openapi.yaml

openapi: 3.1.0
info:
  description: |
    This tests for a oneOf interface representation
  title: ByRefOrValue
  version: 0.0.1
servers:
- url: http://localhost:8080
tags:
- name: Foo
- name: Bar
paths:
  /foo:
    get:
      operationId: getAllFoos
      responses:
        "200":
          $ref: "#/components/responses/200FooArray"
      summary: GET all Foos
      tags:
      - Foo
      x-accepts:
      - application/json;charset=utf-8
    post:
      operationId: createFoo
      requestBody:
        $ref: "#/components/requestBodies/Foo"
      responses:
        "201":
          $ref: "#/components/responses/201Foo"
      summary: Create a Foo
      tags:
      - Foo
      x-content-type: application/json;charset=utf-8
      x-accepts:
      - application/json
  /bar:
    post:
      operationId: createBar
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Bar_Create"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Bar"
          description: Bar created
      summary: Create a Bar
      tags:
      - Bar
      x-content-type: application/json
      x-accepts:
      - application/json
components:
  requestBodies:
    Foo:
      content:
        application/json;charset=utf-8:
          schema:
            $ref: "#/components/schemas/Foo"
      description: The Foo to be created
  responses:
    "204":
      content: {}
      description: Deleted
    "201Foo":
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/FooRefOrValue"
      description: Error
    "200FooArray":
      content:
        application/json;charset=utf-8:
          schema:
            items:
              $ref: "#/components/schemas/FooRefOrValue"
            type: array
            default: null
      description: Success
  schemas:
    Addressable:
      description: Base schema for addressable entities
      properties:
        href:
          description: Hyperlink reference
          type: string
        id:
          description: unique identifier
          type: string
    Extensible:
      properties:
        '@schemaLocation':
          description: A URI to a JSON-Schema file that defines additional attributes
            and relationships
          type: string
        '@baseType':
          description: "When sub-classing, this defines the super-class"
          type: string
        '@type':
          description: "When sub-classing, this defines the sub-class Extensible name"
          type: string
      required:
      - '@type'
    Entity:
      allOf:
      - $ref: "#/components/schemas/Addressable"
      - $ref: "#/components/schemas/Extensible"
      discriminator:
        propertyName: '@type'
    EntityRef:
      allOf:
      - $ref: "#/components/schemas/Addressable"
      - $ref: "#/components/schemas/Extensible"
      - description: Entity reference schema to be use for all entityRef class.
        properties:
          name:
            description: Name of the related entity.
            type: string
          '@referredType':
            description: The actual type of the target instance when needed for disambiguation.
            type: string
        type: object
        example: null
      discriminator:
        propertyName: '@type'
      example: null
    FooRefOrValue:
      discriminator:
        propertyName: '@type'
      oneOf:
      - $ref: "#/components/schemas/Foo"
      - $ref: "#/components/schemas/FooRef"
      x-one-of-name: FooRefOrValue
    Foo:
      allOf:
      - $ref: "#/components/schemas/Entity"
      - properties:
          fooPropA:
            type: string
          fooPropB:
            type: string
        type: object
        example: null
      example:
        href: href
        id: id
        '@schemaLocation': '@schemaLocation'
        '@baseType': '@baseType'
        '@type': '@type'
        fooPropA: fooPropA
        fooPropB: fooPropB
    FooRef:
      allOf:
      - $ref: "#/components/schemas/EntityRef"
      - properties:
          foorefPropA:
            type: string
        type: object
        example: null
      example: null
    BarRef:
      allOf:
      - $ref: "#/components/schemas/EntityRef"
    Bar_Create:
      allOf:
      - $ref: "#/components/schemas/Entity"
      - properties:
          barPropA:
            type: string
          fooPropB:
            type: string
          foo:
            $ref: "#/components/schemas/FooRefOrValue"
        type: object
        example: null
      example: null
    Bar:
      allOf:
      - $ref: "#/components/schemas/Entity"
      - properties:
          id:
            type: string
          barPropA:
            type: string
          fooPropB:
            type: string
          foo:
            $ref: "#/components/schemas/FooRefOrValue"
        required:
        - id
        type: object
        example: null
      example:
        href: href
        id: id
        '@schemaLocation': '@schemaLocation'
        '@baseType': '@baseType'
        '@type': '@type'
        barPropA: barPropA
        fooPropB: fooPropB
        foo:
          href: href
          id: id
          '@schemaLocation': '@schemaLocation'
          '@baseType': '@baseType'
          '@type': '@type'
          fooPropA: fooPropA
          fooPropB: fooPropB
    BarRefOrValue:
      oneOf:
      - $ref: "#/components/schemas/Bar"
      - $ref: "#/components/schemas/BarRef"
      x-one-of-name: BarRefOrValue
    Pizza:
      allOf:
      - $ref: "#/components/schemas/Entity"
      - properties:
          pizzaSize:
            type: number
        type: object
        example: null
      example: null
    Pasta:
      allOf:
      - $ref: "#/components/schemas/Entity"
      - properties:
          vendor:
            type: string
        type: object
        example: null
      example: null
    PizzaSpeziale:
      allOf:
      - $ref: "#/components/schemas/Pizza"
      - properties:
          toppings:
            type: string
        type: object
        example: null
      example: null
    FruitType:
      enum:
      - APPLE
      - BANANA
      type: string
    Fruit:
      discriminator:
        mapping:
          APPLE: "#/components/schemas/Apple"
          BANANA: "#/components/schemas/Banana"
        propertyName: fruitType
      oneOf:
      - $ref: "#/components/schemas/Apple"
      - $ref: "#/components/schemas/Banana"
      properties:
        fruitType:
          allOf:
          - $ref: "#/components/schemas/FruitType"
          description: test
      required:
      - fruitType
      x-one-of-name: Fruit
    Apple:
      properties:
        seeds:
          type: integer
      required:
      - seeds
    Banana:
      properties:
        length:
          type: integer
      required:
      - length
    Animal:
      oneOf:
      - $ref: "#/components/schemas/Dog"
      - $ref: "#/components/schemas/Cat"
      x-one-of-name: Animal
    Cat:
      properties:
        declawed:
          type: boolean
    Dog:
      properties:
        bark:
          type: boolean