From 7e884f6669e703e19149eb2e9611e9f4ff0c1829 Mon Sep 17 00:00:00 2001 From: Steven Webb Date: Wed, 18 Sep 2024 15:10:19 +0800 Subject: [PATCH] Fix packages api url interpolation 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. --- pages/apis/rest_api/packages/packages.md | 8 ++++---- pages/apis/rest_api/packages/registries.md | 12 ++++++------ pages/apis/rest_api/packages/registry_tokens.md | 10 +++++----- 3 files changed, 15 insertions(+), 15 deletions(-) diff --git a/pages/apis/rest_api/packages/packages.md b/pages/apis/rest_api/packages/packages.md index 8718cb2204..517cc20de6 100644 --- a/pages/apis/rest_api/packages/packages.md +++ b/pages/apis/rest_api/packages/packages.md @@ -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' ``` @@ -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 @@ -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" ``` @@ -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` diff --git a/pages/apis/rest_api/packages/registries.md b/pages/apis/rest_api/packages/registries.md index 7b4c1ec7f9..2a604a7a0e 100644 --- a/pages/apis/rest_api/packages/registries.md +++ b/pages/apis/rest_api/packages/registries.md @@ -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 @@ -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 @@ -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 @@ -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", @@ -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` diff --git a/pages/apis/rest_api/packages/registry_tokens.md b/pages/apis/rest_api/packages/registry_tokens.md index 7b36b46a5b..0321b43caa 100644 --- a/pages/apis/rest_api/packages/registry_tokens.md +++ b/pages/apis/rest_api/packages/registry_tokens.md @@ -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" @@ -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" ``` @@ -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 @@ -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" @@ -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`