mirror of https://github.com/coder/coder.git
cfd02d959c
* docs: Applications * WIP * WIP * WIP * Fix: consume * Fix: @Description * Fix * docs: apiroot, buildinfo, csp * Fix: buildinfo * docs: updatecheck * docs: apiroot * Fix: s/none//g * Fix: godoc nice * Fix: description * Fix: It * Fix: code sample trim empty line * More fixes * Fix: br * Merge * Fix: no-security on updatecheck * Fix: code tags * Fix: enumerated values in code tags * Rephrased * Address PR comments * Fix: URL, id * Fix: array items * Fix: any property * Fix: array item singular |
||
---|---|---|
.. | ||
README.md | ||
authentication.def | ||
code_shell.dot | ||
debug.def | ||
main.dot | ||
operation.dot | ||
parameters.def | ||
responses.def | ||
security.def |
README.md
Swagger / OpenAPI 2 and OpenAPI 3 template parameters
Note that properties of OpenAPI objects will be in OpenAPI 3.0 form, as Swagger / OpenAPI 2.0 definitions are converted automatically.
Code templates
method
- the HTTP method of the operation (in lower-case)methodUpper
- the HTTP method of the operation (in upper-case)url
- the full URL of the operation (including protocol and host)consumes[]
- an array of MIME-types the operation consumesproduces[]
- an array of MIME-types the operation producesoperation
- the current operation objectoperationId
- the current operation idopName
- the operationId if set, otherwise the method + pathtags[]
- the full list of tags applying to the operationsecurity
- the security definitions applying to the operationresource
- the current tag/path objectparameters[]
- an array of parameters for the operation (see below)queryString
- an example queryString, urlEncodedrequiredQueryString
- an example queryString forrequired:true
parametersqueryParameters[]
- a subset ofparameters
that arein:query
requiredParameters[]
- a subset ofqueryParameters
that arerequired:true
headerParameters[]
- a subset ofparameters
that arein:header
allHeaders[]
- a concatenation ofheaderParameters
and pseudo-parametersAccept
andContent-Type
, and optionallyAuthorization
(the latter has anisAuth
boolean property set true so it can be omitted in templates if desired
Parameter template
parameters[]
- an array of parameters, including the following pseudo-propertiesshortDesc
- a truncated version of the parameter descriptionsafeType
- a computed version of the parameter type, including Body and schema namesoriginalType
- the original type of the parameterexampleValues
- an object containing examples for use in code-templatesjson
- example values in JSON compatible syntaxobject
- example values in raw object form (unquoted strings etc)
depth
- a zero-based indicator of the depth of expanded request body parameters
enums[]
- an array of (parameter)name/value pairs
Responses template
responses[]
- an array of responses, includingstatus
andmeaning
properties
Authentication template
authenticationStr
- a simple string of methods (and scopes where appropriate)securityDefinitions[]
- an array of applicable securityDefinitions
Schema Property template
schemaProperties[]
- an array ofname
type
required
description
enums[]
- an array of (schema property)name/value pairs
Common to all templates
openapi
- the top-level OpenAPI / Swagger documentheader
- the front-matter of the Slate/Shins markdown documenthost
- the (computed) host of the APIprotocol
- the default/first protocol of the APIbaseUrl
- the (computed) baseUrl of the API (including protocol and host)widdershins
- the contents of widdershinspackage.json