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

API Guideline - Stabilize Http Verbs #152

Merged
merged 1 commit into from
Jul 7, 2022
Merged

API Guideline - Stabilize Http Verbs #152

merged 1 commit into from
Jul 7, 2022

Conversation

gmourier
Copy link
Member

@gmourier gmourier commented May 23, 2022 •
edited
Loading

🤖 API Diff

Summary

This specification introduces changes to the HTTP verbs used to be more compliant with the Rest specification regarding resource updates.

Changes

Indexes API

  • [Breaking] PUT -> PATCH /indexes/{indexUid}

Settings API

  • [Breaking] POST -> PATCH /indexes/{indexUid}/settings
  • [Breaking] POST -> PATCH /indexes/{indexUid}/settings/typo-tolerance
  • [Breaking] POST -> PUT /indexes/{indexUid}/settings/displayed-attributes
  • [Breaking] POST -> PUT /indexes/{indexUid}/settings/distinct-attribute
  • [Breaking] POST -> PUT /indexes/{indexUid}/settings/filterable-attributes
  • [Breaking] POST -> PUT /indexes/{indexUid}/settings/ranking-rules
  • [Breaking] POST -> PUT /indexes/{indexUid}/settings/searchable-attributes
  • [Breaking] POST -> PUT /indexes/{indexUid}/settings/sortable-attributes
  • [Breaking] POST -> PUT /indexes/{indexUid}/settings/stop-words
  • [Breaking] POST -> PUT /indexes/{indexUid}/settings/synonyms

Misc

  • Update OpenAPI specification file

@gmourier gmourier added the In Progress Feature specification is in elaboration. Important changes can still occurs in the specification. label May 23, 2022
@github-actions
Copy link

github-actions bot commented May 23, 2022 •
edited
Loading

🚨 Breaking API change detected:

Modified (11)

  • [Breaking] PATCH /indexes/{indexUid}
  • [Breaking] PATCH /indexes/{indexUid}/settings
  • [Breaking] PATCH /indexes/{indexUid}/settings/typo-tolerance
  • [Breaking] PUT /indexes/{indexUid}/settings/displayed-attributes
  • [Breaking] PUT /indexes/{indexUid}/settings/distinct-attribute
  • [Breaking] PUT /indexes/{indexUid}/settings/filterable-attributes
  • [Breaking] PUT /indexes/{indexUid}/settings/ranking-rules
  • [Breaking] PUT /indexes/{indexUid}/settings/searchable-attributes
  • [Breaking] PUT /indexes/{indexUid}/settings/sortable-attributes
  • [Breaking] PUT /indexes/{indexUid}/settings/stop-words
  • [Breaking] PUT /indexes/{indexUid}/settings/synonyms

View documentation diff

Powered by Bump

@gmourier gmourier marked this pull request as ready for review May 23, 2022 08:55
@gmourier gmourier changed the title API - Stabilize API Http Verbs API - Stabilize Http Verbs May 23, 2022
@gmourier gmourier mentioned this pull request May 23, 2022
Merged
1 task
@gmourier gmourier changed the title API - Stabilize Http Verbs API Guideline - Stabilize Http Verbs May 23, 2022
@gmourier gmourier added Q3:2022 v0.28 OpenAPI Update OpenAPI specification. Ready For Review Feature specification must be reviewed. and removed In Progress Feature specification is in elaboration. Important changes can still occurs in the specification. labels May 23, 2022
@curquiza curquiza mentioned this pull request May 23, 2022
Closed
11 tasks
curquiza
curquiza previously approved these changes May 24, 2022
View reviewed changes
@guimachiavelli guimachiavelli mentioned this pull request Jun 7, 2022
Closed
@brunoocasali brunoocasali mentioned this pull request Jun 8, 2022
Merged
2 tasks
@gmourier gmourier force-pushed the stabilize-api-http-verbs branch from bc2f04b to 777b47b Compare July 7, 2022 15:39
@gmourier gmourier merged commit 9e0f07c into develop Jul 7, 2022
@gmourier gmourier deleted the stabilize-api-http-verbs branch July 7, 2022 15:40
gmourier added a commit that referenced this pull request Jul 7, 2022
@gmourier
Introduces HTTP Verbs changesto be compliant regarding a Rest API (#152)
5413602
gmourier added a commit that referenced this pull request Jul 11, 2022
@gmourier @brunoocasali
@bidoubiwa @Kerollmops @dichotommy @ManyTheFish @irevoire @MarinPostma @curquiza
Release v0.28.0 (#137)
937e8eb 
* 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]>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@curquiza curquiza curquiza left review comments

@brunoocasali brunoocasali Awaiting requested review from brunoocasali

@Kerollmops Kerollmops Awaiting requested review from Kerollmops

Assignees
No one assigned
Labels
OpenAPI Update OpenAPI specification. Q3:2022 Ready For Review Feature specification must be reviewed. v0.28
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@gmourier @curquiza