fix: channel parameter not always returning schema #868
Conversation
jonaslagoni
requested review from
fmvilas,
magicmatatjahu,
smoya and
asyncapi-bot-eve
as code owners
| const doc = serializeInput<v3.ParameterObject>({}); | ||
| const d = new ChannelParameter(doc); | ||
| expect(d.hasSchema()).toEqual(false); | ||
| expect(d.hasSchema()).toEqual(true); |
There was a problem hiding this comment.
I agree with the other change but this one is highly debatable. "hasSchema" is meant to tell you if the document has the schema specified, therefore it should be false. However, even though it's false, you should get a default schema in the "schema()" call. These are two different things IMHO.
There was a problem hiding this comment.
But for v3, you will always have a schema (underneath) as the default behavior is that the parameters are of type: string 🤔 Regardless of what else you define in your parameter.
For v2 it makes sense.
There was a problem hiding this comment.
As @fmvilas mentioned, hasSchema is there for answering: Did the user set the schema?
There was a problem hiding this comment.
But for v3 the schema is always set, even when an empty parameter is defined.
There was a problem hiding this comment.
What I mean is if the user has set the schema key. hasSchema answers that question. If the schema key is there, then hasSchema is true, otherwise it's false. Now, the schema() call will always give you a schema because it has a default. Does that make sense?
There was a problem hiding this comment.
Alright, discussed offline and this is fine. On v3, there's no schema keyword anymore so it should always be true.
There was a problem hiding this comment.
But for v3, you will always have a schema (underneath) as the default behavior is that the parameters are of
type: string🤔 Regardless of what else you define in your parameter.For v2 it makes sense.
Oh yeah its true😅
|
/rtm |
|
Kudos, SonarCloud Quality Gate passed!
|
|
🎉 This PR is included in version 3.0.0-next-major-spec.5 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Description
One thing that I found weird while working on asyncapi/markdown-template#360 was that parameter schemas could be undefined with v3 🤔
Cause it should always at least have the schema
{type: "string"}and then the rest is optional.