feat: add extensive descriptions and examples to the schema v2.6.0 #394
Conversation
AceTheCreator
requested review from
fmvilas,
derberg,
dalelane,
smoya,
char0n and
asyncapi-bot-eve
as code owners
|
so I ran your script and it looks good, the info examples is added 
|
| @@ -13,38 +13,48 @@ | |||
| }, | |||
| "properties": { | |||
| "url": { | |||
| "type": "string" | |||
| "type": "string", | |||
| "description": "A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the AsyncAPI document is being served." | |||
There was a problem hiding this comment.
I don't agree that we should call this a URL, but I'm being a pedant... plus that's already in https://github.com/asyncapi/spec/blob/master/spec/asyncapi.md#server-object so this isn't the PR to fix that in :-)
…r/spec-json-schemas into 2.6.0-schema-update
…r/spec-json-schemas into 2.6.0-schema-update
There was a problem hiding this comment.
it works well in VSCode ❤️
examples are not super nice as they are stringified
but it is because of yaml extension and https://github.com/redhat-developer/yaml-language-server/blob/main/src/languageservice/services/yamlHover.ts#L156 that should be updated to JSON.stringify(example, null, 4)
you only forgot about description for message definition
There was a problem hiding this comment.
it works well in VSCode ❤️
examples are not super nice as they are stringified
but it is because of yaml extension and https://github.com/redhat-developer/yaml-language-server/blob/main/src/languageservice/services/yamlHover.ts#L156 that should be updated to JSON.stringify(example, null, 4)
you only forgot about description for message definition
There was a problem hiding this comment.
also missing description in definitions/2.6.0/license.json
definitions/2.6.0/components.json do not match spec https://www.asyncapi.com/docs/reference/specification/v2.6.0#componentsObject
and yeah, message
| @@ -1,6 +1,6 @@ | |||
| { | |||
| "type": "object", | |||
| "description": "An object representing a Server.", | |||
| "description": "An object representing a message broker, a server or any other kind of computer program capable of sending and/or receiving data", | |||
There was a problem hiding this comment.
there is longer description in the spec
| @@ -11,6 +11,9 @@ | |||
| } | |||
| ] | |||
| }, | |||
| "example": { | |||
There was a problem hiding this comment.
the description of servers do not match spec
There was a problem hiding this comment.
also missing description in definitions/2.6.0/license.json
definitions/2.6.0/components.json do not match spec https://www.asyncapi.com/docs/reference/specification/v2.6.0#componentsObject
and yeah, message
derberg
changed the title
|
/rtm |
|
🎉 This PR is included in version 5.1.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
|
Kudos, SonarCloud Quality Gate passed!
|
So I decided to enhance the spec-json-schema to include additional info and examples. This will enable tools like Studio, spec-visualizer and vscode to have the ability to get more information when consuming the spec-json-schema
cc @derberg @smoya @fmvilas