forked from loafle/openapi-generator-original
added sample output docs
This commit is contained in:
Tony Tam
138
samples/docs/swagger-static-docs/sd/operations/PetApi.html
Normal file
138
samples/docs/swagger-static-docs/sd/operations/PetApi.html
Normal file
@@ -0,0 +1,138 @@
|
||||
<!DOCTYPE html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
|
||||
<link rel="stylesheet" type="text/css" href="../assets/css/bootstrap.css" media="screen">
|
||||
<link rel="stylesheet" type="text/css" href="../assets/css/bootstrap-responsive.css" media="screen">
|
||||
<link rel="stylesheet" type="text/css" href="../assets/css/style.css">
|
||||
|
||||
<title>REST API v1.1 Resources | Twitter Developers</title>
|
||||
</head>
|
||||
<body>
|
||||
<div class="header">
|
||||
<div class="top-bar">
|
||||
<h1 id="logo"><a class="logo" href="/"><span>Swagger</span><span class="light">API Docs</span></a></h1>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="main_content">
|
||||
<h1></h1>
|
||||
<a name="getPetById"></a>
|
||||
<h2>getPetById</h2>
|
||||
<h3>GET: /pet.{format}/{petId}</h3>
|
||||
<table>
|
||||
<tr>
|
||||
<th class="column_header_name">parameter</th>
|
||||
<th class="column_header_param_type">param type</th>
|
||||
<th class="column_header_data_type">data type</th>
|
||||
<th class="column_header_return_type">response type</th>
|
||||
<th class="column_header_notes">Description</th>
|
||||
</tr>
|
||||
<!-- body params -->
|
||||
<!-- path params -->
|
||||
<tr>
|
||||
<td>petId<br/>required</td>
|
||||
<td>path</td>
|
||||
<td>string*</td>
|
||||
<td>Pet</td>
|
||||
<td>ID of pet that needs to be fetched<br/><div id="PetApi_getPetById" class="operation expandable">Returns a pet based on ID</div></td>
|
||||
</tr>
|
||||
<!-- query params -->
|
||||
<!-- header params -->
|
||||
</table>
|
||||
<a name="addPet"></a>
|
||||
<h2>addPet</h2>
|
||||
<h3>POST: /pet.{format}</h3>
|
||||
<table>
|
||||
<tr>
|
||||
<th class="column_header_name">parameter</th>
|
||||
<th class="column_header_param_type">param type</th>
|
||||
<th class="column_header_data_type">data type</th>
|
||||
<th class="column_header_return_type">response type</th>
|
||||
<th class="column_header_notes">Description</th>
|
||||
</tr>
|
||||
<!-- body params -->
|
||||
<tr>
|
||||
<td>body<br/>required</td>
|
||||
<td>body</td>
|
||||
<td>Pet*</td>
|
||||
<td>-</td>
|
||||
<td>Pet object that needs to be added to the store<br/><div id="PetApi_addPet" class="operation expandable"></div></td>
|
||||
</tr>
|
||||
<!-- path params -->
|
||||
<!-- query params -->
|
||||
<!-- header params -->
|
||||
</table>
|
||||
<a name="updatePet"></a>
|
||||
<h2>updatePet</h2>
|
||||
<h3>PUT: /pet.{format}</h3>
|
||||
<table>
|
||||
<tr>
|
||||
<th class="column_header_name">parameter</th>
|
||||
<th class="column_header_param_type">param type</th>
|
||||
<th class="column_header_data_type">data type</th>
|
||||
<th class="column_header_return_type">response type</th>
|
||||
<th class="column_header_notes">Description</th>
|
||||
</tr>
|
||||
<!-- body params -->
|
||||
<tr>
|
||||
<td>body<br/>required</td>
|
||||
<td>body</td>
|
||||
<td>Pet*</td>
|
||||
<td>-</td>
|
||||
<td>Pet object that needs to be updated in the store<br/><div id="PetApi_updatePet" class="operation expandable"></div></td>
|
||||
</tr>
|
||||
<!-- path params -->
|
||||
<!-- query params -->
|
||||
<!-- header params -->
|
||||
</table>
|
||||
<a name="findPetsByStatus"></a>
|
||||
<h2>findPetsByStatus</h2>
|
||||
<h3>GET: /pet.{format}/findByStatus</h3>
|
||||
<table>
|
||||
<tr>
|
||||
<th class="column_header_name">parameter</th>
|
||||
<th class="column_header_param_type">param type</th>
|
||||
<th class="column_header_data_type">data type</th>
|
||||
<th class="column_header_return_type">response type</th>
|
||||
<th class="column_header_notes">Description</th>
|
||||
</tr>
|
||||
<!-- body params -->
|
||||
<!-- path params -->
|
||||
<!-- query params -->
|
||||
<tr>
|
||||
<td>status<br/>required</td>
|
||||
<td>query</td>
|
||||
<td>string*</td>
|
||||
<td>List[Pet]</td>
|
||||
<td>Status values that need to be considered for filter<br/><div id="PetApi_findPetsByStatus" class="operation expandable">Multiple status values can be provided with comma seperated strings</div></td>
|
||||
</tr>
|
||||
<!-- header params -->
|
||||
</table>
|
||||
<a name="findPetsByTags"></a>
|
||||
<h2>findPetsByTags</h2>
|
||||
<h3>GET: /pet.{format}/findByTags</h3>
|
||||
<table>
|
||||
<tr>
|
||||
<th class="column_header_name">parameter</th>
|
||||
<th class="column_header_param_type">param type</th>
|
||||
<th class="column_header_data_type">data type</th>
|
||||
<th class="column_header_return_type">response type</th>
|
||||
<th class="column_header_notes">Description</th>
|
||||
</tr>
|
||||
<!-- body params -->
|
||||
<!-- path params -->
|
||||
<!-- query params -->
|
||||
<tr>
|
||||
<td>tags<br/>required</td>
|
||||
<td>query</td>
|
||||
<td>string*</td>
|
||||
<td>List[Pet]</td>
|
||||
<td>Tags to filter by<br/><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>
|
||||
<!-- header params -->
|
||||
</table>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
92
samples/docs/swagger-static-docs/sd/operations/StoreApi.html
Normal file
92
samples/docs/swagger-static-docs/sd/operations/StoreApi.html
Normal file
@@ -0,0 +1,92 @@
|
||||
<!DOCTYPE html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
|
||||
<link rel="stylesheet" type="text/css" href="../assets/css/bootstrap.css" media="screen">
|
||||
<link rel="stylesheet" type="text/css" href="../assets/css/bootstrap-responsive.css" media="screen">
|
||||
<link rel="stylesheet" type="text/css" href="../assets/css/style.css">
|
||||
|
||||
<title>REST API v1.1 Resources | Twitter Developers</title>
|
||||
</head>
|
||||
<body>
|
||||
<div class="header">
|
||||
<div class="top-bar">
|
||||
<h1 id="logo"><a class="logo" href="/"><span>Swagger</span><span class="light">API Docs</span></a></h1>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="main_content">
|
||||
<h1></h1>
|
||||
<a name="getOrderById"></a>
|
||||
<h2>getOrderById</h2>
|
||||
<h3>GET: /store.{format}/order/{orderId}</h3>
|
||||
<table>
|
||||
<tr>
|
||||
<th class="column_header_name">parameter</th>
|
||||
<th class="column_header_param_type">param type</th>
|
||||
<th class="column_header_data_type">data type</th>
|
||||
<th class="column_header_return_type">response type</th>
|
||||
<th class="column_header_notes">Description</th>
|
||||
</tr>
|
||||
<!-- body params -->
|
||||
<!-- path params -->
|
||||
<tr>
|
||||
<td>orderId<br/>required</td>
|
||||
<td>path</td>
|
||||
<td>string*</td>
|
||||
<td>Order</td>
|
||||
<td>ID of pet that needs to be fetched<br/><div id="StoreApi_getOrderById" class="operation expandable">For valid response try integer IDs with value <= 5. Anything above 5 or nonintegers will generate API errors</div></td>
|
||||
</tr>
|
||||
<!-- query params -->
|
||||
<!-- header params -->
|
||||
</table>
|
||||
<a name="deleteOrder"></a>
|
||||
<h2>deleteOrder</h2>
|
||||
<h3>DELETE: /store.{format}/order/{orderId}</h3>
|
||||
<table>
|
||||
<tr>
|
||||
<th class="column_header_name">parameter</th>
|
||||
<th class="column_header_param_type">param type</th>
|
||||
<th class="column_header_data_type">data type</th>
|
||||
<th class="column_header_return_type">response type</th>
|
||||
<th class="column_header_notes">Description</th>
|
||||
</tr>
|
||||
<!-- body params -->
|
||||
<!-- path params -->
|
||||
<tr>
|
||||
<td>orderId<br/>required</td>
|
||||
<td>path</td>
|
||||
<td>string*</td>
|
||||
<td>-</td>
|
||||
<td>ID of the order that needs to be deleted<br/><div id="StoreApi_deleteOrder" class="operation expandable">For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors</div></td>
|
||||
</tr>
|
||||
<!-- query params -->
|
||||
<!-- header params -->
|
||||
</table>
|
||||
<a name="placeOrder"></a>
|
||||
<h2>placeOrder</h2>
|
||||
<h3>POST: /store.{format}/order</h3>
|
||||
<table>
|
||||
<tr>
|
||||
<th class="column_header_name">parameter</th>
|
||||
<th class="column_header_param_type">param type</th>
|
||||
<th class="column_header_data_type">data type</th>
|
||||
<th class="column_header_return_type">response type</th>
|
||||
<th class="column_header_notes">Description</th>
|
||||
</tr>
|
||||
<!-- body params -->
|
||||
<tr>
|
||||
<td>body<br/>required</td>
|
||||
<td>body</td>
|
||||
<td>Order*</td>
|
||||
<td>-</td>
|
||||
<td>order placed for purchasing the pet<br/><div id="StoreApi_placeOrder" class="operation expandable"></div></td>
|
||||
</tr>
|
||||
<!-- path params -->
|
||||
<!-- query params -->
|
||||
<!-- header params -->
|
||||
</table>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
214
samples/docs/swagger-static-docs/sd/operations/UserApi.html
Normal file
214
samples/docs/swagger-static-docs/sd/operations/UserApi.html
Normal file
@@ -0,0 +1,214 @@
|
||||
<!DOCTYPE html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
|
||||
<link rel="stylesheet" type="text/css" href="../assets/css/bootstrap.css" media="screen">
|
||||
<link rel="stylesheet" type="text/css" href="../assets/css/bootstrap-responsive.css" media="screen">
|
||||
<link rel="stylesheet" type="text/css" href="../assets/css/style.css">
|
||||
|
||||
<title>REST API v1.1 Resources | Twitter Developers</title>
|
||||
</head>
|
||||
<body>
|
||||
<div class="header">
|
||||
<div class="top-bar">
|
||||
<h1 id="logo"><a class="logo" href="/"><span>Swagger</span><span class="light">API Docs</span></a></h1>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="main_content">
|
||||
<h1></h1>
|
||||
<a name="createUsersWithArrayInput"></a>
|
||||
<h2>createUsersWithArrayInput</h2>
|
||||
<h3>POST: /user.{format}/createWithArray</h3>
|
||||
<table>
|
||||
<tr>
|
||||
<th class="column_header_name">parameter</th>
|
||||
<th class="column_header_param_type">param type</th>
|
||||
<th class="column_header_data_type">data type</th>
|
||||
<th class="column_header_return_type">response type</th>
|
||||
<th class="column_header_notes">Description</th>
|
||||
</tr>
|
||||
<!-- body params -->
|
||||
<tr>
|
||||
<td>body<br/>required</td>
|
||||
<td>body</td>
|
||||
<td>Array[User]*</td>
|
||||
<td>-</td>
|
||||
<td>List of user object<br/><div id="UserApi_createUsersWithArrayInput" class="operation expandable"></div></td>
|
||||
</tr>
|
||||
<!-- path params -->
|
||||
<!-- query params -->
|
||||
<!-- header params -->
|
||||
</table>
|
||||
<a name="createUser"></a>
|
||||
<h2>createUser</h2>
|
||||
<h3>POST: /user.{format}</h3>
|
||||
<table>
|
||||
<tr>
|
||||
<th class="column_header_name">parameter</th>
|
||||
<th class="column_header_param_type">param type</th>
|
||||
<th class="column_header_data_type">data type</th>
|
||||
<th class="column_header_return_type">response type</th>
|
||||
<th class="column_header_notes">Description</th>
|
||||
</tr>
|
||||
<!-- body params -->
|
||||
<tr>
|
||||
<td>body<br/>required</td>
|
||||
<td>body</td>
|
||||
<td>User*</td>
|
||||
<td>-</td>
|
||||
<td>Created user object<br/><div id="UserApi_createUser" class="operation expandable">This can only be done by the logged in user.</div></td>
|
||||
</tr>
|
||||
<!-- path params -->
|
||||
<!-- query params -->
|
||||
<!-- header params -->
|
||||
</table>
|
||||
<a name="createUsersWithListInput"></a>
|
||||
<h2>createUsersWithListInput</h2>
|
||||
<h3>POST: /user.{format}/createWithList</h3>
|
||||
<table>
|
||||
<tr>
|
||||
<th class="column_header_name">parameter</th>
|
||||
<th class="column_header_param_type">param type</th>
|
||||
<th class="column_header_data_type">data type</th>
|
||||
<th class="column_header_return_type">response type</th>
|
||||
<th class="column_header_notes">Description</th>
|
||||
</tr>
|
||||
<!-- body params -->
|
||||
<tr>
|
||||
<td>body<br/>required</td>
|
||||
<td>body</td>
|
||||
<td>List[User]*</td>
|
||||
<td>-</td>
|
||||
<td>List of user object<br/><div id="UserApi_createUsersWithListInput" class="operation expandable"></div></td>
|
||||
</tr>
|
||||
<!-- path params -->
|
||||
<!-- query params -->
|
||||
<!-- header params -->
|
||||
</table>
|
||||
<a name="updateUser"></a>
|
||||
<h2>updateUser</h2>
|
||||
<h3>PUT: /user.{format}/{username}</h3>
|
||||
<table>
|
||||
<tr>
|
||||
<th class="column_header_name">parameter</th>
|
||||
<th class="column_header_param_type">param type</th>
|
||||
<th class="column_header_data_type">data type</th>
|
||||
<th class="column_header_return_type">response type</th>
|
||||
<th class="column_header_notes">Description</th>
|
||||
</tr>
|
||||
<!-- body params -->
|
||||
<tr>
|
||||
<td>body<br/>required</td>
|
||||
<td>body</td>
|
||||
<td>User*</td>
|
||||
<td>-</td>
|
||||
<td>Updated user object<br/><div id="UserApi_updateUser" class="operation expandable">This can only be done by the logged in user.</div></td>
|
||||
</tr>
|
||||
<!-- path params -->
|
||||
<tr>
|
||||
<td>username<br/>required</td>
|
||||
<td>path</td>
|
||||
<td>string*</td>
|
||||
<td>-</td>
|
||||
<td>name that need to be deleted<br/><div id="UserApi_updateUser" class="operation expandable">This can only be done by the logged in user.</div></td>
|
||||
</tr>
|
||||
<!-- query params -->
|
||||
<!-- header params -->
|
||||
</table>
|
||||
<a name="deleteUser"></a>
|
||||
<h2>deleteUser</h2>
|
||||
<h3>DELETE: /user.{format}/{username}</h3>
|
||||
<table>
|
||||
<tr>
|
||||
<th class="column_header_name">parameter</th>
|
||||
<th class="column_header_param_type">param type</th>
|
||||
<th class="column_header_data_type">data type</th>
|
||||
<th class="column_header_return_type">response type</th>
|
||||
<th class="column_header_notes">Description</th>
|
||||
</tr>
|
||||
<!-- body params -->
|
||||
<!-- path params -->
|
||||
<tr>
|
||||
<td>username<br/>required</td>
|
||||
<td>path</td>
|
||||
<td>string*</td>
|
||||
<td>-</td>
|
||||
<td>The name that needs to be deleted<br/><div id="UserApi_deleteUser" class="operation expandable">This can only be done by the logged in user.</div></td>
|
||||
</tr>
|
||||
<!-- query params -->
|
||||
<!-- header params -->
|
||||
</table>
|
||||
<a name="getUserByName"></a>
|
||||
<h2>getUserByName</h2>
|
||||
<h3>GET: /user.{format}/{username}</h3>
|
||||
<table>
|
||||
<tr>
|
||||
<th class="column_header_name">parameter</th>
|
||||
<th class="column_header_param_type">param type</th>
|
||||
<th class="column_header_data_type">data type</th>
|
||||
<th class="column_header_return_type">response type</th>
|
||||
<th class="column_header_notes">Description</th>
|
||||
</tr>
|
||||
<!-- body params -->
|
||||
<!-- path params -->
|
||||
<tr>
|
||||
<td>username<br/>required</td>
|
||||
<td>path</td>
|
||||
<td>string*</td>
|
||||
<td>User</td>
|
||||
<td>The name that needs to be fetched. Use user1 for testing.<br/><div id="UserApi_getUserByName" class="operation expandable"></div></td>
|
||||
</tr>
|
||||
<!-- query params -->
|
||||
<!-- header params -->
|
||||
</table>
|
||||
<a name="loginUser"></a>
|
||||
<h2>loginUser</h2>
|
||||
<h3>GET: /user.{format}/login</h3>
|
||||
<table>
|
||||
<tr>
|
||||
<th class="column_header_name">parameter</th>
|
||||
<th class="column_header_param_type">param type</th>
|
||||
<th class="column_header_data_type">data type</th>
|
||||
<th class="column_header_return_type">response type</th>
|
||||
<th class="column_header_notes">Description</th>
|
||||
</tr>
|
||||
<!-- body params -->
|
||||
<!-- path params -->
|
||||
<!-- query params -->
|
||||
<tr>
|
||||
<td>username<br/>required</td>
|
||||
<td>query</td>
|
||||
<td>string*</td>
|
||||
<td>string</td>
|
||||
<td>The user name for login<br/><div id="UserApi_loginUser" class="operation expandable"></div></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>password<br/>required</td>
|
||||
<td>query</td>
|
||||
<td>string*</td>
|
||||
<td>string</td>
|
||||
<td>The password for login in clear text<br/><div id="UserApi_loginUser" class="operation expandable"></div></td>
|
||||
</tr>
|
||||
<!-- header params -->
|
||||
</table>
|
||||
<a name="logoutUser"></a>
|
||||
<h2>logoutUser</h2>
|
||||
<h3>GET: /user.{format}/logout</h3>
|
||||
<table>
|
||||
<tr>
|
||||
<th class="column_header_name">parameter</th>
|
||||
<th class="column_header_param_type">param type</th>
|
||||
<th class="column_header_data_type">data type</th>
|
||||
<th class="column_header_return_type">response type</th>
|
||||
<th class="column_header_notes">Description</th>
|
||||
</tr>
|
||||
<!-- body params -->
|
||||
<!-- path params -->
|
||||
<!-- query params -->
|
||||
<!-- header params -->
|
||||
</table>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user