Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions bin/configs/html.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
generatorName: html
outputDir: samples/documentation/html
inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore.yaml
templateDir: modules/openapi-generator/src/main/resources/htmlDocs
additionalProperties:
hideGenerationTimestamp: "true"
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{{#isBodyParam}}<div class="param">{{baseName}} {{#baseType}}<a href="#{{baseType}}">{{baseType}}</a>{{/baseType}} {{^required}}(optional){{/required}}{{#required}}(required){{/required}}</div>
{{#isBodyParam}}<div class="param">{{baseName}} {{#isContainer}}{{containerType}}[{{/isContainer}}{{#baseType}}<a href="#{{baseType}}">{{baseType}}</a>{{/baseType}}{{#isContainer}}]{{/isContainer}} {{^required}}(optional){{/required}}{{#required}}(required){{/required}}</div>

<div class="param-desc"><span class="param-type">Body Parameter</span> &mdash; {{unescapedDescription}} {{#defaultValue}}default: {{{.}}}{{/defaultValue}}</div>{{/isBodyParam}}
2 changes: 1 addition & 1 deletion samples/documentation/html/.openapi-generator/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
5.3.0-SNAPSHOT
7.20.0-SNAPSHOT
78 changes: 71 additions & 7 deletions samples/documentation/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -189,8 +189,8 @@ <h1>OpenAPI Petstore</h1>
<div class="license-url">https://www.apache.org/licenses/LICENSE-2.0.html</div>
<h2>Access</h2>
<ol>
<li>APIKey KeyParamName:api_key KeyInQuery:false KeyInHeader:true</li>
<li>OAuth AuthorizationUrl:http://petstore.swagger.io/api/oauth/dialogTokenUrl:</li>
<li>APIKey KeyParamName:api_key KeyInQuery:false KeyInHeader:true</li>
</ol>

<h2><a name="__Methods">Methods</a></h2>
Expand Down Expand Up @@ -286,11 +286,19 @@ <h3 class="field-label">Example data</h3>
<div class="example-data-content-type">Content-Type: application/xml</div>
<pre class="example"><code><Pet>
<id>123456789</id>
<Category>
<id>123456789</id>
<name>aeiou</name>
</Category>
<name>doggie</name>
<photoUrls>
<photoUrls>aeiou</photoUrls>
</photoUrls>
<tags>
<Tag>
<id>123456789</id>
<name>aeiou</name>
</Tag>
</tags>
<status>aeiou</status>
</Pet></code></pre>
Expand Down Expand Up @@ -378,7 +386,7 @@ <h3 class="field-label">Return type</h3>

<h3 class="field-label">Example data</h3>
<div class="example-data-content-type">Content-Type: application/json</div>
<pre class="example"><code>{
<pre class="example"><code>[ {
"photoUrls" : [ "photoUrls", "photoUrls" ],
"name" : "doggie",
"id" : 0,
Expand All @@ -394,16 +402,40 @@ <h3 class="field-label">Example data</h3>
"id" : 1
} ],
"status" : "available"
}</code></pre>
}, {
"photoUrls" : [ "photoUrls", "photoUrls" ],
"name" : "doggie",
"id" : 0,
"category" : {
"name" : "name",
"id" : 6
},
"tags" : [ {
"name" : "name",
"id" : 1
}, {
"name" : "name",
"id" : 1
} ],
"status" : "available"
} ]</code></pre>
<h3 class="field-label">Example data</h3>
<div class="example-data-content-type">Content-Type: application/xml</div>
<pre class="example"><code><Pet>
<id>123456789</id>
<Category>
<id>123456789</id>
<name>aeiou</name>
</Category>
<name>doggie</name>
<photoUrls>
<photoUrls>aeiou</photoUrls>
</photoUrls>
<tags>
<Tag>
<id>123456789</id>
<name>aeiou</name>
</Tag>
</tags>
<status>aeiou</status>
</Pet></code></pre>
Expand Down Expand Up @@ -454,7 +486,7 @@ <h3 class="field-label">Return type</h3>

<h3 class="field-label">Example data</h3>
<div class="example-data-content-type">Content-Type: application/json</div>
<pre class="example"><code>{
<pre class="example"><code>[ {
"photoUrls" : [ "photoUrls", "photoUrls" ],
"name" : "doggie",
"id" : 0,
Expand All @@ -470,16 +502,40 @@ <h3 class="field-label">Example data</h3>
"id" : 1
} ],
"status" : "available"
}</code></pre>
}, {
"photoUrls" : [ "photoUrls", "photoUrls" ],
"name" : "doggie",
"id" : 0,
"category" : {
"name" : "name",
"id" : 6
},
"tags" : [ {
"name" : "name",
"id" : 1
}, {
"name" : "name",
"id" : 1
} ],
"status" : "available"
} ]</code></pre>
<h3 class="field-label">Example data</h3>
<div class="example-data-content-type">Content-Type: application/xml</div>
<pre class="example"><code><Pet>
<id>123456789</id>
<Category>
<id>123456789</id>
<name>aeiou</name>
</Category>
<name>doggie</name>
<photoUrls>
<photoUrls>aeiou</photoUrls>
</photoUrls>
<tags>
<Tag>
<id>123456789</id>
<name>aeiou</name>
</Tag>
</tags>
<status>aeiou</status>
</Pet></code></pre>
Expand Down Expand Up @@ -551,11 +607,19 @@ <h3 class="field-label">Example data</h3>
<div class="example-data-content-type">Content-Type: application/xml</div>
<pre class="example"><code><Pet>
<id>123456789</id>
<Category>
<id>123456789</id>
<name>aeiou</name>
</Category>
<name>doggie</name>
<photoUrls>
<photoUrls>aeiou</photoUrls>
</photoUrls>
<tags>
<Tag>
<id>123456789</id>
<name>aeiou</name>
</Tag>
</tags>
<status>aeiou</status>
</Pet></code></pre>
Expand Down Expand Up @@ -1034,7 +1098,7 @@ <h3 class="field-label">Consumes</h3>

<h3 class="field-label">Request body</h3>
<div class="field-items">
<div class="param">User <a href="#User">User</a> (required)</div>
<div class="param">User array[<a href="#User">User</a>] (required)</div>

<div class="param-desc"><span class="param-type">Body Parameter</span> &mdash; </div>

Expand Down Expand Up @@ -1070,7 +1134,7 @@ <h3 class="field-label">Consumes</h3>

<h3 class="field-label">Request body</h3>
<div class="field-items">
<div class="param">User <a href="#User">User</a> (required)</div>
<div class="param">User array[<a href="#User">User</a>] (required)</div>

<div class="param-desc"><span class="param-type">Body Parameter</span> &mdash; </div>

Expand Down
Loading