Skip to content

Add missing code samples for Mintlify #3430

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
curquiza merged 1 commit into from
Jan 8, 2026
Merged

Add missing code samples for Mintlify #3430

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
36 changes: 33 additions & 3 deletions .code-samples.meilisearch.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# Every example written here will be automatically fetched by
# the documentation on build
---
## BEGIN /references/api
## BEGIN /references/api
# get_indexes_indexUid
get_one_index_1: |-
curl \
Expand Down Expand Up @@ -68,7 +68,7 @@ add_or_update_documents_1: |-
delete_all_documents_1: |-
curl \
-X DELETE 'MEILISEARCH_URL/indexes/movies/documents'
# delete_indexes_indexUid_documentId
# delete_indexes_indexUid_documents_documentId
delete_one_document_1: |-
curl \
-X DELETE 'MEILISEARCH_URL/indexes/movies/documents/25684'
Expand Down Expand Up @@ -581,6 +581,24 @@ update_vector_store_settings_1: |-
reset_vector_store_settings_1: |-
curl \
-X DELETE 'MEILISEARCH_URL/indexes/INDEX_UID/settings/vector-store'
# get_indexes_indexUid_settings_chat
get_chat_settings_1: |-
curl \
-X GET 'MEILISEARCH_URL/indexes/INDEX_NAME/settings/chat'
# patch_indexes_indexUid_settings_chat
update_chat_settings_1: |-
curl \
-X PATCH 'MEILISEARCH_URL/indexes/INDEX_NAME/settings/chat' \
-H 'Content-Type: application/json' \
--data-binary '{
"description": "An index of movies.",
"documentTemplate": "A movie titled '{{doc.title}}' released in {{ doc.release_date }}",
"documentTemplateMaxBytes": 400
}'
# delete_indexes_indexUid_settings_chat
reset_chat_settings_1: |-
curl \
-X DELETE 'MEILISEARCH_URL/indexes/INDEX_NAME/settings/chat'
### END settings + subroutes

# post_dumps
Expand Down Expand Up @@ -655,6 +673,18 @@ delete_documents_by_filter_1: |-
--data-binary '{
"filter": "genres = action OR genres = adventure"
}'
# post_indexes_indexUid_documents_edit
edit_documents_by_function_1: |-
curl \
-X POST 'MEILISEARCH_URL/indexes/movies/documents/edit' \
-H 'Content-Type: application/json' \
--data-binary '{
"function": "doc.new_field = `a]new[value`",
"filter": "id > 3000",
"context": {
"max_title_length": 10
}
}'
# get_experimental_features
get_experimental_features_1: |-
curl \
Expand Down Expand Up @@ -1740,7 +1770,7 @@ multi_search_remote_federated_1: |-
}
}
]

search_parameter_reference_media_1: |-
curl \
-X POST 'MEILISEARCH_URL/indexes/INDEX_NAME/search' \
Expand Down