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

Stabilize scoreDetails feature #264

Merged
merged 2 commits into from
Mar 11, 2024
Merged

Stabilize scoreDetails feature #264

merged 2 commits into from
Mar 11, 2024

Conversation

dureuill
Copy link
Contributor

@dureuill dureuill commented Feb 6, 2024

🤖 API Diff Put the link of the GitHub comment generated by bump.sh if generated; Apply the OpenApi label


Summary

Stabilize the scoreDetails feature.


Changes

  • Remove (EXPERIMENTAL) mentions for scoreDetails
  • Update OpenAPI with up-to-date fields

Out Of Scope

  • other experimental features seem to be only partially tracked in the specs. It is not in the scope of this PR to fix this.

Attention To Reviewers

Most of the specification was written when the feature was in its experimental state. The wording should be consistent with its newly stabilized status.


Misc

  • Update OpenAPI specification file (if needed; Apply the OpenApi label)
  • Update telemetry datapoints (if needed; Apply the Telemetry label)

@dureuill dureuill added OpenAPI Update OpenAPI specification. Telemetry Update the telemetry collect. ⚠️ Breaking Introduce a breaking change. labels Feb 6, 2024
Copy link

github-actions bot commented Feb 6, 2024

🚨 Breaking API change detected:

Modified (5)

  • GET /experimental-features
    • Response modified: 200
      • Content type modified: application/json
        • [Breaking] Attribute removed: scoreDetails
          • Removing a resource is always breaking unless it was deprecated before [Breaking]
        • Attributes added: metrics, exportPuffinReports
  • GET /indexes/{indexUid}/search
    • Response modified: 200
      • Content type modified: application/json
        • Attribute modified: hits
  • PATCH /experimental-features
    • Content type modified: application/json
      • [Breaking] Attribute removed: scoreDetails
        • Removing a resource is always breaking unless it was deprecated before [Breaking]
      • Attributes added: metrics, exportPuffinReports
    • Response modified: 200
      • Content type modified: application/json
        • [Breaking] Attribute removed: scoreDetails
          • Removing a resource is always breaking unless it was deprecated before [Breaking]
        • Attributes added: metrics, exportPuffinReports
  • POST /indexes/{indexUid}/search
    • Response modified: 200
      • Content type modified: application/json
        • Attribute modified: hits
  • POST /multi-search
    • Response modified: 200
      • Content type modified: application/json
        • Attribute modified: results

Powered by Bump.sh

@macraig macraig mentioned this pull request Feb 6, 2024
4 tasks
Copy link
Contributor

@macraig macraig left a comment

Choose a reason for hiding this comment

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

Really cool to see this stabilized! 🚀

@macraig macraig merged commit 92a1bc8 into release-v1.7.0 Mar 11, 2024
2 checks passed
@macraig macraig deleted the scoreDetails branch March 11, 2024 19:47
macraig added a commit that referenced this pull request Mar 11, 2024
* Bump version to v1.7

* Stabilize scoreDetails feature (#264)

* Stabilize scoreDetails feature

* Remove from telemetry and experimental features

---------

Co-authored-by: María <[email protected]>
Co-authored-by: Louis Dureuil <[email protected]>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
⚠️ Breaking Introduce a breaking change. OpenAPI Update OpenAPI specification. Telemetry Update the telemetry collect.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants