io.apicurio.datamodels.openapi.v3.models

Class Oas30Document

java.lang.Object

io.apicurio.datamodels.core.models.Node

io.apicurio.datamodels.core.models.ExtensibleNode

io.apicurio.datamodels.core.models.Document

io.apicurio.datamodels.openapi.models.OasDocument

io.apicurio.datamodels.openapi.v3.models.Oas30Document

All Implemented Interfaces:

IExternalDocumentationParent, ISecurityRequirementParent, IServerParent, IVisitable

public class Oas30Document
extends OasDocument
implements IServerParent

Models the root document of the OpenAPI 2.0 (aka Swagger) data model.

Author:

eric.wittmann@gmail.com

Field Summary

Fields

Modifier and Type	Field and Description
Oas30Components	components
String	openapi
List<Server>	servers

Fields inherited from class io.apicurio.datamodels.openapi.models.OasDocument

paths, security

Fields inherited from class io.apicurio.datamodels.core.models.Document

externalDocs, info, tags

Fields inherited from class io.apicurio.datamodels.core.models.ExtensibleNode

_extensions

Fields inherited from class io.apicurio.datamodels.core.models.Node

_attributes, _extraProperties, _modelId, _ownerDocument, _parent, _validationProblems

Constructor Summary

Constructors

Constructor and Description
Oas30Document() Constructor.

Method Summary

Modifier and Type	Method and Description
void	addServer(Server server) Adds a server.
Server	addServer(String url, String description) Adds a server.
Oas30Components	createComponents() Creates an OAS 3.0 Components object.
ExternalDocumentation	createExternalDocumentation() Creates an External Documentation node.
Info	createInfo() Creates an Info node.
OasPaths	createPaths() Creates an OAS Paths object.
OasSecurityRequirement	createSecurityRequirement() Creates an OAS Security Requirement object.
Server	createServer() Creates a server.
Tag	createTag() Creates a Tag node.
DocumentType	getDocumentType() Called to get the type of document.
Server	getServer(String url) Gets a server by URL.
List<Server>	getServers() Gets the list of servers.

Methods inherited from class io.apicurio.datamodels.openapi.models.OasDocument

addSecurityRequirement, getSecurityRequirements, is2xDocument, is3xDocument

Methods inherited from class io.apicurio.datamodels.core.models.Document

accept, addTag, setExternalDocumentation, setExternalDocumentation

Methods inherited from class io.apicurio.datamodels.core.models.ExtensibleNode

addExtension, clearExtensions, createExtension, getExtension, getExtensions, isExtensible, removeExtension

Methods inherited from class io.apicurio.datamodels.core.models.Node

addExtraProperty, addValidationProblem, clearAttributes, clearValidationProblems, getAttribute, getAttributeNames, getExtraProperty, getExtraPropertyNames, getValidationProblemCodes, getValidationProblems, getValidationProblemsFor, hasExtraProperties, modelId, ownerDocument, parent, removeExtraProperty, setAttribute

Methods inherited from class java.lang.Object

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

Field Detail

openapi

public String openapi

servers

public List<Server> servers

components

public Oas30Components components

Constructor Detail

Oas30Document

public Oas30Document()

Constructor.

Method Detail

getDocumentType

public final DocumentType getDocumentType()

Description copied from class: Document

Called to get the type of document.

Specified by:

getDocumentType in class Document

See Also:

Document.getDocumentType()

createPaths

public OasPaths createPaths()

Description copied from class: OasDocument

Creates an OAS Paths object.

Specified by:

createPaths in class OasDocument

See Also:

OasDocument.createPaths()

createSecurityRequirement

public OasSecurityRequirement createSecurityRequirement()

Description copied from interface: ISecurityRequirementParent

Creates an OAS Security Requirement object.

Specified by:

createSecurityRequirement in interface ISecurityRequirementParent

Specified by:

createSecurityRequirement in class OasDocument

See Also:

OasDocument.createSecurityRequirement()

createInfo

public Info createInfo()

Description copied from class: Document

Creates an Info node.

Specified by:

createInfo in class Document

See Also:

Document.createInfo()

createTag

public Tag createTag()

Description copied from class: Document

Creates a Tag node.

Specified by:

createTag in class Document

See Also:

Document.createTag()

createExternalDocumentation

public ExternalDocumentation createExternalDocumentation()

Description copied from class: Document

Creates an External Documentation node.

Specified by:

createExternalDocumentation in interface IExternalDocumentationParent

Specified by:

createExternalDocumentation in class Document

See Also:

Document.createExternalDocumentation()

createServer

public Server createServer()

Description copied from interface: IServerParent

Creates a server.

Specified by:

createServer in interface IServerParent

See Also:

IServerParent.createServer()

addServer

public Server addServer(String url,
                        String description)

Adds a server.

Parameters:

url -

description -

createComponents

public Oas30Components createComponents()

Creates an OAS 3.0 Components object.

addServer

public void addServer(Server server)

Description copied from interface: IServerParent

Adds a server.

Specified by:

addServer in interface IServerParent

See Also:

IServerParent.addServer(io.apicurio.datamodels.core.models.common.Server)

getServer

public Server getServer(String url)

Description copied from interface: IServerParent

Gets a server by URL.

Specified by:

getServer in interface IServerParent

See Also:

IServerParent.getServer(java.lang.String)

getServers

public List<Server> getServers()

Description copied from interface: IServerParent

Gets the list of servers.

Specified by:

getServers in interface IServerParent

See Also:

IServerParent.getServers()