Default value ambiguity in `oneOf` / Support for discriminators?

[catadch]

I can't work out if discriminators are supposed to be supported, or not. I certainly can't get them to be honored. If I use express-ajv-swagger-validation then they are honored, but default values are not. Kind of hoping express-openapi-validator might be a one-stop-shop as everything else works a treat.

[catadch]

Actually, it could be that oneOf isn't working. I have schema types with different properties and they're not being distinguished from one another.

[gonenduk]

Can you give an example? allOf is working well for me.

[catadch]

So my schema is pretty big, but way down in it I have something like this:

When I POST an instance of SimilarTypeOne, we're all set. When I POST an instance of SimilarTypeTwo the validator complains uniqueOne is missing.

If I switch the order in the oneOf, instances of SimilarTypeOne now get rejected for not having uniqueTwo.

  SimilarTypeOne:
     allOf:   
       - $ref: '#/components/schemas/SimilarSuperType'
     type: object
     properties:
       type:
         type: string
         enum: [Some Value One]
       uniqueOne:
         type: string
     required:
       - type
      - uniqueOne

   SimilarTypeTwo:
     allOf:   
       - $ref: '#/components/schemas/SimilarSuperType'
     type: object
     properties:
       type:
         type: string
         enum: [Some Value Tow]
       uniqueTwo:
         type: string
     required:
       - type
      - uniqueTwo

   SomeType:
     allOf:   
       - $ref: '#/components/schemas/SomeSuperTYpe'
     type: object
     properties:
       something:
         type: array
         minItems: 1
         maxItems: 2
         items:
           oneOf:
             - $ref: "#/components/schemas/SimilarTypeOne"
             - $ref: "#/components/schemas/SimilarTypeTwo"
           discriminator:
             propertyName: type

[cdimascio]

@catadch would you mind posting your full spec as well as the request body you are POSTing. i'd like to repro this to investigate.

if you do not wish to post the entire spec here publicly, you can direct message it to me on gitter - just hover over my avatar and select "Chat Privately"

[catadch]

@cdimascio can't send you the whole schema for copyright / ip reasons and in simplifying / anonymizing for a reproducible test case, the problem goes away : (

If I figure out what the problem is, I'll let you know.

[cdimascio]

@catadch i created a few tests to exercise the schema you sent. it appears to work in that i'm able to use the two oneOf instances
see here -> https://github.com/cdimascio/express-openapi-validator/pull/105/files

there may be some other element that is contributing to the issue.
it would be great if you can provide a snippet that can repro the issue.

feel free to modify my tests as well

[catadch]

@cdimascio - I found the problem.

In the schema below, it's the enums / defaults for the two "value" number type properties that causes the problem.

Comment either one out and the problem goes away.

I have a stand-alone project to demonstrate this is you want it.

openapi: '3.0.0'

info:
  description: express-openapi-validator-test
  version: 1.0.0
  title: express-openapi-validator-test
  license:
    name: MIT License
    url: https://opensource.org/licenses/MIT

servers:
  - url: http://localhost:3010/v0

paths:
  /typethrees:
    post:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/TypeThree'
      responses:
        '201':
          description: Application response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TypeThree'
        default:
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'

components:
  schemas:
    Error:
      required:
        - code
        - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string

    SuperTypeOne:
      type: object
      properties:
        type:
          type: string
        value:
          type: number
          format: int32
      discriminator:
        propertyName: type
      required:
        - value
        - type

    TypeOne:
      allOf:   
        - $ref: '#/components/schemas/SuperTypeOne'
      type: object
      properties:
        type:
          type: string
          enum: [TypeOne]
        value:
          type: number
          format: int32
          enum: [ 1 ]
          default: 1
        uniqueOne:
          type: string
          default: Unique One
      required:
        - type
        - uniqueOne

    TypeTwo:
      allOf:   
        - $ref: '#/components/schemas/SuperTypeOne'
      type: object
      properties:
        type:
          type: string
          enum: [TypeTwo]
        value:
          type: number
          format: int32
          enum: [ 2 ]
          default: 2
        uniqueTwo:
          type: string
          default: Unique Two
      required:
        - uniqueTwo

    SuperTypeTwo:
      type: object
      properties:
        id:
          type: string
          format: uuid
        date:
          type: string
          format: date-time
        someStrings:
          type: array
          items:
            type: string

    TypeThree:
      allOf:   
        - $ref: '#/components/schemas/SuperTypeTwo'
      type: object
      properties:
        type:
          type: string
          enum: [TypeThree]
          default: TypeThree
        somethings:
          type: array
          minItems: 1
          maxItems: 2
          items:
            oneOf:
              - $ref: "#/components/schemas/TypeOne"
              - $ref: "#/components/schemas/TypeTwo"
            discriminator:
              propertyName: type
      required:
        - type
        - somethings

[cdimascio]

hmm. i added a new test that adds the value properties in a manner similar to what you show above
same PR here -> https://github.com/cdimascio/express-openapi-validator/pull/105/files

I'm still not able to reproduce

please send along your sample project that is able to trigger the issue.

also, feel free to review my test to make sure i'm exercising your case properly

[catadch]

@cdimascio try this:

https://github.com/catadch/express-openapi-validator-test

Let me know when you'e cloned it and I'll make it private again.

[cdimascio]

i cloned it, ran npm start, but appears index.js is missing

[catadch]

$ npm test

As in the README : )

[cdimascio]

gotcha. just picked up the readme change. i can run the test. thanks!
(fyi, i'm heading out shortly, but will definitely have a look tomorrow)
thanks for your help on this

[catadch]

No worries.

It's 01:00 where I am and I've been working on this for 48 hours straight, so i'm out of here too.

[cdimascio]

get some sleep :) hopefully we'll have some answers soon.