Class/Object

com.avsystem.commons.rest.openapi

Schema

Related Docs: object Schema | package openapi

Permalink

case class Schema(type: commons.OptArg[DataType] = OptArg.Empty, format: commons.OptArg[String] = OptArg.Empty, title: commons.OptArg[String] = OptArg.Empty, description: commons.OptArg[String] = OptArg.Empty, nullable: Boolean = false, readOnly: Boolean = false, writeOnly: Boolean = false, xml: commons.OptArg[Xml] = OptArg.Empty, externalDocs: commons.OptArg[ExternalDocumentation] = OptArg.Empty, deprecated: Boolean = false, multipleOf: commons.OptArg[BigDecimal] = OptArg.Empty, maximum: commons.OptArg[BigDecimal] = OptArg.Empty, exclusiveMaximum: Boolean = false, minimum: commons.OptArg[BigDecimal] = OptArg.Empty, exclusiveMinimum: Boolean = false, maxLength: commons.OptArg[Int] = OptArg.Empty, minLength: commons.OptArg[Int] = OptArg.Empty, pattern: commons.OptArg[String] = OptArg.Empty, items: commons.OptArg[RefOr[Schema]] = OptArg.Empty, maxItems: commons.OptArg[Int] = OptArg.Empty, minItems: commons.OptArg[Int] = OptArg.Empty, uniqueItems: Boolean = false, properties: Map[String, RefOr[Schema]] = Map.empty, additionalProperties: commons.OptArg[RefOr[Schema]] = OptArg.Empty, maxProperties: commons.OptArg[Int] = OptArg.Empty, minProperties: commons.OptArg[Int] = OptArg.Empty, required: List[String] = Nil, allOf: List[RefOr[Schema]] = Nil, oneOf: List[RefOr[Schema]] = Nil, anyOf: List[RefOr[Schema]] = Nil, not: commons.OptArg[RefOr[Schema]] = OptArg.Empty, discriminator: commons.OptArg[Discriminator] = OptArg.Empty, enum: List[JsonValue] = Nil, default: commons.OptArg[JsonValue] = OptArg.Empty, example: commons.OptArg[JsonValue] = OptArg.Empty) extends Product with Serializable

Representation of Schema Object

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Schema
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Schema(type: commons.OptArg[DataType] = OptArg.Empty, format: commons.OptArg[String] = OptArg.Empty, title: commons.OptArg[String] = OptArg.Empty, description: commons.OptArg[String] = OptArg.Empty, nullable: Boolean = false, readOnly: Boolean = false, writeOnly: Boolean = false, xml: commons.OptArg[Xml] = OptArg.Empty, externalDocs: commons.OptArg[ExternalDocumentation] = OptArg.Empty, deprecated: Boolean = false, multipleOf: commons.OptArg[BigDecimal] = OptArg.Empty, maximum: commons.OptArg[BigDecimal] = OptArg.Empty, exclusiveMaximum: Boolean = false, minimum: commons.OptArg[BigDecimal] = OptArg.Empty, exclusiveMinimum: Boolean = false, maxLength: commons.OptArg[Int] = OptArg.Empty, minLength: commons.OptArg[Int] = OptArg.Empty, pattern: commons.OptArg[String] = OptArg.Empty, items: commons.OptArg[RefOr[Schema]] = OptArg.Empty, maxItems: commons.OptArg[Int] = OptArg.Empty, minItems: commons.OptArg[Int] = OptArg.Empty, uniqueItems: Boolean = false, properties: Map[String, RefOr[Schema]] = Map.empty, additionalProperties: commons.OptArg[RefOr[Schema]] = OptArg.Empty, maxProperties: commons.OptArg[Int] = OptArg.Empty, minProperties: commons.OptArg[Int] = OptArg.Empty, required: List[String] = Nil, allOf: List[RefOr[Schema]] = Nil, oneOf: List[RefOr[Schema]] = Nil, anyOf: List[RefOr[Schema]] = Nil, not: commons.OptArg[RefOr[Schema]] = OptArg.Empty, discriminator: commons.OptArg[Discriminator] = OptArg.Empty, enum: List[JsonValue] = Nil, default: commons.OptArg[JsonValue] = OptArg.Empty, example: commons.OptArg[JsonValue] = OptArg.Empty)

    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. val additionalProperties: commons.OptArg[RefOr[Schema]]

    Permalink

  5. val allOf: List[RefOr[Schema]]

    Permalink

  6. val anyOf: List[RefOr[Schema]]

    Permalink

  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  9. val default: commons.OptArg[JsonValue]

    Permalink

  10. val deprecated: Boolean

    Permalink

  11. val description: commons.OptArg[String]

    Permalink

  12. val discriminator: commons.OptArg[Discriminator]

    Permalink

  13. val enum: List[JsonValue]

    Permalink

  14. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  15. val example: commons.OptArg[JsonValue]

    Permalink

  16. val exclusiveMaximum: Boolean

    Permalink

  17. val exclusiveMinimum: Boolean

    Permalink

  18. val externalDocs: commons.OptArg[ExternalDocumentation]

    Permalink

  19. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  20. val format: commons.OptArg[String]

    Permalink

  21. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  23. val items: commons.OptArg[RefOr[Schema]]

    Permalink

  24. val maxItems: commons.OptArg[Int]

    Permalink

  25. val maxLength: commons.OptArg[Int]

    Permalink

  26. val maxProperties: commons.OptArg[Int]

    Permalink

  27. val maximum: commons.OptArg[BigDecimal]

    Permalink

  28. val minItems: commons.OptArg[Int]

    Permalink

  29. val minLength: commons.OptArg[Int]

    Permalink

  30. val minProperties: commons.OptArg[Int]

    Permalink

  31. val minimum: commons.OptArg[BigDecimal]

    Permalink

  32. val multipleOf: commons.OptArg[BigDecimal]

    Permalink

  33. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  34. val not: commons.OptArg[RefOr[Schema]]

    Permalink

  35. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  36. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  37. val nullable: Boolean

    Permalink

  38. val oneOf: List[RefOr[Schema]]

    Permalink

  39. val pattern: commons.OptArg[String]

    Permalink

  40. val properties: Map[String, RefOr[Schema]]

    Permalink

  41. val readOnly: Boolean

    Permalink

  42. val required: List[String]

    Permalink

  43. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  44. val title: commons.OptArg[String]

    Permalink

  45. val type: commons.OptArg[DataType]

    Permalink

  46. val uniqueItems: Boolean

    Permalink

  47. final def wait(): Unit

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

  48. final def wait(arg0: Long, arg1: Int): Unit

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

  49. final def wait(arg0: Long): Unit

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

  50. val writeOnly: Boolean

    Permalink

  51. val xml: commons.OptArg[Xml]

    Permalink

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped