Skip to content

Commit 98f2e8a

Browse files
committed
docs(api-server): add clarification for read-only models in data management API
- Add a caution note about `country` and `language` models being read-only - Explain that foundational data is managed via database seeding - Update the list of manageable models to include `language` - Improve clarity on unsupported actions through the generic endpoint
1 parent 5e5d5a1 commit 98f2e8a

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

src/content/docs/api-server/features/data-management-api.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,12 +40,17 @@ The generic data endpoint can manage the following models out-of-the-box:
4040
- `topic`
4141
- `source`
4242
- `country`
43+
- `language`
4344
- `user`
4445
- `user_app_settings`
4546
- `user_content_preferences`
4647
- `remote_config`
4748
- `dashboard_summary`
4849

50+
<Aside type="caution" title="Read-Only Models">
51+
The `country` and `language` models are configured to be **read-only** through the API. This is an intentional design choice. This foundational data is managed centrally via the database seeding process and is not intended to be modified by users.
52+
</Aside>
53+
4954
<Aside type="note">
5055
Some actions are intentionally unsupported through this generic endpoint for security or logical reasons. For example, creating a new user is handled exclusively by the dedicated `/api/v1/auth/verify-code` endpoint, not by a POST request to `?model=user`. These restrictions are defined in the `ModelConfig` for each model.
5156
</Aside>

0 commit comments

Comments
 (0)