diff --git a/.code-samples.meilisearch.yaml b/.code-samples.meilisearch.yaml index ea1a6668..f77f5e25 100644 --- a/.code-samples.meilisearch.yaml +++ b/.code-samples.meilisearch.yaml @@ -452,7 +452,7 @@ primary_field_guide_add_document_primary_key: |- ] ], 'reference_number'); authorization_header_1: |- - $client = new Client('MEILISEARCH_URL', 'masterKey'); + $client = new Client('MEILISEARCH_URL', 'MEILISEARCH_KEY'); $client->getKeys(); tenant_token_guide_generate_sdk_1: |- $apiKeyUid = '85c3c2f9-bdd6-41f1-abd8-11fcf80e0f76'; diff --git a/README.md b/README.md index 5550c0eb..bae16d59 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ Discord | Roadmap | Website | - FAQ + FAQ

@@ -41,7 +41,7 @@ ## 📖 Documentation -To learn more about Meilisearch PHP, refer to the in-depth [Meilisearch PHP Documentation](https://php-sdk.meilisearch.com). To learn more about Meilisearch in general, refer to our [documentation](https://www.meilisearch.com/docs/learn/getting_started/quick_start) or our [API reference](https://www.meilisearch.com/docs/reference/api/overview). +To learn more about Meilisearch PHP, refer to the in-depth [Meilisearch PHP Documentation](https://php-sdk.meilisearch.com). To learn more about Meilisearch in general, refer to our [documentation](https://www.meilisearch.com/docs/learn/self_hosted/getting_started_with_self_hosted_meilisearch) or our [API reference](https://www.meilisearch.com/docs/reference/api/authorization). ## 🔧 Installation @@ -98,7 +98,7 @@ $documents = [ $index->addDocuments($documents); // => { "uid": 0 } ``` -With the `uid`, you can check the status (`enqueued`, `canceled`, `processing`, `succeeded` or `failed`) of your documents addition using the [task](https://www.meilisearch.com/docs/reference/api/tasks#status). +With the `uid`, you can check the status (`enqueued`, `canceled`, `processing`, `succeeded` or `failed`) of your documents addition using the [task](https://www.meilisearch.com/docs/reference/api/async-task-management/list-tasks#status). #### Basic Search @@ -127,7 +127,7 @@ Array #### Custom Search -All the supported options are described in the [search parameters](https://www.meilisearch.com/docs/reference/api/search#search-parameters) section of the documentation. +All the supported options are described in the [search parameters](https://www.meilisearch.com/docs/reference/api/search/search-with-post#search-parameters) section of the documentation. 💡 **More about the `search()` method in [the Wiki](https://github.com/meilisearch/meilisearch-php/wiki/Search).** @@ -175,7 +175,7 @@ $index->updateFilterableAttributes([ You only need to perform this operation once. -Note that Meilisearch will rebuild your index whenever you update `filterableAttributes`. Depending on the size of your dataset, this might take time. You can track the process using the [tasks](https://www.meilisearch.com/docs/reference/api/tasks#get-tasks)). +Note that Meilisearch will rebuild your index whenever you update `filterableAttributes`. Depending on the size of your dataset, this might take time. You can track the process using the [tasks](https://www.meilisearch.com/docs/reference/api/async-task-management/list-tasks#get-tasks)). Then, you can perform the search: @@ -213,10 +213,10 @@ This package guarantees compatibility with [version v1.x of Meilisearch](https:/ The following sections in our main documentation website may interest you: -- **Manipulate documents**: see the [API references](https://www.meilisearch.com/docs/reference/api/documents) or read more about [documents](https://www.meilisearch.com/docs/learn/core_concepts/documents). -- **Search**: see the [API references](https://www.meilisearch.com/docs/reference/api/search) or follow our guide on [search parameters](https://www.meilisearch.com/docs/reference/api/search#search-parameters). -- **Manage the indexes**: see the [API references](https://www.meilisearch.com/docs/reference/api/indexes) or read more about [indexes](https://www.meilisearch.com/docs/learn/core_concepts/indexes). -- **Configure the index settings**: see the [API references](https://www.meilisearch.com/docs/reference/api/settings) or follow our guide on [settings parameters](https://www.meilisearch.com/docs/learn/configuration/settings). +- **Manipulate documents**: see the [API references](https://www.meilisearch.com/docs/reference/api/documents/list-documents-with-get) or read more about [documents](https://www.meilisearch.com/docs/learn/getting_started/documents). +- **Search**: see the [API references](https://www.meilisearch.com/docs/reference/api/search/search-with-post) or follow our guide on [search parameters](https://www.meilisearch.com/docs/reference/api/search/search-with-post#search-parameters). +- **Manage the indexes**: see the [API references](https://www.meilisearch.com/docs/reference/api/indexes/list-all-indexes) or read more about [indexes](https://www.meilisearch.com/docs/learn/getting_started/indexes). +- **Configure the index settings**: see the [API references](https://www.meilisearch.com/docs/reference/api/settings/list-all-settings) or follow our guide on [settings parameters](https://www.meilisearch.com/docs/learn/configuration/configuring_index_settings). ## 🧰 HTTP Client Compatibilities diff --git a/src/Contracts/SearchQuery.php b/src/Contracts/SearchQuery.php index 47c557b7..f5cf222b 100644 --- a/src/Contracts/SearchQuery.php +++ b/src/Contracts/SearchQuery.php @@ -258,7 +258,7 @@ public function setShowRankingScore(?bool $showRankingScore): self * It's available after Meilisearch v1.3. * To enable it properly and use ranking scoring details its required to opt-in through the /experimental-features route. * - * More info: https://www.meilisearch.com/docs/reference/api/experimental_features + * More info: https://www.meilisearch.com/docs/reference/api/experimental-features/list-experimental-features * * @param bool $showRankingScoreDetails whether the feature is enabled or not * @@ -399,7 +399,7 @@ public function setFederationOptions(FederationOptions $federationOptions): self * It's available from Meilisearch v1.3. * To enable it properly and use vector store capabilities it's required to activate it through the /experimental-features route. * - * More info: https://www.meilisearch.com/docs/reference/api/experimental_features + * More info: https://www.meilisearch.com/docs/reference/api/experimental-features/list-experimental-features * * @param non-empty-list> $vector a multi-level array floats * diff --git a/src/Endpoints/Delegates/HandlesDocuments.php b/src/Endpoints/Delegates/HandlesDocuments.php index 6032716b..9dbd0be3 100644 --- a/src/Endpoints/Delegates/HandlesDocuments.php +++ b/src/Endpoints/Delegates/HandlesDocuments.php @@ -172,7 +172,7 @@ public function updateDocumentsNdjsonInBatches(string $documents, ?int $batchSiz * It's available after Meilisearch v1.10. * * More info about the feature: https://github.com/orgs/meilisearch/discussions/762 - * More info about experimental features in general: https://www.meilisearch.com/docs/reference/api/experimental_features + * More info about experimental features in general: https://www.meilisearch.com/docs/reference/api/experimental-features/list-experimental-features * * @param non-empty-string $function * @param array{filter?: non-empty-string|list|null, context?: array} $options diff --git a/tests/Exceptions/ApiExceptionTest.php b/tests/Exceptions/ApiExceptionTest.php index 3498ad3e..e8a1819c 100644 --- a/tests/Exceptions/ApiExceptionTest.php +++ b/tests/Exceptions/ApiExceptionTest.php @@ -16,7 +16,7 @@ public function testException(): void 'message' => 'This is the message', 'code' => 'this_is_the_error_code', 'type' => 'this_is_the_error_type', - 'link' => 'https://www.meilisearch.com/docs/errors', + 'link' => 'https://www.meilisearch.com/docs/reference/errors/error_codes', ]; $statusCode = 400;