models

Type Members

1. case class Enum(name: String, description: Option[String] = None, values: Seq[EnumValue]) extends Product with Serializable

   

2. case class EnumValue(name: String, description: Option[String] = None) extends Product with Serializable

   

3. case class Error(code: String, message: String) extends Product with Serializable

   

4. case class Field(name: String, datatype: Type, description: Option[String] = None, required: Boolean, default: Option[String] = None, example: Option[String] = None, minimum: Option[Long] = None, maximum: Option[Long] = None) extends Product with Serializable

   

5. case class Generator(key: String, name: String, language: Option[String] = None, description: Option[String] = None) extends Product with Serializable

   

   The generator metadata.

6. case class Header(name: String, headertype: HeaderType, headertypeValue: Option[String] = None, description: Option[String] = None, required: Boolean, multiple: Boolean, default: Option[String] = None) extends Product with Serializable

   

7. sealed trait HeaderType extends AnyRef

   

8. case class Invocation(source: String) extends Product with Serializable

   

   The result of invoking a generator.

9. case class Model(name: String, plural: String, description: Option[String] = None, fields: Seq[Field]) extends Product with Serializable

   

10. case class Operation(model: Model, method: String, path: String, description: Option[String] = None, body: Option[Type] = None, parameters: Seq[Parameter], responses: Seq[Response]) extends Product with Serializable

    

11. case class Parameter(name: String, datatype: Type, location: ParameterLocation, description: Option[String] = None, required: Boolean, default: Option[String] = None, example: Option[String] = None, minimum: Option[Long] = None, maximum: Option[Long] = None) extends Product with Serializable

    

12. sealed trait ParameterLocation extends AnyRef

    

13. case class Resource(model: Model, path: String, operations: Seq[Operation]) extends Product with Serializable

    

14. case class Response(code: Int, datatype: Type) extends Product with Serializable

    

15. case class ServiceDescription(enums: Seq[Enum], models: Seq[Model], headers: Seq[Header], resources: Seq[Resource], baseUrl: Option[String] = None, name: String, packageName: Option[String] = None, description: Option[String] = None, userAgent: Option[String] = None) extends Product with Serializable

    

    Description of a service

16. case class Type(kind: TypeKind, name: String, multiple: Boolean) extends Product with Serializable

    

17. sealed trait TypeKind extends AnyRef