Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added note on write_suites API access token scope to README #344

Merged
merged 2 commits into from
Aug 2, 2023
Merged

Added note on write_suites API access token scope to README #344

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d9b1765
Added note on write_suites API access token scope to README
james2791 Aug 1, 2023
12d7c36
Added write_suites mention to other places in docs/descriptions
james2791 Aug 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ The provider allows you to manage resources in your Buildkite organization.
Two configuration values are required:

- An API token, generated at https://buildkite.com/user/api-access-tokens. The
token must have the `write_pipelines, read_pipelines` REST API scopes and be enabled for GraphQL
token must have the `write_pipelines`, `read_pipelines` and `write_suites` REST API scopes and be enabled for GraphQL API access.
- A Buildkite organization slug, available by signing into buildkite.com and
examining the URL: https://buildkite.com/<org-slug>
examining the URL: https://buildkite.com/<org-slug>.

## Documentation

Expand Down
4 changes: 2 additions & 2 deletions buildkite/provider.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ func (*terraformProvider) Schema(ctx context.Context, req provider.SchemaRequest
},
SchemaKeyAPIToken: framework_schema.StringAttribute{
Optional: true,
Description: "API token with GraphQL access and `write_pipelines, read_pipelines` scopes",
Description: "API token with GraphQL access and `write_pipelines, read_pipelines` and `write_suites` REST API scopes",
Sensitive: true,
},
SchemaKeyGraphqlURL: framework_schema.StringAttribute{
Expand Down Expand Up @@ -153,7 +153,7 @@ func Provider(version string) *schema.Provider {
Type: schema.TypeString,
},
SchemaKeyAPIToken: {
Description: "API token with GraphQL access and `write_pipelines, read_pipelines` scopes",
Description: "API token with GraphQL access and `write_pipelines, read_pipelines` and `write_suites` REST API scopes",
Optional: true,
Type: schema.TypeString,
Sensitive: true,
Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This provider can be used to manage resources on [buildkite.com](https://buildki
Two configuration values are required:

- An API token, generated at https://buildkite.com/user/api-access-tokens. The
token must have the `write_pipelines, read_pipelines` REST API scopes and be enabled for GraphQL
token must have the `write_pipelines`, `read_pipelines` and `write_suites` REST API scopes and also be enabled for GraphQL
- A Buildkite organization slug, available by signing into buildkite.com and
examining the URL: https://buildkite.com/<org-slug>

Expand All @@ -30,6 +30,6 @@ provider "buildkite" {
## Argument Reference

- `api_token` - (Required) This is the Buildkite API Access Token. It must be provided but can also be sourced from the `BUILDKITE_API_TOKEN` environment variable.
- `organization` - (Required) This is the Buildkite organization slug. It must be provided, but can also be sourced from the `BUILDKITE_ORGANIZATION_SLUG` environment variable. The token requires GraphQL access and the `write_pipelines, read_pipelines` scopes.
- `organization` - (Required) This is the Buildkite organization slug. It must be provided, but can also be sourced from the `BUILDKITE_ORGANIZATION_SLUG` environment variable. The token requires GraphQL access and the `write_pipelines`, `read_pipelines` and `write_suites` REST API scopes.
- `graphql_url` - (Optional) This is the base URL to use for GraphQL requests. It defaults to "https://graphql.buildkite.com/v1", but can also be sourced from the `BUILDKITE_GRAPHQL_URL` environment variable.
- `rest_url` - (Optional) This is the the base URL to use for REST requests. It defaults to "https://api.buildkite.com", but can also be sourced from the `BUILDKITE_REST_URL` environment variable.