Release v0.23

.github/workflows/bump.yml

@@ -4,18 +4,18 @@ on:
   pull_request:
     branches:
       - main
+      - develop
 
 jobs:
   api-diff:
-    name: Check diff on Bump
+    if: ${{ github.event_name == 'pull_request' }}
+    name: Check API diff on Bump
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-      - name: Comment pull request with API diff
-        uses: bump-sh/github-action@v1
+      - uses: actions/checkout@v2
+      - uses: bump-sh/github-action@v1
         with:
-          doc: 0772e3a7-2923-4d62-95e3-c4339c525968
+          doc: meilisearch
           token: ${{secrets.BUMP_TOKEN}}
           file: open-api.yaml
           command: diff

open-api.yaml

@@ -124,6 +124,7 @@ components:
                 length: 5
               - start: 155
                 length: 5
+      description: ''
       properties:
         _formatted:
           type: object
@@ -140,7 +141,9 @@ components:
             - string
             - number
           description: Retrieve attributes of the document. `attributesToRetrieve` controls these fields.
-      description: ''
+        _geoDistance:
+          type: number
+          description: 'Using _geoPoint({lat}, {lng}) built-in sort rule at search leads the engine to return a _geoDistance within the search results. This field represents the distance in meters of the document from the specified _geoPoint.'
     documentId:
       oneOf:
         - type: number
@@ -156,6 +159,9 @@ components:
         - String: `"something > 1 AND genres=comedy AND (genres=horror OR title=batman)"`
         - Mixed: `["something > 1 AND genres=comedy", "genres=horror OR title=batman"]`
 
