required property in referenced response

[gbkwiatt]

In this scenario my required properties are checked in the main response, not in nested config object. So it fails validation
yaml:

/system/config:
 get ... 

responses:
        '200':
          description: Config list
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Config'
                  - $ref: '#/components/schemas/dataToken'

components:
  schemas:
   Config:
     type: object
      properties:
        systemName:
          type: string
     required:
        - systemName

if I change systemName to config on required, it passes validation. which menas doesnt matter where required is, it always checks from main response object ?

[rwalle61]

Hi @gbkwiatt, thanks for raising this.

What’s in your dataToken schema, and what’s the validation error you’re getting?

[gbkwiatt]

dataToken schema is just another properties which are fine in this case.
without it I get same errors

dataToken:
      type: object
      properties:
        errorMessage:
          type: string
          example: ''
        errorCode:
          type: string
          example: ''
          enum:
            - ''
        token:
          type: string
          example: hbGciOiJIUzI1NiIsInR5cCI6...

validation error just says response should have required systemName, which it does but in response.body.config.systemName, but it looks for systemName inside response.body instead.

[rwalle61]

Okay, it looks like this isn't a bug, and your response schema is slightly different to your response body.

Your response body has response.body.config.systemName, but your response schema currently does not actually mention a config property. (Calling your schema Config does not make a difference in this respect).

Try this response schema:

        content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      config:
                        $ref: '#/components/schemas/Config'
                  - $ref: '#/components/schemas/dataToken'

Does that resolve your error?

(And if you get another error to do with allOf, check you are using allOf correctly - see this explanation #46 (comment))

[gbkwiatt]

I just had a look after sleep, and you are so right I don't know how I missed that, I was so certain config is there. Well It was there before but I must messed up on some point and in my head it was always there ;) Thank you for pointing it out. Again 'user errors' and your module is great, saves so much coding