Uses of Interface
org.eclipse.microprofile.openapi.models.Components

Packages that use Components

Package	Description
org.eclipse.microprofile.openapi	A set of Java interfaces, annotations and programming models which allow Java developers to natively produce OpenAPI v3.1 documents from their Jakarta REST applications.
org.eclipse.microprofile.openapi.models	A set of interfaces for programmable models and their helper classes, many derived from Swagger Core library.

Uses of Components in org.eclipse.microprofile.openapi

Methods in org.eclipse.microprofile.openapi that return Components

Modifier and Type	Method	Description
static Components	OASFactory.createComponents()	This method creates a new Components instance.

Uses of Components in org.eclipse.microprofile.openapi.models

Methods in org.eclipse.microprofile.openapi.models that return Components

Modifier and Type	Method	Description
Components	Components.addCallback(String key, Callback callback)	Adds the given callback to this Components' map of callbacks with the given string as its key.
Components	Components.addExample(String key, Example example)	Adds the given example to this Components' map of examples with the given string as its key.
Components	Components.addHeader(String key, Header header)	Adds the given header to this Components' map of headers with the given string as its key.
Components	Components.addLink(String key, Link link)	Adds the given link to this Components' map of links with the given string as its key.
Components	Components.addParameter(String key, Parameter parameter)	Adds the given parameter to this Components' map of parameters with the given string as its key.
Components	Components.addPathItem(String name, PathItem pathItem)	Adds a path item.
Components	Components.addRequestBody(String key, RequestBody requestBody)	Adds the given request body to this Components' map of request bodies with the given string as its key.
Components	Components.addResponse(String key, APIResponse response)	Adds the given response to this Components' map of responses with the given string as its key.
Components	Components.addSchema(String key, Schema schema)	Adds the given schema to this Components' list of schemas with the given string as its key.
Components	Components.addSecurityScheme(String key, SecurityScheme securityScheme)	Adds the given security scheme to this Components' map of security schemes with the given string as its key.
default Components	Components.callbacks(Map<String,Callback> callbacks)	Sets this Components' callbacks property to the given Map containing keys and reusable callback objects.
default Components	Components.examples(Map<String,Example> examples)	Sets this Components' examples property to the given Map containing keys and reusable example objects.
Components	OpenAPI.getComponents()	Returns the components property from an OpenAPI instance.
default Components	Components.headers(Map<String,Header> headers)	Sets this Components' headers property to the given Map containing keys and reusable header objects.
default Components	Components.links(Map<String,Link> links)	Sets this Components' links property to the given Map containing keys and reusable link objects.
default Components	Components.parameters(Map<String,Parameter> parameters)	Sets this Components' parameters property to the given Map containing keys and reusable parameter objects.
default Components	Components.pathItems(Map<String,PathItem> pathItems)	Sets the pathItems property of this Components instance.
default Components	Components.requestBodies(Map<String,RequestBody> requestBodies)	Sets this Components' requestBodies property to the given Map containing keys and reusable request body objects.
default Components	Components.responses(Map<String,APIResponse> responses)	Sets this Components' responses property to the given Map containing keys and reusable response objects.
default Components	Components.schemas(Map<String,Schema> schemas)	Sets this Components' schemas property to the given Map containing keys and reusable schemas.
default Components	Components.securitySchemes(Map<String,SecurityScheme> securitySchemes)	Sets this Components' securitySchemes property to the given Map containing keys and reusable security scheme objects.

Methods in org.eclipse.microprofile.openapi.models with parameters of type Components

Modifier and Type	Method	Description
default OpenAPI	OpenAPI.components(Components components)	Sets this OpenAPI instance's components property to the given components.
void	OpenAPI.setComponents(Components components)	Sets this OpenAPI instance's components property to the given components.