org.eclipse.microprofile.openapi.models.Components Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of microprofile-openapi-api Show documentation
Show all versions of microprofile-openapi-api Show documentation
MicroProfile OpenAPI API :: API
/**
* Copyright (c) 2017 Contributors to the Eclipse Foundation
* Copyright 2017 SmartBear Software
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.eclipse.microprofile.openapi.models;
import java.util.Map;
import org.eclipse.microprofile.openapi.models.callbacks.Callback;
import org.eclipse.microprofile.openapi.models.examples.Example;
import org.eclipse.microprofile.openapi.models.headers.Header;
import org.eclipse.microprofile.openapi.models.links.Link;
import org.eclipse.microprofile.openapi.models.media.Schema;
import org.eclipse.microprofile.openapi.models.parameters.Parameter;
import org.eclipse.microprofile.openapi.models.parameters.RequestBody;
import org.eclipse.microprofile.openapi.models.responses.APIResponse;
import org.eclipse.microprofile.openapi.models.security.SecurityScheme;
/**
* Components
*
* Holds a set of reusable objects for different aspects of the API specification. All objects defined within this
* object will have no effect on the API unless they are explicitly referenced from properties outside the components
* object.
*
* All the fields are indexed by keys that must match the regular expression: ^[a-zA-Z0-9\.\-_]+$.
*
* Key Examples:
*
* - User
* - User_1
* - User_Name
* - user-name
* - my.org.User
*
*
* @see OpenAPI
* Specification Components Object
*/
public interface Components extends Constructible, Extensible {
/**
* Returns the schemas property from a Components instance.
*
* @return a copy Map (potentially immutable) containing the keys and the reusable schemas for this OpenAPI document
**/
Map getSchemas();
/**
* Sets this Components' schemas property to the given Map containing keys and reusable schema objects.
*
* @param schemas
* a Map containing keys and reusable schema objects
*/
void setSchemas(Map schemas);
/**
* Sets this Components' schemas property to the given Map containing keys and reusable schemas.
*
* @param schemas
* a Map containing keys and reusable schemas
* @return the current Components object
*/
default Components schemas(Map schemas) {
setSchemas(schemas);
return this;
}
/**
* Adds the given schema to this Components' list of schemas with the given string as its key.
*
* @param key
* a key conforming to the format required for this object
* @param schema
* a reusable schema object. null values will be rejected (implementation will throw an exception) or
* ignored.
* @return the current Components object
*/
Components addSchema(String key, Schema schema);
/**
* Removes the given schema to this Components' list of schemas with the given string as its key.
*
* @param key
* a key conforming to the format required for this object
*/
void removeSchema(String key);
/**
* Returns the responses property from a Components instance.
*
* @return a copy Map (potentially immutable) containing the keys and the reusable responses from API operations for
* this OpenAPI document
**/
Map getResponses();
/**
* Sets this Components' responses property to the given Map containing keys and reusable response objects.
*
* @param responses
* a Map containing keys and reusable response objects
*/
void setResponses(Map responses);
/**
* Sets this Components' responses property to the given Map containing keys and reusable response objects.
*
* @param responses
* a Map containing keys and reusable response objects
* @return the current Components object
*/
default Components responses(Map responses) {
setResponses(responses);
return this;
}
/**
* Adds the given response to this Components' map of responses with the given string as its key.
*
* @param key
* a key conforming to the format required for this object
* @param response
* a reusable response object. null values will be rejected (implementation will throw an exception) or
* ignored.
* @return the current Components object
*/
Components addResponse(String key, APIResponse response);
/**
* Removes the given response to this Components' map of responses with the given string as its key.
*
* @param key
* a key conforming to the format required for this object
*/
void removeResponse(String key);
/**
* Returns the parameters property from a Components instance.
*
* @return a copy Map (potentially immutable) containing the keys and the reusable parameters of API operations for
* this OpenAPI document
**/
Map getParameters();
/**
* Sets this Components' parameters property to the given Map containing keys and reusable parameter objects.
*
* @param parameters
* a Map containing keys and reusable parameter objects
*/
void setParameters(Map parameters);
/**
* Sets this Components' parameters property to the given Map containing keys and reusable parameter objects.
*
* @param parameters
* a Map containing keys and reusable parameter objects
* @return the current Components object
*/
default Components parameters(Map parameters) {
setParameters(parameters);
return this;
}
/**
* Adds the given parameter to this Components' map of parameters with the given string as its key.
*
* @param key
* a key conforming to the format required for this object
* @param parameter
* a reusable parameter object. null values will be rejected (implementation will throw an exception) or
* ignored.
* @return the current Components object
*/
Components addParameter(String key, Parameter parameter);
/**
* Removes the given parameter to this Components' map of parameters with the given string as its key.
*
* @param key
* a key conforming to the format required for this object
*/
void removeParameter(String key);
/**
* Returns the examples property from a Components instance.
*
* @return a copy Map (potentially immutable) containing the keys and the reusable examples for this OpenAPI
* document
**/
Map getExamples();
/**
* Sets this Components' examples property to the given Map containing keys and reusable example objects.
*
* @param examples
* a Map containing keys and reusable example objects
*/
void setExamples(Map examples);
/**
* Sets this Components' examples property to the given Map containing keys and reusable example objects.
*
* @param examples
* a Map containing keys and reusable example objects
* @return the current Components object
*/
default Components examples(Map examples) {
setExamples(examples);
return this;
}
/**
* Adds the given example to this Components' map of examples with the given string as its key.
*
* @param key
* a key conforming to the format required for this object
* @param example
* a reusable example object. null values will be rejected (implementation will throw an exception) or
* ignored.
* @return the current Components object
*/
Components addExample(String key, Example example);
/**
* Removes the given example to this Components' map of examples with the given string as its key.
*
* @param key
* a key conforming to the format required for this object
*/
void removeExample(String key);
/**
* Returns the requestBodies property from a Components instance.
*
* @return a copy Map (potentially immutable) containing the keys and the reusable request bodies for this OpenAPI
* document
**/
Map getRequestBodies();
/**
* Sets this Components' requestBodies property to the given Map containing keys and reusable request body objects.
*
* @param requestBodies
* a Map containing the keys and reusable request body objects
**/
void setRequestBodies(Map requestBodies);
/**
* Sets this Components' requestBodies property to the given Map containing keys and reusable request body objects.
*
* @param requestBodies
* a Map containing the keys and reusable request body objects
* @return the current Components object
*/
default Components requestBodies(Map requestBodies) {
setRequestBodies(requestBodies);
return this;
}
/**
* Adds the given request body to this Components' map of request bodies with the given string as its key.
*
* @param key
* a key conforming to the format required for this object
* @param requestBody
* a reusable request body object. null values will be rejected (implementation will throw an exception)
* or ignored.
* @return the current Components object
*/
Components addRequestBody(String key, RequestBody requestBody);
/**
* Removes the given request body to this Components' map of request bodies with the given string as its key.
*
* @param key
* a key conforming to the format required for this object
*/
void removeRequestBody(String key);
/**
* Returns the headers property from a Components instance.
*
* @return a copy Map (potentially immutable) containing the keys and the reusable headers for this OpenAPI document
**/
Map getHeaders();
/**
* Sets this Components' headers property to the given Map containing keys and reusable header objects.
*
* @param headers
* a Map containing the keys and reusable header objects
*/
void setHeaders(Map headers);
/**
* Sets this Components' headers property to the given Map containing keys and reusable header objects.
*
* @param headers
* a Map containing the keys and reusable header objects
* @return the current Components object
*/
default Components headers(Map headers) {
setHeaders(headers);
return this;
}
/**
* Adds the given header to this Components' map of headers with the given string as its key.
*
* @param key
* a key conforming to the format required for this object
* @param header
* a reusable header object. null values will be rejected (implementation will throw an exception) or
* ignored.
* @return the current Components object
*/
Components addHeader(String key, Header header);
/**
* Removes the given header to this Components' map of headers with the given string as its key.
*
* @param key
* a key conforming to the format required for this object
*/
void removeHeader(String key);
/**
* Returns the securitySchemes property from a Components instance.
*
* @return a copy Map (potentially immutable) containing the keys and the reusable security schemes for this OpenAPI
* document
**/
Map getSecuritySchemes();
/**
* Sets this Components' securitySchemes property to the given Map containing keys and reusable security scheme
* objects.
*
* @param securitySchemes
* a Map containing the keys and reusable security scheme objects
*/
void setSecuritySchemes(Map securitySchemes);
/**
* Sets this Components' securitySchemes property to the given Map containing keys and reusable security scheme
* objects.
*
* @param securitySchemes
* a Map containing the keys and reusable security scheme objects
* @return the current Components object
*/
default Components securitySchemes(Map securitySchemes) {
setSecuritySchemes(securitySchemes);
return this;
}
/**
* Adds the given security scheme to this Components' map of security schemes with the given string as its key.
*
* @param key
* a key conforming to the format required for this object
* @param securityScheme
* a reusable security scheme object. null values will be rejected (implementation will throw an
* exception) or ignored.
* @return the current Components object
*/
Components addSecurityScheme(String key, SecurityScheme securityScheme);
/**
* Removes the given security scheme to this Components' map of security schemes with the given string as its key.
*
* @param key
* a key conforming to the format required for this object
*/
void removeSecurityScheme(String key);
/**
* Returns the links property from a Components instance.
*
* @return a copy Map (potentially immutable) containing the keys and the reusable links for this OpenAPI document
**/
Map getLinks();
/**
* Sets this Components' links property to the given Map containing keys and reusable link objects.
*
* @param links
* a Map containing the keys and reusable link objects
*/
void setLinks(Map links);
/**
* Sets this Components' links property to the given Map containing keys and reusable link objects.
*
* @param links
* a Map containing the keys and reusable link objects
* @return the current Components object
*/
default Components links(Map links) {
setLinks(links);
return this;
}
/**
* Adds the given link to this Components' map of links with the given string as its key.
*
* @param key
* a key conforming to the format required for this object
* @param link
* a reusable link object. null values will be rejected (implementation will throw an exception) or
* ignored.
* @return the current Components object
*/
Components addLink(String key, Link link);
/**
* Removes the given link to this Components' map of links with the given string as its key.
*
* @param key
* a key conforming to the format required for this object
*/
void removeLink(String key);
/**
* Returns the callbacks property from a Components instance.
*
* @return a copy Map (potentially immutable) containing the keys and the reusable callbacks for this OpenAPI
* document
**/
Map getCallbacks();
/**
* Sets this Components' callbacks property to the given Map containing keys and reusable callback objects.
*
* @param callbacks
* a Map containing the keys and reusable callback objects
*/
void setCallbacks(Map callbacks);
/**
* Sets this Components' callbacks property to the given Map containing keys and reusable callback objects.
*
* @param callbacks
* a Map containing the keys and reusable callback objects
* @return the current Components object
*/
default Components callbacks(Map callbacks) {
setCallbacks(callbacks);
return this;
}
/**
* Adds the given callback to this Components' map of callbacks with the given string as its key.
*
* @param key
* a key conforming to the format required for this object
* @param callback
* a reusable callback object. null values will be rejected (implementation will throw an exception) or
* ignored.
* @return the current Components object
*/
Components addCallback(String key, Callback callback);
/**
* Removes the given callback to this Components' map of callbacks with the given string as its key.
*
* @param key
* a key conforming to the format required for this object
*/
void removeCallback(String key);
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy