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

Document the GraphQL Usage API #2220

Merged
merged 6 commits into from
Jun 27, 2023
Merged

Document the GraphQL Usage API #2220

merged 6 commits into from
Jun 27, 2023

Conversation

jameshill
Copy link
Contributor

@jameshill jameshill commented Jun 19, 2023 •
edited
Loading

Usage API via GraphQL

We've recently added the ability to query Usage data via the GraphQL API.

Internal Context

@buildkite-docs-bot
Copy link
Contributor

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

@jameshill jameshill force-pushed the fdn-2671-release-docs-on-usage-api branch from 5e9ba55 to 925254d Compare June 19, 2023 22:33
@mbelton-buildkite
Copy link
Contributor

(FYI, I've seen this but not reviewed it because it's in draft. Mention me in a comment when you're ready for review 😊)

@jameshill jameshill marked this pull request as ready for review June 26, 2023 05:10
@jameshill
Copy link
Contributor Author

Hey @mbelton-buildkite this is ready for review, no change to before... I was just checking on the auto-generated (schema) documentation.

@jameshill jameshill force-pushed the fdn-2671-release-docs-on-usage-api branch from 925254d to 30fd752 Compare June 26, 2023 23:13
@github-actions github-actions bot added pipelines Pull requests that update content related to Pipelines test-analytics Pull requests that update content related to Test Analytics labels Jun 26, 2023
@jameshill
Add the Usage API to the GraphQL cookbook
a72e243 
Cross link to the cookbook from the job_minutes and test_exectutions
pages.
@jameshill jameshill force-pushed the fdn-2671-release-docs-on-usage-api branch from 30fd752 to a72e243 Compare June 27, 2023 00:11
mbelton-buildkite
mbelton-buildkite reviewed Jun 27, 2023
View reviewed changes
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.

Just a few style tweaks.

I remember this was added by support to provide some guidance on usage: Get number of builds between two dates. Do you think it should be removed now? All good to just keep it if it's not an easy answer.

pages/apis/graphql/graphql_cookbook.md Outdated Show resolved Hide resolved
pages/apis/graphql/graphql_cookbook.md Outdated Show resolved Hide resolved
pages/apis/graphql/graphql_cookbook.md Outdated Show resolved Hide resolved
pages/pipelines/job_minutes.md Outdated Show resolved Hide resolved
pages/test_analytics/test_executions.md Outdated Show resolved Hide resolved
jameshill and others added 5 commits June 27, 2023 11:03
@jameshill @mbelton-buildkite
Update pages/apis/graphql/graphql_cookbook.md
b1c33c8 
Co-authored-by: Michael Belton <119824349+mbelton-buildkite@users.noreply.github.com>
@jameshill @mbelton-buildkite
Update pages/apis/graphql/graphql_cookbook.md
8e74a34 
Co-authored-by: Michael Belton <119824349+mbelton-buildkite@users.noreply.github.com>
@jameshill @mbelton-buildkite
Update pages/apis/graphql/graphql_cookbook.md
487b919 
Co-authored-by: Michael Belton <119824349+mbelton-buildkite@users.noreply.github.com>
@jameshill @mbelton-buildkite
Update pages/pipelines/job_minutes.md
1f56815 
Co-authored-by: Michael Belton <119824349+mbelton-buildkite@users.noreply.github.com>
@jameshill @mbelton-buildkite
Update pages/test_analytics/test_executions.md
ef6df57 
Co-authored-by: Michael Belton <119824349+mbelton-buildkite@users.noreply.github.com>
@jameshill
Copy link
Contributor Author

I remember this was added by support to provide some guidance on usage: Get number of builds between two dates. Do you think it should be removed now? All good to just keep it if it's not an easy answer.

Good idea, yeah I reckon we can drop this in a new PR.

@jameshill jameshill merged commit 27c5e94 into main Jun 27, 2023
1 check passed
@jameshill jameshill deleted the fdn-2671-release-docs-on-usage-api branch June 27, 2023 01:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mbelton-buildkite mbelton-buildkite mbelton-buildkite approved these changes

Assignees
No one assigned
Labels
api graphql pipelines Pull requests that update content related to Pipelines test-analytics Pull requests that update content related to Test Analytics
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jameshill @buildkite-docs-bot @mbelton-buildkite