test(resolver): add tests for OpenAPI 3.1 useCircularStructures opt

Closes #2761
swagger-api · Jan 23, 2023 · 1d9a8f8 · 1d9a8f8
1 parent b1f1f04
commit 1d9a8f8
Show file tree

Hide file tree

Showing 43 changed files with 1,484 additions and 60 deletions.
diff --git a/package.json b/package.json
@@ -112,7 +112,7 @@
   "dependencies": {
     "@babel/runtime-corejs3": "^7.11.2",
     "@swagger-api/apidom-core": "^0.63.0",
-    "@swagger-api/apidom-reference": "^0.63.0",
+    "@swagger-api/apidom-reference": "^0.63.1",
     "@swagger-api/apidom-ns-openapi-3-1": "^0.63.0",
     "@swagger-api/apidom-json-pointer": "^0.63.0",
     "cookie": "~0.5.0",

diff --git a/src/helpers/apidom/reference/dereference/strategies/openapi-3-1-swagger-client/visitor.js b/src/helpers/apidom/reference/dereference/strategies/openapi-3-1-swagger-client/visitor.js
diff --git a/...dom/reference/dereference/strategies/openapi-3-1-swagger-client/reference-object/index.js b/...dom/reference/dereference/strategies/openapi-3-1-swagger-client/reference-object/index.js
@@ -421,7 +421,6 @@ describe('dereference', () => {
             const parseResult = await parse(uri, {
               parse: { mediaType: mediaTypes.latest('json') },
             });
-            // @ts-ignore
             const referenceElement = parseResult.api?.components.parameters.get('externalRef');
             const refSet = ReferenceSet();
             const rootFileReference = Reference({ uri, value: parseResult });

diff --git a/...-client/schema-object/__fixtures__/$anchor-external-circular-structures/dereferenced.json b/...-client/schema-object/__fixtures__/$anchor-external-circular-structures/dereferenced.json
@@ -0,0 +1,34 @@
+[
+  {
+    "openapi": "3.1.0",
+    "components": {
+      "schemas": {
+        "User": {
+          "type": "object",
+          "properties": {
+            "login": {
+              "type": "string"
+            },
+            "password": {
+              "type": "string"
+            },
+            "profile": {
+              "$anchor": "user-profile",
+              "properties": {
+                "firstName": {
+                  "type": "string"
+                },
+                "lastName": {
+                  "type": "string"
+                },
+                "parent": {
+                  "$ref": "/home/smartbear/ex.json#user-profile"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+]
diff --git a/...-1-swagger-client/schema-object/__fixtures__/$anchor-external-circular-structures/ex.json b/...-1-swagger-client/schema-object/__fixtures__/$anchor-external-circular-structures/ex.json
@@ -0,0 +1,18 @@
+{
+  "$defs": {
+    "UserProfile": {
+      "$anchor": "user-profile",
+      "properties": {
+        "firstName": {
+          "type": "string"
+        },
+        "lastName": {
+          "type": "string"
+        },
+        "parent": {
+          "$ref": "#user-profile"
+        }
+      }
+    }
+  }
+}
diff --git a/...-swagger-client/schema-object/__fixtures__/$anchor-external-circular-structures/root.json b/...-swagger-client/schema-object/__fixtures__/$anchor-external-circular-structures/root.json
@@ -0,0 +1,21 @@
+{
+  "openapi": "3.1.0",
+  "components": {
+    "schemas": {
+      "User": {
+        "type": "object",
+        "properties": {
+          "login": {
+            "type": "string"
+          },
+          "password": {
+            "type": "string"
+          },
+          "profile": {
+            "$ref": "./ex.json#user-profile"
+          }
+        }
+      }
+    }
+  }
+}
diff --git a/...-client/schema-object/__fixtures__/$anchor-internal-circular-structures/dereferenced.json b/...-client/schema-object/__fixtures__/$anchor-internal-circular-structures/dereferenced.json
@@ -0,0 +1,48 @@
+[
+  {
+    "openapi": "3.1.0",
+    "components": {
+      "schemas": {
+        "User": {
+          "type": "object",
+          "properties": {
+            "login": {
+              "type": "string"
+            },
+            "password": {
+              "type": "string"
+            },
+            "profile": {
+              "$anchor": "user-profile",
+              "properties": {
+                "firstName": {
+                  "type": "string"
+                },
+                "lastName": {
+                  "type": "string"
+                },
+                "parent": {
+                  "$ref": "/home/smartbear/root.json#user-profile"
+                }
+              }
+            }
+          }
+        },
+        "UserProfile": {
+          "$anchor": "user-profile",
+          "properties": {
+            "firstName": {
+              "type": "string"
+            },
+            "lastName": {
+              "type": "string"
+            },
+            "parent": {
+              "$ref": "/home/smartbear/root.json#user-profile"
+            }
+          }
+        }
+      }
+    }
+  }
+]
diff --git a/...-swagger-client/schema-object/__fixtures__/$anchor-internal-circular-structures/root.json b/...-swagger-client/schema-object/__fixtures__/$anchor-internal-circular-structures/root.json
@@ -0,0 +1,35 @@
+{
+  "openapi": "3.1.0",
+  "components": {
+    "schemas": {
+      "User": {
+        "type": "object",
+        "properties": {
+          "login": {
+            "type": "string"
+          },
+          "password": {
+            "type": "string"
+          },
+          "profile": {
+            "$ref": "#user-profile"
+          }
+        }
+      },
+      "UserProfile": {
+        "$anchor": "user-profile",
+        "properties": {
+          "firstName": {
+            "type": "string"
+          },
+          "lastName": {
+            "type": "string"
+          },
+          "parent": {
+            "$ref": "#user-profile"
+          }
+        }
+      }
+    }
+  }
+}
diff --git a/...er-client/schema-object/__fixtures__/$id-uri-direct-circular-structures/dereferenced.json b/...er-client/schema-object/__fixtures__/$id-uri-direct-circular-structures/dereferenced.json
@@ -0,0 +1,32 @@
+[
+  {
+    "openapi": "3.1.0",
+    "components": {
+      "schemas": {
+        "User": {
+          "type": "object",
+          "properties": {
+            "login": {
+              "type": "string"
+            },
+            "password": {
+              "type": "string"
+            },
+            "profile": {
+              "$id": "./nested/",
+              "type": "object",
+              "properties": {
+                "avatar": {
+                  "type": "string"
+                },
+                "user": {
+                  "$ref": "/home/smartbear/root.json#/components/schemas/User"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+]
diff --git a/...agger-client/schema-object/__fixtures__/$id-uri-direct-circular-structures/nested/ex.json b/...agger-client/schema-object/__fixtures__/$id-uri-direct-circular-structures/nested/ex.json
@@ -0,0 +1,11 @@
+{
+  "type": "object",
+  "properties": {
+    "avatar": {
+      "type": "string"
+    },
+    "user": {
+      "$ref": "../root.json#/components/schemas/User"
+    }
+  }
+}
diff --git a/...-1-swagger-client/schema-object/__fixtures__/$id-uri-direct-circular-structures/root.json b/...-1-swagger-client/schema-object/__fixtures__/$id-uri-direct-circular-structures/root.json
@@ -0,0 +1,22 @@
+{
+  "openapi": "3.1.0",
+  "components": {
+    "schemas": {
+      "User": {
+        "type": "object",
+        "properties": {
+          "login": {
+            "type": "string"
+          },
+          "password": {
+            "type": "string"
+          },
+          "profile": {
+            "$id": "./nested/",
+            "$ref": "./ex.json"
+          }
+        }
+      }
+    }
+  }
+}
diff --git a/...client/schema-object/__fixtures__/$id-uri-enclosing-circular-structures/dereferenced.json b/...client/schema-object/__fixtures__/$id-uri-enclosing-circular-structures/dereferenced.json
@@ -0,0 +1,32 @@
+[
+  {
+    "openapi": "3.1.0",
+    "components": {
+      "schemas": {
+        "User": {
+          "$id": "./nested/",
+          "type": "object",
+          "properties": {
+            "login": {
+              "type": "string"
+            },
+            "password": {
+              "type": "string"
+            },
+            "profile": {
+              "type": "object",
+              "properties": {
+                "avatar": {
+                  "type": "string"
+                },
+                "user": {
+                  "$ref": "/home/smartbear/root.json#/components/schemas/User"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+]
diff --git a/...er-client/schema-object/__fixtures__/$id-uri-enclosing-circular-structures/nested/ex.json b/...er-client/schema-object/__fixtures__/$id-uri-enclosing-circular-structures/nested/ex.json
@@ -0,0 +1,11 @@
+{
+  "type": "object",
+  "properties": {
+    "avatar": {
+      "type": "string"
+    },
+    "user": {
+      "$ref": "../root.json#/components/schemas/User"
+    }
+  }
+}
diff --git a/...swagger-client/schema-object/__fixtures__/$id-uri-enclosing-circular-structures/root.json b/...swagger-client/schema-object/__fixtures__/$id-uri-enclosing-circular-structures/root.json
@@ -0,0 +1,22 @@
+{
+  "openapi": "3.1.0",
+  "components": {
+    "schemas": {
+      "User": {
+        "$id": "./nested/",
+        "type": "object",
+        "properties": {
+          "login": {
+            "type": "string"
+          },
+          "password": {
+            "type": "string"
+          },
+          "profile": {
+            "$ref": "./ex.json"
+          }
+        }
+      }
+    }
+  }
+}
diff --git a/...-client/schema-object/__fixtures__/$id-uri-external-circular-structures/dereferenced.json b/...-client/schema-object/__fixtures__/$id-uri-external-circular-structures/dereferenced.json
@@ -0,0 +1,32 @@
+[
+  {
+    "openapi": "3.1.0",
+    "components": {
+      "schemas": {
+        "User": {
+          "type": "object",
+          "properties": {
+            "login": {
+              "type": "string"
+            },
+            "password": {
+              "type": "string"
+            },
+            "profile": {
+              "$id": "./nested/",
+              "type": "object",
+              "properties": {
+                "avatar": {
+                  "type": "string"
+                },
+                "user": {
+                  "$ref": "/home/smartbear/root.json#/components/schemas/User"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+]
diff --git a/...ger-client/schema-object/__fixtures__/$id-uri-external-circular-structures/nested/ex.json b/...ger-client/schema-object/__fixtures__/$id-uri-external-circular-structures/nested/ex.json
@@ -0,0 +1,8 @@
+{
+  "$defs": {
+    "UserProfile": {
+      "$id": "./nested/",
+      "$ref": "./ex.json"
+    }
+  }
+}
diff --git a/...ent/schema-object/__fixtures__/$id-uri-external-circular-structures/nested/nested/ex.json b/...ent/schema-object/__fixtures__/$id-uri-external-circular-structures/nested/nested/ex.json
@@ -0,0 +1,11 @@
+{
+  "type": "object",
+  "properties": {
+    "avatar": {
+      "type": "string"
+    },
+    "user": {
+      "$ref": "../../root.json#/components/schemas/User"
+    }
+  }
+}
diff --git a/...-swagger-client/schema-object/__fixtures__/$id-uri-external-circular-structures/root.json b/...-swagger-client/schema-object/__fixtures__/$id-uri-external-circular-structures/root.json
@@ -0,0 +1,21 @@
+{
+  "openapi": "3.1.0",
+  "components": {
+    "schemas": {
+      "User": {
+        "type": "object",
+        "properties": {
+          "login": {
+            "type": "string"
+          },
+          "password": {
+            "type": "string"
+          },
+          "profile": {
+            "$ref": "./nested/ex.json#/$defs/UserProfile"
+          }
+        }
+      }
+    }
+  }
+}