chore(deps): update dependency docusaurus-plugin-openapi-docs to v4 #1311

renovate · 2024-11-29T15:51:29Z

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
docusaurus-plugin-openapi-docs (source)	`0.0.0-953` -> `4.2.0`

Warning

Some dependencies could not be looked up. Check the warning logs for more information.

Release Notes

PaloAltoNetworks/docusaurus-openapi-docs (docusaurus-plugin-openapi-docs)

`v4.2.0`

Compare Source

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
- Add response examples
- Add ResponseExamples component
- Import new ResponseSchema component
- Switch to new ResponseSchema component
- Add new ResponseSchema component
- Reduce params details to single component for all types
- Switch to docusaurus Details component
- Fix details summaries
- Add ParamsDetails to imports
- Refactor createParamsDetails to use component
- Add className to Props
- Add new ParamsDetails component

Bug Fixes

allOf items
- [Fix] All of items in array for API response (#995)
- Fix linter errors
- Update test snapshot
- Fix create allof request/response samples
empty language tabs
- Fix bug in CodeSnippets component (#988)
contact info
- Fix bug in createContactInfo.ts, protocol was set to mailto even though it was a URL (#992)
import names
- Fix import name

Refactoring

schema
- Refactor create schema tests to cypress (#997)
- Rename 'from schema' to 'generated' and cleanup examples
imports
- Remove unused imports
- Cleanup API doc template imports
- Update imports
- Remove unused imports
- Update imports
code cleanup
- Remove unused import
- Cleanup AdditionalProperties types and logic
- Cleanup PropertyDiscriminator and Markdown types
- Cleanup code comments
- Remove unnecessary div
- Revert CSR experiment
- Remove unnecessary div
- Remove code comment

Other

internal
- Migrate branch 'main' into params-details
- Update build-perf.yml
- Update build-perf.yml

`v4.1.0`

Compare Source

High level enhancements

Added support for rendering schema item example (#985)
Improved support for enum descriptions (#981 and #951)
Added support for sidebarGenerators (#963)
Added OpenAPI 3.1 webhooks support (#961)
Improved code snippets support(#945 and #984)

Other enhancements and bug fixes

Merge pull request #985 from PaloAltoNetworks/edge-allof
- Combined merged schema with original to ensure no properties are lost
- Add support for rendering example to SchemaItem
Merge pull request #984 from PaloAltoNetworks/fix-code-snippet-scroll
- Adjust offset for glow effect around active tab
- Avoid scrolling if first item in scroll area
- Use scrollLeft to avoid scrolling entire page to active code tab
Merge pull request #981 from tuanpt-0634/support-schema-enum-descriptions
- Support enum descriptions in schema object
Merge pull request #971 from robbieaverill/children-reactnode
- Restore fallback to empty string when children is falsy
- Revert string casting in plugin utils
- Revert changes to plugin guard() and render() methods, they will not accept ReactNode
- Children interface is now ReactNode, theme utility methods are deprecated in favour of plugin methods
Merge pull request #969 from tuanpt-0634/fix_button_show_optional_parameters
- Fix change type of Show optional parameters button
Merge pull request #963 from robbieaverill/feature/custom-doc-item-generator
- Move createDocItem() into a sidebarGenerators object
- Add line-through style to deprecated sidebar items
- Add support for custom sidebar DocItem generators supporting customisation
- Add markdownGenerators example and update docs
Merge pull request #961 from PaloAltoNetworks/webhooks
- Add example OpenAPI 3.1 petstore
- Add support for OpenAPI 3.1 webhooks
Merge pull request #960 from PaloAltoNetworks/deprecation-notice
- Fix deprecation notice
Merge pull request #958 from PaloAltoNetworks/default-values
- Ensure description comes before qualifier and default value
- Render default value after description
- Fix defaultValue and cleanup unused code
- Update packages
- Apply changes to ParamsItem
- Render default value as string literal instead of markdown
- Fix curl logoClass
Merge pull request #957 from PaloAltoNetworks/security-schemes
- Apply border radius to summary
Merge pull request #951 from omonk/ollie.monk/x-enumDescriptions
- Add missing security schemes component
- Enum => Enum Value
Merge pull request #954 from Olexandr88/patch-1
- Update README
Merge pull request #952 from PaloAltoNetworks/language-options
- Remove unused import
- Update languageTabs and styling docs
- Remove log
- Fix type
- Use x-enumDescriptions in UI
- Merge user-defined languageTabs options
Merge pull request #949 from PaloAltoNetworks/method-endpoint
- Import hooks from theme
Merge pull request #945 from PaloAltoNetworks/language-tabs
- Add fallback in case language not already in localStorage
- Auto scroll to default language
- Use first variant in variants array as default
- Define defaultValue for language and add code comments to improve clarity
- Convert python styles to CSS
- Expand supported languages in demo
- Demonstrate overriding language tab styles
- Add additional language tab styles
- Add function for generating languageSet
- Add missing languages
- Add advanced topics
- Add BrowserWindow component
- Update workflows
Merge pull request #939 from omonk/context-aware-method-endpoint-render
Merge pull request #944 from robbieaverill/fix-oneof-within-anyof
Merge pull request #943 from PaloAltoNetworks/dependabot/github_actions/dot-github/workflows/actions/download-artifact-4.1.7
- Add example of oneOf within anyOf to "Tests" in demo
- Fix bug where oneOf within anyOf would not be rendered in request schemas
- Bump actions/download-artifact from 3 to 4.1.7 in /.github/workflows
- Fix linting
- Fix linting
- Do not render serverUrl on callbacks MethodEndpoint component
Merge pull request #937 from PaloAltoNetworks/layout-paginator
- Conditionally set col width for API doc layout
Merge pull request #931 from IanVS/docusaurus-35-version
- Update dependencies for docusaurus 3.5+

`v4.0.1`

Compare Source

High level enhancements

Improved support for rendering discriminator properties

Other enhancements and bug fixes

Merge pull request #927 from PaloAltoNetworks/discriminator-no-mapping
add test cases for discriminator
add discriminator test spec
handle discriminators with no mapping as simply property
Add additional oneOf tests (#924)

`v4.0.0`

Compare Source

High level enhancements

Introduce support for Docusaurus 3.5.0+

Note that this breaks backward compatibility and users will need to update their Docusaurus installation to 3.5.0 or later to use this version of the plugin.

Other enhancements and bug fixes

Introduce support for Docusaurus 3.5.0+ (#919)

`v3.0.2`

Compare Source

High level enhancements

Various bug fixes and support for allOf, anyOf, oneOf.

Other enhancements and bug fixes

Ensure same-level properties and allOf are rendered (#904)
statically set generated date and date-time example value (#901)
Fix support for example summaries (#898)
Support anyOf/oneOf schema descriptions (#897)
Check if the outputDir exists before attempting to create the versions.json file (#892)
Add object primitive support to createAnyOneOf (#895)

`v3.0.1`

Compare Source

High level enhancements

Fixed regression bug

Other enhancements and bug fixes

Fall back to languageSet if no languageTabs provided (#871)

`v3.0.0`

Compare Source

First official v3 release!

Added support for Docusaurus v3.0.1 - v3.4.0 (and hopefully beyond)
Complete feature parity with v2.2.0 including bug fixes

Other enhancements and bug fixes

Support absolute or relative downloadUrl (#865)
fix typo in attribute (#864)
uncomment version dropdown styles (#863)
Support flexible code snippet ordering and options (#862)
migrate back to canonical postman deps (#860)
Support custom downloadUrl for versions (#859)
[V3] Fix tagGroup display when showSchemas is configured (#852)
check to avoid tagGroup config before concat operation, api, schemas (#853)
handle various additionalProperties cases (#803)
cleanup legacy ApiDemoPanel component
cleanup legacy docusaurus config
upgrade to docusaurus 3.4.0 (#850)
support empty object schema type (#849)
ensure readOnly/writeOnly are evaluated first (#848)
transparent bg color when showing placeholder (#847)
Bug/set accept (#846)
Implement the x-tags extension for schema objects (#837)
fix col row padding footer&pagination (#810)
Update index.tsx (#839)
fix: markdown table within the description attribute cannot be rendered correctly (#831)
upgrade demo to docusaurus 3.3.2 (#822)
add missing types and cast ref to LegacyRef (#818)
Add option to disable frontmatter api prop compression (#800)
preventing to send form onClick left/right arrows in SchemaTabs component (#796)
Ensure sidebars.ts and schemas are properly cleaned (#817)
changed theme and plugin to headings (#786)
Allow custom plugin to render (#784)
Remove scrollbar width for Tab components (#785)

High level enhancements

First v2.0.0 stable release!

Currently only compatible with Docusaurus v2.4.1 -> v2.4.3

Other enhancements and bug fixes

upgrade to react 18 and demo docusaurus to 2.4.3 (#656)
allow upgrade to react 18 (#651)
stop docusaurus support at v2.4.0 (#650)

`v1.7.3`

Compare Source

What's Changed

Add more debug info to resolveJsonRefs by @Cellaryllis in https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/560
[Bug] Add handler for oneOf properties, fix nested <li> and avoid duplicate properties in createAnyOneOf by @sserrata in https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/561
Add optional markdownGenerators config option by @jgarrow in https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/567
Prepare release v1.7.3 by @blindaa121 in https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/569

New Contributors

@Cellaryllis made their first contribution in https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/560
@jgarrow made their first contribution in https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/567

Full Changelog: PaloAltoNetworks/docusaurus-openapi-docs@v1.7.2...v1.7.3

`v1.7.2`

Compare Source

What's Changed

Upgrade dependencies by @sserrata in https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/551

Full Changelog: PaloAltoNetworks/docusaurus-openapi-docs@v1.7.1...v1.7.2

`v1.7.1`

Compare Source

What's Changed

[Enhancement] Add support for rendering vendor extensions by @sserrata in https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/527
Improve Algolia search for method endpoint paths by @blindaa121 in https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/541
Remove PWA plugin and assets to improve LLMO by @sserrata in https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/548
Prepare release v1.7.1 by @blindaa121 in https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/549

Full Changelog: PaloAltoNetworks/docusaurus-openapi-docs@v1.7.0...v1.7.1

`v1.7.0`

Compare Source

What's Changed

Add v2.0.0 branch to release workflows by @sserrata in https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/475
Relax if statement to allow v2.0.0 releases by @sserrata in https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/477
Add bold, svg filtering and ensure parity between opening/closing regex by @sserrata in https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/479
Split beta release into separate script/workflow by @sserrata in https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/480
Add canary support to v2 by @sserrata in https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/485
[bug] Checkout v2.0.0 instead of main by @sserrata in https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/486
[Bug] Set ignoreAdditionalProperties back to true by @sserrata in https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/493
Bump webpack from 5.75.0 to 5.76.0 by @dependabot in https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/498
[Enhancement] Add support for powershell by @sserrata in https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/507
[Bug] Fix double scrollbars by @sserrata in https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/504
Prepare release v1.7.0 by @sserrata in https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/512

Full Changelog: PaloAltoNetworks/docusaurus-openapi-docs@v1.6.1...v1.7.0

`v1.6.1`

Compare Source

High level enhancements

Add support for rendering additionalProperties schemas (#465)
Add response status class name to response tab item (#461)
Update usage docs (#463)
Allow "none" option for categoryLinkSource (#462)
Add code, thead and tbody to greaterThan regex (#459)

Other enhancements and bug fixes

Eval guard value as double not (#468)
Remove code tab test styling (#469)

`v1.6.0`

Compare Source

High level enhancements

Add support for security vendor extensions (#457)
[Enhancement] Add option to hide send button (#456)
Lock supported docusaurus versions (#449)
Handle missing params/header schema (#446)
Apply docusaurus.io styles to demo (#443)
[FR] Added support for summary and description for param schema examples (#406)

Other enhancements and bug fixes

Avoid falling back to MOD label when rendering oneOf/anyOf and title not defined (#455)
Expand support for nullable objects and default to any for empty/unknown schemas (#452)
Fix security schemes (#444)
[bug] Use toString() utility to always convert example to string (#442)
Improve handling of non-string default values (#436)
Remove trailing slash in outputDir option if present (#435)
Fix: date-time examples should include time (#427)
Fix logo/darkLogo and colorMode synching (#426)
fix: fix logic that determines if an object property is required in response (#424)
Implement NodePolyfillPlugin in theme webpack config (#422)
revert max-width and max-height on code blocks in code tabs (#417)
Update sidebars.md (#413)
Clarify support for OpenAPI 3.0 (#420)
Add support for java and expand language variants (#404)

`v1.5.2`

Compare Source

High level enhancements

Improved support for rendering items/arrays
Fixed issue that prevented some schemas from fully-rendering (#397)
Added support for nullable

Other enhancements and bug fixes

Cleanup API doc demos (#400)
[Bug] Support multiple same-level node types and improve items/array support (#397)
Bump ua-parser-js from 0.7.32 to 0.7.33 (#395)
Add support for nullable (#393)
Bump cookiejar from 2.1.3 to 2.1.4 (#390)
Update intro/README (#384)
Update a link in the credits (#382)

`v1.5.1`

Compare Source

High level enhancements

Added support for x-webhooks extension
Improvements to how Swagger 2.0 is upconverted to OpenAPI 3.0

Other enhancements and bug fixes

[Bug] Refactor selective sanitization of > and < symbols in generated markdown descriptions (#377)
fix jsonSchemaMergeAllOf options in createRequestSchema (#374)
Add resolveInternal to swagger2openapi options (#375)
[Enhancement] Introduce support for webhooks extension (#370)

`v1.5.0`

Compare Source

High level enhancements

Introduced proxy support
Added support for rendering deprecated schema items/properties

Other enhancements and bug fixes

Only create list of 2xx content types for request samples (#365)
[Enhancement] Add deprecated support to schema items (#367)
[Enhancement] Add proxy support (#366)
kebab case fix for info pages (#363)
Hide edit URL by default (#364)
Update index.ts (#361)

`v1.4.7`

Compare Source

High level enhancements

Emergency patch to address regression bug introdudced by #351

Other enhancements and bug fixes

Import markdown utils from lib (#358)

`v1.4.6`

Compare Source

High level enhancements

Added support for swizzling ApiItem and ApiDemoPanel components!

Other enhancements and bug fixes

Remove createProperties from items anyOneOf condition and add new condition for handling items.properties (#356)
[Enhancement] Allow whitespace in key/token/password input (#354)
[Bug] Respect readOnly/writeOnly when creating example from schema (#353)
[Bug] Import Body from @theme in makeRequest (#352)
[Experimental] Improve support for swizzling theme components (#351)
Bump loader-utils from 2.0.3 to 2.0.4 (#346)

`v1.4.5`

Compare Source

High level enhancements

Bug fixes and polish
Re-introduce missing --openapi-input-background variable to styles.css

Other enhancements and bug fixes

[Bug] Add condition for handling arrays of discriminators (#344)

`v1.4.4`

Compare Source

High level enhancements

Introduce Docusaurus v2.2.0 support

Other enhancements and bug fixes

Include global tags and tag docs only if referenced by operation (#340)
[Bug] Handle double quotes in sidebar_label frontmatter (#338)
Fix error when allOf two refs ([#

Configuration

📅 Schedule: Branch creation - "every weekday" (UTC), 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 was generated by Mend Renovate. View the repository job log.

renovate · 2024-11-29T16:04:17Z

Renovate Ignore Notification

Because you closed this PR without merging, Renovate will ignore this update. You will not get PRs for any future 4.x releases. But if you manually upgrade to 4.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.

chore(deps): update dependency docusaurus-plugin-openapi-docs to v4

296462c

B4nan closed this Nov 29, 2024

renovate bot deleted the renovate/docusaurus-plugin-openapi-docs-4.x branch November 29, 2024 16:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

chore(deps): update dependency docusaurus-plugin-openapi-docs to v4 #1311

chore(deps): update dependency docusaurus-plugin-openapi-docs to v4 #1311

Uh oh!

renovate bot commented Nov 29, 2024

Uh oh!

renovate bot commented Nov 29, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

chore(deps): update dependency docusaurus-plugin-openapi-docs to v4 #1311

chore(deps): update dependency docusaurus-plugin-openapi-docs to v4 #1311

Uh oh!

Conversation

renovate bot commented Nov 29, 2024

Release Notes

Features/Enhancements

Bug Fixes

Refactoring

Other

What's Changed

What's Changed

What's Changed

New Contributors

What's Changed

What's Changed

What's Changed

What's Changed

New Contributors

What's Changed

New Contributors

What's Changed

New Contributors

What's Changed

What's Changed

What's Changed

New Contributors

What's Changed

What's Changed

What's Changed

Configuration

Uh oh!

renovate bot commented Nov 29, 2024

Renovate Ignore Notification

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants