Skip to content

docs: API workspace agents and builds #5538

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
merged 20 commits into from
Jan 5, 2023
Merged

docs: API workspace agents and builds #5538

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
a3fbe72
docs: audit, deploymentconfig, files, parameters
mtojek Dec 22, 2022
fbe1d70
Swagger comments in workspacebuilds.go
mtojek Jan 2, 2023
96daf47
structs in workspacebuilds.go
mtojek Jan 2, 2023
663ec87
workspaceagents: instance identity
mtojek Jan 2, 2023
fc00d7e
workspaceagents.go in progress
mtojek Jan 2, 2023
67a85b9
workspaceagents.go in progress
mtojek Jan 2, 2023
ce8c7ea
Agents
mtojek Jan 2, 2023
d2a9af5
workspacebuilds.go
mtojek Jan 2, 2023
f37c6b3
/workspaces
mtojek Jan 3, 2023
596cdbd
Merge branch 'main' into 3522-workspacebuilds-1
mtojek Jan 3, 2023
eb4ba48
Merge
mtojek Jan 3, 2023
e314c24
x-apidocgen
mtojek Jan 4, 2023
97cd7ac
NullTime hack not needed anymore
mtojek Jan 4, 2023
ae06598
Fix: x-apidocgen
mtojek Jan 4, 2023
a88968c
Fix: header
mtojek Jan 5, 2023
4519636
Fix: header
mtojek Jan 5, 2023
6bb31ce
Fix: authentication.def
mtojek Jan 5, 2023
fb2e7c3
Merge branch 'main' into 3522-workspacebuilds-1
mtojek Jan 5, 2023
d38b26c
Fix: authentication.def
mtojek Jan 5, 2023
20dcb3a
Fix: dot
mtojek Jan 5, 2023
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
Prev Previous commit
Fix: dot
  • Loading branch information
