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-11 20:44:09 +00:00
< meta name = "generator" content = "Hugo 0.123.8" >
2024-02-29 19:52:06 +00:00
< meta name = "generator" content = "Relearn 5.25.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" >
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" >
< meta property = "og:type" content = "website" >
2024-02-24 13:03:50 +00:00
< meta property = "og:url" content = "https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/openapi/index.html" >
< meta property = "og:image" content = "https://mcshelby.github.io/hugo-theme-relearn/images/hero.png" >
2023-10-11 15:32:39 +00:00
< meta property = "og:site_name" content = "Cap'n Hugo Relearrrn Theme" >
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-03-16 09:01:12 +00:00
< link href = "/hugo-theme-relearn/images/logo.svg?1710579667" 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-03-16 09:01:12 +00:00
< link href = "/hugo-theme-relearn/css/fontawesome-all.min.css?1710579669" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "/hugo-theme-relearn/css/fontawesome-all.min.css?1710579669" rel = "stylesheet" > < / noscript >
< link href = "/hugo-theme-relearn/css/nucleus.css?1710579669" rel = "stylesheet" >
< link href = "/hugo-theme-relearn/css/auto-complete.css?1710579669" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "/hugo-theme-relearn/css/auto-complete.css?1710579669" rel = "stylesheet" > < / noscript >
< link href = "/hugo-theme-relearn/css/perfect-scrollbar.min.css?1710579669" rel = "stylesheet" >
< link href = "/hugo-theme-relearn/css/fonts.css?1710579669" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "/hugo-theme-relearn/css/fonts.css?1710579669" rel = "stylesheet" > < / noscript >
< link href = "/hugo-theme-relearn/css/theme.css?1710579669" rel = "stylesheet" >
< link href = "/hugo-theme-relearn/css/theme-relearn-auto.css?1710579669" rel = "stylesheet" id = "R-variant-style" >
< link href = "/hugo-theme-relearn/css/chroma-relearn-auto.css?1710579669" rel = "stylesheet" id = "R-variant-chroma-style" >
< link href = "/hugo-theme-relearn/css/variant.css?1710579669" rel = "stylesheet" >
< link href = "/hugo-theme-relearn/css/print.css?1710579669" rel = "stylesheet" media = "print" >
< link href = "/hugo-theme-relearn/css/format-print.css?1710579669" rel = "stylesheet" >
< link href = "/hugo-theme-relearn/css/ie.css?1710579669" rel = "stylesheet" >
< script src = "/hugo-theme-relearn/js/url.js?1710579669" > < / script >
< script src = "/hugo-theme-relearn/js/variant.js?1710579669" > < / script >
2022-04-02 13:30:16 +00:00
< script >
// hack to let hugo tell us how to get to the root when using relativeURLs, it needs to be called *url= for it to do its magic:
// https://github.com/gohugoio/hugo/blob/145b3fcce35fbac25c7033c91c1b7ae6d1179da8/transform/urlreplacers/absurlreplacer.go#L72
2024-02-24 12:50:21 +00:00
window.index_js_url="/hugo-theme-relearn/pir/index.search.js";
var root_url="/";
2022-04-02 13:30:16 +00:00
var baseUri=root_url.replace(/\/$/, '');
2023-11-16 22:53:34 +00:00
window.relearn = window.relearn || {};
2024-02-24 13:03:50 +00:00
window.relearn.baseUriFull='https:\/\/mcshelby.github.io\/hugo-theme-relearn/';
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" >
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 >
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
2023-10-28 20:28:18 +00:00
< p > Th' < code > openapi< / code > shortcode uses th' < a href = "https://github.com/swagger-api/swagger-ui" 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-03-16 09:01:12 +00:00
id="R-openapi-0d99501373e5f363131bd9f85db67253"
2024-02-24 12:50:21 +00:00
data-openapi-url="/hugo-theme-relearn/shortcodes/openapi/petstore.json"
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-03-16 09:01:12 +00:00
< script src = "/hugo-theme-relearn/js/clipboard.min.js?1710579669" defer > < / script >
< script src = "/hugo-theme-relearn/js/perfect-scrollbar.min.js?1710579669" defer > < / script >
2023-07-27 15:06:14 +00:00
< script > window . noZensmooth = true ; < / script >
2024-03-16 09:01:12 +00:00
< script src = "/hugo-theme-relearn/js/swagger-ui/swagger-ui-bundle.js?1710579669" defer > < / script >
< script src = "/hugo-theme-relearn/js/swagger-ui/swagger-ui-standalone-preset.js?1710579669" defer > < / script >
2023-07-27 15:06:14 +00:00
< script >
2024-03-16 09:01:12 +00:00
window.themeUseOpenapi = { css: "/hugo-theme-relearn/js/swagger-ui/swagger-ui.css?1710579669", assetsBuster: 1710579669 };
2023-07-27 15:06:14 +00:00
< / script >
2024-03-16 09:01:12 +00:00
< script src = "/hugo-theme-relearn/js/theme.js?1710579669" defer > < / script >
2022-04-02 13:30:16 +00:00
< / body >
< / html >
