Package org.eclipse.microprofile.openapi.annotations.security
@Version("1.1")
@ProviderType
package org.eclipse.microprofile.openapi.annotations.security
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" ) ) ) )
-
Annotation InterfacesClassDescriptionConfiguration details for a supported OAuth Flow.Allows configuration of the supported OAuth Flows.Represents an OAuth scope.Specifies a security requirement for an operation.Container annotation for repeated
SecurityRequirement
annotations.This annotation represents a set of security requirements which permit access to an operation if all of them are satisfied.Represents an array of security requirement sets that apply to an operation.Defines a security scheme that can be used by the operations.This object represents an array of SecurityScheme annotations that can be specified at the definition level.