Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

allOf raises invalid media examples (model composition)

See original GitHub issue

Describe the bug Making use of allOf raises no-invalid-media-type-examples

Expected behavior allOf combines the objects as expected

openapi: 3.1.0
info:
  version: '1.0'
  title: Test
  description: |
    Test OAS
  license:
    name: Copyright
    url: 'https://foo.com'
  contact:
    name: Contact
    url: 'https://www.foo.com'
    email: bar@foo.com
servers:
  - url: 'https://foo.com'
tags:
  - name: Test
    description: A Test API
paths:
  /test:
    get:
      summary: Retrieve a Test
      operationId: getTest
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestModel'
              example:
                address_1: boulevard Montmartre
                address_2: 5eme etage
                city: Paris
                country_state: null
                email: 'foo@bar.com'
components:
  schemas:
    TestModel:
      title: TestModel
      description: A Test Object
      allOf:
        - $ref: '#/components/schemas/BaseModel'
        - type: object
          properties:
            address_1:
              type: string
            address_2:
              type: string
            city:
              type: string
            country_state:
              type:
                - string
                - 'null'

    BaseModel:
      title: BaseModel
      type: object
      description: A Base test model for testing
      properties:
        email:
          type: string

When running the above, redocly complains about the example and all of the fields (excerpt from the validation)

Example value must conform to the schema: must NOT have additional properties `address_2`.

34 | email: foo@bar.com
35 | address_1: boulevard Montmartre
36 | address_2: 5eme etage
37 | city: Paris
38 | country_state: null

referenced from schemas/orders/test.yaml:29:15

Error was generated by the no-invalid-media-type-examples rule.

When removing the example from responses the linter stop complaining.