Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from
Feb 7, 2023
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion definitions/3.0.0/channel.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
10 changes: 8 additions & 2 deletions definitions/3.0.0/operation.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
3 changes: 3 additions & 0 deletions definitions/3.0.0/operationTrait.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
},
Expand Down
11 changes: 10 additions & 1 deletion definitions/3.0.0/server.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down