mirror of
https://github.com/coder/coder.git
synced 2025-07-03 16:13:58 +00:00
e67d131514
* docs: audit, deploymentconfig, files, parameters * Fix: mark as binary * Fix: show format in docs * Fix: use .swaggo * Fix: swagger notice * Swagger notice
54 lines
1.3 KiB
Modula-2
54 lines
1.3 KiB
Modula-2
{{
|
|
function renderParameterType(p) {
|
|
if (p.schema['x-widdershins-oldRef']) {
|
|
const aType = p.schema['x-widdershins-oldRef'].replace("#/components/schemas/","");
|
|
const href = aType.replace(".","").toLowerCase();
|
|
return "[" + aType + "](schemas.md#" + href + ")";
|
|
}
|
|
if (p.safeType == 'string(binary)') {
|
|
return 'binary';
|
|
}
|
|
return p.safeType;
|
|
}
|
|
}}
|
|
{{= data.tags.section }}
|
|
### Parameters
|
|
|
|
|Name|In|Type|Required|Description|
|
|
|---|---|---|---|---|
|
|
{{~ data.parameters :p}}|`{{=p.name}}`|{{=p.in}}|{{= renderParameterType(p)}}|{{=p.required}}|{{=p.shortDesc||''}}|
|
|
{{~}}
|
|
|
|
{{? data.longDescs }}
|
|
#### Detailed descriptions
|
|
{{~ data.parameters :p}}{{? p.shortDesc !== p.description}}
|
|
**{{=p.name}}**: {{=p.description}}{{?}}
|
|
{{~}}
|
|
{{?}}
|
|
|
|
{{~ data.parameters :p}}
|
|
|
|
{{? p.schema && p.schema.enum }}
|
|
{{~ p.schema.enum :e}}
|
|
{{ var entry = {}; entry.name = p.name; entry.value = e; data.enums.push(entry); }}
|
|
{{~}}
|
|
{{?}}
|
|
|
|
{{? p.schema && p.schema.items && p.schema.items.enum }}
|
|
{{~ p.schema.items.enum :e}}
|
|
{{ var entry = {}; entry.name = p.name; entry.value = e; data.enums.push(entry); }}
|
|
{{~}}
|
|
{{?}}
|
|
|
|
{{~}}
|
|
|
|
{{? data.enums && data.enums.length }}
|
|
#### Enumerated Values
|
|
|
|
|Parameter|Value|
|
|
|---|---|
|
|
{{~ data.enums :e}}|`{{=e.name}}`|`{{=data.utils.toPrimitive(e.value)}}`|
|
|
{{~}}
|
|
{{?}}
|
|
{{= data.tags.endSection }}
|