+        > info
+        > _geoRadius({lat}, {lng}, {distance_in_meters}) built-in filter rule can be used to filter documents within a geo circle.
+
         > warn
         > Attribute(s) used in `filter` should be declared as filterable attributes. See [Filtering and Faceted Search](https://docs.meilisearch.com/reference/features/filtering_and_faceted_search.html).
       example:
@@ -361,7 +367,7 @@ components:
         - attribute
         - sort
         - exactness
-        - release_date:asc
+        - 'release_date:asc'
       examples: []
     filterableAttributes:
       type: array
@@ -617,6 +623,8 @@ 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:
       name: filter
       in: query
@@ -632,8 +640,20 @@ components:
         - String: `something > 1 AND genres=comedy AND (genres=horror OR title=batman)`
         - Mixed: `["something > 1 AND genres=comedy", "genres=horror OR title=batman"]`
 
+        > info
+        > _geoRadius({lat}, {lng}, {distance_in_meters}) built-in filter rule can be used to filter documents within a geo circle.
+
         > warn
         > Attribute(s) used in `filter` should be declared as filterable attributes. See [Filtering and Faceted Search](https://docs.meilisearch.com/reference/features/filtering_and_faceted_search.html).
+    Content-Type:
+      name: Content-Type
+      in: header
+      required: true
+      schema:
+        type: string
+        enum:
+          - application/json
+      description: Payload content-type
   responses:
     '202':
       description: Accepted
@@ -685,6 +705,10 @@ components:
       type: apiKey
       in: header
       name: X-Meili-API-Key
+      description: |-
+        An API key is a token that you provide when making API calls. Include the token in a header parameter called `X-Meili-API-Key`.
+
+        Example: `X-Meili-API-Key: 8fece4405662dd830e4cb265e7e047aab2e79672a760a12712d2a263c9003509`
   examples: {}
 tags:
   - name: Indexes
@@ -912,6 +936,8 @@ paths:
                     errorLink: 'https://docs.meilisearch.com/errors#invalid_index_uid'
         '401':
           $ref: '#/components/responses/401'
+      parameters:
+        - $ref: '#/components/parameters/Content-Type'
   '/indexes/{indexUid}':
     get:
       operationId: indexes.get
@@ -984,6 +1010,8 @@ paths:
           $ref: '#/components/responses/401'
         '404':
           description: Not Found
+      parameters:
+        - $ref: '#/components/parameters/Content-Type'
     delete:
       operationId: indexes.remove
       summary: Delete Index
@@ -1048,6 +1076,9 @@ paths:
 
         > info
         > If the provided index does not exist, it will be created.
+
+        > info
+        > Use the reserved `_geo` object to add geo coordinates to a document. `_geo` is an object made of `lat` and `lng` field.
       tags:
         - Documents
       security:
@@ -1059,17 +1090,29 @@ paths:
             schema:
               type: array
               items: null
+            examples: {}
       responses:
         '202':
           $ref: '#/components/responses/202'
         '401':
           $ref: '#/components/responses/401'
         '413':
           $ref: '#/components/responses/413'
+      parameters:
+        - schema:
+            type: string
+            enum:
+              - application/json
+              - text/csv
+              - application/x-ndjson
+          in: header
+          name: Content-Type
+          required: true
+          description: The content-type associated with the format to be indexed
     put:
       operationId: indexes.documents.upsert
       summary: Add or update documents
-      description: |
+      description: |-
         Add a list of documents or update them if they already exist.
 
         If you send an already existing document (same [id](https://docs.meilisearch.com/learn/core_concepts/documents.html#primary-key)) the old document will be only partially updated according to the fields of the new document. Thus, any fields not present in the new document are kept and remained unchanged.
@@ -1078,6 +1121,9 @@ paths:
 
         > info
         > If the provided index does not exist, it will be created.
+
+        > info
+        > Use the reserved `_geo` object to add geo coordinates to a document. `_geo` is an object made of `lat` and `lng` field.
       tags:
         - Documents
       security:
@@ -1106,6 +1152,17 @@ paths:
           $ref: '#/components/responses/401'
         '413':
           $ref: '#/components/responses/413'
+      parameters:
+        - schema:
+            type: string
+            enum:
+              - application/json
+              - text/csv
+              - application/x-ndjson
+          in: header
+          name: Content-Type
+          description: The content-type associated with the format to be indexed
+          required: true
     delete:
       operationId: indexes.documents.removeAll
       summary: Delete all documents
@@ -1157,6 +1214,8 @@ paths:
           $ref: '#/components/responses/401'
         '404':
           description: Not Found
+      parameters:
+        - $ref: '#/components/parameters/Content-Type'
     parameters:
       - $ref: '#/components/parameters/indexUid'
   '/indexes/{indexUid}/documents/{documentId}':
@@ -1389,6 +1448,8 @@ paths:
           $ref: '#/components/responses/401'
         '404':
           description: Not Found
+      parameters:
+        - $ref: '#/components/parameters/Content-Type'
     parameters:
       - $ref: '#/components/parameters/indexUid'
   '/indexes/{indexUid}/settings':
@@ -1446,7 +1507,7 @@ paths:
                       - attribute
                       - sort
                       - exactness
-                      - release_date:asc
+                      - 'release_date:asc'
                     distinctAttribute: ean13
                     searchableAttributes:
                       - title
@@ -1543,7 +1604,7 @@ paths:
                     - attribute
                     - sort
                     - exactness
-                    - release_date:asc
+                    - 'release_date:asc'
                   distinctAttribute: ean13
                   searchableAttributes:
                     - title
@@ -1563,6 +1624,8 @@ paths:
           $ref: '#/components/responses/401'
         '404':
           description: Not Found
+      parameters:
+        - $ref: '#/components/parameters/Content-Type'
     delete:
       operationId: indexes.settings.reset
       summary: Reset settings
@@ -1631,6 +1694,8 @@ paths:
           $ref: '#/components/responses/401'
         '404':
           description: Not Found
+      parameters:
+        - $ref: '#/components/parameters/Content-Type'
     delete:
       operationId: indexes.settings.synonyms.reset
       summary: Reset synonyms
@@ -1675,6 +1740,9 @@ paths:
       summary: Update sortable attributes
       description: |
         Update the list of [sortableAttributes](https://docs.meilisearch.com//reference/features/settings.html#sortable-attributes) of an index.
+
+        > info
+        > In order to enable sorting capabilities on geographic data, the `_geo` field must be added as a sortableAttribute.
       tags:
         - Settings
       security:
@@ -1694,6 +1762,8 @@ paths:
           $ref: '#/components/responses/401'
         '404':
           description: Not Found
+      parameters:
+        - $ref: '#/components/parameters/Content-Type'
     delete:
       operationId: indexes.settings.sortable-attributes.reset
       summary: Reset sortable attributes
@@ -1767,6 +1837,8 @@ paths:
           $ref: '#/components/responses/401'
         '404':
           description: Not Found
+      parameters:
+        - $ref: '#/components/parameters/Content-Type'
     delete:
       operationId: indexes.settings.stopWords.reset
       summary: Reset stop-words
@@ -1836,6 +1908,8 @@ paths:
           $ref: '#/components/responses/401'
         '404':
           description: Not Found
+      parameters:
+        - $ref: '#/components/parameters/Content-Type'
     delete:
       operationId: indexes.settings.rankingRules.reset
       summary: Reset ranking rules
@@ -1888,6 +1962,9 @@ paths:
       description: |
         Update the [filterable attributes](https://docs.meilisearch.com/reference/features/settings.html#filterable-attributes) of an index.
 
+        > info
+        > In order to enable filtering capabilities on geographic data, the `_geo` field must be added as a filterableAttribute.
+
         > info
         > If the provided index does not exist, it will be created.
       tags:
@@ -1907,6 +1984,8 @@ paths:
             schema:
               $ref: '#/components/schemas/filterableAttributes'
         description: ''
+      parameters:
+        - $ref: '#/components/parameters/Content-Type'
     delete:
       operationId: indexes.settings.filterableAttributes.reset
       summary: Reset Filterable Attributes
@@ -1972,6 +2051,8 @@ paths:
           $ref: '#/components/responses/401'
         '404':
           description: Not Found
+      parameters:
+        - $ref: '#/components/parameters/Content-Type'
     delete:
       operationId: indexes.settings.distinctAttribute.reset
       summary: Reset distinct attribute
@@ -2036,6 +2117,8 @@ paths:
           $ref: '#/components/responses/401'
         '404':
           description: Not Found
+      parameters:
+        - $ref: '#/components/parameters/Content-Type'
     delete:
       operationId: indexes.settings.searchableAttributes.reset
       summary: Reset searchable attributes
@@ -2100,6 +2183,8 @@ paths:
           $ref: '#/components/responses/401'
         '404':
           description: Not Found
+      parameters:
+        - $ref: '#/components/parameters/Content-Type'
     delete:
       operationId: indexes.settings.displayedAttributes.reset
       summary: Reset displayed attributes
@@ -2336,7 +2421,7 @@ paths:
                   value:
                     commitSha: b46889b5f0f2f8b91438a08a358ba8f05fc09fc1
                     commitDate: '2021-07-08'
-                    pkgVersion: 0.22.0
+                    pkgVersion: 0.23.0
         '401':
           $ref: '#/components/responses/401'
 security: []