DOCS-3238 Document Translation Package API (v2) endpoints - #336
Open
dimitrystd wants to merge 3 commits into
Open
DOCS-3238 Document Translation Package API (v2) endpoints#336dimitrystd wants to merge 3 commits into
dimitrystd wants to merge 3 commits into
Conversation
Adds spec/translations/ covering the 7 offline-translation endpoints: create/get translation package, async process status, XLIFF/TMX download, offline-CAT XLIFF import, and recent import status. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
- Rename tag to translations (Translations display name), move it after Translation quality checks, and generalize its description to cover future translations-api endpoints beyond translation packages. - Drop the per-endpoint Limitations block now duplicated at the tag level. - Use TranslationJobUid/WorkflowStepUid schemas instead of bare strings where those identifiers appear. - Recommend generateTmx=false when a TMX file isn't needed. - Fix inaccurate async/sync claims: package creation only resolves string membership synchronously, the XLIFF itself is generated on demand at download time (only TMX generation is actually async), and the get-package readiness poll applies only to the translationMemory link. - Remove extendedMode and userUid from the public content-download endpoint - both were added for internal Smartling tooling (XLIFF metadata export, LQA review of AIT translations) with no customer use case. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Address review feedback: drop parenthetical mentions of Trados, MemoQ, Phrase, and Wordfast in favor of generic "external CAT tools" language. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
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
2 participants
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.
Jira: DOCS-3238 Document Translation Package API (v2) endpoints
Preview
https://api-reference.smartling.com/preview/pr-336/#tag/translations
Test plan
npm testpasses (same pre-existing, unrelated failures as master)npm run buildbundles all 7 new paths and thetranslationstag correctly