Repository navigation
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
This was referenced Sep 14, 2026
lawl-dev
force-pushed
the
docs/style-profiles-api
branch
from
October 13, 2026 14:23
9c8cddf to
ff90872
Compare
lawl-dev
force-pushed
the
docs/style-profiles-api
branch
from
October 13, 2026 14:27
ff90872 to
61f43ae
Compare
Adds the /v3/style_profiles endpoints (list, create, retrieve, update, delete), style_profile_id on POST /v2/translate and POST /v2/document, a Using Style Profiles guide, and a style profiles row on the customize overview page. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
lawl-dev
force-pushed
the
docs/style-profiles-api
branch
from
October 13, 2026 14:39
61f43ae to
f2aca36
Compare
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.
Adds API reference documentation for the
/v3/style_profilesendpoints and forstyle_profile_idonPOST /v2/translateandPOST /v2/document, plus a Using Style Profiles guide under Customize.A style profile bundles your other customizations, glossaries, style rule lists and translation memories, behind a single
style_profile_id, so one ID stands for a whole translation configuration instead of a list of individual parameters.Endpoints documented
GET/v3/style_profilesstyle_profiles:readGET/v3/style_profiles/{style_profile_id}style_profiles:readPOST/v3/style_profilesstyle_profiles:writePATCH/v3/style_profiles/{style_profile_id}style_profiles:writeDELETE/v3/style_profiles/{style_profile_id}style_profiles:writeBehavior called out in the descriptions
400message names the list the bad ID was passed inPATCHis open to the owner and to accounts the profile was shared with for editing. It leaves absent fields unchanged. An empty string clearsdescriptionandindustry, an emptynameis a400, and each component list that is sent replaces that linked set in fullDELETEreturns204 No Contentand only unlinks the bundled glossaries, style rule lists and translation memories. They are not deleted. Deleting a component removes it from every profile that links it404on delete, the same status as an unknown IDglossary_priority_order_enabledmakes the order ofglossary_idsdecide which glossary wins when two define the same source term. Without it the order has no effect456when the account has reached its style profile limit, and403when the plan does not include creating style profiles400style_profile_idonPOST /v2/translateglossary_id,glossary_ids,style_id,translation_memory_id,translation_memory_thresholdorcustom_instructions(400)404style_profile_idonPOST /v2/documentglossary_id,glossary_ids,style_id,translation_memory_idortranslation_memory_threshold(400)Style profile not found.Changes
api-reference/openapi.yaml: the two paths, theManageStyleProfilestag, theStyleProfileandStyleProfileIdschemas,style_profile_idon bothPOST /v2/translaterequest bodies, andstyle_profile_idonPOST /v2/documentapi-reference/openapi.json: regenerated withyq -o=json '.' api-reference/openapi.yaml > api-reference/openapi.jsonapi-reference/style-profiles/: five endpoint pagesdocs.json: a Style Profiles group under Customize, next to the other customization resourcesdocs/customize/using-style-profiles.mdx: how-to guide (create, translate, glossary priority, update, limits), linked from the Customize navdocs/customize/overview.mdx: a style profiles row in the customization tableA question for the reviewer
Field character limits are stated in prose in the field descriptions rather than encoded as
maxLengthormaximumin the schema, following the OpenAPI conventions inCLAUDE.md.Worth a second opinion, though: the neighboring customization endpoints do encode their limits in the schema, so the spec now reads two ways depending on which resource you look at. Would you rather these fields match the neighbors, or keep them as they are and treat this as the pattern to move toward? Happy to change it either way, just say which.
Verification
yqparses the YAML and every new$refresolves. The regenerated JSON is identical to the previous one apart from the additionsmint broken-linkspasses; the guide's links resolvemint broken-links --check-anchorsreports the same six pre-existing anchors asmainand nothing newOpened as a draft because the endpoints are not released yet. Includes the changes from #439 and #440.
Replaces #424, which was opened from a fork. The
Convert YAML specs to JSONworkflow checks the branch out of this repository, so it can never resolve a fork's head ref and failed on every commit there. Pushed to a branch here instead.