From d0a09a349753a0ca222755f6a0451d73e453643a Mon Sep 17 00:00:00 2001 From: Molly Jane Nicholas Date: Mon, 20 Oct 2025 11:26:39 -0700 Subject: [PATCH 1/3] update README with latest scope names --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 10f4e1dc..e3bf17c7 100644 --- a/README.md +++ b/README.md @@ -21,12 +21,17 @@ Whether you’re looking to use SDS to start a new project, or are looking for e ### Figma Auth -- [Create a Figma API token](https://www.figma.com/developers/api#authentication) - - Add Code Connect scope - - Add File Read, Dev Resources Write, and Variables scopes if you want to use the integrations in [scripts](./scripts/) +- [Create a Figma API token](https://www.figma.com/developers/api#authentication) and request the following scopes if you want to use the integrations in [scripts](./scripts/) + - ```file_code_connect_scope:write``` - to work with Code Connect + - ```file_dev_resources:read```- Read dev resources in files. + - ```file_dev_resources:write``` - Write dev resources to files + - ```file_variables:read``` - Read variables in files. Note: Enterprise plan only. + - ```file_variables:write``` - Write variables and collections in files. Note: Enterprise plan only. + - ```file_metadata:read``` - Read metadata of files. + - ```file_versions:read``` - Read the version history for files you can access. - [More on scopes](https://www.figma.com/developers/api#authentication-scopes) - Duplicate [.env-rename](./.env-rename) -- Rename it to `.env`, it will be ignored from git. +- Rename it to `.env`, it will be ignored by git. - Set `FIGMA_ACCESS_TOKEN=` as your token in `.env` - Set `FIGMA_FILE_KEY=` as your file's key (grab it from the file URL) in `.env` From 53c350691f21a995c73dbf8cfb5a1f5d6b6b8db4 Mon Sep 17 00:00:00 2001 From: Molly Jane Nicholas Date: Mon, 20 Oct 2025 11:38:34 -0700 Subject: [PATCH 2/3] clarify which scopes are for what --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e3bf17c7..6189d371 100644 --- a/README.md +++ b/README.md @@ -21,8 +21,10 @@ Whether you’re looking to use SDS to start a new project, or are looking for e ### Figma Auth -- [Create a Figma API token](https://www.figma.com/developers/api#authentication) and request the following scopes if you want to use the integrations in [scripts](./scripts/) +- [Create a Figma API token](https://www.figma.com/developers/api#authentication) and request the following scopes to work with Code Connect - ```file_code_connect_scope:write``` - to work with Code Connect + +and these scopes, if you want to use the integrations in [scripts](./scripts/) - ```file_dev_resources:read```- Read dev resources in files. - ```file_dev_resources:write``` - Write dev resources to files - ```file_variables:read``` - Read variables in files. Note: Enterprise plan only. From bdaa6bc88ed39d20695127d6541e90cd93b48571 Mon Sep 17 00:00:00 2001 From: Molly Jane Nicholas Date: Mon, 20 Oct 2025 11:43:53 -0700 Subject: [PATCH 3/3] point to the right docs for each scope --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6189d371..1910a186 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,7 @@ Whether you’re looking to use SDS to start a new project, or are looking for e - [Create a Figma API token](https://www.figma.com/developers/api#authentication) and request the following scopes to work with Code Connect - ```file_code_connect_scope:write``` - to work with Code Connect + - [More on Code Connect scopes](https://developers.figma.com/docs/code-connect/quickstart-guide/#before-you-begin) and these scopes, if you want to use the integrations in [scripts](./scripts/) - ```file_dev_resources:read```- Read dev resources in files. @@ -31,7 +32,7 @@ and these scopes, if you want to use the integrations in [scripts](./scripts/) - ```file_variables:write``` - Write variables and collections in files. Note: Enterprise plan only. - ```file_metadata:read``` - Read metadata of files. - ```file_versions:read``` - Read the version history for files you can access. - - [More on scopes](https://www.figma.com/developers/api#authentication-scopes) + - [More on REST API scopes](https://www.figma.com/developers/api#authentication-scopes) - Duplicate [.env-rename](./.env-rename) - Rename it to `.env`, it will be ignored by git. - Set `FIGMA_ACCESS_TOKEN=` as your token in `.env`