doc: Added Latest Documentation ✨
This commit is contained in:
github-actions
@ -0,0 +1,230 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
||||
<title>DefaultMethodParser</title>
|
||||
</head><body><link href="../../../images/logo-icon.svg" rel="icon" type="image/svg"><script>var pathToRoot = "../../../";</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"><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>
|
||||
|
||||
|
||||
<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":"io.bkbn.kompendium.core.parser/-default-method-parser/index.html"}"><div class="versions-dropdown">
|
||||
<div class="versions-dropdown-button">2.0.4</div>
|
||||
<div class="versions-dropdown-data"><a href="index.html">2.0.4</a><a href="../../../older/2.0.3/kompendium-core/io.bkbn.kompendium.core.parser/-default-method-parser/index.html">2.0.3</a><a href="../../../older/2.0.2/kompendium-core/io.bkbn.kompendium.core.parser/-default-method-parser/index.html">2.0.2</a><a href="../../../older/2.0.1/kompendium-core/io.bkbn.kompendium.core.parser/-default-method-parser/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-core::io.bkbn.kompendium.core.parser/DefaultMethodParser///PointingToDeclaration//-1397293861">
|
||||
<div class="breadcrumbs"><a href="../../index.html">kompendium-core</a>/<a href="../index.html">io.bkbn.kompendium.core.parser</a>/<a href="index.html">DefaultMethodParser</a></div>
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><span>Default</span><wbr><span>Method</span><wbr><span><span>Parser</span></span></h1>
|
||||
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kompendium-core:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">object </span><a href="index.html">DefaultMethodParser</a> : <a href="../-i-method-parser/index.html">IMethodParser</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
|
||||
</div>
|
||||
<div class="tabbedcontent">
|
||||
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Functions">Functions</button></div>
|
||||
<div class="tabs-section-body">
|
||||
<h2 class="">Functions</h2>
|
||||
<div class="table" data-togglable="Functions"><a data-name="-367042555%2FFunctions%2F-1397293861" anchor-label="calculateRoutePath" id="-367042555%2FFunctions%2F-1397293861" data-filterable-set=":kompendium-core:dokkaHtmlPartial/main"></a>
|
||||
<div class="table-row" data-filterable-current=":kompendium-core:dokkaHtmlPartial/main" data-filterable-set=":kompendium-core:dokkaHtmlPartial/main">
|
||||
<div class="main-subrow keyValue ">
|
||||
<div class=""><span class="inline-flex">
|
||||
<div><a href="../-i-method-parser/calculate-route-path.html"><span>calculate</span><wbr><span>Route</span><wbr><span><span>Path</span></span></a></div>
|
||||
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-367042555%2FFunctions%2F-1397293861"></span>
|
||||
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
||||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kompendium-core:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword"></span><span class="token keyword">fun </span><span data-unresolved-link="io.ktor.routing/Route///PointingToDeclaration/">Route</span><span class="token punctuation">.</span><a href="../-i-method-parser/calculate-route-path.html"><span class="token function">calculateRoutePath</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="brief "><p class="paragraph">Uses the built-in Ktor route path <span data-unresolved-link="io.ktor.routing/Route/toString/#/PointingToDeclaration/">Route.toString</span> but cuts out any meta route such as authentication... anything that matches the RegEx pattern <code class="lang-kotlin">/\\(.+\\)</code></p></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<a data-name="-561924284%2FFunctions%2F-1397293861" anchor-label="defaultValueInjector" id="-561924284%2FFunctions%2F-1397293861" data-filterable-set=":kompendium-core:dokkaHtmlPartial/main"></a>
|
||||
<div class="table-row" data-filterable-current=":kompendium-core:dokkaHtmlPartial/main" data-filterable-set=":kompendium-core:dokkaHtmlPartial/main">
|
||||
<div class="main-subrow keyValue ">
|
||||
<div class=""><span class="inline-flex">
|
||||
<div><a href="../-i-method-parser/default-value-injector.html"><span>default</span><wbr><span>Value</span><wbr><span><span>Injector</span></span></a></div>
|
||||
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-561924284%2FFunctions%2F-1397293861"></span>
|
||||
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
||||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kompendium-core:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="../-i-method-parser/default-value-injector.html"><span class="token function">defaultValueInjector</span></a><span class="token punctuation">(</span>param<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-parameter/index.html">KParameter</a><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="brief "><p class="paragraph">Allows the reflection invoker to populate a parameter map with values in order to sus out any default parameters.</p></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<a data-name="-1386594905%2FFunctions%2F-1397293861" anchor-label="getDefaultParameterValue" id="-1386594905%2FFunctions%2F-1397293861" data-filterable-set=":kompendium-core:dokkaHtmlPartial/main"></a>
|
||||
<div class="table-row" data-filterable-current=":kompendium-core:dokkaHtmlPartial/main" data-filterable-set=":kompendium-core:dokkaHtmlPartial/main">
|
||||
<div class="main-subrow keyValue ">
|
||||
<div class=""><span class="inline-flex">
|
||||
<div><a href="../-i-method-parser/get-default-parameter-value.html"><span>get</span><wbr><span>Default</span><wbr><span>Parameter</span><wbr><span><span>Value</span></span></a></div>
|
||||
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1386594905%2FFunctions%2F-1397293861"></span>
|
||||
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
||||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kompendium-core:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="../-i-method-parser/get-default-parameter-value.html"><span class="token function">getDefaultParameterValue</span></a><span class="token punctuation">(</span>clazz<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.html">KClass</a><span class="token operator"><</span><span class="token operator">*</span><span class="token operator">></span><span class="token punctuation">, </span>prop<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-property/index.html">KProperty</a><span class="token operator"><</span><span class="token operator">*</span><span class="token operator">></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">?</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="brief "><p class="paragraph">Absolutely disgusting reflection to determine if a default value is available for a given property.</p></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<a data-name="90729359%2FFunctions%2F-1397293861" anchor-label="mapToSpec" id="90729359%2FFunctions%2F-1397293861" data-filterable-set=":kompendium-core:dokkaHtmlPartial/main"></a>
|
||||
<div class="table-row" data-filterable-current=":kompendium-core:dokkaHtmlPartial/main" data-filterable-set=":kompendium-core:dokkaHtmlPartial/main">
|
||||
<div class="main-subrow keyValue ">
|
||||
<div class=""><span class="inline-flex">
|
||||
<div><a href="../-i-method-parser/map-to-spec.html"><span>map</span><wbr><span>To</span><wbr><span><span>Spec</span></span></a></div>
|
||||
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="90729359%2FFunctions%2F-1397293861"></span>
|
||||
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
||||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kompendium-core:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html">Set</a><span class="token operator"><</span><span class="token keyword"></span><a href="../../io.bkbn.kompendium.core.metadata/-parameter-example/index.html">ParameterExample</a><span class="token operator">></span><span class="token punctuation">.</span><a href="../-i-method-parser/map-to-spec.html"><span class="token function">mapToSpec</span></a><span class="token punctuation">(</span>parameterName<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><span class="token operator"><</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../../../kompendium-oas/io.bkbn.kompendium.oas.payload/-parameter/-example/index.html">Parameter.Example</a><span class="token operator">></span><span class="token operator">?</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<a data-name="1921584089%2FFunctions%2F-1397293861" anchor-label="parseExceptions" id="1921584089%2FFunctions%2F-1397293861" data-filterable-set=":kompendium-core:dokkaHtmlPartial/main"></a>
|
||||
<div class="table-row" data-filterable-current=":kompendium-core:dokkaHtmlPartial/main" data-filterable-set=":kompendium-core:dokkaHtmlPartial/main">
|
||||
<div class="main-subrow keyValue ">
|
||||
<div class=""><span class="inline-flex">
|
||||
<div><a href="../-i-method-parser/parse-exceptions.html"><span>parse</span><wbr><span><span>Exceptions</span></span></a></div>
|
||||
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1921584089%2FFunctions%2F-1397293861"></span>
|
||||
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
||||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kompendium-core:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="../-i-method-parser/parse-exceptions.html"><span class="token function">parseExceptions</span></a><span class="token punctuation">(</span>exceptionInfo<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html">Set</a><span class="token operator"><</span><span class="token keyword"></span><a href="../../io.bkbn.kompendium.core.metadata/-exception-info/index.html">ExceptionInfo</a><span class="token operator"><</span><span class="token operator">*</span><span class="token operator">></span><span class="token operator">></span><span class="token punctuation">, </span>feature<span class="token operator">: </span><a href="../../io.bkbn.kompendium.core/-kompendium/index.html">Kompendium</a><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><span class="token operator"><</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../../../kompendium-oas/io.bkbn.kompendium.oas.payload/-response/index.html">Response</a><span class="token operator">></span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<a data-name="-33080169%2FFunctions%2F-1397293861" anchor-label="parseMethodInfo" id="-33080169%2FFunctions%2F-1397293861" data-filterable-set=":kompendium-core:dokkaHtmlPartial/main"></a>
|
||||
<div class="table-row" data-filterable-current=":kompendium-core:dokkaHtmlPartial/main" data-filterable-set=":kompendium-core:dokkaHtmlPartial/main">
|
||||
<div class="main-subrow keyValue ">
|
||||
<div class=""><span class="inline-flex">
|
||||
<div><a href="../-i-method-parser/parse-method-info.html"><span>parse</span><wbr><span>Method</span><wbr><span><span>Info</span></span></a></div>
|
||||
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-33080169%2FFunctions%2F-1397293861"></span>
|
||||
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
||||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kompendium-core:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="../-i-method-parser/parse-method-info.html"><span class="token function">parseMethodInfo</span></a><span class="token punctuation">(</span>info<span class="token operator">: </span><a href="../../io.bkbn.kompendium.core.metadata.method/-method-info/index.html">MethodInfo</a><span class="token operator"><</span><span class="token operator">*</span><span class="token punctuation">, </span><span class="token operator">*</span><span class="token operator">></span><span class="token punctuation">, </span>paramType<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-type/index.html">KType</a><span class="token punctuation">, </span>requestType<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-type/index.html">KType</a><span class="token punctuation">, </span>responseType<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-type/index.html">KType</a><span class="token punctuation">, </span>feature<span class="token operator">: </span><a href="../../io.bkbn.kompendium.core/-kompendium/index.html">Kompendium</a><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../../kompendium-oas/io.bkbn.kompendium.oas.path/-path-operation/index.html">PathOperation</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="brief "><p class="paragraph">Generates the OpenAPI Path spec from provided metadata</p></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<a data-name="-168922249%2FFunctions%2F-1397293861" anchor-label="parseResponse" id="-168922249%2FFunctions%2F-1397293861" data-filterable-set=":kompendium-core:dokkaHtmlPartial/main"></a>
|
||||
<div class="table-row" data-filterable-current=":kompendium-core:dokkaHtmlPartial/main" data-filterable-set=":kompendium-core:dokkaHtmlPartial/main">
|
||||
<div class="main-subrow keyValue ">
|
||||
<div class=""><span class="inline-flex">
|
||||
<div><a href="../-i-method-parser/parse-response.html"><span>parse</span><wbr><span><span>Response</span></span></a></div>
|
||||
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-168922249%2FFunctions%2F-1397293861"></span>
|
||||
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
||||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kompendium-core:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="../-i-method-parser/parse-response.html"><span class="token function">parseResponse</span></a><span class="token punctuation">(</span>responseType<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-type/index.html">KType</a><span class="token punctuation">, </span>responseInfo<span class="token operator">: </span><a href="../../io.bkbn.kompendium.core.metadata/-response-info/index.html">ResponseInfo</a><span class="token operator"><</span><span class="token operator">*</span><span class="token operator">></span><span class="token operator">?</span><span class="token punctuation">, </span>feature<span class="token operator">: </span><a href="../../io.bkbn.kompendium.core/-kompendium/index.html">Kompendium</a><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><span class="token operator"><</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../../../kompendium-oas/io.bkbn.kompendium.oas.payload/-response/index.html">Response</a><span class="token operator">></span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<a data-name="-1356542711%2FFunctions%2F-1397293861" anchor-label="resolveContent" id="-1356542711%2FFunctions%2F-1397293861" data-filterable-set=":kompendium-core:dokkaHtmlPartial/main"></a>
|
||||
<div class="table-row" data-filterable-current=":kompendium-core:dokkaHtmlPartial/main" data-filterable-set=":kompendium-core:dokkaHtmlPartial/main">
|
||||
<div class="main-subrow keyValue ">
|
||||
<div class=""><span class="inline-flex">
|
||||
<div><a href="../-i-method-parser/resolve-content.html"><span>resolve</span><wbr><span><span>Content</span></span></a></div>
|
||||
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1356542711%2FFunctions%2F-1397293861"></span>
|
||||
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
||||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kompendium-core:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="../../io.bkbn.kompendium.core/-kompendium/index.html">Kompendium</a><span class="token punctuation">.</span><a href="../-i-method-parser/resolve-content.html"><span class="token function">resolveContent</span></a><span class="token punctuation">(</span>type<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-type/index.html">KType</a><span class="token punctuation">, </span>mediaTypes<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator"><</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">></span><span class="token punctuation">, </span>examples<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><span class="token operator"><</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><span class="token operator"><</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../../../kompendium-oas/io.bkbn.kompendium.oas.payload/-media-type/index.html">MediaType</a><span class="token operator">></span><span class="token operator">?</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="brief "><p class="paragraph">Generates MediaTypes along with any examples provided</p></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<a data-name="2101289123%2FFunctions%2F-1397293861" anchor-label="toParameter" id="2101289123%2FFunctions%2F-1397293861" data-filterable-set=":kompendium-core:dokkaHtmlPartial/main"></a>
|
||||
<div class="table-row" data-filterable-current=":kompendium-core:dokkaHtmlPartial/main" data-filterable-set=":kompendium-core:dokkaHtmlPartial/main">
|
||||
<div class="main-subrow keyValue ">
|
||||
<div class=""><span class="inline-flex">
|
||||
<div><a href="../-i-method-parser/to-parameter.html"><span>to</span><wbr><span><span>Parameter</span></span></a></div>
|
||||
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2101289123%2FFunctions%2F-1397293861"></span>
|
||||
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
||||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kompendium-core:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-property/index.html">KProperty</a><span class="token operator"><</span><span class="token operator">*</span><span class="token operator">></span><span class="token punctuation">.</span><a href="../-i-method-parser/to-parameter.html"><span class="token function">toParameter</span></a><span class="token punctuation">(</span>info<span class="token operator">: </span><a href="../../io.bkbn.kompendium.core.metadata.method/-method-info/index.html">MethodInfo</a><span class="token operator"><</span><span class="token operator">*</span><span class="token punctuation">, </span><span class="token operator">*</span><span class="token operator">></span><span class="token punctuation">, </span>parentType<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-type/index.html">KType</a><span class="token punctuation">, </span>parentClazz<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.html">KClass</a><span class="token operator"><</span><span class="token operator">*</span><span class="token operator">></span><span class="token punctuation">, </span>feature<span class="token operator">: </span><a href="../../io.bkbn.kompendium.core/-kompendium/index.html">Kompendium</a><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../../kompendium-oas/io.bkbn.kompendium.oas.payload/-parameter/index.html">Parameter</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<a data-name="-1784869417%2FFunctions%2F-1397293861" anchor-label="toParameterSpec" id="-1784869417%2FFunctions%2F-1397293861" data-filterable-set=":kompendium-core:dokkaHtmlPartial/main"></a>
|
||||
<div class="table-row" data-filterable-current=":kompendium-core:dokkaHtmlPartial/main" data-filterable-set=":kompendium-core:dokkaHtmlPartial/main">
|
||||
<div class="main-subrow keyValue ">
|
||||
<div class=""><span class="inline-flex">
|
||||
<div><a href="../-i-method-parser/to-parameter-spec.html"><span>to</span><wbr><span>Parameter</span><wbr><span><span>Spec</span></span></a></div>
|
||||
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1784869417%2FFunctions%2F-1397293861"></span>
|
||||
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
||||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kompendium-core:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-type/index.html">KType</a><span class="token punctuation">.</span><a href="../-i-method-parser/to-parameter-spec.html"><span class="token function">toParameterSpec</span></a><span class="token punctuation">(</span>info<span class="token operator">: </span><a href="../../io.bkbn.kompendium.core.metadata.method/-method-info/index.html">MethodInfo</a><span class="token operator"><</span><span class="token operator">*</span><span class="token punctuation">, </span><span class="token operator">*</span><span class="token operator">></span><span class="token punctuation">, </span>feature<span class="token operator">: </span><a href="../../io.bkbn.kompendium.core/-kompendium/index.html">Kompendium</a><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator"><</span><span class="token keyword"></span><a href="../../../kompendium-oas/io.bkbn.kompendium.oas.payload/-parameter/index.html">Parameter</a><span class="token operator">></span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="brief "><p class="paragraph">Parses a type for all parameter information. All fields in the receiver must be annotated with <a href="../../../kompendium-annotations/io.bkbn.kompendium.annotations/-param/index.html">io.bkbn.kompendium.annotations.Param</a>.</p></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<a data-name="251984949%2FFunctions%2F-1397293861" anchor-label="toRequestSpec" id="251984949%2FFunctions%2F-1397293861" data-filterable-set=":kompendium-core:dokkaHtmlPartial/main"></a>
|
||||
<div class="table-row" data-filterable-current=":kompendium-core:dokkaHtmlPartial/main" data-filterable-set=":kompendium-core:dokkaHtmlPartial/main">
|
||||
<div class="main-subrow keyValue ">
|
||||
<div class=""><span class="inline-flex">
|
||||
<div><a href="../-i-method-parser/to-request-spec.html"><span>to</span><wbr><span>Request</span><wbr><span><span>Spec</span></span></a></div>
|
||||
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="251984949%2FFunctions%2F-1397293861"></span>
|
||||
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
||||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kompendium-core:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-type/index.html">KType</a><span class="token punctuation">.</span><a href="../-i-method-parser/to-request-spec.html"><span class="token function">toRequestSpec</span></a><span class="token punctuation">(</span>requestInfo<span class="token operator">: </span><a href="../../io.bkbn.kompendium.core.metadata/-request-info/index.html">RequestInfo</a><span class="token operator"><</span><span class="token operator">*</span><span class="token operator">></span><span class="token operator">?</span><span class="token punctuation">, </span>feature<span class="token operator">: </span><a href="../../io.bkbn.kompendium.core/-kompendium/index.html">Kompendium</a><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../../kompendium-oas/io.bkbn.kompendium.oas.payload/-request/index.html">Request</a><span class="token operator">?</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="brief "><p class="paragraph">Converts a <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-type/index.html">KType</a> to an <a href="../../../kompendium-oas/io.bkbn.kompendium.oas.payload/-request/index.html">Request</a></p></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<a data-name="-1950994457%2FFunctions%2F-1397293861" anchor-label="toResponseSpec" id="-1950994457%2FFunctions%2F-1397293861" data-filterable-set=":kompendium-core:dokkaHtmlPartial/main"></a>
|
||||
<div class="table-row" data-filterable-current=":kompendium-core:dokkaHtmlPartial/main" data-filterable-set=":kompendium-core:dokkaHtmlPartial/main">
|
||||
<div class="main-subrow keyValue ">
|
||||
<div class=""><span class="inline-flex">
|
||||
<div><a href="../-i-method-parser/to-response-spec.html"><span>to</span><wbr><span>Response</span><wbr><span><span>Spec</span></span></a></div>
|
||||
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1950994457%2FFunctions%2F-1397293861"></span>
|
||||
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
||||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kompendium-core:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-type/index.html">KType</a><span class="token punctuation">.</span><a href="../-i-method-parser/to-response-spec.html"><span class="token function">toResponseSpec</span></a><span class="token punctuation">(</span>responseInfo<span class="token operator">: </span><a href="../../io.bkbn.kompendium.core.metadata/-response-info/index.html">ResponseInfo</a><span class="token operator"><</span><span class="token operator">*</span><span class="token operator">></span><span class="token operator">?</span><span class="token punctuation">, </span>feature<span class="token operator">: </span><a href="../../io.bkbn.kompendium.core/-kompendium/index.html">Kompendium</a><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html">Pair</a><span class="token operator"><</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../../../kompendium-oas/io.bkbn.kompendium.oas.payload/-response/index.html">Response</a><span class="token operator">></span><span class="token operator">?</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="brief "><p class="paragraph">Converts a <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-type/index.html">KType</a> to a pairing of http status code to <a href="../../../kompendium-oas/io.bkbn.kompendium.oas.payload/-response/index.html">Response</a></p></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</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>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user