[PIE-1819] Documentation for Analytics REST API Suites#update and Suite#destroy #2251
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Preview URL: https://2251--bk-docs-preview.netlify.app |
amybiyuliu
force-pushed
the
pie-1819-docs-for-suitesupdate-and-suitedestroy
branch
from
5541e0d
to
db1ec94
Compare
swebb
reviewed
Jun 26, 2023
| https://api.buildkite.com/v2/analytics/organizations/{org.slug}/suites{suite.slug} \ | ||
| ``` | ||
|
|
||
| Required scope: `write_clusters` |
There was a problem hiding this comment.
Suggested change
| Required scope: `write_clusters` | |
| Required scope: `write_suites` |
There was a problem hiding this comment.
whoops I copied it from pipelines docs and forgot to update the scope name. Good catch!
| ## Update a suite | ||
|
|
||
| ```bash | ||
| curl -X PUT \ |
There was a problem hiding this comment.
[nit]
Suggested change
| curl -X PUT \ | |
| curl -X PATCH \ |
I believe this is generally better practice and is consistent with pipelines: https://buildkite.com/docs/apis/rest-api/pipelines#update-a-pipeline
|
|
||
| <table class="responsive-table"> | ||
| <tbody> | ||
| <tr><th><code>name</code></th><td>Name of the new suite.<br><em>Example:</em> <code>"Jasmine"</code>.</td></tr> |
There was a problem hiding this comment.
Suggested change
| <tr><th><code>name</code></th><td>Name of the new suite.<br><em>Example:</em> <code>"Jasmine"</code>.</td></tr> | |
| <tr><th><code>name</code></th><td>Name of the suite.<br><em>Example:</em> <code>"Jasmine"</code>.</td></tr> |
mbelton-buildkite
approved these changes
Jun 27, 2023
There was a problem hiding this comment.
One minor style tweak, otherwise, looks good to me with @swebb's suggestions. 😊
|
|
||
| ```bash | ||
| curl -X DELETE \ | ||
| https://api.buildkite.com/v2/analytics/organizations/{org.slug}/suites{suite.slug} \ |
There was a problem hiding this comment.
Style: I don't believe this is necessary.
Suggested change
| https://api.buildkite.com/v2/analytics/organizations/{org.slug}/suites{suite.slug} \ | |
| https://api.buildkite.com/v2/analytics/organizations/{org.slug}/suites{suite.slug} |
amybiyuliu
force-pushed
the
pie-1819-docs-for-suitesupdate-and-suitedestroy
branch
from
db1ec94
to
a4d65a9
Compare
swebb
approved these changes
Jun 28, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add documentation about test analytics Suites#update and Suite#destroy API endpoints
Suites#update:
Suite#destroy: