Skip to content

Add OpenAPI v3.1 importer #522

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.

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

Merged
merged 1 commit into from
Jun 20, 2025
Merged

Add OpenAPI v3.1 importer #522

merged 1 commit into from
Jun 20, 2025

Conversation

LucasPickering
Copy link
Owner

@LucasPickering LucasPickering commented Jun 18, 2025

Description

Describe the change. If there is an associated issue, please include the issue link (e.g. "Closes #xxx"). For UI changes, please also include screenshots.

Add support for OpenAPI 3.1 collections, which are not compatible with OpenAPI 3.0. This pulls in a new library oas3 because openapiv3 only supports 3.0. The openapi format for slumber import will check the version of the given OpenAPI file so we didn't have to add a new target for this.

Closes #513

Known Risks

What issues could potentially go wrong with this change? Is it a breaking change? What have you done to mitigate any potential risks?

  • This certainly has bugs. There's some edge cases where I cut corners, ambiguity in the OpenAPI library's types, and inherent incompatibilities between OpenAPI and Slumber. I did my best and we'll have to patch bugs as they're reported
  • This can't be merged until this oas3 PR is merged

QA

How did you test this?

New integration test

Checklist

  • Have you read CONTRIBUTING.md already?
  • Did you update CHANGELOG.md?
    • Only user-facing changes belong in the changelog. Internal changes such as refactors should only be included if they'll impact users, e.g. via performance improvement.
  • Did you remove all TODOs?
    • If there are unresolved issues, please open a follow-on issue and link to it in a comment so future work can be tracked

@LucasPickering LucasPickering force-pushed the openapi-3.1 branch 2 times, most recently from 63a2242 to 172ac0e Compare June 18, 2025 15:37
@LucasPickering LucasPickering force-pushed the openapi-3.1 branch 2 times, most recently from 86e8037 to 0678695 Compare June 18, 2025 15:44
@LucasPickering LucasPickering enabled auto-merge (rebase) June 20, 2025 16:23
@LucasPickering LucasPickering merged commit 694c8db into master Jun 20, 2025
22 of 23 checks passed
@LucasPickering LucasPickering deleted the openapi-3.1 branch June 20, 2025 16:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support OpenAPI 3.1.x imports
1 participant