Tasks API - Rename `uid` to `taskUid` in the `202 - Accepted` Summarized Task Response #144

gmourier · 2022-04-21T10:03:07Z

Why?

Following this discussion, we decided to rename the uid field in a summarized task response (202 Accepted) to taskUid to bring more context and help understanding what is given as a response.

Changes

uid contained in 202 Accepted (Summarized Task Response) is renamed to taskUid

github-actions · 2022-04-21T10:03:29Z

🚨 Breaking API change detected:

Modified (25)

DELETE /indexes/{indexUid}/documents
- Response modified: 202
  - Body attribute added: taskUid
  - [Breaking] Body attribute removed: uid
DELETE /indexes/{indexUid}/documents/{documentId}
- Response modified: 202
  - Body attribute added: taskUid
  - [Breaking] Body attribute removed: uid
DELETE /indexes/{indexUid}/settings
- Response modified: 202
  - Body attribute added: taskUid
  - [Breaking] Body attribute removed: uid
DELETE /indexes/{indexUid}/settings/displayed-attributes
- Response modified: 202
  - Body attribute added: taskUid
  - [Breaking] Body attribute removed: uid
DELETE /indexes/{indexUid}/settings/distinct-attribute
- Response modified: 202
  - Body attribute added: taskUid
  - [Breaking] Body attribute removed: uid
DELETE /indexes/{indexUid}/settings/filterable-attributes
- Response modified: 202
  - Body attribute added: taskUid
  - [Breaking] Body attribute removed: uid
DELETE /indexes/{indexUid}/settings/ranking-rules
- Response modified: 202
  - Body attribute added: taskUid
  - [Breaking] Body attribute removed: uid
DELETE /indexes/{indexUid}/settings/searchable-attributes
- Response modified: 202
  - Body attribute added: taskUid
  - [Breaking] Body attribute removed: uid
DELETE /indexes/{indexUid}/settings/sortable-attributes
- Response modified: 202
  - Body attribute added: taskUid
  - [Breaking] Body attribute removed: uid
DELETE /indexes/{indexUid}/settings/stop-words
- Response modified: 202
  - Body attribute added: taskUid
  - [Breaking] Body attribute removed: uid
DELETE /indexes/{indexUid}/settings/synonyms
- Response modified: 202
  - Body attribute added: taskUid
  - [Breaking] Body attribute removed: uid
DELETE /indexes/{indexUid}/settings/typo-tolerance
- Response modified: 202
  - Body attribute added: taskUid
  - [Breaking] Body attribute removed: uid
POST /indexes/{indexUid}/documents
- Response modified: 202
  - Body attribute added: taskUid
  - [Breaking] Body attribute removed: uid
POST /indexes/{indexUid}/documents/delete-batch
- Response modified: 202
  - Body attribute added: taskUid
  - [Breaking] Body attribute removed: uid
POST /indexes/{indexUid}/settings
- Response modified: 202
  - Body attribute added: taskUid
  - [Breaking] Body attribute removed: uid
POST /indexes/{indexUid}/settings/displayed-attributes
- Response modified: 202
  - Body attribute added: taskUid
  - [Breaking] Body attribute removed: uid
POST /indexes/{indexUid}/settings/distinct-attribute
- Response modified: 202
  - Body attribute added: taskUid
  - [Breaking] Body attribute removed: uid
POST /indexes/{indexUid}/settings/filterable-attributes
- Response modified: 202
  - Body attribute added: taskUid
  - [Breaking] Body attribute removed: uid
POST /indexes/{indexUid}/settings/ranking-rules
- Response modified: 202
  - Body attribute added: taskUid
  - [Breaking] Body attribute removed: uid
POST /indexes/{indexUid}/settings/searchable-attributes
- Response modified: 202
  - Body attribute added: taskUid
  - [Breaking] Body attribute removed: uid
POST /indexes/{indexUid}/settings/sortable-attributes
- Response modified: 202
  - Body attribute added: taskUid
  - [Breaking] Body attribute removed: uid
POST /indexes/{indexUid}/settings/stop-words
- Response modified: 202
  - Body attribute added: taskUid
  - [Breaking] Body attribute removed: uid
POST /indexes/{indexUid}/settings/synonyms
- Response modified: 202
  - Body attribute added: taskUid
  - [Breaking] Body attribute removed: uid
POST /indexes/{indexUid}/settings/typo-tolerance
- Response modified: 202
  - Body attribute added: taskUid
  - [Breaking] Body attribute removed: uid
PUT /indexes/{indexUid}/documents
- Response modified: 202
  - Body attribute added: taskUid
  - [Breaking] Body attribute removed: uid

View documentation diff

Powered by Bump

curquiza

🚀

gmourier · 2022-04-21T11:53:05Z

