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

adding rank_eval indices API tests #704

Merged
merged 9 commits into from
Dec 3, 2024

Conversation

Tokesh
Copy link
Collaborator

@Tokesh Tokesh commented Dec 2, 2024

Description

test for:
GET /_rank_eval
POST /_rank_eval
GET /{index}/_rank_eval
POST /{index}/_rank_eval

Issues Resolved

[#663 ]

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Copy link
Contributor

github-actions bot commented Dec 2, 2024

Changes Analysis

Commit SHA: 866897a
Comparing To SHA: 3981d33

API Changes

Summary

└─┬Components
  ├─┬_core.rank_eval___RankEvalMetricDetail
  │ └─┬metric_details
  │   └─┬Schema
  │     └─┬Schema
  │       └──[🔀] type (43394:21)❌ 
  └─┬_core.rank_eval___RankEvalHit
    └──[➕] properties (43335:9)

Document Element Total Changes Breaking Changes
components 2 1
  • BREAKING Changes: 1 out of 2
  • Modifications: 1
  • Additions: 1
  • Breaking Modifications: 1

Report

The full API changes report is available at: https://github.com/opensearch-project/opensearch-api-specification/actions/runs/12146406371/artifacts/2269346061

API Coverage

Before After Δ
Covered (%) 599 (58.67 %) 599 (58.67 %) 0 (0 %)
Uncovered (%) 422 (41.33 %) 422 (41.33 %) 0 (0 %)
Unknown 42 42 0

@dblock
Copy link
Member

dblock commented Dec 3, 2024

1.3.x returns _type in the docs, schema should be referencing an existing document model somewhere

Copy link
Contributor

github-actions bot commented Dec 3, 2024

Spec Test Coverage Analysis

Total Tested
528 423 (80.11 %)

@Tokesh Tokesh marked this pull request as ready for review December 3, 2024 19:04
@Tokesh Tokesh requested a review from dblock December 3, 2024 19:04
@Tokesh
Copy link
Collaborator Author

Tokesh commented Dec 3, 2024

I think its ready for review, open to any suggestions :)
We have achieved 80% test coverage!
We're almost there—100% coverage is within reach!

@@ -134,7 +134,7 @@ components:
additionalProperties:
type: object
additionalProperties:
type: object
type: number
Copy link
Member

Choose a reason for hiding this comment

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

So these are always numbers?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I'll try to read it in the future, most likely yes.
If I notice it's not, I'll open a new pull request.

@dblock dblock merged commit 0ee21a8 into opensearch-project:main Dec 3, 2024
36 checks passed
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 this pull request may close these issues.

2 participants