Skip to content

Update task api for v0.28.0 #299

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

Merged
merged 24 commits into from
Aug 22, 2022
Merged

Update task api for v0.28.0 #299

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
a37ffd3
Update task api v0.28.0
bidoubiwa Jul 7, 2022
b9ffd60
Update tests to be relevant with the structures where they are ran
bidoubiwa Jul 11, 2022
c527312
Update types in code-samples
bidoubiwa Jul 11, 2022
17d6c19
Remove clearAll task type
bidoubiwa Jul 11, 2022
ff0d350
Add index_uid as an optional in the Tasks
bidoubiwa Jul 11, 2022
9241a7b
Add comments on best builder implementation
bidoubiwa Jul 19, 2022
eb38d18
Add execute function on get_tasks
bidoubiwa Aug 2, 2022
d37be56
Update code samples
bidoubiwa Aug 3, 2022
61be5a5
Remove out of context comment
bidoubiwa Aug 3, 2022
7aa409b
Merge
bidoubiwa Aug 3, 2022
c968df3
Fix tests
bidoubiwa Aug 3, 2022
c21b18f
Fix pagination tests
bidoubiwa Aug 3, 2022
0cb9e93
Fix clippy
bidoubiwa Aug 3, 2022
734fd13
Fix doc tests
bidoubiwa Aug 3, 2022
6b70f5a
Fix get tasks inside index structure
bidoubiwa Aug 4, 2022
67637c2
Fix none doc tests with new get_tasks api
bidoubiwa Aug 8, 2022
c2dcd92
Add from and limit in tasks params
bidoubiwa Aug 8, 2022
efff813
Add warning on failing test
bidoubiwa Aug 8, 2022
abc0f7b
Update task API
bidoubiwa Aug 9, 2022
eaef1ea
Remove useless comment
bidoubiwa Aug 9, 2022
3989758
Rename type in Task structure
bidoubiwa Aug 10, 2022
668ba13
Removed useless newlines
bidoubiwa Aug 10, 2022
ac95329
Fix typo in comment
bidoubiwa Aug 10, 2022
66bd1a5
Add missing semi-column
bidoubiwa Aug 10, 2022
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
86 changes: 43 additions & 43 deletions .code-samples.meilisearch.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ get_one_document_1: |-
get_documents_1: |-
let documents: Vec<Movie> = client.index("movies").get_documents(None, Some(2), None).await.unwrap();
add_or_replace_documents_1: |-
let task: Task = client.index("movies").add_or_replace(&[
let task: TaskInfo = client.index("movies").add_or_replace(&[
Movie {
id: 287947,
title: "Shazam".to_string(),
Expand All @@ -35,18 +35,18 @@ add_or_update_documents_1: |-
title: String
}

let task: Task = client.index("movies").add_or_update(&[
let task: TaskInfo = client.index("movies").add_or_update(&[
IncompleteMovie {
id: 287947,
title: "Shazam ⚡️".to_string()
}
], None).await.unwrap();
delete_all_documents_1: |-
let task: Task = client.index("movies").delete_all_documents().await.unwrap();
let task: TaskInfo = client.index("movies").delete_all_documents().await.unwrap();
delete_one_document_1: |-
let task: Task = client.index("movies").delete_document(25684).await.unwrap();
let task: TaskInfo = client.index("movies").delete_document(25684).await.unwrap();
delete_documents_1: |-
let task: Task = client.index("movies").delete_documents(&[23488, 153738, 437035, 363869]).await.unwrap();
let task: TaskInfo = client.index("movies").delete_documents(&[23488, 153738, 437035, 363869]).await.unwrap();
search_post_1: |-
let results: SearchResults<Movie> = client.index("movies")
.search()
Expand All @@ -57,9 +57,9 @@ search_post_1: |-
get_task_by_index_1: |-
let task: Task = client.index("movies").get_task(1).await.unwrap();
get_all_tasks_by_index_1: |-
let tasks: Vec<Task> = client.index("movies").get_tasks().await.unwrap();
let tasks: TasksResults = client.index("movies").get_tasks().await.unwrap();
get_all_tasks_1: |-
let tasks: Vec<Task> = client.get_tasks().await.unwrap();
let tasks: TasksResults = client.get_tasks().await.unwrap();
get_task_1: |-
let task: Task = client.get_task(1).await.unwrap();
get_settings_1: |-
Expand Down Expand Up @@ -103,9 +103,9 @@ update_settings_1: |-
])
.with_synonyms(synonyms);

let task: Task = client.index("movies").set_settings(&settings).await.unwrap();
let task: TaskInfo = client.index("movies").set_settings(&settings).await.unwrap();
reset_settings_1: |-
let task: Task = client.index("movies").reset_settings().await.unwrap();
let task: TaskInfo = client.index("movies").reset_settings().await.unwrap();
get_synonyms_1: |-
let synonyms: HashMap<String, Vec<String>> = client.index("movies").get_synonyms().await.unwrap();
update_synonyms_1: |-
Expand All @@ -114,16 +114,16 @@ update_synonyms_1: |-
synonyms.insert(String::from("logan"), vec![String::from("xmen"), String::from("wolverine")]);
synonyms.insert(String::from("wow"), vec![String::from("world of warcraft")]);

let task: Task = client.index("movies").set_synonyms(&synonyms).await.unwrap();
let task: TaskInfo = client.index("movies").set_synonyms(&synonyms).await.unwrap();
reset_synonyms_1: |-
let task: Task = client.index("movies").reset_synonyms().await.unwrap();
let task: TaskInfo = client.index("movies").reset_synonyms().await.unwrap();
get_stop_words_1: |-
let stop_words: Vec<String> = client.index("movies").get_stop_words().await.unwrap();
update_stop_words_1: |-
let stop_words = ["of", "the", "to"];
let task: Task = client.index("movies").set_stop_words(&stop_words).await.unwrap();
let task: TaskInfo = client.index("movies").set_stop_words(&stop_words).await.unwrap();
reset_stop_words_1: |-
let task: Task = client.index("movies").reset_stop_words().await.unwrap();
let task: TaskInfo = client.index("movies").reset_stop_words().await.unwrap();
get_ranking_rules_1: |-
let ranking_rules: Vec<String> = client.index("movies").get_ranking_rules().await.unwrap();
update_ranking_rules_1: |-
Expand All @@ -138,15 +138,15 @@ update_ranking_rules_1: |-
"rank:desc",
];

let task: Task = client.index("movies").set_ranking_rules(&ranking_rules).await.unwrap();
let task: TaskInfo = client.index("movies").set_ranking_rules(&ranking_rules).await.unwrap();
reset_ranking_rules_1: |-
let task: Task = client.index("movies").reset_ranking_rules().await.unwrap();
let task: TaskInfo = client.index("movies").reset_ranking_rules().await.unwrap();
get_distinct_attribute_1: |-
let distinct_attribute: Option<String> = client.index("shoes").get_distinct_attribute().await.unwrap();
update_distinct_attribute_1: |-
let task: Task = client.index("shoes").set_distinct_attribute("skuid").await.unwrap();
let task: TaskInfo = client.index("shoes").set_distinct_attribute("skuid").await.unwrap();
reset_distinct_attribute_1: |-
let task: Task = client.index("shoes").reset_distinct_attribute().await.unwrap();
let task: TaskInfo = client.index("shoes").reset_distinct_attribute().await.unwrap();
get_searchable_attributes_1: |-
let searchable_attributes: Vec<String> = client.index("movies").get_searchable_attributes().await.unwrap();
update_searchable_attributes_1: |-
Expand All @@ -156,9 +156,9 @@ update_searchable_attributes_1: |-
"genres"
];

let task: Task = client.index("movies").set_searchable_attributes(&searchable_attributes).await.unwrap();
let task: TaskInfo = client.index("movies").set_searchable_attributes(&searchable_attributes).await.unwrap();
reset_searchable_attributes_1: |-
let task: Task = client.index("movies").reset_searchable_attributes().await.unwrap();
let task: TaskInfo = client.index("movies").reset_searchable_attributes().await.unwrap();
get_filterable_attributes_1: |-
let filterable_attributes: Vec<String> = client.index("movies").get_filterable_attributes().await.unwrap();
update_filterable_attributes_1: |-
Expand All @@ -167,9 +167,9 @@ update_filterable_attributes_1: |-
"director"
];

let task: Task = client.index("movies").set_filterable_attributes(&filterable_attributes).await.unwrap();
let task: TaskInfo = client.index("movies").set_filterable_attributes(&filterable_attributes).await.unwrap();
reset_filterable_attributes_1: |-
let task: Task = client.index("movies").reset_filterable_attributes().await.unwrap();
let task: TaskInfo = client.index("movies").reset_filterable_attributes().await.unwrap();
get_displayed_attributes_1: |-
let displayed_attributes: Vec<String> = client.index("movies").get_displayed_attributes().await.unwrap();
update_displayed_attributes_1: |-
Expand All @@ -180,9 +180,9 @@ update_displayed_attributes_1: |-
"release_date"
];

let task: Task = client.index("movies").set_displayed_attributes(&displayed_attributes).await.unwrap();
let task: TaskInfo = client.index("movies").set_displayed_attributes(&displayed_attributes).await.unwrap();
reset_displayed_attributes_1: |-
let task: Task = client.index("movies").reset_displayed_attributes().await.unwrap();
let task: TaskInfo = client.index("movies").reset_displayed_attributes().await.unwrap();
get_index_stats_1: |-
let stats: IndexStats = client.index("movies").get_stats().await.unwrap();
get_indexes_stats_1: |-
Expand All @@ -193,15 +193,15 @@ get_health_1: |-
get_version_1: |-
let version: Version = client.get_version().await.unwrap();
distinct_attribute_guide_1: |-
let task: Task = client.index("jackets").set_distinct_attribute("product_id").await.unwrap();
let task: TaskInfo = client.index("jackets").set_distinct_attribute("product_id").await.unwrap();
field_properties_guide_searchable_1: |-
let searchable_attributes = [
"title",
"overvieww",
"genres"
];

let task: Task = client.index("movies").set_searchable_attributes(&searchable_attributes).await.unwrap();
let task: TaskInfo = client.index("movies").set_searchable_attributes(&searchable_attributes).await.unwrap();
field_properties_guide_displayed_1: |-
let displayed_attributes = [
"title",
Expand All @@ -210,7 +210,7 @@ field_properties_guide_displayed_1: |-
"release_date"
];

let task: Task = client.index("movies").set_displayed_attributes(&displayed_attributes).await.unwrap();
let task: TaskInfo = client.index("movies").set_displayed_attributes(&displayed_attributes).await.unwrap();
filtering_guide_1: |-
let results: SearchResults<Movie> = client.index("movies").search()
.with_query("Avengers")
Expand Down Expand Up @@ -330,15 +330,15 @@ settings_guide_stop_words_1: |-
"an"
]);

let task = client.index("movies").set_settings(&settings).await.unwrap();
let task: TaskInfo = client.index("movies").set_settings(&settings).await.unwrap();
settings_guide_filterable_attributes_1: |-
let settings = Settings::new()
.with_filterable_attributes([
"director",
"genres"
]);

let task: Task = client.index("movies").set_settings(&settings).await.unwrap();
let task: TaskInfo = client.index("movies").set_settings(&settings).await.unwrap();
settings_guide_ranking_rules_1: |-
let settings = Settings::new()
.with_ranking_rules([
Expand All @@ -352,12 +352,12 @@ settings_guide_ranking_rules_1: |-
"rank:desc",
]);

let task = client.index("movies").set_settings(&settings).await.unwrap();
let task: TaskInfo = client.index("movies").set_settings(&settings).await.unwrap();
settings_guide_distinct_1: |-
let settings = Settings::new()
.with_distinct_attribute("product_id");

let task: Task = client.index("jackets").set_settings(&settings).await.unwrap();
let task: TaskInfo = client.index("jackets").set_settings(&settings).await.unwrap();
settings_guide_searchable_1: |-
let settings = Settings::new()
.with_searchable_attributes([
Expand All @@ -366,7 +366,7 @@ settings_guide_searchable_1: |-
"genres"
]);

let task: Task = client.index("movies").set_settings(&settings).await.unwrap();
let task: TaskInfo = client.index("movies").set_settings(&settings).await.unwrap();
settings_guide_displayed_1: |-
let settings = Settings::new()
.with_displayed_attributes([
Expand All @@ -376,15 +376,15 @@ settings_guide_displayed_1: |-
"release_date"
]);

let task: Task = client.index("movies").set_settings(&settings).await.unwrap();
let task: TaskInfo = client.index("movies").set_settings(&settings).await.unwrap();
settings_guide_sortable_1: |-
let settings = Settings::new()
.with_sortable_attributes([
"author",
"price"
]);

let task: Task = client.index("books").set_settings(&settings).await.unwrap();
let task: TaskInfo = client.index("books").set_settings(&settings).await.unwrap();
add_movies_json_1: |-
use meilisearch_sdk::{
indexes::*,
Expand Down Expand Up @@ -417,7 +417,7 @@ documents_guide_add_movie_1: |-
}

