org.eclipse.microprofile.openapi.annotations.responses

public @Interface APIResponses

Annotations

@Target:METHOD, TYPE
@Retention:RUNTIME
@Inherited

Imports

java.lang.annotation.ElementType, .Inherited, .Retention, .RetentionPolicy, .Target, org.eclipse.microprofile.openapi.annotations.extensions.Extension

The ApiResponses annotation is a container for @ApiResponse annotations. When used on a method it is treated as if each ApiResponse annotation were applied individually.

See Also: OpenAPI Specification Responses Object

Method Summary

Modifier and Type	Method and Description
public Extension[]	Returns: array of extensions extensions() List of extensions to be added to the `APIResponses` model corresponding to the containing annotation.
public APIResponse[]	Returns: the array of the APIResponse value() An array of APIResponse annotations

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

Method Detail

extensions back to summary

extensions	back to summary
public Extension[] extensions() List of extensions to be added to the `APIResponses` 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 APIResponses model corresponding to the containing annotation.

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

value	back to summary
public APIResponse[] value() An array of APIResponse annotations Returns:APIResponse[] the array of the APIResponse

value

back to summary

public APIResponse[] value()

An array of APIResponse annotations

Returns:APIResponse[]: the array of the APIResponse