Package io.apicurio.datamodels.models.openapi

Interface OpenApiComponents

All Superinterfaces:

Components, Node, Visitable

All Known Subinterfaces:

OpenApi30Components, OpenApi31Components

All Known Implementing Classes:

OpenApi30ComponentsImpl, OpenApi31ComponentsImpl

public interface OpenApiComponents
extends Components

Method Summary

Modifier and Type	Method	Description
void	addCallback(String name, OpenApiCallback value)
void	addExample(String name, OpenApiExample value)
void	addHeader(String name, OpenApiHeader value)
void	addLink(String name, OpenApiLink value)
void	addRequestBody(String name, OpenApiRequestBody value)
void	addResponse(String name, OpenApiResponse value)
void	clearCallbacks()
void	clearExamples()
void	clearHeaders()
void	clearLinks()
void	clearRequestBodies()
void	clearResponses()
OpenApiCallback	createCallback()
OpenApiExample	createExample()
OpenApiHeader	createHeader()
OpenApiLink	createLink()
OpenApiRequestBody	createRequestBody()
OpenApiResponse	createResponse()
Map<String,OpenApiCallback>	getCallbacks()
Map<String,OpenApiExample>	getExamples()
Map<String,OpenApiHeader>	getHeaders()
Map<String,OpenApiLink>	getLinks()
Map<String,OpenApiRequestBody>	getRequestBodies()
Map<String,OpenApiResponse>	getResponses()
void	insertCallback(String name, OpenApiCallback value, int atIndex)
void	insertExample(String name, OpenApiExample value, int atIndex)
void	insertHeader(String name, OpenApiHeader value, int atIndex)
void	insertLink(String name, OpenApiLink value, int atIndex)
void	insertRequestBody(String name, OpenApiRequestBody value, int atIndex)
void	insertResponse(String name, OpenApiResponse value, int atIndex)
void	removeCallback(String name)
void	removeExample(String name)
void	removeHeader(String name)
void	removeLink(String name)
void	removeRequestBody(String name)
void	removeResponse(String name)

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

addParameter, addSchema, addSecurityScheme, clearParameters, clearSchemas, clearSecuritySchemes, createParameter, createSchema, createSecurityScheme, getParameters, getSchemas, getSecuritySchemes, insertParameter, insertSchema, insertSecurityScheme, removeParameter, removeSchema, removeSecurityScheme

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.Visitable

accept

Method Detail

createRequestBody

OpenApiRequestBody createRequestBody()

getRequestBodies

Map<String,OpenApiRequestBody> getRequestBodies()

addRequestBody

void addRequestBody(String name,
                    OpenApiRequestBody value)

clearRequestBodies

void clearRequestBodies()

removeRequestBody

void removeRequestBody(String name)

insertRequestBody

void insertRequestBody(String name,
                       OpenApiRequestBody value,
                       int atIndex)

createLink

OpenApiLink createLink()

getLinks

Map<String,OpenApiLink> getLinks()

addLink

void addLink(String name,
             OpenApiLink value)

clearLinks

void clearLinks()

removeLink

void removeLink(String name)

insertLink

void insertLink(String name,
                OpenApiLink value,
                int atIndex)

createResponse

OpenApiResponse createResponse()

getResponses

Map<String,OpenApiResponse> getResponses()

addResponse

void addResponse(String name,
                 OpenApiResponse value)

clearResponses

void clearResponses()

removeResponse

void removeResponse(String name)

insertResponse

void insertResponse(String name,
                    OpenApiResponse value,
                    int atIndex)

createExample

OpenApiExample createExample()

getExamples

Map<String,OpenApiExample> getExamples()

addExample

void addExample(String name,
                OpenApiExample value)

clearExamples

void clearExamples()

removeExample

void removeExample(String name)

insertExample

void insertExample(String name,
                   OpenApiExample value,
                   int atIndex)

createHeader

OpenApiHeader createHeader()

getHeaders

Map<String,OpenApiHeader> getHeaders()

addHeader

void addHeader(String name,
               OpenApiHeader value)

clearHeaders

void clearHeaders()

removeHeader

void removeHeader(String name)

insertHeader

void insertHeader(String name,
                  OpenApiHeader value,
                  int atIndex)

createCallback

OpenApiCallback createCallback()

getCallbacks

Map<String,OpenApiCallback> getCallbacks()

addCallback

void addCallback(String name,
                 OpenApiCallback value)

clearCallbacks

void clearCallbacks()

removeCallback

void removeCallback(String name)

insertCallback

void insertCallback(String name,
                    OpenApiCallback value,
                    int atIndex)