Index (MicroProfile OpenAPI API)

A B C D E F G H I L M N O P Q R S T U V W X
All Classes All Packages

A

addAllOf(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Adds the given Schema to the list of schemas used by the allOf property.
addAnyOf(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Adds the given Schema to the list of schemas used by the anyOf property.
addAPIResponse(String, APIResponse) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponses: Adds an APIResponse in the format of the name as a key and the item as the value to APIResponses map
addCallback(String, Callback) - Method in interface org.eclipse.microprofile.openapi.models.Components: Adds the given callback to this Components' map of callbacks with the given string as its key.
addCallback(String, Callback) - Method in interface org.eclipse.microprofile.openapi.models.Operation: Adds the given callback item to this Operation's map of callbacks.
addEncoding(String, Encoding) - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType: Adds an Encoding item to the encoding property of a MediaType instance.
addEnumeration(Object) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Adds an item of the appropriate type to the enumerated list of values allowed.
addEnumeration(String) - Method in interface org.eclipse.microprofile.openapi.models.servers.ServerVariable: This method adds a string item to enumeration list of a ServerVariable instance and returns the instance.
addExample(String, Example) - Method in interface org.eclipse.microprofile.openapi.models.Components: Adds the given example to this Components' map of examples with the given string as its key.
addExample(String, Example) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header: Adds an example of the header using the specified key to this Header instance.
addExample(String, Example) - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType: Adds an example item to the examples map of a MediaType instance.
addExample(String, Example) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter: Adds an example of the parameter using the specified key.
addExtension(String, Object) - Method in interface org.eclipse.microprofile.openapi.models.Extensible: Adds the given object to this Extensible's map of extensions, with the given name as its key.
addHeader(String, Header) - Method in interface org.eclipse.microprofile.openapi.models.Components: Adds the given header to this Components' map of headers with the given string as its key.
addHeader(String, Header) - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding: Adds the given header to this Encoding' list of headers with the given string as its key.
addHeader(String, Header) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponse: Adds the given Header to this ApiResponse instance's map of Headers with the given name and return this instance of ApiResponse.
additionalProperties() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Schema: Provides a Java class as implementation for additional properties that may be present in instances of this schema.
additionalPropertiesBoolean(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the value of "additionalProperties" to either True or False.
additionalPropertiesSchema(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the Schema which defines additional properties not defined by "properties" or "patternProperties".
addLink(String, Link) - Method in interface org.eclipse.microprofile.openapi.models.Components: Adds the given link to this Components' map of links with the given string as its key.
addLink(String, Link) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponse: Adds a link to this instance of ApiResponse using the given name and Link, and returns this ApiResponse instance.
addMapping(String, String) - Method in interface org.eclipse.microprofile.openapi.models.media.Discriminator: Maps the given name to the given value and stores it in this Discriminator's mapping property.
addMediaType(String, MediaType) - Method in interface org.eclipse.microprofile.openapi.models.media.Content: Adds the MediaType for this Content, where the key is the name of the MediaType and the value is the object that describes the content passed into or returned from an operation.
addOneOf(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Adds the given Schema to the list of schemas used by the oneOf property.
addParameter(String, Object) - Method in interface org.eclipse.microprofile.openapi.models.links.Link: Add a new parameter to the parameters property of this instance of Link.
addParameter(String, Parameter) - Method in interface org.eclipse.microprofile.openapi.models.Components: Adds the given parameter to this Components' map of parameters with the given string as its key.
addParameter(Parameter) - Method in interface org.eclipse.microprofile.openapi.models.Operation: Adds the given parameter item to this Operation's list of parameters.
addParameter(Parameter) - Method in interface org.eclipse.microprofile.openapi.models.PathItem: Adds the given parameter to this PathItem's list of parameters.
addPathItem(String, PathItem) - Method in interface org.eclipse.microprofile.openapi.models.callbacks.Callback: Adds the given PathItem to this Callback's list of PathItems using the string as its key.
addPathItem(String, PathItem) - Method in interface org.eclipse.microprofile.openapi.models.Paths: Adds the given path item to this Paths and return this instance of Paths
addProperty(String, Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Adds a Schema property of the provided name using the given schema.
addRequestBody(String, RequestBody) - Method in interface org.eclipse.microprofile.openapi.models.Components: Adds the given request body to this Components' map of request bodies with the given string as its key.
addRequired(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Adds the name of an item to the list of fields required in objects defined by this Schema.
addResponse(String, APIResponse) - Method in interface org.eclipse.microprofile.openapi.models.Components: Adds the given response to this Components' map of responses with the given string as its key.
addSchema(String, Schema) - Method in interface org.eclipse.microprofile.openapi.models.Components: Adds the given schema to this Components' list of schemas with the given string as its key.
addScheme(String) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityRequirement: Adds a security scheme to the SecurityRequirement instance based on the scheme name.
addScheme(String, String) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityRequirement: Adds a security scheme to the SecurityRequirement instance based on the scheme name and required scope (optional) provided.
addScheme(String, List<String>) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityRequirement: Adds a security scheme to the SecurityRequirement instance based on the scheme name and required scopes (optional) provided.
addScope(String, String) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlow: Adds name of an existing scope object and item parameters to scopes as a key-value pair in a map.
addSecurityRequirement(SecurityRequirement) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI: Adds the given security requirement to this OpenAPI instance's list of security requirements.
addSecurityRequirement(SecurityRequirement) - Method in interface org.eclipse.microprofile.openapi.models.Operation: Adds the given security requirement item to this Operation's list of security mechanisms.
addSecurityScheme(String, SecurityScheme) - Method in interface org.eclipse.microprofile.openapi.models.Components: Adds the given security scheme to this Components' map of security schemes with the given string as its key.
addServer(Server) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI: Adds the given server to this OpenAPI instance's list of servers.
addServer(Server) - Method in interface org.eclipse.microprofile.openapi.models.Operation: Adds the given server to this Operation's list of servers.
addServer(Server) - Method in interface org.eclipse.microprofile.openapi.models.PathItem: Adds the given server to this PathItem's list of servers.
addTag(String) - Method in interface org.eclipse.microprofile.openapi.models.Operation: Adds the given tag to this Operation's list of tags.
addTag(Tag) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI: Adds the given tag to this OpenAPI instance's list of tags.
addVariable(String, ServerVariable) - Method in interface org.eclipse.microprofile.openapi.models.servers.Server: Adds the given server variable item to the Server's map of variables.
allOf() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Schema: Provides an array of java class implementations which can be used to describe multiple acceptable schemas.
allOf() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.SchemaProperty: Provides an array of java class implementations which can be used to describe multiple acceptable schemas.
allOf(List<Schema>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the schemas used by the allOf property of this Schema.
allowEmptyValue() - Method in annotation type org.eclipse.microprofile.openapi.annotations.headers.Header: When true, allows sending an empty value.
allowEmptyValue() - Method in annotation type org.eclipse.microprofile.openapi.annotations.parameters.Parameter: When true, allows sending an empty value.
allowEmptyValue(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header: Sets this Header's allowEmptyValue property to the given value.
allowEmptyValue(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter: Sets the allowEmptyValue property of a Parameter instance to the given value.
allowReserved() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Encoding: Determines whether the encoding instance value SHOULD allow reserved characters, as defined by RFC3986 to be included without percent-encoding.
allowReserved() - Method in annotation type org.eclipse.microprofile.openapi.annotations.parameters.Parameter: Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986.
allowReserved(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding: AllowReserved determines whether the parameter value SHOULD allow reserved characters to be encoded without percent-encoding.
allowReserved(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter: Sets the allowReserved property of a Parameter instance to the given value.
anyOf() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Schema: Provides an array of java class implementations which can be used to describe multiple acceptable schemas.
anyOf() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.SchemaProperty: Provides an array of java class implementations which can be used to describe multiple acceptable schemas.
anyOf(List<Schema>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the schemas used by the anyOf property of this Schema.
APIKEY - org.eclipse.microprofile.openapi.annotations.enums.SecuritySchemeType
APIKEY - org.eclipse.microprofile.openapi.models.security.SecurityScheme.Type
apiKeyName() - Method in annotation type org.eclipse.microprofile.openapi.annotations.security.SecurityScheme: Applies to and is REQUIRED for SecurityScheme of apiKey type.
APIResponse - Interface in org.eclipse.microprofile.openapi.models.responses: This interface represents a single response from an API Operation, including design-time, static links to operations based on the response.
APIResponse - Annotation Type in org.eclipse.microprofile.openapi.annotations.responses: The APIResponse annotation corresponds to the OpenAPI Response model object which describes a single response from an API Operation, including design-time, static links to operations based on the response.
APIResponses - Interface in org.eclipse.microprofile.openapi.models.responses: This interface represents the container for the expected responses of an operation.
APIResponses - Annotation Type in org.eclipse.microprofile.openapi.annotations.responses: The ApiResponses annotation is a container for @ApiResponse annotations.
APIResponseSchema - Annotation Type in org.eclipse.microprofile.openapi.annotations.responses: The APIResponseSchema annotation corresponds to an individual schema in the OpenAPI Response model object which describes a single response from an API Operation.
ARRAY - org.eclipse.microprofile.openapi.annotations.enums.SchemaType
ARRAY - org.eclipse.microprofile.openapi.models.media.Schema.SchemaType
attribute(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.XML: This method sets the attribute property of XML instance to the given Boolean argument and returns the modified instance.
authorizationCode() - Method in annotation type org.eclipse.microprofile.openapi.annotations.security.OAuthFlows: Configuration for the OAuth Authorization Code flow.
authorizationCode(OAuthFlow) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlows: OAuth Authorization Code flow; previously called accessCode in OpenAPI 2.0
authorizationUrl() - Method in annotation type org.eclipse.microprofile.openapi.annotations.security.OAuthFlow: The authorization URL to be used for this flow.
authorizationUrl(String) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlow: The authorization URL to be used for this flow.

B

bearerFormat() - Method in annotation type org.eclipse.microprofile.openapi.annotations.security.SecurityScheme: Applies to http ("bearer") type.
bearerFormat(String) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme: bearerFormat is intended as a hint to the client to identify how the bearer token is formatted.
BOOLEAN - org.eclipse.microprofile.openapi.annotations.enums.SchemaType
BOOLEAN - org.eclipse.microprofile.openapi.models.media.Schema.SchemaType
buildModel() - Method in interface org.eclipse.microprofile.openapi.OASModelReader: This method is called by the vendor's OpenAPI processing framework.

C

Callback - Interface in org.eclipse.microprofile.openapi.models.callbacks: Callback
Callback - Annotation Type in org.eclipse.microprofile.openapi.annotations.callbacks: This object represents a callback URL that will be invoked.
CallbackOperation - Annotation Type in org.eclipse.microprofile.openapi.annotations.callbacks: Describes a single API callback operation.
callbacks() - Method in annotation type org.eclipse.microprofile.openapi.annotations.Components: An object to hold reusable Callback Objects.
callbacks(Map<String, Callback>) - Method in interface org.eclipse.microprofile.openapi.models.Components: Sets this Components' callbacks property to the given Map containing keys and reusable callback objects.
callbacks(Map<String, Callback>) - Method in interface org.eclipse.microprofile.openapi.models.Operation: Sets this Operation's callbacks property to the given map.
Callbacks - Annotation Type in org.eclipse.microprofile.openapi.annotations.callbacks: This object represents an array of Callback URLs that can be invoked.
callbackUrlExpression() - Method in annotation type org.eclipse.microprofile.openapi.annotations.callbacks.Callback: An absolute URL which defines the destination which will be called with the supplied operation definition.
clientCredentials() - Method in annotation type org.eclipse.microprofile.openapi.annotations.security.OAuthFlows: Configuration for the OAuth Client Credentials flow.
clientCredentials(OAuthFlow) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlows: OAuth Client Credential flow; previously called application in OpenAPI 2.0
components() - Method in annotation type org.eclipse.microprofile.openapi.annotations.OpenAPIDefinition: An element to hold a set of reusable objects for different aspects of the OpenAPI Specification (OAS).
components(Components) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI: Sets this OpenAPI instance's components property to the given components.
Components - Interface in org.eclipse.microprofile.openapi.models: Components
Components - Annotation Type in org.eclipse.microprofile.openapi.annotations: Describes the Components object that holds various reusable objects for different aspects of the OpenAPI Specification (OAS).
Constructible - Interface in org.eclipse.microprofile.openapi.models: Marker interface for OpenAPI model objects that can be constructed by the OASFactory.
contact() - Method in annotation type org.eclipse.microprofile.openapi.annotations.info.Info: The contact information for the exposed API.
contact(Contact) - Method in interface org.eclipse.microprofile.openapi.models.info.Info: Sets this Info instance's contact information for the exposed API and returns this instance of Info.
Contact - Interface in org.eclipse.microprofile.openapi.models.info: This interface represents the Contact information for the exposed API.
Contact - Annotation Type in org.eclipse.microprofile.openapi.annotations.info: Contact information for the exposed API.
content() - Method in annotation type org.eclipse.microprofile.openapi.annotations.parameters.Parameter: The representation of this parameter, for different media types.
content() - Method in annotation type org.eclipse.microprofile.openapi.annotations.parameters.RequestBody: The content of the request body.
content() - Method in annotation type org.eclipse.microprofile.openapi.annotations.responses.APIResponse: An array containing descriptions of potential response payloads for different media types.
content(Content) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header: Sets this Header's content property to the given object.
content(Content) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter: Sets the content property of a Parameter instance to the given object.
content(Content) - Method in interface org.eclipse.microprofile.openapi.models.parameters.RequestBody: Sets the content of this instance of RequestBody, where the keys in content are media type names and the values describe it.
content(Content) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponse: Sets the map containing descriptions of potential response payload for this instance of ApiResponse and returns this ApiResponse instance.
Content - Interface in org.eclipse.microprofile.openapi.models.media: Content
Content - Annotation Type in org.eclipse.microprofile.openapi.annotations.media: This object provides schema and examples for a particular media type.
contentType() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Encoding: The Content-Type for encoding a specific property.
contentType(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding: The Content-Type for encoding a specific property.
COOKIE - org.eclipse.microprofile.openapi.annotations.enums.ParameterIn
COOKIE - org.eclipse.microprofile.openapi.annotations.enums.SecuritySchemeIn
COOKIE - org.eclipse.microprofile.openapi.models.parameters.Parameter.In
COOKIE - org.eclipse.microprofile.openapi.models.security.SecurityScheme.In
createAPIResponse() - Static method in class org.eclipse.microprofile.openapi.OASFactory: This method creates a new APIResponse instance.
createAPIResponses() - Static method in class org.eclipse.microprofile.openapi.OASFactory: This method creates a new APIResponses instance.
createCallback() - Static method in class org.eclipse.microprofile.openapi.OASFactory: This method creates a new Callback instance.
createComponents() - Static method in class org.eclipse.microprofile.openapi.OASFactory: This method creates a new Components instance.
createContact() - Static method in class org.eclipse.microprofile.openapi.OASFactory: This method creates a new Contact instance.
createContent() - Static method in class org.eclipse.microprofile.openapi.OASFactory: This method creates a new Content instance.
createDiscriminator() - Static method in class org.eclipse.microprofile.openapi.OASFactory: This method creates a new Discriminator instance.
createEncoding() - Static method in class org.eclipse.microprofile.openapi.OASFactory: This method creates a new Encoding instance.
createExample() - Static method in class org.eclipse.microprofile.openapi.OASFactory: This method creates a new Example instance.
createExternalDocumentation() - Static method in class org.eclipse.microprofile.openapi.OASFactory: This method creates a new ExternalDocumentation instance.
createHeader() - Static method in class org.eclipse.microprofile.openapi.OASFactory: This method creates a new Header instance.
createInfo() - Static method in class org.eclipse.microprofile.openapi.OASFactory: This method creates a new Info instance.
createLicense() - Static method in class org.eclipse.microprofile.openapi.OASFactory: This method creates a new License instance.
createLink() - Static method in class org.eclipse.microprofile.openapi.OASFactory: This method creates a new Link instance.
createMediaType() - Static method in class org.eclipse.microprofile.openapi.OASFactory: This method creates a new MediaType instance.
createOAuthFlow() - Static method in class org.eclipse.microprofile.openapi.OASFactory: This method creates a new OAuthFlow instance.
createOAuthFlows() - Static method in class org.eclipse.microprofile.openapi.OASFactory: This method creates a new OAuthFlows instance.
createObject(Class<T>) - Static method in class org.eclipse.microprofile.openapi.OASFactory: This method creates a new instance of a constructible element from the OpenAPI model tree.
createObject(Class<T>) - Method in class org.eclipse.microprofile.openapi.spi.OASFactoryResolver: Create a new instance of a constructible element from the OpenAPI model tree.
createOpenAPI() - Static method in class org.eclipse.microprofile.openapi.OASFactory: This method creates a new OpenAPI instance.
createOperation() - Static method in class org.eclipse.microprofile.openapi.OASFactory: This method creates a new Operation instance.
createParameter() - Static method in class org.eclipse.microprofile.openapi.OASFactory: This method creates a new Parameter instance.
createPathItem() - Static method in class org.eclipse.microprofile.openapi.OASFactory: This method creates a new PathItem instance.
createPaths() - Static method in class org.eclipse.microprofile.openapi.OASFactory: This method creates a new Paths instance.
createRequestBody() - Static method in class org.eclipse.microprofile.openapi.OASFactory: This method creates a new RequestBody instance.
createSchema() - Static method in class org.eclipse.microprofile.openapi.OASFactory: This method creates a new Schema instance.
createSecurityRequirement() - Static method in class org.eclipse.microprofile.openapi.OASFactory: This method creates a new SecurityRequirement instance.
createSecurityScheme() - Static method in class org.eclipse.microprofile.openapi.OASFactory: This method creates a new SecurityScheme instance.
createServer() - Static method in class org.eclipse.microprofile.openapi.OASFactory: This method creates a new Server instance.
createServerVariable() - Static method in class org.eclipse.microprofile.openapi.OASFactory: This method creates a new ServerVariable instance.
createTag() - Static method in class org.eclipse.microprofile.openapi.OASFactory: This method creates a new Tag instance.
createXML() - Static method in class org.eclipse.microprofile.openapi.OASFactory: This method creates a new XML instance.

D

DEEP_OBJECT - org.eclipse.microprofile.openapi.models.media.Encoding.Style
DEEPOBJECT - org.eclipse.microprofile.openapi.annotations.enums.ParameterStyle
DEEPOBJECT - org.eclipse.microprofile.openapi.models.parameters.Parameter.Style
DEFAULT - org.eclipse.microprofile.openapi.annotations.enums.Explode
DEFAULT - org.eclipse.microprofile.openapi.annotations.enums.ParameterIn
DEFAULT - org.eclipse.microprofile.openapi.annotations.enums.ParameterStyle
DEFAULT - org.eclipse.microprofile.openapi.annotations.enums.SchemaType
DEFAULT - org.eclipse.microprofile.openapi.annotations.enums.SecuritySchemeIn
DEFAULT - org.eclipse.microprofile.openapi.annotations.enums.SecuritySchemeType
DEFAULT - Static variable in interface org.eclipse.microprofile.openapi.models.responses.APIResponses
defaultValue() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Schema: Provides a default value.
defaultValue() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.SchemaProperty: Provides a default value.
defaultValue() - Method in annotation type org.eclipse.microprofile.openapi.annotations.servers.ServerVariable: The default value of this server variable.
defaultValue(Object) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Set the default value property of this Schema instance to the value given.
defaultValue(String) - Method in interface org.eclipse.microprofile.openapi.models.servers.ServerVariable: The default value to use for substitution, and to send, if an alternate value is not supplied.
defaultValue(APIResponse) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponses: Sets the default documentation of responses for this instance of ApiResponses and return this instance of ApiResponses.
DELETE - org.eclipse.microprofile.openapi.models.PathItem.HttpMethod
DELETE(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem: Sets this PathItem's delete property to the given operation.
deprecated() - Method in annotation type org.eclipse.microprofile.openapi.annotations.headers.Header: Specifies that a header is deprecated and should be transitioned out of usage.
deprecated() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Schema: Specifies that a schema is deprecated and SHOULD be transitioned out of usage.
deprecated() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.SchemaProperty: Specifies that a schema is deprecated and SHOULD be transitioned out of usage.
deprecated() - Method in annotation type org.eclipse.microprofile.openapi.annotations.Operation: Allows an operation to be marked as deprecated.
deprecated() - Method in annotation type org.eclipse.microprofile.openapi.annotations.parameters.Parameter: Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.
deprecated(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header: Sets this Header's deprecated property to the given value.
deprecated(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the deprecated property of this Schema.
deprecated(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.Operation: Sets this Operation's deprecated property to the given value.
deprecated(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter: Sets the deprecated property of a Parameter instance to the given value.
description() - Method in annotation type org.eclipse.microprofile.openapi.annotations.callbacks.CallbackOperation: A verbose description of the callback operation behavior.
description() - Method in annotation type org.eclipse.microprofile.openapi.annotations.ExternalDocumentation: A short description of the target documentation.
description() - Method in annotation type org.eclipse.microprofile.openapi.annotations.headers.Header: Additional description data to provide on the purpose of the header
description() - Method in annotation type org.eclipse.microprofile.openapi.annotations.info.Info: A short description of the application.
description() - Method in annotation type org.eclipse.microprofile.openapi.annotations.links.Link: A description of the link.
description() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.ExampleObject: Long description for the example.
description() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Schema: A description of the schema.
description() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.SchemaProperty: A description of the schema.
description() - Method in annotation type org.eclipse.microprofile.openapi.annotations.Operation: A verbose description of the operation behaviour.
description() - Method in annotation type org.eclipse.microprofile.openapi.annotations.parameters.Parameter: A brief description of the parameter.
description() - Method in annotation type org.eclipse.microprofile.openapi.annotations.parameters.RequestBody: A brief description of the request body.
description() - Method in annotation type org.eclipse.microprofile.openapi.annotations.responses.APIResponse: A short description of the response.
description() - Method in annotation type org.eclipse.microprofile.openapi.annotations.security.OAuthScope: Short description of the scope.
description() - Method in annotation type org.eclipse.microprofile.openapi.annotations.security.SecurityScheme: A short description for security scheme.
description() - Method in annotation type org.eclipse.microprofile.openapi.annotations.servers.Server: An optional string describing the host designated by the URL.
description() - Method in annotation type org.eclipse.microprofile.openapi.annotations.servers.ServerVariable: An optional description for the server variable.
description() - Method in annotation type org.eclipse.microprofile.openapi.annotations.tags.Tag: A short description for this tag.
description(String) - Method in interface org.eclipse.microprofile.openapi.models.examples.Example: Sets this Example's description property to the given string.
description(String) - Method in interface org.eclipse.microprofile.openapi.models.ExternalDocumentation: Sets this ExternalDocumentation's description property to the given string.
description(String) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header: Sets this Header's description property to the given string.
description(String) - Method in interface org.eclipse.microprofile.openapi.models.info.Info: Sets this Info instance's description for the application to the given description and returns this instance of Info.
description(String) - Method in interface org.eclipse.microprofile.openapi.models.links.Link: Sets this Link's description property to the given string.
description(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the description property of this Schema to the given string.
description(String) - Method in interface org.eclipse.microprofile.openapi.models.Operation: Sets this Operation's description property to the given string.
description(String) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter: Sets the description property of a Parameter instance to the given string.
description(String) - Method in interface org.eclipse.microprofile.openapi.models.parameters.RequestBody: Sets the description of this RequestBody and return this instance of RequestBody
description(String) - Method in interface org.eclipse.microprofile.openapi.models.PathItem: Sets this PathItem's description property to the given string.
description(String) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponse: Sets the description of this instance of ApiResponse and returns this ApiResponse instance.
description(String) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme: A short description for security schema.
description(String) - Method in interface org.eclipse.microprofile.openapi.models.servers.Server: This method sets the description property of a Server instance to the given description parameter and returns the modified instance.
description(String) - Method in interface org.eclipse.microprofile.openapi.models.servers.ServerVariable: This method sets the description property of ServerVariable instance to the given description argument and returns the modeified instance.
description(String) - Method in interface org.eclipse.microprofile.openapi.models.tags.Tag: Sets the description property of a Tag instance to the given string.
discriminator(Discriminator) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the discriminator property of this Schema instance to the given object.
Discriminator - Interface in org.eclipse.microprofile.openapi.models.media: Discriminator
discriminatorMapping() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Schema: An array of discriminator mappings.
discriminatorMapping() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.SchemaProperty: An array of discriminator mappings.
DiscriminatorMapping - Annotation Type in org.eclipse.microprofile.openapi.annotations.media: This object maps payload values to a particular Schema.
discriminatorProperty() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Schema: Provides a discriminator property value.
discriminatorProperty() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.SchemaProperty: Provides a discriminator property value.

E

email() - Method in annotation type org.eclipse.microprofile.openapi.annotations.info.Contact: The email address of the contact person/organization.
email(String) - Method in interface org.eclipse.microprofile.openapi.models.info.Contact: Sets this Contact instance's contact email to the given email and returns this instance of Contact
encoding() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Content: An array of encoding corresponding to a map of property name and its encoding information in MediaType model.
encoding(Map<String, Encoding>) - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType: Sets encoding property of a MediaType instance to the given map object.
Encoding - Interface in org.eclipse.microprofile.openapi.models.media: Encoding
Encoding - Annotation Type in org.eclipse.microprofile.openapi.annotations.media: Single encoding definition to be applied to single Schema Object
Encoding.Style - Enum in org.eclipse.microprofile.openapi.models.media
enumeration() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Schema: Provides a list of enum values.
enumeration() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.SchemaProperty: Provides a list of enum values.
enumeration() - Method in annotation type org.eclipse.microprofile.openapi.annotations.servers.ServerVariable: An array of enum values for this variable.
enumeration(List<Object>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
enumeration(List<String>) - Method in interface org.eclipse.microprofile.openapi.models.servers.ServerVariable: This method sets the enumeration property of ServerVariable instance to the given enumeration argument and returns the modified instance.
example() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Content: A free-form property to include an example of an instance for this content.
example() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Schema: A free-form property to include an example of an instance for this schema.
example() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.SchemaProperty: A free-form property to include an example of an instance for this schema.
example() - Method in annotation type org.eclipse.microprofile.openapi.annotations.parameters.Parameter: Provides an example of the schema.
example(Object) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header: Sets this Header's example property to the given object.
example(Object) - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType: Sets the example property of a MediaType instance to the given value.
example(Object) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the example property of this Schema instance.
example(Object) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter: Sets the example property of a Parameter instance to the given object.
Example - Interface in org.eclipse.microprofile.openapi.models.examples: Example
ExampleObject - Annotation Type in org.eclipse.microprofile.openapi.annotations.media: This object illustrates an example of a particular content
examples() - Method in annotation type org.eclipse.microprofile.openapi.annotations.Components: An object to hold reusable Example Objects.
examples() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Content: An array of examples used to show the use of the associated schema.
examples() - Method in annotation type org.eclipse.microprofile.openapi.annotations.parameters.Parameter: Provides an array examples of the schema.
examples(Map<String, Example>) - Method in interface org.eclipse.microprofile.openapi.models.Components: Sets this Components' examples property to the given Map containing keys and reusable example objects.
examples(Map<String, Example>) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header: Sets the examples property of this Header instance to the given map.
examples(Map<String, Example>) - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType: Sets the examples field of a MediaType instance to the given map object.
examples(Map<String, Example>) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter: Sets the examples property of a Parameter instance to the given value.
exclusiveMaximum() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Schema: If true, makes the maximum value exclusive, or a less-than criteria.
exclusiveMaximum() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.SchemaProperty: If true, makes the maximum value exclusive, or a less-than criteria.
exclusiveMaximum(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the exclusiveMaximum property of this Schema instance to the value given.
exclusiveMinimum() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Schema: If true, makes the minimum value exclusive, or a greater-than criteria.
exclusiveMinimum() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.SchemaProperty: If true, makes the minimum value exclusive, or a greater-than criteria.
exclusiveMinimum(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the exclusiveMinimum property of this Schema instance to the value given.
explode() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Encoding: When explode is set to true, property values of type array or object generate separate parameters for each value of the array, or key-value-pair of the map.
explode() - Method in annotation type org.eclipse.microprofile.openapi.annotations.parameters.Parameter: When this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map.
explode(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header: Sets this Header's explode property to the given value.
explode(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding: When this is true, property values of type array or object generate separate parameters for each value of the array, or key-value-pair of the map.
explode(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter: Sets the explode property of a Parameter instance to the given value.
Explode - Enum in org.eclipse.microprofile.openapi.annotations.enums: Enumeration used to define the value of Explode property.
expression() - Method in annotation type org.eclipse.microprofile.openapi.annotations.links.LinkParameter: A constant or an expression to be evaluated and passed to the linked operation.
Extensible<T extends Extensible<T>> - Interface in org.eclipse.microprofile.openapi.models: The base interface for OpenAPI model objects that can contain extensions.
Extension - Annotation Type in org.eclipse.microprofile.openapi.annotations.extensions: A named extension that should be added to the OpenAPI definition.
extensions() - Method in annotation type org.eclipse.microprofile.openapi.annotations.callbacks.Callback: List of extensions to be added to the Callback model corresponding to the containing annotation.
extensions() - Method in annotation type org.eclipse.microprofile.openapi.annotations.callbacks.CallbackOperation: List of extensions to be added to the Operation model corresponding to the containing annotation.
extensions() - Method in annotation type org.eclipse.microprofile.openapi.annotations.Components: List of extensions to be added to the Components model corresponding to the containing annotation.
extensions() - Method in annotation type org.eclipse.microprofile.openapi.annotations.ExternalDocumentation: List of extensions to be added to the ExternalDocumentation model corresponding to the containing annotation.
extensions() - Method in annotation type org.eclipse.microprofile.openapi.annotations.headers.Header: List of extensions to be added to the Header model corresponding to the containing annotation.
extensions() - Method in annotation type org.eclipse.microprofile.openapi.annotations.info.Contact: List of extensions to be added to the Contact model corresponding to the containing annotation.
extensions() - Method in annotation type org.eclipse.microprofile.openapi.annotations.info.Info: List of extensions to be added to the Info model corresponding to the containing annotation.
extensions() - Method in annotation type org.eclipse.microprofile.openapi.annotations.info.License: List of extensions to be added to the License model corresponding to the containing annotation.
extensions() - Method in annotation type org.eclipse.microprofile.openapi.annotations.links.Link: List of extensions to be added to the Link model corresponding to the containing annotation.
extensions() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Content: List of extensions to be added to the MediaType model corresponding to the containing annotation.
extensions() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Encoding: List of extensions to be added to the Encoding model corresponding to the containing annotation.
extensions() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.ExampleObject: List of extensions to be added to the Example model corresponding to the containing annotation.
extensions() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Schema: List of extensions to be added to the Schema model corresponding to the containing annotation.
extensions() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.SchemaProperty: List of extensions to be added to the Schema model corresponding to the containing annotation.
extensions() - Method in annotation type org.eclipse.microprofile.openapi.annotations.OpenAPIDefinition: List of extensions to be added to the OpenAPI model corresponding to the containing annotation.
extensions() - Method in annotation type org.eclipse.microprofile.openapi.annotations.Operation: List of extensions to be added to the Operation model corresponding to the containing annotation.
extensions() - Method in annotation type org.eclipse.microprofile.openapi.annotations.parameters.Parameter: List of extensions to be added to the Parameter model corresponding to the containing annotation.
extensions() - Method in annotation type org.eclipse.microprofile.openapi.annotations.parameters.RequestBody: List of extensions to be added to the RequestBody model corresponding to the containing annotation.
extensions() - Method in annotation type org.eclipse.microprofile.openapi.annotations.responses.APIResponse: List of extensions to be added to the APIResponse model corresponding to the containing annotation.
extensions() - Method in annotation type org.eclipse.microprofile.openapi.annotations.responses.APIResponses: List of extensions to be added to the APIResponses model corresponding to the containing annotation.
extensions() - Method in annotation type org.eclipse.microprofile.openapi.annotations.security.OAuthFlow: List of extensions to be added to the OAuthFlow model corresponding to the containing annotation.
extensions() - Method in annotation type org.eclipse.microprofile.openapi.annotations.security.OAuthFlows: List of extensions to be added to the OAuthFlows model corresponding to the containing annotation.
extensions() - Method in annotation type org.eclipse.microprofile.openapi.annotations.security.SecurityScheme: List of extensions to be added to the SecurityScheme model corresponding to the containing annotation.
extensions() - Method in annotation type org.eclipse.microprofile.openapi.annotations.servers.Server: List of extensions to be added to the Server model corresponding to the containing annotation.
extensions() - Method in annotation type org.eclipse.microprofile.openapi.annotations.servers.ServerVariable: List of extensions to be added to the ServerVariable model corresponding to the containing annotation.
extensions() - Method in annotation type org.eclipse.microprofile.openapi.annotations.tags.Tag: List of extensions to be added to the Tag model corresponding to the containing annotation.
extensions(Map<String, Object>) - Method in interface org.eclipse.microprofile.openapi.models.Extensible: Sets this Extensible's extensions property to the given map of extensions.
Extensions - Annotation Type in org.eclipse.microprofile.openapi.annotations.extensions: This object represents an array of extensions that can be added to the element.
EXTENSIONS_PREFIX - Static variable in class org.eclipse.microprofile.openapi.OASConfig: Recommended prefix for vendor specific configuration properties.
externalDocs() - Method in annotation type org.eclipse.microprofile.openapi.annotations.callbacks.CallbackOperation: Additional external documentation for this callback operation.
externalDocs() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Schema: Additional external documentation for this schema.
externalDocs() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.SchemaProperty: Additional external documentation for this schema.
externalDocs() - Method in annotation type org.eclipse.microprofile.openapi.annotations.OpenAPIDefinition: Any additional external documentation for the API
externalDocs() - Method in annotation type org.eclipse.microprofile.openapi.annotations.tags.Tag: Additional external documentation for this tag.
externalDocs(ExternalDocumentation) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the externalDocs property of this Schema to the indicated value.
externalDocs(ExternalDocumentation) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI: Sets this OpenAPI instance's externalDocs property to the given object.
externalDocs(ExternalDocumentation) - Method in interface org.eclipse.microprofile.openapi.models.Operation: Sets this Operation's externalDocs property to the given object.
externalDocs(ExternalDocumentation) - Method in interface org.eclipse.microprofile.openapi.models.tags.Tag: Sets the externalDocs property of a Tag instance to the given object.
ExternalDocumentation - Interface in org.eclipse.microprofile.openapi.models: ExternalDocumentation
ExternalDocumentation - Annotation Type in org.eclipse.microprofile.openapi.annotations: This annotation allows referencing an external resource for extended documentation.
externalValue() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.ExampleObject: A URL to point to an external document to be used as an example.
externalValue(String) - Method in interface org.eclipse.microprofile.openapi.models.examples.Example: Sets this Example's externalValue property to the given string.

F

FALSE - org.eclipse.microprofile.openapi.annotations.enums.Explode
FILTER - Static variable in class org.eclipse.microprofile.openapi.OASConfig: Configuration property to specify the fully qualified name of the OASFilter implementation.
filterAPIResponse(APIResponse) - Method in interface org.eclipse.microprofile.openapi.OASFilter: Allows filtering of a particular APIResponse.
filterCallback(Callback) - Method in interface org.eclipse.microprofile.openapi.OASFilter: Allows filtering of a particular Callback.
filterHeader(Header) - Method in interface org.eclipse.microprofile.openapi.OASFilter: Allows filtering of a particular Header.
filterLink(Link) - Method in interface org.eclipse.microprofile.openapi.OASFilter: Allows filtering of a particular Link.
filterOpenAPI(OpenAPI) - Method in interface org.eclipse.microprofile.openapi.OASFilter: Allows filtering of the singleton OpenAPI element.
filterOperation(Operation) - Method in interface org.eclipse.microprofile.openapi.OASFilter: Allows filtering of a particular Operation.
filterParameter(Parameter) - Method in interface org.eclipse.microprofile.openapi.OASFilter: Allows filtering of a particular Parameter.
filterPathItem(PathItem) - Method in interface org.eclipse.microprofile.openapi.OASFilter: Allows filtering of a particular PathItem.
filterRequestBody(RequestBody) - Method in interface org.eclipse.microprofile.openapi.OASFilter: Allows filtering of a particular RequestBody.
filterSchema(Schema) - Method in interface org.eclipse.microprofile.openapi.OASFilter: Allows filtering of a particular Schema.
filterSecurityScheme(SecurityScheme) - Method in interface org.eclipse.microprofile.openapi.OASFilter: Allows filtering of a particular SecurityScheme.
filterServer(Server) - Method in interface org.eclipse.microprofile.openapi.OASFilter: Allows filtering of a particular Server.
filterTag(Tag) - Method in interface org.eclipse.microprofile.openapi.OASFilter: Allows filtering of a particular Tag.
flows() - Method in annotation type org.eclipse.microprofile.openapi.annotations.security.SecurityScheme: Applies to and is REQUIRED for SecurityScheme of oauth2 type.
flows(OAuthFlows) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme: Flows is a REQUIRED property.
FORM - org.eclipse.microprofile.openapi.annotations.enums.ParameterStyle
FORM - org.eclipse.microprofile.openapi.models.media.Encoding.Style
FORM - org.eclipse.microprofile.openapi.models.parameters.Parameter.Style
format() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Schema: Provides an optional override for the format.
format() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.SchemaProperty: Provides an optional override for the format.
format(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the format property of this Schema instance to the given string.

G

GET - org.eclipse.microprofile.openapi.models.PathItem.HttpMethod
GET(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem: Sets this PathItem's get property to the given operation.
getAdditionalPropertiesBoolean() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Returns the value of the "additionalProperties" setting, which indicates whether properties not otherwise defined are allowed.
getAdditionalPropertiesSchema() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Returns the value of the "additionalProperties" setting, which indicates whether properties not otherwise defined are allowed.
getAllOf() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Returns the schemas used by the allOf property.
getAllowEmptyValue() - Method in interface org.eclipse.microprofile.openapi.models.headers.Header: Returns the allowEmptyValue property from a Header instance.
getAllowEmptyValue() - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter: Returns the allowEmptyValue property from a Parameter instance.
getAllowReserved() - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding: AllowReserved determines whether the parameter value SHOULD allow reserved characters to be encoded without percent-encoding.
getAllowReserved() - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter: Returns the allowReserved property from a Parameter instance.
getAnyOf() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Returns the schemas used by the anyOf property.
getAPIResponse(String) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponses: Returns a APIResponse for a given name.
getAPIResponses() - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponses: Returns a copy map (potentially immutable) of the APIResponses.
getAttribute() - Method in interface org.eclipse.microprofile.openapi.models.media.XML: This method returns the attribute property of XML instance.
getAuthorizationCode() - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlows: OAuth Authorization Code flow; previously called accessCode in OpenAPI 2.0
getAuthorizationUrl() - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlow: The authorization URL to be used for this flow.
getBearerFormat() - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme: bearerFormat is intended as a hint to the client to identify how the bearer token is formatted.
getCallbacks() - Method in interface org.eclipse.microprofile.openapi.models.Components: Returns the callbacks property from a Components instance.
getCallbacks() - Method in interface org.eclipse.microprofile.openapi.models.Operation: Returns the callbacks property from an Operation instance.
getClientCredentials() - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlows: OAuth Client Credential flow; previously called application in OpenAPI 2.0
getComponents() - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI: Returns the components property from an OpenAPI instance.
getContact() - Method in interface org.eclipse.microprofile.openapi.models.info.Info: Returns the contact information for the exposed API from this Info instance.
getContent() - Method in interface org.eclipse.microprofile.openapi.models.headers.Header: Returns the content property from a Header instance.
getContent() - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter: Returns the content property from a Parameter instance.
getContent() - Method in interface org.eclipse.microprofile.openapi.models.parameters.RequestBody: Returns the content of this instance of RequestBody, where the keys in content are media type names and the values describe it.
getContent() - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponse: Returns the map containing descriptions of potential response payload for this instance of ApiResponse.
getContentType() - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding: The Content-Type for encoding a specific property.
getDefaultValue() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Returns the default value property from this Schema instance.
getDefaultValue() - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponses: Returns the default documentation of responses other than the ones declared for specific HTTP response codes in this instance of ApiResponses.
getDefaultValue() - Method in interface org.eclipse.microprofile.openapi.models.servers.ServerVariable: The default value to use for substitution, and to send, if an alternate value is not supplied.
getDELETE() - Method in interface org.eclipse.microprofile.openapi.models.PathItem: Returns the delete property from a PathItem instance.
getDeprecated() - Method in interface org.eclipse.microprofile.openapi.models.headers.Header: Returns the deprecated property from a Header instance.
getDeprecated() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Returns the deprecated property from this Schema instance.
getDeprecated() - Method in interface org.eclipse.microprofile.openapi.models.Operation: Returns the deprecated property from an Operation instance.
getDeprecated() - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter: Returns the deprecated property from a Parameter instance.
getDescription() - Method in interface org.eclipse.microprofile.openapi.models.examples.Example: Returns the description property from an Example instance.
getDescription() - Method in interface org.eclipse.microprofile.openapi.models.ExternalDocumentation: Returns the description property from an ExternalDocumentation instance.
getDescription() - Method in interface org.eclipse.microprofile.openapi.models.headers.Header: Returns the description property from a Header instance.
getDescription() - Method in interface org.eclipse.microprofile.openapi.models.info.Info: Returns a short description for the application for this Info instance.
getDescription() - Method in interface org.eclipse.microprofile.openapi.models.links.Link: Returns the description property from a Link instance.
getDescription() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Returns a description of the purpose of this Schema.
getDescription() - Method in interface org.eclipse.microprofile.openapi.models.Operation: Returns the description property from an Operation instance.
getDescription() - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter: Returns the description property from a Parameter instance.
getDescription() - Method in interface org.eclipse.microprofile.openapi.models.parameters.RequestBody: Returns the description of this instance of RequestBody.
getDescription() - Method in interface org.eclipse.microprofile.openapi.models.PathItem: Returns the description property from a PathItem instance.
getDescription() - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponse: Returns a short description of this instance of ApiResponse.
getDescription() - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme: A short description for security schema.
getDescription() - Method in interface org.eclipse.microprofile.openapi.models.servers.Server: This method returns the description property of Server instance.
getDescription() - Method in interface org.eclipse.microprofile.openapi.models.servers.ServerVariable: This method returns the description property of ServerVariable instance.
getDescription() - Method in interface org.eclipse.microprofile.openapi.models.tags.Tag: Returns the description property from a Tag instance.
getDiscriminator() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Returns the discriminator property from this Schema instance.
getEmail() - Method in interface org.eclipse.microprofile.openapi.models.info.Contact: Returns the contact email of this Contact instance.
getEncoding() - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType: Returns the encoding property from a MediaType instance.
getEnumeration() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Returns the enumerated list of values allowed for objects defined by this Schema.
getEnumeration() - Method in interface org.eclipse.microprofile.openapi.models.servers.ServerVariable: This method returns the enumeration property of ServerVariable instance.
getExample() - Method in interface org.eclipse.microprofile.openapi.models.headers.Header: Returns the example property from a Header instance.
getExample() - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType: Returns the example property from a MediaType instance.
getExample() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Returns the example property from this Schema instance.
getExample() - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter: Returns the example property from a Parameter instance.
getExamples() - Method in interface org.eclipse.microprofile.openapi.models.Components: Returns the examples property from a Components instance.
getExamples() - Method in interface org.eclipse.microprofile.openapi.models.headers.Header: Returns the examples property from a Header instance.
getExamples() - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType: Returns the collection of examples from a MediaType instance.
getExamples() - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter: Returns the examples property from a Parameter instance.
getExclusiveMaximum() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Returns the exclusiveMaximum property from this Schema instance.
getExclusiveMinimum() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Returns the exclusiveMinimum property from this Schema instance.
getExplode() - Method in interface org.eclipse.microprofile.openapi.models.headers.Header: Returns the explode property from a Header instance.
getExplode() - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding: When this is true, property values of type array or object generate separate parameters for each value of the array, or key-value-pair of the map.
getExplode() - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter: Returns the explode property from a Parameter instance.
getExtensions() - Method in interface org.eclipse.microprofile.openapi.models.Extensible: Returns the extensions property from an Extensible instance.
getExternalDocs() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Returns the externalDocs property from this Schema instance.
getExternalDocs() - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI: Returns the externalDocs property from an OpenAPI instance.
getExternalDocs() - Method in interface org.eclipse.microprofile.openapi.models.Operation: Returns the externalDocs property from an Operation instance.
getExternalDocs() - Method in interface org.eclipse.microprofile.openapi.models.tags.Tag: Returns the externalDocs property from a Tag instance.
getExternalValue() - Method in interface org.eclipse.microprofile.openapi.models.examples.Example: Returns the externalValue property from an Example instance.
getFlows() - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme: Flows is a REQUIRED property.
getFormat() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Returns the format property from this Schema instance.
getGET() - Method in interface org.eclipse.microprofile.openapi.models.PathItem: Returns the get property from a PathItem instance.
getHEAD() - Method in interface org.eclipse.microprofile.openapi.models.PathItem: Returns the head property from a PathItem instance.
getHeaders() - Method in interface org.eclipse.microprofile.openapi.models.Components: Returns the headers property from a Components instance.
getHeaders() - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding: Headers property of an Encoding is a map that allows additional information to be provided as headers
getHeaders() - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponse: Returns the map of Headers in this instance of ApiResponse.
getImplicit() - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlows: This method returns the implicit property from OAuthFlows instance.
getIn() - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter: Returns the in property from a Parameter instance.
getIn() - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme: In is a REQUIRED property that indicates the location of the API key.
getInfo() - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI: Returns the info property from an OpenAPI instance.
getItems() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Returns the Schema used for all the elements of an array typed Schema.
getLicense() - Method in interface org.eclipse.microprofile.openapi.models.info.Info: Returns the license information for the exposed API from this Info instance.
getLinks() - Method in interface org.eclipse.microprofile.openapi.models.Components: Returns the links property from a Components instance.
getLinks() - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponse: Returns the operations links that can be followed from this instance of ApiResponse.
getMapping() - Method in interface org.eclipse.microprofile.openapi.models.media.Discriminator: Returns the mapping property from a Discriminator instance.
getMaximum() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Returns the maximum property from this Schema instance.
getMaxItems() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Returns the maxItems property from this Schema instance.
getMaxLength() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Returns the maxLength property from this Schema instance.
getMaxProperties() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Returns the maxProperties property from this Schema instance.
getMediaType(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Content: Returns a media type for a given name.
getMediaTypes() - Method in interface org.eclipse.microprofile.openapi.models.media.Content: Returns a copy map (potentially immutable) of media types.
getMinimum() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Returns the minimum property from this Schema instance.
getMinItems() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Returns the minItems property from this Schema instance.
getMinLength() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Returns the minLength property from this Schema instance.
getMinProperties() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Returns the minProperties property from this Schema instance.
getMultipleOf() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Returns the multipleOf property from this Schema instance.
getName() - Method in interface org.eclipse.microprofile.openapi.models.info.Contact: Returns the identifying name of this Contact instance.
getName() - Method in interface org.eclipse.microprofile.openapi.models.info.License: Returns the license name for this License instance that is used for the API.
getName() - Method in interface org.eclipse.microprofile.openapi.models.media.XML: This method returns the name property from XML instance.
getName() - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter: Returns the name property from a Parameter instance.
getName() - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme: Name is a REQUIRED property - this is the name of the header, query or cookie parameter to be used.
getName() - Method in interface org.eclipse.microprofile.openapi.models.tags.Tag: Returns the name property from a Tag instance.
getNamespace() - Method in interface org.eclipse.microprofile.openapi.models.media.XML: This method returns the namespace property of XML instance.
getNot() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Returns a Schema which describes properties not allowed in objects defined by the current schema.
getNullable() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Returns the nullable property from this Schema instance which indicates whether null is a valid value.
getOneOf() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Returns the schemas used by the oneOf property.
getOpenapi() - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI: Returns the openapi property from an OpenAPI instance.
getOpenIdConnectUrl() - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme: openIdConnectUrl is a REQUIRED property.
getOperationId() - Method in interface org.eclipse.microprofile.openapi.models.links.Link: Returns the operationId property for this instance of Link.
getOperationId() - Method in interface org.eclipse.microprofile.openapi.models.Operation: Returns the operationId property from an Operation instance.
getOperationRef() - Method in interface org.eclipse.microprofile.openapi.models.links.Link: Returns the operationRef property from a Link instance.
getOperations() - Method in interface org.eclipse.microprofile.openapi.models.PathItem: Returns a map with all the operations for this path where the keys are PathItem.HttpMethod items
getOPTIONS() - Method in interface org.eclipse.microprofile.openapi.models.PathItem: Returns the options property from a PathItem instance.
getParameters() - Method in interface org.eclipse.microprofile.openapi.models.Components: Returns the parameters property from a Components instance.
getParameters() - Method in interface org.eclipse.microprofile.openapi.models.links.Link: Returns the parameters property from this instance of Link.
getParameters() - Method in interface org.eclipse.microprofile.openapi.models.Operation: Returns the parameters property from an Operation instance.
getParameters() - Method in interface org.eclipse.microprofile.openapi.models.PathItem: Returns the parameters property from this PathItem instance.
getPassword() - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlows: OAuth Resource Owner Password flow
getPATCH() - Method in interface org.eclipse.microprofile.openapi.models.PathItem: Returns the patch property from a PathItem instance.
getPathItem(String) - Method in interface org.eclipse.microprofile.openapi.models.callbacks.Callback: Returns a path item for a given name.
getPathItem(String) - Method in interface org.eclipse.microprofile.openapi.models.Paths: Returns a path item for a given name.
getPathItems() - Method in interface org.eclipse.microprofile.openapi.models.callbacks.Callback: Returns a copy map (potentially immutable) of the path items.
getPathItems() - Method in interface org.eclipse.microprofile.openapi.models.Paths: Returns a copy map (potentially immutable) of the path items.
getPaths() - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI: Returns the paths property from an OpenAPI instance.
getPattern() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Returns the pattern property from this Schema instance.
getPOST() - Method in interface org.eclipse.microprofile.openapi.models.PathItem: Returns the post property from a PathItem instance.
getPrefix() - Method in interface org.eclipse.microprofile.openapi.models.media.XML: This method returns the prefix property of XML instance.
getProperties() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Returns the properties defined in this Schema.
getPropertyName() - Method in interface org.eclipse.microprofile.openapi.models.media.Discriminator: Returns the propertyName property from a Discriminator instance.
getPUT() - Method in interface org.eclipse.microprofile.openapi.models.PathItem: Returns the put property from a PathItem instance.
getReadOnly() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Returns the readOnly property from this Schema instance.
getRef() - Method in interface org.eclipse.microprofile.openapi.models.Reference: Returns the reference property from this Reference instance.
getRefreshUrl() - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlow: The URL to be used for obtaining refresh tokens.
getRequestBodies() - Method in interface org.eclipse.microprofile.openapi.models.Components: Returns the requestBodies property from a Components instance.
getRequestBody() - Method in interface org.eclipse.microprofile.openapi.models.links.Link: Returns the requestBody property from a Link instance.
getRequestBody() - Method in interface org.eclipse.microprofile.openapi.models.Operation: Returns the requestBody property from an Operation instance.
getRequired() - Method in interface org.eclipse.microprofile.openapi.models.headers.Header: Returns the required property from a Header instance.
getRequired() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Returns the required property from this Schema instance.
getRequired() - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter: Returns the required property from a Parameter instance.
getRequired() - Method in interface org.eclipse.microprofile.openapi.models.parameters.RequestBody: Returns whether this instance of RequestBody is required for the operation.
getResponses() - Method in interface org.eclipse.microprofile.openapi.models.Components: Returns the responses property from a Components instance.
getResponses() - Method in interface org.eclipse.microprofile.openapi.models.Operation: Returns the responses property from an Operation instance.
getSchema() - Method in interface org.eclipse.microprofile.openapi.models.headers.Header: Returns the schema property from a Header instance.
getSchema() - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType: Returns the schema property from a MediaType instance.
getSchema() - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter: Returns the schema property from a Parameter instance.
getSchemas() - Method in interface org.eclipse.microprofile.openapi.models.Components: Returns the schemas property from a Components instance.
getScheme() - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme: Schema is a REQUIRED property that is the name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.
getScheme(String) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityRequirement: Returns a list of scopes for a given scheme name.
getSchemes() - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityRequirement: Returns a copy map (potentially immutable) of the schemes.
getScopes() - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlow: The available scopes for the OAuth2 security scheme.
getSecurity() - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI: Returns the security property from an OpenAPI instance.
getSecurity() - Method in interface org.eclipse.microprofile.openapi.models.Operation: Returns the security property from an Operation instance.
getSecuritySchemes() - Method in interface org.eclipse.microprofile.openapi.models.Components: Returns the securitySchemes property from a Components instance.
getServer() - Method in interface org.eclipse.microprofile.openapi.models.links.Link: Returns the server property from a Link instance.
getServers() - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI: Returns the Servers defined in the API
getServers() - Method in interface org.eclipse.microprofile.openapi.models.Operation: Returns the servers property from an Operation instance.
getServers() - Method in interface org.eclipse.microprofile.openapi.models.PathItem: Returns the servers property from a PathItem instance.
getStyle() - Method in interface org.eclipse.microprofile.openapi.models.headers.Header: Returns the style property from a Header instance.
getStyle() - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding: Style describes how the encoding value will be serialized depending on the type of the parameter value.
getStyle() - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter: Returns the style property from a Parameter instance.
getSummary() - Method in interface org.eclipse.microprofile.openapi.models.examples.Example: Returns the summary property from an Example instance.
getSummary() - Method in interface org.eclipse.microprofile.openapi.models.Operation: Returns the summary property from an Operation instance.
getSummary() - Method in interface org.eclipse.microprofile.openapi.models.PathItem: Returns the summary property from a PathItem instance.
getTags() - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI: Returns the tags property from an OpenAPI instance.
getTags() - Method in interface org.eclipse.microprofile.openapi.models.Operation: Returns the tags property from an Operation instance.
getTermsOfService() - Method in interface org.eclipse.microprofile.openapi.models.info.Info: Returns the URL to the Terms of Service for the API for this instance of Info.
getTitle() - Method in interface org.eclipse.microprofile.openapi.models.info.Info: Returns the title for the application for this instance of Info
getTitle() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Returns the title property from this Schema instance.
getTokenUrl() - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlow: The token URL to be used for this flow.
getTRACE() - Method in interface org.eclipse.microprofile.openapi.models.PathItem: Returns the trace property from a PathItem instance.
getType() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Returns the type property from this Schema.
getType() - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme: Type is a REQUIRED property that specifies the type of SecurityScheme instance.
getUniqueItems() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Returns the uniqueItems property from this Schema instance.
getUrl() - Method in interface org.eclipse.microprofile.openapi.models.ExternalDocumentation: Returns the url property from an ExternalDocumentation instance.
getUrl() - Method in interface org.eclipse.microprofile.openapi.models.info.Contact: Returns the URL pointing to the contact information for this Contact instance.
getUrl() - Method in interface org.eclipse.microprofile.openapi.models.info.License: Returns the URL for this License instance that is used for the API.
getUrl() - Method in interface org.eclipse.microprofile.openapi.models.servers.Server: This method returns the url property of Server instance, which is a URL to the target host.
getValue() - Method in interface org.eclipse.microprofile.openapi.models.examples.Example: Returns the value property from an Example instance.
getVariables() - Method in interface org.eclipse.microprofile.openapi.models.servers.Server: This method returns the variables property of Server instance.
getVersion() - Method in interface org.eclipse.microprofile.openapi.models.info.Info: Returns the version of the OpenAPI document for this Info instance.
getWrapped() - Method in interface org.eclipse.microprofile.openapi.models.media.XML: This method returns the wrapped property of XML instance.
getWriteOnly() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Returns the writeOnly property from this Schema instance.
getXml() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Returns the xml property from this Schema instance.

H

hasAPIResponse(String) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponses: Check whether a APIResponse is present in the map.
hasMediaType(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Content: Check whether a media type is present in the map.
hasPathItem(String) - Method in interface org.eclipse.microprofile.openapi.models.callbacks.Callback: Check whether a path item is present to the map.
hasPathItem(String) - Method in interface org.eclipse.microprofile.openapi.models.Paths: Check whether a path item is present in the map.
hasScheme(String) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityRequirement: Check whether a scheme is present in the map.
HEAD - org.eclipse.microprofile.openapi.models.PathItem.HttpMethod
HEAD(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem: Sets this PathItem's head property to the given operation.
Header - Interface in org.eclipse.microprofile.openapi.models.headers: Header
Header - Annotation Type in org.eclipse.microprofile.openapi.annotations.headers: Describes a single header object
HEADER - org.eclipse.microprofile.openapi.annotations.enums.ParameterIn
HEADER - org.eclipse.microprofile.openapi.annotations.enums.SecuritySchemeIn
HEADER - org.eclipse.microprofile.openapi.models.parameters.Parameter.In
HEADER - org.eclipse.microprofile.openapi.models.security.SecurityScheme.In
Header.Style - Enum in org.eclipse.microprofile.openapi.models.headers: Controls the style of serialization.
headers() - Method in annotation type org.eclipse.microprofile.openapi.annotations.Components: An object to hold reusable Header Objects.
headers() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Encoding: An array of headers that corresponds to a map of headers in the encoding model.
headers() - Method in annotation type org.eclipse.microprofile.openapi.annotations.responses.APIResponse: An array of response headers.
headers(Map<String, Header>) - Method in interface org.eclipse.microprofile.openapi.models.Components: Sets this Components' headers property to the given Map containing keys and reusable header objects.
headers(Map<String, Header>) - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding: Headers property of an Encoding is a map that allows additional information to be provided as headers
headers(Map<String, Header>) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponse: Sets the Headers for this instance of ApiResponse with the given map of Headers and returns this instance of ApiResponse.
hidden() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Schema: Allows schema to be marked as hidden.
hidden() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.SchemaProperty: Allows schema to be marked as hidden.
hidden() - Method in annotation type org.eclipse.microprofile.openapi.annotations.Operation: Allows this operation to be marked as hidden
hidden() - Method in annotation type org.eclipse.microprofile.openapi.annotations.parameters.Parameter: Allows this parameter to be marked as hidden
HTTP - org.eclipse.microprofile.openapi.annotations.enums.SecuritySchemeType
HTTP - org.eclipse.microprofile.openapi.models.security.SecurityScheme.Type

I

implementation() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Schema: Provides a java class as implementation for this schema.
implementation() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.SchemaProperty: Provides a java class as implementation for this schema.
implicit() - Method in annotation type org.eclipse.microprofile.openapi.annotations.security.OAuthFlows: Configuration for the OAuth Implicit flow.
implicit(OAuthFlow) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlows: This method sets the implicit property of OAuthFlows instance to the given implicit argument and returns the modified instance.
in() - Method in annotation type org.eclipse.microprofile.openapi.annotations.parameters.Parameter: The location of the parameter.
in() - Method in annotation type org.eclipse.microprofile.openapi.annotations.security.SecurityScheme: Applies to and is REQUIRED for SecurityScheme of apiKey type.
in(Parameter.In) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter: Sets the in property of a Parameter instance to the given value.
in(SecurityScheme.In) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme: In is a REQUIRED property that indicates the location of the API key.
info() - Method in annotation type org.eclipse.microprofile.openapi.annotations.OpenAPIDefinition: Required: Provides metadata about the API.
info(Info) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI: Sets this OpenAPI instance's info property to the given object.
Info - Interface in org.eclipse.microprofile.openapi.models.info: This interface represents all the metadata about the API.
Info - Annotation Type in org.eclipse.microprofile.openapi.annotations.info: This annotation provides metadata about the API, and maps to the Info object in OpenAPI Specification 3.
instance() - Static method in class org.eclipse.microprofile.openapi.spi.OASFactoryResolver: Creates an OASFactoryResolver object.
INTEGER - org.eclipse.microprofile.openapi.annotations.enums.SchemaType
INTEGER - org.eclipse.microprofile.openapi.models.media.Schema.SchemaType
items(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Set the Schema used for all the elements of an array typed Schema.

L

LABEL - org.eclipse.microprofile.openapi.annotations.enums.ParameterStyle
LABEL - org.eclipse.microprofile.openapi.models.parameters.Parameter.Style
license() - Method in annotation type org.eclipse.microprofile.openapi.annotations.info.Info: The license information for the exposed API.
license(License) - Method in interface org.eclipse.microprofile.openapi.models.info.Info: Sets this Info's license information for the exposed API and returns this instance of Info.
License - Interface in org.eclipse.microprofile.openapi.models.info: This interface represents the License information for the exposed API.
License - Annotation Type in org.eclipse.microprofile.openapi.annotations.info: License information for the exposed API.
Link - Interface in org.eclipse.microprofile.openapi.models.links: Link
Link - Annotation Type in org.eclipse.microprofile.openapi.annotations.links: The Link object represents a possible design-time link for a response.
LinkParameter - Annotation Type in org.eclipse.microprofile.openapi.annotations.links: Represents a parameter to pass to an operation as specified with operationId or identified via operationRef.
links() - Method in annotation type org.eclipse.microprofile.openapi.annotations.Components: An object to hold reusable Link Objects.
links() - Method in annotation type org.eclipse.microprofile.openapi.annotations.responses.APIResponse: An array of operation links that can be followed from the response.
links(Map<String, Link>) - Method in interface org.eclipse.microprofile.openapi.models.Components: Sets this Components' links property to the given Map containing keys and reusable link objects.
links(Map<String, Link>) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponse: Sets the operations links that can be followed from this instance of ApiResponse.

M

mapping(Map<String, String>) - Method in interface org.eclipse.microprofile.openapi.models.media.Discriminator: Sets this Discriminator's mapping property to the given map object.
MATRIX - org.eclipse.microprofile.openapi.annotations.enums.ParameterStyle
MATRIX - org.eclipse.microprofile.openapi.models.parameters.Parameter.Style
maximum() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Schema: Sets the maximum numeric value for a property.
maximum() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.SchemaProperty: Sets the maximum numeric value for a property.
maximum(BigDecimal) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the maximum property of this Schema instance to the value given.
maxItems() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Schema: Only applicable if type=array.
maxItems() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.SchemaProperty: Only applicable if type=array.
maxItems(Integer) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the maxItems property of this Schema instance to the value given.
maxLength() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Schema: Sets the maximum length of a string value.
maxLength() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.SchemaProperty: Sets the maximum length of a string value.
maxLength(Integer) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the maxLength property of this Schema instance to the value given.
maxProperties() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Schema: Constrains the number of arbitrary properties when additionalProperties is defined.
maxProperties() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.SchemaProperty: Constrains the number of arbitrary properties when additionalProperties is defined.
maxProperties(Integer) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the maxProperties property of this Schema instance to the value given.
mediaType() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Content: The media type that this object applies to.
MediaType - Interface in org.eclipse.microprofile.openapi.models.media: MediaType
method() - Method in annotation type org.eclipse.microprofile.openapi.annotations.callbacks.CallbackOperation: The HTTP method for this callback operation.
minimum() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Schema: Sets the minimum numeric value for a property.
minimum() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.SchemaProperty: Sets the minimum numeric value for a property.
minimum(BigDecimal) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the minimum property of this Schema instance to the value given.
minItems() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Schema: Only applicable if type=array.
minItems() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.SchemaProperty: Only applicable if type=array.
minItems(Integer) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the minItems property of this Schema instance to the value given.
minLength() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Schema: Sets the minimum length of a string value.
minLength() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.SchemaProperty: Sets the minimum length of a string value.
minLength(Integer) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the minLength property of this Schema instance to the value given.
minProperties() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Schema: Constrains the number of arbitrary properties when additionalProperties is defined.
minProperties() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.SchemaProperty: Constrains the number of arbitrary properties when additionalProperties is defined.
minProperties(Integer) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the minProperties property of this Schema instance to the value given.
MODEL_READER - Static variable in class org.eclipse.microprofile.openapi.OASConfig: Configuration property to specify the fully qualified name of the OASModelReader implementation.
multipleOf() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Schema: Constrains a value such that when divided by the multipleOf, the remainder must be an integer.
multipleOf() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.SchemaProperty: Constrains a value such that when divided by the multipleOf, the remainder must be an integer.
multipleOf(BigDecimal) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the multipleOf property of this Schema instance to the value given.

N

name() - Method in annotation type org.eclipse.microprofile.openapi.annotations.callbacks.Callback: The friendly name used to refer to this callback.
name() - Method in annotation type org.eclipse.microprofile.openapi.annotations.extensions.Extension: A name for the extension.
name() - Method in annotation type org.eclipse.microprofile.openapi.annotations.headers.Header: The name of the header.
name() - Method in annotation type org.eclipse.microprofile.openapi.annotations.info.Contact: The identifying name of the contact person/organization.
name() - Method in annotation type org.eclipse.microprofile.openapi.annotations.info.License: The license name used for the API.
name() - Method in annotation type org.eclipse.microprofile.openapi.annotations.links.Link: The name of this link.
name() - Method in annotation type org.eclipse.microprofile.openapi.annotations.links.LinkParameter: The name of this link parameter.
name() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Encoding: The name of this encoding object instance.
name() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.ExampleObject: A unique name to identify this particular example in a map.
name() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Schema: The name of the schema or property.
name() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.SchemaProperty: The name of the property.
name() - Method in annotation type org.eclipse.microprofile.openapi.annotations.parameters.Parameter: The name of the parameter.
name() - Method in annotation type org.eclipse.microprofile.openapi.annotations.parameters.RequestBody: The unique name to identify this request body.
name() - Method in annotation type org.eclipse.microprofile.openapi.annotations.responses.APIResponse: The unique name to identify this response.
name() - Method in annotation type org.eclipse.microprofile.openapi.annotations.security.OAuthScope: Name of the scope.
name() - Method in annotation type org.eclipse.microprofile.openapi.annotations.security.SecurityRequirement: Name MUST correspond to a security scheme which is declared in the Security Schemes under the Components Object.
name() - Method in annotation type org.eclipse.microprofile.openapi.annotations.servers.ServerVariable: The name of this server variable.
name() - Method in annotation type org.eclipse.microprofile.openapi.annotations.tags.Tag: The name of this tag.
name(String) - Method in interface org.eclipse.microprofile.openapi.models.info.Contact: Sets this Contact instance's identifying name to the given name and returns this instance of Contact.
name(String) - Method in interface org.eclipse.microprofile.openapi.models.info.License: Sets this License instance's name used for the API and returns this instance of License.
name(String) - Method in interface org.eclipse.microprofile.openapi.models.media.XML: This method sets the name property of XML instance to the given String argument and returns the modified instance.
name(String) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter: Sets the name property of a Parameter instance to the given string.
name(String) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme: Name is a REQUIRED property - this is the name of the header, query or cookie parameter to be used.
name(String) - Method in interface org.eclipse.microprofile.openapi.models.tags.Tag: Sets the name property of a Tag instance to the given string.
namespace(String) - Method in interface org.eclipse.microprofile.openapi.models.media.XML: This method sets the namespace property of XML instance to the given String argument and returns the modified instance.
not() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Schema: Provides a java class to be used to disallow matching properties.
not() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.SchemaProperty: Provides a java class to be used to disallow matching properties.
not(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the not property to a Schema which describes properties not allowed in objects defined by the current schema.
nullable() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Schema: Allows sending a null value for the defined schema.
nullable() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.SchemaProperty: Allows sending a null value for the defined schema.
nullable(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the nullable property of this Schema instance.
NUMBER - org.eclipse.microprofile.openapi.annotations.enums.SchemaType
NUMBER - org.eclipse.microprofile.openapi.models.media.Schema.SchemaType

O

OASConfig - Class in org.eclipse.microprofile.openapi: Configurable properties in MicroProfile OpenAPI
OASFactory - Class in org.eclipse.microprofile.openapi: This class allows application developers to build new OpenAPI model elements.
OASFactoryResolver - Class in org.eclipse.microprofile.openapi.spi: This class is not intended to be used by end-users.
OASFactoryResolver() - Constructor for class org.eclipse.microprofile.openapi.spi.OASFactoryResolver
OASFilter - Interface in org.eclipse.microprofile.openapi: This interface allows application developers to filter different parts of the OpenAPI model tree.
OASModelReader - Interface in org.eclipse.microprofile.openapi: This interface allows application developers to programmatically contribute an OpenAPI model tree.
OAUTH2 - org.eclipse.microprofile.openapi.annotations.enums.SecuritySchemeType
OAUTH2 - org.eclipse.microprofile.openapi.models.security.SecurityScheme.Type
OAuthFlow - Interface in org.eclipse.microprofile.openapi.models.security: Configuration details for a supportde OAuthFlow
OAuthFlow - Annotation Type in org.eclipse.microprofile.openapi.annotations.security: Configuration details for a supported OAuth Flow.
OAuthFlows - Interface in org.eclipse.microprofile.openapi.models.security: Configuration of the supported OAuthFlows
OAuthFlows - Annotation Type in org.eclipse.microprofile.openapi.annotations.security: Allows configuration of the supported OAuth Flows.
OAuthScope - Annotation Type in org.eclipse.microprofile.openapi.annotations.security: Represents an OAuth scope.
OBJECT - org.eclipse.microprofile.openapi.annotations.enums.SchemaType
OBJECT - org.eclipse.microprofile.openapi.models.media.Schema.SchemaType
oneOf() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Schema: Provides an array of java class implementations which can be used to describe multiple acceptable schemas.
oneOf() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.SchemaProperty: Provides an array of java class implementations which can be used to describe multiple acceptable schemas.
oneOf(List<Schema>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the schemas used by the oneOf property of this Schema.
openapi(String) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI: Sets this OpenAPI instance's openapi property to the given string.
OpenAPI - Interface in org.eclipse.microprofile.openapi.models: OpenAPI
OpenAPIDefinition - Annotation Type in org.eclipse.microprofile.openapi.annotations: OpenAPI
OPENIDCONNECT - org.eclipse.microprofile.openapi.annotations.enums.SecuritySchemeType
OPENIDCONNECT - org.eclipse.microprofile.openapi.models.security.SecurityScheme.Type
openIdConnectUrl() - Method in annotation type org.eclipse.microprofile.openapi.annotations.security.SecurityScheme: Applies to and is REQUIRED for SecurityScheme of openIdConnect type.
openIdConnectUrl(String) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme: penIdConnectUrl is a REQUIRED property.
Operation - Interface in org.eclipse.microprofile.openapi.models: Operation
Operation - Annotation Type in org.eclipse.microprofile.openapi.annotations: Describes a single API operation on a path.
operationId() - Method in annotation type org.eclipse.microprofile.openapi.annotations.links.Link: The name of an existing, resolvable OAS operation, as defined with a unique operationId.
operationId() - Method in annotation type org.eclipse.microprofile.openapi.annotations.Operation: Unique string used to identify the operation.
operationId(String) - Method in interface org.eclipse.microprofile.openapi.models.links.Link: Sets this Link's operationId property to the given string.
operationId(String) - Method in interface org.eclipse.microprofile.openapi.models.Operation: Sets this Operation's operationId property to the given string.
operationRef() - Method in annotation type org.eclipse.microprofile.openapi.annotations.links.Link: A relative or absolute reference to an OAS operation.
operationRef(String) - Method in interface org.eclipse.microprofile.openapi.models.links.Link: Sets this Link's operationRef property to the given string.
operations() - Method in annotation type org.eclipse.microprofile.openapi.annotations.callbacks.Callback: The array of operations that will be called out-of band
OPTIONS - org.eclipse.microprofile.openapi.models.PathItem.HttpMethod
OPTIONS(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem: Sets this PathItem's options property to the given operation.
org.eclipse.microprofile.openapi - package org.eclipse.microprofile.openapi: A set of Java interfaces, annotations and programming models which allow Java developers to natively produce OpenAPI v3 documents from their JAX-RS applications.
org.eclipse.microprofile.openapi.annotations - package org.eclipse.microprofile.openapi.annotations: A set of annotations, many derived from Swagger Core library.
org.eclipse.microprofile.openapi.annotations.callbacks - package org.eclipse.microprofile.openapi.annotations.callbacks: A set of annotations to represent callback URL or an array of relevant callback URLs that can be invoked for a particular HTTP operation as well as the HTTP operation that will be invoked with the callback.
org.eclipse.microprofile.openapi.annotations.enums - package org.eclipse.microprofile.openapi.annotations.enums: A set of parameters used by other annotations to represent their enumerable properties.
org.eclipse.microprofile.openapi.annotations.extensions - package org.eclipse.microprofile.openapi.annotations.extensions: Annotations to represent additional data to extend existing OpenAPI specifications.
org.eclipse.microprofile.openapi.annotations.headers - package org.eclipse.microprofile.openapi.annotations.headers: An annotation to describe a single header object.
org.eclipse.microprofile.openapi.annotations.info - package org.eclipse.microprofile.openapi.annotations.info: A set of annotations to represent metadata about the API, including license information and contact information of the exposed API.
org.eclipse.microprofile.openapi.annotations.links - package org.eclipse.microprofile.openapi.annotations.links: Annotations to represent a design-time link for a response and the corresponding parameter to be passed to the linked operation.
org.eclipse.microprofile.openapi.annotations.media - package org.eclipse.microprofile.openapi.annotations.media: A set of annotations to represent input and output data type, media type and relevant examples.
org.eclipse.microprofile.openapi.annotations.parameters - package org.eclipse.microprofile.openapi.annotations.parameters: A set of annotations to describe and encapsulate operation parameters and operation's request body.
org.eclipse.microprofile.openapi.annotations.responses - package org.eclipse.microprofile.openapi.annotations.responses: Contains annotation to describe a single response from an API operation, and an annotation to encapsulate multiple responses from an API operation.
org.eclipse.microprofile.openapi.annotations.security - package org.eclipse.microprofile.openapi.annotations.security: A set of annotations to represent various security components of an OpenAPI app.
org.eclipse.microprofile.openapi.annotations.servers - package org.eclipse.microprofile.openapi.annotations.servers: Annotations to represent servers used for a single API operation or for all operations in an OpenAPI document, as well as a way to represent variables for server URL template substitution.
org.eclipse.microprofile.openapi.annotations.tags - package org.eclipse.microprofile.openapi.annotations.tags: A set of annotations to represent a tag for an API endpoint and a container that encapsulates multiple such tags.
org.eclipse.microprofile.openapi.models - package org.eclipse.microprofile.openapi.models: A set of interfaces for programmable models and their helper classes, many derived from Swagger Core library.
org.eclipse.microprofile.openapi.models.callbacks - package org.eclipse.microprofile.openapi.models.callbacks: An interface to represent callback URL.
org.eclipse.microprofile.openapi.models.examples - package org.eclipse.microprofile.openapi.models.examples: An interface to represent a programmable model of an example of a data type or a media type.
org.eclipse.microprofile.openapi.models.headers - package org.eclipse.microprofile.openapi.models.headers: An interface of a programmable model to represent a single header object.
org.eclipse.microprofile.openapi.models.info - package org.eclipse.microprofile.openapi.models.info: A set of interfaces of programmable models to represent metadata about the API, including license information and contact information of the exposed API.
org.eclipse.microprofile.openapi.models.links - package org.eclipse.microprofile.openapi.models.links: An interface of a model to represent a design-time link for a response.
org.eclipse.microprofile.openapi.models.media - package org.eclipse.microprofile.openapi.models.media: A set of interfaces for programmable models to represent input and output data types and media types.
org.eclipse.microprofile.openapi.models.parameters - package org.eclipse.microprofile.openapi.models.parameters: A set of model interfaces to describe operation parameters and operation's request body.
org.eclipse.microprofile.openapi.models.responses - package org.eclipse.microprofile.openapi.models.responses: Model interfaces to describe a single response from an API operation, and an annotation to encapsulate multiple responses from an API operation.
org.eclipse.microprofile.openapi.models.security - package org.eclipse.microprofile.openapi.models.security: A set of model interfaces to represent various security components of an OpenAPI app.
org.eclipse.microprofile.openapi.models.servers - package org.eclipse.microprofile.openapi.models.servers: Model interfaces to represent servers used for a single API operation or for all operations in an OpenAPI document, as well as a way to represent variables for server URL template substitution.
org.eclipse.microprofile.openapi.models.tags - package org.eclipse.microprofile.openapi.models.tags: Model interface to represent a tag of an API endpoint.
org.eclipse.microprofile.openapi.spi - package org.eclipse.microprofile.openapi.spi: Service provider interface which allows vendors to set their implementations of OASFactoryResolver.

P

Parameter - Interface in org.eclipse.microprofile.openapi.models.parameters: Parameter
Parameter - Annotation Type in org.eclipse.microprofile.openapi.annotations.parameters: Describes a single operation parameter
Parameter.In - Enum in org.eclipse.microprofile.openapi.models.parameters: The values allowed for the in field.
Parameter.Style - Enum in org.eclipse.microprofile.openapi.models.parameters: The values allowed for the style field.
ParameterIn - Enum in org.eclipse.microprofile.openapi.annotations.enums
parameters() - Method in annotation type org.eclipse.microprofile.openapi.annotations.callbacks.CallbackOperation: An array of parameters applicable for this callback operation, which will be added to any automatically detected parameters in the method itself.
parameters() - Method in annotation type org.eclipse.microprofile.openapi.annotations.Components: An object to hold reusable Parameter Objects.
parameters() - Method in annotation type org.eclipse.microprofile.openapi.annotations.links.Link: Array of parameters to pass to an operation as specified with operationId or identified via operationRef.
parameters(List<Parameter>) - Method in interface org.eclipse.microprofile.openapi.models.Operation: Sets this Operation's parameters property to the given parameter list.
parameters(List<Parameter>) - Method in interface org.eclipse.microprofile.openapi.models.PathItem: Sets this PathItem's parameters property to the given list.
parameters(Map<String, Object>) - Method in interface org.eclipse.microprofile.openapi.models.links.Link: Sets this Link's parameters property to the given map and returns the modified Link instance.
parameters(Map<String, Parameter>) - Method in interface org.eclipse.microprofile.openapi.models.Components: Sets this Components' parameters property to the given Map containing keys and reusable parameter objects.
Parameters - Annotation Type in org.eclipse.microprofile.openapi.annotations.parameters: This object encapsulates input parameters
ParameterStyle - Enum in org.eclipse.microprofile.openapi.annotations.enums
parseValue() - Method in annotation type org.eclipse.microprofile.openapi.annotations.extensions.Extension: Should the value be parsed into an object/array or other simple type (number, boolean, etc) or left as a simple String.
password() - Method in annotation type org.eclipse.microprofile.openapi.annotations.security.OAuthFlows: Configuration for the OAuth Resource Owner Password flow.
password(OAuthFlow) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlows: OAuth Resource Owner Password flow
PATCH - org.eclipse.microprofile.openapi.models.PathItem.HttpMethod
PATCH(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem: Sets this PathItem's patch property to the given operation.
PATH - org.eclipse.microprofile.openapi.annotations.enums.ParameterIn
PATH - org.eclipse.microprofile.openapi.models.parameters.Parameter.In
PathItem - Interface in org.eclipse.microprofile.openapi.models: PathItem
PathItem.HttpMethod - Enum in org.eclipse.microprofile.openapi.models: All of the possible types of HTTP operations for this path
paths(Paths) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI: Sets this OpenAPI instance's paths property to the given paths.
Paths - Interface in org.eclipse.microprofile.openapi.models: Paths
pattern() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Schema: A pattern that the value must satisfy.
pattern() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.SchemaProperty: A pattern that the value must satisfy.
pattern(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the pattern property of this Schema instance to the string given.
PIPE_DELIMITED - org.eclipse.microprofile.openapi.models.media.Encoding.Style
PIPEDELIMITED - org.eclipse.microprofile.openapi.annotations.enums.ParameterStyle
PIPEDELIMITED - org.eclipse.microprofile.openapi.models.parameters.Parameter.Style
POST - org.eclipse.microprofile.openapi.models.PathItem.HttpMethod
POST(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem: Sets this PathItem's post property to the given operation.
prefix(String) - Method in interface org.eclipse.microprofile.openapi.models.media.XML: This method sets the prefix property of XML instance to the given String argument and returns the modified instance.
properties() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Schema: Provides a list of properties present in this schema.
properties(Map<String, Schema>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the properties of this Schema instance to the map provided.
propertyName(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Discriminator: Sets this Discriminator's propertyName property to the given string.
PUT - org.eclipse.microprofile.openapi.models.PathItem.HttpMethod
PUT(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem: Sets this PathItem's put property to the given operation.

Q

QUERY - org.eclipse.microprofile.openapi.annotations.enums.ParameterIn
QUERY - org.eclipse.microprofile.openapi.annotations.enums.SecuritySchemeIn
QUERY - org.eclipse.microprofile.openapi.models.parameters.Parameter.In
QUERY - org.eclipse.microprofile.openapi.models.security.SecurityScheme.In

R

readOnly() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Schema: Relevant only for Schema "properties" definitions.
readOnly() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.SchemaProperty: Relevant only for Schema "properties" definitions.
readOnly(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the readOnly property of this Schema.
ref() - Method in annotation type org.eclipse.microprofile.openapi.annotations.callbacks.Callback: Reference value to a Callback object.
ref() - Method in annotation type org.eclipse.microprofile.openapi.annotations.headers.Header: Reference value to a Header object.
ref() - Method in annotation type org.eclipse.microprofile.openapi.annotations.links.Link: Reference value to a Link object.
ref() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.ExampleObject: Reference value to an Example object.
ref() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Schema: Reference value to a Schema definition.
ref() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.SchemaProperty: Reference value to a Schema definition.
ref() - Method in annotation type org.eclipse.microprofile.openapi.annotations.parameters.Parameter: Reference value to a Parameter object.
ref() - Method in annotation type org.eclipse.microprofile.openapi.annotations.parameters.RequestBody: Reference value to a RequestBody object.
ref() - Method in annotation type org.eclipse.microprofile.openapi.annotations.responses.APIResponse: Reference value to a Response object.
ref() - Method in annotation type org.eclipse.microprofile.openapi.annotations.security.SecurityScheme: Reference value to a SecurityScheme object.
ref() - Method in annotation type org.eclipse.microprofile.openapi.annotations.tags.Tag: Reference value to a Tag object.
ref(String) - Method in interface org.eclipse.microprofile.openapi.models.Reference: Sets this Reference's reference property to the given string.
Reference<T extends Reference<T>> - Interface in org.eclipse.microprofile.openapi.models: Base interface for OpenAPI model objects that can make reference to other objects.
refreshUrl() - Method in annotation type org.eclipse.microprofile.openapi.annotations.security.OAuthFlow: The URL to be used for obtaining refresh tokens.
refreshUrl(String) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlow: The URL to be used for obtaining refresh tokens.
refs() - Method in annotation type org.eclipse.microprofile.openapi.annotations.tags.Tags: An array of referenced Tag objects which hold metadata for the API
removeAllOf(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Removes the given Schema to the list of schemas used by the allOf property.
removeAnyOf(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Removes the given Schema to the list of schemas used by the anyOf property.
removeAPIResponse(String) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponses: Removes the given APIResponse to this APIResponses.
removeCallback(String) - Method in interface org.eclipse.microprofile.openapi.models.Components: Removes the given callback to this Components' map of callbacks with the given string as its key.
removeCallback(String) - Method in interface org.eclipse.microprofile.openapi.models.Operation: Removes the given callback item to this Operation's map of callbacks.
removeEncoding(String) - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType: Removes an Encoding item to the encoding property of a MediaType instance.
removeEnumeration(Object) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Removes an item of the appropriate type to the enumerated list of values allowed.
removeEnumeration(String) - Method in interface org.eclipse.microprofile.openapi.models.servers.ServerVariable: This method removes a string item to enumeration list of a ServerVariable instance.
removeExample(String) - Method in interface org.eclipse.microprofile.openapi.models.Components: Removes the given example to this Components' map of examples with the given string as its key.
removeExample(String) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header: Removes an example of the header using the specified key to this Header instance.
removeExample(String) - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType: Removes an example item to the examples map of a MediaType instance.
removeExample(String) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter: Removes an example of the parameter using the specified key.
removeExtension(String) - Method in interface org.eclipse.microprofile.openapi.models.Extensible: Removes the given object to this Extensible's map of extensions, with the given name as its key.
removeHeader(String) - Method in interface org.eclipse.microprofile.openapi.models.Components: Removes the given header to this Components' map of headers with the given string as its key.
removeHeader(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding: Removes the given header to this Encoding' list of headers with the given string as its key.
removeHeader(String) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponse: Removes the given Header to this ApiResponse instance's map of Headers with the given name and return this instance of ApiResponse.
removeLink(String) - Method in interface org.eclipse.microprofile.openapi.models.Components: Removes the given link to this Components' map of links with the given string as its key.
removeLink(String) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponse: Removes a link to this instance of ApiResponse using the given name and Link.
removeMapping(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Discriminator: Remove the given name to the given value and stores it in this Discriminator's mapping property.
removeMediaType(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Content: Removes the given MediaType for this Content by its name.
removeOneOf(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Removes the given Schema to the list of schemas used by the oneOf property.
removeParameter(String) - Method in interface org.eclipse.microprofile.openapi.models.Components: Removes the given parameter to this Components' map of parameters with the given string as its key.
removeParameter(String) - Method in interface org.eclipse.microprofile.openapi.models.links.Link: Remove a new parameter to the parameters property of this instance of Link.
removeParameter(Parameter) - Method in interface org.eclipse.microprofile.openapi.models.Operation: Removes the given parameter item to this Operation's list of parameters.
removeParameter(Parameter) - Method in interface org.eclipse.microprofile.openapi.models.PathItem: Removes the given parameter to this PathItem's list of parameters.
removePathItem(String) - Method in interface org.eclipse.microprofile.openapi.models.callbacks.Callback: Removes the given path item of the Callback PathItems.
removePathItem(String) - Method in interface org.eclipse.microprofile.openapi.models.Paths: Removes the given path item to this Paths.
removeProperty(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Removes a Schema property of the provided name using the given schema.
removeRequestBody(String) - Method in interface org.eclipse.microprofile.openapi.models.Components: Removes the given request body to this Components' map of request bodies with the given string as its key.
removeRequired(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Removes the name of an item to the list of fields required in objects defined by this Schema.
removeResponse(String) - Method in interface org.eclipse.microprofile.openapi.models.Components: Removes the given response to this Components' map of responses with the given string as its key.
removeSchema(String) - Method in interface org.eclipse.microprofile.openapi.models.Components: Removes the given schema to this Components' list of schemas with the given string as its key.
removeScheme(String) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityRequirement: Removes a security scheme to the SecurityRequirement instance based on the scheme name.
removeScope(String) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlow: Removes the given scope item to this scope mapping.
removeSecurityRequirement(SecurityRequirement) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI: Removes the given security requirement to this OpenAPI instance's list of security requirements.
removeSecurityRequirement(SecurityRequirement) - Method in interface org.eclipse.microprofile.openapi.models.Operation: Removes the given security requirement item to this Operation's list of security mechanisms.
removeSecurityScheme(String) - Method in interface org.eclipse.microprofile.openapi.models.Components: Removes the given security scheme to this Components' map of security schemes with the given string as its key.
removeServer(Server) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI: Removes the given server to this OpenAPI instance's list of servers.
removeServer(Server) - Method in interface org.eclipse.microprofile.openapi.models.Operation: Removes the given server to this Operation's list of servers.
removeServer(Server) - Method in interface org.eclipse.microprofile.openapi.models.PathItem: Removes the given server to this PathItem's list of servers.
removeTag(String) - Method in interface org.eclipse.microprofile.openapi.models.Operation: Removes the given tag to this Operation's list of tags.
removeTag(Tag) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI: Removes the given tag to this OpenAPI instance's list of tags.
removeVariable(String) - Method in interface org.eclipse.microprofile.openapi.models.servers.Server: Removes the given server variable item from the Server's map of variables
requestBodies() - Method in annotation type org.eclipse.microprofile.openapi.annotations.Components: An object to hold reusable Request Body Objects.
requestBodies(Map<String, RequestBody>) - Method in interface org.eclipse.microprofile.openapi.models.Components: Sets this Components' requestBodies property to the given Map containing keys and reusable request body objects.
requestBody() - Method in annotation type org.eclipse.microprofile.openapi.annotations.callbacks.CallbackOperation: The request body applicable for this callback operation.
requestBody() - Method in annotation type org.eclipse.microprofile.openapi.annotations.links.Link: A literal value or {expression} to use as a request body when calling the target operation.
requestBody(Object) - Method in interface org.eclipse.microprofile.openapi.models.links.Link: Sets this Link's requestBody property to the given object.
requestBody(RequestBody) - Method in interface org.eclipse.microprofile.openapi.models.Operation: Sets this Operation's requestBody property to the given object.
RequestBody - Interface in org.eclipse.microprofile.openapi.models.parameters: This interface represents the request body of an operation in which body parameters can be specified.
RequestBody - Annotation Type in org.eclipse.microprofile.openapi.annotations.parameters: Describes a single request body.
RequestBodySchema - Annotation Type in org.eclipse.microprofile.openapi.annotations.parameters: Provides a reference to a class that (after introspection) describes the schema for a single request body.
required() - Method in annotation type org.eclipse.microprofile.openapi.annotations.headers.Header: Determines whether this header is mandatory.
required() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Schema: Mandates whether the annotated item is required or not.
required() - Method in annotation type org.eclipse.microprofile.openapi.annotations.parameters.Parameter: Determines whether this parameter is mandatory.
required() - Method in annotation type org.eclipse.microprofile.openapi.annotations.parameters.RequestBody: Determines if the request body is required in the request.
required(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header: Sets this Header's required property to the given value.
required(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter: Sets the required property of a Parameter instance to the given value.
required(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.parameters.RequestBody: Sets whether this instance of RequestBody is required or not and returns this instance of RequestBody
required(List<String>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the list of fields required in objects defined by this Schema.
requiredProperties() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Schema: Allows multiple properties in an object to be marked as required.
requiredProperties() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.SchemaProperty: Allows multiple properties in an object to be marked as required.
responseCode() - Method in annotation type org.eclipse.microprofile.openapi.annotations.responses.APIResponse: The HTTP response code, or 'default', for the supplied response.
responseCode() - Method in annotation type org.eclipse.microprofile.openapi.annotations.responses.APIResponseSchema: The HTTP response code, or 'default', for the supplied response.
responseDescription() - Method in annotation type org.eclipse.microprofile.openapi.annotations.responses.APIResponseSchema: A short description of the response.
responses() - Method in annotation type org.eclipse.microprofile.openapi.annotations.callbacks.CallbackOperation: This is a REQUIRED property of an callback operation instance.
responses() - Method in annotation type org.eclipse.microprofile.openapi.annotations.Components: An object to hold reusable Response Objects.
responses(Map<String, APIResponse>) - Method in interface org.eclipse.microprofile.openapi.models.Components: Sets this Components' responses property to the given Map containing keys and reusable response objects.
responses(APIResponses) - Method in interface org.eclipse.microprofile.openapi.models.Operation: Sets this Operation's responses property to the given responses.

S

SCAN_BEANVALIDATION - Static variable in class org.eclipse.microprofile.openapi.OASConfig: Configuration property to enable or disable scanning Jakarta Bean Validation annotations
SCAN_CLASSES - Static variable in class org.eclipse.microprofile.openapi.OASConfig: Configuration property to specify the list of classes to scan.
SCAN_DISABLE - Static variable in class org.eclipse.microprofile.openapi.OASConfig: Configuration property to disable annotation scanning.
SCAN_EXCLUDE_CLASSES - Static variable in class org.eclipse.microprofile.openapi.OASConfig: Configuration property to specify the list of classes to exclude from scans.
SCAN_EXCLUDE_PACKAGES - Static variable in class org.eclipse.microprofile.openapi.OASConfig: Configuration property to specify the list of packages to exclude from scans.
SCAN_PACKAGES - Static variable in class org.eclipse.microprofile.openapi.OASConfig: Configuration property to specify the list of packages to scan.
schema() - Method in annotation type org.eclipse.microprofile.openapi.annotations.headers.Header: The schema defining the type used for the header.
schema() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Content: The schema defining the type used for the request body.
schema() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.DiscriminatorMapping: The schema that is being mapped to a property value
schema() - Method in annotation type org.eclipse.microprofile.openapi.annotations.parameters.Parameter: The schema defining the type used for the parameter.
schema(Schema) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header: Sets this Header's schema property to the given object.
schema(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType: Sets the schema field of a MediaType instance to the given schema object.
schema(Schema) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter: Sets the schema property of a Parameter instance to the given value.
Schema - Interface in org.eclipse.microprofile.openapi.models.media: The Schema Object allows the definition of input and output data types.
Schema - Annotation Type in org.eclipse.microprofile.openapi.annotations.media: The Schema Object allows the definition of input and output data types.
SCHEMA_PREFIX - Static variable in class org.eclipse.microprofile.openapi.OASConfig: Prefix of the configuration property to specify a schema for a specific class, in JSON format.
Schema.False - Class in org.eclipse.microprofile.openapi.annotations.media: Marker class for use in additionalProperties to indicate that the corresponding schema's additionalPropertiesBoolean value is to be set to boolean false.
Schema.SchemaType - Enum in org.eclipse.microprofile.openapi.models.media: The values allowed for the in field.
Schema.True - Class in org.eclipse.microprofile.openapi.annotations.media: Marker class for use in additionalProperties to indicate that the corresponding schema's additionalPropertiesBoolean value is to be set to boolean true.
SchemaProperty - Annotation Type in org.eclipse.microprofile.openapi.annotations.media: The SchemaProperty Object allows the definition of input and output data types nested within the properties attribute of a Schema annotation.
schemas() - Method in annotation type org.eclipse.microprofile.openapi.annotations.Components: An object to hold reusable Schema Objects.
schemas(Map<String, Schema>) - Method in interface org.eclipse.microprofile.openapi.models.Components: Sets this Components' schemas property to the given Map containing keys and reusable schemas.
SchemaType - Enum in org.eclipse.microprofile.openapi.annotations.enums
scheme() - Method in annotation type org.eclipse.microprofile.openapi.annotations.security.SecurityScheme: Applies to and is REQUIRED for SecurityScheme of http type.
scheme(String) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme: Schema is a REQUIRED property that is the name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.
scopes() - Method in annotation type org.eclipse.microprofile.openapi.annotations.security.OAuthFlow: This is a REQUIRED property.
scopes() - Method in annotation type org.eclipse.microprofile.openapi.annotations.security.SecurityRequirement: If the security scheme referred by the name property is of type "oauth2" or "openIdConnect", then the scopes array is a list of scope names required for the execution.
scopes(Map<String, String>) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlow: The available scopes for the OAuth2 security scheme.
security() - Method in annotation type org.eclipse.microprofile.openapi.annotations.callbacks.CallbackOperation: A declaration of which security mechanisms can be used for this callback operation.
security() - Method in annotation type org.eclipse.microprofile.openapi.annotations.OpenAPIDefinition: A declaration of which security mechanisms can be used across the API.
security(List<SecurityRequirement>) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI: Sets this OpenAPI instance's security property to the given list.
security(List<SecurityRequirement>) - Method in interface org.eclipse.microprofile.openapi.models.Operation: Sets this Operation's security property to the given list.
SecurityRequirement - Interface in org.eclipse.microprofile.openapi.models.security: SecurityRequirement
SecurityRequirement - Annotation Type in org.eclipse.microprofile.openapi.annotations.security: Specifies a security requirement for an operation.
SecurityRequirements - Annotation Type in org.eclipse.microprofile.openapi.annotations.security: Container annotation for repeated SecurityRequirement annotations.
SecurityRequirementsSet - Annotation Type in org.eclipse.microprofile.openapi.annotations.security: This annotation represents a set of security requirements which permit access to an operation if all of them are satisfied.
SecurityRequirementsSets - Annotation Type in org.eclipse.microprofile.openapi.annotations.security: Represents an array of security requirement sets that apply to an operation.
SecurityScheme - Interface in org.eclipse.microprofile.openapi.models.security: SecurityScheme
SecurityScheme - Annotation Type in org.eclipse.microprofile.openapi.annotations.security: Defines a security scheme that can be used by the operations.
SecurityScheme.In - Enum in org.eclipse.microprofile.openapi.models.security: In is a REQUIRED property that specifies the location of the API key.
SecurityScheme.Type - Enum in org.eclipse.microprofile.openapi.models.security: Type is a REQUIRED property that specifies the type of SecurityScheme instance.
SecuritySchemeIn - Enum in org.eclipse.microprofile.openapi.annotations.enums
securitySchemeName() - Method in annotation type org.eclipse.microprofile.openapi.annotations.security.SecurityScheme: The name of this SecurityScheme.
securitySchemes() - Method in annotation type org.eclipse.microprofile.openapi.annotations.Components: An object to hold reusable Security Scheme Objects.
securitySchemes(Map<String, SecurityScheme>) - Method in interface org.eclipse.microprofile.openapi.models.Components: Sets this Components' securitySchemes property to the given Map containing keys and reusable security scheme objects.
SecuritySchemes - Annotation Type in org.eclipse.microprofile.openapi.annotations.security: This object represents an array of SecurityScheme annotations that can be specified at the definition level.
SecuritySchemeType - Enum in org.eclipse.microprofile.openapi.annotations.enums
securitySets() - Method in annotation type org.eclipse.microprofile.openapi.annotations.callbacks.CallbackOperation: A declaration of which security mechanisms can be used for this callback operation.
securitySets() - Method in annotation type org.eclipse.microprofile.openapi.annotations.OpenAPIDefinition: A declaration of which security mechanisms can be used across the API.
server() - Method in annotation type org.eclipse.microprofile.openapi.annotations.links.Link: An alternative server to service this operation.
server(Server) - Method in interface org.eclipse.microprofile.openapi.models.links.Link: Sets this Link's server property to the given object.
Server - Interface in org.eclipse.microprofile.openapi.models.servers: An object representing a server.
Server - Annotation Type in org.eclipse.microprofile.openapi.annotations.servers: This annotation represents a Server used in an operation or used by all operations in an OpenAPI document.
servers() - Method in annotation type org.eclipse.microprofile.openapi.annotations.OpenAPIDefinition: An array of Server Objects, which provide connectivity information to a target server.
servers(List<Server>) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI: Sets this OpenAPI instance's servers property to the given servers.
servers(List<Server>) - Method in interface org.eclipse.microprofile.openapi.models.Operation: Sets this Operation's servers property to the given list.
servers(List<Server>) - Method in interface org.eclipse.microprofile.openapi.models.PathItem: Sets this PathItem's servers property to the given list.
Servers - Annotation Type in org.eclipse.microprofile.openapi.annotations.servers: The Servers annotation is a container for @Server annotations.
SERVERS - Static variable in class org.eclipse.microprofile.openapi.OASConfig: Configuration property to specify the list of global servers that provide connectivity information.
SERVERS_OPERATION_PREFIX - Static variable in class org.eclipse.microprofile.openapi.OASConfig: Prefix of the configuration property to specify an alternative list of servers to service an operation.
SERVERS_PATH_PREFIX - Static variable in class org.eclipse.microprofile.openapi.OASConfig: Prefix of the configuration property to specify an alternative list of servers to service all operations in a path.
ServerVariable - Interface in org.eclipse.microprofile.openapi.models.servers: An object representing a Server Variable for server URL template substitution.
ServerVariable - Annotation Type in org.eclipse.microprofile.openapi.annotations.servers: An object representing a Server Variable for server URL template substitution.
setAdditionalPropertiesBoolean(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the value of "additionalProperties" to either True or False.
setAdditionalPropertiesSchema(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the Schema which defines additional properties not defined by "properties" or "patternProperties".
setAllOf(List<Schema>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the schemas used by the allOf property of this Schema.
setAllowEmptyValue(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header: Sets this Header's allowEmptyValue property to the given value.
setAllowEmptyValue(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter: Sets the allowEmptyValue property of a Parameter instance to the given value.
setAllowReserved(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding: AllowReserved determines whether the parameter value SHOULD allow reserved characters to be encoded without percent-encoding.
setAllowReserved(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter: Sets the allowReserved property of a Parameter instance to the given value.
setAnyOf(List<Schema>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the schemas used by the anyOf property of this Schema.
setAPIResponses(Map<String, APIResponse>) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponses: Set the APIResponses map to this APIResponses
setAttribute(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.XML: This method sets the attribute property of XML instance to the given Boolean argument.
setAuthorizationCode(OAuthFlow) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlows: OAuth Authorization Code flow; previously called accessCode in OpenAPI 2.0
setAuthorizationUrl(String) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlow: The authorization URL to be used for this flow.
setBearerFormat(String) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme: bearerFormat is intended as a hint to the client to identify how the bearer token is formatted.
setCallbacks(Map<String, Callback>) - Method in interface org.eclipse.microprofile.openapi.models.Components: Sets this Components' callbacks property to the given Map containing keys and reusable callback objects.
setCallbacks(Map<String, Callback>) - Method in interface org.eclipse.microprofile.openapi.models.Operation: Sets this Operation's callbacks property to the given map.
setClientCredentials(OAuthFlow) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlows: OAuth Client Credential flow; previously called application in OpenAPI 2.0
setComponents(Components) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI: Sets this OpenAPI instance's components property to the given components.
setContact(Contact) - Method in interface org.eclipse.microprofile.openapi.models.info.Info: Sets this Info instance's contact information for the exposed API.
setContent(Content) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header: Sets this Header's content property to the given object.
setContent(Content) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter: Sets the content property of a Parameter instance to the given object.
setContent(Content) - Method in interface org.eclipse.microprofile.openapi.models.parameters.RequestBody: Sets the content of this instance of RequestBody, where the keys in content are media type names and the values describe it.
setContent(Content) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponse: Sets the map containing descriptions of potential response payload for this instance of ApiResponse.
setContentType(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding: The Content-Type for encoding a specific property.
setDefaultValue(Object) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Set the default value property of this Schema instance to the value given.
setDefaultValue(String) - Method in interface org.eclipse.microprofile.openapi.models.servers.ServerVariable: The default value to use for substitution, and to send, if an alternate value is not supplied.
setDefaultValue(APIResponse) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponses: Sets the default documentation of responses for this instance of ApiResponses.
setDELETE(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem: Sets this PathItem's delete property to the given operation.
setDeprecated(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header: Sets this Header's deprecated property to the given value.
setDeprecated(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the deprecated property of this Schema.
setDeprecated(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.Operation: Sets this Operation's deprecated property to the given value.
setDeprecated(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter: Sets the deprecated property of a Parameter instance to the given value.
setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.examples.Example: Sets this Example's description property to the given string.
setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.ExternalDocumentation: Sets this ExternalDocumentation's description property to the given string.
setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header: Sets this Header's description property to the given string.
setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.info.Info: Sets this Info instance's description for the application to the given description.
setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.links.Link: Sets this Link's description property to the given string.
setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the description property of this Schema to the given string.
setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.Operation: Sets this Operation's description property to the given string.
setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter: Sets the description property of a Parameter instance to the given string.
setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.parameters.RequestBody: Sets the description of this instance of RequestBody.
setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.PathItem: Sets this PathItem's description property to the given string.
setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponse: Sets the description of this instance of ApiResponse.
setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme: A short description for security schema.
setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.servers.Server: This method sets the description property of a Server instance to the given description parameter.
setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.servers.ServerVariable: This method sets the description property of ServerVariable instance to the given description argument.
setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.tags.Tag: Sets the description property of a Tag instance to the given string.
setDiscriminator(Discriminator) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the discriminator property of this Schema instance to the given object.
setEmail(String) - Method in interface org.eclipse.microprofile.openapi.models.info.Contact: Sets the contact email of this instance of Contact.
setEncoding(Map<String, Encoding>) - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType: Sets encoding property of a MediaType instance to the given map object.
setEnumeration(List<Object>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the enumerated list of values allowed for objects defined by this Schema.
setEnumeration(List<String>) - Method in interface org.eclipse.microprofile.openapi.models.servers.ServerVariable: This method sets the enumeration property of ServerVariable instance to the given enumeration argument.
setExample(Object) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header: Sets this Header's example property to the given object.
setExample(Object) - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType: Sets the example property of a MediaType instance to the given value.
setExample(Object) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the example property of this Schema instance.
setExample(Object) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter: Sets the example property of a Parameter instance to the given object.
setExamples(Map<String, Example>) - Method in interface org.eclipse.microprofile.openapi.models.Components: Sets this Components' examples property to the given Map containing keys and reusable example objects.
setExamples(Map<String, Example>) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header: Sets the examples property of this Header instance to the given map.
setExamples(Map<String, Example>) - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType: Sets the examples field of a MediaType instance to the given map object.
setExamples(Map<String, Example>) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter: Sets the examples property of a Parameter instance to the given value.
setExclusiveMaximum(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the exclusiveMaximum property of this Schema instance to the value given.
setExclusiveMinimum(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the exclusiveMinimum property of this Schema instance to the value given.
setExplode(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header: Sets this Header's explode property to the given value.
setExplode(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding: When this is true, property values of type array or object generate separate parameters for each value of the array, or key-value-pair of the map.
setExplode(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter: Sets the explode property of a Parameter instance to the given value.
setExtensions(Map<String, Object>) - Method in interface org.eclipse.microprofile.openapi.models.Extensible: Sets this Extensible's extensions property to the given map of extensions.
setExternalDocs(ExternalDocumentation) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the externalDocs property of this Schema to the indicated value.
setExternalDocs(ExternalDocumentation) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI: Sets this OpenAPI instance's externalDocs property to the given object.
setExternalDocs(ExternalDocumentation) - Method in interface org.eclipse.microprofile.openapi.models.Operation: Sets this Operation's externalDocs property to the given object.
setExternalDocs(ExternalDocumentation) - Method in interface org.eclipse.microprofile.openapi.models.tags.Tag: Sets the externalDocs property of a Tag instance to the given object.
setExternalValue(String) - Method in interface org.eclipse.microprofile.openapi.models.examples.Example: Sets this Example's externalValue property to the given string.
setFlows(OAuthFlows) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme: Flows is a REQUIRED property.
setFormat(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the format property of this Schema instance to the given string.
setGET(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem: Sets this PathItem's get property to the given operation.
setHEAD(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem: Sets this PathItem's head property to the given operation.
setHeaders(Map<String, Header>) - Method in interface org.eclipse.microprofile.openapi.models.Components: Sets this Components' headers property to the given Map containing keys and reusable header objects.
setHeaders(Map<String, Header>) - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding: Headers property of an Encoding is a map that allows additional information to be provided as headers
setHeaders(Map<String, Header>) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponse: Sets the Headers for this instance of ApiResponse with the given map of Headers.
setImplicit(OAuthFlow) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlows: This method sets the implicit property of OAuthFlows instance to the given implicit argument.
setIn(Parameter.In) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter: Sets the in property of a Parameter instance to the given value.
setIn(SecurityScheme.In) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme: In is a REQUIRED property that indicates the location of the API key.
setInfo(Info) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI: Sets this OpenAPI instance's info property to the given object.
setInstance(OASFactoryResolver) - Static method in class org.eclipse.microprofile.openapi.spi.OASFactoryResolver: Set the instance.
setItems(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Set the Schema used for all the elements of an array typed Schema.
setLicense(License) - Method in interface org.eclipse.microprofile.openapi.models.info.Info: Sets this Info's license information for the exposed API.
setLinks(Map<String, Link>) - Method in interface org.eclipse.microprofile.openapi.models.Components: Sets this Components' links property to the given Map containing keys and reusable link objects.
setLinks(Map<String, Link>) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponse: Sets the operations links that can be followed from this instance of ApiResponse.
setMapping(Map<String, String>) - Method in interface org.eclipse.microprofile.openapi.models.media.Discriminator: Sets this Discriminator's mapping property to the given map object.
setMaximum(BigDecimal) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the maximum property of this Schema instance to the value given.
setMaxItems(Integer) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the maxItems property of this Schema instance to the value given.
setMaxLength(Integer) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the maxLength property of this Schema instance to the value given.
setMaxProperties(Integer) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the maxProperties property of this Schema instance to the value given.
setMediaTypes(Map<String, MediaType>) - Method in interface org.eclipse.microprofile.openapi.models.media.Content: Set the media types map to this Content
setMinimum(BigDecimal) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the minimum property of this Schema instance to the value given.
setMinItems(Integer) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the minItems property of this Schema instance to the value given.
setMinLength(Integer) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the minLength property of this Schema instance to the value given.
setMinProperties(Integer) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the minProperties property of this Schema instance to the value given.
setMultipleOf(BigDecimal) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the multipleOf property of this Schema instance to the value given.
setName(String) - Method in interface org.eclipse.microprofile.openapi.models.info.Contact: Sets the identifying name of this Contact instance.
setName(String) - Method in interface org.eclipse.microprofile.openapi.models.info.License: Sets the license name for this License instance that is used for the API.
setName(String) - Method in interface org.eclipse.microprofile.openapi.models.media.XML: This method sets the name property of XML instance to the given String argument.
setName(String) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter: Sets the name property of a Parameter instance to the given string.
setName(String) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme: Name is a REQUIRED property - this is the name of the header, query or cookie parameter to be used.
setName(String) - Method in interface org.eclipse.microprofile.openapi.models.tags.Tag: Sets the name property of a Tag instance to the given string.
setNamespace(String) - Method in interface org.eclipse.microprofile.openapi.models.media.XML: This method sets the namespace property of XML instance to the given String argument.
setNot(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the not property to a Schema which describes properties not allowed in objects defined by the current schema.
setNullable(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the nullable property of this Schema instance.
setOneOf(List<Schema>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the schemas used by the oneOf property of this Schema.
setOpenapi(String) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI: Sets this OpenAPI instance's openapi property to the given string.
setOpenIdConnectUrl(String) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme: openIdConnectUrl is a REQUIRED property.
setOperation(PathItem.HttpMethod, Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem: Sets an operation for a given http method.
setOperationId(String) - Method in interface org.eclipse.microprofile.openapi.models.links.Link: Sets this Link's operationId property to the given string.
setOperationId(String) - Method in interface org.eclipse.microprofile.openapi.models.Operation: Sets this Operation's operationId property to the given string.
setOperationRef(String) - Method in interface org.eclipse.microprofile.openapi.models.links.Link: Sets this Link's operationRef property to the given string.
setOPTIONS(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem: Sets this PathItem's options property to the given operation.
setParameters(List<Parameter>) - Method in interface org.eclipse.microprofile.openapi.models.Operation: Sets this Operation's parameters property to the given parameter list.
setParameters(List<Parameter>) - Method in interface org.eclipse.microprofile.openapi.models.PathItem: Sets this PathItem's parameters property to the given list.
setParameters(Map<String, Object>) - Method in interface org.eclipse.microprofile.openapi.models.links.Link: Sets this Link's parameters property to the given map.
setParameters(Map<String, Parameter>) - Method in interface org.eclipse.microprofile.openapi.models.Components: Sets this Components' parameters property to the given Map containing keys and reusable parameter objects.
setPassword(OAuthFlow) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlows: OAuth Resource Owner Password flow
setPATCH(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem: Sets this PathItem's patch property to the given operation.
setPathItems(Map<String, PathItem>) - Method in interface org.eclipse.microprofile.openapi.models.callbacks.Callback: Set the path items map to this Callback.
setPathItems(Map<String, PathItem>) - Method in interface org.eclipse.microprofile.openapi.models.Paths: Set the path items map to this Paths
setPaths(Paths) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI: Sets this OpenAPI instance's paths property to the given paths.
setPattern(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the pattern property of this Schema instance to the string given.
setPOST(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem: Sets this PathItem's post property to the given operation.
setPrefix(String) - Method in interface org.eclipse.microprofile.openapi.models.media.XML: This method sets the prefix property of XML instance to the given String argument.
setProperties(Map<String, Schema>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the properties of this Schema instance to the map provided.
setPropertyName(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Discriminator: Sets this Discriminator's propertyName property to the given propertyName.
setPUT(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem: Sets this PathItem's put property to the given operation.
setReadOnly(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the readOnly property of this Schema.
setRef(String) - Method in interface org.eclipse.microprofile.openapi.models.Reference: Sets this Reference's reference property to the given string.
setRefreshUrl(String) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlow: The URL to be used for obtaining refresh tokens.
setRequestBodies(Map<String, RequestBody>) - Method in interface org.eclipse.microprofile.openapi.models.Components: Sets this Components' requestBodies property to the given Map containing keys and reusable request body objects.
setRequestBody(Object) - Method in interface org.eclipse.microprofile.openapi.models.links.Link: Sets this Link's requestBody property to the given object.
setRequestBody(RequestBody) - Method in interface org.eclipse.microprofile.openapi.models.Operation: Sets this Operation's requestBody property to the given object.
setRequired(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header: Sets this Header's required property to the given value.
setRequired(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter: Sets the required property of a Parameter instance to the given value.
setRequired(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.parameters.RequestBody: Sets whether this instance of RequestBody is required or not.
setRequired(List<String>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the list of fields required in objects defined by this Schema.
setResponses(Map<String, APIResponse>) - Method in interface org.eclipse.microprofile.openapi.models.Components: Sets this Components' responses property to the given Map containing keys and reusable response objects.
setResponses(APIResponses) - Method in interface org.eclipse.microprofile.openapi.models.Operation: Sets this Operation's responses property to the given responses.
setSchema(Schema) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header: Sets this Header's schema property to the given object.
setSchema(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType: Sets the schema field of a MediaType instance to the given schema object.
setSchema(Schema) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter: Sets the schema property of a Parameter instance to the given value.
setSchemas(Map<String, Schema>) - Method in interface org.eclipse.microprofile.openapi.models.Components: Sets this Components' schemas property to the given Map containing keys and reusable schema objects.
setScheme(String) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme: Schema is a REQUIRED property that is the name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.
setSchemes(Map<String, List<String>>) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityRequirement: Set all security schemes to the SecurityRequirement instance.
setScopes(Map<String, String>) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlow: The available scopes for the OAuth2 security scheme.
setSecurity(List<SecurityRequirement>) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI: Sets this OpenAPI instance's security property to the given list.
setSecurity(List<SecurityRequirement>) - Method in interface org.eclipse.microprofile.openapi.models.Operation: Sets this Operation's security property to the given list.
setSecuritySchemes(Map<String, SecurityScheme>) - Method in interface org.eclipse.microprofile.openapi.models.Components: Sets this Components' securitySchemes property to the given Map containing keys and reusable security scheme objects.
setServer(Server) - Method in interface org.eclipse.microprofile.openapi.models.links.Link: Sets this Link's server property to the given object.
setServers(List<Server>) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI: Sets this OpenAPI instance's servers property to the given servers.
setServers(List<Server>) - Method in interface org.eclipse.microprofile.openapi.models.Operation: Sets this Operation's servers property to the given list.
setServers(List<Server>) - Method in interface org.eclipse.microprofile.openapi.models.PathItem: Sets this PathItem's servers property to the given list.
setStyle(Header.Style) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header: Sets this Header's style property to the given style.
setStyle(Encoding.Style) - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding: Style describes how the encoding value will be serialized depending on the type of the parameter value.
setStyle(Parameter.Style) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter: Sets the style property of a Parameter instance to the given value.
setSummary(String) - Method in interface org.eclipse.microprofile.openapi.models.examples.Example: Sets this Example's summary property to the given string.
setSummary(String) - Method in interface org.eclipse.microprofile.openapi.models.Operation: Sets this Operation's summary property to the given string.
setSummary(String) - Method in interface org.eclipse.microprofile.openapi.models.PathItem: Sets this PathItem's summary property to the given string.
setTags(List<String>) - Method in interface org.eclipse.microprofile.openapi.models.Operation: Sets this Operation's tags property to the given tags.
setTags(List<Tag>) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI: Sets this OpenAPI instance's tags property to the given Tags.
setTermsOfService(String) - Method in interface org.eclipse.microprofile.openapi.models.info.Info: Sets this Info instance's URL to the Terms of Service for the API to the given String.
setTitle(String) - Method in interface org.eclipse.microprofile.openapi.models.info.Info: Sets this Info instance's title for the application to the given title.
setTitle(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the title property of this Schema instance to the given string.
setTokenUrl(String) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlow: The token URL to be used for this flow.
setTRACE(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem: Sets this PathItem's trace property to the given operation.
setType(Schema.SchemaType) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the type used by this Schema to the string given.
setType(SecurityScheme.Type) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme: Type is a REQUIRED property that specifies the type of SecurityScheme instance.
setUniqueItems(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the uniqueItems property of this Schema instance to the value given.
setUrl(String) - Method in interface org.eclipse.microprofile.openapi.models.ExternalDocumentation: Sets this ExternalDocumentation's url property to the given string.
setUrl(String) - Method in interface org.eclipse.microprofile.openapi.models.info.Contact: Sets this Contact instance's URL pointing to the contact information.
setUrl(String) - Method in interface org.eclipse.microprofile.openapi.models.info.License: Sets this URL for this License instance that is used for the API.
setUrl(String) - Method in interface org.eclipse.microprofile.openapi.models.servers.Server: This method sets the url property of Server instance to the given url argument, representing a URL to the target host.
setValue(Object) - Method in interface org.eclipse.microprofile.openapi.models.examples.Example: Sets this Example's value property to the given value.
setVariables(Map<String, ServerVariable>) - Method in interface org.eclipse.microprofile.openapi.models.servers.Server: This method sets the variables property of Server instance to the given variables argument.
setVersion(String) - Method in interface org.eclipse.microprofile.openapi.models.info.Info: Sets the version of the OpenAPI document for this instance of Info to the given version.
setWrapped(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.XML: This method sets the wrapped property of XML instance to the given Boolean argument.
setWriteOnly(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the writeOnly property of this Schema.
setXml(XML) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the xml property of this Schema instance.
SIMPLE - org.eclipse.microprofile.openapi.annotations.enums.ParameterStyle
SIMPLE - org.eclipse.microprofile.openapi.models.headers.Header.Style
SIMPLE - org.eclipse.microprofile.openapi.models.parameters.Parameter.Style
SPACE_DELIMITED - org.eclipse.microprofile.openapi.models.media.Encoding.Style
SPACEDELIMITED - org.eclipse.microprofile.openapi.annotations.enums.ParameterStyle
SPACEDELIMITED - org.eclipse.microprofile.openapi.models.parameters.Parameter.Style
STRING - org.eclipse.microprofile.openapi.annotations.enums.SchemaType
STRING - org.eclipse.microprofile.openapi.models.media.Schema.SchemaType
style() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Encoding: Style describes how the encoding value will be serialized depending on the type of the parameter value.
style() - Method in annotation type org.eclipse.microprofile.openapi.annotations.parameters.Parameter: Describes how the parameter value will be serialized depending on the type of the parameter value.
style(Header.Style) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header: Sets this Header's style property to the given style.
style(Encoding.Style) - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding: Style describes how the encoding value will be serialized depending on the type of the parameter value.
style(Parameter.Style) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter: Sets the style property of a Parameter instance to the given value.
summary() - Method in annotation type org.eclipse.microprofile.openapi.annotations.callbacks.CallbackOperation: Provides a brief description of what this callback operation does.
summary() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.ExampleObject: A brief summary of the purpose or context of the example
summary() - Method in annotation type org.eclipse.microprofile.openapi.annotations.Operation: Provides a brief description of what this operation does.
summary(String) - Method in interface org.eclipse.microprofile.openapi.models.examples.Example: Sets this Example's summary property to the given string.
summary(String) - Method in interface org.eclipse.microprofile.openapi.models.Operation: Sets this Operation's summary property to the given string.
summary(String) - Method in interface org.eclipse.microprofile.openapi.models.PathItem: Sets this PathItem's summary property to the given string.

T

Tag - Interface in org.eclipse.microprofile.openapi.models.tags: Tag
Tag - Annotation Type in org.eclipse.microprofile.openapi.annotations.tags: This object represents a tag.
tags() - Method in annotation type org.eclipse.microprofile.openapi.annotations.OpenAPIDefinition: A list of tags used by the specification with additional metadata.
tags(List<String>) - Method in interface org.eclipse.microprofile.openapi.models.Operation: Sets this Operation's tags property to the given tags.
tags(List<Tag>) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI: Sets this OpenAPI instance's tags property to the given tags.
Tags - Annotation Type in org.eclipse.microprofile.openapi.annotations.tags: The Tags annotation is a container for @Tag annotations.
termsOfService() - Method in annotation type org.eclipse.microprofile.openapi.annotations.info.Info: A URL to the Terms of Service for the API.
termsOfService(String) - Method in interface org.eclipse.microprofile.openapi.models.info.Info: Sets this Info instance's URL to the Terms of Service for the API to the given String and returns this instance of Info.
title() - Method in annotation type org.eclipse.microprofile.openapi.annotations.info.Info: The title of the application.
title() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Schema: A title to explain the purpose of the schema.
title() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.SchemaProperty: A title to explain the purpose of the schema.
title(String) - Method in interface org.eclipse.microprofile.openapi.models.info.Info: Sets this Info instance's title for the application to the given title and returns this instance of Info
title(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the title property of this Schema instance to the given string.
tokenUrl() - Method in annotation type org.eclipse.microprofile.openapi.annotations.security.OAuthFlow: The token URL to be used for this flow.
tokenUrl(String) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlow: The token URL to be used for this flow.
toString() - Method in enum org.eclipse.microprofile.openapi.annotations.enums.ParameterIn
toString() - Method in enum org.eclipse.microprofile.openapi.annotations.enums.ParameterStyle
toString() - Method in enum org.eclipse.microprofile.openapi.annotations.enums.SchemaType
toString() - Method in enum org.eclipse.microprofile.openapi.annotations.enums.SecuritySchemeIn
toString() - Method in enum org.eclipse.microprofile.openapi.annotations.enums.SecuritySchemeType
toString() - Method in enum org.eclipse.microprofile.openapi.models.headers.Header.Style
toString() - Method in enum org.eclipse.microprofile.openapi.models.media.Encoding.Style
toString() - Method in enum org.eclipse.microprofile.openapi.models.media.Schema.SchemaType
toString() - Method in enum org.eclipse.microprofile.openapi.models.parameters.Parameter.In
toString() - Method in enum org.eclipse.microprofile.openapi.models.parameters.Parameter.Style
toString() - Method in enum org.eclipse.microprofile.openapi.models.security.SecurityScheme.In
toString() - Method in enum org.eclipse.microprofile.openapi.models.security.SecurityScheme.Type
TRACE - org.eclipse.microprofile.openapi.models.PathItem.HttpMethod
TRACE(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem: Sets this PathItem's trace property to the given operation.
TRUE - org.eclipse.microprofile.openapi.annotations.enums.Explode
type() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Schema: Provides an override for the basic type of the schema.
type() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.SchemaProperty: Provides an override for the basic type of the schema.
type() - Method in annotation type org.eclipse.microprofile.openapi.annotations.security.SecurityScheme: The type of the security scheme.
type(Schema.SchemaType) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the type used by this Schema to the string given.
type(SecurityScheme.Type) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme: Type is a REQUIRED property that specifies the type of SecurityScheme instance.

U

uniqueItems() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Schema: Only applicable if type=array.
uniqueItems() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.SchemaProperty: Only applicable if type=array.
uniqueItems(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the uniqueItems property of this Schema instance to the value given.
url() - Method in annotation type org.eclipse.microprofile.openapi.annotations.ExternalDocumentation: The URL for the target documentation.
url() - Method in annotation type org.eclipse.microprofile.openapi.annotations.info.Contact: The URL pointing to the contact information.
url() - Method in annotation type org.eclipse.microprofile.openapi.annotations.info.License: A URL to the license used for the API.
url() - Method in annotation type org.eclipse.microprofile.openapi.annotations.servers.Server: A URL to the target host.
url(String) - Method in interface org.eclipse.microprofile.openapi.models.ExternalDocumentation: Sets this ExternalDocumentation's url property to the given string.
url(String) - Method in interface org.eclipse.microprofile.openapi.models.info.Contact: Sets this Contact instance's URL pointing to the contact information and returns this instance of Contact.
url(String) - Method in interface org.eclipse.microprofile.openapi.models.info.License: Sets this License instance's URL used for the API and returns this instance of License.
url(String) - Method in interface org.eclipse.microprofile.openapi.models.servers.Server: This method sets the url property of Server instance to the given url argument, representing a URL to the target host, and returns the modified instance.

V

value() - Method in annotation type org.eclipse.microprofile.openapi.annotations.callbacks.Callbacks: An array of Callback annotations which are a map of possible out-of band callbacks related to the parent operation
value() - Method in annotation type org.eclipse.microprofile.openapi.annotations.extensions.Extension: The extension value.
value() - Method in annotation type org.eclipse.microprofile.openapi.annotations.extensions.Extensions: An array of Extension annotations
value() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.DiscriminatorMapping: The property value that will be mapped to a Schema
value() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.ExampleObject: A string representation of the example.
value() - Method in annotation type org.eclipse.microprofile.openapi.annotations.parameters.Parameters: An array of Parameter Objects for the operation
value() - Method in annotation type org.eclipse.microprofile.openapi.annotations.parameters.RequestBodySchema: Provides a Java class as implementation for this schema.
value() - Method in annotation type org.eclipse.microprofile.openapi.annotations.responses.APIResponses: An array of APIResponse annotations
value() - Method in annotation type org.eclipse.microprofile.openapi.annotations.responses.APIResponseSchema: Provides a Java class as implementation for this schema.
value() - Method in annotation type org.eclipse.microprofile.openapi.annotations.security.SecurityRequirements: An array of SecurityRequirement annotations
value() - Method in annotation type org.eclipse.microprofile.openapi.annotations.security.SecurityRequirementsSet: The security requirements which make up the set
value() - Method in annotation type org.eclipse.microprofile.openapi.annotations.security.SecurityRequirementsSets: An array of SecurityRequirementSet annotations
value() - Method in annotation type org.eclipse.microprofile.openapi.annotations.security.SecuritySchemes: An array of SecurityScheme annotations that can be specified at definition level.
value() - Method in annotation type org.eclipse.microprofile.openapi.annotations.servers.Servers: An array of Server objects which is used to provide connectivity information to a target server.
value() - Method in annotation type org.eclipse.microprofile.openapi.annotations.tags.Tags: An array of Tag annotation objects which hold metadata for the API
value(Object) - Method in interface org.eclipse.microprofile.openapi.models.examples.Example: Sets this Example's value property to the given value.
valueOf(String) - Static method in enum org.eclipse.microprofile.openapi.annotations.enums.Explode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.microprofile.openapi.annotations.enums.ParameterIn: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.microprofile.openapi.annotations.enums.ParameterStyle: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.microprofile.openapi.annotations.enums.SchemaType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.microprofile.openapi.annotations.enums.SecuritySchemeIn: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.microprofile.openapi.annotations.enums.SecuritySchemeType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.microprofile.openapi.models.headers.Header.Style: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.microprofile.openapi.models.media.Encoding.Style: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.microprofile.openapi.models.media.Schema.SchemaType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.microprofile.openapi.models.parameters.Parameter.In: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.microprofile.openapi.models.parameters.Parameter.Style: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.microprofile.openapi.models.PathItem.HttpMethod: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.microprofile.openapi.models.security.SecurityScheme.In: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.microprofile.openapi.models.security.SecurityScheme.Type: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.eclipse.microprofile.openapi.annotations.enums.Explode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.microprofile.openapi.annotations.enums.ParameterIn: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.microprofile.openapi.annotations.enums.ParameterStyle: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.microprofile.openapi.annotations.enums.SchemaType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.microprofile.openapi.annotations.enums.SecuritySchemeIn: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.microprofile.openapi.annotations.enums.SecuritySchemeType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.microprofile.openapi.models.headers.Header.Style: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.microprofile.openapi.models.media.Encoding.Style: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.microprofile.openapi.models.media.Schema.SchemaType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.microprofile.openapi.models.parameters.Parameter.In: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.microprofile.openapi.models.parameters.Parameter.Style: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.microprofile.openapi.models.PathItem.HttpMethod: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.microprofile.openapi.models.security.SecurityScheme.In: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.microprofile.openapi.models.security.SecurityScheme.Type: Returns an array containing the constants of this enum type, in the order they are declared.
variables() - Method in annotation type org.eclipse.microprofile.openapi.annotations.servers.Server: An array of variables used for substitution in the server's URL template.
variables(Map<String, ServerVariable>) - Method in interface org.eclipse.microprofile.openapi.models.servers.Server: This method sets the variables property of Server instance to the given variables argument and returns the modified instance.
version() - Method in annotation type org.eclipse.microprofile.openapi.annotations.info.Info: The version of the API definition.
version(String) - Method in interface org.eclipse.microprofile.openapi.models.info.Info: Sets the version of the OpenAPI document for this instance of Info to the given version and returns this instance of Info

W

wrapped(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.XML: This method sets the wrapped property of XML instance to the given Boolean argument and returns the modified instance.
writeOnly() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.Schema: Relevant only for Schema "properties" definitions.
writeOnly() - Method in annotation type org.eclipse.microprofile.openapi.annotations.media.SchemaProperty: Relevant only for Schema "properties" definitions.
writeOnly(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the writeOnly property of this Schema.

X

xml(XML) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema: Sets the xml property of this Schema instance.
XML - Interface in org.eclipse.microprofile.openapi.models.media: A metadata object that allows for more fine-tuned XML model definitions.

A B C D E F G H I L M N O P Q R S T U V W X
All Classes All Packages