feat: adding an example definition that has a circular $ref

readmeio · May 5, 2022 · d29a629 · d29a629
1 parent 2ff6ec4
commit d29a629
Show file tree

Hide file tree

Showing 2 changed files with 103 additions and 0 deletions.
diff --git a/3.0/json/circular.json b/3.0/json/circular.json
@@ -0,0 +1,62 @@
+{
+  "openapi": "3.0.1",
+  "info": {
+    "title": "API definition with a circular $ref",
+    "version": "1.0.0"
+  },
+  "servers": [
+    {
+      "url": "https://httpbin.org"
+    }
+  ],
+  "paths": {
+    "/anything": {
+      "get": {
+        "responses": {
+          "200": {
+            "description": "OK"
+          },
+          "404": {
+            "description": "Not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorMessage"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "ErrorMessage": {
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "statusCode": {
+            "type": "integer",
+            "format": "int32"
+          },
+          "error": {
+            "type": "string",
+            "nullable": true
+          },
+          "inner": {
+            "$ref": "#/components/schemas/ErrorMessage"
+          },
+          "canBeRetried": {
+            "type": "string",
+            "enum": ["Unknown", "Yes", "No"]
+          },
+          "detailedErrorCode": {
+            "type": "integer",
+            "format": "int32"
+          }
+        }
+      }
+    }
+  }
+}
diff --git a/3.0/yaml/circular.yaml b/3.0/yaml/circular.yaml
@@ -0,0 +1,41 @@
+openapi: 3.0.1
+info:
+  title: API definition with a circular $ref
+  version: 1.0.0
+servers:
+  - url: https://httpbin.org
+paths:
+  '/anything':
+    get:
+      responses:
+        '200':
+          description: OK
+        '404':
+          description: Not found
+          content:
+            application/json:
+              schema:
+                '$ref': '#/components/schemas/ErrorMessage'
+components:
+  schemas:
+    ErrorMessage:
+      type: object
+      additionalProperties: false
+      properties:
+        statusCode:
+          type: integer
+          format: int32
+        error:
+          type: string
+          nullable: true
+        inner:
+          '$ref': '#/components/schemas/ErrorMessage'
+        canBeRetried:
+          type: string
+          enum:
+            - Unknown
+            - 'Yes'
+            - 'No'
+        detailedErrorCode:
+          type: integer
+          format: int32