#{{#apiInfo}}{{title}} {{description}} Terms of Service: [{{termsOfServiceUrl}}]({{termsOfServiceUrl}}) Contact: [{{contact}}](mailto:{{contact}}) License: [{{license}}]({{licenseUrl}}) {{/apiInfo}} BasePath: {{basePath}} Api Version: {{apiVersion}} ## APIs {{#apiDocuments}} ### {{resourcePath}} {{#description}} #### Overview {{{description}}} {{/description}} {{#apis}} {{#operations}} #### **{{httpMethod}}** `{{path}}` ##### {{nickname}} {{summary}} {{{notes}}} ###### URL {{url}} ###### Parameters {{#parameters}} - {{paramType}} {{#paras}} {{/paras}}
Parameter Required Description Data Type
{{name}} {{required}} {{description}} {{#linkType}}{{type}}{{/linkType}}{{^linkType}}{{type}}{{/linkType}}
{{/parameters}} {{#responseClass}} ###### Response [{{className}}](#{{classLinkName}}){{^genericClasses}}{{/genericClasses}}{{#genericClasses}}< [{{className}}](#{{classLinkName}}) >{{/genericClasses}} {{/responseClass}} ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| {{#errorResponses}} | {{code}} | {{message}} | {{#linkType}}[{{type}}](#{{linkType}}){{/linkType}}{{^linkType}}{{#type}}{{{type}}}{{/type}}{{^type}}-{{/type}}{{/linkType}} | {{/errorResponses}} {{#samples}} ###### Samples {{/samples}} {{#samples}} {{sampleDescription}} - Sample Request ``` {{{sampleRequest}}} ``` - Sample Response ``` {{{sampleResponse}}} ``` {{/samples}} - - - {{/operations}} {{/apis}} {{/apiDocuments}} ## Data Types {{#dataTypes}} ## {{name}} {{#items}} {{/items}}
type required access description notes
{{#linkType}}{{type}}{{/linkType}}{{^linkType}}{{type}}{{/linkType}} {{#required}}required{{/required}}{{^required}}optional{{/required}} {{#access}}{{{access}}}{{/access}}{{^access}}-{{/access}} {{#description}}{{{description}}}{{/description}}{{^description}}-{{/description}}{{#allowableValue}} Allowable values:{{.}}{{/allowableValue}} {{#notes}}{{{notes}}}{{/notes}}{{^notes}}-{{/notes}}
{{/dataTypes}} {{#enumTypes}} ## {{name}} {{#allowableValues}} {{.}} {{/allowableValues}} {{/enumTypes}}