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

Pipeline's UUID and info added to graphql cookbook #2236

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Pipeline's UUID and info added to graphql cookbook #2236

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
72afd8c
Fixed typo
Jun 21, 2023
909a707
Update pages/apis/graphql/graphql_cookbook.md
butterkitty Jul 19, 2023
06821af
Update graphql uuid language as per PR
Jul 21, 2023
0655d38
Merge branch 'main' into graphql-cookbook-pipeline
mbelton-buildkite Jul 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions pages/apis/graphql/graphql_cookbook.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,11 +82,9 @@ query RecentPipelineSlugs {
}
```

### Get a pipeline's UUID
### Get a pipeline's persistent UUID

Get a pipeline's UUID by searching for it in the API. Search term can match a pipeline slug.

_Note: Pipeline slugs are modifiable and can change_
While a pipeline's name and slug can change over time, its UUID is permanent. Use the UUID when you need a way to reference a pipeline that won't change.

```graphql
query GetPipelineUUID {
Expand All @@ -105,7 +103,7 @@ query GetPipelineUUID {

### Get a pipeline's information

You can get specific pipeline information for each of your pipeline. You can retrieve information for each build, jobs, and any other information listed on [this](https://buildkite.com/docs/apis/graphql/schemas/object/pipeline) page.
You can get more specific pipeline information for each of your pipelines. You can retrieve information for each build, jobs, and any other information listed on [this](https://buildkite.com/docs/apis/graphql/schemas/object/pipeline) page.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
You can get more specific pipeline information for each of your pipelines. You can retrieve information for each build, jobs, and any other information listed on [this](https://buildkite.com/docs/apis/graphql/schemas/object/pipeline) page.
You can get specific information about your pipelines, including details of each build, job, and anything from the [Pipeline object](/docs/apis/graphql/schemas/object/pipeline).


```graphql
query GetPipelineInfo {
Expand Down