com.wordnik.swagger.annotations

Annotation Type AuthorizationScope

@Target(value=METHOD)
@Retention(value=RUNTIME)
@Inherited
public @interface AuthorizationScope

Describes an OAuth2 authorization scope.

Used to declare an authorization scope that is used by a resource or 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 and Description
String	description A brief description of the scope.
String	scope The scope of the OAuth2 Authorization scheme to be used.

Element Detail

scope

public abstract String scope

The scope of the OAuth2 Authorization scheme to be used.

The scope should be previously defined in the Resource Listing's authorization section.

description

public abstract String description

A brief description of the scope.