mirror of
https://github.com/coder/coder.git
synced 2025-07-23 21:32:07 +00:00
docs: api root, buildinfo, csp (#5493)
* docs: Applications * WIP * WIP * WIP * Fix: consume * Fix: @Description * Fix * docs: apiroot, buildinfo, csp * Fix: buildinfo * docs: updatecheck * docs: apiroot * Fix: s/none//g * Fix: godoc nice * Fix: description * Fix: It * Fix: code sample trim empty line * More fixes * Fix: br * Merge * Fix: no-security on updatecheck * Fix: code tags * Fix: enumerated values in code tags * Rephrased * Address PR comments * Fix: URL, id * Fix: array items * Fix: any property * Fix: array item singular
This commit is contained in:
Marcin Tojek
GitHub
@@ -17,10 +17,10 @@ curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/member
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | In | Type | Required | Description |
|
||||
| ------------ | ---- | ------------ | -------- | --------------- |
|
||||
| organization | path | string(uuid) | true | Organization ID |
|
||||
| user | path | string | true | Username |
|
||||
| Name | In | Type | Required | Description |
|
||||
| -------------- | ---- | ------------ | -------- | --------------- |
|
||||
| `organization` | path | string(uuid) | true | Organization ID |
|
||||
| `user` | path | string | true | Username |
|
||||
|
||||
### Example responses
|
||||
|
||||
@@ -180,11 +180,11 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/workspace/{workspacenam
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | In | Type | Required | Description |
|
||||
| --------------- | ----- | ------- | -------- | ----------------------------------------------------------- |
|
||||
| user | path | string | true | Owner username |
|
||||
| workspacename | path | string | true | Workspace name |
|
||||
| include_deleted | query | boolean | false | Return data instead of HTTP 404 if the workspace is deleted |
|
||||
| Name | In | Type | Required | Description |
|
||||
| ----------------- | ----- | ------- | -------- | ----------------------------------------------------------- |
|
||||
| `user` | path | string | true | Owner username |
|
||||
| `workspacename` | path | string | true | Workspace name |
|
||||
| `include_deleted` | query | boolean | false | Return data instead of HTTP 404 if the workspace is deleted |
|
||||
|
||||
### Example responses
|
||||
|
||||
@@ -344,31 +344,31 @@ curl -X GET http://coder-server:8080/api/v2/workspaces \
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | In | Type | Required | Description |
|
||||
| --------- | ----- | ------ | -------- | ------------------------------------------- |
|
||||
| owner | query | string | false | Filter by owner username |
|
||||
| template | query | string | false | Filter by template name |
|
||||
| name | query | string | false | Filter with partial-match by workspace name |
|
||||
| status | query | string | false | Filter by workspace status |
|
||||
| has_agent | query | string | false | Filter by agent status |
|
||||
| Name | In | Type | Required | Description |
|
||||
| ----------- | ----- | ------ | -------- | ------------------------------------------- |
|
||||
| `owner` | query | string | false | Filter by owner username |
|
||||
| `template` | query | string | false | Filter by template name |
|
||||
| `name` | query | string | false | Filter with partial-match by workspace name |
|
||||
| `status` | query | string | false | Filter by workspace status |
|
||||
| `has_agent` | query | string | false | Filter by agent status |
|
||||
|
||||
#### Enumerated Values
|
||||
|
||||
| Parameter | Value |
|
||||
| --------- | ------------ |
|
||||
| status | pending |
|
||||
| status | running |
|
||||
| status | stopping |
|
||||
| status | stopped |
|
||||
| status | failed |
|
||||
| status | canceling |
|
||||
| status | canceled |
|
||||
| status | deleted |
|
||||
| status | deleting |
|
||||
| has_agent | connected |
|
||||
| has_agent | connecting |
|
||||
| has_agent | disconnected |
|
||||
| has_agent | timeout |
|
||||
| Parameter | Value |
|
||||
| ----------- | -------------- |
|
||||
| `status` | `pending` |
|
||||
| `status` | `running` |
|
||||
| `status` | `stopping` |
|
||||
| `status` | `stopped` |
|
||||
| `status` | `failed` |
|
||||
| `status` | `canceling` |
|
||||
| `status` | `canceled` |
|
||||
| `status` | `deleted` |
|
||||
| `status` | `deleting` |
|
||||
| `has_agent` | `connected` |
|
||||
| `has_agent` | `connecting` |
|
||||
| `has_agent` | `disconnected` |
|
||||
| `has_agent` | `timeout` |
|
||||
|
||||
### Example responses
|
||||
|
||||
@@ -529,10 +529,10 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{id} \
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | In | Type | Required | Description |
|
||||
| --------------- | ----- | ------------ | -------- | ----------------------------------------------------------- |
|
||||
| id | path | string(uuid) | true | Workspace ID |
|
||||
| include_deleted | query | boolean | false | Return data instead of HTTP 404 if the workspace is deleted |
|
||||
| Name | In | Type | Required | Description |
|
||||
| ----------------- | ----- | ------------ | -------- | ----------------------------------------------------------- |
|
||||
| `id` | path | string(uuid) | true | Workspace ID |
|
||||
| `include_deleted` | query | boolean | false | Return data instead of HTTP 404 if the workspace is deleted |
|
||||
|
||||
### Example responses
|
||||
|
||||
@@ -700,10 +700,10 @@ curl -X PATCH http://coder-server:8080/api/v2/workspaces/{workspace} \
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | In | Type | Required | Description |
|
||||
| --------- | ---- | ---------------------------------------------------------------------------- | -------- | ----------------------- |
|
||||
| workspace | path | string(uuid) | true | Workspace ID |
|
||||
| body | body | [codersdk.UpdateWorkspaceRequest](schemas.md#codersdkupdateworkspacerequest) | true | Metadata update request |
|
||||
| Name | In | Type | Required | Description |
|
||||
| ----------- | ---- | ---------------------------------------------------------------------------- | -------- | ----------------------- |
|
||||
| `workspace` | path | string(uuid) | true | Workspace ID |
|
||||
| `body` | body | [codersdk.UpdateWorkspaceRequest](schemas.md#codersdkupdateworkspacerequest) | true | Metadata update request |
|
||||
|
||||
### Responses
|
||||
|
||||
@@ -736,10 +736,10 @@ curl -X PUT http://coder-server:8080/api/v2/workspaces/{workspace}/autostart \
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | In | Type | Required | Description |
|
||||
| --------- | ---- | ---------------------------------------------------------------------------------------------- | -------- | ----------------------- |
|
||||
| workspace | path | string(uuid) | true | Workspace ID |
|
||||
| body | body | [codersdk.UpdateWorkspaceAutostartRequest](schemas.md#codersdkupdateworkspaceautostartrequest) | true | Schedule update request |
|
||||
| Name | In | Type | Required | Description |
|
||||
| ----------- | ---- | ---------------------------------------------------------------------------------------------- | -------- | ----------------------- |
|
||||
| `workspace` | path | string(uuid) | true | Workspace ID |
|
||||
| `body` | body | [codersdk.UpdateWorkspaceAutostartRequest](schemas.md#codersdkupdateworkspaceautostartrequest) | true | Schedule update request |
|
||||
|
||||
### Responses
|
||||
|
||||
@@ -773,10 +773,10 @@ curl -X PUT http://coder-server:8080/api/v2/workspaces/{workspace}/extend \
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | In | Type | Required | Description |
|
||||
| --------- | ---- | ---------------------------------------------------------------------------------- | -------- | ------------------------------ |
|
||||
| workspace | path | string(uuid) | true | Workspace ID |
|
||||
| body | body | [codersdk.PutExtendWorkspaceRequest](schemas.md#codersdkputextendworkspacerequest) | true | Extend deadline update request |
|
||||
| Name | In | Type | Required | Description |
|
||||
| ----------- | ---- | ---------------------------------------------------------------------------------- | -------- | ------------------------------ |
|
||||
| `workspace` | path | string(uuid) | true | Workspace ID |
|
||||
| `body` | body | [codersdk.PutExtendWorkspaceRequest](schemas.md#codersdkputextendworkspacerequest) | true | Extend deadline update request |
|
||||
|
||||
### Example responses
|
||||
|
||||
@@ -826,10 +826,10 @@ curl -X PUT http://coder-server:8080/api/v2/workspaces/{workspace}/ttl \
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | In | Type | Required | Description |
|
||||
| --------- | ---- | ---------------------------------------------------------------------------------- | -------- | ---------------------------- |
|
||||
| workspace | path | string(uuid) | true | Workspace ID |
|
||||
| body | body | [codersdk.UpdateWorkspaceTTLRequest](schemas.md#codersdkupdateworkspacettlrequest) | true | Workspace TTL update request |
|
||||
| Name | In | Type | Required | Description |
|
||||
| ----------- | ---- | ---------------------------------------------------------------------------------- | -------- | ---------------------------- |
|
||||
| `workspace` | path | string(uuid) | true | Workspace ID |
|
||||
| `body` | body | [codersdk.UpdateWorkspaceTTLRequest](schemas.md#codersdkupdateworkspacettlrequest) | true | Workspace TTL update request |
|
||||
|
||||
### Responses
|
||||
|
||||
@@ -854,9 +854,9 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace}/watch \
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | In | Type | Required | Description |
|
||||
| --------- | ---- | ------------ | -------- | ------------ |
|
||||
| workspace | path | string(uuid) | true | Workspace ID |
|
||||
| Name | In | Type | Required | Description |
|
||||
| ----------- | ---- | ------------ | -------- | ------------ |
|
||||
| `workspace` | path | string(uuid) | true | Workspace ID |
|
||||
|
||||
### Example responses
|
||||
|
||||
|
||||
Reference in New Issue
Block a user