feat: add reusable tags and externalDocs objects (#245)

asyncapi · Feb 7, 2023 · 290bbf5 · 290bbf5
1 parent a74c78f
commit 290bbf5
Show file tree

Hide file tree

Showing 10 changed files with 149 additions and 25 deletions.
diff --git a/definitions/3.0.0/asyncapi.json b/definitions/3.0.0/asyncapi.json
@@ -43,16 +43,6 @@
     },
     "components": {
       "$ref": "http://asyncapi.com/definitions/3.0.0/components.json"
-    },
-    "tags": {
-      "type": "array",
-      "items": {
-        "$ref": "http://asyncapi.com/definitions/3.0.0/tag.json"
-      },
-      "uniqueItems": true
-    },
-    "externalDocs": {
-      "$ref": "http://asyncapi.com/definitions/3.0.0/externalDocs.json"
     }
   }
 }
diff --git a/definitions/3.0.0/channel.json b/definitions/3.0.0/channel.json
@@ -37,18 +37,32 @@
       },
       "uniqueItems": true
     },
-    "bindings": {
-      "$ref": "http://asyncapi.com/definitions/3.0.0/channelBindingsObject.json"
-    },
     "tags": {
       "type": "array",
       "items": {
-        "$ref": "http://asyncapi.com/definitions/3.0.0/tag.json"
+        "oneOf": [
+          {
+            "$ref": "http://asyncapi.com/definitions/3.0.0/Reference.json"
+          },
+          {
+            "$ref": "http://asyncapi.com/definitions/3.0.0/tag.json"
+          }
+        ]
       },
       "uniqueItems": true
     },
     "externalDocs": {
-      "$ref": "http://asyncapi.com/definitions/3.0.0/externalDocs.json"
+      "oneOf": [
+        {
+          "$ref": "http://asyncapi.com/definitions/3.0.0/Reference.json"
+        },
+        {
+          "$ref": "http://asyncapi.com/definitions/3.0.0/externalDocs.json"
+        }
+      ]
+    },
+    "bindings": {
+      "$ref": "http://asyncapi.com/definitions/3.0.0/channelBindingsObject.json"
     }
   },
   "$schema": "http://json-schema.org/draft-07/schema#",

diff --git a/definitions/3.0.0/components.json b/definitions/3.0.0/components.json
@@ -91,6 +91,32 @@
       "additionalProperties": {
         "$ref": "http://asyncapi.com/definitions/3.0.0/messageBindingsObject.json"
       }
+    },
+    "tags": {
+      "type": "object",
+      "additionalProperties": {
+        "oneOf": [
+          {
+            "$ref": "http://asyncapi.com/definitions/3.0.0/Reference.json"
+          },
+          {
+            "$ref": "http://asyncapi.com/definitions/3.0.0/tag.json"
+          }
+        ]
+      }
+    },
+    "externalDocs": {
+      "type": "object",
+      "additionalProperties": {
+        "oneOf": [
+          {
+            "$ref": "http://asyncapi.com/definitions/3.0.0/Reference.json"
+          },
+          {
+            "$ref": "http://asyncapi.com/definitions/3.0.0/externalDocs.json"
+          }
+        ]
+      }
     }
   },
   "$schema": "http://json-schema.org/draft-07/schema#",

diff --git a/definitions/3.0.0/info.json b/definitions/3.0.0/info.json
@@ -38,12 +38,26 @@
     "tags": {
       "type": "array",
       "items": {
-        "$ref": "http://asyncapi.com/definitions/3.0.0/tag.json"
+        "oneOf": [
+          {
+            "$ref": "http://asyncapi.com/definitions/3.0.0/Reference.json"
+          },
+          {
+            "$ref": "http://asyncapi.com/definitions/3.0.0/tag.json"
+          }
+        ]
       },
       "uniqueItems": true
     },
     "externalDocs": {
-      "$ref": "http://asyncapi.com/definitions/3.0.0/externalDocs.json"
+      "oneOf": [
+        {
+          "$ref": "http://asyncapi.com/definitions/3.0.0/Reference.json"
+        },
+        {
+          "$ref": "http://asyncapi.com/definitions/3.0.0/externalDocs.json"
+        }
+      ]
     }
   },
   "$schema": "http://json-schema.org/draft-07/schema#",

diff --git a/definitions/3.0.0/message.json b/definitions/3.0.0/message.json
@@ -66,7 +66,14 @@
             "tags": {
               "type": "array",
               "items": {
-                "$ref": "http://asyncapi.com/definitions/3.0.0/tag.json"
+                "oneOf": [
+                  {
+                    "$ref": "http://asyncapi.com/definitions/3.0.0/Reference.json"
+                  },
+                  {
+                    "$ref": "http://asyncapi.com/definitions/3.0.0/tag.json"
+                  }
+                ]
               },
               "uniqueItems": true
             },
@@ -87,7 +94,14 @@
               "description": "A longer description of the message. CommonMark is allowed."
             },
             "externalDocs": {
-              "$ref": "http://asyncapi.com/definitions/3.0.0/externalDocs.json"
+              "oneOf": [
+                {
+                  "$ref": "http://asyncapi.com/definitions/3.0.0/Reference.json"
+                },
+                {
+                  "$ref": "http://asyncapi.com/definitions/3.0.0/externalDocs.json"
+                }
+              ]
             },
             "deprecated": {
               "type": "boolean",

diff --git a/definitions/3.0.0/messageTrait.json b/definitions/3.0.0/messageTrait.json
@@ -43,7 +43,14 @@
     "tags": {
       "type": "array",
       "items": {
-        "$ref": "http://asyncapi.com/definitions/3.0.0/tag.json"
+        "oneOf": [
+          {
+            "$ref": "http://asyncapi.com/definitions/3.0.0/Reference.json"
+          },
+          {
+            "$ref": "http://asyncapi.com/definitions/3.0.0/tag.json"
+          }
+        ]
       },
       "uniqueItems": true
     },
@@ -64,7 +71,14 @@
       "description": "A longer description of the message. CommonMark is allowed."
     },
     "externalDocs": {
-      "$ref": "http://asyncapi.com/definitions/3.0.0/externalDocs.json"
+      "oneOf": [
+        {
+          "$ref": "http://asyncapi.com/definitions/3.0.0/Reference.json"
+        },
+        {
+          "$ref": "http://asyncapi.com/definitions/3.0.0/externalDocs.json"
+        }
+      ]
     },
     "deprecated": {
       "type": "boolean",

diff --git a/definitions/3.0.0/operation.json b/definitions/3.0.0/operation.json
@@ -69,12 +69,26 @@
     "tags": {
       "type": "array",
       "items": {
-        "$ref": "http://asyncapi.com/definitions/3.0.0/tag.json"
+        "oneOf": [
+          {
+            "$ref": "http://asyncapi.com/definitions/3.0.0/Reference.json"
+          },
+          {
+            "$ref": "http://asyncapi.com/definitions/3.0.0/tag.json"
+          }
+        ]
       },
       "uniqueItems": true
     },
     "externalDocs": {
-      "$ref": "http://asyncapi.com/definitions/3.0.0/externalDocs.json"
+      "oneOf": [
+        {
+          "$ref": "http://asyncapi.com/definitions/3.0.0/Reference.json"
+        },
+        {
+          "$ref": "http://asyncapi.com/definitions/3.0.0/externalDocs.json"
+        }
+      ]
     },
     "bindings": {
       "$ref": "http://asyncapi.com/definitions/3.0.0/operationBindingsObject.json"

diff --git a/definitions/3.0.0/schema.json b/definitions/3.0.0/schema.json
@@ -84,7 +84,14 @@
           "type": "string"
         },
         "externalDocs": {
-          "$ref": "http://asyncapi.com/definitions/3.0.0/externalDocs.json"
+          "oneOf": [
+            {
+              "$ref": "http://asyncapi.com/definitions/3.0.0/Reference.json"
+            },
+            {
+              "$ref": "http://asyncapi.com/definitions/3.0.0/externalDocs.json"
+            }
+          ]
         },
         "deprecated": {
           "type": "boolean",

diff --git a/definitions/3.0.0/server.json b/definitions/3.0.0/server.json
@@ -40,6 +40,30 @@
     "security": {
       "$ref": "http://asyncapi.com/definitions/3.0.0/securityRequirements.json"
     },
+    "tags": {
+      "type": "array",
+      "items": {
+        "oneOf": [
+          {
+            "$ref": "http://asyncapi.com/definitions/3.0.0/Reference.json"
+          },
+          {
+            "$ref": "http://asyncapi.com/definitions/3.0.0/tag.json"
+          }
+        ]
+      },
+      "uniqueItems": true
+    },
+    "externalDocs": {
+      "oneOf": [
+        {
+          "$ref": "http://asyncapi.com/definitions/3.0.0/Reference.json"
+        },
+        {
+          "$ref": "http://asyncapi.com/definitions/3.0.0/externalDocs.json"
+        }
+      ]
+    },
     "bindings": {
       "$ref": "http://asyncapi.com/definitions/3.0.0/serverBindingsObject.json"
     }

diff --git a/definitions/3.0.0/tag.json b/definitions/3.0.0/tag.json
@@ -12,7 +12,14 @@
       "type": "string"
     },
     "externalDocs": {
-      "$ref": "http://asyncapi.com/definitions/3.0.0/externalDocs.json"
+      "oneOf": [
+        {
+          "$ref": "http://asyncapi.com/definitions/3.0.0/Reference.json"
+        },
+        {
+          "$ref": "http://asyncapi.com/definitions/3.0.0/externalDocs.json"
+        }
+      ]
     }
   },
   "patternProperties": {