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.

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

v1.1 #2193

Merged
merged 46 commits into from
Apr 3, 2023
Merged

v1.1 #2193

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
46 commits
Select commit Hold shift + click to select a range
86f8d97
version bump
guimachiavelli Mar 8, 2023
9f91cd0
v1.1: Use wildcard (*) when creating API keys
maryamsulemani97 Mar 9, 2023
0bff896
v1.1: Use wildcard (*) when creating tenant tokens
maryamsulemani97 Mar 9, 2023
5d117d5
v1.1: Batch document additions and deletions
maryamsulemani97 Mar 9, 2023
566bb2d
Bump Docker image URLs to latest stable release
guimachiavelli Mar 9, 2023
75efab5
WIP: geosearch: add `_geoBoundingBox`
guimachiavelli Mar 9, 2023
91ad203
geosearch: add `_geoBoundingBox`
guimachiavelli Mar 13, 2023
7579339
experimental: add metrics endpoint
guimachiavelli Mar 13, 2023
fdeeb45
WIP: add `csvDelimiter` to document endpoints
guimachiavelli Mar 13, 2023
fa4f01e
Apply suggestions from code review
maryamsulemani97 Mar 14, 2023
d76cb18
Apply suggestions from code review
maryamsulemani97 Mar 14, 2023
497062b
update index size/count limits
guimachiavelli Mar 14, 2023
b31ca86
add new code sample
guimachiavelli Mar 14, 2023
465f677
improve geosearch wording
guimachiavelli Mar 14, 2023
10b10d3
metrics: improve wording, move menu location
guimachiavelli Mar 14, 2023
e951008
csv delimiter: improve wording
guimachiavelli Mar 14, 2023
a83c6f3
index size/count: improve wording
guimachiavelli Mar 14, 2023
cc5ba41
Update learn/advanced/known_limitations.md
guimachiavelli Mar 15, 2023
f18cf74
metrics: address reviewer feedback
guimachiavelli Mar 15, 2023
2fe74be
csv delimiter: address reviewer feedback
guimachiavelli Mar 15, 2023
688bc66
Apply suggestions from code review
guimachiavelli Mar 16, 2023
924d881
Update learn/advanced/known_limitations.md
guimachiavelli Mar 16, 2023
704b931
geosearch: address reviewer feedback
guimachiavelli Mar 16, 2023
25f3c10
index size limitations: address reviewer feedback
guimachiavelli Mar 16, 2023
5c7f094
Update learn/experimental/metrics.md
guimachiavelli Mar 16, 2023
86c275c
update postman
maryamsulemani97 Mar 20, 2023
cddf759
update file
maryamsulemani97 Mar 20, 2023
c8ab47d
error codes: update and fix list of reserved words
guimachiavelli Mar 20, 2023
6d8efb1
address reviewer feedback
guimachiavelli Mar 20, 2023
44bab14
Apply suggestions from code review
maryamsulemani97 Mar 21, 2023
11dc969
Update reference/api/keys.md
maryamsulemani97 Mar 21, 2023
5b3048d
update based on review
maryamsulemani97 Mar 21, 2023
fa62497
Apply suggestions from code review
guimachiavelli Mar 21, 2023
b265735
update telemetry table
guimachiavelli Mar 21, 2023
92b0b09
Apply suggestions from code review
guimachiavelli Mar 21, 2023
0989d40
update _geoBoundingSearch parameter following last minute change
guimachiavelli Mar 29, 2023
c5bbee6
Merge #2213
bors[bot] Mar 30, 2023
96cc102
Merge #2210
bors[bot] Mar 30, 2023
4c35fbc
Merge #2209 #2229
bors[bot] Mar 30, 2023
4824f73
Apply suggestions from code review
guimachiavelli Mar 30, 2023
b0a7119
Merge #2214
bors[bot] Mar 30, 2023
9937154
Merge #2216 #2222 #2224 #2231
bors[bot] Mar 30, 2023
9df337f
Merge #2223
bors[bot] Mar 30, 2023
4084399
multi-index take 3
maryamsulemani97 Apr 3, 2023
a5bba97
Merge #2263
bors[bot] Apr 3, 2023
bc6f4f3
Merge branch 'main' into v1.1
guimachiavelli Apr 3, 2023
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
85 changes: 75 additions & 10 deletions .code-samples.meilisearch.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -567,16 +567,6 @@ getting_started_communicating_with_a_protected_instance: |-
curl \
-X POST 'http://localhost:7700/indexes/movies/search' \
-H 'Authorization: Bearer API_KEY'
faceted_search_update_settings_1: |-
curl \
-X PATCH 'http://localhost:7700/indexes/movie_ratings/settings' \
-H 'Content-Type: application/json' \
--data-binary '{
"filterableAttributes": [
"director",
"genres"
]
}'
faceted_search_facets_1: |-
curl \
-X POST 'http://localhost:7700/indexes/movies/search' \
Expand Down Expand Up @@ -693,6 +683,11 @@ geosearch_guide_filter_usage_2: |-
-X POST 'http://localhost:7700/indexes/restaurants/search' \
-H 'Content-type:application/json' \
--data-binary '{ "filter": "_geoRadius(45.472735, 9.184019, 2000) AND type = pizza" }'
geosearch_guide_filter_usage_3: |-
curl \
-X POST 'http://localhost:7700/indexes/restaurants/search' \
-H 'Content-type:application/json' \
--data-binary '{ "filter": "_geoBoundingBox([45.494181, 9.214024], [45.449484, 9.179175])" }'
geosearch_guide_sort_settings_1: |-
curl \
-X PUT 'http://localhost:7700/indexes/restaurants/settings/sortable-attributes' \
Expand Down Expand Up @@ -993,3 +988,73 @@ swap_indexes_1: |
]
}
]'
multi_search_1: |-
curl \
-X POST 'http://localhost:7700/multi-search' \
-H 'Content-Type: application/json' \
--data-binary '{
"queries": [
{
"indexUid": "movies",
"q": "pooh",
"limit": 5
},
{
"indexUid": "movies",
"q": "nemo",
"limit": 5
},
{
"indexUid": "movie_ratings",
"q": "us"
}
]
}'
faceted_search_update_settings_1: |-
curl \
-X PUT 'http://localhost:7700/indexes/books/settings/filterable-attributes' \
-H 'Content-Type: application/json' \
--data-binary '[
"genres", "rating", "language"
]'
faceted_search_1: |-
curl \
-X POST 'http://localhost:7700/indexes/books/search' \
-H 'Content-Type: application/json' \
--data-binary '{
"q": "classic",
"facets": [
"genres", "rating", "language"
]
}'
search_parameter_guide_facet_stats_1: |-
curl \
-X POST 'http://localhost:7700/indexes/movie_ratings/search' \
-H 'Content-Type: application/json' \
--data-binary '{
"q": "Batman",
"facets": ["genres", "rating"]
}'
faceted_search_2: |-
curl \
-X POST 'http://localhost:7700/multi-search' \
-H 'Content-Type: application/json' \
--data-binary '{
"queries": [
{
"indexUid": "books",
"facets": ["language", "genres", "author", "format"],
"filter": "(language = English AND language = French) OR genres = Fiction"
},
{
"indexUid": "books",
"facets": ["language"],
"filter": "genres = Fiction"
},
{
"indexUid": "books",
"facets": ["genres"],
"filter": "language = English OR language = French"
}
]
}'
14 changes: 12 additions & 2 deletions .vuepress/config.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
const ogprefix = 'og: http://ogp.me/ns#'
module.exports = {
title: 'Meilisearch Documentation v1.0',
title: 'Meilisearch Documentation v1.1',
description: 'Open source Instant Search Engine',
theme: 'default-prefers-color-scheme',
themeConfig: {
Expand Down Expand Up @@ -190,7 +190,8 @@ module.exports = {
collapsable: false,
children: [
'/learn/advanced/asynchronous_operations',
'/learn/advanced/filtering_and_faceted_search',
'/learn/advanced/filtering',
'/learn/advanced/faceted_search',
'/learn/advanced/geosearch',
'/learn/advanced/pagination',
'/learn/advanced/sorting',
Expand Down Expand Up @@ -290,6 +291,14 @@ module.exports = {
},
],
},
{
title: '🧪 Experimental',
path: '/learn/experimental/metrics.html',
collapsable: false,
children: [
'/learn/experimental/metrics',
],
},
{
title: '👐 Contributing',
path: '/learn/contributing/overview.html',
Expand Down Expand Up @@ -319,6 +328,7 @@ module.exports = {
'/reference/api/indexes',
'/reference/api/documents',
'/reference/api/search',
'/reference/api/multi_search',
'/reference/api/tasks',
'/reference/api/keys',
'/reference/api/settings',
Expand Down
15 changes: 11 additions & 4 deletions .vuepress/public/_redirects
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@
/guides/advanced_guides/installation.html /learn/getting_started/installation.html
/guides/advanced_guides/configuration.html /learn/configuration/instance_options.html
/guides/advanced_guides/search_parameters.html /reference/api/search.html
/guides/advanced_guides/filtering.html /learn/advanced/filtering_and_faceted_search.html
/guides/advanced_guides/faceted_search.html /learn/advanced/filtering_and_faceted_search.html
/guides/advanced_guides/filtering.html /learn/advanced/filtering.html
/guides/advanced_guides/faceted_search.html /learn/advanced/faceted_search.html
/guides/advanced_guides/authentication.html /learn/security/master_api_keys.html
/guides/advanced_guides/asynchronous_updates.html /learn/advanced/asynchronous_operations.html
/guides/advanced_guides/web_interface.html /learn/what_is_meilisearch/search_preview.html
Expand Down Expand Up @@ -77,8 +77,8 @@

# Group filters and facets content
/reference/api/attributes_for_faceting.html /reference/api/settings.html
/reference/features/filtering.html /learn/advanced/filtering_and_faceted_search.html
/reference/features/faceted_search.html /learn/advanced/filtering_and_faceted_search.html
/reference/features/filtering.html /learn/advanced/filtering.html
/reference/features/faceted_search.html /learn/advanced/faceted_search.html

# Rename Asynchronous updates to Asynchronous operations
/learn/advanced/asynchronous_updates.html /learn/advanced/asynchronous_operations.html
Expand Down Expand Up @@ -203,3 +203,10 @@
# New "Update and migration" section
/learn/getting_started/algolia_migration.html /learn/update_and_migration/algolia_migration.html
/learn/advanced/updating.html /learn/update_and_migration/updating.html

# Move faceting to a new guide
/learn/advanced/filtering_and_faceted_search.html#faceted-search /learn/advanced/faceted_search.html

# Rename filtering guide
/learn/advanced/filtering_and_faceted_search.html /learn/advanced/filtering.html

145 changes: 145 additions & 0 deletions .vuepress/public/books.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
[
{
"id":5,
"title": "Hard Times",
"genres": ["Classics","Fiction", "Victorian", "Literature"],
"publisher": "Penguin Classics",
"language": "English",
"author": "Charles Dickens",
"description":"Hard Times is a novel of social protest which attacks utilitarianism, Bentham's theory which only considered the practical aspects of happiness and ignored emotional, spiritual and moral values. It is set in Coketown, a fictious industrial city in northern England in the mid-1800s.",
"format": "Hardcover",
"rating": 3
},
{
"id":1,
"title": "Don Quixote",
"genres": ["Satire","Fiction"],
"publisher": "Penguin Classics",
"language": "Spanish",
"author": "Miguel de Cervantes",
"description":"Don Quixote is a classic novel from 1605 which portraits the life and insightful journey of Don Quixote de la Mancha, a Spanish man who seems to be losing his mind on his quest to become a knight and restore chivalry alongside with a farmer named Sancho Panza, with whom he fights multiple imaginary ",
"format": "Hardcover",
"rating": 4
},
{
"id":2,
"title": "The Travels of Ibn Battuta",
"genres": ["Travel","Adventure"],
"publisher": "Dover Publications",
"language": "English",
"author": "Ibn Battuta",
"description":"His main reason to travel was to go on a Hajj, or a Pilgrimage to Mecca, to fulfill the fifth pillar of Isla.. But his traveling went on for around 29 years and he covered about 75,000 miles visiting the equivalent of 44 modern countries which were then mostly under the governments of Muslim leaders of the World of ",
"format": "Hardcover",
"rating": 4.5
},
{
"id":3,
"title": "Les Misérables",
"genres": ["Tragedy", "Fiction", "Novel", "Historical Fiction", "Literature", "Classics"],
"publisher": "Simon & Schuster",
"language": "French",
"author": "Victor Hugo",
"description":"Les Misérables centres on the character Jean Valjean, an ex-convict in 19th-century France. The story spans many years as it tells of Valjean's release from prison and reformation as an industrialist while being constantly pursued by the morally strict inspector Javert.",
"format": "Hardcover",
"rating": 4.7
},
{
"id":4,
"title": "James and the Giant Peach",
"genres": ["Novel","Children's Literature", "Fantasy"],
"publisher": "Puffin Books",
"language": "English",
"author": "Roald Dahl",
"description":"When his parents are unceremoniously eaten by a rhinoceros that escapes from London Zoo, James is forced to go and live with his unpleasant aunts. Through a series of peculiar and magical happenings, James finds himself in a giant peach with a bunch of friendly giant insects for travelling companions.",
"format": "Paperback",
"rating": 4
},
{
"id":6,
"title": "Pride and Prejudice",
"genres": ["Classics","Fiction", "Romance", "Literature"],
"publisher": "Penguin Classics",
"language": "English",
"author": "Jane Austen",
"description":"Pride and Prejudice follows the turbulent relationship between Elizabeth Bennet, the daughter of a country gentleman, and Fitzwilliam Darcy, a rich aristocratic landowner. They must overcome the titular sins of pride and prejudice in order to fall in love and marry.",
"format": "Hardcover",
"rating": 4
},
{
"id":7,
"title": "Diary of a Wimpy Kid",
"genres": ["Humor", "Fiction", "Young Adult", "Comedy","Diary Fiction"],
"publisher": "",
"language": "English",
"author": "Jeff Kinney",
"description":"It's a new school year, and Greg Heffley finds himself thrust into middle school, where undersized weaklings share the hallways with kids who are taller, meaner, and already shaving. The hazards of growing up before you're ready are uniquely revealed through words and drawings as Greg records them in his diary.",
"format": "Hardcover",
"rating": 4.8
},
{
"id":8,
"title": "Anne of Green Gables",
"genres": ["Literature", "Fiction", "Novel", "Comedy", "Coming-of-Age"],
"publisher": "Wordsworth Editions Ltd",
"language": "English",
"author": "Lucy M. Montgomery",
"description":"Anne of Green Gables, children's novel by Canadian author Lucy Maud Montgomery, published in 1908. The work, a sentimental but charming coming-of-age story about a spirited and unconventional orphan girl who finds a home with elderly siblings, became a classic of children's literature and led to several sequels.",
"format": "Hardcover",
"rating": 4
},
{
"id":9,
"title": "Harry Potter and the Chamber of Secrets",
"genres": ["Fantasy", "Fiction", "Magic", "Adventure", "Young Adult"],
"publisher": "Bloomsbury Publishing PLC",
"language": "English",
"author": "J.K. Rowling",
"description":"The second instalment of boy wizard Harry Potter's adventures at Hogwarts School of Witchcraft and Wizardry, based on the novel by JK Rowling. A mysterious elf tells Harry to expect trouble during his second year at Hogwarts, but nothing can prepare him for trees that fight back, flying cars, spiders that talk and deadly warnings written in blood on the walls of the school.",
"format": "Paperback",
"rating": 2
},
{
"id":10,
"title": "David Copperfield",
"genres": ["Classics","Fiction", "Victorian", "Literature"],
"publisher": "Penguin UK",
"language": "English",
"author": "Charles Dickens",
"description":"The story follows the life of David Copperfield from childhood to maturity. David was born in Blunderstone, Suffolk, England, six months after the death of his father. David spends his early years in relative happiness with his loving, childish mother and their kindly housekeeper, Clara Peggotty.",
"format": "Hardcover",
"rating": 3.9
},
{
"id":11,
"title": "Dracula",
"genres": ["Classics","Fiction", "Horror", "Literature", "Vampires", "Fantasy"],
"publisher": "Penguin UK",
"language": "English",
"author": "Bram Stoker",
"description":"Dracula is a gothic novel by Bram Stoker published in 1897. Stoker tells the story of the fight against the vampire Dracula in an epistolary format. The story comprises various letters, telegrams, journal entries, and newspaper articles written by the main characters.",
"format": "Hardcover",
"rating": 2.5
},
{
"id":12,
"title": "Frankenstein",
"genres": ["Classics","Fiction", "Horror", "Literature", "Fantasy"],
"publisher": "Penguin UK",
"language": "English",
"author": "Mary Shelley",
"description":"Frankenstein tells the story of gifted scientist Victor Frankenstein who succeeds in giving life to a being of his own creation. However, this is not the perfect specimen he imagines that it will be, but rather a hideous creature who is rejected by Victor and mankind in general.",
"format": "Hardcover",
"rating": 3
},
{
"id":13,
"title": "Madame Bovary",
"genres": ["Novel","Fiction", "Realism", "Literature"],
"publisher": "Penguin UK",
"language": "French",
"author": "Gustave Flaubert",
"description":"Madame Bovary is the debut novel of French writer Gustave Flaubert, published in 1856. The character lives beyond her means in order to escape the banalities and emptiness of provincial life. When the novel was first serialized in La Revue de Paris between 1 October 1856 and 15 December 1856, public prosecutors attacked the novel for obscenity. The resulting trial in January 1857 made the story notorious. After Flaubert's acquittal on 7 February 1857, Madame Bovary became a bestseller in April 1857 when it was published in two volumes. A seminal work of literary realism, the novel is now considered Flaubert's masterpiece, and one of the most influential literary works in history.",
"format": "Hardcover",
"rating": 4
}
]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .vuepress/public/faceted-search/facets-ecommerce.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .vuepress/public/faceted-search/multi-search.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading