mirror of
https://github.com/meilisearch/meilisearch.git
synced 2024-11-26 03:55:07 +08:00
857cd09285
When adding a new setting, there are several important points that can be easily forgotten. This PR adds a small reminder list of some of these points.
1.7 KiB
1.7 KiB
name | about | title | labels | assignees |
---|---|---|---|---|
New sprint issue | ⚠️ Should only be used by the engine team ⚠️ |
Related product team resources: PRD (internal only) Related product discussion: Related spec: WIP
Motivation
Usage
TODO
- Release a prototype
- If prototype validated, merge changes into
main
- Update the spec
Reminders when modifying the Setting API
- Ensure the new setting route is at least tested by the
test_setting_routes
macro - Ensure Analytics are fully implemented
/settings/my-new-setting
configurated in themake_setting_routes
macro- global
/settings
route configurated in theupdate_all
function
- Ensure the dump serializing is consistent with the
/settings
route serializing, e.g., enums case can be different (camelCase
in route andPascalCase
in the dump)