Object

org.http4s.rho.swagger

models

Related Doc: package swagger

Permalink

object models

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. models
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. case class AbstractProperty(type: String = null, $ref: Option[String] = None, required: Boolean = false, title: Option[String] = None, description: Option[String] = None, format: Option[String] = None) extends Property with Product with Serializable

    Permalink
  2. case class ApiKeyAuthDefinition(name: String, in: In, description: Option[String] = None) extends SecuritySchemeDefinition with Product with Serializable

    Permalink
  3. case class ArrayModel(id: String, id2: String, description: Option[String] = None, type: Option[String] = None, properties: Map[String, Property] = Map.empty, items: Option[Property] = None, example: Option[String] = None, externalDocs: Option[ExternalDocs] = None) extends Model with Product with Serializable

    Permalink
  4. case class ArrayProperty(items: Property, uniqueItems: Boolean = false, required: Boolean = true, title: Option[String] = None, description: Option[String] = None, format: Option[String] = None) extends Property with Product with Serializable

    Permalink
  5. case class BodyParameter(schema: Option[Model] = None, name: Option[String] = None, description: Option[String] = None, required: Boolean = false, access: Option[String] = None, vendorExtensions: Map[String, Any] = Map.empty) extends Parameter with Product with Serializable

    Permalink
  6. case class ComposedModel(id: String, id2: String, description: Option[String] = None, allOf: List[Model] = Nil, parent: Option[Model] = None, child: Option[Model] = None, interfaces: List[RefModel] = Nil, properties: Map[String, Property] = Map.empty, example: Option[String] = None, externalDocs: Option[ExternalDocs] = None) extends Model with Product with Serializable

    Permalink
  7. case class Contact(name: String, url: Option[String] = None, email: Option[String] = None) extends Product with Serializable

    Permalink
  8. case class CookieParameter(type: String, format: Option[String] = None, collectionFormat: Option[String] = None, items: Option[Property] = None, defaultValue: Option[String] = None, name: Option[String] = None, description: Option[String] = None, required: Boolean = false, access: Option[String] = None, vendorExtensions: Map[String, Any] = Map.empty) extends Parameter with Product with Serializable

    Permalink
  9. case class ExternalDocs(description: String, url: String) extends Product with Serializable

    Permalink
  10. case class FormParameter(type: String, format: Option[String] = None, collectionFormat: Option[String] = None, items: Option[Property] = None, defaultValue: Option[String] = None, name: Option[String] = None, description: Option[String] = None, required: Boolean = false, access: Option[String] = None, vendorExtensions: Map[String, Any] = Map.empty) extends Parameter with Product with Serializable

    Permalink
  11. case class HeaderParameter(type: String, format: Option[String] = None, collectionFormat: Option[String] = None, items: Option[Property] = None, defaultValue: Option[String] = None, name: Option[String] = None, description: Option[String] = None, required: Boolean = false, access: Option[String] = None, vendorExtensions: Map[String, Any] = Map.empty) extends Parameter with Product with Serializable

    Permalink
  12. sealed trait In extends AnyRef

    Permalink
  13. case class Info(title: String, version: String, description: Option[String] = None, termsOfService: Option[String] = None, contact: Option[Contact] = None, license: Option[License] = None, vendorExtensions: Map[String, Any] = Map.empty) extends Product with Serializable

    Permalink
  14. case class License(name: String, url: String) extends Product with Serializable

    Permalink
  15. case class MapProperty(additionalProperties: Property, required: Boolean = false, title: Option[String] = None, description: Option[String] = None, format: Option[String] = None) extends Property with Product with Serializable

    Permalink
  16. sealed trait Model extends AnyRef

    Permalink
  17. case class ModelImpl(id: String, id2: String, description: Option[String] = None, type: Option[String] = None, name: Option[String] = None, required: List[String] = Nil, properties: Map[String, Property] = Map.empty, isSimple: Boolean = false, example: Option[String] = None, additionalProperties: Option[Property] = None, discriminator: Option[String] = None, externalDocs: Option[ExternalDocs] = None) extends Model with Product with Serializable

    Permalink
  18. case class OAuth2Definition(authorizationUrl: String, tokenUrl: String, flow: String, scopes: Map[String, String]) extends SecuritySchemeDefinition with Product with Serializable

    Permalink
  19. case class ObjectProperty(required: Boolean = false, title: Option[String] = None, description: Option[String] = None, format: Option[String] = None, properties: Map[String, Property] = Map.empty) extends Property with Product with Serializable

    Permalink
  20. case class Operation(tags: List[String] = Nil, summary: Option[String] = None, description: Option[String] = None, operationId: Option[String] = None, schemes: List[Scheme] = Nil, consumes: List[String] = Nil, produces: List[String] = Nil, parameters: List[Parameter] = Nil, responses: Map[String, Response] = Map.empty, security: List[Map[String, List[String]]] = Nil, externalDocs: Option[ExternalDocs] = None, deprecated: Boolean = false, vendorExtensions: Map[String, Any] = Map.empty) extends Product with Serializable

    Permalink
  21. sealed trait Parameter extends AnyRef

    Permalink
  22. case class Path(get: Option[Operation] = None, put: Option[Operation] = None, post: Option[Operation] = None, delete: Option[Operation] = None, patch: Option[Operation] = None, options: Option[Operation] = None, head: Option[Operation] = None, parameters: List[Parameter] = Nil, vendorExtensions: Map[String, Any] = Map.empty) extends Product with Serializable

    Permalink
  23. case class PathParameter(type: String, format: Option[String] = None, collectionFormat: Option[String] = None, items: Option[Property] = None, defaultValue: Option[String] = None, name: Option[String] = None, description: Option[String] = None, required: Boolean = false, access: Option[String] = None, vendorExtensions: Map[String, Any] = Map.empty) extends Parameter with Product with Serializable

    Permalink
  24. sealed trait Property extends AnyRef

    Permalink
  25. case class QueryParameter(type: Option[String] = None, $ref: Option[String] = None, format: Option[String] = None, collectionFormat: Option[String] = None, items: Option[Property] = None, defaultValue: Option[String] = None, name: Option[String] = None, description: Option[String] = None, required: Boolean = false, access: Option[String] = None, vendorExtensions: Map[String, Any] = Map.empty, isArray: Boolean = false, enums: List[String] = List.empty) extends Parameter with Product with Serializable

    Permalink
  26. case class RefModel(id: String, id2: String, ref: String, description: Option[String] = None, properties: Map[String, Property] = Map.empty, example: Option[String] = None, externalDocs: Option[ExternalDocs] = None) extends Model with Product with Serializable

    Permalink
  27. case class RefParameter(ref: String, name: Option[String] = None, description: Option[String] = None, required: Boolean = false, access: Option[String] = None, vendorExtensions: Map[String, Any] = Map.empty) extends Parameter with Product with Serializable

    Permalink
  28. case class RefProperty(ref: String, required: Boolean = false, title: Option[String] = None, description: Option[String] = None, format: Option[String] = None) extends Property with Product with Serializable

    Permalink
  29. case class Response(description: String, schema: Option[Property] = None, examples: Map[String, String] = Map.empty, headers: Map[String, Property] = Map.empty) extends Product with Serializable

    Permalink
  30. sealed trait Scheme extends AnyRef

    Permalink
  31. case class SecurityRequirement(name: String, scopes: List[String]) extends Product with Serializable

    Permalink
  32. sealed trait SecuritySchemeDefinition extends AnyRef

    Permalink
  33. case class SecurityScope(name: String, description: String) extends Product with Serializable

    Permalink
  34. case class StringProperty(title: Option[String] = None, description: Option[String] = None, format: Option[String] = None, required: Boolean = false, enums: Set[String], minLength: Option[Int] = None, maxLength: Option[Int] = None, pattern: Option[String] = None, default: Option[String] = None) extends Property with Product with Serializable

    Permalink
  35. case class Swagger(swagger: String = "2.0", info: Option[Info] = None, host: Option[String] = None, basePath: Option[String] = None, schemes: List[Scheme] = Nil, consumes: List[String] = Nil, produces: List[String] = Nil, paths: Map[String, Path] = Map.empty, securityDefinitions: Map[String, SecuritySchemeDefinition] = Map.empty, definitions: Map[String, Model] = Map.empty, parameters: Map[String, Parameter] = Map.empty, externalDocs: Option[ExternalDocs] = None) extends Product with Serializable

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. object BasicAuthDefinition extends SecuritySchemeDefinition with Product with Serializable

    Permalink
  5. object In

    Permalink
  6. object Parameter

    Permalink
  7. object Scheme

    Permalink
  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  12. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  14. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  20. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  21. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped