Update module github.com/deepmap/oapi-codegen to v2

[renovate]

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
github.com/deepmap/oapi-codegen	v1.16.2 -> v2.1.0

---

Release Notes

deepmap/oapi-codegen (github.com/deepmap/oapi-codegen)

v2.1.0: : Nullable, external reference improvements, x-order, and many more!

Compare Source

🔊 Notable features

Nullable types

It's possible that you want to be able to determine whether a field isn't sent, is sent as null or has a value.

For instance, if you had the following OpenAPI property:

S:
  type: object
  properties:
    Field:
      type: string
      nullable: true
    required: []

The current behaviour in oapi-codegen is to generate:

type S struct {
	Field *string `json:"field,omitempty"`
}

However, you lose the ability to understand the three cases, as there's no way to distinguish two of the types from each other:

• is this field not sent? (Can be checked with S.Field == nil)
• is this field null? (Can be checked with S.Field == nil)
• does this field have a value? (S.Field != nil && *S.Field == "123")

Therefore, as requested in #​1039, this is now possible to represent with the nullable.Nullable type from our new library, oapi-codegen/nullable.

If you configure your generator's Output Options as so:

output-options:
  nullable-type: true

You will now receive the following output:

type S struct {
    Field nullable.Nullable[string] `json:"field,omitempty"`
}

Note that this is opt-in only, due to it being a break in existing signatures and behaviour.

You can find out more about how this works in a blog post with further details.

External references are now handled better

A big change has come in which handling of external references (also called import mappings) is much more resilient and predictable for generated code.

This allows cases where multiple files referencing each other (for instance if you've split your API across multiple files, and join them using $refs) now correctly generate code.

There are a few cases that won't be covered, that we'll complete in https://github.com/deepmap/oapi-codegen/issues/1440 but until then, it hopefully should work better.

Thank you to Ejendomstorvet for sponsoring this work.

🚀 New features and improvements

• Add support for x-order extension (#​1190) @​filintod
• Make arrays use concrete types, not aliases. (#​1246) @​jkj
• feat: filter by operation ids (#​929) @​johanneswuerbach
• Allow generating nullable.Nullable for nullable properties (#​1404) @​sonasingh46
• Support media type parameters for IsMediaTypeJson (#​1386) @​jamietanna
• Pass .Required to BindStyledParameterWithLocation and BindStyledParameter (#​1315) @​renom

🐛 Bug fixes

• Fix: Ensure external refs are propagated to generated code (#​1389) @​jamietanna
• Fix: Refer to external refs correctly in strict interfaces (#​1387) @​jamietanna
• refactor(cmd): Use os.Exit(1) only from main() (#​1398) @​alexandear
• Fix binding for JSON body (#​1299) @​ShouheiNishi
• Fix: Handle code generation for all multipart content-types (#​1385) @​ShouheiNishi
• Pass .Required to BindStyledParameterWithLocation and BindStyledParameter (#​1315) @​renom

📝 Documentation updates

• Fixes confusing indentation for example code in README.md (#​1414) @​mtskg
• Document how to use import-mapping with URLs (#​1428) @​jamietanna
• Fix typo in README.md (#​1351) @​eltociear

👻 Maintenance

• Fix typos in flag, tests, doc, and comments (#​1287) @​alexandear
• add unit tests for go type gen function (#​1423) @​sonasingh46
• Use non-deprecated function names for oapi-codegen/runtime (#​1359) @​cimitan
• Onboard to Release Drafter (#​1350) @​jamietanna

📦 Dependency updates

• Update module github.com/golangci/golangci-lint to v1.55.2 (#​1285) @​renovate
• feat: bump github.com/getkin/kin-openapi to v0.122.0 (#​1364) @​chrisgacsal
• Update module golang.org/x/text to v0.14.0 (#​1349) @​renovate

New Contributors

• @​renom made their first contribution in https://github.com/deepmap/oapi-codegen/pull/1315
• @​eltociear made their first contribution in https://github.com/deepmap/oapi-codegen/pull/1351
• @​chrisgacsal made their first contribution in https://github.com/deepmap/oapi-codegen/pull/1364
• @​cimitan made their first contribution in https://github.com/deepmap/oapi-codegen/pull/1359
• @​sonasingh46 made their first contribution in https://github.com/deepmap/oapi-codegen/pull/1423
• @​mtskg made their first contribution in https://github.com/deepmap/oapi-codegen/pull/1414
• @​jkj made their first contribution in https://github.com/deepmap/oapi-codegen/pull/1246
• @​filintod made their first contribution in https://github.com/deepmap/oapi-codegen/pull/1190

v2.0.0: : Remove deprecated packages

Compare Source

As announced in oapi-codegen v2 is coming, this is a release to perform some cleanup, drastically reducing the dependency graph for users of the library, and migrating to multi-repo middleware and utility packages that can evolve separately to the code generator itself.

There's more details in https://www.jvt.me/posts/2023/10/23/oapi-codegen-v2-decrease/ in the exact benefits ??, but the key metrics you will be interested in seeing are:

	Before (v1.13.0)	After (v2.0.0)
Vendored dependency size (MB)	40	6
Direct dependencies	15	6
Indirect dependencies	95	34

Key changes

Full Changelog: oapi-codegen/oapi-codegen@v1.16.2...v2.0.0

As a consumer, for the most part you shouldn't have much to do, as if you've been using oapi-codegen v1.15.0 or later, you should be using the new packages.

If you use this as a library or execute it as part of go run you will need to update module import paths:

-//go:generate go run github.com/deepmap/oapi-codegen/cmd/oapi-codegen --config=config.yaml spec.yaml
+//go:generate go run github.com/deepmap/oapi-codegen/v2/cmd/oapi-codegen --config=config.yaml spec.yaml

If you're installing the package via go install, you'll need to run the following instead:

-go install github.com/deepmap/oapi-codegen/cmd/oapi-codegen@latest
+go install github.com/deepmap/oapi-codegen/v2/cmd/oapi-codegen@latest

Move pkg/testutil to its own package + remove it

Similar to the below changes, we've moved pkg/testutil to its own package, and removed it from the codebase.

The changes for you as a consumer can be seen here.

This is almost a drop in replacement, the key difference is that there is no longer a RequestBuilder.Go method, as it is replaced by the RequestBuilder.GoWithHTTPHandler.

Remove deprecated packages:

For the packages:

• pkg/chi-middleware
• pkg/fiber-middleware
• pkg/gin-middleware
• pkg/middleware
• pkg/runtime
• pkg/types

These have been deprecated because they are now hosted as individual modules at https://github.com/oapi-codegen/. Doing so allows for their dependencies to be separated from each other, so your transitive module dependencies decrease. Any code which you generate using v1.15.0 will already refer to these modules in their new location.

---

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.

---

• If you want to rebase/retry this PR, check this box

---

This PR has been generated by Mend Renovate. View repository job log here.

[renovate]

Renovate Ignore Notification

Because you closed this PR without merging, Renovate will ignore this update. You will not get PRs for any future 2.x releases. But if you manually upgrade to 2.x then Renovate will re-enable minor and patch updates automatically.

If you accidentally closed this PR, or if you changed your mind: rename this PR to get a fresh replacement PR.