Skip to content

Update api parity docs and update graphQL cookbook#2243

Closed
jeremybumsted wants to merge 4 commits intomainfrom
jb-rest-graphql-parity-update
Closed

Update api parity docs and update graphQL cookbook#2243
jeremybumsted wants to merge 4 commits intomainfrom
jb-rest-graphql-parity-update

Conversation

@jeremybumsted
Copy link
Contributor

We have the ability to query detailed retry info for jobs on a given build with only the GraphQL api, so this will update the api differences page, as well as add a query that shows how to do this as an example.

@buildkite-docs-bot
Copy link
Contributor

Preview URL: https://2243--bk-docs-preview.netlify.app

Copy link
Contributor

@mbelton-buildkite mbelton-buildkite left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple of tweaks, then it looks good 😊

jeremybumsted and others added 2 commits June 30, 2023 16:09
Co-authored-by: Michael Belton <119824349+mbelton-buildkite@users.noreply.github.com>
Co-authored-by: Michael Belton <119824349+mbelton-buildkite@users.noreply.github.com>
@jeremybumsted
Copy link
Contributor Author

Amazing, thanks @mbelton-buildkite :)

@mbelton-buildkite
Copy link
Contributor

^ I merged in main to pick up a fix for the failing build.

@ozdenyilmaz
Copy link
Contributor

This PR is no longer needed. Both changes have already been applied to the current codebase:

Job retry cookbook entry — The GraphQL cookbook now has a "Get retry information for a job" section in pages/apis/graphql/cookbooks/jobs.md (line 195), with an even more detailed query that includes retrySource, retryType, and retriedBy.
API differences page — Line 17 already lists "Retry data for jobs" under REST-only features, and the GraphQL-only section doesn't need an entry since retry info is now documented in the GraphQL cookbooks. The feature parity gap the PR was documenting has been addressed.

The PR can be safely closed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants