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 docusaurus-plugin-openapi-docs from 2.0.4 to 4.2.0 #4665

Conversation

dependabot[bot]
Copy link
Contributor

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

Bumps docusaurus-plugin-openapi-docs from 2.0.4 to 4.2.0.

Release notes

Sourced from docusaurus-plugin-openapi-docs's releases.

v4.2.0

What's Changed

New Contributors

Full Changelog: PaloAltoNetworks/docusaurus-openapi-docs@v4.1.0...v4.2.0

v4.1.0

What's Changed

New Contributors

Full Changelog: PaloAltoNetworks/docusaurus-openapi-docs@v4.0.1...v4.1.0

v4.0.1

... (truncated)

Changelog

Sourced from docusaurus-plugin-openapi-docs's changelog.

4.2.0 (Nov 1, 2024)

High level enhancements

  • Massive refactor of plugin and theme that dramatically optimizes and reduces generated MDX.
  • Added sample JSON code snippet component to schema pages.
  • Improvements to how allOf, additonalProperties and discriminators are processed/handled.

Other enhancements and bug fixes

Features/Enhancements

  • discriminators
    • Improve handling of discriminators (#1009)
  • schema
    • Migrate schema page to Schema component and refactor layout (#1001)
    • Refactor to use new theme components
    • Add new RequestSchema and Schema components
  • additional properties
    • Add additionalProperties examples to tests
    • Support object as primitive additional properties
    • Improve Items support for allOf and primitives
  • allOf handling
    • Refactor items allOf to new pattern/library
    • Extend allOf tests
    • Migrate to allof-merge library to improve merging
    • Improve handling of top-level primitives
    • Improve support for allOf
    • Avoid returning on first schema match and improve support for AnyOneOf
  • UI/UX improvements
    • Implement skeleton loader component
    • Try lazy loading on all
    • Implement lazy loading without BrowserOnly
    • Render loading spinner instead of text
    • Add language tabs back
    • Add default logo for http and shell
    • Add margin top to enum descriptions
    • Change label from generated to auto
    • Add Summary component, cleanup PropertyDiscriminator and SchemaNodeDetails
    • Rename Edge to SchemaEdge and fix props and types
    • Rename SchemaComponent to SchemaNode
    • Cleanup Properties and add missing props
    • Port x-enumDescription fix from #981
    • Add additional schema support to edge
    • Support single mime type schemas
    • Make props optional
    • Add DetailsNode component and markdown rendering for description and qualifier
    • Add StatusCodes component
    • Use ExecutionEnvironment to avoid SSR
    • Render ParamsDetails client-side

... (truncated)

Commits
  • e7295a8 Prepare release v4.2.0 (#1010)
  • 320fc1c Migrate schema page to Schema component and refactor layout (#1001)
  • ef8b1d9 refactor items allof to new pattern/library
  • ae8639b Merge branch 'main' into params-details
  • 6557a3d [Fix] all of items in array for api response
  • fb837ea fix linter errors
  • 6db4252 update test snapshot
  • 5d0684d fix create allof request/response samples
  • f10ceb8 migrate to allof-merge library to improve merging
  • e5973ef cleanup api doc template imports
  • Additional commits viewable in compare view

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)

@dependabot dependabot bot added the dependencies Pull requests that update a dependency file label Nov 26, 2024
@pepopowitz pepopowitz added deploy Stand up a temporary docs site with this PR and removed deploy Stand up a temporary docs site with this PR labels Nov 26, 2024
@github-actions github-actions bot temporarily deployed to camunda-docs November 26, 2024 17:49 Destroyed
Copy link
Contributor

The preview environment relating to the commit 7bb2811 has successfully been deployed. You can access it at https://preview.docs.camunda.cloud/pr-4665/index.html

@pepopowitz
Copy link
Collaborator

This update won't work until we get some other things in place first.

  1. It requires a parallel update of the docusaurus-theme-openapi-docs package (which isn't a big deal)
  2. It requires an update to docusaurus 3
  3. It spits out a lot of unmet peer dependency errors for react 18, which will likely be resolved when we update to docusaurus 3
  4. It spits out a lot of unsupported engine errors for node 16, which will be resolved by chore: update node to v22 #4667.

The bottleneck is docusaurus 3, so I'll continue to work toward that.

cc @akeller

@pepopowitz pepopowitz closed this Nov 26, 2024
Copy link
Contributor Author

dependabot bot commented on behalf of github Nov 26, 2024

OK, I won't notify you again about this release, but will get in touch when a new version is available. If you'd rather skip all updates until the next major or minor version, let me know by commenting @dependabot ignore this major version or @dependabot ignore this minor version. You can also ignore all major, minor, or patch releases for a dependency by adding an ignore condition with the desired update_types to your config file.

If you change your mind, just re-open this PR and I'll resolve any conflicts on it.

@dependabot dependabot bot deleted the dependabot/npm_and_yarn/docusaurus-plugin-openapi-docs-4.2.0 branch November 26, 2024 19:40
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.

1 participant