feat: Document translation memory management endpoints - #418
feat: Document translation memory management endpoints#418BriannaDelgado wants to merge 3 commits into
Conversation
Add API reference pages for retrieving, listing segments, importing, exporting, deleting translation memories, and polling import/export jobs. Updates the OpenAPI spec, navigation, permission scopes, and release notes to match. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
|
||
| <Steps> | ||
| <Step title="Create the import job"> | ||
| Send the file's name and size in bytes. The response returns the `job_id`, the `upload_url`, and the `expires_at` deadline for the upload. |
There was a problem hiding this comment.
Should we document what the max content length is?
There was a problem hiding this comment.
Just added here and also in the openapi specs
| - downloaded | ||
| - failed | ||
| - expired | ||
| - unspecified |
There was a problem hiding this comment.
Should we keep this? Is unspecified even a valid input? I assume not?
There was a problem hiding this comment.
Good catch - Claude got confused between the internal/customer-facing states. Just removed unspecified and downloaded.
| enum: | ||
| - import | ||
| - export | ||
| - unspecified |
There was a problem hiding this comment.
Same comment here about unspecified
| properties: | ||
| job_id: | ||
| description: The identifier of the job. | ||
| type: string |
There was a problem hiding this comment.
In some places we also specify format: uuid for ID fields. Should we do the same here?
| - awaiting_input | ||
| - processing | ||
| - completed | ||
| - downloaded |
There was a problem hiding this comment.
Are we keeping this as a status value?
Replaces "within DeepL's size limit for TMX imports" in both specs and on the import page. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2 participants
Add API reference pages for retrieving, listing segments, importing, exporting, deleting translation memories, and polling import/export jobs. Updates the OpenAPI spec, navigation, permission scopes, and release notes to match.