Skip to content

Document the style profile endpoints #427

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
lawl-dev wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

Document the style profile endpoints #427

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
30689ad
feat: document style profile endpoints
Sep 1, 2026
da587d8
feat: document the spoken terms link on style profiles
Sep 1, 2026
c20ac4a
feat: note that a style profile holds one style rule list per target …
Sep 3, 2026
3e8b2a1
feat: drop adaptive_translation_enabled from the style profile endpoints
Sep 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,108 changes: 985 additions & 123 deletions api-reference/openapi.json
View file
Open in desktop

Large diffs are not rendered by default.

740 changes: 740 additions & 0 deletions api-reference/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

5 changes: 5 additions & 0 deletions api-reference/style-profiles/create-style-profile.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
openapi: post /v3/style_profiles
title: "Create a style profile"
description: "Learn how to create a style profile, from a name on its own to a fully configured bundle, and what happens when a component ID is rejected."
---
5 changes: 5 additions & 0 deletions api-reference/style-profiles/delete-style-profile.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
openapi: delete /v3/style_profiles/{style_profile_id}
title: "Delete a style profile"
description: "Learn how to delete a style profile you own, and why the components it bundled are only unlinked."
---
5 changes: 5 additions & 0 deletions api-reference/style-profiles/get-style-profile.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
openapi: get /v3/style_profiles/{style_profile_id}
title: "Retrieve a style profile"
description: "Learn how to fetch a single style profile's linked components, metadata, and timestamps by its ID."
---
5 changes: 5 additions & 0 deletions api-reference/style-profiles/list-all-style-profiles.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
openapi: get /v3/style_profiles
title: "List style profiles"
description: "Learn how to page through the style profiles your account owns and the ones shared with it, newest first."
---
5 changes: 5 additions & 0 deletions api-reference/style-profiles/update-style-profile.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
openapi: patch /v3/style_profiles/{style_profile_id}
title: "Update a style profile"
description: "Learn how to rename a style profile, clear its description or industry, and replace the set of components it links."
---
11 changes: 11 additions & 0 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,6 +278,17 @@
],
"drilldown": false
},
{
"group": "Style Profiles",
"pages": [
"api-reference/style-profiles/list-all-style-profiles",
"api-reference/style-profiles/create-style-profile",
"api-reference/style-profiles/get-style-profile",
"api-reference/style-profiles/update-style-profile",
"api-reference/style-profiles/delete-style-profile"
],
"drilldown": false
},
{
"group": "Style Rules",
"pages": [
Expand Down
Loading