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

[PKG-7402] API docs for registries index #2966

Merged
merged 3 commits into from
Sep 12, 2024
Merged

[PKG-7402] API docs for registries index #2966

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a55f56e
docs for registries index
ensvo Sep 11, 2024
37bec34
Fix highlighting issue.
gilesgas Sep 12, 2024
66688f7
Add term 'endpoint' to relevant sections throughout the REST API docs…
gilesgas Sep 12, 2024
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
6 changes: 5 additions & 1 deletion data/nav.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -557,7 +557,11 @@
- name: "Members"
path: "apis/rest-api/organizations/members"
pill: "beta"
- name: "Pipelines "
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removed extra space.

Copy link
Contributor

@gilesgas gilesgas Sep 12, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

No this needs to be there unfortunately for the reason I've now explained in a comment within the relevant areas of the nav.yml file.

Your screenshot above highlights this issue ^ (excusing the pun).

It looks like all of the page nav names throughout this file need to be uniquely different from anything that's at the very top level of the nav.yml (i.e. the global nav bar at the top) to avoid this multiple-highlighting issue.

- name: "Packages"
children:
- name: "Registries"
path: "apis/rest-api/packages/registries"
- name: "Pipelines"
children:
- name: "Overview"
path: "apis/rest-api/pipelines"
Expand Down
35 changes: 35 additions & 0 deletions pages/apis/rest_api/packages/registries.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Registries API

The registries API lets you create and manage registries in your organization.

## List all registries

Returns a list of an organization's registries.

```bash
curl -H "Authorization: Bearer $TOKEN" \
-X GET "https://api.buildkite.com/v2/packages/organizations/#{org.slug}/registries"
```

```json
[
{
"id": "0191df84-85e4-77aa-83ba-6579084728eb",
"graphql_id": "UmVnaXN0cnktLS0wMTkxZGY4NC04NWU0LTc3YWEtODNiYS02NTc5MDg0NzI4ZWI=",
"slug": "my-registry",
"url": "https://api.buildkite.com/v2/packages/organizations/my-org/registries/my-registry",
"web_url": "https://buildkite.com/organizations/my-org/packages/registries/my-registry",
"name": "my registry",
"ecosystem": "ruby",
"description": "registry containing ruby gems",
"emoji": null,
"color": null,
"public": false,
"oidc_policy": null
}
]
```

Required scope: `read_registries`

Success response: `200 OK`
Loading