Package com.networknt.oas.model

Interface OpenApi3

All Superinterfaces:

com.networknt.jsonoverlay.IJsonOverlay<OpenApi3>, com.networknt.jsonoverlay.IModelPart<OpenApi3,OpenApi3>, OpenApi<OpenApi3>

All Known Implementing Classes:

OpenApi3Impl

public interface OpenApi3
extends com.networknt.jsonoverlay.IJsonOverlay<OpenApi3>, com.networknt.jsonoverlay.IModelPart<OpenApi3,OpenApi3>, OpenApi<OpenApi3>

Method Summary

Modifier and Type	Method	Description
void	addSecurityRequirement(SecurityRequirement securityRequirement)
void	addServer(Server server)
void	addTag(Tag tag)
Callback	getCallback(String name)
Map<String,Callback>	getCallbacks()
Map<String,Callback>	getCallbacks(boolean elaborate)
Object	getComponentsExtension(String name)
Map<String,Object>	getComponentsExtensions()
Map<String,Object>	getComponentsExtensions(boolean elaborate)
Example	getExample(String name)
Map<String,Example>	getExamples()
Map<String,Example>	getExamples(boolean elaborate)
Object	getExtension(String name)
Map<String,Object>	getExtensions()
Map<String,Object>	getExtensions(boolean elaborate)
ExternalDocs	getExternalDocs()
ExternalDocs	getExternalDocs(boolean elaborate)
Header	getHeader(String name)
Map<String,Header>	getHeaders()
Map<String,Header>	getHeaders(boolean elaborate)
Info	getInfo()
Info	getInfo(boolean elaborate)
Link	getLink(String name)
Map<String,Link>	getLinks()
Map<String,Link>	getLinks(boolean elaborate)
String	getOpenApi()
Parameter	getParameter(String name)
Map<String,Parameter>	getParameters()
Map<String,Parameter>	getParameters(boolean elaborate)
Path	getPath(String name)
Map<String,Path>	getPaths()
Map<String,Path>	getPaths(boolean elaborate)
Object	getPathsExtension(String name)
Map<String,Object>	getPathsExtensions()
Map<String,Object>	getPathsExtensions(boolean elaborate)
Map<String,RequestBody>	getRequestBodies()
Map<String,RequestBody>	getRequestBodies(boolean elaborate)
RequestBody	getRequestBody(String name)
Response	getResponse(String name)
Map<String,Response>	getResponses()
Map<String,Response>	getResponses(boolean elaborate)
Schema	getSchema(String name)
Map<String,Schema>	getSchemas()
Map<String,Schema>	getSchemas(boolean elaborate)
SecurityRequirement	getSecurityRequirement(int index)
List<SecurityRequirement>	getSecurityRequirements()
List<SecurityRequirement>	getSecurityRequirements(boolean elaborate)
SecurityScheme	getSecurityScheme(String name)
Map<String,SecurityScheme>	getSecuritySchemes()
Map<String,SecurityScheme>	getSecuritySchemes(boolean elaborate)
Server	getServer(int index)
List<Server>	getServers()
List<Server>	getServers(boolean elaborate)
Tag	getTag(int index)
List<Tag>	getTags()
List<Tag>	getTags(boolean elaborate)
Collection<ValidationResults.ValidationItem>	getValidationItems()
ValidationResults	getValidationResults()
boolean	hasCallback(String name)
boolean	hasCallbacks()
boolean	hasComponentsExtension(String name)
boolean	hasComponentsExtensions()
boolean	hasExample(String name)
boolean	hasExamples()
boolean	hasExtension(String name)
boolean	hasExtensions()
boolean	hasHeader(String name)
boolean	hasHeaders()
boolean	hasLink(String name)
boolean	hasLinks()
boolean	hasParameter(String name)
boolean	hasParameters()
boolean	hasPath(String name)
boolean	hasPaths()
boolean	hasPathsExtension(String name)
boolean	hasPathsExtensions()
boolean	hasRequestBodies()
boolean	hasRequestBody(String name)
boolean	hasResponse(String name)
boolean	hasResponses()
boolean	hasSchema(String name)
boolean	hasSchemas()
boolean	hasSecurityRequirements()
boolean	hasSecurityScheme(String name)
boolean	hasSecuritySchemes()
boolean	hasServers()
boolean	hasTags()
void	insertSecurityRequirement(int index, SecurityRequirement securityRequirement)
void	insertServer(int index, Server server)
void	insertTag(int index, Tag tag)
boolean	isValid()
void	removeCallback(String name)
void	removeComponentsExtension(String name)
void	removeExample(String name)
void	removeExtension(String name)
void	removeHeader(String name)
void	removeLink(String name)
void	removeParameter(String name)
void	removePath(String name)
void	removePathsExtension(String name)
void	removeRequestBody(String name)
void	removeResponse(String name)
void	removeSchema(String name)
void	removeSecurityRequirement(int index)
void	removeSecurityScheme(String name)
void	removeServer(int index)
void	removeTag(int index)
void	setCallback(String name, Callback callback)
void	setCallbacks(Map<String,Callback> callbacks)
void	setComponentsExtension(String name, Object componentsExtension)
void	setComponentsExtensions(Map<String,Object> componentsExtensions)
void	setExample(String name, Example example)
void	setExamples(Map<String,Example> examples)
void	setExtension(String name, Object extension)
void	setExtensions(Map<String,Object> extensions)
void	setExternalDocs(ExternalDocs externalDocs)
void	setHeader(String name, Header header)
void	setHeaders(Map<String,Header> headers)
void	setInfo(Info info)
void	setLink(String name, Link link)
void	setLinks(Map<String,Link> links)
void	setOpenApi(String openApi)
void	setParameter(String name, Parameter parameter)
void	setParameters(Map<String,Parameter> parameters)
void	setPath(String name, Path path)
void	setPaths(Map<String,Path> paths)
void	setPathsExtension(String name, Object pathsExtension)
void	setPathsExtensions(Map<String,Object> pathsExtensions)
void	setRequestBodies(Map<String,RequestBody> requestBodies)
void	setRequestBody(String name, RequestBody requestBody)
void	setResponse(String name, Response response)
void	setResponses(Map<String,Response> responses)
void	setSchema(String name, Schema schema)
void	setSchemas(Map<String,Schema> schemas)
void	setSecurityRequirement(int index, SecurityRequirement securityRequirement)
void	setSecurityRequirements(List<SecurityRequirement> securityRequirements)
void	setSecurityScheme(String name, SecurityScheme securityScheme)
void	setSecuritySchemes(Map<String,SecurityScheme> securitySchemes)
void	setServer(int index, Server server)
void	setServers(List<Server> servers)
void	setTag(int index, Tag tag)
void	setTags(List<Tag> tags)
void	validate()

Method Detail

validate

void validate()

isValid

boolean isValid()

getValidationResults

ValidationResults getValidationResults()

getValidationItems

Collection<ValidationResults.ValidationItem> getValidationItems()

getOpenApi

String getOpenApi()

setOpenApi

void setOpenApi(String openApi)

getInfo

Info getInfo()

getInfo

Info getInfo(boolean elaborate)

setInfo

void setInfo(Info info)

getServers

List<Server> getServers()

getServers

List<Server> getServers(boolean elaborate)

hasServers

boolean hasServers()

getServer

Server getServer(int index)

setServers

void setServers(List<Server> servers)

setServer

void setServer(int index,
               Server server)

addServer

void addServer(Server server)

insertServer

void insertServer(int index,
                  Server server)

removeServer

void removeServer(int index)

getPaths

Map<String,Path> getPaths()

getPaths

Map<String,Path> getPaths(boolean elaborate)

hasPaths

boolean hasPaths()

hasPath

boolean hasPath(String name)

getPath

Path getPath(String name)

setPaths

void setPaths(Map<String,Path> paths)

setPath

void setPath(String name,
             Path path)

removePath

void removePath(String name)

getPathsExtensions

Map<String,Object> getPathsExtensions()

getPathsExtensions

Map<String,Object> getPathsExtensions(boolean elaborate)

hasPathsExtensions

boolean hasPathsExtensions()

hasPathsExtension

boolean hasPathsExtension(String name)

getPathsExtension

Object getPathsExtension(String name)

setPathsExtensions

void setPathsExtensions(Map<String,Object> pathsExtensions)

setPathsExtension

void setPathsExtension(String name,
                       Object pathsExtension)

removePathsExtension

void removePathsExtension(String name)

getSchemas

Map<String,Schema> getSchemas()

getSchemas

Map<String,Schema> getSchemas(boolean elaborate)

hasSchemas

boolean hasSchemas()

hasSchema

boolean hasSchema(String name)

getSchema

Schema getSchema(String name)

setSchemas

void setSchemas(Map<String,Schema> schemas)

setSchema

void setSchema(String name,
               Schema schema)

removeSchema

void removeSchema(String name)

getResponses

Map<String,Response> getResponses()

getResponses

Map<String,Response> getResponses(boolean elaborate)

hasResponses

boolean hasResponses()

hasResponse

boolean hasResponse(String name)

getResponse

Response getResponse(String name)

setResponses

void setResponses(Map<String,Response> responses)

setResponse

void setResponse(String name,
                 Response response)

removeResponse

void removeResponse(String name)

getParameters

Map<String,Parameter> getParameters()

getParameters

Map<String,Parameter> getParameters(boolean elaborate)

hasParameters

boolean hasParameters()

hasParameter

boolean hasParameter(String name)

getParameter

Parameter getParameter(String name)

setParameters

void setParameters(Map<String,Parameter> parameters)

setParameter

void setParameter(String name,
                  Parameter parameter)

removeParameter

void removeParameter(String name)

getExamples

Map<String,Example> getExamples()

getExamples

Map<String,Example> getExamples(boolean elaborate)

hasExamples

boolean hasExamples()

hasExample

boolean hasExample(String name)

getExample

Example getExample(String name)

setExamples

void setExamples(Map<String,Example> examples)

setExample

void setExample(String name,
                Example example)

removeExample

void removeExample(String name)

getRequestBodies

Map<String,RequestBody> getRequestBodies()

getRequestBodies

Map<String,RequestBody> getRequestBodies(boolean elaborate)

hasRequestBodies

boolean hasRequestBodies()

hasRequestBody

boolean hasRequestBody(String name)

getRequestBody

RequestBody getRequestBody(String name)

setRequestBodies

void setRequestBodies(Map<String,RequestBody> requestBodies)

setRequestBody

void setRequestBody(String name,
                    RequestBody requestBody)

removeRequestBody

void removeRequestBody(String name)

getHeaders

Map<String,Header> getHeaders()

getHeaders

Map<String,Header> getHeaders(boolean elaborate)

hasHeaders

boolean hasHeaders()

hasHeader

boolean hasHeader(String name)

getHeader

Header getHeader(String name)

setHeaders

void setHeaders(Map<String,Header> headers)

setHeader

void setHeader(String name,
               Header header)

removeHeader

void removeHeader(String name)

getSecuritySchemes

Map<String,SecurityScheme> getSecuritySchemes()

getSecuritySchemes

Map<String,SecurityScheme> getSecuritySchemes(boolean elaborate)

hasSecuritySchemes

boolean hasSecuritySchemes()

hasSecurityScheme

boolean hasSecurityScheme(String name)

getSecurityScheme

SecurityScheme getSecurityScheme(String name)

setSecuritySchemes

void setSecuritySchemes(Map<String,SecurityScheme> securitySchemes)

setSecurityScheme

void setSecurityScheme(String name,
                       SecurityScheme securityScheme)

removeSecurityScheme

void removeSecurityScheme(String name)

getLinks

Map<String,Link> getLinks()

getLinks

Map<String,Link> getLinks(boolean elaborate)

hasLinks

boolean hasLinks()

hasLink

boolean hasLink(String name)

getLink

Link getLink(String name)

setLinks

void setLinks(Map<String,Link> links)

setLink

void setLink(String name,
             Link link)

removeLink

void removeLink(String name)

getCallbacks

Map<String,Callback> getCallbacks()

getCallbacks

Map<String,Callback> getCallbacks(boolean elaborate)

hasCallbacks

boolean hasCallbacks()

hasCallback

boolean hasCallback(String name)

getCallback

Callback getCallback(String name)

setCallbacks

void setCallbacks(Map<String,Callback> callbacks)

setCallback

void setCallback(String name,
                 Callback callback)

removeCallback

void removeCallback(String name)

getComponentsExtensions

Map<String,Object> getComponentsExtensions()

getComponentsExtensions

Map<String,Object> getComponentsExtensions(boolean elaborate)

hasComponentsExtensions

boolean hasComponentsExtensions()

hasComponentsExtension

boolean hasComponentsExtension(String name)

getComponentsExtension

Object getComponentsExtension(String name)

setComponentsExtensions

void setComponentsExtensions(Map<String,Object> componentsExtensions)

setComponentsExtension

void setComponentsExtension(String name,
                            Object componentsExtension)

removeComponentsExtension

void removeComponentsExtension(String name)

getSecurityRequirements

List<SecurityRequirement> getSecurityRequirements()

getSecurityRequirements

List<SecurityRequirement> getSecurityRequirements(boolean elaborate)

hasSecurityRequirements

boolean hasSecurityRequirements()

getSecurityRequirement

SecurityRequirement getSecurityRequirement(int index)

setSecurityRequirements

void setSecurityRequirements(List<SecurityRequirement> securityRequirements)

setSecurityRequirement

void setSecurityRequirement(int index,
                            SecurityRequirement securityRequirement)

addSecurityRequirement

void addSecurityRequirement(SecurityRequirement securityRequirement)

insertSecurityRequirement

void insertSecurityRequirement(int index,
                               SecurityRequirement securityRequirement)

removeSecurityRequirement

void removeSecurityRequirement(int index)

getTags

List<Tag> getTags()

getTags

List<Tag> getTags(boolean elaborate)

hasTags

boolean hasTags()

getTag

Tag getTag(int index)

setTags

void setTags(List<Tag> tags)

setTag

void setTag(int index,
            Tag tag)

addTag

void addTag(Tag tag)

insertTag

void insertTag(int index,
               Tag tag)

removeTag

void removeTag(int index)

getExternalDocs

ExternalDocs getExternalDocs()

getExternalDocs

ExternalDocs getExternalDocs(boolean elaborate)

setExternalDocs

void setExternalDocs(ExternalDocs externalDocs)

getExtensions

Map<String,Object> getExtensions()

getExtensions

Map<String,Object> getExtensions(boolean elaborate)

hasExtensions

boolean hasExtensions()

hasExtension

boolean hasExtension(String name)

getExtension

Object getExtension(String name)

setExtensions

void setExtensions(Map<String,Object> extensions)

setExtension

void setExtension(String name,
                  Object extension)

removeExtension

void removeExtension(String name)