2022-04-02 13:30:16 +00:00
<!DOCTYPE html>
2023-11-28 21:01:15 +00:00
< html lang = "art-pir" dir = "rtl" >
2022-04-02 13:30:16 +00:00
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "height=device-height, width=device-width, initial-scale=1.0, minimum-scale=1.0" >
2024-03-29 23:34:21 +00:00
< meta name = "generator" content = "Hugo 0.124.1" >
2024-04-07 21:49:57 +00:00
< meta name = "generator" content = "Relearn 5.27.0+tip" >
2023-05-14 21:06:26 +00:00
< meta name = "description" content = "Adds UI fer yer OpenAPI / Swaggerrr Specificat'ns" >
2023-10-10 21:22:41 +00:00
< meta name = "author" content = "Sören Weber" >
2023-10-11 16:03:03 +00:00
< meta name = "twitter:card" content = "summary_large_image" >
2024-02-24 13:03:50 +00:00
< meta name = "twitter:image" content = "https://mcshelby.github.io/hugo-theme-relearn/images/hero.png" >
2023-10-11 16:03:03 +00:00
< meta name = "twitter:title" content = "OpenAPI :: Cap'n Hugo Relearrrn Theme" >
< meta name = "twitter:description" content = "Adds UI fer yer OpenAPI / Swaggerrr Specificat'ns" >
2024-04-07 13:13:19 +00:00
< 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" >
2023-10-11 15:32:39 +00:00
< meta property = "og:title" content = "OpenAPI :: Cap'n Hugo Relearrrn Theme" >
< meta property = "og:description" content = "Adds UI fer yer OpenAPI / Swaggerrr Specificat'ns" >
2024-04-07 13:13:19 +00:00
< meta property = "og:locale" content = "art-pir" >
2023-10-11 15:32:39 +00:00
< meta property = "og:type" content = "website" >
2024-02-24 13:03:50 +00:00
< meta property = "og:image" content = "https://mcshelby.github.io/hugo-theme-relearn/images/hero.png" >
2023-05-14 21:06:26 +00:00
< title > OpenAPI :: Cap' n Hugo Relearrrn Theme< / title >
2024-02-24 13:03:50 +00:00
< 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-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" >
2024-02-24 12:50:21 +00:00
< link href = "/hugo-theme-relearn/pir/shortcodes/openapi/index.xml" rel = "alternate" type = "application/rss+xml" title = "OpenAPI :: Cap'n Hugo Relearrrn Theme" >
2024-04-07 22:15:14 +00:00
< link href = "/hugo-theme-relearn/images/logo.svg?1712528109" rel = "icon" type = "image/svg+xml" >
2022-07-15 13:20:02 +00:00
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how - to - use -->
2024-04-07 22:15:14 +00:00
< link href = "/hugo-theme-relearn/css/fontawesome-all.min.css?1712528111" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "/hugo-theme-relearn/css/fontawesome-all.min.css?1712528111" rel = "stylesheet" > < / noscript >
< link href = "/hugo-theme-relearn/css/nucleus.css?1712528111" rel = "stylesheet" >
< link href = "/hugo-theme-relearn/css/auto-complete.css?1712528111" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "/hugo-theme-relearn/css/auto-complete.css?1712528111" rel = "stylesheet" > < / noscript >
< link href = "/hugo-theme-relearn/css/perfect-scrollbar.min.css?1712528111" rel = "stylesheet" >
< link href = "/hugo-theme-relearn/css/fonts.css?1712528111" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "/hugo-theme-relearn/css/fonts.css?1712528111" rel = "stylesheet" > < / noscript >
< link href = "/hugo-theme-relearn/css/theme.css?1712528111" rel = "stylesheet" >
< link href = "/hugo-theme-relearn/css/theme-relearn-auto.css?1712528111" rel = "stylesheet" id = "R-variant-style" >
< link href = "/hugo-theme-relearn/css/chroma-relearn-auto.css?1712528111" rel = "stylesheet" id = "R-variant-chroma-style" >
< link href = "/hugo-theme-relearn/css/variant.css?1712528111" rel = "stylesheet" >
< link href = "/hugo-theme-relearn/css/print.css?1712528111" rel = "stylesheet" media = "print" >
< link href = "/hugo-theme-relearn/css/format-print.css?1712528111" rel = "stylesheet" >
< link href = "/hugo-theme-relearn/css/ie.css?1712528111" rel = "stylesheet" >
< script src = "/hugo-theme-relearn/js/url.js?1712528111" > < / script >
< script src = "/hugo-theme-relearn/js/variant.js?1712528111" > < / script >
2024-03-16 13:44:28 +00:00
< script >
2023-11-16 22:53:34 +00:00
window.relearn = window.relearn || {};
2024-03-18 20:59:19 +00:00
window.relearn.relBasePath='..\/..\/..';
window.relearn.relBaseUri='..\/..\/..\/..';
window.relearn.absBaseUri='https:\/\/mcshelby.github.io\/hugo-theme-relearn';
2024-03-16 12:40:13 +00:00
window.index_js_url="/hugo-theme-relearn/pir/index.search.js";
2023-11-16 22:53:34 +00:00
// variant stuff
2023-12-03 14:23:32 +00:00
window.relearn.themeVariantModifier='';
2023-11-23 00:05:57 +00:00
window.variants & & variants.init( [ 'relearn-auto', 'relearn-light', 'relearn-dark', 'relearn-bright', 'zen-auto', 'zen-light', 'zen-dark', 'neon', 'learn', 'blue', 'green', 'red' ] );
2023-11-16 22:53:34 +00:00
// 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}"`;
2022-04-02 13:30:16 +00:00
< / script >
2022-12-02 15:05:54 +00:00
< style >
2023-09-23 08:19:35 +00:00
#R-body img.bg-white {
2022-12-02 15:05:54 +00:00
background-color: white;
}
< / style >
2022-04-02 13:30:16 +00:00
< / head >
2024-02-24 12:50:21 +00:00
< body class = "mobile-support print disableInlineCopyToClipboard" data-url = "/hugo-theme-relearn/pir/shortcodes/openapi/index.html" >
2023-09-23 08:19:35 +00:00
< div id = "R-body" class = "default-animation" >
< div id = "R-body-overlay" > < / div >
< nav id = "R-topbar" >
2023-09-18 18:49:44 +00:00
< div class = "topbar-wrapper" >
2023-09-13 21:30:04 +00:00
< div class = "topbar-sidebar-divider" > < / div >
2023-09-18 18:49:44 +00:00
< div class = "topbar-area topbar-area-start" data-area = "start" >
2023-12-05 07:41:41 +00:00
< 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 >
2023-09-12 21:10:21 +00:00
< / div >
2023-09-13 21:30:04 +00:00
< / div >
2023-09-20 22:28:27 +00:00
< ol class = "topbar-breadcrumbs breadcrumbs highlightable" itemscope itemtype = "http://schema.org/BreadcrumbList" > < li
2024-02-24 12:50:21 +00:00
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
2023-09-23 22:28:49 +00:00
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement">< span itemprop = "name" > OpenAPI< / span > < meta itemprop = "position" content = "2" > < / li >
2023-09-13 21:30:04 +00:00
< / ol >
2023-09-18 18:49:44 +00:00
< div class = "topbar-area topbar-area-end" data-area = "end" >
2024-04-07 19:58:38 +00:00
< 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 >
2023-09-12 21:19:47 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
< / nav >
2023-09-23 08:19:35 +00:00
< div id = "R-main-overlay" > < / div >
< main id = "R-body-inner" class = "highlightable default" tabindex = "-1" >
2022-04-02 13:30:16 +00:00
< div class = "flex-block-wrapper" >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2023-05-19 18:46:07 +00:00
< header class = "headline" >
< / header >
2024-04-07 19:58:38 +00:00
2023-05-14 21:06:26 +00:00
< h1 id = "openapi" > OpenAPI< / h1 >
2022-04-02 13:30:16 +00:00
2022-07-05 22:16:52 +00:00
2024-04-07 11:45:38 +00:00
< p > Th' < code > openapi< / code > shortcode uses th' < a href = "https://github.com/swagger-api/swagger-ui" rel = "external" target = "_blank" > Swagger UI< / a > library t' display yer OpenAPI / Swagger specificat'ns.< / p >
2023-06-03 22:20:43 +00:00
2022-05-29 21:00:53 +00:00
< div class = "box notices cstyle note" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > Avast< / div >
< div class = "box-content" >
2023-06-04 22:25:27 +00:00
2022-04-02 13:30:16 +00:00
< p > This only works 'n modern browsers.< / p >
2023-06-03 09:12:46 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
2022-06-05 17:32:37 +00:00
< h2 id = "usage" > Usage< / h2 >
2023-01-24 22:59:44 +00:00
< p > While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer own partials.< / p >
2022-06-22 22:08:50 +00:00
2023-07-27 15:06:14 +00:00
< div class = "tab-panel" data-tab-group = "shortcode-parameter" >
2022-06-22 22:08:50 +00:00
< div class = "tab-nav" >
2023-06-06 17:55:15 +00:00
< div class = "tab-nav-title" > ​ < / div >
2022-06-22 22:08:50 +00:00
< button
data-tab-item="shortcode"
2023-11-18 23:55:52 +00:00
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
2023-07-27 15:06:14 +00:00
onclick="switchTab('shortcode-parameter','shortcode')"
2023-01-29 16:05:10 +00:00
>
2023-10-01 19:07:53 +00:00
< span class = "tab-nav-text" > shortcode< / span >
2023-06-04 22:28:49 +00:00
< / button >
2022-06-22 22:08:50 +00:00
< button
data-tab-item="partial"
2023-06-06 16:16:06 +00:00
class="tab-nav-button tab-panel-style cstyle initial"
2023-07-27 15:06:14 +00:00
onclick="switchTab('shortcode-parameter','partial')"
2023-01-29 16:05:10 +00:00
>
2023-10-01 19:07:53 +00:00
< span class = "tab-nav-text" > partial< / span >
2023-06-04 22:28:49 +00:00
< / button >
2022-06-22 22:08:50 +00:00
< / div >
2023-06-05 16:33:00 +00:00
< div class = "tab-content-container" >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="shortcode"
2023-06-06 16:16:06 +00:00
class="tab-content tab-panel-style cstyle initial active">
2023-06-05 16:33:00 +00:00
< div class = "tab-content-text" >
2023-06-04 22:25:27 +00:00
2024-03-11 20:44:09 +00:00
< 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 >
2023-06-05 16:33:00 +00:00
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="partial"
2023-06-06 16:16:06 +00:00
class="tab-content tab-panel-style cstyle initial">
2023-06-05 16:33:00 +00:00
< div class = "tab-content-text" >
2023-06-04 22:25:27 +00:00
2024-03-11 20:44:09 +00:00
< 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 >
2023-07-27 15:06:14 +00:00
< / 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 >
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > )}}< / span > < / span > < / span > < / code > < / pre > < / div > < / div >
2023-06-05 16:33:00 +00:00
< / div >
2022-06-22 22:08:50 +00:00
< / div >
< / div >
< h3 id = "parameter" > Parameter< / h3 >
2022-06-05 17:32:37 +00:00
< table >
< thead >
< tr >
2023-07-27 15:06:14 +00:00
< th > Name< / th >
< th > Default< / th >
< th > Notes< / th >
2022-06-05 17:32:37 +00:00
< / tr >
< / thead >
< tbody >
< tr >
2023-07-27 15:06:14 +00:00
< td > < strong > src< / strong > < / td >
< td > < em > < empty> < / em > < / td >
< td > Th' URL t' th' OpenAPI specificat'n file. This can be relative t' th' URL o' yer plank if it be a leaf or branch bundle.< / td >
2022-06-05 17:32:37 +00:00
< / tr >
< / tbody >
< / table >
2023-06-03 22:20:43 +00:00
2022-10-06 20:51:16 +00:00
< div class = "box notices cstyle note" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > Avast< / div >
< div class = "box-content" >
2023-06-04 22:25:27 +00:00
2023-05-14 21:06:26 +00:00
< 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 >
2024-02-24 14:10:30 +00:00
< p > Instead, open th' < a href = "/hugo-theme-relearn/pir/basics/customization/index.html#activate-print-support" > 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 >
2023-06-03 09:12:46 +00:00
< / div >
2022-10-06 20:51:16 +00:00
< / div >
2023-05-14 21:06:26 +00:00
< h2 id = "example" > Example< / h2 >
2022-06-05 17:32:37 +00:00
< h3 id = "using-local-file" > Us'n Local File< / h3 >
2024-03-11 20:44:09 +00:00
< 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 >
2023-05-14 21:06:26 +00:00
< div class = "sc-openapi-wrapper is-load'n helper-loading-container" >
< div
class="sc-openapi-container"
2024-04-07 22:15:14 +00:00
id="R-openapi-bf234bfb74b48c9eb443f823f61b952e"
2024-03-16 23:28:06 +00:00
data-openapi-url="petstore.json"
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"
},
2024-03-16 23:48:16 +00:00
" version" : " 1.0.18"
2024-03-16 23:28:06 +00:00
},
" 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" ,
2024-03-16 23:48:16 +00:00
" description" : " name that needs t' be updated" ,
2024-03-16 23:28:06 +00:00
" 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" : {
2024-03-16 23:48:16 +00:00
" 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"
}
2024-03-16 23:28:06 +00:00
},
" petId" : {
2024-03-16 23:48:16 +00:00
" 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"
}
2024-03-16 23:28:06 +00:00
},
" quantity" : {
2024-03-16 23:48:16 +00:00
" 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"
}
2024-03-16 23:28:06 +00:00
},
" shipDate" : {
2024-03-16 23:48:16 +00:00
" 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"
}
2024-03-16 23:28:06 +00:00
},
" status" : {
2024-03-16 23:48:16 +00:00
" 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"
}
2024-03-16 23:28:06 +00:00
},
" complete" : {
2024-03-16 23:48:16 +00:00
" 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"
}
2024-03-16 23:28:06 +00:00
}
},
" xml" : {
" name" : " order"
}
},
" Customer" : {
" type" : " object" ,
" properties" : {
" id" : {
2024-03-16 23:48:16 +00:00
" 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"
}
2024-03-16 23:28:06 +00:00
},
" username" : {
2024-03-16 23:48:16 +00:00
" 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"
}
2024-03-16 23:28:06 +00:00
},
" address" : {
2024-03-16 23:48:16 +00:00
" 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"
}
}
2024-03-16 23:28:06 +00:00
},
2024-03-16 23:48:16 +00:00
" xml" : {
" name" : " customer"
2024-03-16 23:28:06 +00:00
}
}
},
" xml" : {
" name" : " customer"
}
},
" Address" : {
" type" : " object" ,
" properties" : {
" street" : {
2024-03-16 23:48:16 +00:00
" 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"
}
2024-03-16 23:28:06 +00:00
},
" city" : {
2024-03-16 23:48:16 +00:00
" 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"
}
2024-03-16 23:28:06 +00:00
},
" state" : {
2024-03-16 23:48:16 +00:00
" 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"
}
2024-03-16 23:28:06 +00:00
},
" zip" : {
2024-03-16 23:48:16 +00:00
" 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"
}
2024-03-16 23:28:06 +00:00
}
},
" xml" : {
" name" : " address"
}
},
" Category" : {
" type" : " object" ,
" properties" : {
" id" : {
2024-03-16 23:48:16 +00:00
" type" : " object" ,
" properties" : {
" id" : {
" type" : " integer" ,
" format" : " int64" ,
" example" : 1
},
" name" : {
" type" : " string" ,
" example" : " Dogs"
}
},
" xml" : {
" name" : " category"
}
2024-03-16 23:28:06 +00:00
},
" name" : {
2024-03-16 23:48:16 +00:00
" type" : " object" ,
" properties" : {
" id" : {
" type" : " integer" ,
" format" : " int64" ,
" example" : 1
},
" name" : {
" type" : " string" ,
" example" : " Dogs"
}
},
" xml" : {
" name" : " category"
}
2024-03-16 23:28:06 +00:00
}
},
" xml" : {
" name" : " category"
}
},
" User" : {
" type" : " object" ,
" properties" : {
" id" : {
2024-03-16 23:48:16 +00:00
" 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"
}
2024-03-16 23:28:06 +00:00
},
" username" : {
2024-03-16 23:48:16 +00:00
" 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"
}
2024-03-16 23:28:06 +00:00
},
" firstName" : {
2024-03-16 23:48:16 +00:00
" 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"
}
2024-03-16 23:28:06 +00:00
},
" lastName" : {
2024-03-16 23:48:16 +00:00
" 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"
}
2024-03-16 23:28:06 +00:00
},
" email" : {
2024-03-16 23:48:16 +00:00
" 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"
}
2024-03-16 23:28:06 +00:00
},
" password" : {
2024-03-16 23:48:16 +00:00
" 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"
}
2024-03-16 23:28:06 +00:00
},
" phone" : {
2024-03-16 23:48:16 +00:00
" 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"
}
2024-03-16 23:28:06 +00:00
},
" userStatus" : {
2024-03-16 23:48:16 +00:00
" 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"
}
2024-03-16 23:28:06 +00:00
}
},
" xml" : {
" name" : " user"
}
},
" Tag" : {
" type" : " object" ,
" properties" : {
" id" : {
2024-03-16 23:48:16 +00:00
" type" : " object" ,
" properties" : {
" id" : {
" type" : " integer" ,
" format" : " int64"
},
" name" : {
" type" : " string"
}
},
" xml" : {
" name" : " tag"
}
2024-03-16 23:28:06 +00:00
},
" name" : {
2024-03-16 23:48:16 +00:00
" type" : " object" ,
" properties" : {
" id" : {
" type" : " integer" ,
" format" : " int64"
},
" name" : {
" type" : " string"
}
},
" xml" : {
" name" : " tag"
}
2024-03-16 23:28:06 +00:00
}
},
" xml" : {
" name" : " tag"
}
},
" Pet" : {
" required" : [
" name" ,
" photoUrls"
],
" type" : " object" ,
" properties" : {
" id" : {
2024-03-16 23:48:16 +00:00
" 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"
}
2024-03-16 23:28:06 +00:00
},
" name" : {
2024-03-16 23:48:16 +00:00
" 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"
}
2024-03-16 23:28:06 +00:00
},
" category" : {
2024-03-16 23:48:16 +00:00
" 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"
}
2024-03-16 23:28:06 +00:00
},
" photoUrls" : {
2024-03-16 23:48:16 +00:00
" 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"
]
2024-03-16 23:28:06 +00:00
}
2024-03-16 23:48:16 +00:00
},
" xml" : {
" name" : " pet"
2024-03-16 23:28:06 +00:00
}
},
" tags" : {
2024-03-16 23:48:16 +00:00
" 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"
]
}
2024-03-16 23:28:06 +00:00
},
2024-03-16 23:48:16 +00:00
" xml" : {
" name" : " pet"
2024-03-16 23:28:06 +00:00
}
},
" status" : {
2024-03-16 23:48:16 +00:00
" 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"
}
2024-03-16 23:28:06 +00:00
}
},
" xml" : {
" name" : " pet"
}
},
" ApiResponse" : {
" type" : " object" ,
" properties" : {
" code" : {
2024-03-16 23:48:16 +00:00
" type" : " object" ,
" properties" : {
" code" : {
" type" : " integer" ,
" format" : " int32"
},
" type" : {
" type" : " string"
},
" message" : {
" type" : " string"
}
},
" xml" : {
" name" : " ##default"
}
2024-03-16 23:28:06 +00:00
},
" type" : {
2024-03-16 23:48:16 +00:00
" type" : " object" ,
" properties" : {
" code" : {
" type" : " integer" ,
" format" : " int32"
},
" type" : {
" type" : " string"
},
" message" : {
" type" : " string"
}
},
" xml" : {
" name" : " ##default"
}
2024-03-16 23:28:06 +00:00
},
" message" : {
2024-03-16 23:48:16 +00:00
" type" : " object" ,
" properties" : {
" code" : {
" type" : " integer" ,
" format" : " int32"
},
" type" : {
" type" : " string"
},
" message" : {
" type" : " string"
}
},
" xml" : {
" name" : " ##default"
}
2024-03-16 23:28:06 +00:00
}
},
" 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"
}
}
}
}"
2023-05-14 21:06:26 +00:00
>< / div >
< / div >
2022-04-02 13:30:16 +00:00
< footer class = "footline" >
< / footer >
< / article >
2023-05-17 22:13:41 +00:00
2022-04-02 13:30:16 +00:00
< / div >
< / main >
< / div >
2024-04-07 22:15:14 +00:00
< script src = "/hugo-theme-relearn/js/clipboard.min.js?1712528111" defer > < / script >
< script src = "/hugo-theme-relearn/js/perfect-scrollbar.min.js?1712528111" defer > < / script >
< script src = "/hugo-theme-relearn/js/js-yaml.min.js?1712528111" defer > < / script >
2023-07-27 15:06:14 +00:00
< script > window . noZensmooth = true ; < / script >
2024-04-07 22:15:14 +00:00
< script src = "/hugo-theme-relearn/js/swagger-ui/swagger-ui-bundle.js?1712528111" defer > < / script >
< script src = "/hugo-theme-relearn/js/swagger-ui/swagger-ui-standalone-preset.js?1712528111" defer > < / script >
2023-07-27 15:06:14 +00:00
< script >
2024-04-07 22:15:14 +00:00
window.themeUseOpenapi = { css: "/js/swagger-ui/swagger-ui.css?1712528111", cssInProject: true, assetsBuster: 1712528111 };
2023-07-27 15:06:14 +00:00
< / script >
2024-04-07 22:15:14 +00:00
< script src = "/hugo-theme-relearn/js/theme.js?1712528111" defer > < / script >
2022-04-02 13:30:16 +00:00
< / body >
< / html >
