Skip to content

docs: add example for how to downgrade OpenAPI 3.1 to 3.0 #1966

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

Merged
jamietanna merged 3 commits into from
May 4, 2025
Merged

docs: add example for how to downgrade OpenAPI 3.1 to 3.0 #1966

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
54e1138
docs: be explicit about OpenAPI 3.1 support
jamietanna May 4, 2025
79f9fee
docs: add clarification title for Overlay
jamietanna May 4, 2025
a0a64fe
docs: add example for how to downgrade OpenAPI 3.1 to 3.0
jamietanna May 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2037,7 +2037,7 @@ If you don't want to do this, an alternate option is to [use a single package, w

Check out [the import-mapping/multiplepackages example](examples/import-mapping/multiplepackages/) for the full code.

## Modifying the input OpenAPI Specification
## Modifying the input OpenAPI Specification (with OpenAPI Overlay)

Prior to `oapi-codegen` v2.4.0, users wishing to override specific configuration, for instance taking advantage of extensions such as `x-go-type` would need to modify the OpenAPI specification they are using.

Expand Down Expand Up @@ -3851,6 +3851,14 @@ Got one to add? Please raise a PR!

## Frequently Asked Questions (FAQs)

### Does `oapi-codegen` support OpenAPI 3.1?

No, we don't currently.

OpenAPI 3.1 support is [awaiting upstream support](https://github.com/oapi-codegen/oapi-codegen/issues/373).

In the meantime, you could follow [steps from this blog post](https://www.jvt.me/posts/2025/05/04/oapi-codegen-trick-openapi-3-1/) to [use OpenAPI Overlay](#modifying-the-input-openapi-specification-with-openapi-overlay) to "downgrade" the OpenAPI 3.1 spec to OpenAPI 3.0.

### How does `oapi-codegen` handle `anyOf`, `allOf` and `oneOf`?

`oapi-codegen` supports `anyOf`, `allOf` and `oneOf` for generated code.
Expand Down