feat: add object descriptions and examples #425
Conversation
AceTheCreator
requested review from
fmvilas,
derberg,
dalelane,
smoya,
char0n and
asyncapi-bot-eve
as code owners
|
@AceTheCreator the quality of this PR is questionable 😆 |
|
@AceTheCreator you are targeting the wrong branch I think 🤔 |
In what way? 😅 |
You're right 😄 |
|
@AceTheCreator there was a lot of strange commits, over 150 files modified, and sonar failing 😛 but now I see some stuff was related to wrong target branch still you have some unrelated changes:
|
|
Updated the PR @derberg |
|
did you follow https://github.com/asyncapi/spec-json-schemas#schemastore-compatibility-testing procedure locally to make sure new descriptions and examples are good and display properly in IDE? |
I tested it locally, and it works as expected, but I noticed the examples property doesn't display well. But keep in mind that it's the same for version 2.6.0, which means that the yaml-server-language hover feat that helps prettify example objects is broken somehow. I opened an issue there, and you can find it here redhat-developer/yaml-language-server#928 |
derberg
changed the title
| "type": "string" | ||
| } | ||
| "type": "string", | ||
| "description": "A short description for security scheme." |
There was a problem hiding this comment.
Not sure how this is handled at CI but this indentation is wrong. There are others as well, so please check 🙏
|
Conflict resolved! cc @derberg |
|
Kudos, SonarCloud Quality Gate passed!
|
There was a problem hiding this comment.
Hi @AceTheCreator,
After I've realized that custom dialect example keyword is later translated by tooling to examples keyword, the PR looks good to me. Nice job!
One thing I've noticed is that references are being made to http://asyncapi.com/definitions/3.0.0/ReferenceObject.json, but file with this name doesn't exist. Nevertheless referencing ReferenceObject.json existed in the code before your PR, so just pointing it out.
Do you mean the URL? if yes, then it's because we are still on the next-major-spec branch and not the master(at least I think). So the /3.0.0 isn't available yet. thoughts @derberg ? |
|
yup, entire 3.0 is on feature branch, so after release/merge, these links will work just fine, I think 😃 |
|
/rtm @AceTheCreator thanks mate, this is huge!!! |
|
🎉 This PR is included in version 6.0.0-next-major-spec.14 🎉 The release is available on: Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 6.0.0-next-major-spec.15 🎉 The release is available on: Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 6.0.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
This PR adds descriptions and examples to version 3.0.0 of the Schema
cc @derberg @jonaslagoni