Skip to content

Commit

Permalink
docs(gatsby-source-airtable): API key to access token transition (#445)
Browse files Browse the repository at this point in the history
* Update documentation for gatsby-source-airtable API key

Updates the documentation to reflect Airtable’s decision to deprecate API keys and move to personal access tokens.

* Add change log

* Update contributor profile
  • Loading branch information
jonesbp authored Jul 8, 2023
1 parent e4f8a27 commit f786b3f
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 2 deletions.
1 change: 1 addition & 0 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,7 @@
"profile": "http://brianjon.es",
"contributions": [
"code",
"doc",
"bug",
"ideas"
]
Expand Down
5 changes: 5 additions & 0 deletions .changeset/dull-items-battle.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"gatsby-source-airtable": patch
---

Update documentation on API key creation
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
<td align="center" valign="top" width="14.28%"><a href="https://www.jacobbolda.com"><img src="https://avatars2.githubusercontent.com/u/2019387?v=4?s=100" width="100px;" alt="Jacob Bolda"/><br /><sub><b>Jacob Bolda</b></sub></a><br /><a href="#plugin-jbolda" title="Plugin/utility libraries">🔌</a> <a href="https://github.com/gatsby-uc/plugins/commits?author=jbolda" title="Code">💻</a> <a href="https://github.com/gatsby-uc/plugins/commits?author=jbolda" title="Documentation">📖</a> <a href="https://github.com/gatsby-uc/plugins/pulls?q=is%3Apr+reviewed-by%3Ajbolda" title="Reviewed Pull Requests">👀</a> <a href="#question-jbolda" title="Answering Questions">💬</a> <a href="#ideas-jbolda" title="Ideas, Planning, & Feedback">🤔</a> <a href="#example-jbolda" title="Examples">💡</a> <a href="https://github.com/gatsby-uc/plugins/issues?q=author%3Ajbolda" title="Bug reports">🐛</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/brendanmc6"><img src="https://avatars3.githubusercontent.com/u/9867865?v=4?s=100" width="100px;" alt="Brendan McGill"/><br /><sub><b>Brendan McGill</b></sub></a><br /><a href="https://github.com/gatsby-uc/plugins/commits?author=brendanmc6" title="Code">💻</a> <a href="https://github.com/gatsby-uc/plugins/commits?author=brendanmc6" title="Documentation">📖</a> <a href="#example-brendanmc6" title="Examples">💡</a> <a href="https://github.com/gatsby-uc/plugins/issues?q=author%3Abrendanmc6" title="Bug reports">🐛</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://www.jamessimone.net"><img src="https://avatars2.githubusercontent.com/u/16430727?v=4?s=100" width="100px;" alt="James Simone"/><br /><sub><b>James Simone</b></sub></a><br /><a href="https://github.com/gatsby-uc/plugins/commits?author=jamessimone" title="Code">💻</a> <a href="https://github.com/gatsby-uc/plugins/commits?author=jamessimone" title="Documentation">📖</a> <a href="https://github.com/gatsby-uc/plugins/issues?q=author%3Ajamessimone" title="Bug reports">🐛</a> <a href="#question-jamessimone" title="Answering Questions">💬</a> <a href="https://github.com/gatsby-uc/plugins/pulls?q=is%3Apr+reviewed-by%3Ajamessimone" title="Reviewed Pull Requests">👀</a></td>
<td align="center" valign="top" width="14.28%"><a href="http://brianjon.es"><img src="https://avatars0.githubusercontent.com/u/507511?v=4?s=100" width="100px;" alt="Brian Jones"/><br /><sub><b>Brian Jones</b></sub></a><br /><a href="https://github.com/gatsby-uc/plugins/commits?author=jonesbp" title="Code">💻</a> <a href="https://github.com/gatsby-uc/plugins/issues?q=author%3Ajonesbp" title="Bug reports">🐛</a> <a href="#ideas-jonesbp" title="Ideas, Planning, & Feedback">🤔</a></td>
<td align="center" valign="top" width="14.28%"><a href="http://brianjon.es"><img src="https://avatars0.githubusercontent.com/u/507511?v=4?s=100" width="100px;" alt="Brian Jones"/><br /><sub><b>Brian Jones</b></sub></a><br /><a href="https://github.com/gatsby-uc/plugins/commits?author=jonesbp" title="Code">💻</a> <a href="https://github.com/gatsby-uc/plugins/issues?q=author%3Ajonesbp" title="Bug reports">🐛</a> <a href="#ideas-jonesbp" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/gatsby-uc/plugins/commits?author=jonesbp" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/christopherfrance"><img src="https://avatars0.githubusercontent.com/u/7366?v=4?s=100" width="100px;" alt="Christopher Blow France"/><br /><sub><b>Christopher Blow France</b></sub></a><br /><a href="https://github.com/gatsby-uc/plugins/commits?author=christopherfrance" title="Documentation">📖</a> <a href="https://github.com/gatsby-uc/plugins/issues?q=author%3Achristopherfrance" title="Bug reports">🐛</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://twitter.com/eunjae_lee"><img src="https://avatars3.githubusercontent.com/u/499898?v=4?s=100" width="100px;" alt="Eunjae Lee"/><br /><sub><b>Eunjae Lee</b></sub></a><br /><a href="https://github.com/gatsby-uc/plugins/commits?author=eunjae-lee" title="Code">💻</a> <a href="https://github.com/gatsby-uc/plugins/commits?author=eunjae-lee" title="Documentation">📖</a></td>
</tr>
Expand Down
4 changes: 3 additions & 1 deletion packages/gatsby-source-airtable/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,9 @@ underscores.

### API Keys

Keys can be found in Airtable by clicking `Help > API Documentation`.
Airtable has moved from using a single API key per user to using personal access tokens that carry specific privileges limited to specific bases and workspaces. The personal API keys will be deprecated by the end of January 2024. The personal access tokens can be used interchangeably with the older API keys.

To create a new token, go to the [Personal Access Tokens](https://airtable.com/create/tokens) panel of the [Developer Hub](https://airtable.com/developers). `gatsby-source-airtable` requires the `data.records:read` scope on any base(s) from which you’ll be pulling data. You’ll need the full Token shown to you only one time on creation, not the truncated Token ID shown in the table of all Personal Access Tokens. Once you have this token value, use it as the API key in the configuration outlined below.

The API key can be hard coded directly in `gatsby-config.js` as noted in the
previous section-- **this exposes your key to anyone viewing your repository and
Expand Down

0 comments on commit f786b3f

Please sign in to comment.