forked from loafle/openapi-generator-original
Fix header parameters display in the documentation (#1579)
* fix header parameters display in html * fix cwiki header, remove test header parameter
This commit is contained in:
parent
8f8d3547f6
commit
cf2ddb8b8c
@ -27,6 +27,6 @@ fi
|
|||||||
|
|
||||||
# if you've executed sbt assembly previously it will use that instead.
|
# if you've executed sbt assembly previously it will use that instead.
|
||||||
export JAVA_OPTS="${JAVA_OPTS} -XX:MaxPermSize=256M -Xmx1024M -DloggerPath=conf/log4j.properties"
|
export JAVA_OPTS="${JAVA_OPTS} -XX:MaxPermSize=256M -Xmx1024M -DloggerPath=conf/log4j.properties"
|
||||||
ags="generate -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g cwiki -o samples/documentation/cwiki $@"
|
ags="generate -t modules/openapi-generator/src/main/resources/confluenceWikiDocs -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g cwiki -o samples/documentation/cwiki $@"
|
||||||
|
|
||||||
java $JAVA_OPTS -jar $executable $ags
|
java $JAVA_OPTS -jar $executable $ags
|
||||||
|
@ -27,6 +27,6 @@ fi
|
|||||||
|
|
||||||
# if you've executed sbt assembly previously it will use that instead.
|
# if you've executed sbt assembly previously it will use that instead.
|
||||||
export JAVA_OPTS="${JAVA_OPTS} -XX:MaxPermSize=256M -Xmx1024M -DloggerPath=conf/log4j.properties"
|
export JAVA_OPTS="${JAVA_OPTS} -XX:MaxPermSize=256M -Xmx1024M -DloggerPath=conf/log4j.properties"
|
||||||
ags="generate -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g html -o samples/documentation/html $@"
|
ags="generate -t modules/openapi-generator/src/main/resources/htmlDocs -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g html -o samples/documentation/html $@"
|
||||||
|
|
||||||
java $JAVA_OPTS -jar $executable $ags
|
java $JAVA_OPTS -jar $executable $ags
|
||||||
|
@ -35,8 +35,8 @@ h2. Endpoints
|
|||||||
{{#hasHeaderParams}}
|
{{#hasHeaderParams}}
|
||||||
h5. Header Parameters
|
h5. Header Parameters
|
||||||
||Name||Description||Required||Default||Pattern||
|
||Name||Description||Required||Default||Pattern||
|
||||||
{{#headerParam}}{{>param}}
|
{{#headerParams}}{{>param}}
|
||||||
{{/headerParam}}
|
{{/headerParams}}
|
||||||
{{/hasHeaderParams}}
|
{{/hasHeaderParams}}
|
||||||
|
|
||||||
{{#hasQueryParams}}
|
{{#hasQueryParams}}
|
||||||
|
@ -1,3 +1,3 @@
|
|||||||
{{#isHeaderParam}}<div class="param">{{baseName}} {{^required}}(optional){{/required}}{{#required}}(required){{/required}}</div>
|
<div class="param">{{baseName}} {{^required}}(optional){{/required}}{{#required}}(required){{/required}}</div>
|
||||||
|
|
||||||
<div class="param-desc"><span class="param-type">Header Parameter</span> — {{unescapedDescription}} {{#defaultValue}}default: {{{defaultValue}}} {{/defaultValue}}{{#dataFormat}}format: {{{dataFormat}}}{{/dataFormat}}</div>{{/isHeaderParam}}
|
<div class="param-desc"><span class="param-type">Header Parameter</span> — {{unescapedDescription}} {{#defaultValue}}default: {{{defaultValue}}} {{/defaultValue}}{{#dataFormat}}format: {{{dataFormat}}}{{/dataFormat}}</div>
|
||||||
|
@ -83,7 +83,7 @@
|
|||||||
{{#hasHeaderParams}}
|
{{#hasHeaderParams}}
|
||||||
<h3 class="field-label">Request headers</h3>
|
<h3 class="field-label">Request headers</h3>
|
||||||
<div class="field-items">
|
<div class="field-items">
|
||||||
{{#headerParam}}{{>headerParam}}{{/headerParam}}
|
{{#headerParams}}{{>headerParam}}{{/headerParams}}
|
||||||
</div> <!-- field-items -->
|
</div> <!-- field-items -->
|
||||||
{{/hasHeaderParams}}
|
{{/hasHeaderParams}}
|
||||||
|
|
||||||
|
@ -1 +1 @@
|
|||||||
3.2.1-SNAPSHOT
|
3.3.4-SNAPSHOT
|
@ -59,12 +59,14 @@ h2. Endpoints
|
|||||||
h4. Parameters
|
h4. Parameters
|
||||||
h5. Path Parameters
|
h5. Path Parameters
|
||||||
||Name||Description||Required||Default||Pattern||
|
||Name||Description||Required||Default||Pattern||
|
||||||
|petId |Pet id to delete |(/) | | |
|
|petId |Pet id to delete |(/) |null | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
h5. Header Parameters
|
h5. Header Parameters
|
||||||
||Name||Description||Required||Default||Pattern||
|
||Name||Description||Required||Default||Pattern||
|
||||||
|
|apiKey | |(x) |null | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -103,7 +105,7 @@ h2. Endpoints
|
|||||||
|
|
||||||
h5. Query Parameters
|
h5. Query Parameters
|
||||||
||Name||Description||Required||Default||Pattern||
|
||Name||Description||Required||Default||Pattern||
|
||||||
|status |Status values that need to be considered for filter |(/) | | |
|
|status |Status values that need to be considered for filter |(/) |null | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -174,7 +176,7 @@ array[Pet]
|
|||||||
|
|
||||||
h5. Query Parameters
|
h5. Query Parameters
|
||||||
||Name||Description||Required||Default||Pattern||
|
||Name||Description||Required||Default||Pattern||
|
||||||
|tags |Tags to filter by |(/) | | |
|
|tags |Tags to filter by |(/) |null | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -242,7 +244,7 @@ array[Pet]
|
|||||||
h4. Parameters
|
h4. Parameters
|
||||||
h5. Path Parameters
|
h5. Path Parameters
|
||||||
||Name||Description||Required||Default||Pattern||
|
||Name||Description||Required||Default||Pattern||
|
||||||
|petId |ID of pet to return |(/) | | |
|
|petId |ID of pet to return |(/) |null | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -391,7 +393,7 @@ Pet
|
|||||||
h4. Parameters
|
h4. Parameters
|
||||||
h5. Path Parameters
|
h5. Path Parameters
|
||||||
||Name||Description||Required||Default||Pattern||
|
||Name||Description||Required||Default||Pattern||
|
||||||
|petId |ID of pet that needs to be updated |(/) | | |
|
|petId |ID of pet that needs to be updated |(/) |null | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -430,7 +432,7 @@ Pet
|
|||||||
h4. Parameters
|
h4. Parameters
|
||||||
h5. Path Parameters
|
h5. Path Parameters
|
||||||
||Name||Description||Required||Default||Pattern||
|
||Name||Description||Required||Default||Pattern||
|
||||||
|petId |ID of pet to update |(/) | | |
|
|petId |ID of pet to update |(/) |null | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -475,7 +477,7 @@ ApiResponse
|
|||||||
h4. Parameters
|
h4. Parameters
|
||||||
h5. Path Parameters
|
h5. Path Parameters
|
||||||
||Name||Description||Required||Default||Pattern||
|
||Name||Description||Required||Default||Pattern||
|
||||||
|orderId |ID of the order that needs to be deleted |(/) | | |
|
|orderId |ID of the order that needs to be deleted |(/) |null | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -574,7 +576,7 @@ map[String, Integer]
|
|||||||
h4. Parameters
|
h4. Parameters
|
||||||
h5. Path Parameters
|
h5. Path Parameters
|
||||||
||Name||Description||Required||Default||Pattern||
|
||Name||Description||Required||Default||Pattern||
|
||||||
|orderId |ID of pet that needs to be fetched |(/) | | |
|
|orderId |ID of pet that needs to be fetched |(/) |null | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -836,7 +838,7 @@ Order
|
|||||||
h4. Parameters
|
h4. Parameters
|
||||||
h5. Path Parameters
|
h5. Path Parameters
|
||||||
||Name||Description||Required||Default||Pattern||
|
||Name||Description||Required||Default||Pattern||
|
||||||
|username |The name that needs to be deleted |(/) | | |
|
|username |The name that needs to be deleted |(/) |null | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -890,7 +892,7 @@ Order
|
|||||||
h4. Parameters
|
h4. Parameters
|
||||||
h5. Path Parameters
|
h5. Path Parameters
|
||||||
||Name||Description||Required||Default||Pattern||
|
||Name||Description||Required||Default||Pattern||
|
||||||
|username |The name that needs to be fetched. Use user1 for testing. |(/) | | |
|
|username |The name that needs to be fetched. Use user1 for testing. |(/) |null | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -973,9 +975,9 @@ User
|
|||||||
|
|
||||||
h5. Query Parameters
|
h5. Query Parameters
|
||||||
||Name||Description||Required||Default||Pattern||
|
||Name||Description||Required||Default||Pattern||
|
||||||
|username |The user name for login |(/) | | |
|
|username |The user name for login |(/) |null | |
|
||||||
|
|
||||||
|password |The password for login in clear text |(/) | | |
|
|password |The password for login in clear text |(/) |null | |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -1088,7 +1090,7 @@ String
|
|||||||
h4. Parameters
|
h4. Parameters
|
||||||
h5. Path Parameters
|
h5. Path Parameters
|
||||||
||Name||Description||Required||Default||Pattern||
|
||Name||Description||Required||Default||Pattern||
|
||||||
|username |name that need to be deleted |(/) | | |
|
|username |name that need to be deleted |(/) |null | |
|
||||||
|
|
||||||
|
|
||||||
h5. Body Parameter
|
h5. Body Parameter
|
||||||
|
@ -1 +1 @@
|
|||||||
3.3.2-SNAPSHOT
|
3.3.4-SNAPSHOT
|
@ -284,6 +284,9 @@ font-style: italic;
|
|||||||
|
|
||||||
<h3 class="field-label">Request headers</h3>
|
<h3 class="field-label">Request headers</h3>
|
||||||
<div class="field-items">
|
<div class="field-items">
|
||||||
|
<div class="param">api_key (optional)</div>
|
||||||
|
|
||||||
|
<div class="param-desc"><span class="param-type">Header Parameter</span> — default: null </div>
|
||||||
|
|
||||||
</div> <!-- field-items -->
|
</div> <!-- field-items -->
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user