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

Fix header parameters display in the documentation (#1579)

Browse Source 
* fix header parameters display in html

* fix cwiki header, remove test header parameter
This commit is contained in:
William Cheng 2018-11-30 20:57:52 +08:00 committed by GitHub
parent 8f8d3547f6
commit cf2ddb8b8c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 29 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
bin/cwiki-petstore.sh
View File

@ -27,6 +27,6 @@ fi
# 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"
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

2
bin/html-petstore.sh
View File

@ -27,6 +27,6 @@ fi
# 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"
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

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

@ -35,8 +35,8 @@ h2. Endpoints
{{#hasHeaderParams}}
h5. Header Parameters
||Name||Description||Required||Default||Pattern||
{{#headerParam}}{{>param}}
{{/headerParam}}
{{#headerParams}}{{>param}}
{{/headerParams}}
{{/hasHeaderParams}}
{{#hasQueryParams}}

4
modules/openapi-generator/src/main/resources/htmlDocs/headerParam.mustache
View File

@ -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> &mdash; {{unescapedDescription}} {{#defaultValue}}default: {{{defaultValue}}} {{/defaultValue}}{{#dataFormat}}format: {{{dataFormat}}}{{/dataFormat}}</div>{{/isHeaderParam}}
<div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; {{unescapedDescription}} {{#defaultValue}}default: {{{defaultValue}}} {{/defaultValue}}{{#dataFormat}}format: {{{dataFormat}}}{{/dataFormat}}</div>

2
modules/openapi-generator/src/main/resources/htmlDocs/index.mustache
View File

@ -83,7 +83,7 @@
{{#hasHeaderParams}}
<h3 class="field-label">Request headers</h3>
<div class="field-items">
{{#headerParam}}{{>headerParam}}{{/headerParam}}
{{#headerParams}}{{>headerParam}}{{/headerParams}}
</div> <!-- field-items -->
{{/hasHeaderParams}}

2
samples/documentation/cwiki/.openapi-generator/VERSION
View File

@ -1 +1 @@
3.2.1-SNAPSHOT
3.3.4-SNAPSHOT

30
samples/documentation/cwiki/confluence-markup.txt
View File

@ -59,13 +59,15 @@ h2. Endpoints
h4. Parameters
h5. Path Parameters
||Name||Description||Required||Default||Pattern||
|petId |Pet id to delete |(/) | | |
|petId |Pet id to delete |(/) |null | |
h5. Header Parameters
||Name||Description||Required||Default||Pattern||
|apiKey | |(x) |null | |
@ -103,7 +105,7 @@ h2. Endpoints
h5. Query Parameters
||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
||Name||Description||Required||Default||Pattern||
|tags |Tags to filter by |(/) | | |
|tags |Tags to filter by |(/) |null | |
@ -242,7 +244,7 @@ array[Pet]
h4. Parameters
h5. Path Parameters
||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
h5. Path Parameters
||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
h5. Path Parameters
||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
h5. Path Parameters
||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
h5. Path Parameters
||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
h5. Path Parameters
||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
h5. Path Parameters
||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
||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
h5. Path Parameters
||Name||Description||Required||Default||Pattern||
|username |name that need to be deleted |(/) | | |
|username |name that need to be deleted |(/) |null | |
h5. Body Parameter

2
samples/documentation/html/.openapi-generator/VERSION
View File

@ -1 +1 @@
3.3.2-SNAPSHOT
3.3.4-SNAPSHOT

5
samples/documentation/html/index.html
View File

@ -284,7 +284,10 @@ font-style: italic;
<h3 class="field-label">Request headers</h3>
<div class="field-items">
<div class="param">api_key (optional)</div>
<div class="param-desc"><span class="param-type">Header Parameter</span> &mdash; default: null </div>
</div> <!-- field-items -->