confluenceWikiDocs.index.mustache Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openapi-generator Show documentation
There is a newer version: 7.9.0
h1. {{{appName}}}

{{{appDescription}}}

{{#version}}*Version:* {{{.}}}{{/version}}

----

{expand:Table of Contents - Click to expand}
{toc:printable=true|style=square|minLevel=2|maxLevel=3|type=list|outline=false|include=.*}
{expand}

h2. Endpoints
{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}

h3. {{nickname}}
{panel:title={{nickname}}|borderStyle=solid|borderColor=#003b6f|titleBGColor=#003b6f|titleColor=#a6b8c7|bgColor=#ffffff}
    {{#summary}}*Summary:* {{.}}{{/summary}}
    *Description:* {{notes}}{{^notes}}*No Description*{{/notes}}

	|| HttpMethod | {status:colour=Yellow|title={{httpMethod}}|subtle=false} |
    || Protocol | {noformat:nopanel=true}{{scheme}}{noformat} |
    || Path | {noformat:nopanel=true}{{path}}{noformat} |
    || Base Path | {noformat:nopanel=true}{{basePath}}{noformat} |
    {{#hasProduces}}|| Produces | {noformat:nopanel=true}{{#produces}}{{mediaType}} {{/produces}}{noformat} |{{/hasProduces}}
----
h4. Parameters
    {{#hasPathParams}}
h5. Path Parameters
        ||Name||Description||Type||Required||Default||Pattern||Enum||Example||
        {{#pathParams}}{{>param}}{{/pathParams}}
    {{/hasPathParams}}

    {{#hasBodyParam}}
h5. Body Parameter
        ||Name||Description||Type||Required||Default||Pattern||Enum||Example||
        {{#bodyParams}}{{>param}}{{/bodyParams}}
    {{/hasBodyParam}}

    {{#hasHeaderParams}}
h5. Header Parameters
        ||Name||Description||Type||Required||Default||Pattern||Enum||Example||
        {{#headerParams}}{{>param}}{{/headerParams}}
    {{/hasHeaderParams}}

    {{#hasQueryParams}}
h5. Query Parameters
        ||Name||Description||Type||Required||Default||Pattern||Enum||Example||
        {{#queryParams}}{{>param}}{{/queryParams}}
    {{/hasQueryParams}}
----
h4. Responses
    {{#responses}}

    	|| Status Code | {status:colour={{#is2xx}}Green{{/is2xx}}{{^is2xx}}{{#is4xx}}Orange{{/is4xx}}{{^is4xx}}Red{{/is4xx}}{{/is2xx}}|title={{code}}|subtle=false} |
    	|| Message | {{message}} |
    	|| Response Type | {{{dataType}}} |
    	|| Response Model | [{{dataType}} Model|#{{dataType}}ModelAnchor|Jump to model] |
    	|| Response Schema | {code:collapse=true}{{{jsonSchema}}}{code}{{#examples}}{code:title=Example {{{contentType}}} |collapse=true }{{{example}}}{code}{{/examples}} |
       {{#hasExamples}}{{#examples}}|| Example {{-index}} | {code:title=Example {{{contentType}}} |collapse=true }{{{example}}}{code} |{{/examples}}{{/hasExamples}}

    {{/responses}}
{panel}

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

{anchor:models}
h2. Models

{{#models}}
    {{#model}}
        {anchor:{{classname}}ModelAnchor}
        h3. {{classname}}

        {{{description}}}

        {{#isEnum}} ||Name||Value||Description||
        {{#allowableValues}} {{#enumVars}} |{{{name}}} |{{{value}}} |{{{enumDescription}}} |
        {{/enumVars}}
        {{/allowableValues}} {{/isEnum}}
        {{^isEnum}}||Field Name||Required||Type||Description||Enum||Example||
        {{#vars}} |{{baseName}} |{{#required}}(/){{/required}}{{^required}}(x){{/required}} |{noformat:nopanel=true}{{{dataType}}}{noformat} | {{description}} | {{#isEnum}} {{_enum}} {{/isEnum}} | {{example}}
        {{/vars}} {{/isEnum}}
    {{/model}}
{{/models}}