Skip to content
This repository was archived by the owner on Mar 21, 2024. It is now read-only.

Conversation

gmourier
Copy link
Member

Summary

Add filtering capabilities to the tasks endpoints to facilitate the management of an instance and its indexes, or a specific index.

This first iteration adds filters on the status and type attributes of the task API resource.

Summary Key Points

  • Add filtering capabilities on type and status for GET task lists endpoints.

Motivation

Following the specification aiming to stabilize the task API resource, we want to give users the capability to refine the lists of task according to several criteria to find precise information more quickly.

gmourier and others added 9 commits September 13, 2021 16:15
* initialize a draft for json lines indexation support specification

* update filename number to match related pull-request

* update specs

* update link to CSV spec

* update spec name

* Apply typos correction from code review

Co-authored-by: cvermand <[email protected]>

* fix typo

* update impact on documentation part

* replace file by data

* add information about giving application/json content-type or not for a json payload

* updates error codes, curl instructions

* moved behavior about missing content-type in explanation part

Co-authored-by: cvermand <[email protected]>
* Initiate csv indexation support specification

* update spec file name to match pull request id

* update csv indexation spec

* fix code examples and typos

* fix typos

* update spec name

* Update header part to match MeiliSearch Tracking-Issues

* update spec from the equivalent ndjson spec reviews

* update --data sample examples

* add information about giving application/json content-type or not for a json payload

* Apply suggestions from code review

Co-authored-by: Clément Renault <[email protected]>

* Change curl --data param to --binary-data in examples

Co-authored-by: Clément Renault <[email protected]>

* updates error codes

* moved behavior about missing content-type in explanation part

* Apply suggestions from code review

Co-authored-by: Clément Renault <[email protected]>

Co-authored-by: Clément Renault <[email protected]>
* 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 <[email protected]>

* 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 <[email protected]>

Co-authored-by: Clémentine Urquizar <[email protected]>
Co-authored-by: gui machiavelli <[email protected]>
* Initialize draft specification for geo-search feature

* add future possibilities

* Update specification

* mention errors and aspects about filterableAttributes and sortableAttributes

* Add measure and finalized key changes

* Add description in OpenApi

* remove old falsy sentence

* Add definition and explanation for  error

* fix rebase on develop

* Specify missing edge cases (#63)

* Initialize draft specification for geo-search feature

* add future possibilities

* Update specification

* mention errors and aspects about filterableAttributes and sortableAttributes

* Add measure and finalized key changes

* Add description in OpenApi

* remove old falsy sentence

* Add definition and explanation for  error

* fix rebase on develop

* update open-api.yml with description on _geoPoint built-in sort rule and _geo field

* Apply suggestions from code review

Co-authored-by: gui machiavelli <[email protected]>

* remove - char in geo-search

* update invalid_geo_field error definition

Co-authored-by: gui machiavelli <[email protected]>
…dering 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
* specify error codes dedicated to payload format for post/put documents endpoints

* Udpdate error codes naming

* Add errors definition

* update errors and cURL examples
…rion error definition (#67)

* add alternative message for reserved keyword and update invalid_criterion error

* update error name in link field for invalid_ranking_rule error

* update invalid_geo_field error message

* fix typo
@gmourier gmourier added the In Progress Feature specification is in elaboration. Important changes can still occurs in the specification. label Sep 14, 2021
@gmourier
Copy link
Member Author

Closed in favor of #116

@gmourier gmourier closed this Feb 21, 2022
@gmourier gmourier deleted the add-filter-for-task-resource-lists branch February 21, 2022 14:53
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

In Progress Feature specification is in elaboration. Important changes can still occurs in the specification.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant