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

Corrected typo in statis HTML API docs

Browse Source
This commit is contained in:
David M. Lee 2013-04-03 13:54:53 -05:00 committed by George Sibble
parent 5eff3fd976
commit 53f1394c25
5 changed files with 64 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

112
samples/docs/swagger-static-docs/sd/index.html
View File

@ -17,62 +17,6 @@
</div> </div>
<div class="main_content"> <div class="main_content">
<h1>API Documentation</h1> <h1>API Documentation</h1>
<h2>StoreApi</h2>
<table>
<tr>
<th class="column_header_name">Name</th>
<th class="column_header_path">Resource</th>
<th class="column_header_notes">Notes</th>
</tr>
<tr>
<td><a href="operations/StoreApi.html#getOrderById">getOrderById</a></td>
<td>/store.{format}/order/{orderId}</td>
<td>Find purchase order by ID<div id="StoreApi_getOrderById" class="operation expandable">For valid response try integer IDs with value &lt;= 5. Anything above 5 or nonintegers will generate API errors</div></td>
</tr>
<tr>
<td><a href="operations/StoreApi.html#deleteOrder">deleteOrder</a></td>
<td>/store.{format}/order/{orderId}</td>
<td>Delete purchase order by ID<div id="StoreApi_deleteOrder" class="operation expandable">For valid response try integer IDs with value &lt; 1000. Anything above 1000 or nonintegers will generate API errors</div></td>
</tr>
<tr>
<td><a href="operations/StoreApi.html#placeOrder">placeOrder</a></td>
<td>/store.{format}/order</td>
<td>Place an order for a pet<div id="StoreApi_placeOrder" class="operation expandable"></div></td>
</tr>
</table>
<h2>PetApi</h2>
<table>
<tr>
<th class="column_header_name">Name</th>
<th class="column_header_path">Resource</th>
<th class="column_header_notes">Notes</th>
</tr>
<tr>
<td><a href="operations/PetApi.html#getPetById">getPetById</a></td>
<td>/pet.{format}/{petId}</td>
<td>Find pet by ID<div id="PetApi_getPetById" class="operation expandable">Returns a pet based on ID</div></td>
</tr>
<tr>
<td><a href="operations/PetApi.html#addPet">addPet</a></td>
<td>/pet.{format}</td>
<td>Add a new pet to the store<div id="PetApi_addPet" class="operation expandable"></div></td>
</tr>
<tr>
<td><a href="operations/PetApi.html#updatePet">updatePet</a></td>
<td>/pet.{format}</td>
<td>Update an existing pet<div id="PetApi_updatePet" class="operation expandable"></div></td>
</tr>
<tr>
<td><a href="operations/PetApi.html#findPetsByStatus">findPetsByStatus</a></td>
<td>/pet.{format}/findByStatus</td>
<td>Finds Pets by status<div id="PetApi_findPetsByStatus" class="operation expandable">Multiple status values can be provided with comma seperated strings</div></td>
</tr>
<tr>
<td><a href="operations/PetApi.html#findPetsByTags">findPetsByTags</a></td>
<td>/pet.{format}/findByTags</td>
<td>Finds Pets by tags<div id="PetApi_findPetsByTags" class="operation expandable">Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.</div></td>
</tr>
</table>
<h2>UserApi</h2> <h2>UserApi</h2>
<table> <table>
<tr> <tr>
@ -121,6 +65,62 @@
<td>Logs out current logged in user session<div id="UserApi_logoutUser" class="operation expandable"></div></td> <td>Logs out current logged in user session<div id="UserApi_logoutUser" class="operation expandable"></div></td>
</tr> </tr>
</table> </table>
<h2>PetApi</h2>
<table>
<tr>
<th class="column_header_name">Name</th>
<th class="column_header_path">Resource</th>
<th class="column_header_notes">Notes</th>
</tr>
<tr>
<td><a href="operations/PetApi.html#getPetById">getPetById</a></td>
<td>/pet.{format}/{petId}</td>
<td>Find pet by ID<div id="PetApi_getPetById" class="operation expandable">Returns a pet based on ID</div></td>
</tr>
<tr>
<td><a href="operations/PetApi.html#addPet">addPet</a></td>
<td>/pet.{format}</td>
<td>Add a new pet to the store<div id="PetApi_addPet" class="operation expandable"></div></td>
</tr>
<tr>
<td><a href="operations/PetApi.html#updatePet">updatePet</a></td>
<td>/pet.{format}</td>
<td>Update an existing pet<div id="PetApi_updatePet" class="operation expandable"></div></td>
</tr>
<tr>
<td><a href="operations/PetApi.html#findPetsByStatus">findPetsByStatus</a></td>
<td>/pet.{format}/findByStatus</td>
<td>Finds Pets by status<div id="PetApi_findPetsByStatus" class="operation expandable">Multiple status values can be provided with comma seperated strings</div></td>
</tr>
<tr>
<td><a href="operations/PetApi.html#findPetsByTags">findPetsByTags</a></td>
<td>/pet.{format}/findByTags</td>
<td>Finds Pets by tags<div id="PetApi_findPetsByTags" class="operation expandable">Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.</div></td>
</tr>
</table>
<h2>StoreApi</h2>
<table>
<tr>
<th class="column_header_name">Name</th>
<th class="column_header_path">Resource</th>
<th class="column_header_notes">Notes</th>
</tr>
<tr>
<td><a href="operations/StoreApi.html#getOrderById">getOrderById</a></td>
<td>/store.{format}/order/{orderId}</td>
<td>Find purchase order by ID<div id="StoreApi_getOrderById" class="operation expandable">For valid response try integer IDs with value &lt;= 5. Anything above 5 or nonintegers will generate API errors</div></td>
</tr>
<tr>
<td><a href="operations/StoreApi.html#deleteOrder">deleteOrder</a></td>
<td>/store.{format}/order/{orderId}</td>
<td>Delete purchase order by ID<div id="StoreApi_deleteOrder" class="operation expandable">For valid response try integer IDs with value &lt; 1000. Anything above 1000 or nonintegers will generate API errors</div></td>
</tr>
<tr>
<td><a href="operations/StoreApi.html#placeOrder">placeOrder</a></td>
<td>/store.{format}/order</td>
<td>Place an order for a pet<div id="StoreApi_placeOrder" class="operation expandable"></div></td>
</tr>
</table>
</div> </div>
</body> </body>
</html> </html>

3
samples/docs/swagger-static-docs/sd/operations/PetApi.html
View File

@ -17,7 +17,7 @@
</div> </div>
<div class="main_content"> <div class="main_content">
<h1></h1> <h1>PetApi</h1>
<a name="getPetById"></a> <a name="getPetById"></a>
<h2>getPetById</h2> <h2>getPetById</h2>
<h3>GET: /pet.{format}/{petId}</h3> <h3>GET: /pet.{format}/{petId}</h3>
@ -136,3 +136,4 @@
</div> </div>
</body> </body>
</html> </html>

3
samples/docs/swagger-static-docs/sd/operations/StoreApi.html
View File

@ -17,7 +17,7 @@
</div> </div>
<div class="main_content"> <div class="main_content">
<h1></h1> <h1>StoreApi</h1>
<a name="getOrderById"></a> <a name="getOrderById"></a>
<h2>getOrderById</h2> <h2>getOrderById</h2>
<h3>GET: /store.{format}/order/{orderId}</h3> <h3>GET: /store.{format}/order/{orderId}</h3>
@ -90,3 +90,4 @@
</div> </div>
</body> </body>
</html> </html>

3
samples/docs/swagger-static-docs/sd/operations/UserApi.html
View File

@ -17,7 +17,7 @@
</div> </div>
<div class="main_content"> <div class="main_content">
<h1></h1> <h1>UserApi</h1>
<a name="createUsersWithArrayInput"></a> <a name="createUsersWithArrayInput"></a>
<h2>createUsersWithArrayInput</h2> <h2>createUsersWithArrayInput</h2>
<h3>POST: /user.{format}/createWithArray</h3> <h3>POST: /user.{format}/createWithArray</h3>
@ -212,3 +212,4 @@
</div> </div>
</body> </body>
</html> </html>

4
src/main/resources/swagger-static/operation.mustache
View File

@ -17,7 +17,7 @@
</div> </div>
<div class="main_content"> <div class="main_content">
<h1>{{classname}}</h1> <h1>{{className}}</h1>
{{#operations}} {{#operations}}
{{#operation}} {{#operation}}
<a name="{{nickname}}"></a> <a name="{{nickname}}"></a>
@ -79,4 +79,4 @@
{{/operations}} {{/operations}}
</div> </div>
</body> </body>
</html> </html>