Skip to content

v0.21: update .code-samples.meilisearch.yaml #1025

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 7 commits into from
Jul 20, 2021
Merged

v0.21: update .code-samples.meilisearch.yaml #1025

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
85ee5f9
v0.21: update `.code-samples.meilisearch.yaml`
dichotommy Jul 5, 2021
78af649
Respond to feedback on .code-samples
dichotommy Jul 5, 2021
9e9f59d
Update facetFilters syntax, finalize phrase search sample
dichotommy Jul 7, 2021
0c7ffa4
Update .code-samples.meilisearch.yaml
dichotommy Jul 7, 2021
13ea22d
Update .code-samples.meilisearch.yaml
dichotommy Jul 7, 2021
013d9ab
Fix typo and add intro readme to .code-samples
dichotommy Jul 8, 2021
06b6f25
Update code samples template
dichotommy Jul 13, 2021
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
60 changes: 33 additions & 27 deletions .code-samples.meilisearch.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
# This code-samples file is used by the MeiliSearch documentation
# Every example written here will be automatically fetched by
# the documentation on build
# You can read more at https://github.com/meilisearch/documentation/tree/master/.vuepress/code-samples
---
get_one_index_1: |-
curl \
-X GET 'http://localhost:7700/indexes/movies'
list_all_indexes_1: |1-
list_all_indexes_1: |-
curl \
-X GET 'http://localhost:7700/indexes'
create_an_index_1: |-
Expand Down Expand Up @@ -84,11 +89,10 @@ update_settings_1: |-
-X POST 'http://localhost:7700/indexes/movies/settings' \
--data '{
"rankingRules": [
"typo",
"words",
"typo",
"proximity",
"attribute",
"wordsPosition",
"exactness",
"desc(release_date)",
"desc(rank)"
Expand Down Expand Up @@ -170,19 +174,19 @@ update_distinct_attribute_1: |-
reset_distinct_attribute_1: |-
curl \
-X DELETE 'http://localhost:7700/indexes/movies/settings/distinct-attribute'
get_attributes_for_faceting_1: |-
get_filterable_attributes_1: |-
curl \
-X GET 'http://localhost:7700/indexes/movies/settings/attributes-for-faceting'
update_attributes_for_faceting_1: |-
-X GET 'http://localhost:7700/indexes/movies/settings/filterable-attributes'
update_filterable_attributes_1: |-
curl \
-X POST 'http://localhost:7700/indexes/movies/settings/attributes-for-faceting' \
-X POST 'http://localhost:7700/indexes/movies/settings/filterable-attributes' \
--data '[
"genres",
"director"
]'
reset_attributes_for_faceting_1: |-
reset_filterable_attributes_1: |-
curl \
-X DELETE 'http://localhost:7700/indexes/movies/settings/attributes-for-faceting'
-X DELETE 'http://localhost:7700/indexes/movies/settings/filterable-attributes'
get_searchable_attributes_1: |-
curl \
-X GET 'http://localhost:7700/indexes/movies/settings/searchable-attributes'
Expand Down Expand Up @@ -252,16 +256,16 @@ field_properties_guide_displayed_1: |-
}'
filtering_guide_1: |-
curl 'http://localhost:7700/indexes/movies/search' \
--data '{ "q": "Avengers", "filters": "release_date > 795484800" }'
--data '{ "q": "Avengers", "filter": "release_date > 795484800" }'
filtering_guide_2: |-
curl 'http://localhost:7700/indexes/movies/search' \
--data '{ "q":"Batman", "filters": "release_date > 795484800 AND (director = \"Tim Burton\" OR director = \"Christopher Nolan\")" }'
--data '{ "q":"Batman", "filter": "release_date > 795484800 AND (director = \"Tim Burton\" OR director = \"Christopher Nolan\")" }'
filtering_guide_3: |-
curl 'http://localhost:7700/indexes/movies/search' \
--data '{ "q": "horror", "filters": "director = \"Jordan Peele\"" }'
--data '{ "q": "horror", "filter": "director = \"Jordan Peele\"" }'
filtering_guide_4: |-
curl 'http://localhost:7700/indexes/movies/search' \
--data '{ "q": "Planet of the Apes", "filters": "rating >= 3 AND (NOT director = \"Tim Burton\")" }' \
--data '{ "q": "Planet of the Apes", "filter": "rating >= 3 AND (NOT director = \"Tim Burton\")" }' \
search_parameter_guide_query_1: |-
curl 'http://localhost:7700/indexes/movies/search' \
--data '{ "q": "shifu" }'
Expand All @@ -279,16 +283,16 @@ search_parameter_guide_crop_1: |-
--data '{ "q": "shifu", "attributesToCrop": ["overview"], "cropLength": 10 }'
search_parameter_guide_highlight_1: |-
curl 'http://localhost:7700/indexes/movies/search' \
--data '{ "q": "shifu", "attributesToHighlight": ["overview"] }'
--data '{ "q": "winter feast", "attributesToHighlight": ["overview"] }'
search_parameter_guide_filter_1: |-
curl 'http://localhost:7700/indexes/movies/search' \
--data '{ "q": "n", "filters": "title = Nightshift" }'
--data '{ "q": "n", "filter": "title = Nightshift" }'
search_parameter_guide_filter_2: |-
curl 'http://localhost:7700/indexes/movies/search' \
--data '{ "q": "shifu", "filters": "title=\"Kung Fu Panda\"" }'
--data '{ "q": "shifu", "filter": "title=\"Kung Fu Panda\"" }'
search_parameter_guide_matches_1: |-
curl 'http://localhost:7700/indexes/movies/search' \
--data '{ "q": "shifu", "attributesToHighlight": ["overview"], "matches": true }'
--data '{ "q": "winter feast", "matches": true }'
settings_guide_synonyms_1: |-
curl \
-X POST 'http://localhost:7700/indexes/tops/settings' \
Expand All @@ -313,11 +317,10 @@ settings_guide_ranking_rules_1: |-
-X POST 'http://localhost:7700/indexes/movies/settings' \
--data '{
"rankingRules": [
"typo",
"words",
"typo",
"proximity",
"attribute",
"wordsPosition",
"exactness",
"asc(release_date)",
"desc(rank)"
Expand Down Expand Up @@ -366,7 +369,7 @@ search_guide_1: |-
--data '{ "q": "shifu", "limit": 5, "offset": 10 }'
search_guide_2: |-
curl 'http://localhost:7700/indexes/movies/search' \
--data '{ "q": "Avengers", "filters": "release_date > 795484800" }'
--data '{ "q": "Avengers", "filter": "release_date > 795484800" }'
getting_started_add_documents_md: |-
```bash
curl \
Expand All @@ -382,35 +385,38 @@ faceted_search_update_settings_1: |-
curl \
-X POST 'http://localhost:7700/indexes/movies/settings' \
--data '{
"attributesForFaceting": [
"filterableAttributes": [
"director",
"genres"
]
}'
faceted_search_facet_filters_1: |-
faceted_search_filter_1: |-
curl 'http://localhost:7700/indexes/movies/search' \
--data '{ "q": "thriller", "facetFilters": [["genres:Horror", "genres:Mystery"], "director:Jordan Peele"] }'
--data '{ "q": "thriller", "filter": [["genres = Horror", "genres = Mystery"], "director = \"Jordan Peele\""] }'
faceted_search_facets_distribution_1: |-
curl --get 'http://localhost:7700/indexes/movies/search' \
--data '{ "q": "Batman", "facetsDistribution": ["genres"] }'
faceted_search_walkthrough_attributes_for_faceting_1: |-
faceted_search_walkthrough_filterable_attributes_1: |-
curl \
-X POST 'http://localhost:7700/indexes/movies/settings' \
--data '{
"attributesForFaceting": [
"filterableAttributes": [
"director",
"producer",
"genres",
"production_companies"
]
}'
faceted_search_walkthrough_facet_filters_1: |-
faceted_search_walkthrough_filter_1: |-
curl 'http://localhost:7700/indexes/movies/search' \
--data '{ "q": "thriller", "facetFilters": [["genres:Horror", "genres:Mystery"], "director:Jordan Peele"] }'
--data '{ "q": "thriller", "filter": [["genres = Horror", "genres = Mystery"], "director = \"Jordan Peele\""] }'
faceted_search_walkthrough_facets_distribution_1: |-
curl 'http://localhost:7700/indexes/movies/search' \
--data '{ "q": "Batman", "facetsDistribution": ["genres"] }'
post_dump_1: |-
curl -X POST 'http://localhost:7700/dumps'
get_dump_status_1: |-
curl -X GET 'http://localhost:7700/dumps/20201101-110357260/status'
phrase_search_1: |-
curl -X POST 'http://localhost:7700/indexes/movies/search' \
--data '{ "q": "\"african american\" horror" }'
15 changes: 9 additions & 6 deletions .vuepress/public/sample-template.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ reset_distinct_attribute_1: |-
get_searchable_attributes_1: |-
update_searchable_attributes_1: |-
reset_searchable_attributes_1: |-
get_attributes_for_faceting_1: |-
update_attributes_for_faceting_1: |-
reset_attributes_for_faceting_1: |-
get_filterable_attributes_1: |-
update_filterable_attributes_1: |-
reset_filterable_attributes_1: |-
get_displayed_attributes_1: |-
update_displayed_attributes_1: |-
reset_displayed_attributes_1: |-
Expand Down Expand Up @@ -75,9 +75,12 @@ search_guide_2: |-
getting_started_add_documents_md: |-
getting_started_search_md: |-
faceted_search_update_settings_1: |-
faceted_search_facet_filters_1: |-
faceted_search_filter_1: |-
faceted_search_facets_distribution_1: |-
faceted_search_walkthrough_attributes_for_faceting_1: |-
faceted_search_walkthrough_facet_filters_1: |-
faceted_search_walkthrough_filterable_attributes_1: |-
faceted_search_walkthrough_filter_1: |-
faceted_search_walkthrough_facets_distribution_1: |-
add_movies_json_1: |-
post_dump_1: |-
get_dump_status_1: |-
phrase_search_1: |-