@mtojek
mtojek committed Jan 5, 2023
commit 20dcb3a1d5514cdf6ed2dcff86cbd4fb7b9e2bfc
18 changes: 9 additions & 9 deletions docs/api/agents.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ curl -X POST http://coder-server:8080/api/v2/workspaceagents/aws-instance-identi
| ------ | ------------------------------------------------------- | ----------- | ---------------------------------------------------------------------------------------------------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceAgentAuthenticateResponse](schemas.md#codersdkworkspaceagentauthenticateresponse) |

To perform this operation, you must be authenticated. [Learn more](authentication.md)
To perform this operation, you must be authenticated. [Learn more](authentication.md).

## Authenticate agent on Azure instance

Expand Down Expand Up @@ -94,7 +94,7 @@ curl -X POST http://coder-server:8080/api/v2/workspaceagents/azure-instance-iden
| ------ | ------------------------------------------------------- | ----------- | ---------------------------------------------------------------------------------------------------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceAgentAuthenticateResponse](schemas.md#codersdkworkspaceagentauthenticateresponse) |

To perform this operation, you must be authenticated. [Learn more](authentication.md)
To perform this operation, you must be authenticated. [Learn more](authentication.md).

## Authenticate agent on Google Cloud instance

Expand Down Expand Up @@ -140,7 +140,7 @@ curl -X POST http://coder-server:8080/api/v2/workspaceagents/google-instance-ide
| ------ | ------------------------------------------------------- | ----------- | ---------------------------------------------------------------------------------------------------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceAgentAuthenticateResponse](schemas.md#codersdkworkspaceagentauthenticateresponse) |

To perform this operation, you must be authenticated. [Learn more](authentication.md)
To perform this operation, you must be authenticated. [Learn more](authentication.md).

## Submit workspace application health

Expand Down Expand Up @@ -178,7 +178,7 @@ curl -X POST http://coder-server:8080/api/v2/workspaceagents/me/app-health \
| ------ | ------------------------------------------------------- | ----------- | ------ |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | |

To perform this operation, you must be authenticated. [Learn more](authentication.md)
To perform this operation, you must be authenticated. [Learn more](authentication.md).

## Coordinate workspace agent via Tailnet

Expand All @@ -201,7 +201,7 @@ incoming connections and publishes node updates.
| ------ | ------------------------------------------------------------------------ | ------------------- | ------ |
| 101 | [Switching Protocols](https://tools.ietf.org/html/rfc7231#section-6.2.2) | Switching Protocols | |

To perform this operation, you must be authenticated. [Learn more](authentication.md)
To perform this operation, you must be authenticated. [Learn more](authentication.md).

## Get workspace agent Git auth

Expand Down Expand Up @@ -241,7 +241,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/me/gitauth?url=http%
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------------------------------------------------ |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceAgentGitAuthResponse](schemas.md#codersdkworkspaceagentgitauthresponse) |

To perform this operation, you must be authenticated. [Learn more](authentication.md)
To perform this operation, you must be authenticated. [Learn more](authentication.md).

## Get workspace agent Git SSH key

Expand Down Expand Up @@ -273,7 +273,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/me/gitsshkey \
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------------------ |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.AgentGitSSHKey](schemas.md#codersdkagentgitsshkey) |

To perform this operation, you must be authenticated. [Learn more](authentication.md)
To perform this operation, you must be authenticated. [Learn more](authentication.md).

## Get authorized workspace agent metadata

Expand Down Expand Up @@ -382,7 +382,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/me/metadata \
| ------ | ------------------------------------------------------- | ----------- | ---------------------------------------------------------------------------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceAgentMetadata](schemas.md#codersdkworkspaceagentmetadata) |

To perform this operation, you must be authenticated. [Learn more](authentication.md)
To perform this operation, you must be authenticated. [Learn more](authentication.md).

## Submit workspace agent stats

Expand Down Expand Up @@ -436,4 +436,4 @@ curl -X POST http://coder-server:8080/api/v2/workspaceagents/me/report-stats \
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------------------------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.AgentStatsResponse](schemas.md#codersdkagentstatsresponse) |

To perform this operation, you must be authenticated. [Learn more](authentication.md)
To perform this operation, you must be authenticated. [Learn more](authentication.md).
4 changes: 2 additions & 2 deletions docs/api/applications.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ curl -X GET http://coder-server:8080/api/v2/applications/auth-redirect \
| ------ | ----------------------------------------------------------------------- | ------------------ | ------ |
| 307 | [Temporary Redirect](https://tools.ietf.org/html/rfc7231#section-6.4.7) | Temporary Redirect | |

To perform this operation, you must be authenticated. [Learn more](authentication.md)
To perform this operation, you must be authenticated. [Learn more](authentication.md).

## Get applications host

Expand Down Expand Up @@ -57,4 +57,4 @@ curl -X GET http://coder-server:8080/api/v2/applications/host \
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------------------------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.GetAppHostResponse](schemas.md#codersdkgetapphostresponse) |

To perform this operation, you must be authenticated. [Learn more](authentication.md)
To perform this operation, you must be authenticated. [Learn more](authentication.md).
4 changes: 2 additions & 2 deletions docs/api/audit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ curl -X GET http://coder-server:8080/api/v2/audit?q=string \
| ------ | ------------------------------------------------------- | ----------- | ---------------------------------------------------------------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.AuditLogResponse](schemas.md#codersdkauditlogresponse) |

To perform this operation, you must be authenticated. [Learn more](authentication.md)
To perform this operation, you must be authenticated. [Learn more](authentication.md).

## Generate fake audit log

Expand Down Expand Up @@ -126,4 +126,4 @@ curl -X POST http://coder-server:8080/api/v2/audit/testgenerate \
| ------ | --------------------------------------------------------------- | ----------- | ------ |
| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | |

To perform this operation, you must be authenticated. [Learn more](authentication.md)
To perform this operation, you must be authenticated. [Learn more](authentication.md).
2 changes: 1 addition & 1 deletion docs/api/authorization.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,4 +66,4 @@ curl -X POST http://coder-server:8080/api/v2/authcheck \
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------------------------------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.AuthorizationResponse](schemas.md#codersdkauthorizationresponse) |

To perform this operation, you must be authenticated. [Learn more](authentication.md)
To perform this operation, you must be authenticated. [Learn more](authentication.md).
14 changes: 7 additions & 7 deletions docs/api/builds.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild} \
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------------------ |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceBuild](schemas.md#codersdkworkspacebuild) |

To perform this operation, you must be authenticated. [Learn more](authentication.md)
To perform this operation, you must be authenticated. [Learn more](authentication.md).

## Cancel workspace build

Expand Down Expand Up @@ -186,7 +186,7 @@ curl -X PATCH http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/c
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------ |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) |

To perform this operation, you must be authenticated. [Learn more](authentication.md)
To perform this operation, you must be authenticated. [Learn more](authentication.md).

## Get workspace build logs

Expand Down Expand Up @@ -257,7 +257,7 @@ Status Code **200**
| `log_level` | `warn` |
| `log_level` | `error` |

To perform this operation, you must be authenticated. [Learn more](authentication.md)
To perform this operation, you must be authenticated. [Learn more](authentication.md).

## Get workspace resources for workspace build

Expand Down Expand Up @@ -440,7 +440,7 @@ Status Code **200**
| `workspace_transition` | `stop` |
| `workspace_transition` | `delete` |

To perform this operation, you must be authenticated. [Learn more](authentication.md)
To perform this operation, you must be authenticated. [Learn more](authentication.md).

## Get provisioner state for workspace build

Expand Down Expand Up @@ -582,7 +582,7 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/sta
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------------------ |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceBuild](schemas.md#codersdkworkspacebuild) |

To perform this operation, you must be authenticated. [Learn more](authentication.md)
To perform this operation, you must be authenticated. [Learn more](authentication.md).

## Get workspace builds by workspace ID

Expand Down Expand Up @@ -857,7 +857,7 @@ Status Code **200**
| `transition` | `stop` |
| `transition` | `delete` |

To perform this operation, you must be authenticated. [Learn more](authentication.md)
To perform this operation, you must be authenticated. [Learn more](authentication.md).

## Create workspace build

Expand Down Expand Up @@ -1022,4 +1022,4 @@ curl -X POST http://coder-server:8080/api/v2/workspaces/{id}/builds \
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------------------ |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceBuild](schemas.md#codersdkworkspacebuild) |

To perform this operation, you must be authenticated. [Learn more](authentication.md)
To perform this operation, you must be authenticated. [Learn more](authentication.md).
4 changes: 2 additions & 2 deletions docs/api/files.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ file: string
| ------ | ------------------------------------------------------------ | ----------- | ------------------------------------------------------------ |
| 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.UploadResponse](schemas.md#codersdkuploadresponse) |

To perform this operation, you must be authenticated. [Learn more](authentication.md)
To perform this operation, you must be authenticated. [Learn more](authentication.md).

## Get file by ID

Expand All @@ -72,4 +72,4 @@ curl -X GET http://coder-server:8080/api/v2/files/{fileID} \
| ------ | ------------------------------------------------------- | ----------- | ------ |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | |

To perform this operation, you must be authenticated. [Learn more](authentication.md)
To perform this operation, you must be authenticated. [Learn more](authentication.md).
4 changes: 2 additions & 2 deletions docs/api/general.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -923,7 +923,7 @@ curl -X GET http://coder-server:8080/api/v2/config/deployment \
| ------ | ------------------------------------------------------- | ----------- | ---------------------------------------------------------------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.DeploymentConfig](schemas.md#codersdkdeploymentconfig) |

To perform this operation, you must be authenticated. [Learn more](authentication.md)
To perform this operation, you must be authenticated. [Learn more](authentication.md).

## Report CSP violations

Expand Down Expand Up @@ -958,7 +958,7 @@ curl -X POST http://coder-server:8080/api/v2/csp/reports \
| ------ | ------------------------------------------------------- | ----------- | ------ |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | |

To perform this operation, you must be authenticated. [Learn more](authentication.md)
To perform this operation, you must be authenticated. [Learn more](authentication.md).

## Update check

Expand Down
6 changes: 3 additions & 3 deletions docs/api/parameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ Status Code **200**
| `source_scheme` | `none` |
| `source_scheme` | `data` |

To perform this operation, you must be authenticated. [Learn more](authentication.md)
To perform this operation, you must be authenticated. [Learn more](authentication.md).

## Create parameter

Expand Down Expand Up @@ -151,7 +151,7 @@ curl -X POST http://coder-server:8080/api/v2/parameters/{scope}/{id} \
| ------ | ------------------------------------------------------------ | ----------- | -------------------------------------------------- |
| 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.Parameter](schemas.md#codersdkparameter) |

To perform this operation, you must be authenticated. [Learn more](authentication.md)
To perform this operation, you must be authenticated. [Learn more](authentication.md).

## Delete parameter

Expand Down Expand Up @@ -205,4 +205,4 @@ curl -X DELETE http://coder-server:8080/api/v2/parameters/{scope}/{id}/{name} \
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------ |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) |

