opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-24 15:04:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: group enumerated values by property in API docs (#21372)

Browse Source 
Fixes #13840
This commit is contained in:
Marcin Tojek
2025-12-22 16:19:25 +01:00
committed by GitHub
parent 5b89da016e
commit 0af038bddd
14 changed files with 506 additions and 1664 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/reference/api/organizations.md
Generated
+8 -27
View File
@@ -283,21 +283,9 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/provisi
#### Enumerated Values
| Parameter | Value |
|-----------|-------------|
| `status` | `pending` |
| `status` | `running` |
| `status` | `succeeded` |
| `status` | `canceling` |
| `status` | `canceled` |
| `status` | `failed` |
| `status` | `unknown` |
| `status` | `pending` |
| `status` | `running` |
| `status` | `succeeded` |
| `status` | `canceling` |
| `status` | `canceled` |
| `status` | `failed` |
| Parameter | Value(s) |
|-----------|---------------------------------------------------------------------------------|
| `status` | `canceled`, `canceling`, `failed`, `pending`, `running`, `succeeded`, `unknown` |
### Example responses
@@ -396,18 +384,11 @@ Status Code **200**
#### Enumerated Values
| Property | Value |
|--------------|-------------------------------|
| `error_code` | `REQUIRED_TEMPLATE_VARIABLES` |
| `status` | `pending` |
| `status` | `running` |
| `status` | `succeeded` |
| `status` | `canceling` |
| `status` | `canceled` |
| `status` | `failed` |
| `type` | `template_version_import` |
| `type` | `workspace_build` |
| `type` | `template_version_dry_run` |
| Property | Value(s) |
|--------------|--------------------------------------------------------------------------|
| `error_code` | `REQUIRED_TEMPLATE_VARIABLES` |
| `status` | `canceled`, `canceling`, `failed`, `pending`, `running`, `succeeded` |
| `type` | `template_version_dry_run`, `template_version_import`, `workspace_build` |
To perform this operation, you must be authenticated. [Learn more](authentication.md).