Merge pull request #998 from PaloAltoNetworks/additional-props

Ensure additionalProperties object primitives are rendered
PaloAltoNetworks · Oct 17, 2024 · dca14cd · dca14cd
2 parents 4137a5a + f53f2a7
commit dca14cd
Show file tree

Hide file tree

Showing 2 changed files with 165 additions and 1 deletion.
diff --git a/demo/examples/tests/additionalProperties.yaml b/demo/examples/tests/additionalProperties.yaml
@@ -0,0 +1,163 @@
+openapi: 3.1.0
+info:
+  title: AdditionalProperties Variations API
+  description: Demonstrates various usages of additionalProperties.
+  version: 1.0.0
+tags:
+  - name: additionalProperties
+    description: additionalProperties tests
+
+paths:
+  /with-typed-additional:
+    get:
+      tags:
+        - additionalProperties
+      summary: Object with typed additionalProperties
+      description: |
+        This endpoint returns an object where additional properties are restricted to a specific type.
+
+        Schema:
+        ```yaml
+        type: object
+        properties:
+          fixedProp:
+            type: string
+        additionalProperties:
+          type: string
+        example:
+          fixedProp: "fixedValue"
+          dynamicProp: "dynamicValue"
+        ```
+      responses:
+        "200":
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  fixedProp:
+                    type: string
+                additionalProperties:
+                  type: string
+                example:
+                  fixedProp: "fixedValue"
+                  dynamicProp: "dynamicValue"
+
+  /with-schema-additional:
+    get:
+      tags:
+        - additionalProperties
+      summary: Object with schema-defined additionalProperties
+      description: |
+        This endpoint returns an object where additional properties follow a specific schema.
+
+        Schema:
+        ```yaml
+        type: object
+        properties:
+          fixedProp:
+            type: string
+        additionalProperties:
+          $ref: "#/components/schemas/NestedAdditionalProperty"
+        example:
+          fixedProp: "fixedValue"
+          dynamicProp:
+            type: "exampleType"
+            value: 42
+        ```
+      responses:
+        "200":
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  fixedProp:
+                    type: string
+                additionalProperties:
+                  $ref: "#/components/schemas/NestedAdditionalProperty"
+                example:
+                  fixedProp: "fixedValue"
+                  dynamicProp:
+                    type: "exampleType"
+                    value: 42
+
+  /with-bool-additional:
+    get:
+      tags:
+        - additionalProperties
+      summary: Object with boolean additionalProperties
+      description: |
+        This endpoint returns an object where additional properties are either allowed or not.
+
+        Schema:
+        ```yaml
+        type: object
+        properties:
+          fixedProp:
+            type: string
+        additionalProperties: true
+        example:
+          fixedProp: "fixedValue"
+          dynamicProp1: 123
+          dynamicProp2: "dynamicValue"
+        ```
+      responses:
+        "200":
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  fixedProp:
+                    type: string
+                additionalProperties: true
+                example:
+                  fixedProp: "fixedValue"
+                  dynamicProp1: 123
+                  dynamicProp2: "dynamicValue"
+
+  /without-additional-properties:
+    get:
+      tags:
+        - additionalProperties
+      summary: Object without any additionalProperties
+      description: |
+        This endpoint returns an object where no additional properties are allowed.
+
+        Schema:
+        ```yaml
+        type: object
+        properties:
+          fixedProp:
+            type: string
+        additionalProperties: false
+        example:
+          fixedProp: "fixedValue"
+        ```
+      responses:
+        "200":
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  fixedProp:
+                    type: string
+                additionalProperties: false
+                example:
+                  fixedProp: "fixedValue"
+
+components:
+  schemas:
+    NestedAdditionalProperty:
+      type: object
+      properties:
+        type:
+          type: string
+        value:
+          type: integer
diff --git a/packages/docusaurus-theme-openapi-docs/src/theme/Schema/index.tsx b/packages/docusaurus-theme-openapi-docs/src/theme/Schema/index.tsx
@@ -334,7 +334,8 @@ const AdditionalProperties: React.FC<SchemaProps> = ({
     additionalProperties.type === "string" ||
     additionalProperties.type === "boolean" ||
     additionalProperties.type === "integer" ||
-    additionalProperties.type === "number"
+    additionalProperties.type === "number" ||
+    additionalProperties.type === "object"
   ) {
     const schemaName = getSchemaName(additionalProperties);
     return (