feat: add title, summary and description fields to the core models (#315

)
asyncapi · Feb 7, 2023 · 4104cab · 4104cab
1 parent b87f2d3
commit 4104cab
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 4 deletions.
diff --git a/definitions/3.0.0/channel.json b/definitions/3.0.0/channel.json
@@ -20,9 +20,17 @@
         "$ref": "http://asyncapi.com/definitions/3.0.0/parameter.json"
       }
     },
+    "title": {
+      "type": "string",
+      "description": "A human-friendly title for the channel."
+    },
+    "summary": {
+      "type": "string",
+      "description": "A brief summary of the channel."
+    },
     "description": {
       "type": "string",
-      "description": "A description of the channel."
+      "description": "A longer description of the channel. CommonMark is allowed."
     },
     "servers": {
       "type": "array",

diff --git a/definitions/3.0.0/operation.json b/definitions/3.0.0/operation.json
@@ -51,11 +51,17 @@
         ]
       }
     },
+    "title": {
+      "type": "string",
+      "description": "A human-friendly title for the operation."
+    },
     "summary": {
-      "type": "string"
+      "type": "string",
+      "description": "A brief summary of the operation."
     },
     "description": {
-      "type": "string"
+      "type": "string",
+      "description": "A longer description of the operation. CommonMark is allowed."
     },
     "security": {
       "type": "array",

diff --git a/definitions/3.0.0/operationTrait.json b/definitions/3.0.0/operationTrait.json
@@ -13,6 +13,9 @@
     "channel": {
       "$ref": "http://asyncapi.com/definitions/3.0.0/operation.json#/properties/channel"
     },
+    "title": {
+      "$ref": "http://asyncapi.com/definitions/3.0.0/operation.json#/properties/title"
+    },
     "summary": {
       "$ref": "http://asyncapi.com/definitions/3.0.0/operation.json#/properties/summary"
     },

diff --git a/definitions/3.0.0/server.json b/definitions/3.0.0/server.json
@@ -15,8 +15,17 @@
     "url": {
       "type": "string"
     },
+    "title": {
+      "type": "string",
+      "description": "A human-friendly title for the server."
+    },
+    "summary": {
+      "type": "string",
+      "description": "A brief summary of the server."
+    },
     "description": {
-      "type": "string"
+      "type": "string",
+      "description": "A longer description of the server. CommonMark is allowed."
     },
     "protocol": {
       "type": "string",