feat: add all{components} functions #969
Conversation
KhudaDad414
requested review from
magicmatatjahu,
jonaslagoni,
smoya and
asyncapi-bot-eve
as code owners
| allServerVariables(): ServerVariablesInterface; | ||
| allParameters(): ChannelParametersInterface; | ||
| allCorrelationIds(): CorrelationIdsInterface; | ||
| allTags(): TagsInterface; |
There was a problem hiding this comment.
There was a problem hiding this comment.
@smoya I'm a little confused about where to add the allReplies function. If I add it here, then v2 also needs to implement it. But v2 doesn't have replies. I see three possible approaches:
- Remove
allRepliesfromparser-apisince it can't be implemented for v2. - Add it here and return an empty array for the v2 implementation.
- Add
allRepliesto v3 only.
I would appreciate some insight on this.
|
|
||
| import type { v3 } from '../../spec-types'; | ||
|
|
||
| export class AsyncAPIDocument extends BaseModel<v3.AsyncAPIObject> implements AsyncAPIDocumentInterface { | ||
| allSecuritySchemes(): SecuritySchemesInterface { | ||
| return this.securitySchemes(); |
There was a problem hiding this comment.
I see two issues here:
- If
allSecuritySchemesdoes the same assecuritySchemes, then this is redundant. - I believe
securitySchemesmethod implementation is wrong ATM because it is only returning Security Schemes fromcomponentsbut instead would need to return from, for example, Operations in the root document.
cc @jonaslagoni please double 👀 just in case I'm delirious.
There was a problem hiding this comment.
- If
allSecuritySchemesdoes the same assecuritySchemes, then this is redundant.
I agree. it has only been added for the sake of completeness.
- I believe
securitySchemesmethod implementation is wrong ATM because it is only returning Security Schemes fromcomponentsbut instead would need to return from, for example, Operations in the root document.
the problem is that when I try to access the security scheme of an specific operation or operationTrait it returns SecurityRequirements[] instead of SecuritySchemes.
not sure if this is a bug or I am missing something.
|
|
Description