feat(openapi): adding a command to resolve circular and recursive references

__tests__/__fixtures__/circular-references-oas/circular-references-resolved.json

@@ -0,0 +1,76 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "title": "Cyclic Reference Example",
+    "version": "1.0.0"
+  },
+  "paths": {
+    "/example": {
+      "get": {
+        "summary": "Example endpoint with cyclic references",
+        "responses": {
+          "200": {
+            "description": "Successful response"
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "ObjectC": {
+        "type": "object",
+        "properties": {
+          "test": {
+            "type": "string"
+          }
+        }
+      },
+      "ObjectA": {
+        "type": "object",
+        "properties": {
+          "test": {
+            "type": "string"
+          },
+          "relatedObject": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ObjectB"
+            }
+          }
+        }
+      },
+      "ObjectB": {
+        "type": "object",
+        "properties": {
+          "test": {
+            "type": "string"
+          },
+          "relatedObject": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ObjectARef"
+            }
+          },
+          "test2": {
+            "$ref": "#/components/schemas/ObjectC"
+          }
+        }
+      },
+      "ObjectARef": {
+        "type": "object",
+        "properties": {
+          "test": {
+            "type": "string"
+          },
+          "relatedObject": {
+            "type": "array",
+            "items": {
+              "type": "object"
+            }
+          }
+        }
+      }
+    }
+  }
+}

__tests__/__fixtures__/circular-references-oas/circular-references.json

@@ -0,0 +1,62 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "title": "Cyclic Reference Example",
+    "version": "1.0.0"
+  },
+  "paths": {
+    "/example": {
+      "get": {
+        "summary": "Example endpoint with cyclic references",
+        "responses": {
+          "200": {
+            "description": "Successful response"
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "ObjectC": {
+        "type": "object",
+        "properties": {
+          "test": {
+            "type": "string"
+          }
+        }
+      },
+      "ObjectA": {
+        "type": "object",
+        "properties": {
+          "test": {
+            "type": "string"
+          },
+          "relatedObject": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ObjectB"
+            }
+          }
+        }
+      },
+      "ObjectB": {
+        "type": "object",
+        "properties": {
+          "test": {
+            "type": "string"
+          },
+          "relatedObject": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ObjectA"
+            }
+          },
+          "test2": {
+            "$ref": "#/components/schemas/ObjectC"
+          }
+        }
+      }
+    }
+  }
+}

__tests__/__fixtures__/circular-references-oas/recursive-reference-resolved.json

@@ -0,0 +1,51 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "title": "Recursive Reference Example",
+    "version": "1.0.0"
+  },
+  "paths": {
+    "/example": {
+      "get": {
+        "summary": "Example endpoint with cyclic references",
+        "responses": {
+          "200": {
+            "description": "Successful response"
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "ObjectB": {
+        "type": "object",
+        "properties": {
+          "test": {
+            "type": "string"
+          },
+          "relatedObject": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ObjectBRef"
+            }
+          }
+        }
+      },
+      "ObjectBRef": {
+        "type": "object",
+        "properties": {
+          "test": {
+            "type": "string"
+          },
+          "relatedObject": {
+            "type": "array",
+            "items": {
+              "type": "object"
+            }
+          }
+        }
+      }
+    }
+  }
+}

__tests__/__fixtures__/circular-references-oas/recursive-reference.json

@@ -0,0 +1,37 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "title": "Recursive Reference Example",
+    "version": "1.0.0"
+  },
+  "paths": {
+    "/example": {
+      "get": {
+        "summary": "Example endpoint with cyclic references",
+        "responses": {
+          "200": {
+            "description": "Successful response"
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "ObjectB": {
+        "type": "object",
+        "properties": {
+          "test": {
+            "type": "string"
+          },
+          "relatedObject": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ObjectB"
+            }
+          }
+        }
+      }
+    }
+  }
+}

__tests__/__fixtures__/circular-references-oas/unresolvable-circular-reference-resolved.json

@@ -0,0 +1,67 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "title": "Complex Cyclic Example",
+    "version": "1.0.0"
+  },
+  "paths": {
+    "/example": {
+      "get": {
+        "summary": "Example endpoint with unresolved references",
+        "responses": {
+          "200": {
+            "description": "Successful response"
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "Entity": {
+        "type": "object",
+        "properties": {
+          "relatedEntity": {
+            "$ref": "#/components/schemas/RelatedEntity"
+          },
+          "Entity": {
+            "$ref": "#/components/schemas/EntityRef"
+          }
+        }
+      },
+      "RelatedEntity": {
+        "type": "object",
+        "properties": {
+          "entity": {
+            "$ref": "#/components/schemas/EntityRef"
+          },
+          "RelatedEntity": {
+            "$ref": "#/components/schemas/RelatedEntityRef"
+          }
+        }
+      },
+      "RelatedEntityRef": {
+        "type": "object",
+        "properties": {
+          "entity": {
+            "type": "object"
+          },
+          "RelatedEntity": {
+            "type": "object"
+          }
+        }
+      },
+      "EntityRef": {
+        "type": "object",
+        "properties": {
+          "relatedEntity": {
+            "$ref": "#/components/schemas/RelatedEntityRef"
+          },
+          "Entity": {
+            "type": "object"
+          }
+        }
+      }
+    }
+  }
+}

__tests__/__fixtures__/circular-references-oas/unresolvable-circular-references.json

@@ -0,0 +1,45 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "title": "Complex Cyclic Example",
+    "version": "1.0.0"
+  },
+  "paths": {
+    "/example": {
+      "get": {
+        "summary": "Example endpoint with unresolved references",
+        "responses": {
+          "200": {
+            "description": "Successful response"
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "Entity": {
+        "type": "object",
+        "properties": {
+          "relatedEntity": {
+            "$ref": "#/components/schemas/RelatedEntity"
+          },
+          "Entity": {
+            "$ref": "#/components/schemas/Entity"
+          }
+        }
+      },
+      "RelatedEntity": {
+        "type": "object",
+        "properties": {
+          "entity": {
+            "$ref": "#/components/schemas/Entity"
+          },
+          "RelatedEntity": {
+            "$ref": "#/components/schemas/RelatedEntity"
+          }
+        }
+      }
+    }
+  }
+}