forked from loafle/openapi-generator-original
192 lines
6.5 KiB
HTML
192 lines
6.5 KiB
HTML
<div class="main-content">
|
|
<h2><a name="PetApi"></a>PetApi</h2>
|
|
<p>This is the PetApi API</p>
|
|
|
|
<h2><a name="getPetById"></a>getPetById</h2>
|
|
<hr>
|
|
<p></p>
|
|
<p>Returns a pet based on ID</p><h3 class="section">URL</h3>
|
|
<code>http://petstore.swagger.wordnik.com/api/pet/{petId}</code>
|
|
<h3 class="section">HTTP Method</h3>
|
|
<code>GET</code>
|
|
<h3 class="section">Response Type</h3>
|
|
<div class="model" id="Pet"><a href="#">Pet</a></div>
|
|
<h3 class="section">Parameters</h3>
|
|
<ul>
|
|
<div class="parameter">
|
|
<div class="param">petId : long (path)</div>
|
|
<span></span>
|
|
</div>
|
|
<p class="param-description">ID of pet that needs to be fetched</p>
|
|
</div>
|
|
</ul>
|
|
<h2><a name="deletePet"></a>deletePet</h2>
|
|
<hr>
|
|
<p></p>
|
|
<p></p><h3 class="section">URL</h3>
|
|
<code>http://petstore.swagger.wordnik.com/api/pet/{petId}</code>
|
|
<h3 class="section">HTTP Method</h3>
|
|
<code>DELETE</code>
|
|
<h3 class="section">Response Type</h3>
|
|
<div class="model" id="void"><a href="#"></a></div>
|
|
<h3 class="section">Parameters</h3>
|
|
<ul>
|
|
<div class="parameter">
|
|
<div class="param">petId : string (path)</div>
|
|
<span></span>
|
|
</div>
|
|
<p class="param-description">Pet id to delete</p>
|
|
</div>
|
|
</ul>
|
|
<h2><a name="partialUpdate"></a>partialUpdate</h2>
|
|
<hr>
|
|
<p></p>
|
|
<p></p><h3 class="section">URL</h3>
|
|
<code>http://petstore.swagger.wordnik.com/api/pet/{petId}</code>
|
|
<h3 class="section">HTTP Method</h3>
|
|
<code>PATCH</code>
|
|
<h3 class="section">Response Type</h3>
|
|
<div class="model" id="Pet"><a href="#">Array[Pet]</a></div>
|
|
<h3 class="section">Parameters</h3>
|
|
<ul>
|
|
<div class="parameter">
|
|
<div class="param">petId : string (path)</div>
|
|
<span></span>
|
|
</div>
|
|
<p class="param-description">ID of pet that needs to be fetched</p>
|
|
</div>
|
|
<div class="parameter">
|
|
<div class="param">body : <div class="model" id="Pet"><a href="#">Pet</a> (body)</div>
|
|
<span></span>
|
|
</div>
|
|
<p class="param-description">Pet object that needs to be added to the store</p>
|
|
</div>
|
|
</ul>
|
|
<h2><a name="updatePetWithForm"></a>updatePetWithForm</h2>
|
|
<hr>
|
|
<p></p>
|
|
<p></p><h3 class="section">URL</h3>
|
|
<code>http://petstore.swagger.wordnik.com/api/pet/{petId}</code>
|
|
<h3 class="section">HTTP Method</h3>
|
|
<code>POST</code>
|
|
<h3 class="section">Response Type</h3>
|
|
<div class="model" id="void"><a href="#"></a></div>
|
|
<h3 class="section">Parameters</h3>
|
|
<ul>
|
|
<div class="parameter">
|
|
<div class="param">petId : string (path)</div>
|
|
<span></span>
|
|
</div>
|
|
<p class="param-description">ID of pet that needs to be updated</p>
|
|
</div>
|
|
<div class="parameter">
|
|
<div class="param">name : string (form)</div>
|
|
<span>optional</span>
|
|
</div>
|
|
<p class="param-description">Updated name of the pet</p>
|
|
</div>
|
|
<div class="parameter">
|
|
<div class="param">status : string (form)</div>
|
|
<span>optional</span>
|
|
</div>
|
|
<p class="param-description">Updated status of the pet</p>
|
|
</div>
|
|
</ul>
|
|
<h2><a name="uploadFile"></a>uploadFile</h2>
|
|
<hr>
|
|
<p></p>
|
|
<p></p><h3 class="section">URL</h3>
|
|
<code>http://petstore.swagger.wordnik.com/api/pet/uploadImage</code>
|
|
<h3 class="section">HTTP Method</h3>
|
|
<code>POST</code>
|
|
<h3 class="section">Response Type</h3>
|
|
<div class="model" id="void"><a href="#"></a></div>
|
|
<h3 class="section">Parameters</h3>
|
|
<ul>
|
|
<div class="parameter">
|
|
<div class="param">additionalMetadata : string (form)</div>
|
|
<span>optional</span>
|
|
</div>
|
|
<p class="param-description">Additional data to pass to server</p>
|
|
</div>
|
|
<div class="parameter">
|
|
<div class="param">body : <div class="model" id="File"><a href="#">File</a> (body)</div>
|
|
<span>optional</span>
|
|
</div>
|
|
<p class="param-description">file to upload</p>
|
|
</div>
|
|
</ul>
|
|
<h2><a name="addPet"></a>addPet</h2>
|
|
<hr>
|
|
<p></p>
|
|
<p></p><h3 class="section">URL</h3>
|
|
<code>http://petstore.swagger.wordnik.com/api/pet</code>
|
|
<h3 class="section">HTTP Method</h3>
|
|
<code>POST</code>
|
|
<h3 class="section">Response Type</h3>
|
|
<div class="model" id="void"><a href="#"></a></div>
|
|
<h3 class="section">Parameters</h3>
|
|
<ul>
|
|
<div class="parameter">
|
|
<div class="param">body : <div class="model" id="Pet"><a href="#">Pet</a> (body)</div>
|
|
<span></span>
|
|
</div>
|
|
<p class="param-description">Pet object that needs to be added to the store</p>
|
|
</div>
|
|
</ul>
|
|
<h2><a name="updatePet"></a>updatePet</h2>
|
|
<hr>
|
|
<p></p>
|
|
<p></p><h3 class="section">URL</h3>
|
|
<code>http://petstore.swagger.wordnik.com/api/pet</code>
|
|
<h3 class="section">HTTP Method</h3>
|
|
<code>PUT</code>
|
|
<h3 class="section">Response Type</h3>
|
|
<div class="model" id="void"><a href="#"></a></div>
|
|
<h3 class="section">Parameters</h3>
|
|
<ul>
|
|
<div class="parameter">
|
|
<div class="param">body : <div class="model" id="Pet"><a href="#">Pet</a> (body)</div>
|
|
<span></span>
|
|
</div>
|
|
<p class="param-description">Pet object that needs to be updated in the store</p>
|
|
</div>
|
|
</ul>
|
|
<h2><a name="findPetsByStatus"></a>findPetsByStatus</h2>
|
|
<hr>
|
|
<p></p>
|
|
<p>Multiple status values can be provided with comma seperated strings</p><h3 class="section">URL</h3>
|
|
<code>http://petstore.swagger.wordnik.com/api/pet/findByStatus</code>
|
|
<h3 class="section">HTTP Method</h3>
|
|
<code>GET</code>
|
|
<h3 class="section">Response Type</h3>
|
|
<div class="model" id="Pet"><a href="#">Array[Pet]</a></div>
|
|
<h3 class="section">Parameters</h3>
|
|
<ul>
|
|
<div class="parameter">
|
|
<div class="param">status : string (query)</div>
|
|
<span></span>
|
|
</div>
|
|
<p class="param-description">Status values that need to be considered for filter</p>
|
|
</div>
|
|
</ul>
|
|
<h2><a name="findPetsByTags"></a>findPetsByTags</h2>
|
|
<hr>
|
|
<p></p>
|
|
<p>Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.</p><h3 class="section">URL</h3>
|
|
<code>http://petstore.swagger.wordnik.com/api/pet/findByTags</code>
|
|
<h3 class="section">HTTP Method</h3>
|
|
<code>GET</code>
|
|
<h3 class="section">Response Type</h3>
|
|
<div class="model" id="Pet"><a href="#">Array[Pet]</a></div>
|
|
<h3 class="section">Parameters</h3>
|
|
<ul>
|
|
<div class="parameter">
|
|
<div class="param">tags : string (query)</div>
|
|
<span></span>
|
|
</div>
|
|
<p class="param-description">Tags to filter by</p>
|
|
</div>
|
|
</ul>
|
|
</div>
|