All Downloads are FREE. Search and download functionalities are using the official Maven repository.

htmlDocs.index.mustache Maven / Gradle / Ivy

There is a newer version: 7.8.0
Show newest version


  
    {{{appName}}}
    
  
  
  

{{{appName}}}

{{{appDescription}}}
{{#infoUrl}}
More information: {{{infoUrl}}}
{{/infoUrl}} {{#infoEmail}}
Contact Info: {{{infoEmail}}}
{{/infoEmail}} {{#version}}
Version: {{{.}}}
{{/version}} {{#basePathWithoutHost}}
BasePath:{{.}}
{{/basePathWithoutHost}}
{{{licenseInfo}}}
{{{licenseUrl}}}

Access

{{#hasAuthMethods}}
    {{#authMethods}}
  1. {{#isBasicBasic}}HTTP Basic Authentication{{/isBasicBasic}}{{#isBasicBearer}}HTTP Bearer Token authentication{{#bearerFormat}} ({{{.}}}){{/bearerFormat}}{{/isBasicBearer}}{{#isHttpSignature}}HTTP signature authentication{{/isHttpSignature}}{{#isOAuth}}OAuth AuthorizationUrl:{{authorizationUrl}}TokenUrl:{{tokenUrl}}{{/isOAuth}}{{#isApiKey}}APIKey KeyParamName:{{keyParamName}} KeyInQuery:{{isKeyInQuery}} KeyInHeader:{{isKeyInHeader}}{{/isApiKey}}
  2. {{/authMethods}}
{{/hasAuthMethods}}

Methods

[ Jump to Models ] {{! for the tables of content, I cheat and don't use CSS styles.... }}

Table of Contents

{{access}}
{{#apiInfo}} {{#apis}} {{#operations}}

{{baseName}}

{{/operations}} {{/apis}} {{/apiInfo}} {{#apiInfo}} {{#apis}} {{#operations}}

{{baseName}}

{{#operation}}
Up
{{httpMethod}} {{path}}
{{summary}} ({{nickname}})
{{! notes is operation.description. So why rename it and make it super confusing???? }}
{{notes}}
{{#hasPathParams}}

Path parameters

{{#pathParams}}{{>pathParam}}{{/pathParams}}
{{/hasPathParams}} {{#hasConsumes}}

Consumes

This API call consumes the following media types via the Content-Type request header:
    {{#consumes}}
  • {{{mediaType}}}
  • {{/consumes}}
{{/hasConsumes}} {{#hasBodyParam}}

Request body

{{#bodyParams}}{{>bodyParam}}{{/bodyParams}}
{{/hasBodyParam}} {{#hasHeaderParams}}

Request headers

{{#headerParams}}{{>headerParam}}{{/headerParams}}
{{/hasHeaderParams}} {{#hasQueryParams}}

Query parameters

{{#queryParams}}{{>queryParam}}{{/queryParams}}
{{/hasQueryParams}} {{#hasFormParams}}

Form parameters

{{#formParams}}{{>formParam}}{{/formParams}}
{{/hasFormParams}} {{#returnType}}

Return type

{{#hasReference}}{{^returnSimpleType}}{{returnContainer}}[{{/returnSimpleType}}{{returnBaseType}}{{^returnSimpleType}}]{{/returnSimpleType}}{{/hasReference}} {{^hasReference}}{{returnType}}{{/hasReference}}
{{/returnType}} {{#hasExamples}} {{#examples}}

Example data

Content-Type: {{{contentType}}}
{{{example}}}
{{/examples}} {{/hasExamples}} {{#hasProduces}}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    {{#produces}}
  • {{{mediaType}}}
  • {{/produces}}
{{/hasProduces}}

Responses

{{#responses}}

{{code}}

{{message}} {{^containerType}}{{dataType}}{{/containerType}} {{#examples}}

Example data

Content-Type: {{{contentType}}}
{{example}}
{{/examples}} {{/responses}}

{{/operation}} {{/operations}} {{/apis}} {{/apiInfo}}

Models

[ Jump to Methods ]

Table of Contents

    {{#models}} {{#model}}
  1. {{name}}{{#title}} - {{.}}{{/title}}
  2. {{/model}} {{/models}}
{{#models}} {{#model}}

{{name}}{{#title}} - {{.}}{{/title}} Up

{{#unescapedDescription}}
{{.}}
{{/unescapedDescription}}
{{#vars}}
{{name}} {{^required}}(optional){{/required}}
{{^isPrimitiveType}}{{dataType}}{{/isPrimitiveType}} {{unescapedDescription}} {{#dataFormat}}format: {{{.}}}{{/dataFormat}}
{{#isEnum}}
Enum:
{{#_enum}}
{{this}}
{{/_enum}} {{/isEnum}} {{/vars}}
{{/model}} {{/models}}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy