static.api-docs.markdown.mustache Maven / Gradle / Ivy

Go to download
# {{apiInfo.title}}

Version: {{apiVersion}}

Endpoints:
{{#apiDocuments}}
- [`{{resourcePath}}`](#{{anchor}}) - {{description}}
{{/apiDocuments}}

Models:
{{#dataTypes}}
- [`{{name}}`](#{{anchor}})
{{/dataTypes}}
{{^dataTypes}}
- *none*
{{/dataTypes}}

- - -

## Endpoints
{{#apiDocuments}}
### {{resourcePath}}
{{#description}}
#### Overview
{{{description}}}
{{/description}}

{{#apis}}
{{#operations}}
#### **{{httpMethod}}** `{{path}}`

{{summary}}
{{{notes}}}

###### Parameters
{{#parameters}}
**{{paramType}}**

| Parameter | Required | Description | Data Type |
|-----------|----------|-------------|-----------|
{{#paras}}
| {{ name }} | {{ required }} | {{ description }} | {{#linkType}}{{type}}{{/linkType}}{{^linkType}}{{type}}{{/linkType}} |
{{/paras}}
{{/parameters}}
{{^parameters}}
- No parameters
{{/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}}
{{^errorResponses}}
| - | - | - |
{{/errorResponses}}

{{#samples}}
###### Samples
{{/samples}}
{{#samples}}
{{sampleDescription}}

- Sample Request

```
{{{sampleRequest}}}
```

- Sample Response

```
{{{sampleResponse}}}
```

{{/samples}}

- - -
{{/operations}}
{{/apis}}
{{/apiDocuments}}

## Data Types
{{#dataTypes}}

## {{name}}

| name | type | required | description |
|------|------|----------|-------------|
{{#items}}
| {{name}} | {{#linkType}}{{type}}{{/linkType}}{{^linkType}}{{type}}{{/linkType}} | {{#required}}required{{/required}}{{^required}}optional{{/required}} | {{#description}}{{{description}}}{{/description}}{{#allowableValue}} Allowable values: {{.}}{{/allowableValue}} |
{{/items}}

{{/dataTypes}}

{{#enumTypes}}

## {{name}}
{{#allowableValues}}
{{.}}
{{/allowableValues}}
{{/enumTypes}}