fix: callback operation ids #262
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mallachari
commented
Dec 20, 2023
src/oas/operation.ts
Outdated
| @@ -89,6 +89,7 @@ export const transformOasEndpointOperation: TranslateFunction< | |||
| parentId: serviceId, | |||
| method, | |||
| path: name, | |||
| key: key ?? 'unknown', | |||
There was a problem hiding this comment.
Or should we generate random string in that case?
There was a problem hiding this comment.
i think it would have to be something stable. i'm kind of thinking this should throw but @P0lip might have a suggestion
There was a problem hiding this comment.
You can leave an empty key key ?? ''. That's what we do for schemas
mallachari
commented
Dec 20, 2023
| @@ -36,6 +36,7 @@ export interface ITransformEndpointOperationOpts<T extends Fragment> { | |||
| document: T; | |||
| name: string; | |||
| method: string; | |||
| key?: string; | |||
There was a problem hiding this comment.
Needed because transformOas3Operation uses this type
mallachari
requested review from
a team and
daniel-white
and removed request for
a team
src/generators.ts
Outdated
| httpCallbackOperation: (props: Context & { method: string; path: string }) => { | ||
| return join(['http_callback', props.parentId, props.method, props.path]); | ||
| httpCallbackOperation: (props: Context & { method: string; path: string; key: string }) => { | ||
| return join(['http_callback', props.parentId, props.method, props.path, props.key]); |
There was a problem hiding this comment.
lets flip this around so that its between parent and method
daniel-white
approved these changes
Dec 21, 2023
|
🎉 This PR is included in version 7.0.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Addresses: https://github.com/stoplightio/platform-internal/issues/18498
Motivation and Context
Callback ids are currently being generated based on operation method and path. This may lead to duplicated ids in case where one operation has more than one callbacks defined.
Description
Adds additional key property (callback name) when generating ids for callback nodes.
How Has This Been Tested?
Tests updated
Screenshot(s)/recordings(s)
Types of changes
Checklist