Package io.micronaut.openapi.annotation

Annotation Type OpenAPISecurity

  • @Documented
@Retention(RUNTIME)
@Target({TYPE,ANNOTATION_TYPE})
public @interface OpenAPISecurity
    The annotation to include Micronaut security endpoints.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      io.swagger.v3.oas.annotations.security.SecurityRequirement[] security
      A declaration of which security mechanisms can be used across the API.
      io.swagger.v3.oas.annotations.tags.Tag[] tags
      A list of tags used by the specification with additional metadata.

    • Element Detail

      • tags

        io.swagger.v3.oas.annotations.tags.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:
        {}

      • security

        io.swagger.v3.oas.annotations.security.SecurityRequirement[] security
        A declaration of which security mechanisms can be used across the API.
        Returns:
        the array of servers used for this API
        Default:
        {}