io.apicurio.datamodels.openapi.models

Class OasDocument

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

All Implemented Interfaces:

IExternalDocumentationParent, ISecurityRequirementParent, IVisitable

Direct Known Subclasses:

Oas20Document, Oas30Document

public abstract class OasDocument
extends Document
implements ISecurityRequirementParent

Models an OpenAPI document.

Author:

eric.wittmann@gmail.com

Field Summary

Fields

Modifier and Type	Field and Description
OasPaths	paths
List<SecurityRequirement>	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
OasDocument()

Method Summary

Modifier and Type	Method and Description
SecurityRequirement	addSecurityRequirement(SecurityRequirement securityRequirement) Adds a security requirement child.
abstract OasPaths	createPaths() Creates an OAS Paths object.
abstract OasSecurityRequirement	createSecurityRequirement() Creates an OAS Security Requirement object.
List<SecurityRequirement>	getSecurityRequirements() Returns a list of all security requirements.
boolean	is2xDocument() Returns true if the document is an OpenAPI/Swagger 2.0 document.
boolean	is3xDocument() Returns true if the document is an OpenAPI 3.x document.

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

accept, addTag, createExternalDocumentation, createInfo, createTag, getDocumentType, 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

paths

public OasPaths paths

security

public List<SecurityRequirement> security

Constructor Detail

OasDocument

public OasDocument()

Method Detail

createPaths

public abstract OasPaths createPaths()

Creates an OAS Paths object.

createSecurityRequirement

public abstract OasSecurityRequirement createSecurityRequirement()

Description copied from interface: ISecurityRequirementParent

Creates an OAS Security Requirement object.

Specified by:

createSecurityRequirement in interface ISecurityRequirementParent

See Also:

ISecurityRequirementParent.createSecurityRequirement()

addSecurityRequirement

public SecurityRequirement addSecurityRequirement(SecurityRequirement securityRequirement)

Description copied from interface: ISecurityRequirementParent

Adds a security requirement child.

Specified by:

addSecurityRequirement in interface ISecurityRequirementParent

See Also:

ISecurityRequirementParent.addSecurityRequirement(io.apicurio.datamodels.core.models.common.SecurityRequirement)

getSecurityRequirements

public List<SecurityRequirement> getSecurityRequirements()

Description copied from interface: ISecurityRequirementParent

Returns a list of all security requirements.

Specified by:

getSecurityRequirements in interface ISecurityRequirementParent

See Also:

ISecurityRequirementParent.getSecurityRequirements()

is2xDocument

public boolean is2xDocument()

Returns true if the document is an OpenAPI/Swagger 2.0 document.

is3xDocument

public boolean is3xDocument()

Returns true if the document is an OpenAPI 3.x document.