io.apicurio.datamodels.openapi.v2.models

Class Oas20Document

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.v2.models.Oas20Document

All Implemented Interfaces:

IExternalDocumentationParent, ISecurityRequirementParent, IVisitable

public class Oas20Document
extends OasDocument

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
String	basePath
List<String>	consumes
Oas20Definitions	definitions
String	host
Oas20ParameterDefinitions	parameters
List<String>	produces
Oas20ResponseDefinitions	responses
List<String>	schemes
Oas20SecurityDefinitions	securityDefinitions
String	swagger

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
Oas20Document()

Method Summary

Modifier and Type	Method and Description
Oas20Definitions	createDefinitions() Creates an OAS 2.0 Definitions object.
ExternalDocumentation	createExternalDocumentation() Creates an External Documentation node.
Info	createInfo() Creates an Info node.
Oas20ParameterDefinitions	createParameterDefinitions() Creates the parameter definitions model.
OasPaths	createPaths() Creates an OAS Paths object.
Oas20ResponseDefinitions	createResponseDefinitions() Creates the parameter definitions model.
Oas20SecurityDefinitions	createSecurityDefinitions() Creates a security definitions.
OasSecurityRequirement	createSecurityRequirement() Creates an OAS Security Requirement object.
Tag	createTag() Creates a Tag node.
DocumentType	getDocumentType() Called to get the type of document.

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

swagger

public final String swagger

See Also:

Constant Field Values

host

public String host

basePath

public String basePath

schemes

public List<String> schemes

consumes

public List<String> consumes

produces

public List<String> produces

definitions

public Oas20Definitions definitions

parameters

public Oas20ParameterDefinitions parameters

responses

public Oas20ResponseDefinitions responses

securityDefinitions

public Oas20SecurityDefinitions securityDefinitions

Constructor Detail

Oas20Document

public Oas20Document()

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()

createDefinitions

public Oas20Definitions createDefinitions()

Creates an OAS 2.0 Definitions object.

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()

createSecurityDefinitions

public Oas20SecurityDefinitions createSecurityDefinitions()

Creates a security definitions.

createParameterDefinitions

public Oas20ParameterDefinitions createParameterDefinitions()

Creates the parameter definitions model.

createResponseDefinitions

public Oas20ResponseDefinitions createResponseDefinitions()

Creates the parameter definitions model.