synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-15 22:20:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: API workspace agents and builds (#5538)

Browse Source
This commit is contained in:
Marcin Tojek
2023-01-05 15:27:10 +01:00
committed by GitHub
parent e6b17b6ea7
commit 66fa2a1a8c
25 changed files with 4334 additions and 254 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
scripts/apidocgen/markdown-template/authentication.def
View File

@ -1 +1 @@
To perform this operation, you must be authenticated by means of one of the following methods: **{{= data.utils.getAuthenticationStr(data) }}**.
To perform this operation, you must be authenticated. [Learn more](authentication.md).

11
scripts/apidocgen/markdown-template/main.dot
View File

@ -93,12 +93,13 @@
> This page is incomplete, stay tuned.
{{ for (var s in data.components.schemas) {
if (s == "codersdk.NullTime") {
continue;
}
var origSchema = data.components.schemas[s];
var schema = data.api.components.schemas[s];
if (schema.description && schema.description.startsWith("x-apidocgen:skip")) {
continue;
}
}}
{{ var origSchema = data.components.schemas[s]; }}
{{ var schema = data.api.components.schemas[s]; }}
{{= data.tags.section }}
## {{=s}}

6
scripts/apidocgen/markdown-template/operation.dot
View File

@ -18,6 +18,12 @@
## {{= data.operationUniqueName}}
{{
if (data.operation['x-apidocgen'] && data.operation['x-apidocgen'].skip) {
return "";
}
}}
{{ data.methodUpper = data.method.verb.toUpperCase(); }}
{{ data.url = data.utils.slashes(data.baseUrl + data.method.path); }}
{{ data.parameters = data.operation.parameters; }}