-
-
Notifications
You must be signed in to change notification settings - Fork 21
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.
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
fix: disclose limitation about parameter schema reference #192
fix: disclose limitation about parameter schema reference #192
Conversation
just noticed problem is not only with parameters that have schema as reference look at https://github.com/asyncapi/spec/blob/master/examples/rpc-client.yml
v3 conversion makes it at the reason is |
Can only convert to what the spec allows 😄 But yea, agree it's probably a good case for a feature request. For 3.0.0, no, 3.1.0 sure. |
@derberg I still think this should be merged as is, as the other issue you raised does not really affect it 🙂 |
@jonaslagoni yeah, I agree that Anyway I opened an issue in spec repo to make sure other codeowners agree regarding this PR, I still see no change and afaik even though error is spotted, conversion continues, so user still gets empty parameter. We should be super clear in the console info, that was not successfully converted AND resulted in an empty parameter object that user needs to update manually and yeah, we need console.error for |
@derberg I altered the converter to warn the user whenever they use properties in the schema that won't be taken over into the new parameter object, not just for I don't think we need to explain anything in the docs though, because it is not really a missing feature 🤔 The regression should be pretty apparent with the warning I added and the migration guide on the website and release notes 🤷 |
but I had a quick look at asyncapi/website#2008 and there is no mention of parameters and migration related to it, or are my 👁️ wrong |
Nope you right, I missed it 😆 |
I will add it to the migration guide 👍 |
Co-authored-by: Lukasz Gornicki <lpgornicki@gmail.com>
Co-authored-by: Lukasz Gornicki <lpgornicki@gmail.com>
Kudos, SonarCloud Quality Gate passed! 0 Bugs No Coverage information |
/rtm |
🎉 This PR is included in version 1.4.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Description
If a parameter's schema is defined with a reference in v2, it would completely be removed in v3, because we cant manipulate references correctly yet, see #90