loafle/openapi-generator-original
3
0
Fork 1
mirror of https://github.com/OpenAPITools/openapi-generator.git synced 2025-07-03 22:20:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add - Status colors in Wiki, Example per parameter (#12394)

Browse Source 
This are small (but visually nice) improvements:
- Add colors: 200 = green, 300 = blue, 400 = red
- Add an example per parameter for better understanding
This commit is contained in:
chatelao 2022-05-21 08:49:19 +02:00 committed by GitHub
parent c270640a36
commit 11462e7fde
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -27,32 +27,32 @@ h3. {{nickname}}
h4. Parameters
{{#hasPathParams}}
h5. Path Parameters
||Name||Description||Type||Required||Default||Pattern||Enum||
||Name||Description||Type||Required||Default||Pattern||Enum||Example||
{{#pathParams}}{{>param}}{{/pathParams}}
{{/hasPathParams}}
{{#hasBodyParam}}
h5. Body Parameter
||Name||Description||Type||Required||Default||Pattern||Enum||
||Name||Description||Type||Required||Default||Pattern||Enum||Example||
{{#bodyParams}}{{>param}}{{/bodyParams}}
{{/hasBodyParam}}
{{#hasHeaderParams}}
h5. Header Parameters
||Name||Description||Required||Default||Pattern||
||Name||Description||Type||Required||Default||Pattern||Enum||Example||
{{#headerParams}}{{>param}}{{/headerParams}}
{{/hasHeaderParams}}
{{#hasQueryParams}}
h5. Query Parameters
||Name||Description||Required||Default||Pattern||
||Name||Description||Type||Required||Default||Pattern||Enum||Example||
{{#queryParams}}{{>param}}{{/queryParams}}
{{/hasQueryParams}}
----
h4. Responses
{{#responses}}
|| Status Code | {status:colour=Green|title={{code}}|subtle=false} |
|| 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] |
@ -81,8 +81,8 @@ h2. Models
{{#allowableValues}} {{#enumVars}} |{{{name}}} |{{{value}}} |{{{enumDescription}}} |
{{/enumVars}}
{{/allowableValues}} {{/isEnum}}
{{^isEnum}}||Field Name||Required||Type||Description||Enum||
{{#vars}} |{{baseName}} |{{#required}}(/){{/required}}{{^required}}(x){{/required}} |{noformat:nopanel=true}{{{dataType}}}{noformat} |{{description}} | {{#isEnum}} {{_enum}} {{/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}}