MicroProfile 7.0 · org.eclipse.microprofile.openapi.annotations.OpenAPIDefinition

Method Summary

Modifier and Type	Method and Description
public Components	Returns: the element with a set of reusable objects for different aspects of the OAS. components() An element to hold a set of reusable objects for different aspects of the OpenAPI Specification (OAS).
public Extension[]	Returns: array of extensions extensions() List of extensions to be added to the `OpenAPI` model corresponding to the containing annotation.
public ExternalDocumentation	Returns: the external documentation for this API. externalDocs() Any additional external documentation for the API
public Info	Returns: the metadata about this API info() Required: Provides metadata about the API.
public SecurityRequirement[]	Returns: the array of security requirements for this API security() A declaration of which security mechanisms can be used across the API.
public SecurityRequirementsSet[]	Returns: the array of security requirement sets for this API securitySets() A declaration of which security mechanisms can be used across the API.
public Server[]	Returns: the servers of this API servers() An array of Server Objects, which provide connectivity information to a target server.
public Tag[]	Returns: the tags used by the specification with any additional metadata tags() A list of tags used by the specification with additional metadata.
public PathItem[]	Returns: the array of webhooks webhooks() An array of webhook definitions which the API may be instructed to call using out-of-band mechanisms.

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

Method Detail

components	back to summary
public Components components() An element to hold a set of reusable objects for different aspects of the OpenAPI Specification (OAS). All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object. Returns:Components the element with a set of reusable objects for different aspects of the OAS.

components

back to summary

public Components components()

An element to hold a set of reusable objects for different aspects of the OpenAPI Specification (OAS). All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.

Returns:Components: the element with a set of reusable objects for different aspects of the OAS.

extensions back to summary

extensions	back to summary
public Extension[] extensions() List of extensions to be added to the `OpenAPI` model corresponding to the containing annotation. Returns:Extension[] array of extensions Since 3.1

public Extension[] extensions()

List of extensions to be added to the OpenAPI model corresponding to the containing annotation.

Returns:Extension[]: array of extensions
Since: 3.1

externalDocs	back to summary
public ExternalDocumentation externalDocs() Any additional external documentation for the API Returns:ExternalDocumentation the external documentation for this API.

externalDocs

back to summary

public ExternalDocumentation externalDocs()

Any additional external documentation for the API

Returns:ExternalDocumentation: the external documentation for this API.

info	back to summary
public Info info() Required: Provides metadata about the API. The metadata MAY be used by tooling as required. Returns:Info the metadata about this API

info

back to summary

public Info info()

Required: Provides metadata about the API. The metadata MAY be used by tooling as required.

Returns:Info: the metadata about this API

security back to summary

security	back to summary
public SecurityRequirement[] security() A declaration of which security mechanisms can be used across the API. Adding a `SecurityRequirement` to this array is equivalent to adding a `SecurityRequirementsSet` containing a single `SecurityRequirement` to `securitySets()`. Returns:SecurityRequirement[] the array of security requirements for this API

public SecurityRequirement[] security()

A declaration of which security mechanisms can be used across the API.

Adding a SecurityRequirement to this array is equivalent to adding a SecurityRequirementsSet containing a single SecurityRequirement to securitySets().

Returns:SecurityRequirement[]: the array of security requirements for this API

securitySets	back to summary
public SecurityRequirementsSet[] securitySets() A declaration of which security mechanisms can be used across the API. All of the security requirements within any one of the sets must be satisfied to authorize a request. Including an empty set within this list indicates that the other requirements are optional. Returns:SecurityRequirementsSet[] the array of security requirement sets for this API

securitySets

back to summary

public SecurityRequirementsSet[] securitySets()

A declaration of which security mechanisms can be used across the API.

All of the security requirements within any one of the sets must be satisfied to authorize a request.

Including an empty set within this list indicates that the other requirements are optional.

Returns:SecurityRequirementsSet[]: the array of security requirement sets for this API

servers	back to summary
public Server[] servers() An array of Server Objects, which provide connectivity information to a target server. If the servers property is not provided, or is an empty array, the default value would be a Server Object with a url value of /. Returns:Server[] the servers of this API

servers

back to summary

public Server[] servers()

An array of Server Objects, which provide connectivity information to a target server. If the servers property is not provided, or is an empty array, the default value would be a Server Object with a url value of /.

Returns:Server[]: the servers of this API

public @Interface OpenAPIDefinition

Method Summary

Method Detail