searchengines-web/MeiliSearch
searchengines-web/MeiliSearch
1
0
Fork 0
mirror of https://github.com/meilisearch/MeiliSearch synced 2025-01-09 21:14:30 +01:00
Code Issues Releases Wiki Activity

improve the description of all the settings route

Browse Source
This commit is contained in:
Tamo 2025-01-06 11:54:39 +01:00
parent 28162759a4
commit 8b95c6ae56
No known key found for this signature in database
GPG Key ID: 20CD8020AFA88D69
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
crates/meilisearch/src/routes/indexes/settings.rs
View File

@ -81,12 +81,13 @@ macro_rules! make_setting_route {
#[allow(unused_imports)] #[allow(unused_imports)]
use super::*; use super::*;
#[doc = $camelcase_attr]
#[utoipa::path( #[utoipa::path(
delete, delete,
path = concat!("{indexUid}/settings", $route), path = concat!("{indexUid}/settings", $route),
tag = "Settings", tag = "Settings",
security(("Bearer" = ["settings.update", "settings.*", "*"])), security(("Bearer" = ["settings.update", "settings.*", "*"])),
summary = concat!("Reset ", $camelcase_attr),
description = concat!("Reset an index's ", $camelcase_attr, " to its default value"),
params(("indexUid", example = "movies", description = "Index Unique Identifier", nullable = false)), params(("indexUid", example = "movies", description = "Index Unique Identifier", nullable = false)),
request_body = $type, request_body = $type,
responses( responses(
@ -149,6 +150,8 @@ macro_rules! make_setting_route {
path = concat!("{indexUid}/settings", $route), path = concat!("{indexUid}/settings", $route),
tag = "Settings", tag = "Settings",
security(("Bearer" = ["settings.update", "settings.*", "*"])), security(("Bearer" = ["settings.update", "settings.*", "*"])),
summary = concat!("Update ", $camelcase_attr),
description = concat!("Update an index's user defined ", $camelcase_attr),
params(("indexUid", example = "movies", description = "Index Unique Identifier", nullable = false)), params(("indexUid", example = "movies", description = "Index Unique Identifier", nullable = false)),
request_body = $type, request_body = $type,
responses( responses(
@ -232,6 +235,8 @@ macro_rules! make_setting_route {
get, get,
path = concat!("{indexUid}/settings", $route), path = concat!("{indexUid}/settings", $route),
tag = "Settings", tag = "Settings",
summary = concat!("Get ", $camelcase_attr),
description = concat!("Get an user defined ", $camelcase_attr),
security(("Bearer" = ["settings.get", "settings.*", "*"])), security(("Bearer" = ["settings.get", "settings.*", "*"])),
params(("indexUid", example = "movies", description = "Index Unique Identifier", nullable = false)), params(("indexUid", example = "movies", description = "Index Unique Identifier", nullable = false)),
responses( responses(