Skip to content

Update generated API docs #3450

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

Open
team-backend-foundations-bot wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update generated API docs #3450

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
43 changes: 15 additions & 28 deletions src/pages/docs/api/_generated/accounts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: src/layouts/Api.astro
pubDate: 2026-08-11
modDate: 2026-08-11
modDate: 2026-09-04
title: Accounts
---

Expand Down Expand Up @@ -36,7 +36,8 @@ Lists accounts in the supplied Octopus Deploy Space in pages. The results will b

- **`Id`** :span[string]{.type-label}
Gets or sets a unique identifier for this resource.
- **`ItemType`** :span[string]{.type-label}
- **`ItemType`** :span[string]{.type-label}
The type of item in this list.
- **`Items`** :span[array of object]{.type-label}
- **`AccountType`** :span[enum]{.type-label}
Allowed values: `AmazonWebServicesAccount`, `AmazonWebServicesOidcAccount`, `AzureOidc`, `AzureServicePrincipal`, `AzureSubscription`, `GenericOidcAccount`, `GoogleCloudAccount`, `GoogleCloudOidcAccount`, `None`, `SshKeyPair`, `Token`, `UsernamePassword`.
Expand Down Expand Up @@ -72,7 +73,7 @@ Lists accounts in the supplied Octopus Deploy Space in pages. The results will b
```json
{
"Id": "string",
"ItemType": "string",
"ItemType": "Account",
"Items": [
{
"AccountType": "AmazonWebServicesAccount",
Expand All @@ -85,9 +86,7 @@ Lists accounts in the supplied Octopus Deploy Space in pages. The results will b
"LastModifiedBy": "string",
"LastModifiedOn": "2020-01-01T00:00:00.000Z",
"Links": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
"Self": "/api/..."
},
"Name": "string",
"Slug": "string",
Expand All @@ -102,17 +101,15 @@ Lists accounts in the supplied Octopus Deploy Space in pages. The results will b
"TenantedDeploymentParticipation": "Untenanted"
}
],
"ItemsPerPage": 0,
"ItemsPerPage": 30,
"LastModifiedBy": "string",
"LastModifiedOn": "2020-01-01T00:00:00.000Z",
"LastPageNumber": 0,
"LastPageNumber": 1,
"Links": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
"Self": "/api/..."
},
"NumberOfPages": 0,
"TotalResults": 0
"NumberOfPages": 2,
"TotalResults": 42
}
```
:::
Expand Down Expand Up @@ -204,9 +201,7 @@ Also reachable at `/api/accounts`, `/api/spaces/{spaceIdentifier}/accounts`.
"LastModifiedBy": "string",
"LastModifiedOn": "2020-01-01T00:00:00.000Z",
"Links": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
"Self": "/api/..."
},
"Name": "string",
"Slug": "string",
Expand Down Expand Up @@ -274,9 +269,7 @@ Lists all of the accounts in the supplied Octopus Deploy Space. The results will
"LastModifiedBy": "string",
"LastModifiedOn": "2020-01-01T00:00:00.000Z",
"Links": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
"Self": "/api/..."
},
"Name": "string",
"Slug": "string",
Expand Down Expand Up @@ -394,9 +387,7 @@ Also reachable at `/api/accounts/{accountId}`, `/api/spaces/{spaceIdentifier}/ac
"LastModifiedBy": "string",
"LastModifiedOn": "2020-01-01T00:00:00.000Z",
"Links": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
"Self": "/api/..."
},
"Name": "string",
"Slug": "string",
Expand Down Expand Up @@ -463,9 +454,7 @@ Also reachable at `/api/accounts/{id}`, `/api/spaces/{spaceIdentifier}/accounts/
"LastModifiedBy": "string",
"LastModifiedOn": "2020-01-01T00:00:00.000Z",
"Links": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
"Self": "/api/..."
},
"Name": "string",
"Slug": "string",
Expand Down Expand Up @@ -655,9 +644,7 @@ Also reachable at `/api/accounts/{id}/usages`, `/api/spaces/{spaceIdentifier}/ac
}
],
"Links": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
"Self": "/api/..."
},
"ProjectTenantVariables": [
{
Expand Down
55 changes: 18 additions & 37 deletions src/pages/docs/api/_generated/action-templates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: src/layouts/Api.astro
pubDate: 2026-08-11
modDate: 2026-09-03
modDate: 2026-09-04
title: Action Templates
---

Expand Down Expand Up @@ -77,7 +77,8 @@ Lists all of the Action Templates in the supplied Octopus Deploy Space. The resu

- **`Id`** :span[string]{.type-label}
Gets or sets a unique identifier for this resource.
- **`ItemType`** :span[string]{.type-label}
- **`ItemType`** :span[string]{.type-label}
The type of item in this list.
- **`Items`** :span[array of object]{.type-label}
- **`ActionType`** :span[string]{.type-label}
Minimum length 1.
Expand Down Expand Up @@ -114,7 +115,7 @@ Lists all of the Action Templates in the supplied Octopus Deploy Space. The resu
```json
{
"Id": "string",
"ItemType": "string",
"ItemType": "ActionTemplate",
"Items": [
{
"ActionType": "string",
Expand All @@ -127,9 +128,7 @@ Lists all of the Action Templates in the supplied Octopus Deploy Space. The resu
"LastModifiedBy": "string",
"LastModifiedOn": "2020-01-01T00:00:00.000Z",
"Links": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
"Self": "/api/..."
},
"Name": "string",
"Packages": [
Expand All @@ -147,17 +146,15 @@ Lists all of the Action Templates in the supplied Octopus Deploy Space. The resu
"Version": 0
}
],
"ItemsPerPage": 0,
"ItemsPerPage": 30,
"LastModifiedBy": "string",
"LastModifiedOn": "2020-01-01T00:00:00.000Z",
"LastPageNumber": 0,
"LastPageNumber": 1,
"Links": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
"Self": "/api/..."
},
"NumberOfPages": 0,
"TotalResults": 0
"NumberOfPages": 2,
"TotalResults": 42
}
```
:::
Expand Down Expand Up @@ -404,9 +401,7 @@ Also reachable at `/api/actiontemplates`, `/api/spaces/{spaceIdentifier}/actiont
"LastModifiedBy": "string",
"LastModifiedOn": "2020-01-01T00:00:00.000Z",
"Links": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
"Self": "/api/..."
},
"Name": "string",
"Packages": [
Expand Down Expand Up @@ -572,9 +567,7 @@ Lists the all of the action templates in the supplied Octopus Deploy Space. The
"LastModifiedBy": "string",
"LastModifiedOn": "2020-01-01T00:00:00.000Z",
"Links": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
"Self": "/api/..."
},
"Name": "string",
"Packages": [
Expand Down Expand Up @@ -828,9 +821,7 @@ Also reachable at `/api/actiontemplates/{id}`, `/api/spaces/{spaceIdentifier}/ac
"LastModifiedBy": "string",
"LastModifiedOn": "2020-01-01T00:00:00.000Z",
"Links": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
"Self": "/api/..."
},
"Name": "string",
"Packages": [
Expand Down Expand Up @@ -1136,9 +1127,7 @@ Also reachable at `/api/actiontemplates/{id}`, `/api/spaces/{spaceIdentifier}/ac
"LastModifiedBy": "string",
"LastModifiedOn": "2020-01-01T00:00:00.000Z",
"Links": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
"Self": "/api/..."
},
"Name": "string",
"Packages": [
Expand Down Expand Up @@ -1745,9 +1734,7 @@ Gets a list of all steps/deployment processes that use a given action template.
"LastModifiedBy": "string",
"LastModifiedOn": "2020-01-01T00:00:00.000Z",
"Links": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
"Self": "/api/..."
},
"ProcessId": "string",
"ProcessType": "Deployment",
Expand Down Expand Up @@ -1829,9 +1816,7 @@ Also reachable at `/api/actiontemplates/{id}/v1`, `/api/spaces/{spaceIdentifier}
"LastModifiedBy": "string",
"LastModifiedOn": "2020-01-01T00:00:00.000Z",
"Links": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
"Self": "/api/..."
},
"Name": "string",
"Packages": [
Expand Down Expand Up @@ -1974,9 +1959,7 @@ Also reachable at `/api/actiontemplates/{id}/versions`, `/api/spaces/{spaceIdent
"LastModifiedBy": "string",
"LastModifiedOn": "2020-01-01T00:00:00.000Z",
"Links": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
"Self": "/api/..."
},
"Name": "string",
"Packages": [
Expand Down Expand Up @@ -2120,9 +2103,7 @@ Also reachable at `/api/actiontemplates/{id}/versions/{version}`, `/api/spaces/{
"LastModifiedBy": "string",
"LastModifiedOn": "2020-01-01T00:00:00.000Z",
"Links": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
"Self": "/api/..."
},
"Name": "string",
"Packages": [
Expand Down
52 changes: 23 additions & 29 deletions src/pages/docs/api/_generated/api-keys.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: src/layouts/Api.astro
pubDate: 2026-08-11
modDate: 2026-08-11
modDate: 2026-09-04
title: Api Keys
---

Expand Down Expand Up @@ -33,7 +33,8 @@ Lists all API keys for a user, returning the most recent results first.

- **`Id`** :span[string]{.type-label}
Gets or sets a unique identifier for this resource.
- **`ItemType`** :span[string]{.type-label}
- **`ItemType`** :span[string]{.type-label}
The type of item in this list.
- **`Items`** :span[array of object]{.type-label}
- **`AccessLevel`** :span[enum]{.type-label}
The access level this API key grants.
Expand Down Expand Up @@ -75,7 +76,7 @@ Lists all API keys for a user, returning the most recent results first.
```json
{
"Id": "string",
"ItemType": "string",
"ItemType": "ApiKey",
"Items": [
{
"AccessLevel": "FullAccess",
Expand All @@ -93,25 +94,21 @@ Lists all API keys for a user, returning the most recent results first.
"LastModifiedOn": "2020-01-01T00:00:00.000Z",
"LastUsedTimeStamp": "2020-01-01T00:00:00.000Z",
"Links": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
"Self": "/api/..."
},
"Purpose": "string",
"UserId": "string"
}
],
"ItemsPerPage": 0,
"ItemsPerPage": 30,
"LastModifiedBy": "string",
"LastModifiedOn": "2020-01-01T00:00:00.000Z",
"LastPageNumber": 0,
"LastPageNumber": 1,
"Links": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
"Self": "/api/..."
},
"NumberOfPages": 0,
"TotalResults": 0
"NumberOfPages": 2,
"TotalResults": 42
}
```
:::
Expand Down Expand Up @@ -190,9 +187,7 @@ The API Key returned in the result must be saved by the caller, as it cannot be
"LastModifiedOn": "2020-01-01T00:00:00.000Z",
"LastUsedTimeStamp": "2020-01-01T00:00:00.000Z",
"Links": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
"Self": "/api/..."
},
"Purpose": "string",
"UserId": "string"
Expand Down Expand Up @@ -229,7 +224,8 @@ Lists all API keys for a user, returning the most recent results first.
- **`ApiKeys`** :span[object]{.type-label}
- **`Id`** :span[string]{.type-label}
Gets or sets a unique identifier for this resource.
- **`ItemType`** :span[string]{.type-label}
- **`ItemType`** :span[string]{.type-label}
The type of item in this list.
- **`Items`** :span[array of object]{.type-label}
- **`ItemsPerPage`** :span[integer]{.type-label}
- **`LastModifiedBy`** :span[string]{.type-label}
Expand All @@ -247,7 +243,7 @@ Lists all API keys for a user, returning the most recent results first.
{
"ApiKeys": {
"Id": "string",
"ItemType": "string",
"ItemType": "ApiKey",
"Items": [
{
"AccessLevel": "FullAccess",
Expand All @@ -260,22 +256,22 @@ Lists all API keys for a user, returning the most recent results first.
"LastModifiedBy": "string",
"LastModifiedOn": "2020-01-01T00:00:00.000Z",
"LastUsedTimeStamp": "2020-01-01T00:00:00.000Z",
"Links": {},
"Links": {
"Self": "/api/..."
},
"Purpose": "string",
"UserId": "string"
}
],
"ItemsPerPage": 0,
"ItemsPerPage": 30,
"LastModifiedBy": "string",
"LastModifiedOn": "2020-01-01T00:00:00.000Z",
"LastPageNumber": 0,
"LastPageNumber": 1,
"Links": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
"Self": "/api/..."
},
"NumberOfPages": 0,
"TotalResults": 0
"NumberOfPages": 2,
"TotalResults": 42
}
}
```
Expand Down Expand Up @@ -343,9 +339,7 @@ Lists all API keys for a user, returning the most recent results first.
"LastModifiedOn": "2020-01-01T00:00:00.000Z",
"LastUsedTimeStamp": "2020-01-01T00:00:00.000Z",
"Links": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
"Self": "/api/..."
},
"Purpose": "string",
"UserId": "string"
Expand Down
Loading
Loading