org.http4s.rho.swagger

models

Related Doc: package swagger

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
Learn more about member selection
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

  2. case class ApiKeyAuthDefinition(name: String, in: In) extends SecuritySchemeDefinition with Product with Serializable

  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

  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

  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

  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

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

  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

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

  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

  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

  12. sealed trait In extends AnyRef

  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

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

  15. sealed trait Model extends AnyRef

  16. 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

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

  18. 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

  19. sealed trait Parameter extends AnyRef

  20. 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, parameters: List[Parameter] = Nil, vendorExtensions: Map[String, Any] = Map.empty) extends Product with Serializable

  21. 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

  22. sealed trait Property extends AnyRef

  23. 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) extends Parameter with Product with Serializable

  24. 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

  25. 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

  26. 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

  27. 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

  28. sealed trait Scheme extends AnyRef

  29. case class SecurityDefinition(type: String, scopes: Map[String, String]) extends Product with Serializable

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

  31. sealed trait SecuritySchemeDefinition extends AnyRef

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

  33. 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

Value Members

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

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

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

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

  5. object In

  6. object Parameter

  7. object Scheme

  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def clone(): AnyRef

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

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

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

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

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

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

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

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

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

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

    Definition Classes
    AnyRef
  20. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped