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
Swagger notice
  • Loading branch information
@mtojek
mtojek committed Jan 3, 2023
commit ec782b200f6aa4ecbd7ba0c0ca5dc30c1f567e14
2 changes: 0 additions & 2 deletions docs/api/files.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@ curl -X POST http://coder-server:8080/api/v2/files \

`POST /files`

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

> Body parameter

```yaml
Expand Down
14 changes: 12 additions & 2 deletions scripts/apidocgen/markdown-template/operation.dot
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,17 @@
{{
function renderCodeSample(data) {
const originalCodeSample = data.utils.getCodeSamples(data);
return originalCodeSample.replace("\n```\n", "```\n")
return originalCodeSample.replace("\n```\n", "```\n");
}

function renderDescription(data) {
if (!data.operation.description) {
return "";
}
if (data.operation.description.startsWith("Swagger notice:")) {
return "";
}
return data.operation.description;
}
}}
{{= data.tags.section }}
Expand All @@ -27,7 +37,7 @@

{{? data.operation.summary && !data.options.tocSummary}}*{{= data.operation.summary }}*{{?}}

{{? data.operation.description}}{{= data.operation.description }}{{?}}
{{= renderDescription(data)}}

{{? data.operation.requestBody}}
> Body parameter
Expand Down