Skip to content
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.

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

chore(deps): bump zod-openapi from 2.18.0 to 4.1.0 #113

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Nov 25, 2024

Bumps zod-openapi from 2.18.0 to 4.1.0.

Release notes

Sourced from zod-openapi's releases.

v4.1.0

What's Changed

New Features 🎉

New Contributors

Full Changelog: samchungy/zod-openapi@v4.0.0...v4.1.0

v4.0.0

What's Changed

Breaking Changes 🛠

  • .openapi() Breaking Change by @​samchungy in samchungy/zod-openapi#356

    .openapi() behaves a little differently now. It will now preserve previous openapi state except for ref and use it. This means that any metadata set on previous schema will now also be carried over to the next schema. Whilst I don't suspect this will impact too many users, it is still a breaking change nonetheless. Libraries which declare zod-openapi as a peer dependency, can safely set this version as a non breaking change for their library.

    const FooSchema = z
      .string()
      .transform((str => str.trim()))
      .openapi({ effectType: 'same', example: 'foo' });
    // in this version, this BarSchema now has effectType: same and example: 'foo' too
    const BarSchema = FooSchema.openapi({ description: "bar" });

    Why do we need this change?

    1. Unintuitive Extension

      const FooSchema = z.string().openapi({ ref: 'string' });
      const BarSchema = z.object({
      a: FooSchema,
      b: FooSchema.openapi({ description: 'foo' }),
      });
      createSchema(BarSchema)

      This previous generated the following:

      {

... (truncated)

Commits

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Bumps [zod-openapi](https://github.com/samchungy/zod-openapi) from 2.18.0 to 4.1.0.
- [Release notes](https://github.com/samchungy/zod-openapi/releases)
- [Commits](samchungy/zod-openapi@v2.18.0...v4.1.0)

---
updated-dependencies:
- dependency-name: zod-openapi
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot added the dependencies Pull requests that update a dependency file label Nov 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants