Skip navigation links

Package org.eclipse.microprofile.openapi.annotations.security

A set of annotations to represent various security components of an OpenAPI app.

See: Description

Package org.eclipse.microprofile.openapi.annotations.security Description

A set of annotations to represent various security components of an OpenAPI app.

Example usage:

  @Path("/reviews")
  @SecurityScheme(
  securitySchemeName = "reviewoauth2",
  type = SecuritySchemeType.OAUTH2,
  description = "authentication needed to create and delete reviews",
  flows =  @OAuthFlows(
      implicit =  @OAuthFlow(
          authorizationUrl = "https://example.com/api/oauth/dialog",
          scopes =  @OAuthScope(
              name = "write:reviews",
              description = "create a review"
          )
      )
   )
 )
 
Skip navigation links