Update module github.com/deepmap/oapi-codegen/v2 to v2.5.0 #221
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![renovate[bot]](https://avatars.githubusercontent.com/in/2740?s=80&v=4){kind=small}
renovate
bot
force-pushed
the
renovate/github.com-deepmap-oapi-codegen-v2-2.x
branch
from
27cff81 to
a770119
Compare
renovate
bot
changed the title
|
renovate
bot
force-pushed
the
renovate/github.com-deepmap-oapi-codegen-v2-2.x
branch
from
a770119 to
a23334d
Compare
renovate
bot
changed the title
renovate
bot
force-pushed
the
renovate/github.com-deepmap-oapi-codegen-v2-2.x
branch
from
a23334d to
f61182a
Compare
renovate
bot
changed the title
renovate
bot
force-pushed
the
renovate/github.com-deepmap-oapi-codegen-v2-2.x
branch
from
f61182a to
0c3ebe0
Compare
renovate
bot
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.1.0->v2.5.0Release Notes
deepmap/oapi-codegen (github.com/deepmap/oapi-codegen/v2)
v2.5.0: : No more optional pointers (optionally),omitzero, better control over initialisms, and so much more!Compare Source
v2.5.0: No more optional pointers (optionally)!
🎉 Notable changes
Begone optional pointers! (optionally)
One of the key things
oapi-codegendoes is to use an "optional pointer", following idiomatic Go practices, to indicate that a field/type is optional.This can be tuned on a per-field basis, using the
x-go-type-skip-optional-pointerextension, but it can be a bit repetitive, or can be more complex when using an OpenAPI Overlay.As of
oapi-codegenv2.5.0, this can be tuned in two specific ways, via the following Output Options:prefer-skip-optional-pointer: a global default that you do not want the "optional pointer" generated. Optional fields will not have an "optional pointer", and will have anomitemptyJSON tagprefer-skip-optional-pointer-with-omitzero: when used in conjunction withprefer-skip-optional-pointer, any optional fields are generated with anomitzeroJSON tag. Requires Go 1.24+In both cases, there is control on a per-field level to set
x-go-type-skip-optional-pointer: falseorx-omitzero: falseto undo these to field(s).See Globally skipping the "optional pointer" for more details.
Generating
omitzeroJSON tags, withx-omitzeroRelated to the above functionality, it is possible to define the OpenAPI extension
x-omitzeroon fields to generate theomitzeroJSON tag, based on the (now not-so-new) Go 1.24 release.Thanks to @lzap for the contribution 🚀
Using OpenAPI 3.1 with
oapi-codegenThere's some promising behind-the-scenes discussions with may lead to OpenAPI 3.1 support (#373) coming in the not-too-distant future 👀
In the meantime, Jamie (one of the Core Maintainers) has written a blog post about how to use
oapi-codegenwith OpenAPI 3.1 specs (by downgrading them to OpenAPI 3.0).Defining your own initialisms
As a means to define your own custom initialisms, it's possible to use the
additional-initialismsOutput Option.Thanks @micaelmalta for the contribution 🚀
If your organisation uses a lot of TLAs (Two Letter Acronyms or Three Letter Acronyms) or any other sorts of initialisms, it's handy to be able to configure these yourself.
For instance, if you regularly use the term CSP to refer to Cloud Service Provider, you may want
CSPto be used in variable names.This makes it possible to define i.e.
Minimum version of Go needed for oapi-codegen is now 1.22.5
As part of a couple of updates in #1888 and #1986, we're now requiring Go >= 1.22.5.
Similar to the bump to Go 1.21 in v2.4.0
Notable background work
Since the last
oapi-codegenrelease (all the way in September 2024 🥲) the following big changes towards the project and its ecosystem have been:net/httpmiddleware v1.1.0: Better error handling, allow not validatingServers(by configuration) and return an HTTP 405 Method Not Allowed where appropriateruntime: fixes formaps andx-go-type-skip-optional-pointer🚀 New features and improvements
Bytes()toClientWithResponsesresponses (#1780) @grongorprefer-skip-optional-pointer-on-container-types(#1979) @jamietannaprefer-skip-optional-pointerto default to skipping optional pointers (#1694) @aksdbyaml-tagsoption (#1798) @deitchadditional-initialisms(#1733) @micaelmalta🐛 Bug fixes
operationId(#1945) @jamietannaprefer-skip-optional-pointerin reference types + add tests forpreferskipoptionalpointer(#2021) @jamietanna📝 Documentation updates
Responsemodels (#2025) @jamietanna<details>blocks in<table>(#2019) @jamietannax-enumNames(#2000) @jamietannanethttp-middlewarefor other purposes (#1951) @jamietannago toolfor Go 1.24+ (#1908) @jamietannatools.go(#1788) @jamietanna👻 Maintenance
mainbranch please" (#1847) @jamietannaprefer-skip-optional-pointerin reference types + add tests forpreferskipoptionalpointer(#2021) @jamietanna📦 Dependency updates
13 changes
d35c59a(#1969) @renovate[bot]Sponsors
We would like to thank our sponsors for their support during this release.
New contributors
We had 16 new contributors in this release, thanks folks 🚀
v2.4.1: : A couple of post-release fixesCompare Source
🐛 Bug fixes
📝 Documentation updates
👻 Maintenance
godirective (#1784) @jamietannaSponsors
We would like to thank our sponsors for their support during this release.
v2.4.0: : OpenAPI Overlay, improvedimport-mappingfunctionality, 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-codegenv2.4.0, users wishing to override specific configuration, for instance taking advantage of extensions such asx-go-typewould 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-codegenv2.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-codegenv2.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/plainChanges in oapi-codegen#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-codegenis 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-codegenwith 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
mainbefore these status checks will pass.🚀 New features and improvements
import-mappingto the current package (#1774) @jamietanna @djgilcreaseMuxinterface instead of*http.ServeMux(#1720) @sonalys<and>in property or type names (#1740) @ansonix-oapi-codegen-only-honour-go-name(#1697) @jamietanna🐛 Bug fixes
anyOfs (#1178) @daleef-rahmancookievariables in block scope (#1687) @andremarianiellox-orderfrom next to$ref, if present (#1700) @paulmach📝 Documentation updates
deepmap/oapi-codegenreferences (#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.
v2.3.0: Updates related to repository moveCompare Source
With this version,
oapi-codegenconsolidates all code undergithub.com/oapi-codegen. When you install the core tool, please use this new location,github.com/oapi-codegen/oapi-codegen/v2starting with versionv2.3.0, but continue to usegithub.com/deepmap/oapi-codegen/v2with any earlier release.This release contains changes to import paths, go.mod and the README.
What's Changed
Full Changelog: oapi-codegen/oapi-codegen@v2.2.0...v2.3.0
v2.2.0: : Pure-Go 1.22+ server, documentation overhaul. JSON schema and several bug fixesCompare Source
Big announcements
In case you've missed it, we've got a few big announcements as maintainers of
oapi-codegenwhich we'd recommend you read in more depth.oapi-codegenis moving to its own orgoapi-codegenin the futureWe'd also like to thank our sponsors for this release:
🔊 Notable features
The v2.2.0 release was largely focussed on the following big changes, alongside a number of other bug fixes.
Generate a pure Go 1.22+
net/httpserverWith Go 1.22+'s enhanced routing, it's now easier than ever to be able to write a pure-Go HTTP service, and thanks to a contribution from @thedadams we now have a
std-http-server, further documented in the Supported Servers section in the README.Documentation overhaul
A significant undertaking in this release was to rewrite pretty much every line of documentation we had, as well as introducing a number of additional examples and test cases.
We're excited to hear your feedback on the new structure of the README, the additional docs added, and whether there are any additional examples that may be of use.
JSON Schema configuration
In the spirit of documentation, we now also have a JSON schema which can be found further documented in the Usage section in the README.
This not only gives a separate definition of fields and their meaning, but it can be used with IDEs for autocompletion and validation, allowing for a much better Developer Experience.
kin-openapi upgrade
A few big upgrades have come in kin-openapi, which we use for the underlying OpenAPI parsing and validation, which included a significant breaking change that meant that consumers of
oapi-codegencouldn't upgrade the kin-openapi version until we had made changes inoapi-codegen.This has additionally been set up as an FAQ as it's one we commonly get.
🚀 New features and improvements
🐛 Bug fixes
nullable(#1585) @jamietanna📝 Documentation updates
echoserver (#1627) @jamietannax-go-type-namedocs (#1616) @jamietannastd-http-serverexample (#1576) @sajjanjyothimainbranch (#1493) @dharsanb👻 Maintenance
mergeOpenapiSchemas(#1424) @Juneezeegolang.org/x/lint(#1588) @jamietannaadditionalPropertiesbug (#1528) @jamietanna📦 Dependency updates
16 changes
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.