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

htmlDocs2.index.mustache Maven / Gradle / Ivy

There is a newer version: 3.0.0-rc1
Show newest version



  
  {{{appName}}}
  
  
  
  {{>js_jquery}}
  {{>js_prettify}}
  {{>js_bootstrap}}
  {{>marked}}
  
  


  

  

{{{appName}}}

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

{{baseName}}

{{#operation}}

{{nickname}}

{{summary}}

{{notes}}


{{path}}

Usage and SDK Samples

curl -X {{vendorExtensions.x-codegen-httpMethodUpperCase}}{{#authMethods}}{{#isApiKey}}{{#isKeyInHeader}} -H "{{keyParamName}}: [[apiKey]]"{{/isKeyInHeader}}{{/isApiKey}}{{#isBasic}}{{#hasProduces}} -H "Accept: {{#produces}}{{{mediaType}}}{{#hasMore}},{{/hasMore}}{{/produces}}"{{/hasProduces}}{{#hasConsumes}} -H "Content-Type: {{#consumes}}{{{mediaType}}}{{#hasMore}},{{/hasMore}}{{/consumes}}"{{/hasConsumes}} -H "Authorization: Basic [[basicHash]]"{{/isBasic}}{{/authMethods}} "{{basePath}}{{path}}{{#hasQueryParams}}?{{#queryParams}}{{^-first}}&{{/-first}}{{baseName}}={{vendorExtensions.x-eg}}{{/queryParams}}{{/hasQueryParams}}"
{{>sample_java}}
{{>sample_android}}
{{>sample_objc}}
{{>sample_js}}
{{>sample_csharp}}
{{>sample_php}}
{{>sample_perl}}
{{>sample_python}}

Parameters

{{#hasPathParams}}
Path parameters
{{#pathParams}} {{>param}} {{/pathParams}}
Name Description
{{/hasPathParams}} {{#hasHeaderParams}}
Header parameters
{{#headerParams}} {{>param}} {{/headerParams}}
Name Description
{{/hasHeaderParams}} {{#hasBodyParam}}
Body parameters
{{#bodyParams}} {{>paramB}} {{/bodyParams}}
Name Description
{{/hasBodyParam}} {{#hasFormParams}}
Form parameters
{{#formParams}} {{>param}} {{/formParams}}
Name Description
{{/hasFormParams}} {{#hasQueryParams}}
Query parameters
{{#queryParams}} {{>param}} {{/queryParams}}
Name Description
{{/hasQueryParams}}

Responses

{{#responses}}

Status: {{code}} - {{message}}

{{#schema}}
{{#examples}}
{{example}}
{{/examples}} {{/schema}} {{#hasHeaders}}
{{#headers}} {{/headers}}
Name Type Format Description
{{#name}}{{name}}{{/name}} {{#datatype}}{{datatype}}{{/datatype}} {{#dataFormat}}{{dataFormat}}{{/dataFormat}} {{#description}}{{description}}{{/description}}
{{/hasHeaders}}
{{/responses}}

{{/operation}}
{{/operations}} {{/apis}} {{/apiInfo}}
{{^hideGenerationTimestamp}}
Generated {{generatedDate}}
{{/hideGenerationTimestamp}}
{{>js_jsonformatter}} {{>js_jsonschemaview}} {{>js_json_schema_ref_parser}} {{>js_json_stringify_safe}} {{>js_webfontloader}}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy