Skip to content

Commit 4104cab

Browse files
feat: add title, summary and description fields to the core models (#315)
1 parent b87f2d3 commit 4104cab

File tree

4 files changed

+30
-4
lines changed

4 files changed

+30
-4
lines changed

definitions/3.0.0/channel.json

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,17 @@
2020
"$ref": "http://asyncapi.com/definitions/3.0.0/parameter.json"
2121
}
2222
},
23+
"title": {
24+
"type": "string",
25+
"description": "A human-friendly title for the channel."
26+
},
27+
"summary": {
28+
"type": "string",
29+
"description": "A brief summary of the channel."
30+
},
2331
"description": {
2432
"type": "string",
25-
"description": "A description of the channel."
33+
"description": "A longer description of the channel. CommonMark is allowed."
2634
},
2735
"servers": {
2836
"type": "array",

definitions/3.0.0/operation.json

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,17 @@
5151
]
5252
}
5353
},
54+
"title": {
55+
"type": "string",
56+
"description": "A human-friendly title for the operation."
57+
},
5458
"summary": {
55-
"type": "string"
59+
"type": "string",
60+
"description": "A brief summary of the operation."
5661
},
5762
"description": {
58-
"type": "string"
63+
"type": "string",
64+
"description": "A longer description of the operation. CommonMark is allowed."
5965
},
6066
"security": {
6167
"type": "array",

definitions/3.0.0/operationTrait.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@
1313
"channel": {
1414
"$ref": "http://asyncapi.com/definitions/3.0.0/operation.json#/properties/channel"
1515
},
16+
"title": {
17+
"$ref": "http://asyncapi.com/definitions/3.0.0/operation.json#/properties/title"
18+
},
1619
"summary": {
1720
"$ref": "http://asyncapi.com/definitions/3.0.0/operation.json#/properties/summary"
1821
},

definitions/3.0.0/server.json

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,17 @@
1515
"url": {
1616
"type": "string"
1717
},
18+
"title": {
19+
"type": "string",
20+
"description": "A human-friendly title for the server."
21+
},
22+
"summary": {
23+
"type": "string",
24+
"description": "A brief summary of the server."
25+
},
1826
"description": {
19-
"type": "string"
27+
"type": "string",
28+
"description": "A longer description of the server. CommonMark is allowed."
2029
},
2130
"protocol": {
2231
"type": "string",

0 commit comments

Comments
 (0)