Type Members

1.  trait AllowableValues extends AnyRef
2.  case class Api (apiVersion: String, swaggerVersion: String, resourcePath: String, description: Option[String] = None, produces: List[String] = Nil, consumes: List[String] = Nil, protocols: List[String] = Nil, apis: List[Endpoint] = Nil, models: Map[String, Model] = Map.empty, authorizations: List[String] = Nil, position: Int = 0) extends SwaggerApi[Endpoint] with Product with Serializable
3.  case class ApiInfo (title: String, description: String, termsOfServiceUrl: String, contact: String, license: String, licenseUrl: String) extends Product with Serializable
4.  case class ApiKey (keyname: String, passAs: String = "header", description: String = "") extends AuthorizationType with Product with Serializable
5.  case class ApiListingReference (path: String, description: Option[String] = None, position: Int = 0) extends Product with Serializable
6.  case class ApplicationGrant (tokenEndpoint: TokenEndpoint) extends GrantType with Product with Serializable
7.  case class AuthApi [TypeForUser <: AnyRef](apiVersion: String, swaggerVersion: String, resourcePath: String, description: Option[String] = None, produces: List[String] = Nil, consumes: List[String] = Nil, protocols: List[String] = Nil, apis: List[AuthEndpoint[TypeForUser]] = Nil, models: Map[String, Model] = Map.empty, authorizations: List[String] = Nil, position: Int = 0) extends SwaggerApi[AuthEndpoint[TypeForUser]] with Product with Serializable
8.  case class AuthEndpoint [TypeForUser <: AnyRef](path: String, description: Option[String] = None, operations: List[AuthOperation[TypeForUser]] = Nil) extends SwaggerEndpoint[AuthOperation[TypeForUser]] with Product with Serializable
9.  case class AuthOperation [TypeForUser <: AnyRef](method: HttpMethod, responseClass: DataType, summary: String, position: Int, notes: Option[String] = None, deprecated: Boolean = false, nickname: Option[String] = None, parameters: List[Parameter] = Nil, responseMessages: List[ResponseMessage] = Nil, consumes: List[String] = Nil, produces: List[String] = Nil, protocols: List[String] = Nil, authorizations: List[String] = Nil, tags: List[String] = Nil, allows: (Option[TypeForUser]) ⇒ Boolean = (_: Option[TypeForUser]) => true) extends SwaggerOperation with Product with Serializable
10.  case class AuthorizationCodeGrant (tokenRequestEndpoint: TokenRequestEndpoint, tokenEndpoint: TokenEndpoint) extends GrantType with Product with Serializable
11.  trait AuthorizationType extends AnyRef
12.  sealed trait DataType extends AnyRef
13.  case class Endpoint (path: String, description: Option[String] = None, operations: List[Operation] = Nil) extends SwaggerEndpoint[Operation] with Product with Serializable
14.  trait GrantType extends AnyRef
15.  case class ImplicitGrant (loginEndpoint: LoginEndpoint, tokenName: String) extends GrantType with Product with Serializable
16.  trait JacksonSwaggerBase extends ScalatraBase with JacksonJsonSupport with CorsSupport with SwaggerBase
17.  case class LoginEndpoint (url: String) extends Product with Serializable
18.  case class Model (id: String, name: String, qualifiedName: Option[String] = None, description: Option[String] = None, properties: List[(String, ModelProperty)] = Nil, baseModel: Option[String] = None, discriminator: Option[String] = None) extends Product with Serializable
19.  case class ModelProperty (type: DataType, position: Int = 0, required: Boolean = false, description: Option[String] = None, allowableValues: AllowableValues = AllowableValues.AnyValue, items: Option[ModelRef] = None) extends Product with Serializable
20.  case class ModelRef (type: String, ref: Option[String] = None, qualifiedType: Option[String] = None) extends Product with Serializable
21.  trait NativeSwaggerBase extends ScalatraBase with NativeJsonSupport with CorsSupport with SwaggerBase
22.  case class OAuth (scopes: List[String], grantTypes: List[GrantType], keyname: String = "oauth2", description: String = "") extends AuthorizationType with Product with Serializable
23.  case class Operation (method: HttpMethod, responseClass: DataType, summary: String, position: Int, notes: Option[String] = None, deprecated: Boolean = false, nickname: Option[String] = None, parameters: List[Parameter] = Nil, responseMessages: List[ResponseMessage] = Nil, consumes: List[String] = Nil, produces: List[String] = Nil, protocols: List[String] = Nil, authorizations: List[String] = Nil, tags: List[String] = Nil) extends SwaggerOperation with Product with Serializable
24.  case class Parameter (name: String, type: DataType, description: Option[String] = None, notes: Option[String] = None, paramType: ParamType.ParamType = ParamType.Query, defaultValue: Option[String] = None, allowableValues: AllowableValues = AllowableValues.AnyValue, required: Boolean = true, paramAccess: Option[String] = None, position: Int = 0) extends Product with Serializable
25.  case class ResourceListing (apiVersion: String, swaggerVersion: String = Swagger.SpecVersion, apis: List[ApiListingReference] = Nil, authorizations: List[AuthorizationType] = Nil, info: Option[ApiInfo] = None) extends Product with Serializable
26.  case class ResponseMessage (code: Int, message: String, responseModel: Option[String] = None) extends Product with Serializable
27.  class Swagger extends SwaggerEngine[Api]

    An instance of this class is used to hold the API documentation.

28.  trait SwaggerApi [T <: SwaggerEndpoint[_]] extends AnyRef
29.  trait SwaggerAuthBase [TypeForUser <: AnyRef] extends SwaggerBaseBase
30.  trait SwaggerAuthSupport [TypeForUser <: AnyRef] extends SwaggerSupportBase with SwaggerSupportSyntax
31.  trait SwaggerBase extends SwaggerBaseBase
32.  trait SwaggerBaseBase extends Initializable with ScalatraBase

    Trait that serves the resource and operation listings, as specified by the Swagger specification.

33.  trait SwaggerCommandSupport extends AnyRef
34.  trait SwaggerEndpoint [T <: SwaggerOperation] extends AnyRef
35.  trait SwaggerEngine [T <: SwaggerApi[_]] extends AnyRef
36.  trait SwaggerOperation extends AnyRef
37.  trait SwaggerSupport extends ScalatraBase with SwaggerSupportBase with SwaggerSupportSyntax

    Provides the necessary support for adding documentation to your routes.

38.  trait SwaggerSupportBase extends AnyRef
39.  trait SwaggerSupportSyntax extends Initializable with CorsSupport
40.  class SwaggerWithAuth extends SwaggerEngine[AuthApi[AnyRef]]
41.  case class TokenEndpoint (url: String, tokenName: String) extends Product with Serializable
42.  case class TokenRequestEndpoint (url: String, clientIdName: String, clientSecretName: String) extends Product with Serializable