Skip to content

Commit b4b6233

Browse files
amrapalijzamrapalijz
authored
Update index.html
added corresponding openAPI elements
1 parent e7e5866 commit b4b6233

File tree

1 file changed

+33
-3
lines changed

1 file changed

+33
-3
lines changed

‎index.html

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,7 @@ <h3>Name</h3>
237237
<li>Cardinality: 1..1</li>
238238
<li>Datatype: string</li>
239239
</ul>
240+
<p>OpenAPI element: <font size="2" face="verdana" color=green>info.title</font></p>
240241
<div class="example">
241242
<p>
242243
<pre>
@@ -255,6 +256,7 @@ <h3>Access Point</h3>
255256
<li>Cardinality: 1..1</li>
256257
<li>Datatype: URI</li>
257258
</ul>
259+
<p>OpenAPI element: <font size="2" face="verdana" color=green>basePath</font></p>
258260
<div class="example">
259261
<p>
260262
<pre>
@@ -272,7 +274,8 @@ <h3>Description</h3>
272274
<ul>
273275
<li>Cardinality: 0..1</li>
274276
<li>Datatype: string</li>
275-
</ul>
277+
</ul>
278+
<p>OpenAPI element: <font size="2" face="verdana" color=green>info.description</font></p>
276279
<div class="example">
277280
<p>
278281
<pre>
@@ -291,6 +294,7 @@ <h3>Response Mime-Type</h3>
291294
<li>Cardinality: 0..n</li>
292295
<li>Datatype: string</li>
293296
</ul>
297+
<p>OpenAPI element: <font size="2" face="verdana" color=green>produces</font></p>
294298
<div class="example">
295299
<p>
296300
<pre>
@@ -308,7 +312,8 @@ <h3>Documentation</h3>
308312
<ul>
309313
<li>Cardinality: 0..n</li>
310314
<li>Datatype: URI</li>
311-
</ul>
315+
</ul>
316+
<p>OpenAPI element: <font size="2" face="verdana" color=green>externalDocs</font></p>
312317
<div class="example">
313318
<p>
314319
<pre>
@@ -327,6 +332,7 @@ <h3>Version</h3>
327332
<li>Cardinality: 1..1</li>
328333
<li>Datatype: string</li>
329334
</ul>
335+
<p>OpenAPI element: <font size="2" face="verdana" color=green>info.version</font></p>
330336
<div class="example">
331337
<p>
332338
<pre>
@@ -345,6 +351,7 @@ <h3>Terms of Service</h3>
345351
<li>Cardinality: 0..1</li>
346352
<li>Datatype: string</li>
347353
</ul>
354+
<p>OpenAPI element: <font size="2" face="verdana" color=green>info.termsOfService</font></p>
348355
<div class="example">
349356
<p>
350357
<pre>
@@ -417,6 +424,7 @@ <h3>Website</h3>
417424
<li>Cardinality: 0..1</li>
418425
<li>Datatype: URI</li>
419426
</ul>
427+
<p>OpenAPI element: <font size="2" face="verdana" color=green>host</font></p>
420428
<div class="example">
421429
<p>
422430
<pre>
@@ -600,6 +608,7 @@ <h3>Responsible Organization</h3>
600608
<li>Cardinality: 1..1</li>
601609
<li>Datatype: string</li>
602610
</ul>
611+
<p>OpenAPI element: <font size="2" face="verdana" color=green>contact.url</font></p>
603612
<div class="example">
604613
<p>
605614
<pre>
@@ -636,6 +645,7 @@ <h3>Contact Email</h3>
636645
<li>Cardinality: 1..1</li>
637646
<li>Datatype: email</li>
638647
</ul>
648+
<p>OpenAPI element: <font size="2" face="verdana" color=green>contact.email</font></p>
639649
<div class="example">
640650
<p>
641651
<pre>
@@ -729,6 +739,7 @@ <h3>Operation Description</h3>
729739
<li>Cardinality: 1..1</li>
730740
<li>Datatype: string</li>
731741
</ul>
742+
<p>OpenAPI element: <font size="2" face="verdana" color=green>operation.description</font></p>
732743
<div class="example">
733744
<p>
734745
<pre>
@@ -746,6 +757,7 @@ <h3>Consumes</h3>
746757
<li>Cardinality: 0..n</li>
747758
<li>Datatype: string</li>
748759
</ul>
760+
<p>OpenAPI element: <font size="2" face="verdana" color=green>consumes</font></p>
749761
<div class="example">
750762
<p>
751763
<pre>
@@ -763,6 +775,7 @@ <h3>http Method</h3>
763775
<li>Cardinality: 0..1</li>
764776
<li>Datatype: string</li>
765777
</ul>
778+
<p>OpenAPI element: <font size="2" face="verdana" color=green>pathItem</font></p>
766779
<div class="example">
767780
<p>
768781
<pre>
@@ -800,6 +813,7 @@ <h3>Transfer Protocol</h3>
800813
<li>Datatype: string0</li>
801814
</ul>
802815
<div class="example">
816+
<p>OpenAPI element: <font size="2" face="verdana" color=green>schemes</font></p>
803817
<p>
804818
<pre>
805819
"transfer protocol": "http"
@@ -817,6 +831,7 @@ <h3>Keywords</h3>
817831
<li>Cardinality: 0..n</li>
818832
<li>Datatype: string</li>
819833
</ul>
834+
<p>OpenAPI element: <font size="2" face="verdana" color=green>operation.tags</font></p>
820835
<div class="example">
821836
<p>
822837
<pre>
@@ -853,6 +868,7 @@ <h3>Operation ID</h3>
853868
<li>Cardinality: 0..1</li>
854869
<li>Datatype: string</li>
855870
</ul>
871+
<p>OpenAPI element: <font size="2" face="verdana" color=green>operation.operationID</font></p>
856872
<div class="example">
857873
<p>
858874
<pre>
@@ -871,6 +887,7 @@ <h3>Operation Documentation</h3>
871887
<li>Cardinality: 0..n</li>
872888
<li>Datatype: URI</li>
873889
</ul>
890+
<p>OpenAPI element: <font size="2" face="verdana" color=green>operation.externalDocs</font></p>
874891
<div class="example">
875892
<p>
876893
<pre>
@@ -930,6 +947,7 @@ <h3>Operation Parameter Name</h3>
930947
<li>Cardinality: 1..1</li>
931948
<li>Datatype: string</li>
932949
</ul>
950+
<p>OpenAPI element: <font size="2" face="verdana" color=green>bodyParameter.patternProperties.name</font></p>
933951
<div class="example">
934952
<p>
935953
<pre>
@@ -944,6 +962,7 @@ <h3>Operation Parameter Name</h3>
944962
<section id="operationParameterDescription">
945963
<h3>Operation Parameter Description</h3>
946964
<p>Description of operation parameter.</p>
965+
<p>OpenAPI element: <font size="2" face="verdana" color=green>bodyParameter.patternProperties.description</font></p>
947966
<div class="example">
948967
<ul>
949968
<li>Cardinality: 1..1</li>
@@ -966,6 +985,7 @@ <h3>Location</h3>
966985
<li>Cardinality: 1..1</li>
967986
<li>Datatype: string</li>
968987
</ul>
988+
<p>OpenAPI element: <font size="2" face="verdana" color=green>bodyParameter.patternProperties.in</font></p>
969989
<div class="example">
970990
<p>
971991
<pre>
@@ -1020,6 +1040,7 @@ <h3>Min</h3>
10201040
<li>Cardinality: 0..n</li>
10211041
<li>Datatype: integer</li>
10221042
</ul>
1043+
<p>OpenAPI element: <font size="2" face="verdana" color=green>minItems</font></p>
10231044
<div class="example">
10241045
<p>
10251046
<pre>
@@ -1038,6 +1059,7 @@ <h3>Max</h3>
10381059
<li>Cardinality: 0..1</li>
10391060
<li>Datatype: integer</li>
10401061
</ul>
1062+
<p>OpenAPI element: <font size="2" face="verdana" color=green>maxItems</font></p>
10411063
<div class="example">
10421064
<p>
10431065
<pre>
@@ -1056,6 +1078,7 @@ <h3>Data Format</h3>
10561078
<li>Cardinality: 0..1</li>
10571079
<li>Datatype: string</li>
10581080
</ul>
1081+
<p>OpenAPI element: <font size="2" face="verdana" color=green>type</font></p>
10591082
<div class="example">
10601083
<p>
10611084
<pre>
@@ -1074,6 +1097,7 @@ <h3>Default Value</h3>
10741097
<li>Cardinality: 0..1</li>
10751098
<li>Datatype: string</li>
10761099
</ul>
1100+
<p>OpenAPI element: <font size="2" face="verdana" color=green>default</font></p>
10771101
<div class="example">
10781102
<p>
10791103
<pre>
@@ -1092,6 +1116,7 @@ <h3>Example Value</h3>
10921116
<li>Cardinality: 0..1</li>
10931117
<li>Datatype: string</li>
10941118
</ul>
1119+
<p>OpenAPI element: <font size="2" face="verdana" color=green>examples</font></p>
10951120
<div class="example">
10961121
<p>
10971122
<pre>
@@ -1115,6 +1140,7 @@ <h3>Response Format</h3>
11151140
<li>Cardinality: 1..n</li>
11161141
<li>Datatype: string</li>
11171142
</ul>
1143+
<p>OpenAPI element: <font size="2" face="verdana" color=green>mimeType</font></p>
11181144
<div class="example">
11191145
<p>
11201146
<pre>
@@ -1133,6 +1159,7 @@ <h3>Example Response Value</h3>
11331159
<li>Cardinality: 0..n</li>
11341160
<li>Datatype: integer</li>
11351161
</ul>
1162+
<p>OpenAPI element: <font size="2" face="verdana" color=green>response.examples</font></p>
11361163
<div class="example">
11371164
<p>
11381165
<pre>
@@ -1151,6 +1178,7 @@ <h3>Response Header</h3>
11511178
<li>Cardinality: 0..n</li>
11521179
<li>Datatype: object</li>
11531180
</ul>
1181+
<p>OpenAPI element: <font size="2" face="verdana" color=green>response.headers.hearders.header</font></p>
11541182
<div class="example">
11551183
<p>
11561184
<pre>
@@ -1165,11 +1193,12 @@ <h3>Response Header</h3>
11651193
<section id="responseCode">
11661194
<h3>Response Code</h3>
11671195
<p>A container for the expected responses of an operation. The container maps a HTTP response code to the expected response.
1168-
The list of possible responses as they are returned from executing this operation.</p>
1196+
The list of possible responses as they are returned from executing this operation.</p>
11691197
<ul>
11701198
<li>Cardinality: 0..1</li>
11711199
<li>Datatype: integer</li>
11721200
</ul>
1201+
<p>OpenAPI element: <font size="2" face="verdana" color=green>response.patternProperties</font></p>
11731202
<div class="example">
11741203
<p>
11751204
<pre>
@@ -1188,6 +1217,7 @@ <h3>Response Description</h3>
11881217
<li>Cardinality: 0..1</li>
11891218
<li>Datatype: string</li>
11901219
</ul>
1220+
<p>OpenAPI element: <font size="2" face="verdana" color=green>responseValue.response.description</font></p>
11911221
<div class="example">
11921222
<p>
11931223
<pre>

0 commit comments

Comments
 (0)