Fix document filtering to handle references with description or summary fields

[egrank]

Motivation

If OpenAPI document filtering is enabled for operations containing references with description or summary fields, Swift OpenAPI Generator fails with an error as such references cannot be resolved.

For example, this reference can be resolved:

  schema:
    $ref: '#/components/schemas/Item'

but not this one:


  schema:
    $ref: '#/components/schemas/Item'
    description: "Item with description"

The cause of the described issue is in the FilteredDocumentBuilder code. The required components are registered there, including optional description and summary properties, while the reference matching for filtering is done against references created only with component keys, so equality check fails if description or summary are present.

Modifications

Registering and matching only component keys instead of whole references.

Result

After this change, there are no more limitations on having description and summary fields for references in filtered operations.

Test Plan

Extended unit tests with test cases to cover the described issues:

• Added /things/c path that exercises references with descriptions across:
  • Path-level and operation-level parameters with description fields
  • Response references with descriptions
  • Headers with schema references containing descriptions
  • Examples with descriptions
• Updated the test assertion helper to verify headers and examples are correctly filtered

The added tests fail without the fix.

[czechboy0]

This is great, thank you @egrank! 🙏