• Home
• org.openapitools
• openapi-generator
• 5.0.1
• source code
• index.mustache

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

htmlDocs.index.mustache Maven / Gradle / Ivy

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

    {{#authMethods}}
      
{{#isBasic}}HTTP Basic Authentication{{/isBasic}}{{#isOAuth}}OAuth AuthorizationUrl:{{authorizationUrl}}TokenUrl:{{tokenUrl}}{{/isOAuth}}{{#isApiKey}}APIKey KeyParamName:{{keyParamName}} KeyInQuery:{{isKeyInQuery}} KeyInHeader:{{isKeyInHeader}}{{/isApiKey}}
    {{/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}}
  

  {{#operation}}
  
{{httpMethod}} {{path}}
  {{/operation}}
  
  {{/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}}
        {{#simpleType}}{{dataType}}{{/simpleType}}
    {{#examples}}
    
Example data
    
Content-Type: {{{contentType}}}
    
{{example}}
    {{/examples}}
    {{/responses}}
  
 
  

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

  
Models
  [ Jump to Methods ]

  
Table of Contents
  

  {{#models}}
  {{#model}}
    
{{name}}{{#title}} - {{title}}{{/title}}
  {{/model}}
  {{/models}}
  

  {{#models}}
  {{#model}}
  

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

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