perf: only include components if circular $ref pointers are in the JS…

…ON Schema (#479) * fix: only include components if $ref pointers are in the json schema * test: fixing some broken tests * feat: only including components in response schemas if there's circular refs * test: fixing a broken test
readmeio · Aug 12, 2021 · f3193a0 · f3193a0
1 parent f17bf5d
commit f3193a0
Show file tree

Hide file tree

Showing 12 changed files with 646 additions and 1,128 deletions.
diff --git a/__tests__/__datasets__/circular.json b/__tests__/__datasets__/circular.json
@@ -6,14 +6,15 @@
   },
   "servers": [
     {
-      "url": "https://httpsbin.org"
+      "url": "https://httpbin.org/anything"
     }
   ],
   "paths": {
     "/": {
       "get": {
         "responses": {
           "200": {
+            "description": "OK",
             "content": {
               "application/json": {
                 "schema": {
@@ -60,6 +61,51 @@
               }
             }
           }
+        },
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        }
+      },
+      "put": {
+        "description": "This operation is different because it has a circular ref array as a parameter and in its response, but not its request body.",
+        "parameters": [
+          {
+            "name": "content",
+            "in": "header",
+            "schema": {
+              "type": "array",
+              "items": {
+                "$ref": "#/components/schemas/SalesLine"
+              }
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/SalesLine"
+                  }
+                }
+              }
+            }
+          },
+          "201": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SalesLine"
+                }
+              }
+            }
+          }
         }
       }
     }
@@ -106,6 +152,24 @@
             }
           }
         }
+      },
+      "SalesLine": {
+        "type": "object",
+        "properties": {
+          "stock": {
+            "$ref": "#/components/schemas/ProductStock"
+          }
+        }
+      },
+      "ProductStock": {
+        "properties": {
+          "test_param": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/SalesLine"
+            }
+          }
+        }
       }
     }
   }

diff --git a/__tests__/__fixtures__/create-oas.js b/__tests__/__fixtures__/create-oas.js
@@ -0,0 +1,17 @@
+const Oas = require('../../src');
+
+module.exports = function createOas(operation, components) {
+  const schema = {
+    paths: {
+      '/': {
+        get: operation,
+      },
+    },
+  };
+
+  if (components) {
+    schema.components = components;
+  }
+
+  return new Oas(schema);
+};
diff --git a/__tests__/index.test.js b/__tests__/index.test.js
@@ -1130,6 +1130,7 @@ describe('#dereference()', () => {
     expect(oas.paths['/'].get).toStrictEqual({
       responses: {
         200: {
+          description: 'OK',
           content: {
             'application/json': {
               schema: {

diff --git a/__tests__/lib/openapi-to-json-schema.test.js b/__tests__/lib/openapi-to-json-schema.test.js
@@ -738,6 +738,7 @@ describe('`example` / `examples` support', () => {
 
       const schema = operation.getParametersAsJsonSchema()[0].schema;
 
+      expect(schema.components).toBeUndefined();
       expect(schema.properties.id.examples).toStrictEqual([20]);
 
       // Not `buster` because `doggie` is set directly alongside `name` in the definition.
@@ -749,11 +750,6 @@ describe('`example` / `examples` support', () => {
           examples: ['https://example.com/dog.png'],
         },
       });
-
-      // `Pet` schema `id` example should not be present because that `id` was set against the `requestBody`, not the
-      // component.
-      expect(schema.components.schemas.Pet.properties.id.examples).toBeUndefined();
-      expect(schema.components.schemas.Pet.properties.name.examples).toStrictEqual(['doggie']);
     });
   });