Skip to content

Code samples changes related to Meilisearch release (v0.28.0) #298

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.

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 9 commits into from
Aug 30, 2022

Conversation

meili-bot
Copy link
Contributor

This PR is auto-generated.

Update the code-samples.meilisearch.yml according to the integration-guides issue for more information and the complete description about what should be done here check that issue.

@meili-bot meili-bot added documentation Improvements or additions to documentation skip-changelog The PR will not appear in the release changelogs labels Jul 4, 2022
@bidoubiwa bidoubiwa force-pushed the bump-meilisearch-v0.28.0 branch from 704f22e to f46f78d Compare August 3, 2022 12:30
@bidoubiwa
Copy link
Contributor

bidoubiwa commented Aug 25, 2022

  • Update update_a_key_1 PR
  • Only update name and description: "name": "Products/Reviews API key", "description": "Manage documents: Products/Reviews API key"
  • Update get_all_keys_1 PR
  • Update to add limit parameter: `limit=3'
  • Update delete_a_key_1 PR
  • Replace key key with uid: 6062abda-a5aa-4414-ac9-ecd7944c0f8d
  • Update security_guide_update_key_1 PR
  • Replace key key with uid: 74c9c733-3368-4738-bbe5-1d18a5fecb37
  • Replace updating indexes with description: { "description": "Default Search API Key" }'
  • Update security_guide_delete_key_1 PR
  • Replace key key with uid: ac5cd97d-5a4b-4226-a868-2d0eb6d197ab
  • Update search_parameter_guide_matches_1 PR
  • Rename code sample to search_parameter_guide_show_matches_position_1
  • Rename matches parameter to showMatchesPosition
  • Update faceted_search_facets_distribution_1 PR
  • Rename code sample to faceted_search_facets_1
  • Rename facetsDistribution parameter to facets
  • Remove get_dump_status_1 PR
  • Remove updating_guide_get_dump_status PR
  • Remove get_task_by_index_1 PR
  • Remove get_all_tasks_by_index_1 PR
  • Update getting_started_check_task_status PR
    • Remove getting task from movies index
  • Add get_all_tasks_filtering_1 PR](v0.28 tasks documentation#1746)
    • filter tasks by indexUid=movies
  • Add get_all_tasks_filtering_2 PR](v0.28 tasks documentation#1746)
    • filter tasks by status=succeeded,failed&type=documentAdditionOrUpdate
  • Add get_all_tasks_paginating_1 PR](v0.28 tasks documentation#1746)
    • paginate tasks by limit=2&from=10
  • Add get_all_tasks_paginating_2 PR](v0.28 tasks documentation#1746)
    • paginate tasks by limit=2&from=8
  • Update list_all_indexes_1 PR
    • Add limit parameter: limit=3
  • Update get_one_document_1 PR
    • Add fields parameter: fields=id,title,poster,release_date
  • Add get_pagination_settings_1 PR
  • for the books index
  • Add update_pagination_settings_1 PR
  • for the books index
  • Update "maxTotalHits": 100
  • Add reset_pagination_settings_1 PR
  • for the books index
  • Update update_settings_1 PR, PR
  • add "pagination": {"maxTotalHits": 5000}
  • add "faceting": { "maxValuesPerFacet": 200}
  • Add get_faceting_settings_1 PR
  • for the books index
  • Add update_faceting_settings_1 PR
  • for the books index
  • Update: "maxValuesPerFacet": 2
  • Add reset_faceting_settings_1 PR
  • for the books index
  • Add settings_guide_faceting_1 PR
  • for the movies index
  • sets "maxValuesPerFacet": 5
  • Add settings_guide_pagination_1 PR
  • for the movies index
  • sets "maxTotalHits": 50

@bidoubiwa bidoubiwa requested review from alallema and irevoire August 29, 2022 10:11
Copy link
Contributor

@bidoubiwa bidoubiwa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

need to change get_document

@bidoubiwa bidoubiwa marked this pull request as ready for review August 29, 2022 12:10
Copy link
Member

@brunoocasali brunoocasali left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a couple of questions.

In any case is 100% 🎉 LGTM!

create_an_index_1: |-
client.create_index("movies", Some("id")).await.unwrap();
update_an_index_1: |-
client.index("movies").update("movie_review_id").await.unwrap();
delete_an_index_1: |-
client.index("movies").delete().await.unwrap();
get_one_document_1: |-
let movie: Movie = client.index("movies").get_document(String::from("25684")).await.unwrap();
let movie: Movie = client.index("movies").get_document(String::from("25684"), ["id", "title", "poster", "release_date"].to_vec()).await.unwrap();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why .to_vec() is required here? But not in .with_status(["succeeded", "failed"]) ?

get_all_keys_1: |-
let keys = client.get_keys().await.unwrap();
let mut query = KeysQuery::new().with_limit(3).execute(&client).await.unwrap();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some of the examples are multiline and some are not, I think it could be nice to follow a standard :)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I bring consistency now I have to do it on every sample even the ones that are not linked to this PR.
Maybe an issue that request that change ?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perfect for me! You can open the issue :)

@bidoubiwa bidoubiwa merged commit e963e3c into bump-meilisearch-v0.28.0 Aug 30, 2022
@bidoubiwa bidoubiwa deleted the meili-bot/code-samples-v0-28 branch August 30, 2022 12:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation skip-changelog The PR will not appear in the release changelogs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants