Skip to content

Commit 4e771d3

Browse files
authored
Merge pull request #986 from PaloAltoNetworks/release-v4.1.0
Prepare release v4.1.0
2 parents b7872d6 + bb7f7ac commit 4e771d3

File tree

5 files changed

+97
-7
lines changed

5 files changed

+97
-7
lines changed

CHANGELOG.md

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,93 @@
1+
## 4.1.0 (Oct 4, 2024)
2+
3+
High level enhancements
4+
5+
- Added support for rendering schema item example (#985)
6+
- Improved support for enum descriptions (#981 and #951)
7+
- Added support for `sidebarGenerators` (#963)
8+
- Added OpenAPI 3.1 webhooks support (#961)
9+
- Improved code snippets support(#945 and #984)
10+
11+
Other enhancements and bug fixes
12+
13+
- Merge pull request #985 from PaloAltoNetworks/edge-allof
14+
- Combined merged schema with original to ensure no properties are lost
15+
- Add support for rendering example to SchemaItem
16+
- Merge pull request #984 from PaloAltoNetworks/fix-code-snippet-scroll
17+
- Adjust offset for glow effect around active tab
18+
- Avoid scrolling if first item in scroll area
19+
- Use scrollLeft to avoid scrolling entire page to active code tab
20+
- Merge pull request #981 from tuanpt-0634/support-schema-enum-descriptions
21+
- Support enum descriptions in schema object
22+
- Merge pull request #971 from robbieaverill/children-reactnode
23+
- Restore fallback to empty string when children is falsy
24+
- Revert string casting in plugin utils
25+
- Revert changes to plugin guard() and render() methods, they will not accept ReactNode
26+
- Children interface is now ReactNode, theme utility methods are deprecated in favour of plugin methods
27+
- Merge pull request #969 from tuanpt-0634/fix_button_show_optional_parameters
28+
- Fix change type of Show optional parameters button
29+
- Merge pull request #963 from robbieaverill/feature/custom-doc-item-generator
30+
- Move createDocItem() into a `sidebarGenerators` object
31+
- Add line-through style to deprecated sidebar items
32+
- Add support for custom sidebar DocItem generators supporting customisation
33+
- Add markdownGenerators example and update docs
34+
- Merge pull request #961 from PaloAltoNetworks/webhooks
35+
- Add example OpenAPI 3.1 petstore
36+
- Add support for OpenAPI 3.1 webhooks
37+
- Merge pull request #960 from PaloAltoNetworks/deprecation-notice
38+
- Fix deprecation notice
39+
- Merge pull request #958 from PaloAltoNetworks/default-values
40+
- Ensure description comes before qualifier and default value
41+
- Render default value after description
42+
- Fix defaultValue and cleanup unused code
43+
- Update packages
44+
- Apply changes to ParamsItem
45+
- Render default value as string literal instead of markdown
46+
- Fix curl logoClass
47+
- Merge pull request #957 from PaloAltoNetworks/security-schemes
48+
- Apply border radius to summary
49+
- Merge pull request #951 from omonk/ollie.monk/x-enumDescriptions
50+
- Add missing security schemes component
51+
- Enum => Enum Value
52+
- Merge pull request #954 from Olexandr88/patch-1
53+
- Update README
54+
- Merge pull request #952 from PaloAltoNetworks/language-options
55+
- Remove unused import
56+
- Update languageTabs and styling docs
57+
- Remove log
58+
- Fix type
59+
- Use x-enumDescriptions in UI
60+
- Merge user-defined languageTabs options
61+
- Merge pull request #949 from PaloAltoNetworks/method-endpoint
62+
- Import hooks from theme
63+
- Merge pull request #945 from PaloAltoNetworks/language-tabs
64+
- Add fallback in case language not already in localStorage
65+
- Auto scroll to default language
66+
- Use first variant in variants array as default
67+
- Define defaultValue for language and add code comments to improve clarity
68+
- Convert python styles to CSS
69+
- Expand supported languages in demo
70+
- Demonstrate overriding language tab styles
71+
- Add additional language tab styles
72+
- Add function for generating languageSet
73+
- Add missing languages
74+
- Add advanced topics
75+
- Add BrowserWindow component
76+
- Update workflows
77+
- Merge pull request #939 from omonk/context-aware-method-endpoint-render
78+
- Merge pull request #944 from robbieaverill/fix-oneof-within-anyof
79+
- Merge pull request #943 from PaloAltoNetworks/dependabot/github_actions/dot-github/workflows/actions/download-artifact-4.1.7
80+
- Add example of oneOf within anyOf to "Tests" in demo
81+
- Fix bug where oneOf within anyOf would not be rendered in request schemas
82+
- Bump actions/download-artifact from 3 to 4.1.7 in /.github/workflows
83+
- Fix linting
84+
- Fix linting
85+
- Do not render serverUrl on callbacks MethodEndpoint component
86+
- Merge pull request #937 from PaloAltoNetworks/layout-paginator
87+
- Conditionally set col width for API doc layout
88+
- Merge pull request #931 from IanVS/docusaurus-35-version
89+
- Update dependencies for docusaurus 3.5+
90+
191
## 4.0.1 (Aug 22, 2024)
292

393
High level enhancements

demo/package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "demo",
3-
"version": "4.0.1",
3+
"version": "4.1.0",
44
"private": true,
55
"scripts": {
66
"docusaurus": "docusaurus",
@@ -25,8 +25,8 @@
2525
"@docusaurus/plugin-google-gtag": "3.5.2",
2626
"@docusaurus/preset-classic": "3.5.2",
2727
"clsx": "^1.1.1",
28-
"docusaurus-plugin-openapi-docs": "^4.0.1",
29-
"docusaurus-theme-openapi-docs": "^4.0.1",
28+
"docusaurus-plugin-openapi-docs": "^4.1.0",
29+
"docusaurus-theme-openapi-docs": "^4.1.0",
3030
"prism-react-renderer": "^2.3.0",
3131
"react": "^18.2.0",
3232
"react-dom": "^18.2.0"

lerna.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
2-
"version": "4.0.1",
2+
"version": "4.1.0",
33
"npmClient": "yarn"
44
}

packages/docusaurus-plugin-openapi-docs/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "docusaurus-plugin-openapi-docs",
33
"description": "OpenAPI plugin for Docusaurus.",
4-
"version": "4.0.1",
4+
"version": "4.1.0",
55
"license": "MIT",
66
"keywords": [
77
"openapi",

packages/docusaurus-theme-openapi-docs/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "docusaurus-theme-openapi-docs",
33
"description": "OpenAPI theme for Docusaurus.",
4-
"version": "4.0.1",
4+
"version": "4.1.0",
55
"license": "MIT",
66
"keywords": [
77
"openapi",
@@ -42,7 +42,7 @@
4242
"clsx": "^1.1.1",
4343
"copy-text-to-clipboard": "^3.1.0",
4444
"crypto-js": "^4.1.1",
45-
"docusaurus-plugin-openapi-docs": "^4.0.1",
45+
"docusaurus-plugin-openapi-docs": "^4.1.0",
4646
"docusaurus-plugin-sass": "^0.2.3",
4747
"file-saver": "^2.0.5",
4848
"lodash": "^4.17.20",

0 commit comments

Comments
 (0)