com.wordnik.swagger

model

package model

Visibility
  1. Public
  2. All

Type Members

  1. case class AllowableListValues(values: List[String] = immutable.this.Nil, valueType: String = "LIST") extends AllowableValues with Product with Serializable

  2. case class AllowableRangeValues(min: String, max: String) extends AllowableValues with Product with Serializable

  3. trait AllowableValues extends AnyRef

  4. case class ApiDescription(path: String, description: Option[String], operations: List[Operation] = immutable.this.Nil, hidden: Boolean = false) extends Product with Serializable

  5. case class ApiInfo(title: String, description: String, termsOfServiceUrl: String, contact: String, license: String, licenseUrl: String) extends Product with Serializable

  6. case class ApiKey(keyname: String, passAs: String = "header") extends AuthorizationType with Product with Serializable

  7. case class ApiListing(apiVersion: String, swaggerVersion: String, basePath: String, resourcePath: String, produces: List[String] = immutable.this.List.empty[Nothing], consumes: List[String] = immutable.this.List.empty[Nothing], protocols: List[String] = immutable.this.List.empty[Nothing], authorizations: List[Authorization] = immutable.this.List.empty[Nothing], apis: List[ApiDescription] = immutable.this.Nil, models: Option[Map[String, Model]] = scala.None, description: Option[String] = scala.None, position: Int = 0) extends Product with Serializable

  8. case class ApiListingReference(path: String, description: Option[String], position: Int = 0) extends Product with Serializable

  9. case class Authorization(type: String, scopes: Array[AuthorizationScope]) extends Product with Serializable

  10. case class AuthorizationCodeGrant(tokenRequestEndpoint: TokenRequestEndpoint, tokenEndpoint: TokenEndpoint) extends GrantType with Product with Serializable

  11. case class AuthorizationScope(scope: String, description: String) extends Product with Serializable

  12. trait AuthorizationType extends AnyRef

  13. case class BasicAuth() extends AuthorizationType with Product with Serializable

  14. trait GrantType extends AnyRef

  15. case class ImplicitGrant(loginEndpoint: LoginEndpoint, tokenName: String) extends GrantType with Product with Serializable

  16. case class LoginEndpoint(url: String) extends Product with Serializable

  17. case class Model(id: String, name: String, qualifiedType: String, properties: LinkedHashMap[String, ModelProperty], description: Option[String] = scala.None, baseModel: Option[String] = scala.None, discriminator: Option[String] = scala.None, subTypes: List[String] = immutable.this.List.empty[Nothing]) extends Product with Serializable

  18. case class ModelProperty(type: String, qualifiedType: String, position: Int = 0, required: Boolean = false, description: Option[String] = scala.None, allowableValues: AllowableValues = AnyAllowableValues, items: Option[ModelRef] = scala.None) extends Product with Serializable

  19. case class ModelRef(type: String, ref: Option[String] = scala.None, qualifiedType: Option[String] = scala.None) extends Product with Serializable

  20. case class OAuth(scopes: List[AuthorizationScope], grantTypes: List[GrantType]) extends AuthorizationType with Product with Serializable

  21. class OAuthBuilder extends AnyRef

  22. case class Operation(method: String, summary: String, notes: String, responseClass: String, nickname: String, position: Int, produces: List[String] = immutable.this.List.empty[Nothing], consumes: List[String] = immutable.this.List.empty[Nothing], protocols: List[String] = immutable.this.List.empty[Nothing], authorizations: List[Authorization] = immutable.this.List.empty[Nothing], parameters: List[Parameter] = immutable.this.List.empty[Nothing], responseMessages: List[ResponseMessage] = immutable.this.List.empty[Nothing], deprecated: Option[String] = scala.None) extends Product with Serializable

  23. case class Parameter(name: String, description: Option[String], defaultValue: Option[String], required: Boolean, allowMultiple: Boolean, dataType: String, allowableValues: AllowableValues = AnyAllowableValues, paramType: String, paramAccess: Option[String] = scala.None) extends Product with Serializable

  24. case class ResourceListing(apiVersion: String, swaggerVersion: String, apis: List[ApiListingReference] = immutable.this.Nil, authorizations: List[AuthorizationType] = immutable.this.Nil, info: Option[ApiInfo] = scala.None) extends Product with Serializable

  25. case class ResponseMessage(code: Int, message: String, responseModel: Option[String] = scala.None) extends Product with Serializable

  26. trait Serializers extends AnyRef

  27. case class TokenEndpoint(url: String, tokenName: String) extends Product with Serializable

  28. case class TokenRequestEndpoint(url: String, clientIdName: String, clientSecretName: String) extends Product with Serializable

  29. class ValidationMessage extends AnyRef

Value Members

  1. object AnyAllowableValues extends AllowableValues with Product with Serializable

  2. object SwaggerJsonSchemaSerializers extends Serializers

  3. object SwaggerSerializers extends Serializers

  4. object ValidationMessage

Ungrouped