mirror of
https://github.com/OpenAPITools/openapi-generator.git
synced 2025-07-04 06:30:52 +00:00
Add - Status colors in Wiki, Example per parameter (#12394)
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:
parent
c270640a36
commit
11462e7fde
@ -27,32 +27,32 @@ h3. {{nickname}}
|
|||||||
h4. Parameters
|
h4. Parameters
|
||||||
{{#hasPathParams}}
|
{{#hasPathParams}}
|
||||||
h5. Path Parameters
|
h5. Path Parameters
|
||||||
||Name||Description||Type||Required||Default||Pattern||Enum||
|
||Name||Description||Type||Required||Default||Pattern||Enum||Example||
|
||||||
{{#pathParams}}{{>param}}{{/pathParams}}
|
{{#pathParams}}{{>param}}{{/pathParams}}
|
||||||
{{/hasPathParams}}
|
{{/hasPathParams}}
|
||||||
|
|
||||||
{{#hasBodyParam}}
|
{{#hasBodyParam}}
|
||||||
h5. Body Parameter
|
h5. Body Parameter
|
||||||
||Name||Description||Type||Required||Default||Pattern||Enum||
|
||Name||Description||Type||Required||Default||Pattern||Enum||Example||
|
||||||
{{#bodyParams}}{{>param}}{{/bodyParams}}
|
{{#bodyParams}}{{>param}}{{/bodyParams}}
|
||||||
{{/hasBodyParam}}
|
{{/hasBodyParam}}
|
||||||
|
|
||||||
{{#hasHeaderParams}}
|
{{#hasHeaderParams}}
|
||||||
h5. Header Parameters
|
h5. Header Parameters
|
||||||
||Name||Description||Required||Default||Pattern||
|
||Name||Description||Type||Required||Default||Pattern||Enum||Example||
|
||||||
{{#headerParams}}{{>param}}{{/headerParams}}
|
{{#headerParams}}{{>param}}{{/headerParams}}
|
||||||
{{/hasHeaderParams}}
|
{{/hasHeaderParams}}
|
||||||
|
|
||||||
{{#hasQueryParams}}
|
{{#hasQueryParams}}
|
||||||
h5. Query Parameters
|
h5. Query Parameters
|
||||||
||Name||Description||Required||Default||Pattern||
|
||Name||Description||Type||Required||Default||Pattern||Enum||Example||
|
||||||
{{#queryParams}}{{>param}}{{/queryParams}}
|
{{#queryParams}}{{>param}}{{/queryParams}}
|
||||||
{{/hasQueryParams}}
|
{{/hasQueryParams}}
|
||||||
----
|
----
|
||||||
h4. Responses
|
h4. Responses
|
||||||
{{#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}} |
|
|| Message | {{message}} |
|
||||||
|| Response Type | {{{dataType}}} |
|
|| Response Type | {{{dataType}}} |
|
||||||
|| Response Model | [{{dataType}} Model|#{{dataType}}ModelAnchor|Jump to model] |
|
|| Response Model | [{{dataType}} Model|#{{dataType}}ModelAnchor|Jump to model] |
|
||||||
@ -81,8 +81,8 @@ h2. Models
|
|||||||
{{#allowableValues}} {{#enumVars}} |{{{name}}} |{{{value}}} |{{{enumDescription}}} |
|
{{#allowableValues}} {{#enumVars}} |{{{name}}} |{{{value}}} |{{{enumDescription}}} |
|
||||||
{{/enumVars}}
|
{{/enumVars}}
|
||||||
{{/allowableValues}} {{/isEnum}}
|
{{/allowableValues}} {{/isEnum}}
|
||||||
{{^isEnum}}||Field Name||Required||Type||Description||Enum||
|
{{^isEnum}}||Field Name||Required||Type||Description||Enum||Example||
|
||||||
{{#vars}} |{{baseName}} |{{#required}}(/){{/required}}{{^required}}(x){{/required}} |{noformat:nopanel=true}{{{dataType}}}{noformat} |{{description}} | {{#isEnum}} {{_enum}} {{/isEnum}} |
|
{{#vars}} |{{baseName}} |{{#required}}(/){{/required}}{{^required}}(x){{/required}} |{noformat:nopanel=true}{{{dataType}}}{noformat} | {{description}} | {{#isEnum}} {{_enum}} {{/isEnum}} | {{example}}
|
||||||
{{/vars}} {{/isEnum}}
|
{{/vars}} {{/isEnum}}
|
||||||
{{/model}}
|
{{/model}}
|
||||||
{{/models}}
|
{{/models}}
|
||||||
|
Loading…
x
Reference in New Issue
Block a user