loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity

fix for issue 4061 (#4064)

Browse Source 
improved the Confluence wiki output to fix issues with tables, added information and improved readability within confluence
This commit is contained in:
deviantlycan 2019-10-06 21:35:39 -05:00 committed by Akihito Nakano
parent f96ed69c26
commit 6082dd217d
1 changed files with 38 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

89
modules/openapi-generator/src/main/resources/confluenceWikiDocs/index.mustache vendored
View File

@ -1,94 +1,81 @@
h1. {{{appName}}} {{{appDescription}}} h1. {{{appName}}}
{{{appDescription}}}
{{#version}}*Version:* {{{version}}}{{/version}} {{#version}}*Version:* {{{version}}}{{/version}}
---- ----
{expand:Table of Contents - Click to expand}
{toc:printable=true|style=square|minLevel=2|maxLevel=3|type=list|outline=false|include=.*} {toc:printable=true|style=square|minLevel=2|maxLevel=3|type=list|outline=false|include=.*}
{expand}
h2. Endpoints h2. Endpoints
{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}} {{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}
h3. {{nickname}}
{status:colour=Yellow|title={{httpMethod}}|subtle=false}
{code}
{{httpMethod}} {{path}}
{code}
*Summary:* {{summary}}
*Description:* {{notes}}
h3. {{nickname}}
{panel:title={{nickname}}|borderStyle=solid|borderColor=#003b6f|titleBGColor=#003b6f|titleColor=#a6b8c7|bgColor=#ffffff}
{{#summary}}*Summary:* {{summary}}{{/summary}}
*Description:* {{notes}}{{^notes}}*No Description*{{/notes}}
h4. Parameters || 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}} {{#hasPathParams}}
h5. Path Parameters h5. Path Parameters
||Name||Description||Required||Default||Pattern|| ||Name||Description||Required||Default||Pattern||{{#pathParams}}
{{#pathParams}}{{>param}} {{>param}}{{/pathParams}}
{{/pathParams}}
{{/hasPathParams}} {{/hasPathParams}}
{{#hasBodyParam}} {{#hasBodyParam}}
h5. Body Parameter h5. Body Parameter
||Name||Description||Required||Default||Pattern|| ||Name||Description||Required||Default||Pattern||
{{#bodyParams}}{{>param}} {{#bodyParams}}{{>param}}{{/bodyParams}}
{{/bodyParams}}
{{/hasBodyParam}} {{/hasBodyParam}}
{{#hasHeaderParams}} {{#hasHeaderParams}}
h5. Header Parameters h5. Header Parameters
||Name||Description||Required||Default||Pattern|| ||Name||Description||Required||Default||Pattern||
{{#headerParams}}{{>param}} {{#headerParams}}{{>param}}{{/headerParams}}
{{/headerParams}}
{{/hasHeaderParams}} {{/hasHeaderParams}}
{{#hasQueryParams}} {{#hasQueryParams}}
h5. Query Parameters h5. Query Parameters
||Name||Description||Required||Default||Pattern|| ||Name||Description||Required||Default||Pattern||
{{#queryParams}}{{>param}} {{#queryParams}}{{>param}}{{/queryParams}}
{{/queryParams}}
{{/hasQueryParams}} {{/hasQueryParams}}
----
h4. Responses
h4. Responses
{{#responses}} {{#responses}}
*Status Code:* {{code}}
*Message:* {{message}}
{code:title=Response Type}
{{{dataType}}}
{code}
See [#models]
{{#hasExamples}} || Status Code | {status:colour=Green|title={{code}}|subtle=false} |
{{#examples}} || Message | {{message}} |
{code:title=Example {{{contentType}}} |collapse=true } || Response Type | {{{dataType}}} |
{{{example}}} || Response Model | [{{dataType}} Model|#{{dataType}}ModelAnchor|Jump to model] |
{code} || Response Schema | {code:collapse=true}{{{jsonSchema}}}{code}{{#examples}}{code:title=Example {{{contentType}}} |collapse=true }{{{example}}}{code}{{/examples}} |
{{/examples}} {{#hasExamples}}{{#examples}}|| Example {{-index}} | {code:title=Example {{{contentType}}} |collapse=true }{{{example}}}{code} |{{/examples}}{{/hasExamples}}
{{/hasExamples}}
{code:title=Response Schema |collapse=true}
{{{jsonSchema}}}
{code}
{{#examples}}
{code:title=Example {{{contentType}}} |collapse=true }
{{{example}}}
{code}
{{/examples}}
{{/responses}} {{/responses}}
---- {panel}
{{/operation}} {{/operation}}
{{/operations}} {{/operations}}
{{/apis}} {{/apis}}
{{/apiInfo}} {{/apiInfo}}
{anchor:models}
h2. Models h2. Models
{{#models}} {{#models}}
{{#model}} {{#model}}
{anchor:{{classname}}ModelAnchor}
h3. {{classname}} h3. {{classname}}
||Field Name||Required||Type||Description|| ||Field Name||Required||Type||Description||
{{#vars}} |{{name}} |{{#isNotRequired}}(x){{/isNotRequired}} |{{dataType}} |{{description}} | {{#vars}} |{{name}} |{{#required}}(/){{/required}}{{^required}}(x){{/required}} |{noformat:nopanel=true}{{{dataType}}}{noformat} |{{description}} |
{{/vars}} {{/vars}}
{{/model}} {{/model}}
{{/models}} {{/models}}