mirror of
https://github.com/sourcey/spectacle.git
synced 2024-09-19 09:27:49 +03:00
3111 lines
145 KiB
HTML
3111 lines
145 KiB
HTML
<!doctype html>
|
||
<html class="no-js" lang="en">
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>Cheese Store | API Reference</title>
|
||
<link rel="stylesheet" href="stylesheets/foundation.min.css" />
|
||
<link rel="stylesheet" href="stylesheets/spectacle.min.css" />
|
||
<script src="https://code.jquery.com/jquery-2.1.4.min.js"></script>
|
||
<!-- <script src="javascripts/foundation.js"></script> -->
|
||
<script src="javascripts/spectacle.min.js"></script>
|
||
</head>
|
||
<body id="spectacle">
|
||
<div id="page" class="drawer-layout drawer-slide-right-large">
|
||
<div id="sidebar">
|
||
<button class="close-button" aria-label="Close menu" type="button" data-drawer-close>
|
||
<span aria-hidden="true">×</span>
|
||
</button>
|
||
<div id="logo">
|
||
<img src="images/cheese.png" title="Cheese Store" /> </div>
|
||
<nav id="nav" role="navigation">
|
||
<h5>Topics</h5>
|
||
<a href="#introduction">Introduction</a>
|
||
<a href="#authentication">Authentication</a>
|
||
<h5>Operations</h5>
|
||
<section>
|
||
<a href="#tag-Cheese">Cheese</a>
|
||
<ul>
|
||
<li>
|
||
<a href="#operation--cheeses-post"> Add a new cheese to the store </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--cheeses-put"> Update an existing cheese </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--cheeses-findByTags-get"> Finds cheeses by tags </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--cheeses--cheeseId--get"> Find cheese by ID </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--cheeses--cheeseId--post"> Update a cheese </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--cheeses--cheeseId--delete"> Deletes a cheese </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--cheeses-findByStatus-get"> Finds cheeses by status </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--cheeses--cheeseId--uploadImage-post"> Upload a cheese image </a>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section>
|
||
<a href="#tag-Store">Store</a>
|
||
<ul>
|
||
<li>
|
||
<a href="#operation--store-inventory-get"> Return cheese inventories by available status </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--store-order-post"> Place a cheese order </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--store-order--orderId--get"> Find purchase order by ID </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--store-order--orderId--delete"> Delete purchase order by ID </a>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section>
|
||
<a href="#tag-Customer">Customer</a>
|
||
<ul>
|
||
<li>
|
||
<a href="#operation--customer-post"> Create customer account </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--customer-createMultiple-post"> Create multiple customers </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--customer-login-post"> Customer login </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--customer-logout-get"> Customer logout </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--customer--username--get"> Get customer by username </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--customer--username--put"> Update customer </a>
|
||
</li>
|
||
<li>
|
||
<a href="#operation--customer--username--delete"> Delete customer </a>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<h5>Schema Definitions</h5>
|
||
<a href="#definition-Order"> Order </a>
|
||
<a href="#definition-Category"> Category </a>
|
||
<a href="#definition-Customer"> Customer </a>
|
||
<a href="#definition-Error"> Error </a>
|
||
<a href="#definition-ValidationError"> ValidationError </a>
|
||
<a href="#definition-NotFoundError"> NotFoundError </a>
|
||
<a href="#definition-Cheese"> Cheese </a>
|
||
<a href="#definition-tag.yml--Tag"> tag.yml#/Tag </a>
|
||
</nav>
|
||
</div>
|
||
<div id="docs" class="row collapse expanded drawer" data-drawer>
|
||
<button class="floating-menu-icon" type="button" data-drawer-slide="right">
|
||
<span class="hamburger"></span>
|
||
</button>
|
||
<div class="example-box doc-content"></div>
|
||
<article>
|
||
<h1 class="doc-title">Cheese Store
|
||
<span>API Reference</span>
|
||
</h1>
|
||
<div id="introduction" data-traverse-target="introduction">
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<p>Welcome to the sample Cheese Store API reference. This is a live example of how you can use
|
||
<a href="https://sourcey.com/spectacle">Spectacle</a> in conjunction with
|
||
<a href="https://swagger.io">Swagger</a> to generate beautiful static documentation for your own APIs.</p>
|
||
<p>The Cheese Store API is organized around the
|
||
<a href="https://en.wikipedia.org/wiki/Representational_state_transfer">REST</a> methodology, and it uses resource-oriented URLs, and common HTTP response codes to indicate API errors. All requests are authenticated using an <code>api-key</code> which can be obtained from your developer dashboard. And now, more cheese...</p>
|
||
<p>Hard cheese gouda say cheese. Ricotta cauliflower cheese cheesecake bocconcini edam bocconcini fromage feta. Who moved my cheese bocconcini cheese and wine cottage cheese cheese on toast who moved my cheese caerphilly stinking bishop. Bocconcini cheesy feet the big cheese macaroni cheese cheesy feet mascarpone.</p>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>API Endpoint</h5>
|
||
<!-- <div class="hljs"> --><pre><code>https://cheesy.sourcey.com/v1</code></pre>
|
||
<!-- </div> -->
|
||
<h5>Terms of Service:
|
||
<a href="http://cheesy.sourcey.com/terms">http://cheesy.sourcey.com/terms</a>
|
||
</h5>
|
||
<h5>Contact:
|
||
<a href="mailto:cheesy@sourcey.com">cheesy@sourcey.com</a>
|
||
</h5>
|
||
<h5>Schemes:
|
||
<span>http, https</span>
|
||
</h5>
|
||
<h5>Version:
|
||
<span>1.0.0</span>
|
||
</h5>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<!-- <h1 id="security" data-traverse-target="security">Security</h1> -->
|
||
<h1 id="authentication" data-traverse-target="authentication">Authentication</h1>
|
||
<div id="security-definition-cheesy_auth" class="panel">
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<h3 class="security-definition-title">
|
||
<span class="security-name">cheesy_auth</span>
|
||
<span class="swagger-security-definition-oauth2"></span>
|
||
</h3>
|
||
<section class="security-definition-description">
|
||
<p>Provides OAuth access to the cheese</p>
|
||
</section>
|
||
<section class="swagger-security-definition-properties">
|
||
<div class="prop-row security-definition-property">
|
||
<div class="prop-name">
|
||
<div class="prop-title security-definition-property-name">type</div>
|
||
</div>
|
||
<div class="prop-value security-definition-property-type"> oauth2 </div>
|
||
</div>
|
||
<div class="prop-row security-definition-property">
|
||
<div class="prop-name">
|
||
<div class="prop-title security-definition-property-name">authorizationUrl</div>
|
||
</div>
|
||
<div class="prop-value security-definition-property-type"> http://cheesy.sourcey.com/api/oauth/dialog </div>
|
||
</div>
|
||
<div class="prop-row security-definition-property">
|
||
<div class="prop-name">
|
||
<div class="prop-title security-definition-property-name">flow</div>
|
||
</div>
|
||
<div class="prop-value security-definition-property-type"> implicit </div>
|
||
</div>
|
||
<div class="prop-row security-definition-property">
|
||
<div class="prop-name">
|
||
<div class="prop-title security-definition-property-name">scopes</div>
|
||
</div>
|
||
<div class="prop-value security-definition-property-type">
|
||
<span id="security-definition-scope-write:cheeses">write:cheeses</span>
|
||
<p class="security-definition-scope-description">Modify cheeses in your account</p>
|
||
<span id="security-definition-scope-read:cheeses">read:cheeses</span>
|
||
<p class="security-definition-scope-description">Read your cheeses</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="security-definition-api_key" class="panel">
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<h3 class="security-definition-title">
|
||
<span class="security-name">api_key</span>
|
||
<span class="swagger-security-definition-apiKey"></span>
|
||
</h3>
|
||
<section class="security-definition-description">
|
||
<p>Provides API Key access to the cheese</p>
|
||
</section>
|
||
<section class="swagger-security-definition-properties">
|
||
<div class="prop-row security-definition-property">
|
||
<div class="prop-name">
|
||
<div class="prop-title security-definition-property-name">type</div>
|
||
</div>
|
||
<div class="prop-value security-definition-property-type"> apiKey </div>
|
||
</div>
|
||
<div class="prop-row security-definition-property">
|
||
<div class="prop-name">
|
||
<div class="prop-title security-definition-property-name">name</div>
|
||
</div>
|
||
<div class="prop-value security-definition-property-type"> api_key </div>
|
||
</div>
|
||
<div class="prop-row security-definition-property">
|
||
<div class="prop-name">
|
||
<div class="prop-title security-definition-property-name">in</div>
|
||
</div>
|
||
<div class="prop-value security-definition-property-type"> header </div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h1 id="tag-Cheese" class="swagger-summary-tag" data-traverse-target="tag-Cheese">Cheese</h1>
|
||
<div class="tag-description doc-row">
|
||
<div class="doc-copy">
|
||
<p>Cheese methods provide access to information and operations relating to the cheese available in the store.</p>
|
||
</div>
|
||
</div>
|
||
<div id="operation--cheeses-post" class="operation panel" data-traverse-target="operation--cheeses-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Cheese">Cheese</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Add a new cheese to the store</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-path">
|
||
<span class="operation-method">POST</span>
|
||
<span class="operation-path">/cheeses</span>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-body">
|
||
<div class="prop-row">
|
||
<div class="prop-name">
|
||
<div class="swagger-request-model">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/Cheese">Cheese</a>
|
||
</span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value columns small-6">
|
||
<!-- <div class="swagger-request-description"> -->
|
||
<p>Cheese object to be added to the store</p>
|
||
<!-- </div> -->
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Request Content-Types:
|
||
<span>application/json, application/xml</span>
|
||
</h5>
|
||
<h5>Request Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-number">1</span>,
|
||
<span class="hljs-attr">"category"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-number">1</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"Italian Cheese"</span>
|
||
},
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"Gorgonzola"</span>,
|
||
<span class="hljs-attr">"photoUrls"</span>: [
|
||
<span class="hljs-string">"https://wannabechef.com/gorgonzola.jpg"</span>
|
||
],
|
||
<span class="hljs-attr">"tags"</span>: [
|
||
{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"integer (int64)"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"status"</span>: <span class="hljs-string">"available"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/Cheese">Cheese</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">422 Unprocessable Entity</div>
|
||
<div class="prop-ref">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/ValidationError">ValidationError</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Invalid input</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/xml, application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-number">1</span>,
|
||
<span class="hljs-attr">"category"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-number">1</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"Italian Cheese"</span>
|
||
},
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"Gorgonzola"</span>,
|
||
<span class="hljs-attr">"photoUrls"</span>: [
|
||
<span class="hljs-string">"https://wannabechef.com/gorgonzola.jpg"</span>
|
||
],
|
||
<span class="hljs-attr">"tags"</span>: [
|
||
{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"integer (int64)"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"status"</span>: <span class="hljs-string">"available"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(422 Unprocessable Entity)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"code"</span>: <span class="hljs-number">422</span>,
|
||
<span class="hljs-attr">"type"</span>: <span class="hljs-string">"Validation error"</span>,
|
||
<span class="hljs-attr">"message"</span>: <span class="hljs-string">"Your cheese is not mouldy enough"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-security">
|
||
<table class="table">
|
||
<thead>
|
||
<tr>
|
||
<th class="swagger-request-security-schema"></th>
|
||
<th class="swagger-request-security-scopes"></th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<a href="#security-definition-cheesy_auth">cheesy_auth</a>
|
||
</td>
|
||
<td>
|
||
<a href="#security-definition-scope-write:cheeses">write:cheeses</a>,
|
||
<a href="#security-definition-scope-read:cheeses">read:cheeses</a>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--cheeses-put" class="operation panel" data-traverse-target="operation--cheeses-put">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Cheese">Cheese</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Update an existing cheese</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-path">
|
||
<span class="operation-method">PUT</span>
|
||
<span class="operation-path">/cheeses</span>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-body">
|
||
<div class="prop-row">
|
||
<div class="prop-name">
|
||
<div class="swagger-request-model">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/Cheese">Cheese</a>
|
||
</span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value columns small-6">
|
||
<!-- <div class="swagger-request-description"> -->
|
||
<p>Cheese object that needs to be updated</p>
|
||
<!-- </div> -->
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Request Content-Types:
|
||
<span>application/json, application/xml</span>
|
||
</h5>
|
||
<h5>Request Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-number">1</span>,
|
||
<span class="hljs-attr">"category"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-number">1</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"Italian Cheese"</span>
|
||
},
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"Gorgonzola"</span>,
|
||
<span class="hljs-attr">"photoUrls"</span>: [
|
||
<span class="hljs-string">"https://wannabechef.com/gorgonzola.jpg"</span>
|
||
],
|
||
<span class="hljs-attr">"tags"</span>: [
|
||
{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"integer (int64)"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"status"</span>: <span class="hljs-string">"available"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">404 Not Found</div>
|
||
<div class="prop-ref">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/NotFoundError">NotFoundError</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Cheese not found</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">422 Unprocessable Entity</div>
|
||
<div class="prop-ref">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/ValidationError">ValidationError</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Validation exception</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/xml, application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(404 Not Found)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"code"</span>: <span class="hljs-number">404</span>,
|
||
<span class="hljs-attr">"type"</span>: <span class="hljs-string">"Not found"</span>,
|
||
<span class="hljs-attr">"message"</span>: <span class="hljs-string">"Your cheese has already been eaten"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(422 Unprocessable Entity)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"code"</span>: <span class="hljs-number">422</span>,
|
||
<span class="hljs-attr">"type"</span>: <span class="hljs-string">"Validation error"</span>,
|
||
<span class="hljs-attr">"message"</span>: <span class="hljs-string">"Your cheese is not mouldy enough"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-security">
|
||
<table class="table">
|
||
<thead>
|
||
<tr>
|
||
<th class="swagger-request-security-schema"></th>
|
||
<th class="swagger-request-security-scopes"></th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<a href="#security-definition-cheesy_auth">cheesy_auth</a>
|
||
</td>
|
||
<td>
|
||
<a href="#security-definition-scope-write:cheeses">write:cheeses</a>,
|
||
<a href="#security-definition-scope-read:cheeses">read:cheeses</a>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--cheeses-findByTags-get" class="operation panel" data-traverse-target="operation--cheeses-findByTags-get">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Cheese">Cheese</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Finds cheeses by tags</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-path">
|
||
<span class="operation-method">GET</span>
|
||
<span class="operation-path">/cheeses/findByTags</span>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.</p>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">tags</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in query </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string[]</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Tags to filter by</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner"> Array values passed as multiple parameters: <code>?tags=aaa&tags=bbb</code> </div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref">
|
||
<span class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/Cheese">Cheese</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner">
|
||
<div class="prop-name">type</div>
|
||
<div class="prop-value">
|
||
<span class="json-property-type">
|
||
<span class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/Cheese">Cheese</a>
|
||
</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">404 Not Found</div>
|
||
<div class="prop-ref">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/NotFoundError">NotFoundError</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Invalid tag value</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/xml, application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
|
||
{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-number">1</span>,
|
||
<span class="hljs-attr">"category"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-number">1</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"Italian Cheese"</span>
|
||
},
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"Gorgonzola"</span>,
|
||
<span class="hljs-attr">"photoUrls"</span>: [
|
||
<span class="hljs-string">"https://wannabechef.com/gorgonzola.jpg"</span>
|
||
],
|
||
<span class="hljs-attr">"tags"</span>: [
|
||
{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"integer (int64)"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"status"</span>: <span class="hljs-string">"available"</span>
|
||
}
|
||
]
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(404 Not Found)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"code"</span>: <span class="hljs-number">404</span>,
|
||
<span class="hljs-attr">"type"</span>: <span class="hljs-string">"Not found"</span>,
|
||
<span class="hljs-attr">"message"</span>: <span class="hljs-string">"Your cheese has already been eaten"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-security">
|
||
<table class="table">
|
||
<thead>
|
||
<tr>
|
||
<th class="swagger-request-security-schema"></th>
|
||
<th class="swagger-request-security-scopes"></th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<a href="#security-definition-cheesy_auth">cheesy_auth</a>
|
||
</td>
|
||
<td>
|
||
<a href="#security-definition-scope-write:cheeses">write:cheeses</a>,
|
||
<a href="#security-definition-scope-read:cheeses">read:cheeses</a>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--cheeses--cheeseId--get" class="operation panel" data-traverse-target="operation--cheeses--cheeseId--get">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Cheese">Cheese</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Find cheese by ID</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-path">
|
||
<span class="operation-method">GET</span>
|
||
<span class="operation-path">/cheeses/{cheeseId}</span>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>Return a specific cheese by its ID.</p>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">cheeseId</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in path </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">integer</span>
|
||
<span class="json-property-format">(int64)</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>ID of cheese to return</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/Cheese">Cheese</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">404 Not Found</div>
|
||
<div class="prop-ref">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/NotFoundError">NotFoundError</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Cheese not found</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/xml, application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-number">1</span>,
|
||
<span class="hljs-attr">"category"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-number">1</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"Italian Cheese"</span>
|
||
},
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"Gorgonzola"</span>,
|
||
<span class="hljs-attr">"photoUrls"</span>: [
|
||
<span class="hljs-string">"https://wannabechef.com/gorgonzola.jpg"</span>
|
||
],
|
||
<span class="hljs-attr">"tags"</span>: [
|
||
{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"integer (int64)"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"status"</span>: <span class="hljs-string">"available"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(404 Not Found)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"code"</span>: <span class="hljs-number">404</span>,
|
||
<span class="hljs-attr">"type"</span>: <span class="hljs-string">"Not found"</span>,
|
||
<span class="hljs-attr">"message"</span>: <span class="hljs-string">"Your cheese has already been eaten"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-security">
|
||
<table class="table">
|
||
<thead>
|
||
<tr>
|
||
<th class="swagger-request-security-schema"></th>
|
||
<th class="swagger-request-security-scopes"></th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<a href="#security-definition-api_key">api_key</a>
|
||
</td>
|
||
<td> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--cheeses--cheeseId--post" class="operation panel" data-traverse-target="operation--cheeses--cheeseId--post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Cheese">Cheese</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Update a cheese</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-path">
|
||
<span class="operation-method">POST</span>
|
||
<span class="operation-path">/cheeses/{cheeseId}</span>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>Updates a cheese in the Store with form data.</p>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">cheeseId</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in path </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">integer</span>
|
||
<span class="json-property-format">(int64)</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>ID of the cheese to be updated</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">name</div>
|
||
<div class="prop-subtitle"> in formData </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Updated name of the cheese</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">status</div>
|
||
<div class="prop-subtitle"> in formData </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Updated status of the cheese</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">422 Unprocessable Entity</div>
|
||
<div class="prop-ref">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/ValidationError">ValidationError</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Cannot update cheese</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/xml, application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(422 Unprocessable Entity)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"code"</span>: <span class="hljs-number">422</span>,
|
||
<span class="hljs-attr">"type"</span>: <span class="hljs-string">"Validation error"</span>,
|
||
<span class="hljs-attr">"message"</span>: <span class="hljs-string">"Your cheese is not mouldy enough"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-security">
|
||
<table class="table">
|
||
<thead>
|
||
<tr>
|
||
<th class="swagger-request-security-schema"></th>
|
||
<th class="swagger-request-security-scopes"></th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<a href="#security-definition-cheesy_auth">cheesy_auth</a>
|
||
</td>
|
||
<td>
|
||
<a href="#security-definition-scope-write:cheeses">write:cheeses</a>,
|
||
<a href="#security-definition-scope-read:cheeses">read:cheeses</a>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--cheeses--cheeseId--delete" class="operation panel" data-traverse-target="operation--cheeses--cheeseId--delete">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Cheese">Cheese</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Deletes a cheese</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-path">
|
||
<span class="operation-method">DELETE</span>
|
||
<span class="operation-path">/cheeses/{cheeseId}</span>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">api_key</div>
|
||
<div class="prop-subtitle"> in header </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p class="no-description">(no description)</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">cheeseId</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in path </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">integer</span>
|
||
<span class="json-property-format">(int64)</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Cheese ID to delete</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">404 Not Found</div>
|
||
<div class="prop-ref">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/NotFoundError">NotFoundError</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Cheese not found</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/xml, application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(404 Not Found)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"code"</span>: <span class="hljs-number">404</span>,
|
||
<span class="hljs-attr">"type"</span>: <span class="hljs-string">"Not found"</span>,
|
||
<span class="hljs-attr">"message"</span>: <span class="hljs-string">"Your cheese has already been eaten"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-security">
|
||
<table class="table">
|
||
<thead>
|
||
<tr>
|
||
<th class="swagger-request-security-schema"></th>
|
||
<th class="swagger-request-security-scopes"></th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<a href="#security-definition-cheesy_auth">cheesy_auth</a>
|
||
</td>
|
||
<td>
|
||
<a href="#security-definition-scope-write:cheeses">write:cheeses</a>,
|
||
<a href="#security-definition-scope-read:cheeses">read:cheeses</a>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--cheeses-findByStatus-get" class="operation panel" data-traverse-target="operation--cheeses-findByStatus-get">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Cheese">Cheese</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Finds cheeses by status</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-path">
|
||
<span class="operation-method">GET</span>
|
||
<span class="operation-path">/cheeses/findByStatus</span>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>Multiple status values can be provided with comma separated strings.</p>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">status</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in query </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string[]</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Status values that need to be considered for filter</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner"> Array values passed as multiple parameters: <code>?status=aaa&status=bbb</code> </div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref">
|
||
<span class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/Cheese">Cheese</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner">
|
||
<div class="prop-name">type</div>
|
||
<div class="prop-value">
|
||
<span class="json-property-type">
|
||
<span class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/Cheese">Cheese</a>
|
||
</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">404 Not Found</div>
|
||
<div class="prop-ref">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/NotFoundError">NotFoundError</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Invalid status value</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/xml, application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
|
||
{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-number">1</span>,
|
||
<span class="hljs-attr">"category"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-number">1</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"Italian Cheese"</span>
|
||
},
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"Gorgonzola"</span>,
|
||
<span class="hljs-attr">"photoUrls"</span>: [
|
||
<span class="hljs-string">"https://wannabechef.com/gorgonzola.jpg"</span>
|
||
],
|
||
<span class="hljs-attr">"tags"</span>: [
|
||
{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"integer (int64)"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"status"</span>: <span class="hljs-string">"available"</span>
|
||
}
|
||
]
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(404 Not Found)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"code"</span>: <span class="hljs-number">404</span>,
|
||
<span class="hljs-attr">"type"</span>: <span class="hljs-string">"Not found"</span>,
|
||
<span class="hljs-attr">"message"</span>: <span class="hljs-string">"Your cheese has already been eaten"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-security">
|
||
<table class="table">
|
||
<thead>
|
||
<tr>
|
||
<th class="swagger-request-security-schema"></th>
|
||
<th class="swagger-request-security-scopes"></th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<a href="#security-definition-cheesy_auth">cheesy_auth</a>
|
||
</td>
|
||
<td>
|
||
<a href="#security-definition-scope-write:cheeses">write:cheeses</a>,
|
||
<a href="#security-definition-scope-read:cheeses">read:cheeses</a>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--cheeses--cheeseId--uploadImage-post" class="operation panel" data-traverse-target="operation--cheeses--cheeseId--uploadImage-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Cheese">Cheese</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Upload a cheese image</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-path">
|
||
<span class="operation-method">POST</span>
|
||
<span class="operation-path">/cheeses/{cheeseId}/uploadImage</span>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">cheeseId</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in path </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">integer</span>
|
||
<span class="json-property-format">(int64)</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>ID of cheese to update</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">additionalMetadata</div>
|
||
<div class="prop-subtitle"> in formData </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Additional data to pass to server</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">file</div>
|
||
<div class="prop-subtitle"> in formData </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">file</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Image file to upload</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/Cheese">Cheese</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Successful operation</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-number">1</span>,
|
||
<span class="hljs-attr">"category"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-number">1</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"Italian Cheese"</span>
|
||
},
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"Gorgonzola"</span>,
|
||
<span class="hljs-attr">"photoUrls"</span>: [
|
||
<span class="hljs-string">"https://wannabechef.com/gorgonzola.jpg"</span>
|
||
],
|
||
<span class="hljs-attr">"tags"</span>: [
|
||
{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"integer (int64)"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"status"</span>: <span class="hljs-string">"available"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-security">
|
||
<table class="table">
|
||
<thead>
|
||
<tr>
|
||
<th class="swagger-request-security-schema"></th>
|
||
<th class="swagger-request-security-scopes"></th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<a href="#security-definition-cheesy_auth">cheesy_auth</a>
|
||
</td>
|
||
<td>
|
||
<a href="#security-definition-scope-write:cheeses">write:cheeses</a>,
|
||
<a href="#security-definition-scope-read:cheeses">read:cheeses</a>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h1 id="tag-Store" class="swagger-summary-tag" data-traverse-target="tag-Store">Store</h1>
|
||
<div class="tag-description doc-row">
|
||
<div class="doc-copy">
|
||
<p>Store methods provide access to cheese store orders.</p>
|
||
</div>
|
||
</div>
|
||
<div id="operation--store-inventory-get" class="operation panel" data-traverse-target="operation--store-inventory-get">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Store">Store</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Return cheese inventories by available status</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-path">
|
||
<span class="operation-method">GET</span>
|
||
<span class="operation-path">/store/inventory</span>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>Returns a list of available cheeses.</p>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy"> </div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref">
|
||
<span class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/Cheese">Cheese</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner">
|
||
<div class="prop-name">type</div>
|
||
<div class="prop-value">
|
||
<span class="json-property-type">
|
||
<span class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href="#/definitions/Cheese">Cheese</a>
|
||
</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
|
||
{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-number">1</span>,
|
||
<span class="hljs-attr">"category"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-number">1</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"Italian Cheese"</span>
|
||
},
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"Gorgonzola"</span>,
|
||
<span class="hljs-attr">"photoUrls"</span>: [
|
||
<span class="hljs-string">"https://wannabechef.com/gorgonzola.jpg"</span>
|
||
],
|
||
<span class="hljs-attr">"tags"</span>: [
|
||
{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"integer (int64)"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"status"</span>: <span class="hljs-string">"available"</span>
|
||
}
|
||
]
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-security">
|
||
<table class="table">
|
||
<thead>
|
||
<tr>
|
||
<th class="swagger-request-security-schema"></th>
|
||
<th class="swagger-request-security-scopes"></th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<a href="#security-definition-api_key">api_key</a>
|
||
</td>
|
||
<td> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--store-order-post" class="operation panel" data-traverse-target="operation--store-order-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Store">Store</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Place a cheese order</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-path">
|
||
<span class="operation-method">POST</span>
|
||
<span class="operation-path">/store/order</span>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>Place an order to purchase cheese from the store.</p>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-body">
|
||
<div class="prop-row">
|
||
<div class="prop-name">
|
||
<div class="swagger-request-model">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/Order">Order</a>
|
||
</span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value columns small-6">
|
||
<!-- <div class="swagger-request-description"> -->
|
||
<p>Order to place for purchasing the cheese.</p>
|
||
<!-- </div> -->
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Request Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"cheeseId"</span>: <span class="hljs-string">"1"</span>,
|
||
<span class="hljs-attr">"complete"</span>: <span class="hljs-string">"true"</span>,
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"1"</span>,
|
||
<span class="hljs-attr">"quantity"</span>: <span class="hljs-string">"66"</span>,
|
||
<span class="hljs-attr">"shipDate"</span>: <span class="hljs-string">"04-10-2017 00:09:21 UTC"</span>,
|
||
<span class="hljs-attr">"status"</span>: <span class="hljs-string">"available"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/Order">Order</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">422 Unprocessable Entity</div>
|
||
<div class="prop-ref">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/ValidationError">ValidationError</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Invalid order</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/xml, application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"cheeseId"</span>: <span class="hljs-string">"1"</span>,
|
||
<span class="hljs-attr">"complete"</span>: <span class="hljs-string">"true"</span>,
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"1"</span>,
|
||
<span class="hljs-attr">"quantity"</span>: <span class="hljs-string">"66"</span>,
|
||
<span class="hljs-attr">"shipDate"</span>: <span class="hljs-string">"04-10-2017 00:09:21 UTC"</span>,
|
||
<span class="hljs-attr">"status"</span>: <span class="hljs-string">"available"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(422 Unprocessable Entity)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"code"</span>: <span class="hljs-number">422</span>,
|
||
<span class="hljs-attr">"type"</span>: <span class="hljs-string">"Validation error"</span>,
|
||
<span class="hljs-attr">"message"</span>: <span class="hljs-string">"Your cheese is not mouldy enough"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--store-order--orderId--get" class="operation panel" data-traverse-target="operation--store-order--orderId--get">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Store">Store</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Find purchase order by ID</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-path">
|
||
<span class="operation-method">GET</span>
|
||
<span class="operation-path">/store/order/{orderId}</span>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>For valid response try integer IDs with value >= 1 and <= 10. Other values will generate exceptions.</p>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">orderId</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in path </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">integer</span>
|
||
<span class="json-property-format">(int64)</span>
|
||
<span class="json-property-range" title="Value limits">1 ≤ x ≤ 10</span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>ID of cheese that needs to be fetched</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/Order">Order</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">404 Not Found</div>
|
||
<div class="prop-ref">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/NotFoundError">NotFoundError</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Order not found</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/xml, application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"cheeseId"</span>: <span class="hljs-string">"1"</span>,
|
||
<span class="hljs-attr">"complete"</span>: <span class="hljs-string">"true"</span>,
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"1"</span>,
|
||
<span class="hljs-attr">"quantity"</span>: <span class="hljs-string">"66"</span>,
|
||
<span class="hljs-attr">"shipDate"</span>: <span class="hljs-string">"04-10-2017 00:09:21 UTC"</span>,
|
||
<span class="hljs-attr">"status"</span>: <span class="hljs-string">"available"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(404 Not Found)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"code"</span>: <span class="hljs-number">404</span>,
|
||
<span class="hljs-attr">"type"</span>: <span class="hljs-string">"Not found"</span>,
|
||
<span class="hljs-attr">"message"</span>: <span class="hljs-string">"Your cheese has already been eaten"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--store-order--orderId--delete" class="operation panel" data-traverse-target="operation--store-order--orderId--delete">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Store">Store</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Delete purchase order by ID</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-path">
|
||
<span class="operation-method">DELETE</span>
|
||
<span class="operation-path">/store/order/{orderId}</span>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors.</p>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">orderId</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in path </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">integer</span>
|
||
<span class="json-property-format">(int64)</span>
|
||
<span class="json-property-range" title="Value limits">x ≥ 1</span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>ID of the order that needs to be deleted</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">404 Not Found</div>
|
||
<div class="prop-ref">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/NotFoundError">NotFoundError</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Order not found</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/xml, application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(404 Not Found)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"code"</span>: <span class="hljs-number">404</span>,
|
||
<span class="hljs-attr">"type"</span>: <span class="hljs-string">"Not found"</span>,
|
||
<span class="hljs-attr">"message"</span>: <span class="hljs-string">"Your cheese has already been eaten"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h1 id="tag-Customer" class="swagger-summary-tag" data-traverse-target="tag-Customer">Customer</h1>
|
||
<div class="tag-description doc-row">
|
||
<div class="doc-copy">
|
||
<p>Customer methods contain operations relating to customer accounts.</p>
|
||
</div>
|
||
</div>
|
||
<div id="operation--customer-post" class="operation panel" data-traverse-target="operation--customer-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Customer">Customer</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Create customer account</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-path">
|
||
<span class="operation-method">POST</span>
|
||
<span class="operation-path">/customer</span>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>This can only be done by the logged in customer.</p>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-body">
|
||
<div class="prop-row">
|
||
<div class="prop-name">
|
||
<div class="swagger-request-model">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/Customer">Customer</a>
|
||
</span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value columns small-6">
|
||
<!-- <div class="swagger-request-description"> -->
|
||
<p>Created customer object</p>
|
||
<!-- </div> -->
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Request Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-number">1</span>,
|
||
<span class="hljs-attr">"username"</span>: <span class="hljs-string">"gordo"</span>,
|
||
<span class="hljs-attr">"firstName"</span>: <span class="hljs-string">"Alotta"</span>,
|
||
<span class="hljs-attr">"lastName"</span>: <span class="hljs-string">"Cheese"</span>,
|
||
<span class="hljs-attr">"email"</span>: <span class="hljs-string">"love@cheese.com"</span>,
|
||
<span class="hljs-attr">"password"</span>: <span class="hljs-string">"secret"</span>,
|
||
<span class="hljs-attr">"phone"</span>: <span class="hljs-string">"+3344556677"</span>,
|
||
<span class="hljs-attr">"customerStatus"</span>: <span class="hljs-string">"obese"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">default </div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Successful operation</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/xml, application/json</span>
|
||
</h5>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--customer-createMultiple-post" class="operation panel" data-traverse-target="operation--customer-createMultiple-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Customer">Customer</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Create multiple customers</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-path">
|
||
<span class="operation-method">POST</span>
|
||
<span class="operation-path">/customer/createMultiple</span>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>Create a list of customers from the given input array.</p>
|
||
<p>And here is a random inline code block:</p> <pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"greeting"</span>: Wassup()
|
||
}
|
||
</code></pre>
|
||
<p>All good?</p>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-body">
|
||
<p>List of created customer objects</p>
|
||
<section class="json-schema-array-items">
|
||
<span class="json-property-type">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/Customer">Customer</a>
|
||
</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<div class="json-inner-schema"> </div>
|
||
</section>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Request Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">[
|
||
{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-number">1</span>,
|
||
<span class="hljs-attr">"username"</span>: <span class="hljs-string">"gordo"</span>,
|
||
<span class="hljs-attr">"firstName"</span>: <span class="hljs-string">"Alotta"</span>,
|
||
<span class="hljs-attr">"lastName"</span>: <span class="hljs-string">"Cheese"</span>,
|
||
<span class="hljs-attr">"email"</span>: <span class="hljs-string">"love@cheese.com"</span>,
|
||
<span class="hljs-attr">"password"</span>: <span class="hljs-string">"secret"</span>,
|
||
<span class="hljs-attr">"phone"</span>: <span class="hljs-string">"+3344556677"</span>,
|
||
<span class="hljs-attr">"customerStatus"</span>: <span class="hljs-string">"obese"</span>
|
||
}
|
||
]
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">default </div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Successful operation</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/xml, application/json</span>
|
||
</h5>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--customer-login-post" class="operation panel" data-traverse-target="operation--customer-login-post">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Customer">Customer</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Customer login</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-path">
|
||
<span class="operation-method">POST</span>
|
||
<span class="operation-path">/customer/login</span>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>Log a customer into the system and create a new user session.</p>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">username</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in query </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>The username for login</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">password</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in query </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>The password for login in clear text</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref"></div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-inner">
|
||
<div class="prop-name">type</div>
|
||
<div class="prop-value">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">422 Unprocessable Entity</div>
|
||
<div class="prop-ref">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/ValidationError">ValidationError</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Invalid username/password supplied</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/xml, application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json"><span class="hljs-string">"string"</span>
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
<section>
|
||
<h5>Response Headers
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<section class="swagger-response-headers">
|
||
<table class="table">
|
||
<thead>
|
||
<tr>
|
||
<th class="swagger-response-header-name"></th>
|
||
<th class="swagger-response-header-description"></th>
|
||
<th class="swagger-response-header-data-type"></th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="swagger-response-header-X-Rate-Limit">
|
||
<td> X-Rate-Limit
|
||
<td>
|
||
<p>Calls per hour allowed by the customer</p>
|
||
</td>
|
||
<td>
|
||
<span class="json-property-type">integer</span>
|
||
<span class="json-property-format">(int32)</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</td>
|
||
</tr>
|
||
<tr class="swagger-response-header-X-Expires-After">
|
||
<td> X-Expires-After
|
||
<td>
|
||
<p>Date in UTC when token expires</p>
|
||
</td>
|
||
<td>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-format">(date-time)</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</section>
|
||
</section>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(422 Unprocessable Entity)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"code"</span>: <span class="hljs-number">422</span>,
|
||
<span class="hljs-attr">"type"</span>: <span class="hljs-string">"Validation error"</span>,
|
||
<span class="hljs-attr">"message"</span>: <span class="hljs-string">"Your cheese is not mouldy enough"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--customer-logout-get" class="operation panel" data-traverse-target="operation--customer-logout-get">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Customer">Customer</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Customer logout</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-path">
|
||
<span class="operation-method">GET</span>
|
||
<span class="operation-path">/customer/logout</span>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>Log the currently the authenticated customer out of the system and end the user session.</p>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy"> </div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">default </div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Successful operation</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/xml, application/json</span>
|
||
</h5>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--customer--username--get" class="operation panel" data-traverse-target="operation--customer--username--get">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Customer">Customer</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Get customer by username</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-path">
|
||
<span class="operation-method">GET</span>
|
||
<span class="operation-path">/customer/{username}</span>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>Get customer by their customer username.</p>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">username</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in path </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>The username of the customer to be fetched.</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">200 OK</div>
|
||
<div class="prop-ref">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/Customer">Customer</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Successful operation</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">404 Not Found</div>
|
||
<div class="prop-ref">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/NotFoundError">NotFoundError</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Customer not found</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/xml, application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(200 OK)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-number">1</span>,
|
||
<span class="hljs-attr">"username"</span>: <span class="hljs-string">"gordo"</span>,
|
||
<span class="hljs-attr">"firstName"</span>: <span class="hljs-string">"Alotta"</span>,
|
||
<span class="hljs-attr">"lastName"</span>: <span class="hljs-string">"Cheese"</span>,
|
||
<span class="hljs-attr">"email"</span>: <span class="hljs-string">"love@cheese.com"</span>,
|
||
<span class="hljs-attr">"password"</span>: <span class="hljs-string">"secret"</span>,
|
||
<span class="hljs-attr">"phone"</span>: <span class="hljs-string">"+3344556677"</span>,
|
||
<span class="hljs-attr">"customerStatus"</span>: <span class="hljs-string">"obese"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(404 Not Found)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"code"</span>: <span class="hljs-number">404</span>,
|
||
<span class="hljs-attr">"type"</span>: <span class="hljs-string">"Not found"</span>,
|
||
<span class="hljs-attr">"message"</span>: <span class="hljs-string">"Your cheese has already been eaten"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--customer--username--put" class="operation panel" data-traverse-target="operation--customer--username--put">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Customer">Customer</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Update customer</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-path">
|
||
<span class="operation-method">PUT</span>
|
||
<span class="operation-path">/customer/{username}</span>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>This can only be done by the logged in customer.</p>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-body">
|
||
<div class="prop-row">
|
||
<div class="prop-name">
|
||
<div class="swagger-request-model">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/Customer">Customer</a>
|
||
</span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value columns small-6">
|
||
<!-- <div class="swagger-request-description"> -->
|
||
<p>Customer object to be updated.</p>
|
||
<!-- </div> -->
|
||
</div>
|
||
</div>
|
||
</section>
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">username</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in path </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Username of the customer to update.</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Request Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-number">1</span>,
|
||
<span class="hljs-attr">"username"</span>: <span class="hljs-string">"gordo"</span>,
|
||
<span class="hljs-attr">"firstName"</span>: <span class="hljs-string">"Alotta"</span>,
|
||
<span class="hljs-attr">"lastName"</span>: <span class="hljs-string">"Cheese"</span>,
|
||
<span class="hljs-attr">"email"</span>: <span class="hljs-string">"love@cheese.com"</span>,
|
||
<span class="hljs-attr">"password"</span>: <span class="hljs-string">"secret"</span>,
|
||
<span class="hljs-attr">"phone"</span>: <span class="hljs-string">"+3344556677"</span>,
|
||
<span class="hljs-attr">"customerStatus"</span>: <span class="hljs-string">"obese"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">400 Bad Request</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Invalid customer supplied</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">404 Not Found</div>
|
||
<div class="prop-ref">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/NotFoundError">NotFoundError</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Customer not found</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/xml, application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(404 Not Found)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"code"</span>: <span class="hljs-number">404</span>,
|
||
<span class="hljs-attr">"type"</span>: <span class="hljs-string">"Not found"</span>,
|
||
<span class="hljs-attr">"message"</span>: <span class="hljs-string">"Your cheese has already been eaten"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="operation--customer--username--delete" class="operation panel" data-traverse-target="operation--customer--username--delete">
|
||
<!-- <section class="operation-tags row"> -->
|
||
<!-- <div class="doc-copy"> -->
|
||
<div class="operation-tags">
|
||
<a class="label" href="#tag-Customer">Customer</a>
|
||
<!---->
|
||
</div>
|
||
<!-- </div> -->
|
||
<!-- </section> -->
|
||
<h2 class="operation-title">
|
||
<span class="operation-summary">Delete customer</span>
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-path">
|
||
<span class="operation-method">DELETE</span>
|
||
<span class="operation-path">/customer/{username}</span>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-operation-description">
|
||
<p>Datate a customer by their username.</p>
|
||
</section>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-request-params">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">username</div>
|
||
<span class="json-property-required"></span>
|
||
<div class="prop-subtitle"> in path </div>
|
||
<div class="prop-subtitle">
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Username of the customer to delete.</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples"></div>
|
||
</div>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="swagger-responses">
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">400 Bad Request</div>
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Invalid username supplied</p>
|
||
</div>
|
||
</div>
|
||
<div class="prop-row prop-group">
|
||
<div class="prop-name">
|
||
<div class="prop-title">404 Not Found</div>
|
||
<div class="prop-ref">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/NotFoundError">NotFoundError</a>
|
||
</span>
|
||
</div>
|
||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||
</div>
|
||
<div class="prop-value">
|
||
<p>Customer not found</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<h5>Response Content-Types:
|
||
<span>application/xml, application/json</span>
|
||
</h5>
|
||
<section>
|
||
<h5>Response Example
|
||
<span>(404 Not Found)</span>
|
||
</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"code"</span>: <span class="hljs-number">404</span>,
|
||
<span class="hljs-attr">"type"</span>: <span class="hljs-string">"Not found"</span>,
|
||
<span class="hljs-attr">"message"</span>: <span class="hljs-string">"Your cheese has already been eaten"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h1>Schema Definitions</h1>
|
||
<div id="definition-Order" class="definition panel" data-traverse-target="definition-Order">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/Order"></a>Order: object
|
||
<!-- <span class="json-property-type"><span class="json-property-type">object</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="id">
|
||
<span class="json-property-name">id:</span>
|
||
<span class="json-property-type">integer</span>
|
||
<span class="json-property-format">(int64)</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="cheeseId">
|
||
<span class="json-property-name">cheeseId:</span>
|
||
<span class="json-property-type">integer</span>
|
||
<span class="json-property-format">(int64)</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="quantity">
|
||
<span class="json-property-name">quantity:</span>
|
||
<span class="json-property-type">integer</span>
|
||
<span class="json-property-format">(int32)</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="shipDate">
|
||
<span class="json-property-name">shipDate:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-format">(date-time)</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="status" class="has-description">
|
||
<span class="json-property-name">status:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-enum" title="Possible values">
|
||
<span class="json-property-enum-item">placed</span>,
|
||
<span class="json-property-enum-item">approved</span>,
|
||
<span class="json-property-enum-item">delivered</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dd>
|
||
<p>Order Status</p>
|
||
</dd>
|
||
<dt data-property-name="complete">
|
||
<span class="json-property-name">complete:</span>
|
||
<span class="json-property-type">boolean</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-default-value" title="Default value">false</span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"cheeseId"</span>: <span class="hljs-string">"1"</span>,
|
||
<span class="hljs-attr">"complete"</span>: <span class="hljs-string">"true"</span>,
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"1"</span>,
|
||
<span class="hljs-attr">"quantity"</span>: <span class="hljs-string">"66"</span>,
|
||
<span class="hljs-attr">"shipDate"</span>: <span class="hljs-string">"04-10-2017 00:09:21 UTC"</span>,
|
||
<span class="hljs-attr">"status"</span>: <span class="hljs-string">"available"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-Category" class="definition panel" data-traverse-target="definition-Category">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/Category"></a>Category: object
|
||
<!-- <span class="json-property-type"><span class="json-property-type">object</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="id">
|
||
<span class="json-property-name">id:</span>
|
||
<span class="json-property-type">integer</span>
|
||
<span class="json-property-format">(int64)</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="name">
|
||
<span class="json-property-name">name:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-number">1</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"Italian Cheese"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-Customer" class="definition panel" data-traverse-target="definition-Customer">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/Customer"></a>Customer: object
|
||
<!-- <span class="json-property-type"><span class="json-property-type">object</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="id">
|
||
<span class="json-property-name">id:</span>
|
||
<span class="json-property-type">integer</span>
|
||
<span class="json-property-format">(int64)</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="username">
|
||
<span class="json-property-name">username:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="firstName" class="has-description">
|
||
<span class="json-property-name">firstName:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dd>
|
||
<p>Customer first name</p>
|
||
</dd>
|
||
<dt data-property-name="lastName" class="has-description">
|
||
<span class="json-property-name">lastName:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dd>
|
||
<p>Customer last name</p>
|
||
</dd>
|
||
<dt data-property-name="email">
|
||
<span class="json-property-name">email:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="password">
|
||
<span class="json-property-name">password:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="phone">
|
||
<span class="json-property-name">phone:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="customerStatus" class="has-description">
|
||
<span class="json-property-name">customerStatus:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-enum" title="Possible values">
|
||
<span class="json-property-enum-item">skinny</span>,
|
||
<span class="json-property-enum-item">average</span>,
|
||
<span class="json-property-enum-item">fat</span>,
|
||
<span class="json-property-enum-item">obese</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dd>
|
||
<p>Customer status (the heavier the better)</p>
|
||
</dd>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-number">1</span>,
|
||
<span class="hljs-attr">"username"</span>: <span class="hljs-string">"gordo"</span>,
|
||
<span class="hljs-attr">"firstName"</span>: <span class="hljs-string">"Alotta"</span>,
|
||
<span class="hljs-attr">"lastName"</span>: <span class="hljs-string">"Cheese"</span>,
|
||
<span class="hljs-attr">"email"</span>: <span class="hljs-string">"love@cheese.com"</span>,
|
||
<span class="hljs-attr">"password"</span>: <span class="hljs-string">"secret"</span>,
|
||
<span class="hljs-attr">"phone"</span>: <span class="hljs-string">"+3344556677"</span>,
|
||
<span class="hljs-attr">"customerStatus"</span>: <span class="hljs-string">"obese"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-Error" class="definition panel" data-traverse-target="definition-Error">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/Error"></a>Error: object
|
||
<!-- <span class="json-property-type"><span class="json-property-type">object</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="code">
|
||
<span class="json-property-name">code:</span>
|
||
<span class="json-property-type">integer</span>
|
||
<span class="json-property-format">(int32)</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="type">
|
||
<span class="json-property-name">type:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="message">
|
||
<span class="json-property-name">message:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"code"</span>: <span class="hljs-string">"integer (int32)"</span>,
|
||
<span class="hljs-attr">"type"</span>: <span class="hljs-string">"No cheese found"</span>,
|
||
<span class="hljs-attr">"message"</span>: <span class="hljs-string">"No cheese for you!"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-ValidationError" class="definition panel" data-traverse-target="definition-ValidationError">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/ValidationError"></a>ValidationError: object
|
||
<!-- <span class="json-property-type"><span class="json-property-type">object</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="code">
|
||
<span class="json-property-name">code:</span>
|
||
<span class="json-property-type">integer</span>
|
||
<span class="json-property-format">(int32)</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="type">
|
||
<span class="json-property-name">type:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="message">
|
||
<span class="json-property-name">message:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"code"</span>: <span class="hljs-number">422</span>,
|
||
<span class="hljs-attr">"type"</span>: <span class="hljs-string">"Validation error"</span>,
|
||
<span class="hljs-attr">"message"</span>: <span class="hljs-string">"Your cheese is not mouldy enough"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-NotFoundError" class="definition panel" data-traverse-target="definition-NotFoundError">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/NotFoundError"></a>NotFoundError: object
|
||
<!-- <span class="json-property-type"><span class="json-property-type">object</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="code">
|
||
<span class="json-property-name">code:</span>
|
||
<span class="json-property-type">integer</span>
|
||
<span class="json-property-format">(int32)</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="type">
|
||
<span class="json-property-name">type:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="message">
|
||
<span class="json-property-name">message:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"code"</span>: <span class="hljs-number">404</span>,
|
||
<span class="hljs-attr">"type"</span>: <span class="hljs-string">"Not found"</span>,
|
||
<span class="hljs-attr">"message"</span>: <span class="hljs-string">"Your cheese has already been eaten"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-Cheese" class="definition panel" data-traverse-target="definition-Cheese">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/Cheese"></a>Cheese: object
|
||
<!-- <span class="json-property-type"><span class="json-property-type">object</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="id">
|
||
<span class="json-property-name">id:</span>
|
||
<span class="json-property-type">integer</span>
|
||
<span class="json-property-format">(int64)</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="category">
|
||
<span class="json-property-name">category:</span>
|
||
<span class="json-property-type">
|
||
<span class="">
|
||
<a class="json-schema-ref" href="#/definitions/Category">Category</a>
|
||
</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="name">
|
||
<span class="json-property-name">name:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="photoUrls">
|
||
<span class="json-property-name">photoUrls:</span>
|
||
<span class="json-property-type">string[]</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
<span class="json-property-required"></span>
|
||
</dt>
|
||
<dt data-property-name="tags">
|
||
<span class="json-property-name">tags:</span>
|
||
<span class="json-property-type">
|
||
<span class="json-schema-ref-array">
|
||
<a class="json-schema-ref" href=" #definition-tag.yml--Tag">tag.yml#/Tag</a>
|
||
</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="status" class="has-description">
|
||
<span class="json-property-name">status:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-enum" title="Possible values">
|
||
<span class="json-property-enum-item">available</span>,
|
||
<span class="json-property-enum-item">pending</span>,
|
||
<span class="json-property-enum-item">sold</span>
|
||
</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dd>
|
||
<p>Cheese status in the store</p>
|
||
</dd>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-number">1</span>,
|
||
<span class="hljs-attr">"category"</span>: {
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-number">1</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"Italian Cheese"</span>
|
||
},
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"Gorgonzola"</span>,
|
||
<span class="hljs-attr">"photoUrls"</span>: [
|
||
<span class="hljs-string">"https://wannabechef.com/gorgonzola.jpg"</span>
|
||
],
|
||
<span class="hljs-attr">"tags"</span>: [
|
||
{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"integer (int64)"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
],
|
||
<span class="hljs-attr">"status"</span>: <span class="hljs-string">"available"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="definition-tag.yml--Tag" class="definition panel" data-traverse-target="definition-tag.yml--Tag">
|
||
<h2 class="panel-title">
|
||
<a name="/definitions/tag.yml#/Tag"></a>tag.yml#/Tag: object
|
||
<!-- <span class="json-property-type"><span class="json-property-type">object</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
|
||
|
||
</span> -->
|
||
</h2>
|
||
<div class="doc-row">
|
||
<div class="doc-copy">
|
||
<section class="json-schema-properties">
|
||
<dl>
|
||
<dt data-property-name="id">
|
||
<span class="json-property-name">id:</span>
|
||
<span class="json-property-type">integer</span>
|
||
<span class="json-property-format">(int64)</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
<dt data-property-name="name">
|
||
<span class="json-property-name">name:</span>
|
||
<span class="json-property-type">string</span>
|
||
<span class="json-property-range" title="Value limits"></span>
|
||
</dt>
|
||
</dl>
|
||
</section>
|
||
</div>
|
||
<div class="doc-examples">
|
||
<section>
|
||
<h5>Example</h5>
|
||
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
|
||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"integer (int64)"</span>,
|
||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>
|
||
}
|
||
</code></pre>
|
||
<!-- </div> -->
|
||
</section>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="doc-row no-margin">
|
||
<div class="doc-copy doc-separator">
|
||
<a class="powered-by" href="https://sourcey.com/spectacle">Documentation by
|
||
<span>Spectacle</span>
|
||
</a>
|
||
</div>
|
||
</div>
|
||
</article>
|
||
</div>
|
||
</div>
|
||
</body>
|
||
</html> |