io.swagger.annotations

Annotation Type OAuth2Definition

public @interface OAuth2Definition

Annotation used to construct OAuth security definition.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
OAuth2Definition.Flow	flow The flow used by the OAuth2 security scheme.
String	key Key used to refer to this security definition

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	authorizationUrl The authorization URL to be used for this flow.
String	description A short description for security scheme.
Scope[]	scopes
String	tokenUrl The token URL to be used for this flow.

Element Detail

key

public abstract String key

Key used to refer to this security definition

Returns:

key used to refer to this security definition

flow

public abstract OAuth2Definition.Flow flow

The flow used by the OAuth2 security scheme. Valid values are "implicit", "password", "application" or "accessCode".

Returns:

description

public abstract String description

A short description for security scheme.

Returns:

a short description for security scheme.

Default:

""

authorizationUrl

public abstract String authorizationUrl

The authorization URL to be used for this flow. This SHOULD be in the form of a URL. Required for implicit and access code flows

Returns:

the authorization URL to be used for this flow. This SHOULD be in the form of a URL.

Default:

""

tokenUrl

public abstract String tokenUrl

The token URL to be used for this flow. This SHOULD be in the form of a URL. Required for password, applcation, and access code flows.

Returns:

the token URL to be used for this flow. This SHOULD be in the form of a URL.

Default:

""

scopes

public abstract Scope[] scopes

Default:

{}