Skip to content

feat(API): add uploads array to repo sync import event show response #STRINGS-3739 - #1342

Merged
Efe Bikmaz (bikmazefe) merged 1 commit into
mainfrom
openapi-sync/strings-app-pr-19054
Oct 23, 2026
Merged

Efe Bikmaz (bikmazefe) merged 1 commit into
mainfrom
openapi-sync/strings-app-pr-19054

Conversation

@phrase-bot

Copy link
Copy Markdown
Collaborator

This PR was generated by the openapi-apply agent in response to a
/openapi-sync apply request on
Phrase-Engineering/strings-app#19054.

What changed in the API

  • GET /api/v2/repo_syncs/{repo_sync_id}/events/{id} now returns an uploads field in the response body. When the event has an associated upload batch, uploads is an array of objects each with an id (the upload's public code) and a state (the upload's public state). When no upload batch exists yet, uploads is null. This field appears only on the show response; the index response is unchanged.

Source

Notes for reviewers

  • The uploads field was added to the shared schemas/repo_sync_event.yaml schema (which is also referenced by the index response). The field is optional and nullable, so the index response — which does not include uploads — remains valid against the schema. The description notes that uploads is present on show responses only.
  • The show.yaml operation was also updated to add missing 401 and 403 response codes (absent from the file prior to this PR). The 403 is written inline with a description capturing the three specific conditions: insufficient OAuth scope, disabled gitlab_sync plan feature, or missing read_git_syncs? permission.
  • doc/compiled.json was auto-regenerated by the make bundle step during the pre-merge lint check; it is not a hand-edit.
  • Java was not available in the agent environment, so the openapi-generator-cli validate step in lint.sh fell through to "No validation errors" without actually running the generator validation. npx swagger-cli validate main.yaml passed cleanly.

Opened automatically by the openapi-apply agent. Review the spec changes
against the linked strings-app PR; the agent does not vouch for correctness
beyond "the YAML parsed and the documented layout was followed."

@github-actions

Copy link
Copy Markdown
Contributor

API changelog (oasdiff)

Doc-only edits (descriptions, examples) do not appear here.

6 changes: 0 error, 0 warning, 6 info
info	[response-optional-property-added] at doc/compiled.json
	in API GET /accounts/{account_id}/repo_syncs/{id}/events
		added the optional property `items/uploads` to the response with the `200` status

info	[response-optional-property-added] at doc/compiled.json
	in API POST /accounts/{account_id}/repo_syncs/{id}/export
		added the optional property `uploads` to the response with the `200` status

info	[response-optional-property-added] at doc/compiled.json
	in API POST /accounts/{account_id}/repo_syncs/{id}/import
		added the optional property `uploads` to the response with the `200` status

info	[response-non-success-status-added] at doc/compiled.json
	in API GET /accounts/{account_id}/repo_syncs/{repo_sync_id}/events/{id}
		added the non-success response with the status `401`

info	[response-non-success-status-added] at doc/compiled.json
	in API GET /accounts/{account_id}/repo_syncs/{repo_sync_id}/events/{id}
		added the non-success response with the status `403`

info	[response-optional-property-added] at doc/compiled.json
	in API GET /accounts/{account_id}/repo_syncs/{repo_sync_id}/events/{id}
		added the optional property `uploads` to the response with the `200` status

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants