package
swagger
Type Members
-
-
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
-
case class
ApiInfo(title: String, description: String, termsOfServiceUrl: String, contact: String, license: String, licenseUrl: String) extends Product with Serializable
-
case class
ApiKey(keyname: String, passAs: String = "header") extends AuthorizationType with Product with Serializable
-
case class
ApiListingReference(path: String, description: Option[String] = None, position: Int = 0) extends Product with Serializable
-
-
-
sealed
trait
DataType extends AnyRef
-
case class
Endpoint(path: String, description: Option[String] = None, operations: List[Operation] = Nil) extends SwaggerEndpoint[Operation] with Product with Serializable
-
trait
GrantType extends AnyRef
-
case class
ImplicitGrant(loginEndpoint: LoginEndpoint, tokenName: String) extends GrantType with Product with Serializable
-
trait
JacksonSwaggerBase extends ScalatraBase with JacksonJsonSupport with CorsSupport with SwaggerBase
-
case class
LoginEndpoint(url: String) extends Product with Serializable
-
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
-
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
-
case class
ModelRef(type: String, ref: Option[String] = None, qualifiedType: Option[String] = None) extends Product with Serializable
-
trait
NativeSwaggerBase extends ScalatraBase with NativeJsonSupport with CorsSupport with SwaggerBase
-
case class
OAuth(scopes: List[String], grantTypes: List[GrantType]) extends AuthorizationType with Product with Serializable
-
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) extends SwaggerOperation with Product with Serializable
-
case class
Parameter(name: String, type: DataType, description: Option[String] = None, notes: Option[String] = None, 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
-
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
-
-
case class
StringResponseMessage(code: Int, message: String) extends ResponseMessage[String] with Product with Serializable
-
-
-
-
trait
SwaggerBaseBase extends Initializable with ScalatraBase
-
-
-
-
-
-
trait
SwaggerSupportSyntax extends Initializable with CorsSupport
-
case class
TokenEndpoint(url: String, tokenName: String) extends Product with Serializable
-
case class
TokenRequestEndpoint(url: String, clientIdName: String, clientSecretName: String) extends Product with Serializable
Value Members
-
-
-
object
ParamType extends Enumeration
-
-
-
-
-
-
-
Inherited from AnyRef
Inherited from Any