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

Faceting Setting API - sortFacetValuesBy #247

Merged
merged 5 commits into from
Jul 31, 2023

Conversation

gmourier
Copy link
Member

@gmourier gmourier commented Jun 23, 2023

🤖 API Diff


Summary

Describes the new index setting that gives the ability to customize a facet sort order


Changes

  • Describes the sortFacetValuesBy setting
  • Introduces the new setting property on the open-api.yaml file
  • Describes related errors
  • Describes the added telemetry

Out Of Scope

N/A


Attention To Reviewers

N/A


Misc

  • Update OpenAPI specification file
  • Update telemetry datapoints

@gmourier gmourier changed the base branch from main to release-v1.3.0 June 23, 2023 08:46
@gmourier gmourier added the In Progress Feature specification is in elaboration. Important changes can still occurs in the specification. label Jun 23, 2023
@gmourier gmourier changed the title Faceting API - sortFacetValuesBy Faceting Setting API - sortFacetValuesBy Jun 23, 2023
@gmourier gmourier mentioned this pull request Jun 23, 2023
1 task
@github-actions
Copy link

🚨 Breaking API change detected:

Modified (5)

  • [Breaking] DELETE /indexes/{indexUid}/documents/{documentId}
    • [Breaking] Header removed: Content-Type
    • [Breaking] Body removed
  • GET /indexes/{indexUid}/settings
    • Response modified: 200
      • Attribute modified: faceting
  • GET /indexes/{indexUid}/settings/faceting
    • Response modified: 200
      • Attribute added: sortFacetValuesBy
  • PATCH /indexes/{indexUid}/settings
    • Body modified
      • Attribute modified: faceting
  • PATCH /indexes/{indexUid}/settings/faceting
    • Body modified
      • Attribute added: sortFacetValuesBy

Powered by Bump

@gmourier gmourier added the OpenAPI Update OpenAPI specification. label Jun 26, 2023
@Kerollmops Kerollmops force-pushed the sort-facet-values-by-setting branch from fa1f9ca to d371164 Compare June 29, 2023 15:16
@gmourier gmourier added Telemetry Update the telemetry collect. Ready For Review Feature specification must be reviewed. Implemented Feature specification has been implemented. and removed In Progress Feature specification is in elaboration. Important changes can still occurs in the specification. labels Jun 29, 2023
@@ -522,6 +526,8 @@ This property allows us to gather essential information to better understand on
|---------------|-------------|---------|
| user_agent | Represents the user-agent encountered on this call. | `["Meilisearch Ruby (v2.1)", "Ruby (3.0)"]` |
| faceting.max_values_per_facet | The defined value for `maxValuesPerFacet` property | `100` |
| faceting.sort_facet_values_by_star_count | Whether the user set all fields to be sort by count | `true` |
Copy link
Contributor

Choose a reason for hiding this comment

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

Why is this called faceting.sort_facet_values_by_star_count instead of just faceting.sort_facet_values_by_count?

Copy link
Member Author

Choose a reason for hiding this comment

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

Hey @maryamsulemani97

We want to track if the default * is expressly set to count to re-evaluate the default value in the future (today it's alpha). tbh we didn't spent too much time thinking about the name, that's a telemetry point nothing critical here 😇

@macraig macraig merged commit d82e976 into release-v1.3.0 Jul 31, 2023
@macraig macraig deleted the sort-facet-values-by-setting 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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants