Package io.apicurio.datamodels.models.openapi.v31

Interface OpenApi31Document

All Superinterfaces:

Document, Extensible, Node, OpenApi31Extensible, OpenApi31SecurityRequirementsParent, OpenApi31ServersParent, OpenApiDocument, OpenApiExtensible, OpenApiSecurityRequirementsParent, OpenApiServersParent, RootNode, SecurityRequirementsParent, Visitable

All Known Implementing Classes:

OpenApi31DocumentImpl

public interface OpenApi31Document
extends RootNode, OpenApiDocument, OpenApi31Extensible, OpenApi31ServersParent, OpenApi31SecurityRequirementsParent

Method Summary

Modifier and Type	Method	Description
void	addExtension(String name, com.fasterxml.jackson.databind.JsonNode value)
void	addSecurity(SecurityRequirement value)
void	addServer(OpenApiServer value)
void	addWebhook(String name, OpenApi31PathItem value)
void	clearExtensions()
void	clearSecurity()
void	clearServers()
void	clearWebhooks()
OpenApi31Components	createComponents()
OpenApi31PathItem	createPathItem()
OpenApi31SecurityRequirement	createSecurityRequirement()
OpenApi31Server	createServer()
OpenApi31Components	getComponents()
Map<String,com.fasterxml.jackson.databind.JsonNode>	getExtensions()
String	getJsonSchemaDialect()
String	getOpenapi()
List<SecurityRequirement>	getSecurity()
List<OpenApiServer>	getServers()
Map<String,OpenApi31PathItem>	getWebhooks()
void	insertExtension(String name, com.fasterxml.jackson.databind.JsonNode value, int atIndex)
void	insertSecurity(SecurityRequirement value, int atIndex)
void	insertServer(OpenApiServer value, int atIndex)
void	insertWebhook(String name, OpenApi31PathItem value, int atIndex)
void	removeExtension(String name)
void	removeSecurity(SecurityRequirement value)
void	removeServer(OpenApiServer value)
void	removeWebhook(String name)
void	setComponents(OpenApi31Components value)
void	setJsonSchemaDialect(String value)
void	setOpenapi(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

getOpenapi

String getOpenapi()

setOpenapi

void setOpenapi(String value)

getJsonSchemaDialect

String getJsonSchemaDialect()

setJsonSchemaDialect

void setJsonSchemaDialect(String value)

createPathItem

OpenApi31PathItem createPathItem()

getWebhooks

Map<String,OpenApi31PathItem> getWebhooks()

addWebhook

void addWebhook(String name,
                OpenApi31PathItem value)

clearWebhooks

void clearWebhooks()

removeWebhook

void removeWebhook(String name)

insertWebhook

void insertWebhook(String name,
                   OpenApi31PathItem value,
                   int atIndex)

getComponents

OpenApi31Components getComponents()

setComponents

void setComponents(OpenApi31Components value)

createComponents

OpenApi31Components createComponents()

createServer

OpenApi31Server createServer()

Specified by:

createServer in interface OpenApiServersParent

getServers

List<OpenApiServer> getServers()

Specified by:

getServers in interface OpenApiServersParent

addServer

void addServer(OpenApiServer value)

Specified by:

addServer in interface OpenApiServersParent

clearServers

void clearServers()

Specified by:

clearServers in interface OpenApiServersParent

removeServer

void removeServer(OpenApiServer value)

Specified by:

removeServer in interface OpenApiServersParent

insertServer

void insertServer(OpenApiServer value,
                  int atIndex)

Specified by:

insertServer in interface OpenApiServersParent

createSecurityRequirement

OpenApi31SecurityRequirement 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