Update module github.com/oapi-codegen/oapi-codegen/v2 to v2.4.1 #21
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
v2.3.0
->v2.4.1
Release Notes
oapi-codegen/oapi-codegen (github.com/oapi-codegen/oapi-codegen/v2)
v2.4.1
: : A couple of post-release fixesCompare Source
🐛 Bug fixes
📝 Documentation updates
👻 Maintenance
go
directive (#1784) @jamietannaSponsors
We would like to thank our sponsors for their support during this release.
v2.4.0
: : OpenAPI Overlay, improvedimport-mapping
functionality, and a whole host of other great things 🚀Compare Source
🎉 Notable changes
Modifying the input OpenAPI Specification, without needing to modify it directly
Prior to
oapi-codegen
v2.4.0, users wishing to override specific configuration, for instance taking advantage of extensions such asx-go-type
would need to modify the OpenAPI specification they are using.In a lot of cases, this OpenAPI specification would be produced by a different team to the consumers (or even a different company) and so asking them to make changes like this were unreasonable.
This would lead to the API consumers needing to vendor the specification from the producer (which is our recommendation anyway) and then make any number of local changes to the specification to make it generate code that looks reasonable.
However, in the case that a consumer would update their specification, they would likely end up with a number of merge conflicts.
Now, as of
oapi-codegen
v2.4.0, it is now possible to make changes to the input OpenAPI specification without needing to modify it directly.This takes advantage of the OpenAPI Overlay specification, which is a stable specification.
We're very excited for y'all to be able to take advantage of this, and to be able to manipulate complex specifications you don't have control over.
Using a single package, with multiple OpenAPI spec for a given package
Since
oapi-codegen
v2.4.0, it is now possible to split large OpenAPI specifications into the same Go package, using the "self" mapping (denoted by a-
) when using Import Mapping.This is an improvement on the previous model, which would require splitting files across multiple packages.
This should improve the ability to use a multi-file OpenAPI specification.
Reverting a breaking change to Strict servers using
text/plain
Changes in https://github.com/oapi-codegen/oapi-codegen/pull/1132 had unintended side effects, and so we have reverted this.
This will be a breaking change to anyone who had pulled in this change, since it landed in v1.13.1.
Minimum version of Go needed for
oapi-codegen
is now 1.21Does what it says on the tin.
This was required for a new dependency, and given Go 1.21 is now End-of-Life, this isn't too bad a requirement, without requiring folks unnecessarily bump their minimum supported version higher.
Starting work towards the OpenSSF Best Practices badge
As a means to better understand the compliance of
oapi-codegen
with OpenSSF's Best Practices guide, we've started work towards the "passing" badge.This gives us some insight into where we have gaps, and makes it known for our users, too.
PR Builds now have required status checks
Previously, PR builds did not have a required status check.
Although as maintainers we would only merge changes after the CI checks had passed, this now gives us - and you as our users - greater confidence in the stability of the project.
Previously raised PRs - before 2024-09-20 - will need to merge in the latest changes in
main
before these status checks will pass.🚀 New features and improvements
import-mapping
to the current package (#1774) @jamietanna @djgilcreaseMux
interface instead of*http.ServeMux
(#1720) @sonalys<
and>
in property or type names (#1740) @ansonix-oapi-codegen-only-honour-go-name
(#1697) @jamietanna🐛 Bug fixes
anyOf
s (#1178) @daleef-rahmancookie
variables in block scope (#1687) @andremarianiellox-order
from next to$ref
, if present (#1700) @paulmach📝 Documentation updates
deepmap/oapi-codegen
references (#1771) @jamietannain: cookie
(#1770) @jamietannaFUNDING.yml
(#1661) @jamietanna👻 Maintenance
📦 Dependency updates
9 changes
Sponsors
We would like to thank our sponsors for their support during this release.
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.