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

[PKG-7404] API docs for registries update #2969

Merged
merged 3 commits into from
Sep 12, 2024
Merged

[PKG-7404] API docs for registries update #2969

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
49e5edd
api docs for registry create
ensvo Sep 11, 2024
ca53b43
api docs for registry update
ensvo Sep 11, 2024
cc9720d
Merge branch 'ev-packages-api-registry-create' into ev-packages-api-r…
ensvo Sep 11, 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
47 changes: 45 additions & 2 deletions pages/apis/rest_api/packages/registries.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ curl -H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "my registry",
"ecosystem": "ruby"
"ecosystem": "ruby",
"description": "registry containing ruby gems"
}'
```

Expand All @@ -23,7 +24,7 @@ curl -H "Authorization: Bearer $TOKEN" \
"web_url": "https://buildkite.com/organizations/my-org/registries/my-registry",
"name": "my registry",
"ecosystem": "ruby",
"description": null,
"description": "registry containing ruby gems",
"emoji": null,
"color": null,
"public": false,
Expand Down Expand Up @@ -113,3 +114,45 @@ curl -H "Authorization: Bearer $TOKEN" \
Required scope: `read_registries`

Success response: `200 OK`

## Update a registry

```bash
curl -H "Authorization: Bearer $TOKEN" \
-X POST "https://api.buildkite.com/v2/packages/organizations/#{org.slug}/registries/#{registry.slug}" \
-H "Content-Type: application/json" \
-d '{
"name": "my registry",
"description": "registry containing ruby gems"
}'
```

```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/registries/my-registry",
"name": "my registry",
"ecosystem": "ruby",
"description": "registry containing ruby gems",
"emoji": null,
"color": null,
"public": false,
"oidc_policy": null
}
```

Optional [request body properties](/docs/api#request-body-properties):

<table class="responsive-table">
<tbody>
<tr><th><code>name</code></th><td>Name of the registry.<br><em>Example:</em> <code>my registry</code>.</td></tr>
<tr><th><code>description</code></th><td>Description of the registry.<br><em>Example:</em> <code>registry containing ruby gems</code>.</td></tr>
</tbody>
</table>

Required scope: `write_registries`

Success response: `200 OK`
Loading