Class/Object

io.udash.rest.openapi

Schema

Related Docs: object Schema | package openapi

Permalink

final case class Schema(type: com.avsystem.commons.OptArg[DataType] = OptArg.Empty, format: com.avsystem.commons.OptArg[String] = OptArg.Empty, title: com.avsystem.commons.OptArg[String] = OptArg.Empty, description: com.avsystem.commons.OptArg[String] = OptArg.Empty, nullable: Boolean = false, readOnly: Boolean = false, writeOnly: Boolean = false, xml: com.avsystem.commons.OptArg[Xml] = OptArg.Empty, externalDocs: com.avsystem.commons.OptArg[ExternalDocumentation] = OptArg.Empty, deprecated: Boolean = false, multipleOf: com.avsystem.commons.OptArg[BigDecimal] = OptArg.Empty, maximum: com.avsystem.commons.OptArg[BigDecimal] = OptArg.Empty, exclusiveMaximum: Boolean = false, minimum: com.avsystem.commons.OptArg[BigDecimal] = OptArg.Empty, exclusiveMinimum: Boolean = false, maxLength: com.avsystem.commons.OptArg[Int] = OptArg.Empty, minLength: com.avsystem.commons.OptArg[Int] = OptArg.Empty, pattern: com.avsystem.commons.OptArg[String] = OptArg.Empty, items: com.avsystem.commons.OptArg[RefOr[Schema]] = OptArg.Empty, maxItems: com.avsystem.commons.OptArg[Int] = OptArg.Empty, minItems: com.avsystem.commons.OptArg[Int] = OptArg.Empty, uniqueItems: Boolean = false, properties: Map[String, RefOr[Schema]] = Map.empty, additionalProperties: AdditionalProperties = AdditionalProperties.Flag(true), maxProperties: com.avsystem.commons.OptArg[Int] = OptArg.Empty, minProperties: com.avsystem.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: com.avsystem.commons.OptArg[RefOr[Schema]] = OptArg.Empty, discriminator: com.avsystem.commons.OptArg[Discriminator] = OptArg.Empty, enum: List[JsonValue] = Nil, default: com.avsystem.commons.OptArg[JsonValue] = OptArg.Empty, example: com.avsystem.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: com.avsystem.commons.OptArg[DataType] = OptArg.Empty, format: com.avsystem.commons.OptArg[String] = OptArg.Empty, title: com.avsystem.commons.OptArg[String] = OptArg.Empty, description: com.avsystem.commons.OptArg[String] = OptArg.Empty, nullable: Boolean = false, readOnly: Boolean = false, writeOnly: Boolean = false, xml: com.avsystem.commons.OptArg[Xml] = OptArg.Empty, externalDocs: com.avsystem.commons.OptArg[ExternalDocumentation] = OptArg.Empty, deprecated: Boolean = false, multipleOf: com.avsystem.commons.OptArg[BigDecimal] = OptArg.Empty, maximum: com.avsystem.commons.OptArg[BigDecimal] = OptArg.Empty, exclusiveMaximum: Boolean = false, minimum: com.avsystem.commons.OptArg[BigDecimal] = OptArg.Empty, exclusiveMinimum: Boolean = false, maxLength: com.avsystem.commons.OptArg[Int] = OptArg.Empty, minLength: com.avsystem.commons.OptArg[Int] = OptArg.Empty, pattern: com.avsystem.commons.OptArg[String] = OptArg.Empty, items: com.avsystem.commons.OptArg[RefOr[Schema]] = OptArg.Empty, maxItems: com.avsystem.commons.OptArg[Int] = OptArg.Empty, minItems: com.avsystem.commons.OptArg[Int] = OptArg.Empty, uniqueItems: Boolean = false, properties: Map[String, RefOr[Schema]] = Map.empty, additionalProperties: AdditionalProperties = AdditionalProperties.Flag(true), maxProperties: com.avsystem.commons.OptArg[Int] = OptArg.Empty, minProperties: com.avsystem.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: com.avsystem.commons.OptArg[RefOr[Schema]] = OptArg.Empty, discriminator: com.avsystem.commons.OptArg[Discriminator] = OptArg.Empty, enum: List[JsonValue] = Nil, default: com.avsystem.commons.OptArg[JsonValue] = OptArg.Empty, example: com.avsystem.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: AdditionalProperties

    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
    @HotSpotIntrinsicCandidate() @throws( ... )

  9. val default: com.avsystem.commons.OptArg[JsonValue]

    Permalink

  10. val deprecated: Boolean

    Permalink

  11. val description: com.avsystem.commons.OptArg[String]

    Permalink

  12. val discriminator: com.avsystem.commons.OptArg[Discriminator]

    Permalink

  13. val enum: List[JsonValue]

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  15. val example: com.avsystem.commons.OptArg[JsonValue]

    Permalink

  16. val exclusiveMaximum: Boolean

    Permalink

  17. val exclusiveMinimum: Boolean

    Permalink

  18. val externalDocs: com.avsystem.commons.OptArg[ExternalDocumentation]

    Permalink

  19. val format: com.avsystem.commons.OptArg[String]

    Permalink

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

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  21. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  22. val items: com.avsystem.commons.OptArg[RefOr[Schema]]

    Permalink

  23. val maxItems: com.avsystem.commons.OptArg[Int]

    Permalink

  24. val maxLength: com.avsystem.commons.OptArg[Int]

    Permalink

  25. val maxProperties: com.avsystem.commons.OptArg[Int]

    Permalink

  26. val maximum: com.avsystem.commons.OptArg[BigDecimal]

    Permalink

  27. val minItems: com.avsystem.commons.OptArg[Int]

    Permalink

  28. val minLength: com.avsystem.commons.OptArg[Int]

    Permalink

  29. val minProperties: com.avsystem.commons.OptArg[Int]

    Permalink

  30. val minimum: com.avsystem.commons.OptArg[BigDecimal]

    Permalink

  31. val multipleOf: com.avsystem.commons.OptArg[BigDecimal]

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  33. val not: com.avsystem.commons.OptArg[RefOr[Schema]]

    Permalink

  34. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  35. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  36. val nullable: Boolean

    Permalink

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

    Permalink

  38. val pattern: com.avsystem.commons.OptArg[String]

    Permalink

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

    Permalink

  40. val readOnly: Boolean

    Permalink

  41. val required: List[String]

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  43. val title: com.avsystem.commons.OptArg[String]

    Permalink

  44. val type: com.avsystem.commons.OptArg[DataType]

    Permalink

  45. val uniqueItems: Boolean

    Permalink

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

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

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

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

  48. final def wait(): Unit

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

  49. val writeOnly: Boolean

    Permalink

  50. val xml: com.avsystem.commons.OptArg[Xml]

    Permalink

Deprecated Value Members

  1. def finalize(): Unit

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

    (Since version ) see corresponding Javadoc for more information.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped