mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-11-24 00:03:10 +00:00
2668 lines
88 KiB
HTML
2668 lines
88 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="art-x-pir" dir="rtl" itemscope itemtype="http://schema.org/Article">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="height=device-height, width=device-width, initial-scale=1.0, minimum-scale=1.0">
|
|
<meta name="generator" content="Hugo 0.135.0">
|
|
<meta name="generator" content="Relearn 7.0.0+72a36ea6e73e5941fb92069356655d9913bfb4b4">
|
|
<meta name="description" content="UI fer yer OpenAPI / Swaggerrr Specificat'ns">
|
|
<meta name="author" content="Sören Weber">
|
|
<meta name="twitter:card" content="summary_large_image">
|
|
<meta name="twitter:image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
|
|
<meta name="twitter:title" content="OpenAPI :: Cap'n Hugo Relearrrn Theme">
|
|
<meta name="twitter:description" content="UI fer yer OpenAPI / Swaggerrr Specificat'ns">
|
|
<meta property="og:url" content="https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/openapi/index.html">
|
|
<meta property="og:site_name" content="Cap'n Hugo Relearrrn Theme">
|
|
<meta property="og:title" content="OpenAPI :: Cap'n Hugo Relearrrn Theme">
|
|
<meta property="og:description" content="UI fer yer OpenAPI / Swaggerrr Specificat'ns">
|
|
<meta property="og:locale" content="art_x_pir">
|
|
<meta property="og:type" content="website">
|
|
<meta property="og:image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
|
|
<meta itemprop="name" content="OpenAPI :: Cap'n Hugo Relearrrn Theme">
|
|
<meta itemprop="description" content="UI fer yer OpenAPI / Swaggerrr Specificat'ns">
|
|
<meta itemprop="wordCount" content="458">
|
|
<meta itemprop="image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
|
|
<meta itemprop="keywords" content="Howto,Reference,CustomOpenapiURL,Openapi.errorlevel,Openapi.force,CustomOpenapiURL,Openapi.errorlevel,Openapi.force">
|
|
<title>OpenAPI :: Cap'n Hugo Relearrrn Theme</title>
|
|
<link href="https://mcshelby.github.io/hugo-theme-relearn/shortcodes/openapi/index.html" rel="alternate" hreflang="x-default">
|
|
<link href="https://mcshelby.github.io/hugo-theme-relearn/shortcodes/openapi/index.html" rel="alternate" hreflang="en">
|
|
<link href="https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/openapi/index.html" rel="alternate" hreflang="art-x-pir">
|
|
<link href="https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/openapi/index.html" rel="canonical" type="text/html" title="OpenAPI :: Cap'n Hugo Relearrrn Theme">
|
|
<link href="/hugo-theme-relearn/pir/shortcodes/openapi/index.xml" rel="alternate" type="application/rss+xml" title="OpenAPI :: Cap'n Hugo Relearrrn Theme">
|
|
<link href="/hugo-theme-relearn/images/logo.svg?1728832967" rel="icon" type="image/svg+xml">
|
|
<link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1728832967" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1728832967" rel="stylesheet"></noscript>
|
|
<link href="/hugo-theme-relearn/css/nucleus.css?1728832967" rel="stylesheet">
|
|
<link href="/hugo-theme-relearn/css/auto-complete.css?1728832967" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/auto-complete.css?1728832967" rel="stylesheet"></noscript>
|
|
<link href="/hugo-theme-relearn/css/perfect-scrollbar.min.css?1728832967" rel="stylesheet">
|
|
<link href="/hugo-theme-relearn/css/fonts.css?1728832967" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fonts.css?1728832967" rel="stylesheet"></noscript>
|
|
<link href="/hugo-theme-relearn/css/theme.css?1728832967" rel="stylesheet">
|
|
<link href="/hugo-theme-relearn/css/theme-relearn-auto.css?1728832967" rel="stylesheet" id="R-variant-style">
|
|
<link href="/hugo-theme-relearn/css/chroma-relearn-auto.css?1728832967" rel="stylesheet" id="R-variant-chroma-style">
|
|
<link href="/hugo-theme-relearn/css/print.css?1728832967" rel="stylesheet" media="print">
|
|
<link href="/hugo-theme-relearn/css/format-print.css?1728832967" rel="stylesheet">
|
|
<script src="/hugo-theme-relearn/js/variant.js?1728832967"></script>
|
|
<script>
|
|
window.relearn = window.relearn || {};
|
|
window.relearn.relBasePath='..\/..\/..';
|
|
window.relearn.relBaseUri='..\/..\/..\/..';
|
|
window.relearn.absBaseUri='https:\/\/mcshelby.github.io\/hugo-theme-relearn';
|
|
window.relearn.disableAnchorCopy=false;
|
|
window.relearn.disableAnchorScrolling=false;
|
|
// variant stuff
|
|
window.variants && variants.init( [ 'relearn-auto', 'relearn-light', 'relearn-dark', 'relearn-bright', 'zen-auto', 'zen-light', 'zen-dark', 'retro-auto', 'neon', 'learn', 'blue', 'green', 'red' ] );
|
|
// translations
|
|
window.T_Copy_to_clipboard = `Copy t' clipboard`;
|
|
window.T_Copied_to_clipboard = `Copied t' clipboard!`;
|
|
window.T_Copy_link_to_clipboard = `Copy link t' clipboard`;
|
|
window.T_Link_copied_to_clipboard = `Copied link t' clipboard!`;
|
|
window.T_Reset_view = `Rrreset view`;
|
|
window.T_View_reset = `View rrreset!`;
|
|
window.T_No_results_found = `No rrresults found fer "{0}"`;
|
|
window.T_N_results_found = `{1} rrresults found fer "{0}"`;
|
|
</script>
|
|
<style>
|
|
#R-body img.bg-white {
|
|
background-color: white;
|
|
}
|
|
</style>
|
|
</head>
|
|
<body class="mobile-support print disableInlineCopyToClipboard" data-url="/hugo-theme-relearn/pir/shortcodes/openapi/index.html">
|
|
<div id="R-body" class="default-animation">
|
|
<div id="R-body-overlay"></div>
|
|
<nav id="R-topbar">
|
|
<div class="topbar-wrapper">
|
|
<div class="topbar-sidebar-divider"></div>
|
|
<div class="topbar-area topbar-area-start" data-area="start">
|
|
<div class="topbar-button topbar-button-sidebar" data-content-empty="disable" data-width-s="show" data-width-m="hide" data-width-l="hide"><button class="topbar-control" onclick="toggleNav()" type="button" title="Menu (CTRL+ALT+n)"><i class="fa-fw fas fa-bars"></i></button>
|
|
</div>
|
|
<div class="topbar-button topbar-button-toc" data-content-empty="hide" data-width-s="show" data-width-m="show" data-width-l="show"><button class="topbar-control" onclick="toggleTopbarFlyout(this)" type="button" title="Table o' Contents (CTRL+ALT+t)"><i class="fa-fw fas fa-list-alt"></i></button>
|
|
<div class="topbar-content">
|
|
<div class="topbar-content-wrapper">
|
|
<nav class="TableOfContents">
|
|
<ul>
|
|
<li><a href="#usage">Usage</a>
|
|
<ul>
|
|
<li><a href="#parameter">Parameter</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#settings">Sett'ns</a>
|
|
<ul>
|
|
<li><a href="#enabling-link-warnings">Enabl'n Link Warn'ns</a></li>
|
|
<li><a href="#loading-an-external-version-of-the-swagger-ui-library">Load'n an External Version o' th' Swagger UI Library</a></li>
|
|
<li><a href="#force-loading-of-the-swagger-ui-library">Force Load'n o' th' Swagger UI Library</a></li>
|
|
<li><a href="#setting-a-specific-swagger-ui-theme">Sett'n a Specific Swagger UI Theme</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#example">Example</a>
|
|
<ul>
|
|
<li><a href="#using-local-file">Us'n Local File</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<ol class="topbar-breadcrumbs breadcrumbs highlightable" itemscope itemtype="http://schema.org/BreadcrumbList"><li
|
|
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><a itemprop="item" href="/hugo-theme-relearn/pir/shortcodes/index.html"><span itemprop="name">Shorrrtcodes</span></a><meta itemprop="position" content="1"> > </li><li
|
|
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><span itemprop="name">OpenAPI</span><meta itemprop="position" content="2"></li>
|
|
</ol>
|
|
<div class="topbar-area topbar-area-end" data-area="end">
|
|
<div class="topbar-button topbar-button-edit" data-content-empty="disable" data-width-s="area-more" data-width-m="show" data-width-l="show"><a class="topbar-control" href="https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/shortcodes/openapi/_index.pir.md" target="_self" title="Edit (CTRL+ALT+w)"><i class="fa-fw fas fa-pen"></i></a>
|
|
</div>
|
|
<div class="topbar-button topbar-button-print" data-content-empty="disable" data-width-s="area-more" data-width-m="show" data-width-l="show"><a class="topbar-control" href="/hugo-theme-relearn/pir/shortcodes/openapi/index.print.html" title="Prrrint whole chapterrr (CTRL+ALT+p)"><i class="fa-fw fas fa-print"></i></a>
|
|
</div>
|
|
<div class="topbar-button topbar-button-prev" data-content-empty="disable" data-width-s="show" data-width-m="show" data-width-l="show"><a class="topbar-control" href="/hugo-theme-relearn/pir/shortcodes/notice/index.html" title="Notice (🡒)"><i class="fa-fw fas fa-chevron-left"></i></a>
|
|
</div>
|
|
<div class="topbar-button topbar-button-next" data-content-empty="disable" data-width-s="show" data-width-m="show" data-width-l="show"><a class="topbar-control" href="/hugo-theme-relearn/pir/shortcodes/resources/index.html" title="Resources (🡐)"><i class="fa-fw fas fa-chevron-right"></i></a>
|
|
</div>
|
|
<div class="topbar-button topbar-button-more" data-content-empty="hide" data-width-s="show" data-width-m="show" data-width-l="show"><button class="topbar-control" onclick="toggleTopbarFlyout(this)" type="button" title="Morrre"><i class="fa-fw fas fa-ellipsis-v"></i></button>
|
|
<div class="topbar-content">
|
|
<div class="topbar-content-wrapper">
|
|
<div class="topbar-area topbar-area-more" data-area="more">
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
<div id="R-main-overlay"></div>
|
|
<main id="R-body-inner" class="highlightable shortcodes" tabindex="-1">
|
|
<div class="flex-block-wrapper">
|
|
<article class="default">
|
|
<header class="headline">
|
|
</header>
|
|
|
|
<h1 id="openapi">OpenAPI</h1>
|
|
|
|
<p>Th' <code>openapi</code> shortcode displays yer OpenAPI / Swagger specificat'ns us'n th' <a href="https://github.com/swagger-api/swagger-ui" rel="external" target="_self">Swagger UI</a> library.</p>
|
|
<h2 id="usage">Usage</h2>
|
|
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
|
<div class="tab-nav">
|
|
<div class="tab-nav-title">​</div>
|
|
<button
|
|
data-tab-item="shortcode"
|
|
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
|
onclick="switchTab('shortcode-parameter','shortcode')"
|
|
>
|
|
<span class="tab-nav-text">shortcode</span>
|
|
</button>
|
|
<button
|
|
data-tab-item="partial"
|
|
class="tab-nav-button tab-panel-style cstyle initial"
|
|
onclick="switchTab('shortcode-parameter','partial')"
|
|
>
|
|
<span class="tab-nav-text">partial</span>
|
|
</button>
|
|
</div>
|
|
<div class="tab-content-container">
|
|
<div
|
|
data-tab-item="shortcode"
|
|
class="tab-content tab-panel-style cstyle initial active">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">openapi</span> <span class="nx">src</span><span class="p">=</span><span class="s">"https://petstore3.openapi.io/api/v3/openapi.json"</span> <span class="p">>}}</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
<div
|
|
data-tab-item="partial"
|
|
class="tab-content tab-panel-style cstyle initial">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/openapi.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="s">"src"</span> <span class="s">"https://petstore3.openapi.io/api/v3/openapi.json"</span>
|
|
</span></span><span class="line"><span class="cl"><span class="p">)}}</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<p>If ye want t' print out (or generate a PDF) from yer OpenAPI documentat'n, don’t initiate print'n directly from th' plank because th' elements be optimized fer interactive usage 'n a browser.</p>
|
|
<p>Instead, open th' <a href="/hugo-theme-relearn/pir/authoring/frontmatter/topbar/index.html">print preview</a> 'n yer browser an' initiate print'n from that plank. This plank be optimized fer read'n an' expands most o' th' avail'ble sections.</p>
|
|
<h3 id="parameter">Parameter</h3>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th style="text-align: left">Name</th>
|
|
<th style="text-align: left">Default</th>
|
|
<th style="text-align: left">Notes</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="text-align: left"><strong>src</strong></td>
|
|
<td style="text-align: left"><em><empty></em></td>
|
|
<td style="text-align: left">Th' path t' th' t' th' OpenAPI specificat'n resource or URL t' be used. Resource paths adhere t' <a href="https://gohugo.io/methods/page/path/" rel="external" target="_self">Hugo’s logical path</a>.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="settings">Sett'ns</h2>
|
|
<h3 id="enabling-link-warnings">Enabl'n Link Warn'ns</h3>
|
|
<p><span class="badge cstyle cyan badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-gears"></i></span><span class="badge-content">Opt'n</span></span> <span class="badge cstyle green badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-markdown"></i></span><span class="badge-content">Front Matter</span></span> Ye can use <code>openapi.errorlevel</code> t' control what should happen if a local OpenAPI specificat'n link can not be resolved t' a resource.</p>
|
|
<p>If not set or empty, any unresolved link be written as given into th' result'n output. If set t' <code>warning</code> th' same happens an' an additional warning be printed 'n th' built console. If set t' <code>error</code> an error message be printed an' th' build be aborted.</p>
|
|
<p>Please note that this can not resolve files inside o' yer <code>static</code> directory. Th' file must be a resource o' th' plank or th' ship.</p>
|
|
<p>Link warnings be also avail'ble fer <a href="/hugo-theme-relearn/pir/authoring/frontmatter/linking/index.html#enabling-link-and-image-link-warnings">images & links</a> an' th' <a href="/hugo-theme-relearn/pir/shortcodes/include/index.html#enabling-link-warnings">include</a> shortcode.</p>
|
|
<div class="tab-panel" data-tab-group="config-code">
|
|
<div class="tab-nav">
|
|
<div class="tab-nav-title">​</div>
|
|
<button
|
|
data-tab-item="toml"
|
|
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
|
onclick="switchTab('config-code','toml')"
|
|
>
|
|
<span class="tab-nav-text">toml</span>
|
|
</button>
|
|
<button
|
|
data-tab-item="yaml"
|
|
class="tab-nav-button tab-panel-style cstyle initial"
|
|
onclick="switchTab('config-code','yaml')"
|
|
>
|
|
<span class="tab-nav-text">yaml</span>
|
|
</button>
|
|
<button
|
|
data-tab-item="json"
|
|
class="tab-nav-button tab-panel-style cstyle initial"
|
|
onclick="switchTab('config-code','json')"
|
|
>
|
|
<span class="tab-nav-text">json</span>
|
|
</button>
|
|
</div>
|
|
<div class="tab-content-container">
|
|
<div
|
|
data-tab-item="toml"
|
|
class="tab-content tab-panel-style cstyle initial active">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="p">[</span><span class="nx">openapi</span><span class="p">]</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">errorlevel</span> <span class="p">=</span> <span class="s1">'warning'</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
<div
|
|
data-tab-item="yaml"
|
|
class="tab-content tab-panel-style cstyle initial">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml"><span class="line"><span class="cl"><span class="nt">openapi</span><span class="p">:</span><span class="w">
|
|
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">errorlevel</span><span class="p">:</span><span class="w"> </span><span class="l">warning</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
<div
|
|
data-tab-item="json"
|
|
class="tab-content tab-panel-style cstyle initial">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nt">"openapi"</span><span class="p">:</span> <span class="p">{</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nt">"errorlevel"</span><span class="p">:</span> <span class="s2">"warning"</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
|
|
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h3 id="loading-an-external-version-of-the-swagger-ui-library">Load'n an External Version o' th' Swagger UI Library</h3>
|
|
<p><span class="badge cstyle cyan badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-gears"></i></span><span class="badge-content">Opt'n</span></span> <span class="badge cstyle green badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-markdown"></i></span><span class="badge-content">Front Matter</span></span> Th' theme uses th' shipped Swagger UI library by default.</p>
|
|
<p>In case ye want do use a different version o' th' Swagger UI library but don’t want t' override th' shipped version, ye can set <code>customOpenapiURL</code> t' th' URL o' th' external Swagger UI library.</p>
|
|
<div class="tab-panel" data-tab-group="config-code">
|
|
<div class="tab-nav">
|
|
<div class="tab-nav-title">​</div>
|
|
<button
|
|
data-tab-item="toml"
|
|
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
|
onclick="switchTab('config-code','toml')"
|
|
>
|
|
<span class="tab-nav-text">toml</span>
|
|
</button>
|
|
<button
|
|
data-tab-item="yaml"
|
|
class="tab-nav-button tab-panel-style cstyle initial"
|
|
onclick="switchTab('config-code','yaml')"
|
|
>
|
|
<span class="tab-nav-text">yaml</span>
|
|
</button>
|
|
<button
|
|
data-tab-item="json"
|
|
class="tab-nav-button tab-panel-style cstyle initial"
|
|
onclick="switchTab('config-code','json')"
|
|
>
|
|
<span class="tab-nav-text">json</span>
|
|
</button>
|
|
</div>
|
|
<div class="tab-content-container">
|
|
<div
|
|
data-tab-item="toml"
|
|
class="tab-content tab-panel-style cstyle initial active">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="nx">customOpenapiURL</span> <span class="p">=</span> <span class="s1">'https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js'</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
<div
|
|
data-tab-item="yaml"
|
|
class="tab-content tab-panel-style cstyle initial">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml"><span class="line"><span class="cl"><span class="nt">customOpenapiURL</span><span class="p">:</span><span class="w"> </span><span class="l">https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
<div
|
|
data-tab-item="json"
|
|
class="tab-content tab-panel-style cstyle initial">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nt">"customOpenapiURL"</span><span class="p">:</span> <span class="s2">"https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js"</span>
|
|
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h3 id="force-loading-of-the-swagger-ui-library">Force Load'n o' th' Swagger UI Library</h3>
|
|
<p><span class="badge cstyle cyan badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-gears"></i></span><span class="badge-content">Opt'n</span></span> <span class="badge cstyle green badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-markdown"></i></span><span class="badge-content">Front Matter</span></span> Th' Swagger UI library will be boarded if th' plank contains an <code>openapi</code> shortcode or codefence.</p>
|
|
<p>Ye can force load'n th' Swagger UI library if no shortcode or codefence was used by sett'n <code>openapi.force=true</code>. If a shortcode or codefence was found, th' opt'n has no effect. This comes handy 'n case ye be us'n script'n t' render a spec.</p>
|
|
<div class="tab-panel" data-tab-group="config-code">
|
|
<div class="tab-nav">
|
|
<div class="tab-nav-title">​</div>
|
|
<button
|
|
data-tab-item="toml"
|
|
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
|
onclick="switchTab('config-code','toml')"
|
|
>
|
|
<span class="tab-nav-text">toml</span>
|
|
</button>
|
|
<button
|
|
data-tab-item="yaml"
|
|
class="tab-nav-button tab-panel-style cstyle initial"
|
|
onclick="switchTab('config-code','yaml')"
|
|
>
|
|
<span class="tab-nav-text">yaml</span>
|
|
</button>
|
|
<button
|
|
data-tab-item="json"
|
|
class="tab-nav-button tab-panel-style cstyle initial"
|
|
onclick="switchTab('config-code','json')"
|
|
>
|
|
<span class="tab-nav-text">json</span>
|
|
</button>
|
|
</div>
|
|
<div class="tab-content-container">
|
|
<div
|
|
data-tab-item="toml"
|
|
class="tab-content tab-panel-style cstyle initial active">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="p">[</span><span class="nx">openapi</span><span class="p">]</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">force</span> <span class="p">=</span> <span class="kc">true</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
<div
|
|
data-tab-item="yaml"
|
|
class="tab-content tab-panel-style cstyle initial">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml"><span class="line"><span class="cl"><span class="nt">openapi</span><span class="p">:</span><span class="w">
|
|
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">force</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
<div
|
|
data-tab-item="json"
|
|
class="tab-content tab-panel-style cstyle initial">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nt">"openapi"</span><span class="p">:</span> <span class="p">{</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nt">"force"</span><span class="p">:</span> <span class="kc">true</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
|
|
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h3 id="setting-a-specific-swagger-ui-theme">Sett'n a Specific Swagger UI Theme</h3>
|
|
<p>Th' recommended way t' configure yer Swagger UI theme be t' set th' default value us'n th' <code>--OPENAPI-theme</code> vari'ble 'n yer <a href="/hugo-theme-relearn/pir/configuration/branding/generator/index.html">color variant stylesheet</a>. This allows yer specs t' look pretty when th' user switches th' color variant.</p>
|
|
<h2 id="example">Example</h2>
|
|
<h3 id="using-local-file">Us'n Local File</h3>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">openapi</span> <span class="nx">src</span><span class="p">=</span><span class="s">"petstore.json"</span> <span class="p">>}}</span></span></span></code></pre></div>
|
|
<div class="sc-openapi-wrapper is-load'n helper-loading-container">
|
|
<div
|
|
class="sc-openapi-container"
|
|
id="R-openapi-496924e674f695dbbdf2f823422b923d"
|
|
data-openapi-url=""
|
|
data-openapi-spec="{
|
|
"openapi": "3.0.2",
|
|
"info": {
|
|
"title": "Swagger Petstore - OpenAPI 3.0",
|
|
"description": "This be a sample Pet Store Server based on th' OpenAPI 3.0 specificat'n. Ye can find out more about\nSwagger at [http://swagger.io](http://swagger.io). In th' third iterat'n o' th' pet store, we've switched t' th' design first approach!\nYou can now help us improve th' API whether it's by mak'n changes t' th' definit'n itself or t' th' code.\nThat way, wit' time, we can improve th' API 'n general, an' expose some o' th' new features 'n OAS3.\n\nSome useful links:\n- [The Pet Store repository](https://github.com/swagger-api/swagger-petstore)\n- [The source API definit'n fer th' Pet Store](https://github.com/swagger-api/swagger-petstore/blob/master/src/main/resources/openapi.yaml)",
|
|
"termsOfService": "http://swagger.io/terms/",
|
|
"contact": {
|
|
"email": "apiteam@swagger.io"
|
|
},
|
|
"license": {
|
|
"name": "Apache 2.0",
|
|
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
|
|
},
|
|
"version": "1.0.18"
|
|
},
|
|
"externalDocs": {
|
|
"description": "Find out more about Swagger",
|
|
"url": "http://swagger.io"
|
|
},
|
|
"servers": [
|
|
{
|
|
"url": "/api/v3"
|
|
}
|
|
],
|
|
"tags": [
|
|
{
|
|
"name": "pet",
|
|
"description": "Everyth'n about yer Pets",
|
|
"externalDocs": {
|
|
"description": "Find out more",
|
|
"url": "http://swagger.io"
|
|
}
|
|
},
|
|
{
|
|
"name": "store",
|
|
"description": "Access t' Petstore orders",
|
|
"externalDocs": {
|
|
"description": "Find out more about our store",
|
|
"url": "http://swagger.io"
|
|
}
|
|
},
|
|
{
|
|
"name": "user",
|
|
"description": "Operat'ns about user"
|
|
}
|
|
],
|
|
"paths": {
|
|
"/pet": {
|
|
"put": {
|
|
"tags": [
|
|
"pet"
|
|
],
|
|
"summary": "Update an exist'n pet",
|
|
"description": "Update an exist'n pet by Id",
|
|
"operationId": "updatePet",
|
|
"requestBody": {
|
|
"description": "Update an existent pet 'n th' store",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Pet"
|
|
}
|
|
},
|
|
"application/xml": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Pet"
|
|
}
|
|
},
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Pet"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful operation",
|
|
"content": {
|
|
"application/xml": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Pet"
|
|
}
|
|
},
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Pet"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid ID supplied"
|
|
},
|
|
"404": {
|
|
"description": "Pet not found"
|
|
},
|
|
"405": {
|
|
"description": "Validat'n exception"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"petstore_auth": [
|
|
"write:pets",
|
|
"read:pets"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"pet"
|
|
],
|
|
"summary": "Add a new pet t' th' store",
|
|
"description": "Add a new pet t' th' store",
|
|
"operationId": "addPet",
|
|
"requestBody": {
|
|
"description": "Create a new pet 'n th' store",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Pet"
|
|
}
|
|
},
|
|
"application/xml": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Pet"
|
|
}
|
|
},
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Pet"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful operation",
|
|
"content": {
|
|
"application/xml": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Pet"
|
|
}
|
|
},
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Pet"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"405": {
|
|
"description": "Invalid input"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"petstore_auth": [
|
|
"write:pets",
|
|
"read:pets"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/pet/findByStatus": {
|
|
"get": {
|
|
"tags": [
|
|
"pet"
|
|
],
|
|
"summary": "Finds Pets by status",
|
|
"description": "Multiple status values can be provided wit' comma separated strings",
|
|
"operationId": "findPetsByStatus",
|
|
"parameters": [
|
|
{
|
|
"name": "status",
|
|
"in": "query",
|
|
"description": "Status values that need t' be considered fer filter",
|
|
"required": false,
|
|
"explode": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"default": "available",
|
|
"enum": [
|
|
"available",
|
|
"pending",
|
|
"sold"
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"content": {
|
|
"application/xml": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Pet"
|
|
}
|
|
}
|
|
},
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Pet"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"petstore_auth": [
|
|
"write:pets",
|
|
"read:pets"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/pet/findByTags": {
|
|
"get": {
|
|
"tags": [
|
|
"pet"
|
|
],
|
|
"summary": "Finds Pets by tags",
|
|
"description": "Multiple tags can be provided wit' comma separated str'ns. Use tag1, tag2, tag3 fer test'n.",
|
|
"operationId": "findPetsByTags",
|
|
"parameters": [
|
|
{
|
|
"name": "tags",
|
|
"in": "query",
|
|
"description": "Tags t' filter by",
|
|
"required": false,
|
|
"explode": true,
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"content": {
|
|
"application/xml": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Pet"
|
|
}
|
|
}
|
|
},
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Pet"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid tag value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"petstore_auth": [
|
|
"write:pets",
|
|
"read:pets"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/pet/{petId}": {
|
|
"get": {
|
|
"tags": [
|
|
"pet"
|
|
],
|
|
"summary": "Find pet by ID",
|
|
"description": "Returns a single pet",
|
|
"operationId": "getPetById",
|
|
"parameters": [
|
|
{
|
|
"name": "petId",
|
|
"in": "path",
|
|
"description": "ID o' pet t' return",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"content": {
|
|
"application/xml": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Pet"
|
|
}
|
|
},
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Pet"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid ID supplied"
|
|
},
|
|
"404": {
|
|
"description": "Pet not found"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"api_key": []
|
|
},
|
|
{
|
|
"petstore_auth": [
|
|
"write:pets",
|
|
"read:pets"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"pet"
|
|
],
|
|
"summary": "Updates a pet 'n th' store wit' form data",
|
|
"description": "",
|
|
"operationId": "updatePetWithForm",
|
|
"parameters": [
|
|
{
|
|
"name": "petId",
|
|
"in": "path",
|
|
"description": "ID o' pet that needs t' be updated",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
},
|
|
{
|
|
"name": "name",
|
|
"in": "query",
|
|
"description": "Name o' pet that needs t' be updated",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "status",
|
|
"in": "query",
|
|
"description": "Status o' pet that needs t' be updated",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"405": {
|
|
"description": "Invalid input"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"petstore_auth": [
|
|
"write:pets",
|
|
"read:pets"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"pet"
|
|
],
|
|
"summary": "Deletes a pet",
|
|
"description": "",
|
|
"operationId": "deletePet",
|
|
"parameters": [
|
|
{
|
|
"name": "api_key",
|
|
"in": "header",
|
|
"description": "",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "petId",
|
|
"in": "path",
|
|
"description": "Pet id t' delete",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"400": {
|
|
"description": "Invalid pet value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"petstore_auth": [
|
|
"write:pets",
|
|
"read:pets"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/pet/{petId}/uploadImage": {
|
|
"post": {
|
|
"tags": [
|
|
"pet"
|
|
],
|
|
"summary": "uploads an image",
|
|
"description": "",
|
|
"operationId": "uploadFile",
|
|
"parameters": [
|
|
{
|
|
"name": "petId",
|
|
"in": "path",
|
|
"description": "ID o' pet t' update",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
},
|
|
{
|
|
"name": "additionalMetadata",
|
|
"in": "query",
|
|
"description": "Additional Metadata",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/octet-stream": {
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "binary"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"petstore_auth": [
|
|
"write:pets",
|
|
"read:pets"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/store/inventory": {
|
|
"get": {
|
|
"tags": [
|
|
"store"
|
|
],
|
|
"summary": "Returns pet inventories by status",
|
|
"description": "Returns a map o' status codes t' quantities",
|
|
"operationId": "getInventory",
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"api_key": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/store/order": {
|
|
"post": {
|
|
"tags": [
|
|
"store"
|
|
],
|
|
"summary": "Place an order fer a pet",
|
|
"description": "Place a new order 'n th' store",
|
|
"operationId": "placeOrder",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Order"
|
|
}
|
|
},
|
|
"application/xml": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Order"
|
|
}
|
|
},
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Order"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Order"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"405": {
|
|
"description": "Invalid input"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/store/order/{orderId}": {
|
|
"get": {
|
|
"tags": [
|
|
"store"
|
|
],
|
|
"summary": "Find purchase order by ID",
|
|
"description": "For valid response try integer IDs wit' value <= 5 or > 10. Other values will generate except'ns.",
|
|
"operationId": "getOrderById",
|
|
"parameters": [
|
|
{
|
|
"name": "orderId",
|
|
"in": "path",
|
|
"description": "ID o' order that needs t' be fetched",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"content": {
|
|
"application/xml": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Order"
|
|
}
|
|
},
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Order"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid ID supplied"
|
|
},
|
|
"404": {
|
|
"description": "Order not found"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"store"
|
|
],
|
|
"summary": "Delete purchase order by ID",
|
|
"description": "For valid response try integer IDs wit' value < 1000. Anyth'n above 1000 or nonintegers will generate API errors",
|
|
"operationId": "deleteOrder",
|
|
"parameters": [
|
|
{
|
|
"name": "orderId",
|
|
"in": "path",
|
|
"description": "ID o' th' order that needs t' be deleted",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"400": {
|
|
"description": "Invalid ID supplied"
|
|
},
|
|
"404": {
|
|
"description": "Order not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/user": {
|
|
"post": {
|
|
"tags": [
|
|
"user"
|
|
],
|
|
"summary": "Create user",
|
|
"description": "This can only be done by th' logged 'n user.",
|
|
"operationId": "createUser",
|
|
"requestBody": {
|
|
"description": "Created user object",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/User"
|
|
}
|
|
},
|
|
"application/xml": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/User"
|
|
}
|
|
},
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/User"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"default": {
|
|
"description": "successful operation",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/User"
|
|
}
|
|
},
|
|
"application/xml": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/User"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/user/createWithList": {
|
|
"post": {
|
|
"tags": [
|
|
"user"
|
|
],
|
|
"summary": "Creates list o' users wit' given input array",
|
|
"description": "Creates list o' users wit' given input array",
|
|
"operationId": "createUsersWithListInput",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/User"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful operation",
|
|
"content": {
|
|
"application/xml": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/User"
|
|
}
|
|
},
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/User"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "successful operation"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/user/login": {
|
|
"get": {
|
|
"tags": [
|
|
"user"
|
|
],
|
|
"summary": "Logs user into th' system",
|
|
"description": "",
|
|
"operationId": "loginUser",
|
|
"parameters": [
|
|
{
|
|
"name": "username",
|
|
"in": "query",
|
|
"description": "The user name fer login",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "password",
|
|
"in": "query",
|
|
"description": "The password fer login 'n clear text",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"headers": {
|
|
"X-Rate-Limit": {
|
|
"description": "calls per hour allowed by th' user",
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
"X-Expires-After": {
|
|
"description": "date 'n UTC when token expires",
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
}
|
|
}
|
|
},
|
|
"content": {
|
|
"application/xml": {
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid username/password supplied"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/user/logout": {
|
|
"get": {
|
|
"tags": [
|
|
"user"
|
|
],
|
|
"summary": "Logs out current logged 'n user session",
|
|
"description": "",
|
|
"operationId": "logoutUser",
|
|
"parameters": [],
|
|
"responses": {
|
|
"default": {
|
|
"description": "successful operation"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/user/{username}": {
|
|
"get": {
|
|
"tags": [
|
|
"user"
|
|
],
|
|
"summary": "Get user by user name",
|
|
"description": "",
|
|
"operationId": "getUserByName",
|
|
"parameters": [
|
|
{
|
|
"name": "username",
|
|
"in": "path",
|
|
"description": "The name that needs t' be fetched. Use user1 fer test'n. ",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"content": {
|
|
"application/xml": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/User"
|
|
}
|
|
},
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/User"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid username supplied"
|
|
},
|
|
"404": {
|
|
"description": "User not found"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"user"
|
|
],
|
|
"summary": "Update user",
|
|
"description": "This can only be done by th' logged 'n user.",
|
|
"operationId": "updateUser",
|
|
"parameters": [
|
|
{
|
|
"name": "username",
|
|
"in": "path",
|
|
"description": "name that needs t' be updated",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"description": "Update an existent user 'n th' store",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/User"
|
|
}
|
|
},
|
|
"application/xml": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/User"
|
|
}
|
|
},
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/User"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"default": {
|
|
"description": "successful operation"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"user"
|
|
],
|
|
"summary": "Delete user",
|
|
"description": "This can only be done by th' logged 'n user.",
|
|
"operationId": "deleteUser",
|
|
"parameters": [
|
|
{
|
|
"name": "username",
|
|
"in": "path",
|
|
"description": "The name that needs t' be deleted",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"400": {
|
|
"description": "Invalid username supplied"
|
|
},
|
|
"404": {
|
|
"description": "User not found"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"components": {
|
|
"schemas": {
|
|
"Order": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 10
|
|
},
|
|
"petId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 198772
|
|
},
|
|
"quantity": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 7
|
|
},
|
|
"shipDate": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"description": "Order Status",
|
|
"example": "approved",
|
|
"enum": [
|
|
"placed",
|
|
"approved",
|
|
"delivered"
|
|
]
|
|
},
|
|
"complete": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"xml": {
|
|
"name": "order"
|
|
}
|
|
},
|
|
"petId": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 10
|
|
},
|
|
"petId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 198772
|
|
},
|
|
"quantity": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 7
|
|
},
|
|
"shipDate": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"description": "Order Status",
|
|
"example": "approved",
|
|
"enum": [
|
|
"placed",
|
|
"approved",
|
|
"delivered"
|
|
]
|
|
},
|
|
"complete": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"xml": {
|
|
"name": "order"
|
|
}
|
|
},
|
|
"quantity": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 10
|
|
},
|
|
"petId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 198772
|
|
},
|
|
"quantity": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 7
|
|
},
|
|
"shipDate": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"description": "Order Status",
|
|
"example": "approved",
|
|
"enum": [
|
|
"placed",
|
|
"approved",
|
|
"delivered"
|
|
]
|
|
},
|
|
"complete": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"xml": {
|
|
"name": "order"
|
|
}
|
|
},
|
|
"shipDate": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 10
|
|
},
|
|
"petId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 198772
|
|
},
|
|
"quantity": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 7
|
|
},
|
|
"shipDate": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"description": "Order Status",
|
|
"example": "approved",
|
|
"enum": [
|
|
"placed",
|
|
"approved",
|
|
"delivered"
|
|
]
|
|
},
|
|
"complete": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"xml": {
|
|
"name": "order"
|
|
}
|
|
},
|
|
"status": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 10
|
|
},
|
|
"petId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 198772
|
|
},
|
|
"quantity": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 7
|
|
},
|
|
"shipDate": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"description": "Order Status",
|
|
"example": "approved",
|
|
"enum": [
|
|
"placed",
|
|
"approved",
|
|
"delivered"
|
|
]
|
|
},
|
|
"complete": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"xml": {
|
|
"name": "order"
|
|
}
|
|
},
|
|
"complete": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 10
|
|
},
|
|
"petId": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 198772
|
|
},
|
|
"quantity": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"example": 7
|
|
},
|
|
"shipDate": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"description": "Order Status",
|
|
"example": "approved",
|
|
"enum": [
|
|
"placed",
|
|
"approved",
|
|
"delivered"
|
|
]
|
|
},
|
|
"complete": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"xml": {
|
|
"name": "order"
|
|
}
|
|
}
|
|
},
|
|
"xml": {
|
|
"name": "order"
|
|
}
|
|
},
|
|
"Customer": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 100000
|
|
},
|
|
"username": {
|
|
"type": "string",
|
|
"example": "fehguy"
|
|
},
|
|
"address": {
|
|
"type": "array",
|
|
"xml": {
|
|
"name": "addresses",
|
|
"wrapped": true
|
|
},
|
|
"items": {
|
|
"$ref": "#/components/schemas/Address"
|
|
}
|
|
}
|
|
},
|
|
"xml": {
|
|
"name": "customer"
|
|
}
|
|
},
|
|
"username": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 100000
|
|
},
|
|
"username": {
|
|
"type": "string",
|
|
"example": "fehguy"
|
|
},
|
|
"address": {
|
|
"type": "array",
|
|
"xml": {
|
|
"name": "addresses",
|
|
"wrapped": true
|
|
},
|
|
"items": {
|
|
"$ref": "#/components/schemas/Address"
|
|
}
|
|
}
|
|
},
|
|
"xml": {
|
|
"name": "customer"
|
|
}
|
|
},
|
|
"address": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 100000
|
|
},
|
|
"username": {
|
|
"type": "string",
|
|
"example": "fehguy"
|
|
},
|
|
"address": {
|
|
"type": "array",
|
|
"xml": {
|
|
"name": "addresses",
|
|
"wrapped": true
|
|
},
|
|
"items": {
|
|
"$ref": "#/components/schemas/Address"
|
|
}
|
|
}
|
|
},
|
|
"xml": {
|
|
"name": "customer"
|
|
}
|
|
}
|
|
},
|
|
"xml": {
|
|
"name": "customer"
|
|
}
|
|
},
|
|
"Address": {
|
|
"type": "object",
|
|
"properties": {
|
|
"street": {
|
|
"type": "object",
|
|
"properties": {
|
|
"street": {
|
|
"type": "string",
|
|
"example": "437 Lytton"
|
|
},
|
|
"city": {
|
|
"type": "string",
|
|
"example": "Palo Alto"
|
|
},
|
|
"state": {
|
|
"type": "string",
|
|
"example": "CA"
|
|
},
|
|
"zip": {
|
|
"type": "string",
|
|
"example": "94301"
|
|
}
|
|
},
|
|
"xml": {
|
|
"name": "address"
|
|
}
|
|
},
|
|
"city": {
|
|
"type": "object",
|
|
"properties": {
|
|
"street": {
|
|
"type": "string",
|
|
"example": "437 Lytton"
|
|
},
|
|
"city": {
|
|
"type": "string",
|
|
"example": "Palo Alto"
|
|
},
|
|
"state": {
|
|
"type": "string",
|
|
"example": "CA"
|
|
},
|
|
"zip": {
|
|
"type": "string",
|
|
"example": "94301"
|
|
}
|
|
},
|
|
"xml": {
|
|
"name": "address"
|
|
}
|
|
},
|
|
"state": {
|
|
"type": "object",
|
|
"properties": {
|
|
"street": {
|
|
"type": "string",
|
|
"example": "437 Lytton"
|
|
},
|
|
"city": {
|
|
"type": "string",
|
|
"example": "Palo Alto"
|
|
},
|
|
"state": {
|
|
"type": "string",
|
|
"example": "CA"
|
|
},
|
|
"zip": {
|
|
"type": "string",
|
|
"example": "94301"
|
|
}
|
|
},
|
|
"xml": {
|
|
"name": "address"
|
|
}
|
|
},
|
|
"zip": {
|
|
"type": "object",
|
|
"properties": {
|
|
"street": {
|
|
"type": "string",
|
|
"example": "437 Lytton"
|
|
},
|
|
"city": {
|
|
"type": "string",
|
|
"example": "Palo Alto"
|
|
},
|
|
"state": {
|
|
"type": "string",
|
|
"example": "CA"
|
|
},
|
|
"zip": {
|
|
"type": "string",
|
|
"example": "94301"
|
|
}
|
|
},
|
|
"xml": {
|
|
"name": "address"
|
|
}
|
|
}
|
|
},
|
|
"xml": {
|
|
"name": "address"
|
|
}
|
|
},
|
|
"Category": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Dogs"
|
|
}
|
|
},
|
|
"xml": {
|
|
"name": "category"
|
|
}
|
|
},
|
|
"name": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 1
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Dogs"
|
|
}
|
|
},
|
|
"xml": {
|
|
"name": "category"
|
|
}
|
|
}
|
|
},
|
|
"xml": {
|
|
"name": "category"
|
|
}
|
|
},
|
|
"User": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 10
|
|
},
|
|
"username": {
|
|
"type": "string",
|
|
"example": "theUser"
|
|
},
|
|
"firstName": {
|
|
"type": "string",
|
|
"example": "John"
|
|
},
|
|
"lastName": {
|
|
"type": "string",
|
|
"example": "James"
|
|
},
|
|
"email": {
|
|
"type": "string",
|
|
"example": "john@email.com"
|
|
},
|
|
"password": {
|
|
"type": "string",
|
|
"example": "12345"
|
|
},
|
|
"phone": {
|
|
"type": "string",
|
|
"example": "12345"
|
|
},
|
|
"userStatus": {
|
|
"type": "integer",
|
|
"description": "User Status",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
},
|
|
"xml": {
|
|
"name": "user"
|
|
}
|
|
},
|
|
"username": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 10
|
|
},
|
|
"username": {
|
|
"type": "string",
|
|
"example": "theUser"
|
|
},
|
|
"firstName": {
|
|
"type": "string",
|
|
"example": "John"
|
|
},
|
|
"lastName": {
|
|
"type": "string",
|
|
"example": "James"
|
|
},
|
|
"email": {
|
|
"type": "string",
|
|
"example": "john@email.com"
|
|
},
|
|
"password": {
|
|
"type": "string",
|
|
"example": "12345"
|
|
},
|
|
"phone": {
|
|
"type": "string",
|
|
"example": "12345"
|
|
},
|
|
"userStatus": {
|
|
"type": "integer",
|
|
"description": "User Status",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
},
|
|
"xml": {
|
|
"name": "user"
|
|
}
|
|
},
|
|
"firstName": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 10
|
|
},
|
|
"username": {
|
|
"type": "string",
|
|
"example": "theUser"
|
|
},
|
|
"firstName": {
|
|
"type": "string",
|
|
"example": "John"
|
|
},
|
|
"lastName": {
|
|
"type": "string",
|
|
"example": "James"
|
|
},
|
|
"email": {
|
|
"type": "string",
|
|
"example": "john@email.com"
|
|
},
|
|
"password": {
|
|
"type": "string",
|
|
"example": "12345"
|
|
},
|
|
"phone": {
|
|
"type": "string",
|
|
"example": "12345"
|
|
},
|
|
"userStatus": {
|
|
"type": "integer",
|
|
"description": "User Status",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
},
|
|
"xml": {
|
|
"name": "user"
|
|
}
|
|
},
|
|
"lastName": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 10
|
|
},
|
|
"username": {
|
|
"type": "string",
|
|
"example": "theUser"
|
|
},
|
|
"firstName": {
|
|
"type": "string",
|
|
"example": "John"
|
|
},
|
|
"lastName": {
|
|
"type": "string",
|
|
"example": "James"
|
|
},
|
|
"email": {
|
|
"type": "string",
|
|
"example": "john@email.com"
|
|
},
|
|
"password": {
|
|
"type": "string",
|
|
"example": "12345"
|
|
},
|
|
"phone": {
|
|
"type": "string",
|
|
"example": "12345"
|
|
},
|
|
"userStatus": {
|
|
"type": "integer",
|
|
"description": "User Status",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
},
|
|
"xml": {
|
|
"name": "user"
|
|
}
|
|
},
|
|
"email": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 10
|
|
},
|
|
"username": {
|
|
"type": "string",
|
|
"example": "theUser"
|
|
},
|
|
"firstName": {
|
|
"type": "string",
|
|
"example": "John"
|
|
},
|
|
"lastName": {
|
|
"type": "string",
|
|
"example": "James"
|
|
},
|
|
"email": {
|
|
"type": "string",
|
|
"example": "john@email.com"
|
|
},
|
|
"password": {
|
|
"type": "string",
|
|
"example": "12345"
|
|
},
|
|
"phone": {
|
|
"type": "string",
|
|
"example": "12345"
|
|
},
|
|
"userStatus": {
|
|
"type": "integer",
|
|
"description": "User Status",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
},
|
|
"xml": {
|
|
"name": "user"
|
|
}
|
|
},
|
|
"password": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 10
|
|
},
|
|
"username": {
|
|
"type": "string",
|
|
"example": "theUser"
|
|
},
|
|
"firstName": {
|
|
"type": "string",
|
|
"example": "John"
|
|
},
|
|
"lastName": {
|
|
"type": "string",
|
|
"example": "James"
|
|
},
|
|
"email": {
|
|
"type": "string",
|
|
"example": "john@email.com"
|
|
},
|
|
"password": {
|
|
"type": "string",
|
|
"example": "12345"
|
|
},
|
|
"phone": {
|
|
"type": "string",
|
|
"example": "12345"
|
|
},
|
|
"userStatus": {
|
|
"type": "integer",
|
|
"description": "User Status",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
},
|
|
"xml": {
|
|
"name": "user"
|
|
}
|
|
},
|
|
"phone": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 10
|
|
},
|
|
"username": {
|
|
"type": "string",
|
|
"example": "theUser"
|
|
},
|
|
"firstName": {
|
|
"type": "string",
|
|
"example": "John"
|
|
},
|
|
"lastName": {
|
|
"type": "string",
|
|
"example": "James"
|
|
},
|
|
"email": {
|
|
"type": "string",
|
|
"example": "john@email.com"
|
|
},
|
|
"password": {
|
|
"type": "string",
|
|
"example": "12345"
|
|
},
|
|
"phone": {
|
|
"type": "string",
|
|
"example": "12345"
|
|
},
|
|
"userStatus": {
|
|
"type": "integer",
|
|
"description": "User Status",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
},
|
|
"xml": {
|
|
"name": "user"
|
|
}
|
|
},
|
|
"userStatus": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 10
|
|
},
|
|
"username": {
|
|
"type": "string",
|
|
"example": "theUser"
|
|
},
|
|
"firstName": {
|
|
"type": "string",
|
|
"example": "John"
|
|
},
|
|
"lastName": {
|
|
"type": "string",
|
|
"example": "James"
|
|
},
|
|
"email": {
|
|
"type": "string",
|
|
"example": "john@email.com"
|
|
},
|
|
"password": {
|
|
"type": "string",
|
|
"example": "12345"
|
|
},
|
|
"phone": {
|
|
"type": "string",
|
|
"example": "12345"
|
|
},
|
|
"userStatus": {
|
|
"type": "integer",
|
|
"description": "User Status",
|
|
"format": "int32",
|
|
"example": 1
|
|
}
|
|
},
|
|
"xml": {
|
|
"name": "user"
|
|
}
|
|
}
|
|
},
|
|
"xml": {
|
|
"name": "user"
|
|
}
|
|
},
|
|
"Tag": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"xml": {
|
|
"name": "tag"
|
|
}
|
|
},
|
|
"name": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"xml": {
|
|
"name": "tag"
|
|
}
|
|
}
|
|
},
|
|
"xml": {
|
|
"name": "tag"
|
|
}
|
|
},
|
|
"Pet": {
|
|
"required": [
|
|
"name",
|
|
"photoUrls"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"required": [
|
|
"name",
|
|
"photoUrls"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 10
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "doggie"
|
|
},
|
|
"category": {
|
|
"$ref": "#/components/schemas/Category"
|
|
},
|
|
"photoUrls": {
|
|
"type": "array",
|
|
"xml": {
|
|
"wrapped": true
|
|
},
|
|
"items": {
|
|
"type": "string",
|
|
"xml": {
|
|
"name": "photoUrl"
|
|
}
|
|
}
|
|
},
|
|
"tags": {
|
|
"type": "array",
|
|
"xml": {
|
|
"wrapped": true
|
|
},
|
|
"items": {
|
|
"$ref": "#/components/schemas/Tag"
|
|
}
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"description": "pet status 'n th' store",
|
|
"enum": [
|
|
"available",
|
|
"pending",
|
|
"sold"
|
|
]
|
|
}
|
|
},
|
|
"xml": {
|
|
"name": "pet"
|
|
}
|
|
},
|
|
"name": {
|
|
"required": [
|
|
"name",
|
|
"photoUrls"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 10
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "doggie"
|
|
},
|
|
"category": {
|
|
"$ref": "#/components/schemas/Category"
|
|
},
|
|
"photoUrls": {
|
|
"type": "array",
|
|
"xml": {
|
|
"wrapped": true
|
|
},
|
|
"items": {
|
|
"type": "string",
|
|
"xml": {
|
|
"name": "photoUrl"
|
|
}
|
|
}
|
|
},
|
|
"tags": {
|
|
"type": "array",
|
|
"xml": {
|
|
"wrapped": true
|
|
},
|
|
"items": {
|
|
"$ref": "#/components/schemas/Tag"
|
|
}
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"description": "pet status 'n th' store",
|
|
"enum": [
|
|
"available",
|
|
"pending",
|
|
"sold"
|
|
]
|
|
}
|
|
},
|
|
"xml": {
|
|
"name": "pet"
|
|
}
|
|
},
|
|
"category": {
|
|
"required": [
|
|
"name",
|
|
"photoUrls"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 10
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "doggie"
|
|
},
|
|
"category": {
|
|
"$ref": "#/components/schemas/Category"
|
|
},
|
|
"photoUrls": {
|
|
"type": "array",
|
|
"xml": {
|
|
"wrapped": true
|
|
},
|
|
"items": {
|
|
"type": "string",
|
|
"xml": {
|
|
"name": "photoUrl"
|
|
}
|
|
}
|
|
},
|
|
"tags": {
|
|
"type": "array",
|
|
"xml": {
|
|
"wrapped": true
|
|
},
|
|
"items": {
|
|
"$ref": "#/components/schemas/Tag"
|
|
}
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"description": "pet status 'n th' store",
|
|
"enum": [
|
|
"available",
|
|
"pending",
|
|
"sold"
|
|
]
|
|
}
|
|
},
|
|
"xml": {
|
|
"name": "pet"
|
|
}
|
|
},
|
|
"photoUrls": {
|
|
"required": [
|
|
"name",
|
|
"photoUrls"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 10
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "doggie"
|
|
},
|
|
"category": {
|
|
"$ref": "#/components/schemas/Category"
|
|
},
|
|
"photoUrls": {
|
|
"type": "array",
|
|
"xml": {
|
|
"wrapped": true
|
|
},
|
|
"items": {
|
|
"type": "string",
|
|
"xml": {
|
|
"name": "photoUrl"
|
|
}
|
|
}
|
|
},
|
|
"tags": {
|
|
"type": "array",
|
|
"xml": {
|
|
"wrapped": true
|
|
},
|
|
"items": {
|
|
"$ref": "#/components/schemas/Tag"
|
|
}
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"description": "pet status 'n th' store",
|
|
"enum": [
|
|
"available",
|
|
"pending",
|
|
"sold"
|
|
]
|
|
}
|
|
},
|
|
"xml": {
|
|
"name": "pet"
|
|
}
|
|
},
|
|
"tags": {
|
|
"required": [
|
|
"name",
|
|
"photoUrls"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 10
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "doggie"
|
|
},
|
|
"category": {
|
|
"$ref": "#/components/schemas/Category"
|
|
},
|
|
"photoUrls": {
|
|
"type": "array",
|
|
"xml": {
|
|
"wrapped": true
|
|
},
|
|
"items": {
|
|
"type": "string",
|
|
"xml": {
|
|
"name": "photoUrl"
|
|
}
|
|
}
|
|
},
|
|
"tags": {
|
|
"type": "array",
|
|
"xml": {
|
|
"wrapped": true
|
|
},
|
|
"items": {
|
|
"$ref": "#/components/schemas/Tag"
|
|
}
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"description": "pet status 'n th' store",
|
|
"enum": [
|
|
"available",
|
|
"pending",
|
|
"sold"
|
|
]
|
|
}
|
|
},
|
|
"xml": {
|
|
"name": "pet"
|
|
}
|
|
},
|
|
"status": {
|
|
"required": [
|
|
"name",
|
|
"photoUrls"
|
|
],
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"example": 10
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "doggie"
|
|
},
|
|
"category": {
|
|
"$ref": "#/components/schemas/Category"
|
|
},
|
|
"photoUrls": {
|
|
"type": "array",
|
|
"xml": {
|
|
"wrapped": true
|
|
},
|
|
"items": {
|
|
"type": "string",
|
|
"xml": {
|
|
"name": "photoUrl"
|
|
}
|
|
}
|
|
},
|
|
"tags": {
|
|
"type": "array",
|
|
"xml": {
|
|
"wrapped": true
|
|
},
|
|
"items": {
|
|
"$ref": "#/components/schemas/Tag"
|
|
}
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"description": "pet status 'n th' store",
|
|
"enum": [
|
|
"available",
|
|
"pending",
|
|
"sold"
|
|
]
|
|
}
|
|
},
|
|
"xml": {
|
|
"name": "pet"
|
|
}
|
|
}
|
|
},
|
|
"xml": {
|
|
"name": "pet"
|
|
}
|
|
},
|
|
"ApiResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"message": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"xml": {
|
|
"name": "##default"
|
|
}
|
|
},
|
|
"type": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"message": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"xml": {
|
|
"name": "##default"
|
|
}
|
|
},
|
|
"message": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"message": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"xml": {
|
|
"name": "##default"
|
|
}
|
|
}
|
|
},
|
|
"xml": {
|
|
"name": "##default"
|
|
}
|
|
}
|
|
},
|
|
"requestBodies": {
|
|
"Pet": {
|
|
"description": "Pet object that needs t' be added t' th' store",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Pet"
|
|
}
|
|
},
|
|
"application/xml": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Pet"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"UserArray": {
|
|
"description": "List o' user object",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/User"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"securitySchemes": {
|
|
"petstore_auth": {
|
|
"type": "oauth2",
|
|
"flows": {
|
|
"implicit": {
|
|
"authorizationUrl": "https://petstore3.swagger.io/oauth/authorize",
|
|
"scopes": {
|
|
"write:pets": "modify pets 'n yer account",
|
|
"read:pets": "read yer pets"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"api_key": {
|
|
"type": "apiKey",
|
|
"name": "api_key",
|
|
"in": "header"
|
|
}
|
|
}
|
|
}
|
|
}"
|
|
></div>
|
|
</div>
|
|
|
|
|
|
<footer class="footline">
|
|
<div class="R-taxonomy taxonomy-categories cstyle" title="Categorrries" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);">
|
|
<i class="fa-fw fas fa-layer-group"></i>
|
|
<ul>
|
|
<li><a class="term-link" href="/hugo-theme-relearn/pir/categories/howto/index.html">Howto</a></li>
|
|
<li><a class="term-link" href="/hugo-theme-relearn/pir/categories/reference/index.html">Reference</a></li>
|
|
</ul>
|
|
</div>
|
|
</footer>
|
|
</article>
|
|
</div>
|
|
</main>
|
|
</div>
|
|
<script src="/hugo-theme-relearn/js/clipboard.min.js?1728832967" defer></script>
|
|
<script src="/hugo-theme-relearn/js/perfect-scrollbar.min.js?1728832967" defer></script>
|
|
<script src="/hugo-theme-relearn/js/js-yaml.min.js?1728832967" defer></script>
|
|
<script>window.noZensmooth = true;</script>
|
|
<script src="/hugo-theme-relearn/js/swagger-ui/swagger-ui-bundle.js?1728832967" defer></script>
|
|
<script src="/hugo-theme-relearn/js/swagger-ui/swagger-ui-standalone-preset.js?1728832967" defer></script>
|
|
<script>
|
|
window.themeUseOpenapi = { css: "/js/swagger-ui/swagger-ui.css?1728832967", cssInProject: true, assetsBuster: "?1728832967" };
|
|
</script>
|
|
<script src="/hugo-theme-relearn/js/theme.js?1728832967" defer></script>
|
|
</body>
|
|
</html>
|