feat!: add new channels and operations objects (asyncapi#264)

jonaslagoni · Nov 6, 2022 · 928bf91 · 928bf91
1 parent 57f7d7c
commit 928bf91
Show file tree

Hide file tree

Showing 13 changed files with 595 additions and 395 deletions.
diff --git a/definitions/3.0.0/asyncapi.json b/definitions/3.0.0/asyncapi.json
@@ -5,8 +5,7 @@
   "type": "object",
   "required": [
     "asyncapi",
-    "info",
-    "channels"
+    "info"
   ],
   "additionalProperties": false,
   "patternProperties": {
@@ -39,6 +38,9 @@
     "channels": {
       "$ref": "http://asyncapi.com/definitions/3.0.0/channels.json"
     },
+    "operations": {
+      "$ref": "http://asyncapi.com/definitions/3.0.0/operations.json"
+    },
     "components": {
       "$ref": "http://asyncapi.com/definitions/3.0.0/components.json"
     },

diff --git a/definitions/3.0.0/bindingsObject.json b/definitions/3.0.0/bindingsObject.json
@@ -0,0 +1,24 @@
+{
+  "type": "object",
+  "additionalProperties": true,
+  "properties": {
+    "http": {},
+    "ws": {},
+    "amqp": {},
+    "amqp1": {},
+    "mqtt": {},
+    "mqtt5": {},
+    "kafka": {},
+    "anypointmq": {},
+    "nats": {},
+    "jms": {},
+    "sns": {},
+    "sqs": {},
+    "stomp": {},
+    "redis": {},
+    "ibmmq": {},
+    "solace": {}
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "http://asyncapi.com/definitions/3.0.0/bindingsObject.json"
+}
diff --git a/definitions/3.0.0/channelItem.json → definitions/3.0.0/channel.json b/definitions/3.0.0/channelItem.json → definitions/3.0.0/channel.json
@@ -7,8 +7,12 @@
     }
   },
   "properties": {
-    "$ref": {
-      "$ref": "http://asyncapi.com/definitions/3.0.0/ReferenceObject.json"
+    "address": {
+      "type": ["string", "null"],
+      "description": "An optional string representation of this channel's address. The address is typically the \"topic name\", \"routing key\", \"event type\", or \"path\". When `null` or absent, it MUST be interpreted as unknown. This is useful when the address is generated dynamically at runtime or can't be known upfront. It MAY contain Channel Address Expressions."
+    },
+    "messages": {
+      "$ref": "http://asyncapi.com/definitions/3.0.0/channelMessages.json"
     },
     "parameters": {
       "type": "object",
@@ -28,20 +32,20 @@
       },
       "uniqueItems": true
     },
-    "publish": {
-      "$ref": "http://asyncapi.com/definitions/3.0.0/operation.json"
-    },
-    "subscribe": {
-      "$ref": "http://asyncapi.com/definitions/3.0.0/operation.json"
-    },
-    "deprecated": {
-      "type": "boolean",
-      "default": false
-    },
     "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"
+      },
+      "uniqueItems": true
+    },
+    "externalDocs": {
+      "$ref": "http://asyncapi.com/definitions/3.0.0/externalDocs.json"
     }
   },
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "http://asyncapi.com/definitions/3.0.0/channelItem.json"
+  "$id": "http://asyncapi.com/definitions/3.0.0/channel.json"
 }
