False positive for oas3-unused-component rule

[crodriguezleon]

Summary

Vacuum detects components as unused when they are only referenced from a component that inherits from another component using the allOf keyword.

Example

components:
  schemas:
    Dog:
      type: object
      allOf:
        - $ref: '#/components/schemas/Pet'
      required:
        - breed
      properties:
        breed:
          $ref: '#/components/schemas/Breed'
    Pet:
      type: object
      properties:
       id: 
        type: String
        description: Unique identifier of the Pet
      age:
        type: integer
        format: int64
   Breed:
      type: object
      properties:
        name:
         type: String
       category:
        type: String

Expected result

Breed should not be detected as unused by oas3-unused-component rule because it's being referenced from Dog.

Actual result

Vacuum detects Breed as an unused component. If we remove the allOf section from the Dog definition, then Breed is not detected anymore as unused.

[daveshanley]

This has been resolved in v0.8.7

A test has been added to validate:

https://github.com/daveshanley/vacuum/blob/main/functions/openapi/unused_component_test.go#L303

[crodriguezleon]

Hello @daveshanley,

Just tested it and the issue keeps happening for me with v0.8.7.

I've attached a zip file with the specification I've used to test it and the report I get.

Example.zip

Thanks in advance!

[daveshanley]

OK this is strange. I will re-investigate for you.

[daveshanley]

This has been resolved in v0.9

The Example.zip now passes.