To perform this operation, you must be authenticated. [Learn more](authentication.md)
To perform this operation, you must be authenticated. [Learn more](authentication.md).
12 changes: 6 additions & 6 deletions docs/api/templates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ curl -X POST http://coder-server:8080/api/v2/organizations/{organization-id}/tem
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------ |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Template](schemas.md#codersdktemplate) |

To perform this operation, you must be authenticated. [Learn more](authentication.md)
To perform this operation, you must be authenticated. [Learn more](authentication.md).

## Get templates by organization

Expand Down Expand Up @@ -179,7 +179,7 @@ Status Code **200**
| `» updated_at` | string(date-time) | false | | |
| `» workspace_owner_count` | integer | false | | |

To perform this operation, you must be authenticated. [Learn more](authentication.md)
To perform this operation, you must be authenticated. [Learn more](authentication.md).

## Get templates by organization and template name

Expand Down Expand Up @@ -242,7 +242,7 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/templat
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------ |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Template](schemas.md#codersdktemplate) |

To perform this operation, you must be authenticated. [Learn more](authentication.md)
To perform this operation, you must be authenticated. [Learn more](authentication.md).

## Get template metadata by ID

Expand Down Expand Up @@ -304,7 +304,7 @@ curl -X GET http://coder-server:8080/api/v2/templates/{id} \
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------ |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Template](schemas.md#codersdktemplate) |

To perform this operation, you must be authenticated. [Learn more](authentication.md)
To perform this operation, you must be authenticated. [Learn more](authentication.md).

## Delete template by ID

Expand Down Expand Up @@ -348,7 +348,7 @@ curl -X DELETE http://coder-server:8080/api/v2/templates/{id} \
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------ |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) |

To perform this operation, you must be authenticated. [Learn more](authentication.md)
To perform this operation, you must be authenticated. [Learn more](authentication.md).

## Update template metadata by ID

Expand Down Expand Up @@ -410,4 +410,4 @@ curl -X PATCH http://coder-server:8080/api/v2/templates/{id} \
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------ |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Template](schemas.md#codersdktemplate) |

To perform this operation, you must be authenticated. [Learn more](authentication.md)
To perform this operation, you must be authenticated. [Learn more](authentication.md).
Loading