diff --git a/definitions/3.0.0/channelBindingsObject.json b/definitions/3.0.0/channelBindingsObject.json
@@ -2,7 +2,7 @@
   "type": "object",
   "additionalProperties": false,
   "patternProperties": {
-    "^x-[\\w\\d\\.\\-\\_]+$": {
+    "^x-[\\w\\d\\.\\x2d_]+$": {
       "$ref": "http://asyncapi.com/definitions/3.0.0/specificationExtension.json"
     }
   },

diff --git a/definitions/3.0.0/channelMessages.json b/definitions/3.0.0/channelMessages.json
@@ -0,0 +1,9 @@
+{
+  "type": "object",
+  "additionalProperties": {
+    "$ref": "http://asyncapi.com/definitions/3.0.0/message.json"
+  },
+  "description": "A map of the messages that will be sent to this channel by any application at any time. **Every message sent to this channel MUST be valid against one, and only one, of the message objects defined in this map.**",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "http://asyncapi.com/definitions/3.0.0/channelMessages.json"
+}
diff --git a/definitions/3.0.0/channels.json b/definitions/3.0.0/channels.json
@@ -1,12 +1,10 @@
 {
   "type": "object",
-  "propertyNames": {
-    "type": "string",
-    "format": "uri-template",
-    "minLength": 1
-  },
   "additionalProperties": {
-    "$ref": "http://asyncapi.com/definitions/3.0.0/channelItem.json"
+    "oneOf": [
+      { "$ref": "http://asyncapi.com/definitions/3.0.0/Reference.json" },
+      { "$ref": "http://asyncapi.com/definitions/3.0.0/channel.json" }
+    ]
   },
   "$schema": "http://json-schema.org/draft-07/schema#",
   "$id": "http://asyncapi.com/definitions/3.0.0/channels.json"

diff --git a/definitions/3.0.0/messageBindingsObject.json b/definitions/3.0.0/messageBindingsObject.json
@@ -2,7 +2,7 @@
   "type": "object",
   "additionalProperties": false,
   "patternProperties": {
-    "^x-[\\w\\d\\.\\-\\_]+$": {
+    "^x-[\\w\\d\\.\\x2d_]+$": {
       "$ref": "http://asyncapi.com/definitions/3.0.0/specificationExtension.json"
     }
   },

diff --git a/definitions/3.0.0/operation.json b/definitions/3.0.0/operation.json
@@ -6,7 +6,19 @@
       "$ref": "http://asyncapi.com/definitions/3.0.0/specificationExtension.json"
     }
   },
+  "required": [
+    "action",
+    "channel"
+  ],
   "properties": {
+    "action": {
+      "type": "string",
+      "description": "Allowed values are send and receive. Use send when it's expected that the application will send a message to the given channel, and receive when the application should expect receiving messages from the given channel.",
+      "enum": ["send", "receive"]
+    },
+    "channel": {
+      "$ref": "http://asyncapi.com/definitions/3.0.0/Reference.json"
+    },
     "traits": {
       "type": "array",
       "items": {
@@ -61,14 +73,8 @@
     "externalDocs": {
       "$ref": "http://asyncapi.com/definitions/3.0.0/externalDocs.json"
     },
-    "operationId": {
-      "type": "string"
-    },
     "bindings": {
       "$ref": "http://asyncapi.com/definitions/3.0.0/operationBindingsObject.json"
-    },
-    "message": {
-      "$ref": "http://asyncapi.com/definitions/3.0.0/message.json"
     }
   },
   "$schema": "http://json-schema.org/draft-07/schema#",

diff --git a/definitions/3.0.0/operationBindingsObject.json b/definitions/3.0.0/operationBindingsObject.json
@@ -2,7 +2,7 @@
   "type": "object",
   "additionalProperties": false,
   "patternProperties": {
-    "^x-[\\w\\d\\.\\-\\_]+$": {
+    "^x-[\\w\\d\\.\\x2d_]+$": {
       "$ref": "http://asyncapi.com/definitions/3.0.0/specificationExtension.json"
     }
   },

diff --git a/definitions/3.0.0/operationTrait.json b/definitions/3.0.0/operationTrait.json
@@ -7,33 +7,29 @@
     }
   },
   "properties": {
+    "action": {
+      "$ref": "http://asyncapi.com/definitions/3.0.0/operation.json#/properties/action"
+    },
+    "channel": {
+      "$ref": "http://asyncapi.com/definitions/3.0.0/operation.json#/properties/channel"
+    },
     "summary": {
-      "type": "string"
+      "$ref": "http://asyncapi.com/definitions/3.0.0/operation.json#/properties/summary"
     },
     "description": {
-      "type": "string"
+      "$ref": "http://asyncapi.com/definitions/3.0.0/operation.json#/properties/description"
+    },
+    "security": {
+      "$ref": "http://asyncapi.com/definitions/3.0.0/operation.json#/properties/security"
     },
     "tags": {
-      "type": "array",
-      "items": {
-        "$ref": "http://asyncapi.com/definitions/3.0.0/tag.json"
-      },
-      "uniqueItems": true
+      "$ref": "http://asyncapi.com/definitions/3.0.0/operation.json#/properties/tags"
     },
     "externalDocs": {
-      "$ref": "http://asyncapi.com/definitions/3.0.0/externalDocs.json"
-    },
-    "operationId": {
-      "type": "string"
-    },
-    "security": {
-      "type": "array",
-      "items": {
-        "$ref": "http://asyncapi.com/definitions/3.0.0/SecurityRequirement.json"
-      }
+      "$ref": "http://asyncapi.com/definitions/3.0.0/operation.json#/properties/externalDocs"
     },
     "bindings": {
-      "$ref": "http://asyncapi.com/definitions/3.0.0/operationBindingsObject.json"
+      "$ref": "http://asyncapi.com/definitions/3.0.0/operation.json#/properties/bindings"
     }
   },
   "$schema": "http://json-schema.org/draft-07/schema#",

diff --git a/definitions/3.0.0/operations.json b/definitions/3.0.0/operations.json
@@ -0,0 +1,11 @@
+{
+  "type": "object",
+  "additionalProperties": {
+    "oneOf": [
+      { "$ref": "http://asyncapi.com/definitions/3.0.0/Reference.json" },
+      { "$ref": "http://asyncapi.com/definitions/3.0.0/operation.json" }
+    ]
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "http://asyncapi.com/definitions/3.0.0/operations.json"
+}
diff --git a/definitions/3.0.0/serverBindingsObject.json b/definitions/3.0.0/serverBindingsObject.json
@@ -2,7 +2,7 @@
   "type": "object",
   "additionalProperties": false,
   "patternProperties": {
-    "^x-[\\w\\d\\.\\-\\_]+$": {
+    "^x-[\\w\\d\\.\\x2d_]+$": {
       "$ref": "http://asyncapi.com/definitions/3.0.0/specificationExtension.json"
     }
   },