fix: required of parent schema not considered in allOf #1570

[MGabr]

Status

READY

Description

Fixes #1570

Given a schema like

components:
  schemas:
    NewTicketNotification:
      required:
        - ctime
        - id
        - ticketId
        - type
        - userId
      type: object
      allOf:
        - $ref: '#/components/schemas/Notification'
        - type: object
          properties:
            ticketId:
              type: integer
              format: int32
            userId:
              type: integer
              format: int32

the allOf was considered as schema on its own when resolving the value of the fields, but in fact we want to consider the required fields of the parent schema also for the allOf sub schema.

This fixes this by including the required field of the parent schema in the sub schema.

Related PRs

There is this existing outdated PR: #861

Todos

• Tests
• Documentation
• Changelog Entry (unreleased)

Steps to Test or Reproduce

> git clone https://github.com/MGabr/orval.git
> yarn build
> cd tests
> yarn generate:react-query

The TypeScript model generated for the new polymorphic-required.yaml test spec should have the required fields set correctly.

So for

components:
  schemas:
    DescendantOne:
      required:
        - type
        - count
      type: object
      allOf:
        - $ref: '#/components/schemas/ParentType'
        - type: object
          properties:
            value:
              type: boolean
            count:
              type: integer
              format: int32
            otherCount:
              type: integer
              format: int32

it generates

export type DescendantOneAllOf = {
  count: number;
  otherCount?: number;
  value?: boolean;
};

[MGabr]

I think this still needs to be adjusted to handle edge cases where both the parent and the sub schema have a required field.

Like:

components:
  schemas:
    DescendantOne:
      required:
        - type
      type: object
      allOf:
        - $ref: '#/components/schemas/ParentType'
        - type: object
           required:
            - count
          properties:
            value:
              type: boolean
            count:
              type: integer
              format: int32
            otherCount:
              type: integer
              format: int32

Currently only the parent required would be considered but I think both required should be considered in this case. Still to check.

[soartec-lab]

@MGabr
Thanks for nice update. i added a comment.

[soartec-lab]

could you merge the yaml of these test files?
I don't wanna separeate related tests.

[MGabr]

Sure, I merged those two into the existing polymorphic.yaml file now

[soartec-lab]

Thanks!