public abstract class OasDocument extends Document implements ISecurityRequirementParent
Modifier and Type | Field and Description |
---|---|
OasPaths |
paths |
List<SecurityRequirement> |
security |
externalDocs, info, tags
_extensions
_attributes, _extraProperties, _modelId, _ownerDocument, _parent, _validationProblems
Constructor and Description |
---|
OasDocument() |
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.
|
accept, addTag, createExternalDocumentation, createInfo, createTag, getDocumentType, setExternalDocumentation, setExternalDocumentation
addExtension, clearExtensions, createExtension, getExtension, getExtensions, isExtensible, removeExtension
addExtraProperty, addValidationProblem, clearAttributes, clearValidationProblems, getAttribute, getAttributeNames, getExtraProperty, getExtraPropertyNames, getValidationProblemCodes, getValidationProblems, getValidationProblemsFor, hasExtraProperties, modelId, ownerDocument, parent, removeExtraProperty, setAttribute
public OasPaths paths
public List<SecurityRequirement> security
public abstract OasPaths createPaths()
public abstract OasSecurityRequirement createSecurityRequirement()
ISecurityRequirementParent
createSecurityRequirement
in interface ISecurityRequirementParent
ISecurityRequirementParent.createSecurityRequirement()
public SecurityRequirement addSecurityRequirement(SecurityRequirement securityRequirement)
ISecurityRequirementParent
public List<SecurityRequirement> getSecurityRequirements()
ISecurityRequirementParent
getSecurityRequirements
in interface ISecurityRequirementParent
ISecurityRequirementParent.getSecurityRequirements()
public boolean is2xDocument()
public boolean is3xDocument()
Copyright © 2019 Red Hat. All rights reserved.