spec
spec copied to clipboard
asyncapi
chore: move root tags and externalDocs to the info object
title: "move root tags and externalDocs to the info object"
This PR moves tags and externalDocs (describing applications) from root to the Info Object. From an application description point of view, this makes much more sense, because all the metadata is in one place. This is more of a stylistic change, however it introduces a breaking change.
Kudos, SonarCloud Quality Gate passed! 
0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells
No Coverage information
No Duplication information
![sonarqubecloud[bot] avatar](https://avatars.githubusercontent.com/in/12526?v=4 "Published by a pub.dev verified publisher"){kind=small}
@dalelane Thanks for your comment! I don't think it causes incompatibility with OpenAPI, because e.g. from the beginning tags in AsyncAPI are used in a different way than in OpenAPI. In OpenAPI you define tags as objects on the root, and in operations you refer to them only by name. In AsyncAPI tags as objects can be used in all places where tags may occur. The only problem may arise if someone wants to refer an Info Object from AsyncAPI in OpenAPI, then yes, this will be a problem, because the validation should inform about the use of additional fields that are not supported (tags and externalDocs).
@KhudaDad414 Could you check the failing Check Markdown links job? I guess that after merging it https://github.com/asyncapi/spec/commit/f269234668a63653616ff7b3fc9a6b249c73ee5b it should be fixed, but it's not. Please correct me if I'm wrong.
Is anything stopping us from merging this? 🤔
I guess the approval from the rest of the owners, e.g. @derberg @dalelane
@jonaslagoni
Is anything stopping us from merging this? 🤔
yes, failing Check Markdown links job 😄 But perhaps one of the maintainers can merge it with admin privileges.
I thought that problem was resolved by this PR https://github.com/asyncapi/spec/commit/f269234668a63653616ff7b3fc9a6b249c73ee5b but unfortunately no.
I don't think the problem is actually with the links being broken - the errors are all HTTP-429 - essentially GitHub complaining about too many requests coming too quickly.
the errors are all HTTP-429
Ideally, the action would accept a header with a valid GH token, so request rate can be higher than actually needed. However there is no such option afaik. We can fix it by follow their recommendations at: https://github.com/gaurav-nelson/github-action-markdown-link-check#too-many-requests
@derberg
we need changes in JSON Schema and the Parser
I will create PR for json-schemas. For parser the current "changes" in spec is reflected in the next parserJS version - https://github.com/asyncapi/parser-js/blob/next-major/src/models/v2/info.ts#L64 You can see that it's for 2.X.X, but due to fact that we don't know how 3.0.0 finally will look like the models are only made for version 2.X.X.
Changes in json-schemas https://github.com/asyncapi/spec-json-schemas/pull/244
Kudos, SonarCloud Quality Gate passed!
0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells
No Coverage information
No Duplication information
Rebased with current next-major-spec. Could you check again? @derberg @fmvilas @dalelane Thanks!
Kudos, SonarCloud Quality Gate passed!
0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells
No Coverage information
No Duplication information
I had to rebase with upstream next-major-spec. Could you check again and merge? Thanks! @derberg @fmvilas @dalelane @smoya @char0n
@magicmatatjahu do you want to merge using /rtm or want us to avoid Squash and Merge?
@fmvilas by /rtm but I will wait for another accepts (at least two more).
@derberg /rtm doesn't work because you added dnm label. Could you merge it?
:tada: This PR is included in version 3.0.0-next-major-spec.4 :tada:
The release is available on GitHub release
Your semantic-release bot :package::rocket:
