Skip to content

docs(openapi): document style_id, translation_memory_id, and translation_memory_threshold on POST /v2/document#363

Open
lawl-dev wants to merge 1 commit into
mainfrom
dts/doctrans-style-rules-and-tm-params
Open

docs(openapi): document style_id, translation_memory_id, and translation_memory_threshold on POST /v2/document#363
lawl-dev wants to merge 1 commit into
mainfrom
dts/doctrans-style-rules-and-tm-params

Conversation

@lawl-dev
Copy link
Copy Markdown
Collaborator

@lawl-dev lawl-dev commented Jun 2, 2026

Summary

  • Document style_id, translation_memory_id, and translation_memory_threshold as multipart form fields on POST /v2/document, matching the parameters already exposed on POST /v2/translate.
  • translation_memory_id and translation_memory_threshold reuse the existing component schemas; style_id is described inline (no model_type interaction note, since /v2/document does not expose model_type).
  • Adds StyleRule and TranslationMemory examples to the request body, alongside the existing Basic and Glossary examples.

Test plan

  • mint broken-links passes
  • mint broken-links --check-anchors passes
  • OpenAPI playground renders the four examples and the three new properties on POST /v2/document

Supersedes #354 (re-opened from an in-repo branch so the OpenAPI JSON auto-conversion workflow can run). Do not merge until the feature gate is tested and enabled on prod.

@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented Jun 2, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
deepl-c950b784 🟢 Ready View Preview Jun 2, 2026, 10:20 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

…ion_memory_threshold on POST /v2/document

Bring document translation in line with text translation by documenting
the new style_id, translation_memory_id, and translation_memory_threshold
parameters on POST /v2/document, regenerating openapi.json, and adding a
changelog entry.
- The Ruby client library [`deepl-rb`](https://github.com/DeepLcom/deepl-rb) v3.8.0 now accepts an `additional_headers` argument on `translate` calls, so you can send `X-DeepL-Reporting-Tag` for usage reporting.
- See [Sending Custom Reporting Tags with Client Libraries](/docs/learning-how-tos/cookbook/sending-custom-reporting-tags-from-client-libraries) for the updated Ruby snippet.

## May 26 - Style Rules and Translation Memories for Document Translation
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The date needs to be updated again

@BriannaDelgado
Copy link
Copy Markdown
Member

nice!
image

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