htmlDocs2.index.mustache Maven / Gradle / Ivy

Go to download

{{{appName}}} {{>js_jquery}} {{>js_prettify}} {{>js_bootstrap}} {{>marked}} API Summary {{#apiInfo}} {{#apis}} {{#operations}} API Methods - {{baseName}} {{#operation}} {{nickname}} {{/operation}} {{/operations}} {{/apis}} {{/apiInfo}} {{{appName}}} API and SDK Documentation {{#version}} Version: {{{version}}} {{/version}} {{{appDescription}}} {{#apiInfo}} {{#apis}} {{#operations}} {{baseName}} {{#operation}} {{nickname}} {{summary}} {{notes}} {{path}} Usage and SDK Samples Curl Java Android Obj-C JavaScript C# PHP Perl Python Rust curl -X {{vendorExtensions.x-codegen-http-method-upper-case}}{{#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}} {{>sample_rust}} Scopes {{#authMethods}}{{#scopes}} {{/scopes}}{{/authMethods}} {{scope}} {{description}} 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}} {{#schema}} Schema {{#examples}} Response Example {{/examples}} {{/schema}} {{#hasHeaders}} Headers {{/hasHeaders}} {{#vendorExtensions}} {{#x-shared-errors}} {{/x-shared-errors}} {{/vendorExtensions}} {{#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}} Suggestions, contact, support and error reporting; {{#infoUrl}} Information URL: {{{infoUrl}}} {{/infoUrl}} {{#infoEmail}} Contact Info: {{{infoEmail}}} {{/infoEmail}} {{#licenseInfo}} {{{licenseInfo}}} {{/licenseInfo}} {{#licenseUrl}} {{{licenseUrl}}} {{/licenseUrl}} {{^hideGenerationTimestamp}} Generated {{generatedDate}} {{/hideGenerationTimestamp}} {{>js_jsonformatter}} {{>js_jsonschemaview}} {{>js_json_schema_ref_parser}} {{>js_json_stringify_safe}} {{>js_webfontloader}}