Fix bullet point line prefer-skip-optional-pointer-with-omitzero typo in README.md#2028
Fix bullet point line prefer-skip-optional-pointer-with-omitzero typo in README.md#2028jamietanna merged 2 commits intooapi-codegen:mainfrom magnetikonline:readme-fix-global-optional-pointer
prefer-skip-optional-pointer-with-omitzero typo in README.md#2028Conversation
…o - reference back to `prefer-skip-optional-pointer`
Kusari Analysis ResultsAnalysis for commit: 90507a8, performed at: 2025-07-16T06:57:16Z • • Recommendation✅ PROCEED with this Pull Request Summary✅ No Flagged Issues Detected All values appear to be within acceptable risk parameters. No pinned version dependency changes, code issues or exposed secrets detected! Found this helpful? Give it a 👍 or 👎 reaction! |
| - `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 an `omitempty` JSON tag | ||
| - `prefer-skip-optional-pointer-with-omitzero`: when used in conjunction with `prefer-skip-optional-pointer-with-omitzero`, any optional fields are generated with an `omitzero` JSON tag. **Requires Go 1.24+** | ||
| - `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 an `omitempty` JSON tag. | ||
| - `prefer-skip-optional-pointer-with-omitzero`: when used in conjunction with `prefer-skip-optional-pointer`, any optional fields are generated with an `omitzero` JSON tag. **Requires Go 1.24+** |
There was a problem hiding this comment.
s/prefer-skip-optional-pointer-with-omitzero/prefer-skip-optional-pointer/.
|
Kusari PR Analysis rerun based on - 90507a8 performed at: 2025-07-16T06:57:16Z - link to updated analysis |
|
I've also amended the release notes 👍🏼 |
Yep, https://github.com/oapi-codegen/oapi-codegen/releases/tag/v2.5.0 looks solid now 👍 |
2 participants
Just noted a small typo in the root
README.md, the line outlining the use of theprefer-skip-optional-pointer-with-omitzerorefers to itself, not the option ofprefer-skip-optional-pointerabove it.Actually noted this in the https://github.com/oapi-codegen/oapi-codegen/releases/tag/v2.5.0 release notes (which also needs fixing) - so assume this was cut and pasted from the
README.md-> into the release notes.