Skip to content

docs: align Quality Evaluation API with the current contract - #433

Open
tn819 wants to merge 1 commit into
DeepL:mainfrom
tn819:feat/TNT-279-quality-evaluations-docs
Open

docs: align Quality Evaluation API with the current contract#433
tn819 wants to merge 1 commit into
DeepL:mainfrom
tn819:feat/TNT-279-quality-evaluations-docs

Conversation

@tn819

@tn819 tn819 commented Sep 10, 2026

Copy link
Copy Markdown

Summary

  • Pluralize the Quality Evaluation API to POST /v1/quality-evaluations and GET /v1/quality-evaluations/{job_id} (and matching poll_url).
  • Remove poll summary / overall_score / granular_counts. Echo source, target, and glossary entries (source_entry, target_entry, ranges; omitted when empty). Document optional metadata.glossary_ids.
  • Keep the pages off the public sidebar: Quality Evaluation is a hidden: true nav group (same pattern as Translate Audio Files). Closed-alpha callout unchanged. No changelog entry.

Test plan

  • Confirm Mintlify sidebar does not show Quality Evaluation on the public API Reference tab
  • Direct URLs /api-reference/quality-evaluation, /submit, /poll still resolve
  • Generated OpenAPI Try it / examples use plural paths and a done body without summary
  • Submit schema shows optional glossary_ids

@tn819
tn819 force-pushed the feat/TNT-279-quality-evaluations-docs branch from b789593 to 2ccc475 Compare September 10, 2026 07:44
@tn819 tn819 changed the title docs: align Quality Evaluation API with TNT-279 docs: align Quality Evaluation API with the current contract Sep 10, 2026
Pluralize /v1/quality-evaluations, drop poll summary/score, echo source/target/entries, and keep the pages hidden in nav.
@tn819
tn819 force-pushed the feat/TNT-279-quality-evaluations-docs branch from 2ccc475 to 918a9a9 Compare September 10, 2026 07:45
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.

1 participant