From a7cb53a627186af47f8dab789a9aa6078e9681d7 Mon Sep 17 00:00:00 2001 From: Octobob Date: Sun, 30 Aug 2026 15:13:08 +0000 Subject: [PATCH] Sync generated API docs origin revision: 2f897ac9 --- src/pages/docs/api/_generated/environments.md | 60 ++++++++++++++++++- src/pages/docs/api/_generated/platform-hub.md | 20 ++++++- 2 files changed, 78 insertions(+), 2 deletions(-) diff --git a/src/pages/docs/api/_generated/environments.md b/src/pages/docs/api/_generated/environments.md index d3f785b26d..96af94b717 100644 --- a/src/pages/docs/api/_generated/environments.md +++ b/src/pages/docs/api/_generated/environments.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-08-27 title: Environments --- @@ -1432,3 +1432,61 @@ Also reachable at `/api/spaces/{spaceIdentifier}/projects/{projectId}/environmen } ``` ::: + +## Delete the environment state entry with the given key for a project/environment (and optionally tenant) + +:endpoint{method="DELETE" path="/api/\{spaceId\}/projects/\{projectId\}/environments/\{environmentId\}/tenants/\{tenantId\}/states/\{key\}"} + +Also reachable at `/api/spaces/{spaceIdentifier}/projects/{projectId}/environments/{environmentId}/tenants/{tenantId}/states/{key}`, `/api/spaces/{spaceIdentifier}/projects/{projectId}/environments/{environmentId}/untenanted/states/{key}`, `/api/{spaceId}/projects/{projectId}/environments/{environmentId}/untenanted/states/{key}`. + +**Path Parameters** + +- **`environmentId`** :span[string]{.type-label} *(required)* + The ID of the environment the environment state entry belongs to. +- **`key`** :span[string]{.type-label} *(required)* + The key of the environment state entry to delete. +- **`projectId`** :span[string]{.type-label} *(required)* + The ID of the project the environment state entry belongs to. +- **`spaceId`** :span[string]{.type-label} *(required)* + The ID of the space containing the environment state entry. +- **`tenantId`** :span[string]{.type-label} *(required)* + An ID for a Tenant. If supplied, the entry deleted is the one published for the Tenant identified by the ID. If not supplied, the untenanted entry is deleted. + +**Response** + +`200` — Success + +## Gets the set of URLs published for a project/environment (and optionally tenant) + +:endpoint{method="GET" path="/api/\{spaceId\}/projects/\{projectId\}/environments/\{environmentId\}/urls"} + +Also reachable at `/api/spaces/{spaceIdentifier}/projects/{projectId}/environments/{environmentId}/urls`. + +**Path Parameters** + +- **`environmentId`** :span[string]{.type-label} *(required)* +- **`projectId`** :span[string]{.type-label} *(required)* +- **`spaceId`** :span[string]{.type-label} *(required)* + +**Query Parameters** + +- **`tenantId`** :span[string]{.type-label} + An ID for a Tenant. If supplied, will limit the result to URLs published for the Tenant identified by the ID. If not supplied, only untenanted URLs are returned. + +**Response** + +`200` — The requested set of environment URLs + +- **`Name`** :span[string]{.type-label} +- **`Url`** :span[string]{.type-label} + +:::api-example{label="Response"} +```json +[ + { + "Name": "string", + "Url": "string" + } +] +``` +::: diff --git a/src/pages/docs/api/_generated/platform-hub.md b/src/pages/docs/api/_generated/platform-hub.md index ce1ba01c65..593d89f7c7 100644 --- a/src/pages/docs/api/_generated/platform-hub.md +++ b/src/pages/docs/api/_generated/platform-hub.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-25 +modDate: 2026-08-27 title: Platform Hub --- @@ -2737,6 +2737,8 @@ Gets a set of GitHub App connections for the Platform Hub. - **`Type`** :span[enum]{.type-label} Allowed values: `Anonymous`, `UsernamePassword`, `Reference`, `GitHub`, `SshKey`. - **`DefaultBranch`** :span[string]{.type-label} +- **`ProtectedBranchNamePatterns`** :span[array of string]{.type-label} +- **`ProtectedDefaultBranch`** :span[boolean]{.type-label} - **`Url`** :span[string]{.type-label} :::api-example{label="Response"} @@ -2747,6 +2749,10 @@ Gets a set of GitHub App connections for the Platform Hub. "Type": "Anonymous" }, "DefaultBranch": "string", + "ProtectedBranchNamePatterns": [ + "string" + ], + "ProtectedDefaultBranch": false, "Url": "string" } ``` @@ -2763,6 +2769,8 @@ Gets a set of GitHub App connections for the Platform Hub. - **`Type`** :span[enum]{.type-label} Allowed values: `Anonymous`, `UsernamePassword`, `Reference`, `GitHub`, `SshKey`. - **`DefaultBranch`** :span[string]{.type-label} *(required)* +- **`ProtectedBranchNamePatterns`** :span[array of string]{.type-label} +- **`ProtectedDefaultBranch`** :span[boolean]{.type-label} - **`Url`** :span[string]{.type-label} *(required)* Minimum length 1. @@ -2774,6 +2782,10 @@ Gets a set of GitHub App connections for the Platform Hub. "Type": "Anonymous" }, "DefaultBranch": "string", + "ProtectedBranchNamePatterns": [ + "string" + ], + "ProtectedDefaultBranch": false, "Url": "string" } ``` @@ -2788,6 +2800,8 @@ Gets a set of GitHub App connections for the Platform Hub. - **`Type`** :span[enum]{.type-label} Allowed values: `Anonymous`, `UsernamePassword`, `Reference`, `GitHub`, `SshKey`. - **`DefaultBranch`** :span[string]{.type-label} +- **`ProtectedBranchNamePatterns`** :span[array of string]{.type-label} +- **`ProtectedDefaultBranch`** :span[boolean]{.type-label} - **`Url`** :span[string]{.type-label} :::api-example{label="Response"} @@ -2798,6 +2812,10 @@ Gets a set of GitHub App connections for the Platform Hub. "Type": "Anonymous" }, "DefaultBranch": "string", + "ProtectedBranchNamePatterns": [ + "string" + ], + "ProtectedDefaultBranch": false, "Url": "string" } ```