Package io.apicurio.datamodels.models.openapi.v20

Interface OpenApi20Document

All Superinterfaces:

Document, Extensible, Node, OpenApi20Extensible, OpenApi20SecurityRequirementsParent, OpenApiDocument, OpenApiExtensible, OpenApiSecurityRequirementsParent, RootNode, SecurityRequirementsParent, Visitable

All Known Implementing Classes:

OpenApi20DocumentImpl

public interface OpenApi20Document
extends RootNode, OpenApiDocument, OpenApi20Extensible, OpenApi20SecurityRequirementsParent

Method Summary

Modifier and Type	Method	Description
void	addExtension(String name, com.fasterxml.jackson.databind.JsonNode value)
void	addSecurity(SecurityRequirement value)
void	clearExtensions()
void	clearSecurity()
OpenApi20Definitions	createDefinitions()
OpenApi20ParameterDefinitions	createParameterDefinitions()
OpenApi20ResponseDefinitions	createResponseDefinitions()
OpenApi20SecurityDefinitions	createSecurityDefinitions()
OpenApi20SecurityRequirement	createSecurityRequirement()
String	getBasePath()
List<String>	getConsumes()
OpenApi20Definitions	getDefinitions()
Map<String,com.fasterxml.jackson.databind.JsonNode>	getExtensions()
String	getHost()
OpenApi20ParameterDefinitions	getParameters()
List<String>	getProduces()
OpenApi20ResponseDefinitions	getResponses()
List<String>	getSchemes()
List<SecurityRequirement>	getSecurity()
OpenApi20SecurityDefinitions	getSecurityDefinitions()
String	getSwagger()
void	insertExtension(String name, com.fasterxml.jackson.databind.JsonNode value, int atIndex)
void	insertSecurity(SecurityRequirement value, int atIndex)
void	removeExtension(String name)
void	removeSecurity(SecurityRequirement value)
void	setBasePath(String value)
void	setConsumes(List<String> value)
void	setDefinitions(OpenApi20Definitions value)
void	setHost(String value)
void	setParameters(OpenApi20ParameterDefinitions value)
void	setProduces(List<String> value)
void	setResponses(OpenApi20ResponseDefinitions value)
void	setSchemes(List<String> value)
void	setSecurityDefinitions(OpenApi20SecurityDefinitions value)
void	setSwagger(String value)

Methods inherited from interface io.apicurio.datamodels.models.Document

createInfo, getInfo, setInfo

Methods inherited from interface io.apicurio.datamodels.models.Node

addExtraProperty, attach, clearNodeAttributes, emptyClone, getExtraProperty, getExtraPropertyNames, getNodeAttribute, getNodeAttributeNames, hasExtraProperties, isAttached, mapPropertyName, modelId, parent, parentPropertyName, parentPropertyType, removeExtraProperty, root, setNodeAttribute

Methods inherited from interface io.apicurio.datamodels.models.openapi.OpenApiDocument

addTag, clearTags, createExternalDocumentation, createPaths, createTag, getExternalDocs, getPaths, getTags, insertTag, removeTag, setExternalDocs, setPaths

Methods inherited from interface io.apicurio.datamodels.models.RootNode

modelType

Methods inherited from interface io.apicurio.datamodels.models.Visitable

accept

Method Detail

getSwagger

String getSwagger()

setSwagger

void setSwagger(String value)

getHost

String getHost()

setHost

void setHost(String value)

getBasePath

String getBasePath()

setBasePath

void setBasePath(String value)

getSchemes

List<String> getSchemes()

setSchemes

void setSchemes(List<String> value)

getConsumes

List<String> getConsumes()

setConsumes

void setConsumes(List<String> value)

getProduces

List<String> getProduces()

setProduces

void setProduces(List<String> value)

getDefinitions

OpenApi20Definitions getDefinitions()

setDefinitions

void setDefinitions(OpenApi20Definitions value)

createDefinitions

OpenApi20Definitions createDefinitions()

getParameters

OpenApi20ParameterDefinitions getParameters()

setParameters

void setParameters(OpenApi20ParameterDefinitions value)

createParameterDefinitions

OpenApi20ParameterDefinitions createParameterDefinitions()

getResponses

OpenApi20ResponseDefinitions getResponses()

setResponses

void setResponses(OpenApi20ResponseDefinitions value)

createResponseDefinitions

OpenApi20ResponseDefinitions createResponseDefinitions()

getSecurityDefinitions

OpenApi20SecurityDefinitions getSecurityDefinitions()

setSecurityDefinitions

void setSecurityDefinitions(OpenApi20SecurityDefinitions value)

createSecurityDefinitions

OpenApi20SecurityDefinitions createSecurityDefinitions()

createSecurityRequirement

OpenApi20SecurityRequirement createSecurityRequirement()

Specified by:

createSecurityRequirement in interface SecurityRequirementsParent

getSecurity

List<SecurityRequirement> getSecurity()

Specified by:

getSecurity in interface SecurityRequirementsParent

addSecurity

void addSecurity(SecurityRequirement value)

Specified by:

addSecurity in interface SecurityRequirementsParent

clearSecurity

void clearSecurity()

Specified by:

clearSecurity in interface SecurityRequirementsParent

removeSecurity

void removeSecurity(SecurityRequirement value)

Specified by:

removeSecurity in interface SecurityRequirementsParent

insertSecurity

void insertSecurity(SecurityRequirement value,
                    int atIndex)

Specified by:

insertSecurity in interface SecurityRequirementsParent

getExtensions

Map<String,com.fasterxml.jackson.databind.JsonNode> getExtensions()

Specified by:

getExtensions in interface Extensible

addExtension

void addExtension(String name,
                  com.fasterxml.jackson.databind.JsonNode value)

Specified by:

addExtension in interface Extensible

clearExtensions

void clearExtensions()

Specified by:

clearExtensions in interface Extensible

removeExtension

void removeExtension(String name)

Specified by:

removeExtension in interface Extensible

insertExtension

void insertExtension(String name,
                     com.fasterxml.jackson.databind.JsonNode value,
                     int atIndex)

Specified by:

insertExtension in interface Extensible