Release v0.24.0 (#88)

* Raise `1000` positions limit to `65535` for document attribute (#80) * Add specification file * fix typos * Update text/0077-words-position-limit.md Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com> Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com> * Error Format (#61) * Patch GeoSearch specification to mention technical limit on `desc` ordering around a _geoPoint (#66) * mention decision and expected behavior for a desc ordering around a geoPoint * add desc ordering around a geoPoint as a future possibility * add descending order capability for _geoPoint built-in sort (#77) * Sort (#55) * initialize sort specification * wip specification body * fix typos and details * Add OpenAPI changes * Rename API routes * fix typo * add a part about measuring success * specify metrics to send on Amplitude * add lexicographical order for string type * Typos, invalid_sort error definition * Apply suggestions from code review Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com> * remove non correct information about mistyped ranking rule that do not raise error * fix typos from reviews * Update text/0055-sort.md Co-authored-by: gui machiavelli <gui@meilisearch.com> Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com> Co-authored-by: gui machiavelli <gui@meilisearch.com> * Initialize draft specification for error object format * reorganize and fix typos * update oas with the new error format * Add full list of errors * Add invalid_geo_field error description * Add task_not_found definition * Add mention of error object fields order in response * Apply suggestions from code review Co-authored-by: gui machiavelli <gui@meilisearch.com> * enhance the missing_primary_key error * add know variants for message for a given error * fix oas * remove invalid_sort variant message for _geoPoint descending order * fix typos * sync new variants with geosearch error handling on ranking rule * Update variants for invalid_filter and invalid_sort regarding geosearch * add missing dot at the end of error message * experiment bump.sh diff fixs * update bump.yml * update errors in oas Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com> Co-authored-by: gui machiavelli <gui@meilisearch.com> * Patch error format and messages (#87) * Describes invalid_document_id error * fix document_fields_limit_reached payload representation * add backtick character for interpolated value on all error message * Add variant for malformed_payload and add current primaryKey information on index_primary_key_already_exist error message * update index_primary_key_already_exists error message since behavior has changed * update index_primary_key_already_exists error message * update payload_too_large message * update payload_too_large message * bump open-api file MeiliSearch version to v0.24.0 * update error examples * Rework Analytics Stack (#84) * Rework analytics specification * Rephrase and fix typos * Apply suggestions from code review Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com> Co-authored-by: Irevoire <tamo@meilisearch.com> * Add requests count on search endpoints * Update context.app and infos * Add an event table and a summarized Metrics/Events table views * Rephrase aggregated metrics * remove launched as trigger for instance system, stats, infos metrics * Standardize metric and event descriptions (#86) * update primary_key on aggregated events Documents Added and Documents Updated * fix typos * Keep native content-type * Update text/0034-telemetry-policies.md Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> * Remove usage of /tmp and use common config_dir instead * fix typos * fix uuid to uid * remove stats before start_since_days * fix order of magnitude for database_size, disk_size and ram_size Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com> Co-authored-by: Irevoire <tamo@meilisearch.com> Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> * Fix documentation of search `sort` query param (#91) It seems there's a missing empty line to differentiate two call-outs in the documentation of the `sort` query parameter of the `GET` search route. Strangely enough, the `POST` search route doesn't have this `info` call-out maybe it's an oversight? Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com> Co-authored-by: gui machiavelli <gui@meilisearch.com> Co-authored-by: Irevoire <tamo@meilisearch.com> Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> Co-authored-by: Paul B <paul+gh@bonaud.fr>
meilisearch · Nov 16, 2021 · 1de1a98 · 1de1a98
1 parent cd39626
commit 1de1a98
Show file tree

Hide file tree

Showing 5 changed files with 1,323 additions and 118 deletions.
diff --git a/.github/workflows/bump.yml b/.github/workflows/bump.yml
@@ -5,7 +5,6 @@ on:
     branches:
       - main
       - develop
-
 jobs:
   api-diff:
     if: ${{ github.event_name == 'pull_request' }}

diff --git a/open-api.yaml b/open-api.yaml
@@ -2,7 +2,7 @@ openapi: 3.1.0
 info:
   title: MeiliSearch Core API
   description: 'Search documents, configure and manage the MeiliSearch engine.'
-  version: 0.23.0
+  version: 0.24.0
   contact:
     name: MeiliSearch
     email: bonjour@meilisearch.com
@@ -189,6 +189,9 @@ components:
 
         > warn
         > Attribute(s) used in `sort` should be declared as sortable attributes. See [Sorting](https://docs.meilisearch.com/reference/features/sorting.html).
+
+        > info
+        > _geoPoint({lat}, {long}) built-in sort rule can be used to sort documents around a geo point.
       example:
         - 'price:desc'
       title: sort
@@ -493,17 +496,17 @@ components:
       properties:
         message:
           type: string
-        errorCode:
+        code:
           type: string
-        errorType:
+        type:
           type: string
-        errorLink:
+        link:
           type: string
       required:
         - message
-        - errorCode
-        - errorType
-        - errorLink
+        - code
+        - type
+        - link
       description: ''
   parameters:
     indexUid:
@@ -623,6 +626,7 @@ components:
 
         > warn
         > Attribute(s) used in `sort` should be declared as sortable attributes. See [Sorting](https://docs.meilisearch.com/reference/features/sorting.html).
+
         > info
         > _geoPoint({lat}, {long}) built-in sort rule can be used to sort documents around a geo point.
     filter:
@@ -683,10 +687,10 @@ components:
           examples:
             Unauthorized:
               value:
-                message: You must have an authorization token
-                errorCode: missing_authorization_header
-                errorType: authentication_error
-                errorLink: 'https://docs.meilisearch.com/errors#missing_authorization_header'
+                message: The X-MEILI-API-KEY header is missing.
+                code: missing_authorization_header
+                type: auth
+                link: 'https://docs.meilisearch.com/errors#missing_authorization_header'
     '413':
       description: Payload Too Large
       content:
@@ -696,10 +700,10 @@ components:
           examples:
             Payload Too Large:
               value:
-                message: Payload reached size limit.
-                errorCode: payload_too_large
-                errorType: invalid_request_error
-                errorLink: 'https://docs.meilisearch.com/errors#payload_too_large'
+                message: The provided payload reached the size limit.
+                code: payload_too_large
+                type: invalid_request
+                link: 'https://docs.meilisearch.com/errors#payload_too_large'
   securitySchemes:
     apiKey:
       type: apiKey
@@ -817,9 +821,9 @@ paths:
                 Not Found:
                   value:
                     message: Dump `20201001-110357260` not found
-                    errorCode: not_found
-                    errorType: invalid_request_error
-                    errorLink: 'https://docs.meilisearch.com/errors#not_found'
+                    code: dump_not_found
+                    type: invalid_request
+                    link: 'https://docs.meilisearch.com/errors#dump_not_found'
     parameters:
       - schema:
           type: string
@@ -924,16 +928,16 @@ paths:
               examples:
                 Index already exists:
                   value:
-                    message: Index already exists.
-                    errorCode: index_already_exists
-                    errorType: invalid_request_error
-                    errorLink: 'https://docs.meilisearch.com/errors#index_already_exists'
+                    message: Index `:indexUid` already exists.
+                    code: index_already_exists
+                    type: invalid_request
+                    link: 'https://docs.meilisearch.com/errors#index_already_exists'
                 Invalid Index Uid:
                   value:
-                    message: 'Index must have a valid uid; Index uid can be of type integer or string only composed of alphanumeric characters, hyphens (-) and underscores (_).'
-                    errorCode: invalid_index_uid
-                    errorType: invalid_request_error
-                    errorLink: 'https://docs.meilisearch.com/errors#invalid_index_uid'
+                    message: '`:indexUid` is not a valid index uid. Index uid can be an integer or a string containing only alphanumeric characters, hyphens (-) and underscores (_).'
+                    code: invalid_index_uid
+                    type: invalid_request
+                    link: 'https://docs.meilisearch.com/errors#invalid_index_uid'
         '401':
           $ref: '#/components/responses/401'
       parameters:
@@ -1002,10 +1006,10 @@ paths:
               examples:
                 Primary Key Already Present:
                   value:
-                    message: A primary key is already present. It's impossible to update it
-                    errorCode: primary_key_already_present
-                    errorType: invalid_request_error
-                    errorLink: 'https://docs.meilisearch.com/errors#primary_key_already_present'
+                    message: Index `:indexUid` already has a primary key.
+                    code: index_primary_key_already_exists
+                    type: invalid_request
+                    link: 'https://docs.meilisearch.com/errors#index_primary_key_already_exists'
         '401':
           $ref: '#/components/responses/401'
         '404':