Skip to content

docs: audit, deploymentconfig, files, parameters #5506

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

docs: audit, deploymentconfig, files, parameters #5506

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
a3fbe72
docs: audit, deploymentconfig, files, parameters
mtojek Dec 22, 2022
c13dc1c
Fix: mark as binary
mtojek Jan 3, 2023
230d34a
Fix: show format in docs
mtojek Jan 3, 2023
a014423
Fix: use .swaggo
mtojek Jan 3, 2023
cbc7dcb
Merge branch 'main' into 3522-document-more-methods-3
mtojek Jan 3, 2023
b9a5f0e
Fix: swagger notice
mtojek Jan 3, 2023
ec782b2
Swagger notice
mtojek Jan 3, 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
Fix: swagger notice
  • Loading branch information
@mtojek
mtojek committed Jan 3, 2023
commit b9a5f0e509096740097e7783c106ac4bc5d2e22a
2 changes: 1 addition & 1 deletion coderd/apidoc/docs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,7 +310,7 @@ const docTemplate = `{
"CoderSessionToken": []
}
],
"description": "Notice: Swagger 2.0 doesn't support file upload with a ` + "`" + `content-type` + "`" + ` different than ` + "`" + `application/x-www-form-urlencoded` + "`" + `.",
"description": "Swagger notice: Swagger 2.0 doesn't support file upload with a ` + "`" + `content-type` + "`" + ` different than ` + "`" + `application/x-www-form-urlencoded` + "`" + `.",
"consumes": [
"application/x-tar"
],
Expand Down
2 changes: 1 addition & 1 deletion coderd/apidoc/swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,7 @@
"CoderSessionToken": []
}
],
"description": "Notice: Swagger 2.0 doesn't support file upload with a `content-type` different than `application/x-www-form-urlencoded`.",
"description": "Swagger notice: Swagger 2.0 doesn't support file upload with a `content-type` different than `application/x-www-form-urlencoded`.",
"consumes": ["application/x-tar"],
"produces": ["application/json"],
"tags": ["Files"],
Expand Down
2 changes: 1 addition & 1 deletion coderd/files.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ const (
)

// @Summary Upload file
// @Description Notice: Swagger 2.0 doesn't support file upload with a `content-type` different than `application/x-www-form-urlencoded`.
// @Description Swagger notice: Swagger 2.0 doesn't support file upload with a `content-type` different than `application/x-www-form-urlencoded`.
// @ID update-file
// @Security CoderSessionToken
// @Produce json
Expand Down
2 changes: 1 addition & 1 deletion docs/api/files.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ curl -X POST http://coder-server:8080/api/v2/files \

`POST /files`

Notice: Swagger 2.0 doesn't support file upload with a `content-type` different than `application/x-www-form-urlencoded`.
Swagger notice: Swagger 2.0 doesn't support file upload with a `content-type` different than `application/x-www-form-urlencoded`.

> Body parameter

Expand Down