Skip to content

docs: api root, buildinfo, csp #5493

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.

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 31 commits into from
Dec 22, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
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
docs: apiroot
  • Loading branch information
mtojek committed Dec 21, 2022
commit 40291615d946cadb0cf422bfebbff9603dcd9d95
5 changes: 0 additions & 5 deletions coderd/apidoc/docs.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,6 @@ const docTemplate = `{
"paths": {
"/": {
"get": {
"security": [
{
"CoderSessionToken": []
}
],
"produces": [
"application/json"
],
Expand Down
5 changes: 0 additions & 5 deletions coderd/apidoc/swagger.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,6 @@
"paths": {
"/": {
"get": {
"security": [
{
"CoderSessionToken": []
}
],
"produces": ["application/json"],
"tags": ["General"],
"summary": "API root handler",
Expand Down
1 change: 0 additions & 1 deletion coderd/apiroot.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ import (

// @Summary API root handler
// @ID api-root-handler
// @Security CoderSessionToken
// @Produce json
// @Tags General
// @Success 200 {object} codersdk.Response
Expand Down
5 changes: 2 additions & 3 deletions docs/api/general.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@
```shell
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/ \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
-H 'Accept: application/json'

```

Expand Down Expand Up @@ -39,7 +38,7 @@ curl -X GET http://coder-server:8080/api/v2/ \
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------ |
| 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**.
undefined

## Build info

Expand Down