-
Notifications
You must be signed in to change notification settings - Fork 7
feat(API): Add create comparison endpoint for branches [SCD-549] #966
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
base: main
Are you sure you want to change the base?
Conversation
5b48b1d to
93ec4fc
Compare
doc/compiled.json
Outdated
| } | ||
| ], | ||
| "responses": { | ||
| "200": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
does API ever return 200 here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah it used to, but not anymore since we dropped the async switch param. Good catch, thanks!
| } | ||
| ], | ||
| "requestBody": { | ||
| "required": true, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is this required, considering that the only parameter is optional?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's not , but the pipeline is failing when this is set to false, I don't remember the exact location of the failure but I can trigger it again. I think that's why we don't have any required: false under requestBody in .yml files (at least I don't see any). I guess we'd need to check this separately 😬
| summary: Create comparison (async.) | ||
| description: | | ||
| Create a branch comparison asynchronously. | ||
| operationId: branch/create_comparison |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This command looks a bit different than our other commands. Maybe branch/comparison/create would work too?
Add create comparison endpoint for branches
https://phrase.atlassian.net/browse/SCD-549