Index (swagger-annotations 1.6.13 API)

A B C D E F H I K L M N O P Q R S T U V W
All Classes All Packages

A

access() - Method in annotation type io.swagger.annotations.ApiImplicitParam: Allows for filtering a parameter from the API documentation.
access() - Method in annotation type io.swagger.annotations.ApiModelProperty: Allows for filtering a property from the API documentation.
access() - Method in annotation type io.swagger.annotations.ApiParam: Allows for filtering a parameter from the API documentation.
ACCESS_CODE - io.swagger.annotations.OAuth2Definition.Flow
accessMode() - Method in annotation type io.swagger.annotations.ApiModelProperty: Allows to specify the access mode of a model property (AccessMode.READ_ONLY, READ_WRITE)
allowableValues() - Method in annotation type io.swagger.annotations.ApiImplicitParam: Limits the acceptable values for this parameter.
allowableValues() - Method in annotation type io.swagger.annotations.ApiModelProperty: Limits the acceptable values for this parameter.
allowableValues() - Method in annotation type io.swagger.annotations.ApiParam: Limits the acceptable values for this parameter.
allowEmptyValue() - Method in annotation type io.swagger.annotations.ApiImplicitParam: Adds the ability to set a format as empty
allowEmptyValue() - Method in annotation type io.swagger.annotations.ApiModelProperty: Allows passing an empty value
allowEmptyValue() - Method in annotation type io.swagger.annotations.ApiParam: Adds the ability to set a format as empty
allowMultiple() - Method in annotation type io.swagger.annotations.ApiImplicitParam: Specifies whether the parameter can accept multiple values by having multiple occurrences.
allowMultiple() - Method in annotation type io.swagger.annotations.ApiParam: Specifies whether the parameter can accept multiple values by having multiple occurrences.
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
apiKeyAuthDefinitions() - Method in annotation type io.swagger.annotations.SecurityDefinition: API Key security definition objects
apiKeyAuthDefintions() - Method in annotation type io.swagger.annotations.SecurityDefinition: Deprecated.
Use SecurityDefinition.apiKeyAuthDefinitions() instead
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.
APPLICATION - io.swagger.annotations.OAuth2Definition.Flow
Authorization - Annotation Type in io.swagger.annotations: Defines an authorization scheme to be used on a resource or an operation.
authorizations() - Method in annotation type io.swagger.annotations.Api: Corresponds to the `security` field of the Operation Object.
authorizations() - Method in annotation type io.swagger.annotations.ApiOperation: Corresponds to the `security` field of the Operation Object.
AuthorizationScope - Annotation Type in io.swagger.annotations: Describes an OAuth2 authorization scope.
authorizationUrl() - Method in annotation type io.swagger.annotations.OAuth2Definition: The authorization URL to be used for this flow.
AUTO - io.swagger.annotations.ApiModelProperty.AccessMode

B

basePath() - Method in annotation type io.swagger.annotations.Api: Deprecated.
basePath() - Method in annotation type io.swagger.annotations.SwaggerDefinition: The basePath to specify in the generated Swagger definition.
basicAuthDefinions() - Method in annotation type io.swagger.annotations.SecurityDefinition: Deprecated.
Use SecurityDefinition.basicAuthDefinitions() instead
BasicAuthDefinition - Annotation Type in io.swagger.annotations: Annotation used to construct Basic Auth security definition.
basicAuthDefinitions() - Method in annotation type io.swagger.annotations.SecurityDefinition: Basic auth security definition objects

C

code() - Method in annotation type io.swagger.annotations.ApiOperation: The HTTP status code of the response.
code() - Method in annotation type io.swagger.annotations.ApiResponse: The HTTP status code of the response.
collectionFormat() - Method in annotation type io.swagger.annotations.ApiImplicitParam: adds ability to override collectionFormat with `array` types
collectionFormat() - Method in annotation type io.swagger.annotations.ApiParam: adds ability to override collectionFormat with `array` types
consumes() - Method in annotation type io.swagger.annotations.Api: Corresponds to the `consumes` field of the operations under this resource.
consumes() - Method in annotation type io.swagger.annotations.ApiOperation: Corresponds to the `consumes` field of the operation.
consumes() - Method in annotation type io.swagger.annotations.SwaggerDefinition: Global level consumes for this swagger definition.
contact() - Method in annotation type io.swagger.annotations.Info: Optional contact information for this API.
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

D

dataType() - Method in annotation type io.swagger.annotations.ApiImplicitParam: The data type of the parameter.
dataType() - Method in annotation type io.swagger.annotations.ApiModelProperty: The data type of the parameter.
dataTypeClass() - Method in annotation type io.swagger.annotations.ApiImplicitParam: The class of the parameter.
DEFAULT - io.swagger.annotations.SwaggerDefinition.Scheme
defaultValue() - Method in annotation type io.swagger.annotations.ApiImplicitParam: Describes the default value for the parameter.
defaultValue() - Method in annotation type io.swagger.annotations.ApiParam: Describes the default value for the parameter.
description() - Method in annotation type io.swagger.annotations.Api: Deprecated.
description() - Method in annotation type io.swagger.annotations.ApiKeyAuthDefinition: A short description for security scheme.
description() - Method in annotation type io.swagger.annotations.ApiModel: Provide a longer description of the class.
description() - Method in annotation type io.swagger.annotations.AuthorizationScope: Not used in 1.5.X, kept for legacy support.
description() - Method in annotation type io.swagger.annotations.BasicAuthDefinition: A short description for security scheme.
description() - Method in annotation type io.swagger.annotations.Info: An optional description of the API.
description() - Method in annotation type io.swagger.annotations.OAuth2Definition: A short description for security scheme.
description() - Method in annotation type io.swagger.annotations.ResponseHeader: Long description of the response header.
description() - Method in annotation type io.swagger.annotations.Scope: A short description of the scope
description() - Method in annotation type io.swagger.annotations.Tag: Optional description of the tag.
discriminator() - Method in annotation type io.swagger.annotations.ApiModel: Supports model inheritance and polymorphism.

E

email() - Method in annotation type io.swagger.annotations.Contact: Optional email for this contact.
example() - Method in annotation type io.swagger.annotations.ApiImplicitParam: a single example for non-body type parameters
example() - Method in annotation type io.swagger.annotations.ApiModelProperty: A sample value for the property.
example() - Method in annotation type io.swagger.annotations.ApiParam: a single example for non-body type parameters
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
examples() - Method in annotation type io.swagger.annotations.ApiImplicitParam: Examples for the parameter.
examples() - Method in annotation type io.swagger.annotations.ApiParam: Examples for the parameter.
examples() - Method in annotation type io.swagger.annotations.ApiResponse: Examples for the response.
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
extensions() - Method in annotation type io.swagger.annotations.ApiModelProperty
extensions() - Method in annotation type io.swagger.annotations.ApiOperation
extensions() - Method in annotation type io.swagger.annotations.Info: Optional list of extensions for this API.
extensions() - Method in annotation type io.swagger.annotations.Tag: A list of extensions associated with this tag.
externalDocs() - Method in annotation type io.swagger.annotations.SwaggerDefinition: Reference to external documentation for this Swagger definition.
externalDocs() - Method in annotation type io.swagger.annotations.Tag: Optional reference to external documentation for this tag.
ExternalDocs - Annotation Type in io.swagger.annotations: Represents an external documentation description.

F

flow() - Method in annotation type io.swagger.annotations.OAuth2Definition: The flow used by the OAuth2 security scheme.
format() - Method in annotation type io.swagger.annotations.ApiImplicitParam: Adds the ability to provide a custom format
format() - Method in annotation type io.swagger.annotations.ApiParam: Adds the ability to provide a custom format
forValue(String) - Static method in enum io.swagger.annotations.ApiKeyAuthDefinition.ApiKeyLocation

H

HEADER - io.swagger.annotations.ApiKeyAuthDefinition.ApiKeyLocation
hidden() - Method in annotation type io.swagger.annotations.Api: Hides the operations under this resource.
hidden() - Method in annotation type io.swagger.annotations.ApiModelProperty: Allows a model property to be hidden in the Swagger model definition.
hidden() - Method in annotation type io.swagger.annotations.ApiOperation: Hides the operation from the list of operations.
hidden() - Method in annotation type io.swagger.annotations.ApiParam: Hides the parameter from the list of parameters.
host() - Method in annotation type io.swagger.annotations.SwaggerDefinition: The host to specify in the generated Swagger definition.
HTTP - io.swagger.annotations.SwaggerDefinition.Scheme
httpMethod() - Method in annotation type io.swagger.annotations.ApiOperation: Corresponds to the `method` field as the HTTP method used.
HTTPS - io.swagger.annotations.SwaggerDefinition.Scheme

I

ignoreJsonView() - Method in annotation type io.swagger.annotations.ApiOperation: Ignores JsonView annotations while resolving operations and types.
IMPLICIT - io.swagger.annotations.OAuth2Definition.Flow
in() - Method in annotation type io.swagger.annotations.ApiKeyAuthDefinition: The location of the API key.
info() - Method in annotation type io.swagger.annotations.SwaggerDefinition: General metadata for this Swagger definition.
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

K

key() - Method in annotation type io.swagger.annotations.ApiKeyAuthDefinition: Key used to refer to this security definition
key() - Method in annotation type io.swagger.annotations.BasicAuthDefinition: Key used to refer to this security definition
key() - Method in annotation type io.swagger.annotations.OAuth2Definition: Key used to refer to this security definition

L

license() - Method in annotation type io.swagger.annotations.Info: Optional license information for this API.
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

M

mediaType() - Method in annotation type io.swagger.annotations.ExampleProperty: The name of the property.
message() - Method in annotation type io.swagger.annotations.ApiResponse: Human-readable message to accompany the response.

N

name() - Method in annotation type io.swagger.annotations.ApiImplicitParam: Name of the parameter.
name() - Method in annotation type io.swagger.annotations.ApiKeyAuthDefinition: The name of the header or query parameter to be used.
name() - Method in annotation type io.swagger.annotations.ApiModelProperty: Allows overriding the name of the property.
name() - Method in annotation type io.swagger.annotations.ApiParam: The parameter name.
name() - Method in annotation type io.swagger.annotations.Contact: The name of the contact.
name() - Method in annotation type io.swagger.annotations.Extension: An option name for these extensions.
name() - Method in annotation type io.swagger.annotations.ExtensionProperty: The name of the property.
name() - Method in annotation type io.swagger.annotations.License: The name of the license.
name() - Method in annotation type io.swagger.annotations.ResponseHeader: Header's name.
name() - Method in annotation type io.swagger.annotations.Scope: The name of the scope
name() - Method in annotation type io.swagger.annotations.Tag: The name of this tag.
nickname() - Method in annotation type io.swagger.annotations.ApiOperation: Corresponds to the `operationId` field.
notes() - Method in annotation type io.swagger.annotations.ApiModelProperty: Currently not in use.
notes() - Method in annotation type io.swagger.annotations.ApiOperation: Corresponds to the 'notes' field of the operation.

O

OAuth2Definition - Annotation Type in io.swagger.annotations: Annotation used to construct OAuth security definition.
OAuth2Definition.Flow - Enum in io.swagger.annotations
oAuth2Definitions() - Method in annotation type io.swagger.annotations.SecurityDefinition: OAuth security definition objects

P

paramType() - Method in annotation type io.swagger.annotations.ApiImplicitParam: The parameter type of the parameter.
parent() - Method in annotation type io.swagger.annotations.ApiModel: Provide a superclass for the model to allow describing inheritance.
parseValue() - Method in annotation type io.swagger.annotations.ExtensionProperty: If set to true, field `value` will be parsed and serialized as JSON/YAML
PASSWORD - io.swagger.annotations.OAuth2Definition.Flow
position() - Method in annotation type io.swagger.annotations.Api: Deprecated.
position() - Method in annotation type io.swagger.annotations.ApiModelProperty: Allows explicitly ordering the property in the model.
position() - Method in annotation type io.swagger.annotations.ApiOperation: Deprecated.
produces() - Method in annotation type io.swagger.annotations.Api: Corresponds to the `produces` field of the operations under this resource.
produces() - Method in annotation type io.swagger.annotations.ApiOperation: Corresponds to the `produces` field of the operation.
produces() - Method in annotation type io.swagger.annotations.SwaggerDefinition: Global level produces for this swagger definition.
properties() - Method in annotation type io.swagger.annotations.Extension: The extension properties.
protocols() - Method in annotation type io.swagger.annotations.Api: Sets specific protocols (schemes) for the operations under this resource.
protocols() - Method in annotation type io.swagger.annotations.ApiOperation: Sets specific protocols (schemes) for this operation.

Q

QUERY - io.swagger.annotations.ApiKeyAuthDefinition.ApiKeyLocation

R

READ_ONLY - io.swagger.annotations.ApiModelProperty.AccessMode
READ_WRITE - io.swagger.annotations.ApiModelProperty.AccessMode
readOnly() - Method in annotation type io.swagger.annotations.ApiImplicitParam: adds ability to be designated as read only.
readOnly() - Method in annotation type io.swagger.annotations.ApiModelProperty: Deprecated.
As of 1.5.19, replaced by ApiModelProperty.accessMode()
readOnly() - Method in annotation type io.swagger.annotations.ApiParam: adds ability to be designated as read only.
reference() - Method in annotation type io.swagger.annotations.ApiModel: Specifies a reference to the corresponding type definition, overrides any other metadata specified
reference() - Method in annotation type io.swagger.annotations.ApiModelProperty: Specifies a reference to the corresponding type definition, overrides any other metadata specified
reference() - Method in annotation type io.swagger.annotations.ApiResponse: Specifies a reference to the response type.
required() - Method in annotation type io.swagger.annotations.ApiImplicitParam: Specifies if the parameter is required or not.
required() - Method in annotation type io.swagger.annotations.ApiModelProperty: Specifies if the parameter is required or not.
required() - Method in annotation type io.swagger.annotations.ApiParam: Specifies if the parameter is required or not.
response() - Method in annotation type io.swagger.annotations.ApiOperation: The response type of the operation.
response() - Method in annotation type io.swagger.annotations.ApiResponse: Optional response class to describe the payload of the message.
response() - Method in annotation type io.swagger.annotations.ResponseHeader: Header's data type.
responseContainer() - Method in annotation type io.swagger.annotations.ApiOperation: Declares a container wrapping the response.
responseContainer() - Method in annotation type io.swagger.annotations.ApiResponse: Declares a container wrapping the response.
responseContainer() - Method in annotation type io.swagger.annotations.ResponseHeader: Declares a container wrapping the response header.
ResponseHeader - Annotation Type in io.swagger.annotations: Represents a header that can be provided as part of the response.
responseHeaders() - Method in annotation type io.swagger.annotations.ApiOperation: A list of possible headers provided alongside the response.
responseHeaders() - Method in annotation type io.swagger.annotations.ApiResponse: A list of possible headers provided alongside the response.
responseReference() - Method in annotation type io.swagger.annotations.ApiOperation: Specifies a reference to the response type.

