10000 docs: API templateversions, templates, members, organizations by mtojek · Pull Request #5546 · coder/coder · GitHub
[go: up one dir, main page]
Skip to content

docs: API templateversions, templates, members, organizations #5546

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 26 commits into from
Jan 11, 2023
Merged

docs: API templateversions, templates, members, organizations #5546

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
26 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
250982a
templates.go, templateversions.go
mtojek Jan 3, 2023
ff622a7
templateversion.go in progress
mtojek Jan 3, 2023
9dd385c
cancel
mtojek Jan 3, 2023
f96351a
templateversions
mtojek Jan 3, 2023
15de3b6
wip
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
c82eb01
Merge branch '3522-workspacebuilds-1' into 3522-templates-1
mtojek Jan 4, 2023
77815d3
Merge branch '3522-templates-1' into 3522-organizations-1
mtojek Jan 4, 2023
7aa0f65
Members
mtojek Jan 4, 2023
b93398e
Fixes
mtojek Jan 4, 2023
5c96bd5
Fix
mtojek Jan 4, 2023
0cd9c4a
Merge branch 'main' into 3522-templates-1
mtojek Jan 5, 2023
afcd7c2
Merge branch 'main' into 3522-templates-1
mtojek Jan 10, 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
Next Next commit
Merge branch 'main' into 3522-templates-1
  • Loading branch information
@mtojek
mtojek committed Jan 5, 2023
commit 0cd9c4a283085e2c5e7951d90925dd788b44d0a8
11 changes: 0 additions & 11 deletions coderd/workspaceagents.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -983,17 +983,6 @@ func (api *API) postWorkspaceAppHealth(rw http.ResponseWriter, r *http.Request)
httpapi.Write(ctx, rw, http.StatusOK, nil)
}

// @Summary Get workspace agent Git auth
// @ID get-workspace-agent-git-auth
// @Security CoderSessionToken
// @Accept json
// @Produce json
// @Tags Agents
// @Param url query string true "Git URL" format(uri)
// @Param listen query bool false "Wait for a new token to be issued"
// @Success 200 {object} codersdk.WorkspaceAgentGitAuthResponse
// @Router /workspaceagents/me/gitauth [get]
//
// workspaceAgentsGitAuth returns a username and password for use
// with GIT_ASKPASS.
//
Expand Down
6 changes: 3 additions & 3 deletions coderd/workspacebuilds.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,6 +274,9 @@ func (api *API) workspaceBuildByBuildNumber(rw http.ResponseWriter, r *http.Requ
httpapi.Write(ctx, rw, http.StatusOK, apiBuild)
}

// Azure supports instance identity verification:
// https://docs.microsoft.com/en-us/azure/virtual-machines/windows/instance-metadata-service?tabs=linux#tabgroup_14
//
// @Summary Create workspace build
// @ID create-workspace-build
// @Security CoderSessionToken
Expand All @@ -284,9 +287,6 @@ func (api *API) workspaceBuildByBuildNumber(rw http.ResponseWriter, r *http.Requ
// @Param request body codersdk.CreateWorkspaceBuildRequest true "Create workspace build request"
// @Success 200 {object} codersdk.WorkspaceBuild
// @Router /workspaces/{id}/builds [post]
//
// Azure supports instance identity verification:
// https://docs.microsoft.com/en-us/azure/virtual-machines/windows/instance-metadata-service?tabs=linux#tabgroup_14
func (api *API) postWorkspaceBuilds(rw http.ResponseWriter, r *http.Request) {
ctx := r.Context()
apiKey := httpmw.APIKey(r)
Expand Down
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 by means of one of the following methods: **CoderSessionToken**.
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 by means of one of the following methods: **CoderSessionToken**.
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 by means of one of the following methods: **CoderSessionToken**.
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 by means of one of the following methods: **CoderSessionToken**.
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 by means of one of the following methods: **CoderSessionToken**.
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 by means of one of the following methods: **CoderSessionToken**.
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 by means of one of the following methods: **CoderSessionToken**.
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 by means of one of the following methods: **CoderSessionToken**.
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 by means of one of the following methods: **CoderSessionToken**.
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 by means of one of the following methods: **CoderSessionToken**.
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 by means of one of the following methods: **CoderSessionToken**.
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 by means of one of the following methods: **CoderSessionToken**.
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 by means of one of the following methods: **CoderSessionToken**.
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 by means of one of the following methods: **CoderSessionToken**.
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 by means of one of the following methods: **CoderSessionToken**.
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 by means of one of the following methods: **CoderSessionToken**.
To perform this operation, you must be authenticated. [Learn more](authentication.md).
4 changes: 2 additions & 2 deletions docs/api/members.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Status Code **200**
| `» display_name` | string | false | | |
| `» name` | string | false | | |

To perform this operation, you must be authenticated by means of one of the following methods: **CoderSessionToken**.
To perform this operation, you must be authenticated. [Learn more](authentication.md).

## Assign role to organization member

Expand Down Expand Up @@ -109,4 +109,4 @@ curl -X PUT http://coder-server:8080/api/v2/organizations/{organization}/members
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------------------------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.OrganizationMember](schemas.md#codersdkorganizationmember) |

To perform this operation, you must be authenticated by means of one of the following methods: **CoderSessionToken**.
To perform this operation, you must be authenticated. [Learn more](authentication.md).
4 changes: 2 additions & 2 deletions
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ curl -X POST http://coder-server:8080/api/v2/organizations \
| ------ | ------------------------------------------------------------ | ----------- | -------------------------------------------------------- |
| 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.Organization](schemas.md#codersdkorganization) |

To perform this operation, you must be authenticated by means of one of the following methods: **CoderSessionToken**.
To perform this operation, you must be authenticated. [Learn more](authentication.md).

## Get organization by ID

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

To perform this operation, you must be authenticated by means of one of the following methods: **CoderSessionToken**.
To perform this operation, you must be authenticated. [Learn more](authentication.md).
Loading
You are viewing a condensed version of this merge commit. You can view the full changes here.
0