204 lines
16 KiB
HTML
204 lines
16 KiB
HTML
<!doctype html>
|
|
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>kompendium-oas</title>
|
|
<link href="../images/logo-icon.svg" rel="icon" type="image/svg"><script>var pathToRoot = "../";</script> <script>const storage = localStorage.getItem("dokka-dark-mode")
|
|
const savedDarkMode = storage ? JSON.parse(storage) : false
|
|
if(savedDarkMode === true){
|
|
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
|
}</script>
|
|
<script type="text/javascript" src="../scripts/sourceset_dependencies.js" async></script>
|
|
<link href="../styles/style.css" rel="Stylesheet">
|
|
<link href="../styles/jetbrains-mono.css" rel="Stylesheet">
|
|
<link href="../styles/main.css" rel="Stylesheet">
|
|
<link href="../styles/prism.css" rel="Stylesheet">
|
|
<link href="../styles/logo-styles.css" rel="Stylesheet">
|
|
<script type="text/javascript" src="../scripts/clipboard.js" async></script>
|
|
<script type="text/javascript" src="../scripts/navigation-loader.js" async></script>
|
|
<script type="text/javascript" src="../scripts/platform-content-handler.js" async></script>
|
|
<script type="text/javascript" src="../scripts/main.js" defer></script>
|
|
<script type="text/javascript" src="../scripts/prism.js" async></script>
|
|
<link href="../styles/multimodule.css" rel="Stylesheet"></head>
|
|
<body>
|
|
<div class="navigation-wrapper" id="navigation-wrapper">
|
|
<div id="leftToggler"><span class="icon-toggler"></span></div>
|
|
<div class="library-name">
|
|
<a href="../index.html">
|
|
<span>kompendium</span> </a> </div>
|
|
<div>
|
|
<dokka-template-command data="{"@class":"org.jetbrains.dokka.base.templating.ReplaceVersionsCommand","location":"index.html"}"><div class="versions-dropdown">
|
|
<div class="versions-dropdown-button">3.0.0</div>
|
|
<div class="versions-dropdown-data"><a href="index.html">3.0.0</a><a href="../older/2.3.4/kompendium-oas/index.html">2.3.4</a><a href="../older/2.3.3/kompendium-oas/index.html">2.3.3</a><a href="../older/2.3.2/kompendium-oas/index.html">2.3.2</a><a href="../older/2.3.1/kompendium-oas/index.html">2.3.1</a><a href="../older/2.3.0/kompendium-oas/index.html">2.3.0</a><a href="../older/2.2.1/kompendium-oas/index.html">2.2.1</a><a href="../older/2.2.0/kompendium-oas/index.html">2.2.0</a><a href="../older/2.1.1/kompendium-oas/index.html">2.1.1</a><a href="../older/2.1.0/kompendium-oas/index.html">2.1.0</a><a href="../older/2.0.4/kompendium-oas/index.html">2.0.4</a><a href="../older/2.0.3/kompendium-oas/index.html">2.0.3</a><a href="../older/2.0.2/kompendium-oas/index.html">2.0.2</a><a href="../older/2.0.1/kompendium-oas/index.html">2.0.1</a></div>
|
|
</div>
|
|
</dokka-template-command> </div>
|
|
<div class="pull-right d-flex">
|
|
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
|
|
<div id="searchBar"></div>
|
|
</div>
|
|
</div>
|
|
<div id="container">
|
|
<div id="leftColumn">
|
|
<div id="sideMenu"></div>
|
|
</div>
|
|
<div id="main">
|
|
<div class="main-content" id="content" pageids="kompendium-oas::////PointingToDeclaration//218983047">
|
|
<div class="breadcrumbs"></div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span><span>kompendium-oas</span></span></h1>
|
|
<div class="platform-hinted UnderCoverText" data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kompendium-oas:dokkaHtmlPartial/main"><h2 class=""> Open Api Specification</h2><p class="paragraph">This module contains the models that represent the Open Api Specification 3.0 (OAS).</p><p class="paragraph">It is a purely domain-based module, with no logic whatsoever.</p><p class="paragraph">The specification can be found <a href="https://swagger.io/specification">here</a>.</p></div></div>
|
|
</div>
|
|
<h2 class="">Packages</h2>
|
|
<div class="table"><a data-name="-1291935789%2FPackages%2F218983047" anchor-label="io.bkbn.kompendium.oas" id="-1291935789%2FPackages%2F218983047" data-filterable-set=":kompendium-oas:dokkaHtmlPartial/main"></a>
|
|
<div class="table-row" data-filterable-current=":kompendium-oas:dokkaHtmlPartial/main" data-filterable-set=":kompendium-oas:dokkaHtmlPartial/main">
|
|
<div>
|
|
<div class="main-subrow ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="io.bkbn.kompendium.oas/index.html">io.bkbn.kompendium.oas</a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1291935789%2FPackages%2F218983047"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div class="pull-right"></div>
|
|
</div>
|
|
<div><span class="brief-comment"><a data-name="-1291935789%2FPackages%2F218983047" anchor-label="io.bkbn.kompendium.oas" id="-1291935789%2FPackages%2F218983047" data-filterable-set=":kompendium-oas:dokkaHtmlPartial/main"></a>
|
|
<p class="paragraph">This is the root package that contains the top level spec that is ultimately serialized into the specification JSON payload.</p>
|
|
</span></div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-2058935510%2FPackages%2F218983047" anchor-label="io.bkbn.kompendium.oas.common" id="-2058935510%2FPackages%2F218983047" data-filterable-set=":kompendium-oas:dokkaHtmlPartial/main"></a>
|
|
<div class="table-row" data-filterable-current=":kompendium-oas:dokkaHtmlPartial/main" data-filterable-set=":kompendium-oas:dokkaHtmlPartial/main">
|
|
<div>
|
|
<div class="main-subrow ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="io.bkbn.kompendium.oas.common/index.html">io.bkbn.kompendium.oas.common</a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-2058935510%2FPackages%2F218983047"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div class="pull-right"></div>
|
|
</div>
|
|
<div><span class="brief-comment"><a data-name="-2058935510%2FPackages%2F218983047" anchor-label="io.bkbn.kompendium.oas.common" id="-2058935510%2FPackages%2F218983047" data-filterable-set=":kompendium-oas:dokkaHtmlPartial/main"></a>
|
|
<p class="paragraph">Here we house data models that will be used across the module.</p>
|
|
</span></div>
|
|
</div>
|
|
</div>
|
|
<a data-name="1192833634%2FPackages%2F218983047" anchor-label="io.bkbn.kompendium.oas.component" id="1192833634%2FPackages%2F218983047" data-filterable-set=":kompendium-oas:dokkaHtmlPartial/main"></a>
|
|
<div class="table-row" data-filterable-current=":kompendium-oas:dokkaHtmlPartial/main" data-filterable-set=":kompendium-oas:dokkaHtmlPartial/main">
|
|
<div>
|
|
<div class="main-subrow ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="io.bkbn.kompendium.oas.component/index.html">io.bkbn.kompendium.oas.component</a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1192833634%2FPackages%2F218983047"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div class="pull-right"></div>
|
|
</div>
|
|
<div><span class="brief-comment"><a data-name="1192833634%2FPackages%2F218983047" anchor-label="io.bkbn.kompendium.oas.component" id="1192833634%2FPackages%2F218983047" data-filterable-set=":kompendium-oas:dokkaHtmlPartial/main"></a>
|
|
<p class="paragraph">This package correlates to the OAS Component layer, which at the moment is relatively bare bones. It will just contain a reference to any security schemas, as adding objects here as components severely limits future ability to add cool features such as route level object validations. Got issues with that, bring it up with the Open API Team :)</p>
|
|
</span></div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-98565267%2FPackages%2F218983047" anchor-label="io.bkbn.kompendium.oas.info" id="-98565267%2FPackages%2F218983047" data-filterable-set=":kompendium-oas:dokkaHtmlPartial/main"></a>
|
|
<div class="table-row" data-filterable-current=":kompendium-oas:dokkaHtmlPartial/main" data-filterable-set=":kompendium-oas:dokkaHtmlPartial/main">
|
|
<div>
|
|
<div class="main-subrow ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="io.bkbn.kompendium.oas.info/index.html">io.bkbn.kompendium.oas.info</a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-98565267%2FPackages%2F218983047"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div class="pull-right"></div>
|
|
</div>
|
|
<div><span class="brief-comment"><a data-name="-98565267%2FPackages%2F218983047" anchor-label="io.bkbn.kompendium.oas.info" id="-98565267%2FPackages%2F218983047" data-filterable-set=":kompendium-oas:dokkaHtmlPartial/main"></a>
|
|
<p class="paragraph">This package houses the data models for information metadata such as contact and licensing info</p>
|
|
</span></div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-2147415004%2FPackages%2F218983047" anchor-label="io.bkbn.kompendium.oas.path" id="-2147415004%2FPackages%2F218983047" data-filterable-set=":kompendium-oas:dokkaHtmlPartial/main"></a>
|
|
<div class="table-row" data-filterable-current=":kompendium-oas:dokkaHtmlPartial/main" data-filterable-set=":kompendium-oas:dokkaHtmlPartial/main">
|
|
<div>
|
|
<div class="main-subrow ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="io.bkbn.kompendium.oas.path/index.html">io.bkbn.kompendium.oas.path</a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-2147415004%2FPackages%2F218983047"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div class="pull-right"></div>
|
|
</div>
|
|
<div><span class="brief-comment"><a data-name="-2147415004%2FPackages%2F218983047" anchor-label="io.bkbn.kompendium.oas.path" id="-2147415004%2FPackages%2F218983047" data-filterable-set=":kompendium-oas:dokkaHtmlPartial/main"></a>
|
|
<p class="paragraph">Now we're getting to the good stuff. This is where the details on each path level operation will live. Your <code class="lang-kotlin">gets</code>, your <code class="lang-kotlin">puts</code>, so on and so forth.</p>
|
|
</span></div>
|
|
</div>
|
|
</div>
|
|
<a data-name="801523827%2FPackages%2F218983047" anchor-label="io.bkbn.kompendium.oas.payload" id="801523827%2FPackages%2F218983047" data-filterable-set=":kompendium-oas:dokkaHtmlPartial/main"></a>
|
|
<div class="table-row" data-filterable-current=":kompendium-oas:dokkaHtmlPartial/main" data-filterable-set=":kompendium-oas:dokkaHtmlPartial/main">
|
|
<div>
|
|
<div class="main-subrow ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="io.bkbn.kompendium.oas.payload/index.html">io.bkbn.kompendium.oas.payload</a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="801523827%2FPackages%2F218983047"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div class="pull-right"></div>
|
|
</div>
|
|
<div><span class="brief-comment"><a data-name="801523827%2FPackages%2F218983047" anchor-label="io.bkbn.kompendium.oas.payload" id="801523827%2FPackages%2F218983047" data-filterable-set=":kompendium-oas:dokkaHtmlPartial/main"></a>
|
|
<p class="paragraph">This is another good one, this is where the actual payload types live. Request and response body specifications, parameter details, collection support. That all lives here.</p>
|
|
</span></div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-398512897%2FPackages%2F218983047" anchor-label="io.bkbn.kompendium.oas.security" id="-398512897%2FPackages%2F218983047" data-filterable-set=":kompendium-oas:dokkaHtmlPartial/main"></a>
|
|
<div class="table-row" data-filterable-current=":kompendium-oas:dokkaHtmlPartial/main" data-filterable-set=":kompendium-oas:dokkaHtmlPartial/main">
|
|
<div>
|
|
<div class="main-subrow ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="io.bkbn.kompendium.oas.security/index.html">io.bkbn.kompendium.oas.security</a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-398512897%2FPackages%2F218983047"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div class="pull-right"></div>
|
|
</div>
|
|
<div><span class="brief-comment"><a data-name="-398512897%2FPackages%2F218983047" anchor-label="io.bkbn.kompendium.oas.security" id="-398512897%2FPackages%2F218983047" data-filterable-set=":kompendium-oas:dokkaHtmlPartial/main"></a>
|
|
<p class="paragraph">Separated from the core schema models are the models that represent security schemas. Despite being referred to as schemas, and despite living as part of the component data structure, these models are drastically different from your core data model schemas, and thus earn their own package</p>
|
|
</span></div>
|
|
</div>
|
|
</div>
|
|
<a data-name="1263357461%2FPackages%2F218983047" anchor-label="io.bkbn.kompendium.oas.serialization" id="1263357461%2FPackages%2F218983047" data-filterable-set=":kompendium-oas:dokkaHtmlPartial/main"></a>
|
|
<div class="table-row" data-filterable-current=":kompendium-oas:dokkaHtmlPartial/main" data-filterable-set=":kompendium-oas:dokkaHtmlPartial/main">
|
|
<div>
|
|
<div class="main-subrow ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="io.bkbn.kompendium.oas.serialization/index.html">io.bkbn.kompendium.oas.serialization</a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1263357461%2FPackages%2F218983047"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div class="pull-right"></div>
|
|
</div>
|
|
<div></div>
|
|
</div>
|
|
</div>
|
|
<a data-name="729524866%2FPackages%2F218983047" anchor-label="io.bkbn.kompendium.oas.server" id="729524866%2FPackages%2F218983047" data-filterable-set=":kompendium-oas:dokkaHtmlPartial/main"></a>
|
|
<div class="table-row" data-filterable-current=":kompendium-oas:dokkaHtmlPartial/main" data-filterable-set=":kompendium-oas:dokkaHtmlPartial/main">
|
|
<div>
|
|
<div class="main-subrow ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="io.bkbn.kompendium.oas.server/index.html">io.bkbn.kompendium.oas.server</a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="729524866%2FPackages%2F218983047"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div class="pull-right"></div>
|
|
</div>
|
|
<div><span class="brief-comment"><a data-name="729524866%2FPackages%2F218983047" anchor-label="io.bkbn.kompendium.oas.server" id="729524866%2FPackages%2F218983047" data-filterable-set=":kompendium-oas:dokkaHtmlPartial/main"></a>
|
|
<p class="paragraph">Here we detail any server information that you wish to attach to your specification</p>
|
|
</span></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="footer">
|
|
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2022 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</body></html>
|
|
|