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.

OAS3 Resolving external schema containing allOf with $ref

See original GitHub issue

When resolving a $ref to an external schema containing a $ref withing an allOf that internal $ref is not resolved.

The file to resolve:

openapi: 3.0.0
info:
  version: 0.0.0
  title: oneOf and anyOf

paths:
  /oneOf:
    get:
      responses:
        '200':
          description: One of Cat or Dog
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: 'http://timotej.se/smartbear/pets.yaml#/components/schemas/Cat'
                  - $ref: 'http://timotej.se/smartbear/pets.yaml#/components/schemas/Dog'
  /anyOf:
    get:
      responses:
        '200':
          description: Any of Cat or Dog
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: 'http://timotej.se/smartbear/pets.yaml#/components/schemas/Cat'
                  - $ref: 'http://timotej.se/smartbear/pets.yaml#/components/schemas/Dog'

Content of the external file:

openapi: 3.0.0
info:
  version: 0.0.0
  title: apa

components:
  schemas:
    Pet:
      required:
        - name
        - petType
      properties:
        name:
          type: string
        petType:
          type: string
    Cat:
      allOf:
        - $ref: '#/components/schemas/Pet'
        - type: object
          properties:
            huntingSkill:
              type: string
              default: lazy
              enum:
                - lazy
                - aggressive
          required:
            - huntingSkill
    Dog:
      allOf:
        - $ref: '#/components/schemas/Pet'
        - type: object
          properties:
            packSize:
              description: The size of the pack the dog is from
              type: integer
          required:
            - packSize

Resolve using this code:

ParseOptions options = new ParseOptions();
options.setResolve(true);
OpenAPI openAPI = new OpenAPIV3Parser().readContents(yaml, null, options).getOpenAPI();
Yaml.pretty().writeValue(System.out, openAPI);

I would expect the output schema to contain Pet, Cat and Dog (since Pet is $ref:d from Cat and Dog). The actual value is only Cat and Dog. The $ref to Pet is now broken.

I have tested this with the currently latest version of 2.0 branch (1292a4e1a77fd4fdc3c4b1dfe29b3d15ac88fa7b)