// Add a document to our index
let task: Task = client.index("movies").add_documents(&[
let task: TaskInfo = client.index("movies").add_documents(&[
IncompleteMovie {
id: "123sq178".to_string(),
title: "Amélie Poulain".to_string(),
Expand All @@ -437,7 +437,7 @@ primary_field_guide_add_document_primary_key: |-
price: f64
}

let task: Task = client.index("books").add_documents(&[
let task: TaskInfo = client.index("books").add_documents(&[
Book {
reference_number: "287947".to_string(),
title: "Diary of a Wimpy Kid".to_string(),
Expand Down Expand Up @@ -616,7 +616,7 @@ getting_started_configure_settings: |-
"mass",
"_geo"
])
let task: Task = client.index("meteorites").set_settings(&settings).await.unwrap();
let task: TaskInfo = client.index("meteorites").set_settings(&settings).await.unwrap();
getting_started_geo_radius: |-
let results: SearchResults<Meteorite> = client.index("meteorites").search()
.with_filter("_geoRadius(46.9480, 7.4474, 210000)")
Expand All @@ -643,7 +643,7 @@ getting_started_filtering: |-
.await
.unwrap();
faceted_search_update_settings_1: |-
let task: Task = client.index("movies").set_filterable_attributes(["director", "genres"]).await.unwrap();
let task: TaskInfo = client.index("movies").set_filterable_attributes(["director", "genres"]).await.unwrap();
faceted_search_filter_1: |-
let results: SearchResults<Movie> = client.index("movies").search()
.with_query("thriller")
Expand Down Expand Up @@ -683,7 +683,7 @@ sorting_guide_update_sortable_attributes_1: |-
"price"
];

let task: Task = client.index("books").set_sortable_attributes(&sortable_attributes).await.unwrap();
let task: TaskInfo = client.index("books").set_sortable_attributes(&sortable_attributes).await.unwrap();
sorting_guide_update_ranking_rules_1: |-
let ranking_rules = [
"words",
Expand All @@ -694,7 +694,7 @@ sorting_guide_update_ranking_rules_1: |-
"exactness"
];

let task: Task = client.index("books").set_ranking_rules(&ranking_rules).await.unwrap();
let task: TaskInfo = client.index("books").set_ranking_rules(&ranking_rules).await.unwrap();
sorting_guide_sort_parameter_1: |-
let results: SearchResults<Books> = client.index("books").search()
.with_query("science fiction")
Expand All @@ -717,9 +717,9 @@ update_sortable_attributes_1: |-
"author"
];

let task: Task = client.index("books").set_sortable_attributes(&sortable_attributes).await.unwrap();
let task: TaskInfo = client.index("books").set_sortable_attributes(&sortable_attributes).await.unwrap();
reset_sortable_attributes_1: |-
let task: Task = client.index("books").reset_sortable_attributes().await.unwrap();
let task: TaskInfo = client.index("books").reset_sortable_attributes().await.unwrap();
search_parameter_guide_sort_1: |-
let results: SearchResults<Books> = client.index("books").search()
.with_query("science fiction")
Expand All @@ -728,7 +728,7 @@ search_parameter_guide_sort_1: |-
.await
.unwrap();
geosearch_guide_filter_settings_1: |-
let task: Task = client.index("restaurants").set_filterable_attributes(&["_geo"]).await.unwrap();
let task: TaskInfo = client.index("restaurants").set_filterable_attributes(&["_geo"]).await.unwrap();
geosearch_guide_filter_usage_1: |-
let results: SearchResults<Restaurant> = client.index("restaurants").search()
.with_filter("_geoRadius(45.472735, 9.184019, 2000)")
Expand All @@ -742,7 +742,7 @@ geosearch_guide_filter_usage_2: |-
.await
.unwrap();
geosearch_guide_sort_settings_1: |-
let task: Task = client.index("restaurants").set_sortable_attributes(&["_geo"]).await.unwrap();
let task: TaskInfo = client.index("restaurants").set_sortable_attributes(&["_geo"]).await.unwrap();
geosearch_guide_sort_usage_1: |-
let results: SearchResults<Restaurant> = client.index("restaurants").search()
.with_sort(&["_geoPoint(48.8561446, 2.2978204):asc"])
Expand Down
4 changes: 2 additions & 2 deletions meilisearch-test-macro/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ async fn test_get_tasks() -> Result<(), Error> {

let tasks = index.get_tasks().await?;
// The only task is the creation of the index
assert_eq!(status.len(), 1);
assert_eq!(status.results.len(), 1);

index.delete()
.await?
Expand All @@ -52,7 +52,7 @@ With this macro, all these problems are solved. See a rewrite of this test:
async fn test_get_tasks(index: Index, client: Client) -> Result<(), Error> {
let tasks = index.get_tasks().await?;
// The only task is the creation of the index
assert_eq!(status.len(), 1);
assert_eq!(status.results.len(), 1);
}
```

Expand Down
Loading