Skip to content

DEVORTEX-6305: Document jobUids filter on content-assignments account endpoint - #337

Merged
Jackalx merged 2 commits into
masterfrom
devortex-6305-document-content-assignments-jobuids-filter
Sep 15, 2026
Merged

Jackalx merged 2 commits into
masterfrom
devortex-6305-document-content-assignments-jobuids-filter

Conversation

@Jackalx

@Jackalx Jackalx commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Adds the optional jobUids query parameter (array of strings, maxItems: 200) to GET /vendors-api/v2/accounts/{accountUid}/content-assignments in the OpenAPI spec.
  • Corresponds to the vendors-service change in Smartling/vendors-service#731, which added this filter to fix an oversized-response failure (~7.5MB unfiltered payload) for large accounts.
  • The agency (/vendors-api/v2/agencies/{agencyUid}/content-assignments) and Smartling LS content-assignments endpoints also gained the same filter in the linked PR, but neither is present in this public spec today — nothing to update there.

Test plan

  • npm test (swagger-repo validate) — confirmed the same 16 pre-existing validation errors appear identically on master before this change (unrelated endpoints: accounts-api/v2/.../projects, files-api/v2/.../file/import, MTTranslateItemRequest); this change introduces zero new validation errors.
  • npm run build — bundles successfully; verified jobUids appears correctly in the generated web_deploy/swagger.json for getContentAssignmentsByAccount.

Jira: https://smartling.atlassian.net/browse/DEVORTEX-6305

…endpoint

GET /vendors-api/v2/accounts/{accountUid}/content-assignments now
accepts an optional jobUids query parameter (max 200) to filter
results to a bounded set of translation jobs, added to fix an
oversized-response failure for large accounts.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@Jackalx
Jackalx requested a review from maescomua September 14, 2026 18:44
@maescomua

Copy link
Copy Markdown
Contributor

Review summary — jobUids filter documentation

This accurately documents the account-endpoint jobUids param and the maxItems: 200 matches the server-side limit. One gap:

  • The schema declares items: { type: string } with no pattern/maxLength, but the server enforces alphanumeric-only, ≤20 chars per item (400 otherwise). Consumers following only this spec have no way to predict that rejection. Worth adding pattern: "^[A-Za-z0-9]{1,20}$" (or maxLength: 20 at minimum) to match.

No action needed on the agency endpoint — confirmed it was never part of this public spec, consistent with this PR's own description, and DEVORTEX-6305 doesn't ask for it either.

@Jackalx
Jackalx merged commit 6c580e3 into master Sep 15, 2026
1 check passed
@Jackalx
Jackalx deleted the devortex-6305-document-content-assignments-jobuids-filter branch September 15, 2026 11:54
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