Repository navigation
docs(openapi): align glossary, spoken terms, admin and paging details with API behavior - #486
Open
BriannaDelgado wants to merge 3 commits into
Open
BriannaDelgado wants to merge 3 commits into
BriannaDelgado wants to merge 3 commits into
Conversation
… with API behavior - Glossaries: creating a glossary without dictionaries is allowed, and entries_format has no default; a dictionary without it returns 400 - Spoken terms: term_lists is optional on create, and PATCH accepts at most one term list - Admin API: document the key secret returned when creating a developer key, speech_to_speech_minutes in the usage breakdown, and the page_size parameter of the custom tag analytics endpoint - Paging: translation memories reduce page_size above 100 to 100 instead of rejecting it, and style rule lists reduce page_size above 10 to 10 Regenerated openapi.json from openapi.yaml. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
…t changing 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
This branch was successfully deployed
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
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.
Corrects several spots where the OpenAPI spec's schemas differ from what the API does. Each change below is checked against the public-api backend.
Changes
dictionariesis no longer required when creating a multilingual glossary, since the backend accepts an empty glossary.entries_formatno longer has atsvdefault, because the backend has none, and "(default)" is dropped from its description.term_listsis no longer required on create.ApiKey.secretis documented. It is returned only when a key is created, and isnullin every other response.UsageBreakdowngainsspeech_to_speech_minutes./v2/admin/analytics/custom-tagsdocuments itspage_sizeparameter (1 to 1000; values outside that range get a 400).openapi.jsonis regenerated fromopenapi.yaml.The matching Kong gateway spec change is https://gitlab.com/deepl-org/deepl/clapi-track/kong-api/-/merge_requests/496.
🤖 Generated with Claude Code