Skip to content
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

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

Merged
merged 8 commits into from
Jul 19, 2022
Merged

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

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
a6d7d1d
Update .code-samples.meilisearch.yaml
meili-bot Jul 4, 2022
4f2a755
Update indexes code-sample for v0.28.0 (#1290)
bidoubiwa Jul 6, 2022
d01935f
Update keys code-sample for v0.28.0 (#1287)
bidoubiwa Jul 6, 2022
7afebfa
Update tasks code-sample for v0.28.0 (#1289)
bidoubiwa Jul 6, 2022
407f800
Update search code-sample for v0.28.0 (#1288)
bidoubiwa Jul 6, 2022
5752e0d
Update settings code-sample for v0.28.0 (#1293)
bidoubiwa Jul 6, 2022
03a97c0
Update documents code-sample for v0.28.0 (#1292)
bidoubiwa Jul 6, 2022
734b6d0
Fix code sample naming
bidoubiwa Jul 18, 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
66 changes: 41 additions & 25 deletions .code-samples.meilisearch.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,17 @@
get_one_index_1: |-
client.index('movies').getRawInfo()
list_all_indexes_1: |-
client.getIndexes()
client.getIndexes({ limit: 3 })
create_an_index_1: |-
client.createIndex('movies', { primaryKey: 'id' })
update_an_index_1: |-
client.updateIndex('movies', { primaryKey: 'id' })
delete_an_index_1: |-
client.deleteIndex('movies')
get_one_document_1: |-
client.index('movies').getDocument(25684)
client
.index('movies')
.getDocument(25684, { fields: ['id', 'title', 'poster', 'release_date'] })
get_documents_1: |-
client.index('movies').getDocuments({ limit: 2 })
add_or_replace_documents_1: |-
Expand All @@ -41,18 +43,22 @@ search_post_1: |-
client.index('movies').search('American ninja')
search_get_1: |-
client.index('movies').search('American ninja')
get_task_by_index_1: |-
client.index('movies').getTask(1)
get_all_tasks_by_index_1: |-
client.index('movies').getTasks()
get_all_tasks_1: |-
client.getTasks()
get_task_1: |-
client.getTask(1)
get_all_tasks_filtering_1: |-
client.getTasks({ indexUid: ['movies'] })
get_all_tasks_filtering_2: |-
client.getTasks({ status: ['succeeded', 'failed'], type: ['documentAdditionOrUpdate'] })
get_all_tasks_paginating_1: |-
client.getTasks({ limit: 2, from: 10 })
get_all_tasks_paginating_2: |-
client.getTasks({ limit: 2, from: 8 })
get_one_key_1: |-
client.getKey('d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4')
client.getKey('6062abda-a5aa-4414-ac91-ecd7944c0f8d')
get_all_keys_1: |-
client.getKeys()
client.getKeys({ limit: 3 })
create_a_key_1: |-
client.createKey({
description: 'Add documents: Products API key',
Expand All @@ -61,20 +67,12 @@ create_a_key_1: |-
expiresAt: '2021-11-13T00:00:00Z'
})
update_a_key_1: |-
client.updateKey('d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4', {
client.updateKey('6062abda-a5aa-4414-ac91-ecd7944c0f8d', {
name: 'Products/Reviews API key',
description: 'Manage documents: Products/Reviews API key',
actions: [
'documents.add',
'documents.delete'
],
indexes: [
'products',
'reviews'
],
expiresAt: '2021-12-31T23:59:59Z'
})
delete_a_key_1: |-
client.deleteKey('d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4')
client.deleteKey('6062abda-a5aa-4414-ac91-ecd7944c0f8d')
get_settings_1: |-
client.index('movies').getSettings()
update_settings_1: |-
Expand Down Expand Up @@ -122,6 +120,12 @@ update_settings_1: |-
'disableOnAttributes': [
'title'
]
},
pagination: {
maxTotalHits: 5000
},
faceting: {
maxValuesPerFacet: 200
}
})
reset_settings_1: |-
Expand Down Expand Up @@ -271,7 +275,7 @@ search_parameter_guide_highlight_tag_1: |-
highlightPreTag: '<span class="highlight">',
highlightPostTag: '</span>'
})
search_parameter_guide_matches_1: |-
search_parameter_guide_show_matches_position_1: |-
client.index('movies').search('winter feast', {
showMatchesPosition: true
})
Expand Down Expand Up @@ -438,7 +442,7 @@ getting_started_update_searchable_attributes: |-
getting_started_update_stop_words: |-
client.index('movies').updateStopWords(['the'])
getting_started_check_task_status: |-
client.index('movies').getTask(0)
client.getTask(0)
getting_started_synonyms: |-
client.index('movies').updateSynonyms({
winnie: ['piglet'],
Expand Down Expand Up @@ -494,7 +498,7 @@ faceted_search_filter_1: |-
.search('thriller', {
filter: [['genres = Horror', 'genres = Mystery'], 'director = "Jordan Peele"']
})
faceted_search_facets_distribution_1: |-
faceted_search_facets_1: |-
client.index('movies')
.search('Batman', {
facets: ['genres']
Expand Down Expand Up @@ -541,6 +545,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 }})
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 Expand Up @@ -575,8 +591,8 @@ security_guide_search_key_1: |-
client.index('patient_medical_records').search()
security_guide_update_key_1: |-
const client = new MeiliSearch({ host: 'http://localhost:7700', apiKey: 'masterKey' })
client.updateKey('d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4', {
indexes: ['doctors']
client.updateKey('74c9c733-3368-4738-bbe5-1d18a5fecb37', {
description: 'Default Search API Key'
})
security_guide_create_key_1: |-
const client = new MeiliSearch({ host: 'http://localhost:7700', apiKey: 'masterKey' })
Expand All @@ -591,7 +607,7 @@ security_guide_list_keys_1: |-
client.getKeys()
security_guide_delete_key_1: |-
const client = new MeiliSearch({ host: 'http://localhost:7700', apiKey: 'masterKey' })
client.getKey('d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4')
client.getKey('ac5cd97d-5a4b-4226-a868-2d0eb6d197ab')
authorization_header_1: |-
const client = new MeiliSearch({ host: 'http://localhost:7700', apiKey: 'masterKey' })
client.getKeys()
Expand Down