Skip to content

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

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

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

Conversation

@lawl-dev
Copy link
Copy Markdown

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

…ion_memory_threshold on POST /v2/document

Reuses the existing TranslationMemoryId and TranslationMemoryThreshold
schemas already used by /v2/translate, and adds StyleRule and
TranslationMemory request examples alongside the existing Basic and
Glossary examples.
@BriannaDelgado
Copy link
Copy Markdown
Member

Could you publish your local branch? We have a Github workflow to automatically convert the YAML openapi spec to JSON but it seems to be failing since it can't find your branch

@BriannaDelgado
Copy link
Copy Markdown
Member

nit: Could you also update the roadmap and releases page that we've released this new feature?

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