Skip to content

Commit 67444c2

Browse files
authored
Update GitHub Connector docs (#378)
1 parent 13ec465 commit 67444c2

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

  • spiceaidocs/docs/components/data-connectors

spiceaidocs/docs/components/data-connectors/github.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The GitHub Data Connector enables federated SQL queries on various GitHub resour
1010

1111
The GitHub data connector can be configured by providing the following `params`. Use the [secret replacement syntax](../secret-stores/index.md) to load the access token from a secret store, e.g. `${secrets:GITHUB_TOKEN}`.
1212

13-
- `github_access_token`: Required. GitHub personal access token to use to connect to the GitHub API. [Learn more](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens).
13+
- `github_token`: Required. GitHub personal access token to use to connect to the GitHub API. [Learn more](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens).
1414
- `owner` - Required. Specifies the owner of the GitHub repository.
1515
- `repo` - Required. Specifies the name of the GitHub repository.
1616

@@ -24,7 +24,7 @@ datasets:
2424
- from: github:github.com/<owner>/<repo>/files/<ref>
2525
name: spiceai.files
2626
params:
27-
github_access_token: ${secrets:GITHUB_TOKEN}
27+
github_token: ${secrets:GITHUB_TOKEN}
2828
include: "**/*.json; **/*.yaml"
2929
acceleration:
3030
enabled: true
@@ -56,7 +56,7 @@ datasets:
5656
- from: github:github.com/spiceai/spiceai/files/v0.17.2-beta
5757
name: spiceai.files
5858
params:
59-
github_access_token: ${secrets:GITHUB_TOKEN}
59+
github_token: ${secrets:GITHUB_TOKEN}
6060
include: "**/*.txt" # include txt files only
6161
acceleration:
6262
enabled: true
@@ -81,7 +81,7 @@ datasets:
8181
- from: github:github.com/<owner>/<repo>/issues
8282
name: spiceai.issues
8383
params:
84-
github_access_token: ${secrets:GITHUB_TOKEN}
84+
github_token: ${secrets:GITHUB_TOKEN}
8585
acceleration:
8686
enabled: true
8787
```
@@ -115,7 +115,7 @@ datasets:
115115
- from: github:github.com/spiceai/spiceai/issues
116116
name: spiceai.issues
117117
params:
118-
github_access_token: ${secrets:GITHUB_TOKEN}
118+
github_token: ${secrets:GITHUB_TOKEN}
119119
```
120120

121121
```console
@@ -141,7 +141,7 @@ datasets:
141141
- from: github:github.com/<owner>/<repo>/pulls
142142
name: spiceai.pulls
143143
params:
144-
github_access_token: ${secrets:GITHUB_TOKEN}
144+
github_token: ${secrets:GITHUB_TOKEN}
145145
```
146146
147147
#### Schema
@@ -175,7 +175,7 @@ datasets:
175175
- from: github:github.com/spiceai/spiceai/pulls
176176
name: spiceai.pulls
177177
params:
178-
github_access_token: ${secrets:GITHUB_TOKEN}
178+
github_token: ${secrets:GITHUB_TOKEN}
179179
acceleration:
180180
enabled: true
181181
```
@@ -198,7 +198,7 @@ datasets:
198198
- from: github:github.com/<owner>/<repo>/commits
199199
name: spiceai.commits
200200
params:
201-
github_access_token: ${secrets:GITHUB_TOKEN}
201+
github_token: ${secrets:GITHUB_TOKEN}
202202
```
203203
204204
#### Schema
@@ -223,7 +223,7 @@ datasets:
223223
- from: github:github.com/spiceai/spiceai/commits
224224
name: spiceai.commits
225225
params:
226-
github_access_token: ${secrets:GITHUB_TOKEN}
226+
github_token: ${secrets:GITHUB_TOKEN}
227227
acceleration:
228228
enabled: true
229229
```
@@ -246,4 +246,4 @@ sql> select sha, message_head_line from spiceai.commits limit 10
246246
+------------------------------------------+------------------------------------------------------------------------+
247247

248248
Time: 0.0065395 seconds. 10 rows.
249-
```
249+
```

0 commit comments

Comments
 (0)