Merge branch 'main' into fix-crash-in-createExample

Author: bourdakos1

CHANGELOG.md

@@ -1,6 +1,58 @@
+## 0.7.5 (Apr 29, 2024)
+
+Enhancements and bug fixes
+
+- Remove axios dependency ([#288](https://github.com/cloud-annotations/docusaurus-openapi/pull/288))
+
+## 0.7.4 (Apr 1, 2024)
+
+Bug Fixes for Docusaurus 3.2.0 upgrade ([#283](https://github.com/cloud-annotations/docusaurus-openapi/pull/283))
+
+- `addLeadingSlash` and `addTrailingSlash` are now imported from `@docusaurus/utils-common`
+- Omit `showLastUpdateAuthor` and `showLastUpdateTime` from PluginOptions
+- Updated `toNav` function to handle `nav.menu` items that now have a role of `button` instead of `link`
+- Updated Docusaurus version to 3.2.0
+
+## 0.7.3 (Jan 15, 2024)
+
+Enhancements and bug fixes
+
+- Use parseMarkdownFile instead of parseMarkdownString ([#277](https://github.com/cloud-annotations/docusaurus-openapi/pull/277))
+
+## 0.7.2 (Dec 21, 2023)
+
+Enhancements and bug fixes
+
+- Fix bash syntax highlighting ([#274](https://github.com/cloud-annotations/docusaurus-openapi/pull/274))
+
+## 0.7.1 (Dec 18, 2023)
+
+High-level enhancements
+
+- Bug fixes related to Docusaurus v3 migration
+
+Other enhancements and bug fixes
+
+- Fix admonitions support in Docusaurus v3 ([#271](https://github.com/cloud-annotations/docusaurus-openapi/pull/271))
+- Fix some MDXv3 migration bugs ([#270](https://github.com/cloud-annotations/docusaurus-openapi/pull/270))
+
+## 0.7.0 (Dec 13, 2023)
+
+High-level enhancements
+
+- Docusaurus v3 support ([#266](https://github.com/cloud-annotations/docusaurus-openapi/pull/266))
+- Allow pressing enter to perform the 'Execute' action ([#255](https://github.com/cloud-annotations/docusaurus-openapi/pull/255))
+- Render examples in a `<code>` block ([#256](https://github.com/cloud-annotations/docusaurus-openapi/pull/256))
+
+Other enhancements and bug fixes
+
+- Wrap code examples tabs in narrow browser windows ([#250](https://github.com/cloud-annotations/docusaurus-openapi/pull/250))
+- Add border to form inputs when using light theme ([#252](https://github.com/cloud-annotations/docusaurus-openapi/pull/252))
+- Fix: Page crash on half surrogate pair ([#261](https://github.com/cloud-annotations/docusaurus-openapi/pull/261))
+
 ## 0.6.4 (Mar 15, 2023)
 
-High level enhancements
+High-level enhancements
 
 - Fixes and enhancements for array query param handling ([#241](https://github.com/cloud-annotations/docusaurus-openapi/pull/241))
   - Respect the `maxItems` property for array query params
@@ -18,7 +70,7 @@ Other enhancements and bug fixes
 
 ## 0.6.3 (Nov 7, 2022)
 
-High level enhancements
+High-level enhancements
 
 - Compatibility with Docusaurus 2.2.0 ([#223](https://github.com/cloud-annotations/docusaurus-openapi/pull/223))
 - Support for loading custom Markdown Files: ([#193](https://github.com/cloud-annotations/docusaurus-openapi/pull/193))
@@ -30,7 +82,7 @@ Other enhancements and bug fixes
 
 ## 0.6.2 (Aug 11, 2022)
 
-High level enhancements
+High-level enhancements
 
 - Authorize with api keys in header
 
@@ -54,7 +106,7 @@ Other enhancements and bug fixes
 
 ## 0.6.0 (Jun 23, 2022)
 
-High level enhancements
+High-level enhancements
 
 - Compatibility with Docusaurus 2.0.0-beta.21
 
@@ -68,7 +120,7 @@ Other enhancements and bug fixes
 
 ## 0.5.0 (Jan 9, 2022)
 
-High level enhancements
+High-level enhancements
 
 - All theme components are now TypeScript 🎉
 
@@ -97,7 +149,7 @@ Enhancements and bug fixes
 
 ## 0.4.0 (Dec 23, 2021)
 
-High level enhancements
+High-level enhancements
 
 - Docusaurus beta.14 support
 
@@ -156,7 +208,7 @@ Other enhancements and bug fixes
 
 ## 0.3.1 (Dec 21, 2021)
 
-High level enhancements
+High-level enhancements
 
 - Added support for more schema qualifiers:
 
@@ -203,7 +255,7 @@ Other enhancements and bug fixes
 
 ## 0.3.0 (Dec 16, 2021)
 
-High level enhancements
+High-level enhancements
 
 - Docusaurus beta.13 support (Thanks @Josh-Cena!)
 
@@ -281,7 +333,7 @@ Fix broken package
 
 ## 0.2.1 (Dec 5, 2021)
 
-High level enhancements
+High-level enhancements
 
 - The demo panel now allows you to choose the security scheme from a dropdown that is populated by the OpenAPI definition (only showing the dropdown if more than one is listed)
 - Adds support for using multiple auth modes simultaneously (Eg: `(BearerAuth) OR (ApiKeyAuth AND BasicAuth)`)

README.md

@@ -1,8 +1,8 @@
-<h1 align="center">Docusaurus OpenAPI (beta)</h1>
+<h1 align="center">Docusaurus OpenAPI</h1>
 
 <div align="center">
 
-OpenAPI plugin for generating API reference docs in Docusaurus v2.
+OpenAPI plugin for generating API reference docs in Docusaurus.
 
 [![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/cloud-annotations/docusaurus-plugin-openapi/blob/HEAD/LICENSE)
 [![npm latest package](https://img.shields.io/npm/v/docusaurus-preset-openapi/latest.svg)](https://www.npmjs.com/package/docusaurus-preset-openapi)

cypress/integration/test.spec.ts

@@ -47,11 +47,19 @@ function navTo(links: RegExp[], heading: RegExp) {
     return false;
   });
 
-  for (let link of links) {
-    cy.get("nav.menu")
-      .findByRole("link", { name: link })
-      .click({ force: true }); // sometimes the sidebar items get covered by the navbar in CI.
-  }
+  links.forEach((linkRegex) => {
+    cy.get("nav.menu").then(($menu) => {
+      const navElement = $menu
+        .find("a")
+        .toArray()
+        .find((el) => linkRegex.test(el.innerText));
+      if (navElement) {
+        cy.wrap(navElement).click({ force: true });
+      } else {
+        cy.log(`No link or button found matching regex: ${linkRegex}`);
+      }
+    });
+  });
 
   cy.findByRole("heading", { name: heading, level: 1 }).should("exist");
 }

demo/docusaurus.config.js

@@ -1,8 +1,10 @@
 // @ts-check
-// Note: type annotations allow type checking and IDEs autocompletion
+// `@type` JSDoc annotations allow editor autocompletion and type checking
+// (when paired with `@ts-check`).
+// There are various equivalent ways to declare your Docusaurus config.
+// See: https://docusaurus.io/docs/api/docusaurus-config
 
-const lightCodeTheme = require("prism-react-renderer/themes/github");
-const darkCodeTheme = require("prism-react-renderer/themes/dracula");
+import { themes as prismThemes } from "prism-react-renderer";
 
 /** @type {import('@docusaurus/types').Config} */
 const config = {
@@ -16,6 +18,18 @@ const config = {
   organizationName: "cloud-annotations", // Usually your GitHub org/user name.
   projectName: "docusaurus-openapi", // Usually your repo name.
 
+  markdown: {
+    mdx1Compat: {
+      comments: false,
+      admonitions: false,
+      headingIds: false,
+    },
+  },
+
+  future: {
+    experimental_faster: true,
+  },
+
   presets: [
     [
       "docusaurus-preset-openapi",
@@ -113,8 +127,8 @@ const config = {
         copyright: `Copyright © ${new Date().getFullYear()} Cloud Annotations. Built with Docusaurus.`,
       },
       prism: {
-        theme: lightCodeTheme,
-        darkTheme: darkCodeTheme,
+        theme: prismThemes.github,
+        darkTheme: prismThemes.dracula,
       },
       api: {
         authPersistance: "localStorage",
@@ -123,4 +137,4 @@ const config = {
     }),
 };
 
-module.exports = config;
+export default config;

demo/examples/openapi-cos.json

@@ -79,7 +79,7 @@
       "put": {
         "tags": ["Bucket operations"],
         "summary": "Create a bucket",
-        "description": "A `PUT` request sent to the endpoint root followed by a string will create a bucket.\nFor more information about endpoints, see [Endpoints and storage locations](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-endpoints#endpoints).\nBucket names must be globally unique and DNS-compliant; names between 3 and 63 characters long must be made of lowercase letters, numbers, and dashes.\nBucket names must begin and end with a lowercase letter or number.\nBucket names resembling IP addresses are not allowed.\nThis operation doesn't make use of operation specific query parameters.\n\n:::info important\nBucket names must be unique because all buckets in the public cloud share a global namespace.\nThis allows for access to a bucket without needing to provide any service instance or account information.\nIt is also not possible to create a bucket with a name beginning with `cosv1-` or `account-` as these prefixes are reserved by the system.\n:::\n\n:::note\nPersonally Identifiable Information (PII): When creating buckets or adding objects, please ensure to not use any information that can identify any user (natural person) by name, location or any other means in the name of the bucket or object.\n:::\n\n## Create a bucket with a different storage class\n\nTo create a bucket with a different storage class, send an XML block specifying a bucket configuration with a `LocationConstraint` of `{provisioning code}` in the body of a `PUT` request to a bucket endpoint.\nFor more information about endpoints, see [Endpoints and storage locations](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-endpoints#endpoints).\nNote that standard bucket [naming rules](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-compatibility-api-bucket-operations#compatibility-api-new-bucket) apply.\nThis operation does not make use of operation specific query parameters.\n\nThe body of the request must contain an XML block with the following schema:\n\n```xml\n<CreateBucketConfiguration>\n  <LocationConstraint>us-vault</LocationConstraint>\n</CreateBucketConfiguration>\n```\n\nA list of valid provisioning codes for `LocationConstraint` can be referenced in [the Storage Classes guide](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-classes#classes-locationconstraint).\n\n## Create a new bucket with Key Protect or Hyper Protect Crypto Services managed encryption keys (SSE-KP)\n\nTo create a bucket where the encryption keys are managed by Key Protect or Hyper Protect Crypto Services, it is necessary to have access to an active Key Protect or Hyper Protect Crypto Services service instance located in the same location as the new bucket.\nThis operation does not make use of operation specific query parameters.\n\nFor more information on using Key Protect to manage your encryption keys, [see the documentation for Key Protect](https://cloud.ibm.com/docs/key-protect?topic=key-protect-getting-started-tutorial).\n\nFor more information on Hyper Protect Crypto Services, [see the documentation](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-get-started).\n\n:::note\nNote that managed encryption is **not** available in a Cross Region configuration and any SSE-KP buckets must be Regional.\n:::",
+        "description": "A `PUT` request sent to the endpoint root followed by a string will create a bucket.\nFor more information about endpoints, see [Endpoints and storage locations](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-endpoints#endpoints).\nBucket names must be globally unique and DNS-compliant; names between 3 and 63 characters long must be made of lowercase letters, numbers, and dashes.\nBucket names must begin and end with a lowercase letter or number.\nBucket names resembling IP addresses are not allowed.\nThis operation doesn't make use of operation specific query parameters.\n\n:::info[important]\nBucket names must be unique because all buckets in the public cloud share a global namespace.\nThis allows for access to a bucket without needing to provide any service instance or account information.\nIt is also not possible to create a bucket with a name beginning with `cosv1-` or `account-` as these prefixes are reserved by the system.\n:::\n\n:::note\nPersonally Identifiable Information (PII): When creating buckets or adding objects, please ensure to not use any information that can identify any user (natural person) by name, location or any other means in the name of the bucket or object.\n:::\n\n## Create a bucket with a different storage class\n\nTo create a bucket with a different storage class, send an XML block specifying a bucket configuration with a `LocationConstraint` of `{provisioning code}` in the body of a `PUT` request to a bucket endpoint.\nFor more information about endpoints, see [Endpoints and storage locations](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-endpoints#endpoints).\nNote that standard bucket [naming rules](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-compatibility-api-bucket-operations#compatibility-api-new-bucket) apply.\nThis operation does not make use of operation specific query parameters.\n\nThe body of the request must contain an XML block with the following schema:\n\n```xml\n<CreateBucketConfiguration>\n  <LocationConstraint>us-vault</LocationConstraint>\n</CreateBucketConfiguration>\n```\n\nA list of valid provisioning codes for `LocationConstraint` can be referenced in [the Storage Classes guide](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-classes#classes-locationconstraint).\n\n## Create a new bucket with Key Protect or Hyper Protect Crypto Services managed encryption keys (SSE-KP)\n\nTo create a bucket where the encryption keys are managed by Key Protect or Hyper Protect Crypto Services, it is necessary to have access to an active Key Protect or Hyper Protect Crypto Services service instance located in the same location as the new bucket.\nThis operation does not make use of operation specific query parameters.\n\nFor more information on using Key Protect to manage your encryption keys, [see the documentation for Key Protect](https://cloud.ibm.com/docs/key-protect?topic=key-protect-getting-started-tutorial).\n\nFor more information on Hyper Protect Crypto Services, [see the documentation](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-get-started).\n\n:::note\nNote that managed encryption is **not** available in a Cross Region configuration and any SSE-KP buckets must be Regional.\n:::",
         "parameters": [
           {
             "name": "bucketName",

demo/examples/petstore.yaml

@@ -38,8 +38,6 @@ info:
     OAuth2 - an open protocol to allow secure authorization in a simple
     and standard method from web, mobile and desktop applications.
 
-    <SecurityDefinitions />
-
   version: 1.0.0
   title: Swagger Petstore YAML
   termsOfService: "http://swagger.io/terms/"
@@ -302,6 +300,9 @@ paths:
             schema:
               type: string
               format: binary
+              description: |
+                This description contains <a href="https://www.w3.org/html/">HTML</a><br />
+                Cat pics plz
   /pet/findByStatus:
     get:
       tags:
@@ -442,7 +443,7 @@ paths:
         - store
       summary: Find purchase order by ID
       description: >-
-        For valid response try integer IDs with value <= 5 or > 10. Other values
+        For valid response try integer IDs with value \<= 5 or > 10. Other values
         will generated exceptions
       operationId: getOrderById
       parameters:
@@ -840,13 +841,15 @@ paths:
       parameters:
         - name: username
           in: query
-          description: The user name for login
+          description: |
+            This description contains <a href="https://www.w3.org/html/">HTML</a><br />The user name for login
           required: true
           schema:
             type: string
         - name: password
           in: query
-          description: The password for login in clear text
+          description: |
+            This description contains [markdown](https://www.markdownguide.org/)<br />The password for login in clear text
           required: true
           schema:
             type: string

demo/examples/petstore/_spec_.yaml

@@ -38,8 +38,6 @@ info:
     OAuth2 - an open protocol to allow secure authorization in a simple
     and standard method from web, mobile and desktop applications.
 
-    <SecurityDefinitions />
-
   version: 1.0.0
   title: Swagger Petstore YAML
   termsOfService: "http://swagger.io/terms/"
@@ -442,7 +440,7 @@ paths:
         - store
       summary: Find purchase order by ID
       description: >-
-        For valid response try integer IDs with value <= 5 or > 10. Other values
+        For valid response try integer IDs with value \<= 5 or > 10. Other values
         will generated exceptions
       operationId: getOrderById
       parameters:

demo/package.json

@@ -1,6 +1,6 @@
 {
   "name": "demo",
-  "version": "0.6.4",
+  "version": "0.7.5",
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",
@@ -14,15 +14,15 @@
     "write-heading-ids": "docusaurus write-heading-ids"
   },
   "dependencies": {
-    "@docusaurus/core": "^2.0.0",
-    "@mdx-js/react": "^1.6.22",
+    "@docusaurus/core": "^3.6.0",
+    "@docusaurus/faster": "^3.6.0",
     "@svgr/webpack": "^5.5.0",
-    "clsx": "^1.1.1",
-    "docusaurus-preset-openapi": "^0.6.4",
+    "clsx": "^1.2.1",
+    "docusaurus-preset-openapi": "^0.7.5",
     "file-loader": "^6.2.0",
-    "prism-react-renderer": "^1.2.1",
-    "react": "^17.0.2",
-    "react-dom": "^17.0.2",
+    "prism-react-renderer": "^2.1.0",
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0",
     "url-loader": "^4.1.1"
   },
   "browserslist": {

demo/sidebars.js

@@ -28,4 +28,4 @@ const sidebars = {
    */
 };
 
-module.exports = sidebars;
+export default sidebars;

lerna.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.6.4",
+  "version": "0.7.5",
   "npmClient": "yarn",
   "useWorkspaces": true
 }

package.json

@@ -38,9 +38,9 @@
     "@babel/preset-typescript": "^7.16.0",
     "@testing-library/cypress": "^8.0.1",
     "@types/jest": "^27.0.2",
-    "@types/node": "^17.0.2",
-    "@typescript-eslint/eslint-plugin": "^4.0.0",
-    "@typescript-eslint/parser": "^4.0.0",
+    "@types/node": "^18.0.0",
+    "@typescript-eslint/eslint-plugin": "^6.0.0",
+    "@typescript-eslint/parser": "^6.0.0",
     "babel-eslint": "^10.0.0",
     "cross-env": "^7.0.3",
     "cypress": "^8.7.0",
@@ -66,7 +66,7 @@
     "start-server-and-test": "^1.14.0",
     "ts-jest": "^27.0.6",
     "ts-node": "^10.9.1",
-    "typescript": "^4.7.4"
+    "typescript": "^5.2.2"
   },
   "lint-staged": {
     "**/*": "prettier --write --ignore-unknown"

packages/create-docusaurus-openapi/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-docusaurus-openapi",
-  "version": "0.6.4",
+  "version": "0.7.5",
   "description": "Create Docusaurus apps easily.",
   "repository": {
     "type": "git",
@@ -23,9 +23,9 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/logger": "^2.0.0",
+    "@docusaurus/logger": "^3.6.0",
     "commander": "^5.1.0",
-    "fs-extra": "^10.0.0",
+    "fs-extra": "^11.0.0",
     "lodash": "^4.17.20",
     "prompts": "^2.4.1",
     "semver": "^7.3.4",
@@ -34,9 +34,10 @@
     "tslib": "^2.3.1"
   },
   "engines": {
-    "node": ">=14"
+    "node": ">=18"
   },
   "devDependencies": {
+    "@types/fs-extra": "^11.0.0",
     "@types/prompts": "^2.0.9",
     "@types/shelljs": "^0.8.6",
     "@types/supports-color": "^8.1.1"