Skip to content

Commit

Permalink
Fix packages api url interpolation
Browse files Browse the repository at this point in the history
The url IDs should be wrapped in only curly braces, not prefixed with a
hash as in ruby. This makes it consistent with the rest of the
documentation.
  • Loading branch information
swebb committed Sep 18, 2024
1 parent 9938da8 commit 7e884f6
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 15 deletions.
8 changes: 4 additions & 4 deletions pages/apis/rest_api/packages/packages.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The packages API endpoint lets you create and manage packages in a registry.

```bash
curl -H "Authorization: Bearer $TOKEN" \
-X POST "https://api.buildkite.com/v2/packages/organizations/#{org.slug}/registries/#{registry.slug}/packages" \
-X POST "https://api.buildkite.com/v2/packages/organizations/{org.slug}/registries/{registry.slug}/packages" \
-H "Content-Type: application/json" \
-F 'file=@path/to/ruby/gem/banana-1.0.0.gem'
```
Expand Down Expand Up @@ -51,7 +51,7 @@ Returns the details for a single package.

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

```json
Expand Down Expand Up @@ -86,7 +86,7 @@ Copies a package from a source registry to a destination registry.

```bash
curl -H "Authorization: Bearer $TOKEN" \
-X POST "https://api.buildkite.com/v2/packages/organizations/#{org.slug}/registries/#{source_registry.slug}/packages/#{package.id}/copy?to=#{destination_registry.slug}"
-X POST "https://api.buildkite.com/v2/packages/organizations/{org.slug}/registries/{source_registry.slug}/packages/{package.id}/copy?to={destination_registry.slug}"
-H "Content-Type: application/json"
```

Expand Down Expand Up @@ -128,7 +128,7 @@ Success response: `200 OK`

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

Required scope: `delete_packages`
Expand Down
12 changes: 6 additions & 6 deletions pages/apis/rest_api/packages/registries.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ The registries API endpoint lets you [create and manage registries](/docs/packag

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

```json
Expand Down Expand Up @@ -59,7 +59,7 @@ 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"
-X GET "https://api.buildkite.com/v2/packages/organizations/{org.slug}/registries"
```

```json
Expand Down Expand Up @@ -91,7 +91,7 @@ Returns the details for a single registry, looked up by its slug.

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

```json
Expand Down Expand Up @@ -119,7 +119,7 @@ Success response: `200 OK`

```bash
curl -H "Authorization: Bearer $TOKEN" \
-X POST "https://api.buildkite.com/v2/packages/organizations/#{org.slug}/registries/#{registry.slug}" \
-X POST "https://api.buildkite.com/v2/packages/organizations/{org.slug}/registries/{registry.slug}" \
-H "Content-Type: application/json" \
-d '{
"name": "my registry",
Expand Down Expand Up @@ -161,7 +161,7 @@ Success response: `200 OK`

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

Required scope: `delete_registries`
Expand Down
10 changes: 5 additions & 5 deletions pages/apis/rest_api/packages/registry_tokens.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The registry tokens API endpoint lets you create and manage credentials needed t

```bash
curl -H "Authorization: Bearer $TOKEN" \
-X POST "https://api.buildkite.com/v2/packages/organizations/#{org.slug}/registries/#{registry.slug}/tokens" \
-X POST "https://api.buildkite.com/v2/packages/organizations/{org.slug}/registries/{registry.slug}/tokens" \
-H "Content-Type: application/json" \
-d '{
"description": "Usher"
Expand Down Expand Up @@ -62,7 +62,7 @@ Returns a list of a registry's tokens.

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

Expand Down Expand Up @@ -109,7 +109,7 @@ Returns the details for a single registry token.

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

```json
Expand Down Expand Up @@ -151,7 +151,7 @@ Success response: `200 OK`

```bash
curl -H "Authorization: Bearer $TOKEN" \
-X POST "https://api.buildkite.com/v2/packages/organizations/#{org.slug}/registries/#{registry.slug}/tokens/#{id}" \
-X POST "https://api.buildkite.com/v2/packages/organizations/{org.slug}/registries/{registry.slug}/tokens/{id}" \
-H "Content-Type: application/json" \
-d '{
"description": "Usher"
Expand Down Expand Up @@ -206,7 +206,7 @@ Success response: `200 OK`

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

Required scope: `write_registries`
Expand Down

0 comments on commit 7e884f6

Please sign in to comment.