Packages

case object OneOfWithBaseRef extends CoproductEncoding with Product with Serializable

Strategy that extends OneOf so that each variant also refers back to the base type schema using allOf. This approach is sometimes referred to in OpenAPI 3 as a way to model polymorphism.

  • compatible with OpenAPI clients that don't handle oneOf properly
  • more complex schemas in Swagger UI

Using the Pet example above, this strategy yields the following:

"schemas": {
  "Pet": {
    "oneOf": [
      { "$ref": "#/components/schemas/Cat" },
      { "$ref": "#/components/schemas/Lizard" }
    ],
    "discriminator": {
      "propertyName": "type",
      "mapping": {
        "Cat": "#/components/schemas/Cat",
        "Lizard": "#/components/schemas/Lizard"
      }
    }
  },

  "Cat": {
    "allOf": [
      { "$ref": "#/components/schemas/Pet" },
      {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [ "Cat" ]
          },
          "name": {
            "type": "string"
          }
        },
        "required": [
          "type",
          "name"
        ]
      }
    ]
  },

  "Lizard": {
    "allOf": [
      { "$ref": "#/components/schemas/Pet" },
      {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [ "Lizard" ]
          },
          "lovesRocks": {
            "type": "boolean"
          }
        },
        "required": [
          "type",
          "lovesRocks"
        ]
      }
    ]
  }
}
Source
JsonSchemas.scala
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OneOfWithBaseRef
  2. Serializable
  3. Product
  4. Equals
  5. CoproductEncoding
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  9. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  10. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  12. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  13. def productElementName(n: Int): String
    Definition Classes
    Product
  14. def productElementNames: Iterator[String]
    Definition Classes
    Product
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from CoproductEncoding

Inherited from AnyRef

Inherited from Any

Ungrouped