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

API Keys - Introduce * wildcard char at the last position to express access to multiple indexes starting with the same string #189

Conversation

gmourier
Copy link
Member

@gmourier gmourier commented Oct 18, 2022

🤖 API Diff


Summary

It's now possible to express access to multiple indexes starting by the same pattern in an API Key's indexes field by using the * char as a wildcard. The pattern is only considered when the * character is at the last position.

e.g products_* match all indexes starting by products_

Related to meilisearch/meilisearch#2788


Changes

N/A

Out Of Scope

N/A


Attention To Reviewers

N/A


Misc

  • Update OpenAPI specification file

@gmourier gmourier added Ready For Review Feature specification must be reviewed. Implemented Feature specification has been implemented. OpenAPI Update OpenAPI specification. Q4:2022 v0.30 labels Oct 18, 2022
@gmourier gmourier mentioned this pull request Oct 18, 2022
1 task
@gmourier gmourier changed the title API Keys - Introduce * wildcard char at the last position to express multiple indexes starting with the same string API Keys - Introduce * wildcard char at the last position to express access to multiple indexes starting with the same string Oct 18, 2022
@gmourier gmourier force-pushed the allow-wildcard-char-at-last-pos-for-api-key-indexes-value branch from 0783a33 to e898ab9 Compare October 18, 2022 22:39
@gmourier gmourier requested a review from curquiza October 18, 2022 22:48
curquiza
curquiza previously approved these changes Oct 19, 2022
Copy link
Member

@curquiza curquiza left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I approve

⚠️ I cannot guarantee it will be implemented in v0.30.0 since it's done by a contributor for hacktoberfest and we are lacking of time

@curquiza
Copy link
Member

@gmourier will probably not be ready for v0.30.0

@curquiza
Copy link
Member

@gmourier: confirmation, will not be in v0.30.0 but in v1! Sorry for the confusion! 🙇

@gmourier gmourier added Ready To Be Implemented Feature specification is ready to be implemented. v1.0.0 and removed Implemented Feature specification has been implemented. Q4:2022 v0.30 labels Nov 2, 2022
@gmourier gmourier changed the base branch from release-v0.30.0 to main November 2, 2022 12:18
@gmourier gmourier dismissed curquiza’s stale review November 2, 2022 12:18

The base branch was changed.

@gmourier gmourier removed the Ready For Review Feature specification must be reviewed. label Nov 3, 2022
@gmourier gmourier force-pushed the allow-wildcard-char-at-last-pos-for-api-key-indexes-value branch from e898ab9 to 48ed447 Compare November 8, 2022 14:17
@gmourier gmourier changed the base branch from main to release-v1.0.0 November 8, 2022 14:17
@gmourier gmourier mentioned this pull request Nov 8, 2022
1 task
@gmourier gmourier added Unplanified The PR must be planned for a release. and removed v1.0.0 labels Jan 5, 2023
@gmourier gmourier added Q1:2023 v1.1.0 and removed Unplanified The PR must be planned for a release. labels Jan 19, 2023
@gmourier gmourier mentioned this pull request Feb 6, 2023
1 task
@gmourier
Copy link
Member Author

gmourier commented Feb 15, 2023

@Kerollmops, I think it misses the error case regarding the invalid index uid format in the POST route of an API Key. Could you check that, please?

@gmourier gmourier changed the base branch from release-v1.0.0 to release-v1.1.0 February 15, 2023 19:23
@gmourier gmourier added Implemented Feature specification has been implemented. Q2:2023 and removed Ready To Be Implemented Feature specification is ready to be implemented. Q1:2023 Q2:2023 labels Feb 22, 2023
@gmourier gmourier merged commit 48895d1 into release-v1.1.0 Apr 3, 2023
@gmourier gmourier deleted the allow-wildcard-char-at-last-pos-for-api-key-indexes-value branch April 3, 2023 14:14
gmourier added a commit that referenced this pull request Apr 3, 2023
* Bump API version

* Metrics API — Introduce a `/metrics` route for observability / monitoring purposes (#174)

* init spec for /metrics

* Rename spec filename and add description for metrics

* update metrics name and type col in the metrics table; add auth errors

* Add --enable-metrics-route to instance-options.md specification

* Precise metrics

* update open-api.yml

* Add telemetry instance property

* Mention metrics route on stats.get action

* Add  action

* Precise  action description

* Rephrase future possibility

* Add MEILI_ENABLE_METRICS_ROUTE

* rename all the cli parameter to the experimental variant

* Update text/0174-metrics-api.md

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Update open-api.yaml

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Update text/0085-api-keys.md

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Apply suggestions from code review

Co-authored-by: Tamo <tamo@meilisearch.com>

---------

Co-authored-by: Tamo <tamo@meilisearch.com>

* API Keys - Introduce `*` wildcard char at the last position to express access to multiple indexes starting with the same string (#189)

* Bump open-api spec

* Precise that the * wildcard char can be used at the last position to match multiple indexes starting with the same string

* Update future possibilities

* Update the index wildcard pattern error message

---------

Co-authored-by: Clément Renault <clement@meilisearch.com>

* Documents API — Support a csv delimiter customization (#221)

* specify the support of the csv-delimiter

* Apply suggestions from code review

* get rid of the last 'future possibility' that is being described in this PR

* Update openAPI specification

---------

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Update the geo-search spec to mention the fact that null is a valid geo field (#222)

* GeoSearch — Add the `_geoBoundingBox` built-in filter (#223)

* Add geoBoundingBox built-in filter description

* Add missing parts

* Update text/0059-geo-search.md

Co-authored-by: Tamo <tamo@meilisearch.com>

* Replace the top left / bottom right signature to a top right / bottom left signature

---------

Co-authored-by: Tamo <tamo@meilisearch.com>

* Search API — Add `facetStats` description (#224)

* update search-api.md

* rephrase

* update open-api.yml

* rephrase, add example on open-api.yml

* Add examples

* fix

* Update text/0118-search-api.md

Co-authored-by: Louis Dureuil <louis.dureuil@gmail.com>

* rephrase

* Clarify that facet stats are for all search results

---------

Co-authored-by: Louis Dureuil <louis.dureuil@gmail.com>

* Multi Search API (#225)

* Add multi-search spec

* Change possible HTTP return codes for index_not_found

* Add multi-search to openAPI

* Update telemetry

* openAPI: shorter summary for multi-search

* openAPI: attempt to remove superfluous "values" field in multisearch request/response

* Apply review suggestions for openAPI

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Apply review suggestions for multi search API

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* Add queries/results keys to openAPI examples

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

* fix indent

* Apply review suggestions for multi search API

Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com>

* OpenAPI: Change summary to `Multi Search`

* use backticks instead of ticks in multi search API example

* Apply review suggestions for multi search API

Co-authored-by: Maryam <90181761+maryamsulemani97@users.noreply.github.com>

* remove superfluous newline from telemetry file

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

---------

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>
Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com>
Co-authored-by: Maryam <90181761+maryamsulemani97@users.noreply.github.com>

* Add small blurb on index count / max size (#226)

---------

Co-authored-by: Tamo <tamo@meilisearch.com>
Co-authored-by: Clément Renault <clement@meilisearch.com>
Co-authored-by: Louis Dureuil <louis.dureuil@gmail.com>
Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com>
Co-authored-by: Maryam <90181761+maryamsulemani97@users.noreply.github.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Implemented Feature specification has been implemented. OpenAPI Update OpenAPI specification. Q1:2023 v1.1.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants