37 lines
1.0 KiB
Handlebars
37 lines
1.0 KiB
Handlebars
= {{swagger.info.title}}
|
|
Version: {{swagger.info.version}}
|
|
CONFIDENTIAL: DO NOT DISTRIBUTE WITHOUT EXPRESS WRITTEN PERMISSION FROM COMCARDE LTD
|
|
|
|
== Overview
|
|
{{#if swagger.info.description}}
|
|
{{swagger.info.description}}
|
|
{{else}}
|
|
This section documents the REST API. available to the HTML5 & javascript-based
|
|
dashboard. For details on the security considerations relating to the design,
|
|
please see <<webconsole-overview- >>.
|
|
{{/if}}
|
|
|
|
=== URI scheme
|
|
Base Path:: {{swagger.basePath}}
|
|
Schemes:: {{#each swagger.schemes}}{{this}}{{#unless @last}}, {{/unless}}{{/each}}
|
|
|
|
=== Content Types
|
|
Consumes:: {{#each swagger.consumes}}{{this}}{{#unless @last}}, {{/unless}}{{/each}}
|
|
Produces:: {{#each swagger.produces}}{{this}}{{#unless @last}}, {{/unless}}{{/each}}
|
|
|
|
=== Security Schemes
|
|
{{#each swagger.securityDefinitions}}
|
|
[[{{@key}}]]{{@key}}:: {{description}}
|
|
{{/each}}
|
|
|
|
==== Default Security
|
|
{{#each swagger.security}}
|
|
{{#each this}}
|
|
* **{{@key}}**
|
|
{{/each}}
|
|
{{/each}}
|
|
|
|
include::paths.adoc[]
|
|
include::responses.adoc[]
|
|
include::definitions.adoc[]
|