S

schemes() - Method in annotation type io.swagger.annotations.SwaggerDefinition: The transfer protocol of the API.
scope() - Method in annotation type io.swagger.annotations.AuthorizationScope: The scope of the OAuth2 Authorization scheme to be used.
Scope - Annotation Type in io.swagger.annotations: The available scopes for an OAuth2 security scheme
scopes() - Method in annotation type io.swagger.annotations.Authorization: The scopes to be used if the authorization scheme is OAuth2.
scopes() - Method in annotation type io.swagger.annotations.OAuth2Definition
securityDefinition() - Method in annotation type io.swagger.annotations.SwaggerDefinition: Defintions for security schemes
SecurityDefinition - Annotation Type in io.swagger.annotations: An aggregation of all security definitions.
subTypes() - Method in annotation type io.swagger.annotations.ApiModel: An array of the sub types inheriting from this model.
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
tags() - Method in annotation type io.swagger.annotations.Api: A list of tags for API documentation control.
tags() - Method in annotation type io.swagger.annotations.ApiOperation: A list of tags for API documentation control.
tags() - Method in annotation type io.swagger.annotations.SwaggerDefinition: Global tags that can be used to tag individual Apis and ApiOperations.
termsOfService() - Method in annotation type io.swagger.annotations.Info: An optional terms of service for this API.
title() - Method in annotation type io.swagger.annotations.Info: The title of the API.
tokenUrl() - Method in annotation type io.swagger.annotations.OAuth2Definition: The token URL to be used for this flow.
toValue() - Method in enum io.swagger.annotations.ApiKeyAuthDefinition.ApiKeyLocation
type() - Method in annotation type io.swagger.annotations.ApiImplicitParam: Adds the ability to override the detected type
type() - Method in annotation type io.swagger.annotations.ApiParam: Adds the ability to override the detected type

U

url() - Method in annotation type io.swagger.annotations.Contact: Optional URL associated with this contact.
url() - Method in annotation type io.swagger.annotations.ExternalDocs: URL for the docs.
url() - Method in annotation type io.swagger.annotations.License: An optional URL for the license.

V

value() - Method in annotation type io.swagger.annotations.Api: Implicitly sets a tag for the operations, legacy support (read description).
value() - Method in annotation type io.swagger.annotations.ApiImplicitParam: A brief description of the parameter.
value() - Method in annotation type io.swagger.annotations.ApiImplicitParams: A list of ApiImplicitParams available to the API operation.
value() - Method in annotation type io.swagger.annotations.ApiModel: Provide an alternative name for the model.
value() - Method in annotation type io.swagger.annotations.ApiModelProperty: A brief description of this property.
value() - Method in annotation type io.swagger.annotations.ApiOperation: Corresponds to the `summary` field of the operation.
value() - Method in annotation type io.swagger.annotations.ApiParam: A brief description of the parameter.
value() - Method in annotation type io.swagger.annotations.ApiResponses: A list of ApiResponses provided by the API operation.
value() - Method in annotation type io.swagger.annotations.Authorization: The name of the authorization scheme to be used on this resource/operation.
value() - Method in annotation type io.swagger.annotations.Example: The examples properties.
value() - Method in annotation type io.swagger.annotations.ExampleProperty: The value of the example.
value() - Method in annotation type io.swagger.annotations.ExtensionProperty: The value of the property.
value() - Method in annotation type io.swagger.annotations.ExternalDocs: A short description of the target documentation.
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.
version() - Method in annotation type io.swagger.annotations.Info: The version of your API.

W

WS - io.swagger.annotations.SwaggerDefinition.Scheme
WSS - io.swagger.annotations.SwaggerDefinition.Scheme

A B C D E F H I K L M N O P Q R S T U V W
All Classes All Packages