Package io.apicurio.datamodels.models

Interface Components

All Superinterfaces:

Node, Visitable

All Known Subinterfaces:

AsyncApi20Components, AsyncApi21Components, AsyncApi22Components, AsyncApi23Components, AsyncApi24Components, AsyncApi25Components, AsyncApi26Components, AsyncApi30Components, AsyncApiComponents, OpenApi30Components, OpenApi31Components, OpenApiComponents

All Known Implementing Classes:

AsyncApi20ComponentsImpl, AsyncApi21ComponentsImpl, AsyncApi22ComponentsImpl, AsyncApi23ComponentsImpl, AsyncApi24ComponentsImpl, AsyncApi25ComponentsImpl, AsyncApi26ComponentsImpl, AsyncApi30ComponentsImpl, OpenApi30ComponentsImpl, OpenApi31ComponentsImpl

public interface Components
extends Node

Method Summary

Modifier and Type	Method	Description
void	addParameter(String name, Parameter value)
void	addSchema(String name, Schema value)
void	addSecurityScheme(String name, SecurityScheme value)
void	clearParameters()
void	clearSchemas()
void	clearSecuritySchemes()
Parameter	createParameter()
Schema	createSchema()
SecurityScheme	createSecurityScheme()
Map<String,Parameter>	getParameters()
Map<String,Schema>	getSchemas()
Map<String,SecurityScheme>	getSecuritySchemes()
void	insertParameter(String name, Parameter value, int atIndex)
void	insertSchema(String name, Schema value, int atIndex)
void	insertSecurityScheme(String name, SecurityScheme value, int atIndex)
void	removeParameter(String name)
void	removeSchema(String name)
void	removeSecurityScheme(String name)

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

createSchema

Schema createSchema()

getSchemas

Map<String,Schema> getSchemas()

addSchema

void addSchema(String name,
               Schema value)

clearSchemas

void clearSchemas()

removeSchema

void removeSchema(String name)

insertSchema

void insertSchema(String name,
                  Schema value,
                  int atIndex)

createParameter

Parameter createParameter()

getParameters

Map<String,Parameter> getParameters()

addParameter

void addParameter(String name,
                  Parameter value)

clearParameters

void clearParameters()

removeParameter

void removeParameter(String name)

insertParameter

void insertParameter(String name,
                     Parameter value,
                     int atIndex)

createSecurityScheme

SecurityScheme createSecurityScheme()

getSecuritySchemes

Map<String,SecurityScheme> getSecuritySchemes()

addSecurityScheme

void addSecurityScheme(String name,
                       SecurityScheme value)

clearSecuritySchemes

void clearSecuritySchemes()

removeSecurityScheme

void removeSecurityScheme(String name)

insertSecurityScheme

void insertSecurityScheme(String name,
                          SecurityScheme value,
                          int atIndex)