Add REST API docs for creating annotations #2546
Merged
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
- parallel_group_index - parallel_group_total - matrix - cluster_id - cluster_url - cluster_queue_id - cluster_queue_url
timriley
requested review from
mbelton-buildkite,
MelissaKaulfuss and
meiqimichelle
as code owners
|
Preview URL: https://2546--bk-docs-preview.netlify.app |
mbelton-buildkite
approved these changes
Nov 13, 2023
Comment on lines
+112
to
+121
| "retried_in_job_id": null, | ||
| "retries_count": null, | ||
| "retry_type": null, | ||
| "parallel_group_index": null, | ||
| "parallel_group_total": null, | ||
| "matrix": null, | ||
| "cluster_id": null, | ||
| "cluster_url": null, | ||
| "cluster_queue_id": null, | ||
| "cluster_queue_url": null |
There was a problem hiding this comment.
Are the any meaningful values we could use here instead of null? We're not the best at including example values for fields so these responses do a lot of heavy lifting for us.
There was a problem hiding this comment.
I think we could definitely look to expand on some of these in the future, but in this case I want to get this (long overdue!) API doc update out, so I'm merging this now (after applying all of your other feedback, thank you!)
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.
Document a new
POST /v2/organizations/{org.slug}/pipelines/{pipeline.slug}/builds/{build.number}/annotationsendpoint for creating build annotations.While here:
parallel_group_index,parallel_group_total,matrix,cluster_id,cluster_url,cluster_queue_id,cluster_queue_url201 Createdstatus cods