🚨 @gmourier These changes should also be included for the dump API since the response to a dump creation becomes a 202 Accepted.

bidoubiwa

🔥🔥🔥🔥

text/0060-tasks-api.md

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

…zed Task Response (#144) * Rename 202 uid to taskUid * Update text/0060-tasks-api.md Co-authored-by: cvermand <[email protected]> Co-authored-by: cvermand <[email protected]>

* Bump open-api.yml to v0.28 * Telemetry - Add `x-meilisearch-client` query parameter (#145) * Introduce the x-meilisearch-client query parameter * Update text/0034-telemetry-policies.md Co-authored-by: Bruno Casali <[email protected]> * Update text/0034-telemetry-policies.md Co-authored-by: Bruno Casali <[email protected]> Co-authored-by: Bruno Casali <[email protected]> * GeoSearch — Support string type for `_geo` `lat` and `lng` fields (#83) * Update specification to support string type for _geo lat and lng fields * mention types mixing for _geo object * Tasks API - Rename `uid` to `taskUid` in the `202 - Accepted` Summarized Task Response (#144) * Rename 202 uid to taskUid * Update text/0060-tasks-api.md Co-authored-by: cvermand <[email protected]> Co-authored-by: cvermand <[email protected]> * Tasks API - Seek/Keyset based pagination (#115) * Move cursor based pagination spec to tasks API spec * remove pagination as a future capability * Clarify boundaries for limit query parameter * Update OpenApi specification * Remove limit field boundaries * Apply suggestions from code review Co-authored-by: Clément Renault <[email protected]> * Update open-api.yml and removes cursor term mentions * Update text/0060-tasks-api.md Co-authored-by: Tommy <[email protected]> * Remove route mention in seek-keyset pagination section Co-authored-by: Clément Renault <[email protected]> Co-authored-by: Tommy <[email protected]> * Tasks API - Filter tasks list by `type`/`status`/`indexUid` (#116) * move filtering tasks by status/type parameter to task api spec * Update specification * Add details about case-sensitivy + rework error message * Introducing naming changes plus make the specification a source of truth instead of a changelog * Remove a future possibility being introduced * misc - replace createIndex to the right type and add the missing type field to the 202 Response resource * Dumps API - Make dump creation an asynchronous task (#139) * wip * Make a dump creation a visible asynchronous task * Add precisions * Update open-api.yml * Add ommited type field for summarized task response * Add future possibilities * Apply suggestions from code review Co-authored-by: cvermand <[email protected]> * Precise that indexUid can be null * Precise priorization of dumpCreation task over other task types * Keep taskUid for 202 response * remove dumps.get API key action Co-authored-by: cvermand <[email protected]> * Search API - Remove/Rename confusing fields (#135) * Rename nbHits, remove exhaustive* boolean fields * Rename approximativeNbHits to estimatedTotalHits * Update open-api.yaml * Apply naming changes for facet distribution and showing matches position * Add a telemetry for facet distribution usage * API Guideline - Return list of API resources under a `results` array (#138) * Place list of documents under a results array on /documents * Add results array for indexes object list * Add the future of indexes pagination * Update open-api.yml * Fix typo * Apply suggestions from code review Co-authored-by: cvermand <[email protected]> * Add offset/limit pagination for indexes and API keys * Try to add multipe refs to a response object Co-authored-by: cvermand <[email protected]> * Remove name field (#140) * Documents API - `displayedAttributes` should not impact the documents API / Rename `attributesToRetrieve` to `fields` (#143) * Specifies that displayedAttributes setting does not impact the GET documents endpoint * Rename attributeToRetrieve to fields on /documents * Add a future possibily to rejectt a field from a document in the given response * Precise behavior details about fields query parameter * Add fields query parameter on GET /indexes/{index}/documents/{docId} * API Keys - Determinist API Keys + Security changes (#148) * Add an uid to make API Keys determinists, plus add a non-unique human readable name field to ease reading information * Describe errors for uid and name fields * Apply suggestions from code review Co-authored-by: Bruno Casali <[email protected]> * misc: add precisions * Reorganize route descriptions * Update error_code when API Key already exists for a given uid * Apply suggestions from code review Co-authored-by: Many the fish <[email protected]> * Add new keys actions, remove master-key changes, introduce a new error for immutable field and update tenant token * Update open-api spec * Update immutable_field error message * Apply suggestions from code review Co-authored-by: Many the fish <[email protected]> * Mention that the Default Admin API Key can manage keys * Specify that the JWT Tenant Token must be enrypted with the API Key value * Update the spec regarding the description of the Admin API Key to be up-to-date * Add uid_or_key url param to update and delete a key * Update text/0085-api-keys.md Co-authored-by: Many the fish <[email protected]> * Update text/0085-api-keys.md Co-authored-by: Many the fish <[email protected]> Co-authored-by: Bruno Casali <[email protected]> Co-authored-by: Many the fish <[email protected]> Co-authored-by: Kerollmops <[email protected]> * Geosearch - Enhance lat/lng format error messages (#149) * Update the geosearch error message * misc: organiser error message in the right specification Co-authored-by: Guillaume Mourier <[email protected]> * Introduces HTTP Verbs changesto be compliant regarding a Rest API (#152) * Telemetry - Replace `x-meilisearch-client` query parameter by `X-Meilisearch-Client` header (#150) * Removes x-meilisearch-client, replace it by a header * Remove capslock * fix typo (#151) * Mention telemetry.meilisearch.com (#153) * update ranking rules error message (#154) * Misc — Update dump versions compatibility table (#156) * Update dump table * Update text/0105-dumps-api.md * Settings API - Customize the hard limits for `pagination` and `faceting` (#157) * Introduces specification files * Update files name * branch telemetry * Update open-api.yml * Update text/0034-telemetry-policies.md Co-authored-by: Clément Renault <[email protected]> * update open-api.yml * Update text/157-faceting-setting-api.md Co-authored-by: Clément Renault <[email protected]> * Rename limitedTo to maxTotalHits * Specify order of returned facet Co-authored-by: Clément Renault <[email protected]> * Add dumpCreation task type to OpenAPI.yml * Tasks filtering params to be in query instead of path on OpenAPI spec Co-authored-by: Bruno Casali <[email protected]> Co-authored-by: cvermand <[email protected]> Co-authored-by: Clément Renault <[email protected]> Co-authored-by: Tommy <[email protected]> Co-authored-by: Many the fish <[email protected]> Co-authored-by: Kerollmops <[email protected]> Co-authored-by: Tamo <[email protected]> Co-authored-by: ad hoc <[email protected]> Co-authored-by: Clémentine Urquizar - curqui <[email protected]>

gmourier added v0.28 Ready For Review Feature specification must be reviewed. OpenAPI Update OpenAPI specification. labels Apr 21, 2022

gmourier self-assigned this Apr 21, 2022

gmourier requested review from curquiza and bidoubiwa April 21, 2022 10:07

gmourier mentioned this pull request Apr 21, 2022

Release v0.28.0 #137

Merged

1 task

gmourier added the Q3:2022 label Apr 21, 2022

curquiza previously approved these changes Apr 21, 2022

View reviewed changes

gmourier mentioned this pull request Apr 21, 2022

Dumps API - Make dump creation an asynchronous task #139

Merged

1 task

curquiza mentioned this pull request May 5, 2022

Changes on /tasks endpoints meilisearch/meilisearch#2377

Closed

15 tasks

Rename 202 uid to taskUid

8aad17b

gmourier dismissed curquiza’s stale review via 8aad17b May 16, 2022 12:16

gmourier force-pushed the rename-uid-to-taskUid-in-202-accepted-asynchronous-response branch from a6548cd to 8aad17b Compare May 16, 2022 12:16

bidoubiwa suggested changes May 16, 2022

View reviewed changes

text/0060-tasks-api.md Outdated Show resolved Hide resolved

Update text/0060-tasks-api.md

f452648

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

gmourier merged commit 27c7d25 into develop May 17, 2022

gmourier deleted the rename-uid-to-taskUid-in-202-accepted-asynchronous-response branch May 17, 2022 13:57

guimachiavelli mentioned this pull request Jun 8, 2022

v0.28: Changes to Tasks API meilisearch/documentation#1706

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Tasks API - Rename `uid` to `taskUid` in the `202 - Accepted` Summarized Task Response #144

Tasks API - Rename `uid` to `taskUid` in the `202 - Accepted` Summarized Task Response #144

gmourier commented Apr 21, 2022 •

edited

Loading

github-actions bot commented Apr 21, 2022 •

edited

Loading

curquiza left a comment

gmourier commented Apr 21, 2022

bidoubiwa left a comment

Tasks API - Rename uid to taskUid in the 202 - Accepted Summarized Task Response #144

Tasks API - Rename uid to taskUid in the 202 - Accepted Summarized Task Response #144

Conversation

gmourier commented Apr 21, 2022 • edited Loading

Why?

Changes

github-actions bot commented Apr 21, 2022 • edited Loading

Modified (25)

curquiza left a comment

Choose a reason for hiding this comment

gmourier commented Apr 21, 2022

bidoubiwa left a comment

Choose a reason for hiding this comment

Tasks API - Rename `uid` to `taskUid` in the `202 - Accepted` Summarized Task Response #144

Tasks API - Rename `uid` to `taskUid` in the `202 - Accepted` Summarized Task Response #144

gmourier commented Apr 21, 2022 •

edited

Loading

github-actions bot commented Apr 21, 2022 •

edited

Loading