Package io.swagger.annotations

Annotation Type AuthorizationScope

  • @Target(METHOD)
@Retention(RUNTIME)
public @interface AuthorizationScope
    Describes an OAuth2 authorization scope.

    Used to define an authorization scope that is used by an operation for a defined authorization scheme.

    This annotation is not used directly and will not be parsed by Swagger. It should be used within the Authorization.

    See Also:
    Authorization, ApiOperation, Api

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      String description
      Not used in 1.5.X, kept for legacy support.
      String scope
      The scope of the OAuth2 Authorization scheme to be used.

    • Element Detail

      • scope

        String scope
        The scope of the OAuth2 Authorization scheme to be used.

        The scope should be previously declared in the Swagger Object's securityDefinition section.

      • description

        String description
        Not used in 1.5.X, kept for legacy support.