Annotation Interface ServiceUnavailable


@Retention(RUNTIME) @Target(METHOD) @Documented public @interface ServiceUnavailable
A convenience annotation that is itself annotated with @ApiResponse.

Methods that carry this annotation will be included in generated openApi documentation with predefined HTTP status code 503. @ResponseBody description will be generated according to ApiError schema description and will use a predefined example.

NOTE: @ServiceUnavailable is processed if annotated method is part of properly configured RestController and springdoc-openapi library.

Since:
1.0.4
Author:
Ilya Nikolaev
See Also:
  • ApiResponse
  • ResponseEntity
  • RestController
  • ApiError