org.eclipse.microprofile.openapi.annotations

Annotation Type OpenAPIDefinition

@Target(value={TYPE,PACKAGE})
 @Retention(value=RUNTIME)
 @Inherited
public @interface OpenAPIDefinition

OpenAPI

This is the root document object of the OpenAPI document. It contains required and optional fields.

See Also:

OpenAPI Specification OpenAPI Object

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
Info	info Required: Provides metadata about the API.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Components	components An element to hold a set of reusable objects for different aspects of the OpenAPI Specification (OAS).
ExternalDocumentation	externalDocs Any additional external documentation for the API
SecurityRequirement[]	security A declaration of which security mechanisms can be used across the API.
Server[]	servers An array of Server Objects, which provide connectivity information to a target server.
Tag[]	tags A list of tags used by the specification with additional metadata.

Element Detail

info

public abstract Info info

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

Returns:

the metadata about this API

tags

public abstract Tag[] tags

A list of tags used by the specification with additional metadata. The order of the tags can be used to reflect on their order by the parsing tools.

Returns:

the tags used by the specification with any additional metadata

Default:

{}

servers

public abstract 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:

the servers of this API

Default:

{}

security

public abstract SecurityRequirement[] security

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

Returns:

the array of servers used for this API

Default:

{}

externalDocs

public abstract ExternalDocumentation externalDocs

Any additional external documentation for the API

Returns:

the external documentation for this API.

Default:

@org.eclipse.microprofile.openapi.annotations.ExternalDocumentation

components

public abstract 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:

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

Default:

@org.eclipse.microprofile.openapi.annotations.Components