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

Facet Search API - #246

Merged
macraig merged 7 commits into
release-v1.3.0from
facet-search
Jul 31, 2023
Merged

macraig merged 7 commits into
release-v1.3.0from
facet-search

Conversation

@gmourier

@gmourier gmourier commented Jun 23, 2023 •

Copy link
Copy Markdown
Contributor

🤖 API Diff


Summary

Describes the facet search endpoint allowing to search for facet values


Changes

  • Introduces facet-search-api.md
  • Introduces new errors definition
    • missing_facet_search_facet_name
    • invalid_facet_search_facet_name
    • invalid_facet_search_facet_query
  • Describes the new API endpoint in open-api.yaml
  • Describes added telemetry

Misc

  • Fix wordsMatchingStrategy to matchingStrategy in open-api.yml

Out Of Scope

N/A


Attention To Reviewers

N/A

Misc

  • Update OpenAPI specification file
  • Update telemetry datapoints

@github-actions

Copy link
Copy Markdown

🚨 Breaking API change detected:

Added (1)

  • POST /indexes/{indexUid}/facet-search

Modified (1)

  • [Breaking] DELETE /indexes/{indexUid}/documents/{documentId}
    • [Breaking] Header removed: Content-Type
    • [Breaking] Body removed

Powered by Bump

@gmourier gmourier added v1.3.0 OpenAPI Update OpenAPI specification. Ready For Review Feature specification must be reviewed. In Progress Feature specification is in elaboration. Important changes can still occurs in the specification. and removed Ready For Review Feature specification must be reviewed. labels Jun 23, 2023
@gmourier gmourier mentioned this pull request Jun 23, 2023
1 task
@gmourier gmourier added Ready For Review Feature specification must be reviewed. Telemetry Update the telemetry collect. Implemented Feature specification has been implemented. and removed In Progress Feature specification is in elaboration. Important changes can still occurs in the specification. labels Jul 6, 2023
@gmourier
gmourier requested review from bidoubiwa, gillian-meilisearch, macraig and maryamsulemani97 and removed request for macraig July 7, 2023 06:21

@gmourier gmourier left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Adding missing Facet Searched POST event on the user-agent telemetry node

Comment thread text/0034-telemetry-policies.md Outdated
Comment thread text/0246-facet-search-api.md
Comment thread text/0246-facet-search-api.md Outdated
gmourier and others added 2 commits July 13, 2023 17:34
Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com>
@macraig
macraig merged commit 8827a3a into release-v1.3.0 Jul 31, 2023
@macraig
macraig deleted the facet-search branch July 31, 2023 10:19
macraig added a commit that referenced this pull request Jul 31, 2023
* Bump openapi.yaml file

* Facet Search API (#246)

* Init specification

* Adjust spec files to PR number

* Fix content-type open-api

* Remove fix content-type

* Add the telemetry

* Update text/0246-facet-search-api.md

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

* Update text/0034-telemetry-policies.md

---------

Co-authored-by: Clément Renault <clement@meilisearch.com>
Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com>

* Faceting Setting API - sortFacetValuesBy  (#247)

* init spec

* Add property description and open-api.yaml

* Removes future possibility

* Update the telemetry

* Update the error of the sortFacetValuesBy setting

---------

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

* Vector Search - `EXPERIMENTAL` (#248)

* Init spec

* Fix the vector store fields

* Add an information on the invalid_search_vector error code

* Add an information on the invalid_vectors_field error codes

* Define the new max_vector_size analytic

* Update the open-api file with vector capabilities

* Apply suggestions from code review

* Update open-api.yaml

Co-authored-by: Maria Craig <marycraig90@gmail.com>

* Update open-api.yaml

Co-authored-by: Maria Craig <marycraig90@gmail.com>

* Update text/0118-search-api.md

Co-authored-by: Maria Craig <marycraig90@gmail.com>

* Update text/0061-error-format-and-definitions.md

Co-authored-by: Maria Craig <marycraig90@gmail.com>

---------

Co-authored-by: Kerollmops <clement@meilisearch.com>
Co-authored-by: Maria Craig <marycraig90@gmail.com>

* Tasks route total (#253)

* Update the tasks route info to add the total field

* Update the OpenApi of the tasks route

* Document the latest metrics improvements (#242)

* document the latest metrics improvements

* Update text/0174-metrics-api.md

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

* Update text/0174-metrics-api.md

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

* adds some details on the meilisearch_db_size metrics

* update the open api metrics smaple

* update a bad copy paste

* Update open-api.yaml

* prefix prometheus metrics by meilisearch_

* Introduce two new metrics

---------

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

---------

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>
Co-authored-by: Clément Renault <clement@meilisearch.com>
Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com>
Co-authored-by: Clément Renault <renault.cle@gmail.com>
Co-authored-by: Tamo <tamo@meilisearch.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. Ready For Review Feature specification must be reviewed. Telemetry Update the telemetry collect. v1.3.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants