Google Git
Sign in
apache / tomee-site-pub / 504059d7503a007b82c04535fee5e5878ca4d30e / . / microprofile-6.0 / javadoc / org / eclipse / microprofile / openapi / annotations / OpenAPIDefinition.html
blob: 72b354c2253e0c7a96787aa52dde88972c347fc1 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>OpenAPIDefinition</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<link rel="shortcut icon" href="/img/microprofile-favicon.png">
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="OpenAPIDefinition";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/eclipse/microprofile/openapi/annotations/ExternalDocumentation.html" title="annotation in org.eclipse.microprofile.openapi.annotations"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/microprofile/openapi/annotations/Operation.html" title="annotation in org.eclipse.microprofile.openapi.annotations"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/microprofile/openapi/annotations/OpenAPIDefinition.html" target="_top">Frames</a></li>
<li><a href="OpenAPIDefinition.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.required.element.summary">Required</a>&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.element.detail">Element</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.eclipse.microprofile.openapi.annotations</div>
<h2 title="Annotation Type OpenAPIDefinition" class="title">Annotation Type OpenAPIDefinition</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>@Target(value={TYPE,PACKAGE})
@Retention(value=RUNTIME)
@Inherited
public @interface <span class="memberNameLabel">OpenAPIDefinition</span></pre>
<div class="block">OpenAPI
<p>
This is the root document object of the OpenAPI document. It contains required and optional fields.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href= "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#openapi-object">OpenAPI
Specification OpenAPI Object</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation.type.required.element.summary">
<!-- -->
</a>
<h3>Required Element Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Required Element Summary table, listing required elements, and an explanation">
<caption><span>Required Elements</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Required Element and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/microprofile/openapi/annotations/info/Info.html" title="annotation in org.eclipse.microprofile.openapi.annotations.info">Info</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/annotations/OpenAPIDefinition.html#info--">info</a></span></code>
<div class="block">Required: Provides metadata about the API.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation.type.optional.element.summary">
<!-- -->
</a>
<h3>Optional Element Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
<caption><span>Optional Elements</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Optional Element and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/microprofile/openapi/annotations/Components.html" title="annotation in org.eclipse.microprofile.openapi.annotations">Components</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/annotations/OpenAPIDefinition.html#components--">components</a></span></code>
<div class="block">An element to hold a set of reusable objects for different aspects of the OpenAPI Specification (OAS).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/microprofile/openapi/annotations/extensions/Extension.html" title="annotation in org.eclipse.microprofile.openapi.annotations.extensions">Extension</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/annotations/OpenAPIDefinition.html#extensions--">extensions</a></span></code>
<div class="block">List of extensions to be added to the <a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html" title="interface in org.eclipse.microprofile.openapi.models"><code>OpenAPI</code></a> model
corresponding to the containing annotation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/microprofile/openapi/annotations/ExternalDocumentation.html" title="annotation in org.eclipse.microprofile.openapi.annotations">ExternalDocumentation</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/annotations/OpenAPIDefinition.html#externalDocs--">externalDocs</a></span></code>
<div class="block">Any additional external documentation for the API</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/microprofile/openapi/annotations/security/SecurityRequirement.html" title="annotation in org.eclipse.microprofile.openapi.annotations.security">SecurityRequirement</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/annotations/OpenAPIDefinition.html#security--">security</a></span></code>
<div class="block">A declaration of which security mechanisms can be used across the API.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/microprofile/openapi/annotations/security/SecurityRequirementsSet.html" title="annotation in org.eclipse.microprofile.openapi.annotations.security">SecurityRequirementsSet</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/annotations/OpenAPIDefinition.html#securitySets--">securitySets</a></span></code>
<div class="block">A declaration of which security mechanisms can be used across the API.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/microprofile/openapi/annotations/servers/Server.html" title="annotation in org.eclipse.microprofile.openapi.annotations.servers">Server</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/annotations/OpenAPIDefinition.html#servers--">servers</a></span></code>
<div class="block">An array of Server Objects, which provide connectivity information to a target server.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/microprofile/openapi/annotations/tags/Tag.html" title="annotation in org.eclipse.microprofile.openapi.annotations.tags">Tag</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/microprofile/openapi/annotations/OpenAPIDefinition.html#tags--">tags</a></span></code>
<div class="block">A list of tags used by the specification with additional metadata.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation.type.element.detail">
<!-- -->
</a>
<h3>Element Detail</h3>
<a name="info--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>info</h4>
<pre>public abstract&nbsp;<a href="../../../../../org/eclipse/microprofile/openapi/annotations/info/Info.html" title="annotation in org.eclipse.microprofile.openapi.annotations.info">Info</a>&nbsp;info</pre>
<div class="block">Required: Provides metadata about the API. The metadata MAY be used by tooling as required.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the metadata about this API</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="tags--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>tags</h4>
<pre>public abstract&nbsp;<a href="../../../../../org/eclipse/microprofile/openapi/annotations/tags/Tag.html" title="annotation in org.eclipse.microprofile.openapi.annotations.tags">Tag</a>[]&nbsp;tags</pre>
<div class="block">A list of tags used by the specification with additional metadata. The order of the tags can be used to reflect
on their order by the parsing tools.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the tags used by the specification with any additional metadata</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>{}</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="servers--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>servers</h4>
<pre>public abstract&nbsp;<a href="../../../../../org/eclipse/microprofile/openapi/annotations/servers/Server.html" title="annotation in org.eclipse.microprofile.openapi.annotations.servers">Server</a>[]&nbsp;servers</pre>
<div class="block">An array of Server Objects, which provide connectivity information to a target server. If the servers property is
not provided, or is an empty array, the default value would be a Server Object with a url value of /.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the servers of this API</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>{}</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="security--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>security</h4>
<pre>public abstract&nbsp;<a href="../../../../../org/eclipse/microprofile/openapi/annotations/security/SecurityRequirement.html" title="annotation in org.eclipse.microprofile.openapi.annotations.security">SecurityRequirement</a>[]&nbsp;security</pre>
<div class="block">A declaration of which security mechanisms can be used across the API.
<p>
Adding a <code>SecurityRequirement</code> to this array is equivalent to adding a <code>SecurityRequirementsSet</code>
containing a single <code>SecurityRequirement</code> to <a href="../../../../../org/eclipse/microprofile/openapi/annotations/OpenAPIDefinition.html#securitySets--"><code>securitySets()</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the array of security requirements for this API</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>{}</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="securitySets--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>securitySets</h4>
<pre>public abstract&nbsp;<a href="../../../../../org/eclipse/microprofile/openapi/annotations/security/SecurityRequirementsSet.html" title="annotation in org.eclipse.microprofile.openapi.annotations.security">SecurityRequirementsSet</a>[]&nbsp;securitySets</pre>
<div class="block">A declaration of which security mechanisms can be used across the API.
<p>
All of the security requirements within any one of the sets must be satisfied to authorize a request.
<p>
Including an empty set within this list indicates that the other requirements are optional.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the array of security requirement sets for this API</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>{}</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="externalDocs--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>externalDocs</h4>
<pre>public abstract&nbsp;<a href="../../../../../org/eclipse/microprofile/openapi/annotations/ExternalDocumentation.html" title="annotation in org.eclipse.microprofile.openapi.annotations">ExternalDocumentation</a>&nbsp;externalDocs</pre>
<div class="block">Any additional external documentation for the API</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the external documentation for this API.</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>@org.eclipse.microprofile.openapi.annotations.ExternalDocumentation</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="components--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>components</h4>
<pre>public abstract&nbsp;<a href="../../../../../org/eclipse/microprofile/openapi/annotations/Components.html" title="annotation in org.eclipse.microprofile.openapi.annotations">Components</a>&nbsp;components</pre>
<div class="block">An element to hold a set of reusable objects for different aspects of the OpenAPI Specification (OAS).
All objects defined within the components object will have no effect on the API unless they are explicitly
referenced from properties outside the components object.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the element with a set of reusable objects for different aspects of the OAS.</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>@org.eclipse.microprofile.openapi.annotations.Components</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="extensions--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>extensions</h4>
<pre>public abstract&nbsp;<a href="../../../../../org/eclipse/microprofile/openapi/annotations/extensions/Extension.html" title="annotation in org.eclipse.microprofile.openapi.annotations.extensions">Extension</a>[]&nbsp;extensions</pre>
<div class="block">List of extensions to be added to the <a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html" title="interface in org.eclipse.microprofile.openapi.models"><code>OpenAPI</code></a> model
corresponding to the containing annotation.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>array of extensions</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.1</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>{}</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/eclipse/microprofile/openapi/annotations/ExternalDocumentation.html" title="annotation in org.eclipse.microprofile.openapi.annotations"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/microprofile/openapi/annotations/Operation.html" title="annotation in org.eclipse.microprofile.openapi.annotations"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/microprofile/openapi/annotations/OpenAPIDefinition.html" target="_top">Frames</a></li>
<li><a href="OpenAPIDefinition.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.required.element.summary">Required</a>&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.element.detail">Element</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>