Forum Discussion

cscott952's avatar
cscott952
New Contributor
6 years ago

Required parameters from multiple schemas

Hello, I'm trying to enforce required parameters in both the 'check_single' and 'check_set' below. The required parameters work when passing when they match the 'check_single', but I haven't been s...
  • RonRatovsky's avatar
    RonRatovsky
    6 years ago

    The use of `anyOf` means that the input would need to match one (or more) of the sub-schemas described in it.

     

    The problem is that you have `anyOf` with two different types - `object` and `array`. The `required` and `properties` are at the same level of the `anyOf` - that means that they would only be applied `check_single` as its type is `object`. When you put type `array` alongside `required` or `properties`, the latter two would have no impact as they have no meaning with tpe `array`.

     

    So what can you do to solve this?

     

    Take the 'single' object definition and extract it to a model. For our purpose, let's call it `MyObject`.

     

    So:

     

    MyObject:
  type: object
  required: [...]
  properties: ...

     

     

    And then you can define `check` as this:

     

    check:
  anyOf:
    - $ref: '#/components/schemas/MyObject'
    - type: array
      items:
            $ref: '#/components/schemas/MyObject

     

    In this case, you may want to use `oneOf` instead, because there will never be case where a compared input will have both.

     

RonRatovsky's avatar
RonRatovsky
Staff

The use of `anyOf` means that the input would need to match one (or more) of the sub-schemas described in it.

 

The problem is that you have `anyOf` with two different types - `object` and `array`. The `required` and `properties` are at the same level of the `anyOf` - that means that they would only be applied `check_single` as its type is `object`. When you put type `array` alongside `required` or `properties`, the latter two would have no impact as they have no meaning with tpe `array`.

 

So what can you do to solve this?

 

Take the 'single' object definition and extract it to a model. For our purpose, let's call it `MyObject`.

 

So:

 

MyObject:
  type: object
  required: [...]
  properties: ...

 

 

And then you can define `check` as this:

 

check:
  anyOf:
    - $ref: '#/components/schemas/MyObject'
    - type: array
      items:
        $ref: '#/components/schemas/MyObject

 

In this case, you may want to use `oneOf` instead, because there will never be case where a compared input will have both.

 

cscott952's avatar
cscott952
New Contributor
6 years ago

Thanks a lot! I have it mostly working, and have a much better understanding of how to overlay schemas.  That said, is there any way to get the response to include what required property is in violation when an incorrect JSON payload is sent?  In my old spec, the 'single' schema would return what property/element was in violation.  What I have now just returns  ... ' is not valid under any of the given schemas'.  The client receives this:

 

{<JSON request body> is not valid under any of the given schemas",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}

 

 

  • RonRatovsky's avatar
    RonRatovsky
    Staff
    6 years ago

    That's more likely a question to the Connexion team. It's not our project and we don't have enough knowledge to help with it. However, they are very responsive so if you file a ticket on the project's repo, I'm sure they'll get back to you.