Skip to content

feat(rulesets): improve OAS 3.1 external references validation #2844

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

feat(rulesets): improve OAS 3.1 external references validation #2844

wants to merge 1 commit into from
+71 −2

Conversation

fluz
Copy link

@fluz fluz commented Aug 20, 2025

Fix schema validation error where path items were incorrectly flagged as having unevaluated properties. Changed paths pattern properties to use path-item-or-reference instead of path-item to support external references in OpenAPI 3.1 specifications properly.

Fixes the issue where documents like:

paths:
  /greetings:
    $ref: 'greetings.yaml'

Would generate: "~1greetings" property must not have unevaluated properties.

  • Update OAS 3.1 schema to use path-item-or-reference for paths
  • Add external references test scenario in test-harness
  • Update Arazzo schema validators to use improved OAS 3.1 schema
  • Enhance OAS 3 schema test coverage

Fixes #2655

Checklist

  • Tests added
  • Docs added

Does this PR introduce a breaking change?

  • Yes
  • No

@fluz fluz marked this pull request as ready for review August 20, 2025 15:13
@fluz fluz requested a review from a team as a code owner August 20, 2025 15:13
@fluz fluz marked this pull request as draft August 20, 2025 15:13
@fluz
feat(rulesets): improve OAS 3.1 external references validation
fde1451 
- Update OAS 3.1 schema to better support external references
- Add external references test scenario in test-harness
- Update Arazzo schema validators to use improved OAS 3.1 schema
- Enhance OAS 3 schema test coverage

Fixes issues with external reference validation in OpenAPI 3.1 documents.
@fluz fluz force-pushed the fix/oas31-external-ref-validation branch from a7c06e7 to fde1451 Compare August 20, 2025 15:23
@fluz fluz marked this pull request as ready for review August 20, 2025 15:27
This was referenced Aug 20, 2025
Closed
Open
@fluz
Copy link
Author

fluz commented Sep 8, 2025

Hi someone can review my proposal.

TIA

@fluz
Copy link
Author

fluz commented Sep 22, 2025

Hi Pals,

just a kindly reminder to not forget my PR 🙏🏾 :-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

spectral-rulesets 1.19.0 breaks path $ref behavior
1 participant
@fluz