Package software.amazon.smithy.openapi.model

Class OpenApi

java.lang.Object

software.amazon.smithy.openapi.model.Component

software.amazon.smithy.openapi.model.OpenApi

All Implemented Interfaces:

ToNode, ToSmithyBuilder<OpenApi>

public final class OpenApi
extends Component
implements ToSmithyBuilder<OpenApi>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OpenApi.Builder

Method Summary

Modifier and Type	Method	Description
static OpenApi.Builder	builder()
protected ObjectNode.Builder	createNodeBuilder()
ComponentsObject	getComponents()
Optional<ExternalDocumentation>	getExternalDocs()
InfoObject	getInfo()
String	getOpenapi()
Map<String,PathItem>	getPaths()
List<Map<String,List<String>>>	getSecurity()
List<ServerObject>	getServers()
List<TagObject>	getTags()
OpenApi.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.

Methods inherited from class software.amazon.smithy.openapi.model.Component

equals, getExtension, getExtensions, hashCode, toNode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Details

builder

public static OpenApi.Builder builder()

getOpenapi

public String getOpenapi()

getInfo

public InfoObject getInfo()

getServers

public List<ServerObject> getServers()

getPaths

public Map<String,PathItem> getPaths()

getComponents

public ComponentsObject getComponents()

getSecurity

public List<Map<String,List<String>>> getSecurity()

getTags

public List<TagObject> getTags()

getExternalDocs

public Optional<ExternalDocumentation> getExternalDocs()

toBuilder

public OpenApi.Builder toBuilder()

Description copied from interface: ToSmithyBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToSmithyBuilder<OpenApi>

Returns:

a builder for type T

createNodeBuilder

protected ObjectNode.Builder createNodeBuilder()

Specified by:

createNodeBuilder in class Component