mirror of
https://github.com/coder/coder.git
synced 2026-09-24 15:04:27 +08:00
docs: applications and authorization (#5477)
* docs: Applications * WIP * WIP * WIP * Fix: consume * Fix: @Description * Fix * Fix: s/none//g * Fix: godoc nice * Fix: description * Fix: It * Fix: code sample trim empty line * More fixes * Fix: br
This commit is contained in:
@@ -1,4 +1,4 @@
|
||||
# Example request using curl
|
||||
curl -X {{=data.methodUpper}} http://coder-server:8080{{=data.url}}{{=data.requiredQueryString}}{{?data.allHeaders.length}} \{{?}}
|
||||
{{~data.allHeaders :p:index}} -H '{{=p.name}}: {{=p.exampleValues.object}}'{{?index < data.allHeaders.length-1}} \{{?}}
|
||||
{{~}}
|
||||
{{~data.allHeaders :p:index}} -H '{{=p.name}}: {{=p.exampleValues.object}}'{{?index < data.allHeaders.length-1}} \
|
||||
{{?}}{{~}}
|
||||
|
||||
@@ -30,26 +30,22 @@
|
||||
|
||||
function renderDescription(p) {
|
||||
if (!p.description) {
|
||||
return "none";
|
||||
return "";
|
||||
}
|
||||
|
||||
const toSnakeCase = str =>
|
||||
str
|
||||
.match(/[A-Z]{2,}(?=[A-Z][a-z]+[0-9]*|\b)|[A-Z]?[a-z]+[0-9]*|[A-Z]|[0-9]+/g)
|
||||
.map(x => x.toLowerCase())
|
||||
.join('_');
|
||||
|
||||
const words = p.description.split(' ');
|
||||
const description = p.description.replaceAll("<br><br>", "\n").replaceAll("<br>", " ");
|
||||
const words = description.split(' ');
|
||||
if (words.length == 0) {
|
||||
return "none";
|
||||
return "";
|
||||
}
|
||||
|
||||
const countUppercase = words[0].length - words[0].replace(/[A-Z]/g, '').length;
|
||||
if (countUppercase > 1) {
|
||||
const displayName = p.displayName.charAt(0).toUpperCase() + p.displayName.replaceAll("_", " ").toLowerCase().slice(1);
|
||||
let displayName = p.displayName.replaceAll("» **additionalProperties**", "It");
|
||||
displayName = displayName.charAt(0).toUpperCase() + displayName.replaceAll("_", " ").toLowerCase().slice(1);
|
||||
return displayName + " " + words.slice(1).join(' ');
|
||||
}
|
||||
return p.description;
|
||||
return description;
|
||||
}
|
||||
}}
|
||||
|
||||
@@ -130,7 +126,7 @@
|
||||
|
||||
{{? block.rows.length}}|Name|Type|Required|Restrictions|Description|
|
||||
|---|---|---|---|---|{{?}}
|
||||
{{~ block.rows :p}}|{{= renderDisplayName(p)}}|{{= renderPropertyType(p)}}|{{=p.required}}|{{=p.restrictions||'none'}}|{{= renderDescription(p)}}|
|
||||
{{~ block.rows :p}}|{{= renderDisplayName(p)}}|{{= renderPropertyType(p)}}|{{=p.required}}|{{=p.restrictions||''}}|{{= renderDescription(p)}}|
|
||||
{{~}}
|
||||
{{~}}
|
||||
{{? (blocks[0].rows.length === 0) && (blocks.length === 1) }}
|
||||
|
||||
@@ -1,3 +1,9 @@
|
||||
{{
|
||||
function renderCodeSample(data) {
|
||||
const originalCodeSample = data.utils.getCodeSamples(data);
|
||||
return originalCodeSample.replace("\n```\n", "```\n")
|
||||
}
|
||||
}}
|
||||
{{= data.tags.section }}
|
||||
|
||||
## {{= data.operationUniqueName}}
|
||||
@@ -14,7 +20,7 @@
|
||||
{{? data.options.codeSamples || data.operation["x-code-samples"] }}
|
||||
### Code samples
|
||||
|
||||
{{= data.utils.getCodeSamples(data)}}
|
||||
{{=renderCodeSample(data)}}
|
||||
{{?}}
|
||||
|
||||
`{{= data.methodUpper}} {{=data.method.path}}`
|
||||
|
||||
@@ -13,7 +13,7 @@
|
||||
|
||||
|Name|In|Type|Required|Description|
|
||||
|---|---|---|---|---|
|
||||
{{~ data.parameters :p}}|{{=p.name}}|{{=p.in}}|{{= renderParameterType(p)}}|{{=p.required}}|{{=p.shortDesc || 'none'}}|
|
||||
{{~ data.parameters :p}}|{{=p.name}}|{{=p.in}}|{{= renderParameterType(p)}}|{{=p.required}}|{{=p.shortDesc||''}}|
|
||||
{{~}}
|
||||
|
||||
{{? data.longDescs }}
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
break;
|
||||
}
|
||||
if (!content) {
|
||||
return "no schema";
|
||||
return "";
|
||||
}
|
||||
|
||||
var ref = content.schema["x-widdershins-oldRef"];
|
||||
@@ -42,7 +42,7 @@
|
||||
|
||||
|Status|Meaning|Description|Schema|
|
||||
|---|---|---|---|
|
||||
{{~ data.responses :r}}|{{=r.status}}|{{=r.meaning}}|{{=r.description || 'none'}}|{{= renderResponseType(r)}}|
|
||||
{{~ data.responses :r}}|{{=r.status}}|{{=r.meaning}}|{{=r.description||''}}|{{= renderResponseType(r)}}|
|
||||
{{~}}
|
||||
|
||||
{{ data.responseSchemas = false; }}
|
||||
@@ -77,7 +77,7 @@ Status Code **{{=response.status}}**
|
||||
{{?}}
|
||||
|Name|Type|Required|Restrictions|Description|
|
||||
|---|---|---|---|---|
|
||||
{{~block.rows :p}}|{{=p.displayName}}|{{? p.$ref}}`{{=p.$ref}}`{{?}}{{? !p.$ref}}{{=p.type}}{{?}}|{{=p.required}}|{{=p.restrictions||'none'}}|{{=p.description||'none'}}|
|
||||
{{~block.rows :p}}|{{=p.displayName}}|{{? p.$ref}}`{{=p.$ref}}`{{?}}{{? !p.$ref}}{{=p.type}}{{?}}|{{=p.required}}|{{=p.restrictions||''}}|{{=p.description||''}}|
|
||||
{{~}}
|
||||
{{~}}
|
||||
{{?}}
|
||||
@@ -106,7 +106,7 @@ Status Code **{{=response.status}}**
|
||||
|
||||
|Status|Header|Type|Format|Description|
|
||||
|---|---|---|---|---|
|
||||
{{~ data.responseHeaders :h}}|{{=h.status}}|{{=h.header}}|{{=h.type}}|{{=h.format||''}}|{{=h.description||'none'}}|
|
||||
{{~ data.responseHeaders :h}}|{{=h.status}}|{{=h.header}}|{{=h.type}}|{{=h.format||''}}|{{=h.description||''}}|
|
||||
{{~}}
|
||||
|
||||
{{?}}
|
||||
|
||||
Reference in New Issue
Block a user