Annotation Interface OpenApi.ApiKeySecurityScheme

Enclosing class:
OpenApi
@Target(TYPE) @Retention(CLASS) @Repeatable(OpenApi.ApiKeySecuritySchemes.class) @Documented public static @interface OpenApi.ApiKeySecurityScheme
OpenAPI API Key Security Scheme Object metadata.

Use only on @OpenApi.Document metadata types.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    apiKeyName
    API key parameter name.
    String
    in
    API key location; supported values are query, header, and cookie.
    String
    name
    Component name.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    deprecated
    Whether the security scheme is deprecated.
    String
    description
    Security scheme description.

  • Element Details

    • name

      String name
      Component name.
      Returns:
      name

    • description

      String description
      Security scheme description.
      Returns:
      description
      Default:
      ""

    • apiKeyName

      String apiKeyName
      API key parameter name.
      Returns:
      API key parameter name

    • in

      String in
      API key location; supported values are query, header, and cookie.
      Returns:
      location

    • deprecated

      boolean deprecated
      Whether the security scheme is deprecated.

      Rendered only for OpenAPI 3.2 output.

      Returns:
      deprecated flag
      Default:
      false