Merge branch 'main' of https://github.com/blindaa121/docusaurus-openapi-docs into codex/update-packages-and-run-tests

Author: blindaa121

.github/workflows/build-perf.yml

@@ -17,7 +17,7 @@ jobs:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
       - uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4
         with:
-          node-version: "18"
+          node-version: "20"
           cache: yarn
       - uses: preactjs/compressed-size-action@946a292cd35bd1088e0d7eb92b69d1a8d5b5d76a # v2
         with:

.github/workflows/canary-beta-release.yml

@@ -23,7 +23,7 @@ jobs:
       - name: Set up Node
         uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4
         with:
-          node-version: "18"
+          node-version: "20"
           cache: yarn
       - name: Prepare git
         run: |

.github/workflows/canary-release.yml

@@ -23,7 +23,7 @@ jobs:
       - name: Set up Node
         uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4
         with:
-          node-version: "18"
+          node-version: "20"
           cache: yarn
       - name: Prepare git
         run: |

AGENTS.md

@@ -57,8 +57,23 @@ yarn test
    ```bash
    yarn release:changelog
    ```
-   Copy the output to the top of `CHANGELOG.md` with the current date. Update the "High level enhancements" section and clean up the history for public release.
+   Copy the output to the top of `CHANGELOG.md` with the current date. Update the "High level enhancements" section (high-level summary of new features or bug fixes) and clean up the history for public release.
 3. **Cleanup documentation** in `README.md`, `packages/docusaurus-plugin-openapi-docs/README.md` and `demo/docs/intro.mdx`.
 4. **Commit** all changes with the message `Prepare release vX.Y.Z`.
 
 Once merged, the `release.yaml` workflow will publish the release automatically.
+
+## Handling Issues and Pull Requests
+
+### Issues
+
+- Triage each report to figure out whether it's a question, documentation request, or bug.
+- Investigate carefully to confirm the problem is within this project and not caused by user error, dependency mismatches, or other external factors.
+- Consider how a fix might affect existing features and avoid any regression or breaking change.
+
+### Pull Requests
+
+- Start by checking if the contribution updates documentation, fixes a bug, or adds or enhances a feature.
+- Ensure the proposal fits the scope of the project and doesn't duplicate existing docs or functionality.
+- Provide a summary of whether the pull request is ready to merge or what changes are still needed from the contributor.
+- Consider how merging the pull request might affect existing features and make sure it does not introduce regressions or breaking changes.

demo/examples/tests/allOf.yaml

@@ -367,6 +367,51 @@ paths:
                       otherOuterProp:
                         type: string
 
+  /allof-parent-required:
+    get:
+      tags:
+        - allOf
+      summary: allOf inherits parent required
+      description: |
+        Parent object marks the "pet" property as required while its schema is composed via allOf.
+
+        Schema:
+        ```yaml
+        type: object
+        properties:
+          pet:
+            allOf:
+              - type: object
+                properties:
+                  name:
+                    type: string
+              - type: object
+                properties:
+                  age:
+                    type: integer
+        required: [pet]
+        ```
+      responses:
+        "200":
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  pet:
+                    allOf:
+                      - type: object
+                        properties:
+                          name:
+                            type: string
+                      - type: object
+                        properties:
+                          age:
+                            type: integer
+                required:
+                  - pet
+
 components:
   schemas:
     # Your existing schemas are integrated here.

packages/docusaurus-plugin-openapi-docs/src/openapi/__fixtures__/webhook/openapi.yaml

@@ -0,0 +1,17 @@
+openapi: 3.0.3
+info:
+  title: Webhook Example
+  version: 1.0.0
+paths: {}
+webhooks:
+  order.created:
+    post:
+      requestBody:
+        description: example body
+        content:
+          application/json:
+            schema:
+              type: object
+      responses:
+        "200":
+          description: OK

packages/docusaurus-plugin-openapi-docs/src/openapi/openapi.ts

@@ -274,11 +274,19 @@ function createItems(
   for (let [path, pathObject] of Object.entries(
     openapiData["x-webhooks"] ?? openapiData["webhooks"] ?? {}
   )) {
+    const eventName = path;
     path = "webhook";
     const { $ref, description, parameters, servers, summary, ...rest } =
       pathObject;
     for (let [method, operationObject] of Object.entries({ ...rest })) {
       method = "event";
+      if (
+        operationObject.summary === undefined &&
+        operationObject.operationId === undefined
+      ) {
+        operationObject.summary = eventName;
+      }
+
       const title =
         operationObject.summary ??
         operationObject.operationId ??
@@ -290,7 +298,7 @@ function createItems(
 
       const baseId = operationObject.operationId
         ? kebabCase(operationObject.operationId)
-        : kebabCase(operationObject.summary);
+        : kebabCase(operationObject.summary ?? eventName);
 
       const extensions = [];
       const commonExtensions = ["x-codeSamples"];

packages/docusaurus-plugin-openapi-docs/src/openapi/webhooks.test.ts

@@ -0,0 +1,30 @@
+/* ============================================================================
+ * Copyright (c) Palo Alto Networks
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ * ========================================================================== */
+
+import path from "path";
+
+// eslint-disable-next-line import/no-extraneous-dependencies
+import { posixPath } from "@docusaurus/utils";
+
+import { readOpenapiFiles, processOpenapiFiles } from ".";
+
+describe("webhooks", () => {
+  it("uses event name when summary and operationId are missing", async () => {
+    const files = await readOpenapiFiles(
+      posixPath(path.join(__dirname, "__fixtures__/webhook/openapi.yaml"))
+    );
+
+    const [items] = await processOpenapiFiles(
+      files,
+      { specPath: "", outputDir: "" } as any,
+      {}
+    );
+
+    const webhookItem = items.find((item) => item.type === "api");
+    expect(webhookItem?.id).toBe("order-created");
+  });
+});

packages/docusaurus-theme-openapi-docs/src/theme/ApiExplorer/CodeTabs/_CodeTabs.scss

@@ -197,7 +197,11 @@ body[class="ReactModal__Body--open"] {
   }
 
   &.active {
-    box-shadow: 0 0 0 3px var(--openapi-code-tab-shadow-color-curl);
+    box-shadow: 0 0 0 3px
+      var(
+        --openapi-code-tab-shadow-color-curl,
+        var(--openapi-code-tab-shadow-color-bash)
+      );
     border-color: var(--ifm-color-danger);
   }
 }

packages/docusaurus-theme-openapi-docs/src/theme/Schema/index.tsx

@@ -725,9 +725,7 @@ const SchemaEdge: React.FC<SchemaEdgeProps> = ({
           name={name}
           schemaName={mergedSchemaName}
           required={
-            Array.isArray(mergedSchemas.required)
-              ? mergedSchemas.required.includes(name)
-              : mergedSchemas.required
+            Array.isArray(required) ? required.includes(name) : required
           }
           nullable={mergedSchemas.nullable}
           schema={mergedSchemas}
@@ -742,9 +740,7 @@ const SchemaEdge: React.FC<SchemaEdgeProps> = ({
           name={name}
           schemaName={mergedSchemaName}
           required={
-            Array.isArray(mergedSchemas.required)
-              ? mergedSchemas.required.includes(name)
-              : mergedSchemas.required
+            Array.isArray(required) ? required.includes(name) : required
           }
           nullable={mergedSchemas.nullable}
           schema={mergedSchemas}
@@ -754,18 +750,18 @@ const SchemaEdge: React.FC<SchemaEdgeProps> = ({
     }
 
     if (mergedSchemas.items?.properties) {
-      <SchemaNodeDetails
-        name={name}
-        schemaName={mergedSchemaName}
-        required={
-          Array.isArray(mergedSchemas.required)
-            ? mergedSchemas.required.includes(name)
-            : mergedSchemas.required
-        }
-        nullable={mergedSchemas.nullable}
-        schema={mergedSchemas}
-        schemaType={schemaType}
-      />;
+      return (
+        <SchemaNodeDetails
+          name={name}
+          schemaName={mergedSchemaName}
+          required={
+            Array.isArray(required) ? required.includes(name) : required
+          }
+          nullable={mergedSchemas.nullable}
+          schema={mergedSchemas}
+          schemaType={schemaType}
+        />
+      );
     }
 
     return (