Skip to content

Update generated API docs #3564

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

Merged
team-backend-foundations-bot merged 1 commit into from
Nov 11, 2026
Merged

Update generated API docs #3564

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
22 changes: 17 additions & 5 deletions src/pages/docs/api/_generated/platform-hub.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-10-07
modDate: 2026-11-10
title: Platform Hub
---

Expand Down Expand Up @@ -1903,6 +1903,8 @@ title: Platform Hub
- **`Name`** :span[string]{.type-label}
Minimum length 1.
- **`RepositoryRestrictions`** :span[object]{.type-label}
- **`SetAuthorAsCommitter`** :span[boolean]{.type-label}
Whether commits made with this credential use the commit author as the committer.
- **`ItemsPerPage`** :span[integer]{.type-label}
- **`LastPageNumber`** :span[integer]{.type-label}
- **`NumberOfPages`** :span[integer]{.type-label}
Expand All @@ -1925,7 +1927,8 @@ title: Platform Hub
"string"
],
"Enabled": false
}
},
"SetAuthorAsCommitter": false
}
],
"ItemsPerPage": 30,
Expand All @@ -1951,6 +1954,8 @@ title: Platform Hub
- **`RepositoryRestrictions`** :span[object]{.type-label}
- **`AllowedRepositories`** :span[array of string]{.type-label}
- **`Enabled`** :span[boolean]{.type-label}
- **`SetAuthorAsCommitter`** :span[boolean]{.type-label}
Whether commits made with this credential use the commit author as the committer.

:::api-example{label="Request"}
```json
Expand All @@ -1965,7 +1970,8 @@ title: Platform Hub
"string"
],
"Enabled": false
}
},
"SetAuthorAsCommitter": false
}
```
:::
Expand Down Expand Up @@ -2125,6 +2131,8 @@ title: Platform Hub
- **`RepositoryRestrictions`** :span[object]{.type-label}
- **`AllowedRepositories`** :span[array of string]{.type-label}
- **`Enabled`** :span[boolean]{.type-label}
- **`SetAuthorAsCommitter`** :span[boolean]{.type-label}
Whether commits made with this credential use the commit author as the committer.

:::api-example{label="Response"}
```json
Expand All @@ -2140,7 +2148,8 @@ title: Platform Hub
"string"
],
"Enabled": false
}
},
"SetAuthorAsCommitter": false
}
```
:::
Expand All @@ -2165,6 +2174,8 @@ title: Platform Hub
- **`RepositoryRestrictions`** :span[object]{.type-label}
- **`AllowedRepositories`** :span[array of string]{.type-label}
- **`Enabled`** :span[boolean]{.type-label}
- **`SetAuthorAsCommitter`** :span[boolean]{.type-label}
Whether commits made with this credential use the commit author as the committer. If you do not provide a value, it will be left as-is.

:::api-example{label="Request"}
```json
Expand All @@ -2180,7 +2191,8 @@ title: Platform Hub
"string"
],
"Enabled": false
}
},
"SetAuthorAsCommitter": false
}
```
:::
Expand Down
7 changes: 5 additions & 2 deletions src/pages/docs/api/_generated/process-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-10-07
modDate: 2026-10-22
title: Process Templates
---

Expand Down Expand Up @@ -233,14 +233,17 @@ title: Process Templates
- **`GitRef`** :span[string]{.type-label} *(required)*
- **`Name`** :span[string]{.type-label} *(required)*
Minimum length 1.
- **`StarterTemplateId`** :span[string]{.type-label}
The starter template whose steps and parameters the new process template should be populated with. When omitted, the process template is created empty.

:::api-example{label="Request"}
```json
{
"ChangeDescription": "string",
"Description": "string",
"GitRef": "string",
"Name": "string"
"Name": "string",
"StarterTemplateId": "string"
}
```
:::
Expand Down
14 changes: 13 additions & 1 deletion src/pages/docs/api/_generated/spaces.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-10-07
modDate: 2026-11-10
title: Spaces
---

Expand Down Expand Up @@ -350,6 +350,8 @@ Also reachable at `/api/spaces/{spaceIdentifier}/git-credentials/v2`.
- **`Name`** :span[string]{.type-label}
Minimum length 1.
- **`RepositoryRestrictions`** :span[object]{.type-label}
- **`SetAuthorAsCommitter`** :span[boolean]{.type-label}
Whether commits made with this credential use the commit author as the committer.
- **`SpaceId`** :span[string]{.type-label}
- **`ItemsPerPage`** :span[integer]{.type-label}
- **`LastPageNumber`** :span[integer]{.type-label}
Expand All @@ -376,6 +378,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/git-credentials/v2`.
],
"Enabled": false
},
"SetAuthorAsCommitter": false,
"SpaceId": "Spaces-1"
}
],
Expand Down Expand Up @@ -409,6 +412,8 @@ Also reachable at `/api/spaces/{spaceIdentifier}/git-credentials/v2`.
- **`RepositoryRestrictions`** :span[object]{.type-label}
- **`AllowedRepositories`** :span[array of string]{.type-label}
- **`Enabled`** :span[boolean]{.type-label}
- **`SetAuthorAsCommitter`** :span[boolean]{.type-label}
Whether commits made with this credential use the commit author as the committer.
- **`SpaceId`** :span[string]{.type-label} *(required)*
The ID of the space containing the resource(s).

Expand All @@ -426,6 +431,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/git-credentials/v2`.
],
"Enabled": false
},
"SetAuthorAsCommitter": false,
"SpaceId": "Spaces-1"
}
```
Expand Down Expand Up @@ -847,6 +853,8 @@ Also reachable at `/api/spaces/{spaceIdentifier}/git-credentials/{id}/v2`.
- **`Name`** :span[string]{.type-label}
Minimum length 1.
- **`RepositoryRestrictions`** :span[object]{.type-label}
- **`SetAuthorAsCommitter`** :span[boolean]{.type-label}
Whether commits made with this credential use the commit author as the committer.
- **`SpaceId`** :span[string]{.type-label}

:::api-example{label="Response"}
Expand All @@ -867,6 +875,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/git-credentials/{id}/v2`.
],
"Enabled": false
},
"SetAuthorAsCommitter": false,
"SpaceId": "Spaces-1"
}
}
Expand Down Expand Up @@ -897,6 +906,8 @@ Also reachable at `/api/spaces/{spaceIdentifier}/git-credentials/{id}/v2`.
- **`RepositoryRestrictions`** :span[object]{.type-label}
- **`AllowedRepositories`** :span[array of string]{.type-label}
- **`Enabled`** :span[boolean]{.type-label}
- **`SetAuthorAsCommitter`** :span[boolean]{.type-label}
Whether commits made with this credential use the commit author as the committer. If you do not provide a value, it will be left as-is.
- **`SpaceId`** :span[string]{.type-label} *(required)*
The ID of the space containing the resource(s).

Expand All @@ -915,6 +926,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/git-credentials/{id}/v2`.
],
"Enabled": false
},
"SetAuthorAsCommitter": false,
"SpaceId": "Spaces-1"
}
```
Expand Down
Loading