Index (swagger-annotations 1.6.0 API)

A B C E F I L O R S T V

A

Api - Annotation Type in io.swagger.annotations: Marks a class as a Swagger resource.
ApiImplicitParam - Annotation Type in io.swagger.annotations: Represents a single parameter in an API Operation.
ApiImplicitParams - Annotation Type in io.swagger.annotations: A wrapper to allow a list of multiple ApiImplicitParam objects.
ApiKeyAuthDefinition - Annotation Type in io.swagger.annotations: Annotation used to construct ApiKey Auth security definition.
ApiKeyAuthDefinition.ApiKeyLocation - Enum in io.swagger.annotations
ApiModel - Annotation Type in io.swagger.annotations: Provides additional information about Swagger models.
ApiModelProperty - Annotation Type in io.swagger.annotations: Adds and manipulates data of a model property.
ApiModelProperty.AccessMode - Enum in io.swagger.annotations
ApiOperation - Annotation Type in io.swagger.annotations: Describes an operation or typically a HTTP method against a specific path.
ApiParam - Annotation Type in io.swagger.annotations: Adds additional meta-data for operation parameters.
ApiResponse - Annotation Type in io.swagger.annotations: Describes a possible response of an operation.
ApiResponses - Annotation Type in io.swagger.annotations: A wrapper to allow a list of multiple ApiResponse objects.
Authorization - Annotation Type in io.swagger.annotations: Defines an authorization scheme to be used on a resource or an operation.
AuthorizationScope - Annotation Type in io.swagger.annotations: Describes an OAuth2 authorization scope.

B

BasicAuthDefinition - Annotation Type in io.swagger.annotations: Annotation used to construct Basic Auth security definition.

C

Contact - Annotation Type in io.swagger.annotations: Contact metadata available within the info section of a Swagger definition - see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#contactObject

E

Example - Annotation Type in io.swagger.annotations: An optionally named list of example properties.
ExampleProperty - Annotation Type in io.swagger.annotations: A mediaType/value property within a Swagger example
Extension - Annotation Type in io.swagger.annotations: An optionally named list of extension properties.
ExtensionProperty - Annotation Type in io.swagger.annotations: A name/value property within a Swagger extension
ExternalDocs - Annotation Type in io.swagger.annotations: Represents an external documentation description.

F

forValue(String) - Static method in enum io.swagger.annotations.ApiKeyAuthDefinition.ApiKeyLocation

I

Info - Annotation Type in io.swagger.annotations: High-level metadata for a Swagger definition - see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#infoObject
io.swagger.annotations - package io.swagger.annotations

L

License - Annotation Type in io.swagger.annotations: License metadata available within the info section of a Swagger definition, see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#licenseObject

O

OAuth2Definition - Annotation Type in io.swagger.annotations: Annotation used to construct OAuth security definition.
OAuth2Definition.Flow - Enum in io.swagger.annotations

R

ResponseHeader - Annotation Type in io.swagger.annotations: Represents a header that can be provided as part of the response.

S

Scope - Annotation Type in io.swagger.annotations: The available scopes for an OAuth2 security scheme
SecurityDefinition - Annotation Type in io.swagger.annotations: An aggregation of all security definitions.
SwaggerDefinition - Annotation Type in io.swagger.annotations: Annotation that configures definition level metadata.
SwaggerDefinition.Scheme - Enum in io.swagger.annotations: Enumeration with valid schemes

T

Tag - Annotation Type in io.swagger.annotations: A definition level Tag object see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#tag-object
toValue() - Method in enum io.swagger.annotations.ApiKeyAuthDefinition.ApiKeyLocation

V

valueOf(String) - Static method in enum io.swagger.annotations.ApiKeyAuthDefinition.ApiKeyLocation: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.swagger.annotations.ApiModelProperty.AccessMode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.swagger.annotations.OAuth2Definition.Flow: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.swagger.annotations.SwaggerDefinition.Scheme: Returns the enum constant of this type with the specified name.
values() - Static method in enum io.swagger.annotations.ApiKeyAuthDefinition.ApiKeyLocation: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.swagger.annotations.ApiModelProperty.AccessMode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.swagger.annotations.OAuth2Definition.Flow: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.swagger.annotations.SwaggerDefinition.Scheme: Returns an array containing the constants of this enum type, in the order they are declared.

A B C E F I L O R S T V