Skip to content

Update settings code-sample for v0.28.0 #1293

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 3 commits into from
Jul 6, 2022
Merged

Update settings code-sample for v0.28.0 #1293

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c7359ff
Update settings code-sample for v0.28.0
bidoubiwa Jul 6, 2022
22cc51b
Add additional code-samples of settings sub-routes
bidoubiwa Jul 6, 2022
7389664
Merge branch 'meili-bot/code-samples-v0-28' into update_settings_code…
bidoubiwa Jul 6, 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
29 changes: 19 additions & 10 deletions .code-samples.meilisearch.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,6 @@
# the documentation on build
# You can read more on https://github.com/meilisearch/documentation/tree/master/.vuepress/code-samples
---
get_pagination_settings_1: |-
update_pagination_settings_1: |-
reset_pagination_settings_1: |-
get_faceting_settings_1: |-
update_faceting_settings_1: |-
reset_faceting_settings_1: |-
settings_guide_faceting_1: |-
settings_guide_pagination_1: |-

get_one_index_1: |-
client.index('movies').getRawInfo()
list_all_indexes_1: |-
Expand Down Expand Up @@ -82,7 +73,7 @@ delete_a_key_1: |-
client.deleteKey('6062abda-a5aa-4414-ac91-ecd7944c0f8d')
get_settings_1: |-
client.index('movies').getSettings()
PLEASE_UPDATE_ME>>>>>>>>>>>>>update_settings_1: |-
update_settings_1: |-
client.index('movies').updateSettings({
rankingRules: [
'words',
Expand Down Expand Up @@ -127,6 +118,12 @@ PLEASE_UPDATE_ME>>>>>>>>>>>>>update_settings_1: |-
'disableOnAttributes': [
'title'
]
},
pagination: {
maxTotalHits: 5000
},
faceting: {
maxValuesPerFacet: 200
}
})
reset_settings_1: |-
Expand Down Expand Up @@ -546,6 +543,18 @@ update_sortable_attributes_1: |-
])
reset_sortable_attributes_1: |-
client.index('books').resetSortableAttributes()
get_pagination_settings_1: |-
update_pagination_settings_1: |-
client.index('books').updateSettings({ pagination: { maxTotalHits: 100 }})
reset_pagination_settings_1: |-
get_faceting_settings_1: |-
update_faceting_settings_1: |-
client.index('books').updateSettings({ faceting: { maxValuesPerFacet: 2 }})
reset_faceting_settings_1: |-
settings_guide_faceting_1: |-
client.index('books').updateSettings({ faceting: { maxValuesPerFacet: 5 }})
Copy link
Member

Choose a reason for hiding this comment

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

This method will be replaced when we implement those special methods correct?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes ! Its per our discussion we had privately that i ve added them

settings_guide_pagination_1: |-
client.index('books').updateSettings({ pagination: { maxTotalHits: 50 }})
search_parameter_guide_sort_1: |-
client.index('books').search('science fiction', {
sort: ['price:asc'],
Expand Down