| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>org.eclipse.microprofile.openapi.models</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="org.eclipse.microprofile.openapi.models"; |
| } |
| } |
| 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 class="navBarCell1Rev">Package</li> |
| <li>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/tags/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../org/eclipse/microprofile/openapi/models/callbacks/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/microprofile/openapi/models/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All 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> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.eclipse.microprofile.openapi.models</h1> |
| <div class="docSummary"> |
| <div class="block">A set of interfaces for programmable models and their helper classes, |
| many derived from Swagger Core library.</div> |
| </div> |
| <p>See: <a href="#package.description">Description</a></p> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/eclipse/microprofile/openapi/models/Components.html" title="interface in org.eclipse.microprofile.openapi.models">Components</a></td> |
| <td class="colLast"> |
| <div class="block">Components</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/eclipse/microprofile/openapi/models/Constructible.html" title="interface in org.eclipse.microprofile.openapi.models">Constructible</a></td> |
| <td class="colLast"> |
| <div class="block">Marker interface for OpenAPI model objects that can be constructed by the OASFactory.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/eclipse/microprofile/openapi/models/Extensible.html" title="interface in org.eclipse.microprofile.openapi.models">Extensible</a><T extends <a href="../../../../../org/eclipse/microprofile/openapi/models/Extensible.html" title="interface in org.eclipse.microprofile.openapi.models">Extensible</a><T>></td> |
| <td class="colLast"> |
| <div class="block">The base interface for OpenAPI model objects that can contain extensions.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/eclipse/microprofile/openapi/models/ExternalDocumentation.html" title="interface in org.eclipse.microprofile.openapi.models">ExternalDocumentation</a></td> |
| <td class="colLast"> |
| <div class="block">ExternalDocumentation</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/eclipse/microprofile/openapi/models/OpenAPI.html" title="interface in org.eclipse.microprofile.openapi.models">OpenAPI</a></td> |
| <td class="colLast"> |
| <div class="block">OpenAPI</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/eclipse/microprofile/openapi/models/Operation.html" title="interface in org.eclipse.microprofile.openapi.models">Operation</a></td> |
| <td class="colLast"> |
| <div class="block">Operation</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/eclipse/microprofile/openapi/models/PathItem.html" title="interface in org.eclipse.microprofile.openapi.models">PathItem</a></td> |
| <td class="colLast"> |
| <div class="block">PathItem</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/eclipse/microprofile/openapi/models/Paths.html" title="interface in org.eclipse.microprofile.openapi.models">Paths</a></td> |
| <td class="colLast"> |
| <div class="block">Paths</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/eclipse/microprofile/openapi/models/Reference.html" title="interface in org.eclipse.microprofile.openapi.models">Reference</a><T extends <a href="../../../../../org/eclipse/microprofile/openapi/models/Reference.html" title="interface in org.eclipse.microprofile.openapi.models">Reference</a><T>></td> |
| <td class="colLast"> |
| <div class="block">Base interface for OpenAPI model objects that can make reference to other objects.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> |
| <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Enum</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/eclipse/microprofile/openapi/models/PathItem.HttpMethod.html" title="enum in org.eclipse.microprofile.openapi.models">PathItem.HttpMethod</a></td> |
| <td class="colLast"> |
| <div class="block">All of the possible types of HTTP operations for this path</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package.description"> |
| <!-- --> |
| </a> |
| <h2 title="Package org.eclipse.microprofile.openapi.models Description">Package org.eclipse.microprofile.openapi.models Description</h2> |
| <div class="block">A set of interfaces for programmable models and their helper classes, |
| many derived from Swagger Core library. These interfaces can be used to |
| define OpenAPI document programmatically. |
| <p> |
| The behaviour of methods inherited from java.lang.Object are undefined by the MicroProfile OpenAPI specification. |
| <p> |
| Example: |
| <pre> |
| public class MyOASModelReaderImpl implements OASModelReader { |
| |
| @Override |
| public OpenAPI buildModel() { |
| return OASFactory.createObject(OpenAPI.class) |
| .info(OASFactory.createObject(Info.class) |
| .title("AirlinesRatingApp API") |
| .version("1.0") |
| .termsOfService("http://airlinesratingapp.com/terms") |
| .contact(OASFactory.createObject(Contact.class) |
| .name("AirlinesRatingApp API Support") |
| .url("http://exampleurl.com/contact") |
| .email("techsupport @airlinesratingapp.com")) |
| .license(OASFactory.createObject(License.class) |
| .name("Apache 2.0") |
| .url("http://www.apache.org/licenses/LICENSE-2.0.html"))) |
| } |
| </pre></div> |
| </div> |
| <!-- ======= 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 class="navBarCell1Rev">Package</li> |
| <li>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/tags/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../org/eclipse/microprofile/openapi/models/callbacks/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/microprofile/openapi/models/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All 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> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
