Repository navigation
feat(API): add uploads array to repo sync import event show response #STRINGS-3739 - #1342
Merged
Merged
Conversation
Contributor
API changelog (oasdiff)Doc-only edits (descriptions, examples) do not appear here. |
Efe Bikmaz (bikmazefe)
approved these changes
Oct 23, 2026
This was referenced Oct 23, 2026
This file contains hidden or 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
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.
This PR was generated by the
openapi-applyagent in response to a/openapi-sync applyrequest onPhrase-Engineering/strings-app#19054.
What changed in the API
GET /api/v2/repo_syncs/{repo_sync_id}/events/{id}now returns anuploadsfield in the response body. When the event has an associated upload batch,uploadsis an array of objects each with anid(the upload's public code) and astate(the upload's public state). When no upload batch exists yet,uploadsisnull. This field appears only on theshowresponse; theindexresponse is unchanged.Source
Notes for reviewers
uploadsfield was added to the sharedschemas/repo_sync_event.yamlschema (which is also referenced by theindexresponse). The field is optional and nullable, so the index response — which does not includeuploads— remains valid against the schema. The description notes thatuploadsis present on show responses only.show.yamloperation was also updated to add missing401and403response codes (absent from the file prior to this PR). The403is written inline with a description capturing the three specific conditions: insufficient OAuth scope, disabledgitlab_syncplan feature, or missingread_git_syncs?permission.doc/compiled.jsonwas auto-regenerated by themake bundlestep during the pre-merge lint check; it is not a hand-edit.openapi-generator-cli validatestep inlint.shfell through to "No validation errors" without actually running the generator validation.npx swagger-cli validate main.yamlpassed cleanly.Opened automatically by the
openapi-applyagent. Review the spec changesagainst the linked strings-app PR; the agent does not vouch for correctness
beyond "the YAML parsed and the documented layout was followed."