Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v0.28: API endpoint verbs update #1702

Closed
guimachiavelli opened this issue Jun 7, 2022 · 1 comment · Fixed by #1707 or #1732
Closed

v0.28: API endpoint verbs update #1702

guimachiavelli opened this issue Jun 7, 2022 · 1 comment · Fixed by #1707 or #1732
Assignees
Milestone

Comments

@guimachiavelli
Copy link
Member

We are changing the verbs for some of our endpoints, mostly so we abide more faithfully to REST standards:

Indexes API

  • PUT -> PATCH /indexes/{indexUid}

Settings API

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

References

Spec: meilisearch/specifications#152
Issue on core: meilisearch/meilisearch#2419
SME: @gmourier

@guimachiavelli
Copy link
Member Author

This will likely require changing code samples as well since curl examples need to specify the HTTP verb e.g.:

curl \
  -X POST 'http://localhost:7700/indexes/movies/settings/displayed-attributes' \

will turn into

curl \
  -X PUT 'http://localhost:7700/indexes/movies/settings/displayed-attributes' \

Changes might also be required outside the API reference pages, depending on whether the endpoint is used elsewhere.

@guimachiavelli guimachiavelli mentioned this issue Jun 15, 2022
@guimachiavelli guimachiavelli linked a pull request Jun 15, 2022 that will close this issue
@guimachiavelli guimachiavelli linked a pull request Jun 23, 2022 that will close this issue
bors bot added a commit that referenced this issue Jun 30, 2022
1732: v0.28: API endpoint verbs update r=guimachiavelli a=maryamsulemani97

closes #1702 

1734: v0.28: /search name changes r=guimachiavelli a=maryamsulemani97

closes #1692

1736: v0.28: Changes to `/documents` r=guimachiavelli a=guimachiavelli

Closes #1700

Co-authored-by: Maryam Sulemani <maryam@meilisearch.com>
Co-authored-by: gui machiavelli <hey@guimachiavelli.com>
Co-authored-by: gui machiavelli <gui@meilisearch.com>
bors bot added a commit that referenced this issue Jul 11, 2022
1707: v0.28 r=guimachiavelli a=guimachiavelli

This is a staging PR for all changes related to Meilisearch v0.28.

Please avoid making changes directly to this PR; instead, create new child branches based off this one.

Closes #1687, #1688, #1691, #1692, #1693, #1694, #1699, #1700, #1701, #1702, #1703, #1704, #1706, #1722, #1727, #561

Co-authored-by: gui machiavelli <hey@guimachiavelli.com>
Co-authored-by: gui machiavelli <gui@meilisearch.com>
Co-authored-by: Tommy Melvin <tommy@meilisearch.com>
Co-authored-by: Maryam Sulemani <maryam@meilisearch.com>
Co-authored-by: Maryam <90181761+maryamsulemani97@users.noreply.github.com>
@bors bors bot closed this as completed in #1707 Jul 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants