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

Add time field to getStats schema in _common.yml #803

Merged
merged 5 commits into from
Jan 22, 2025

Conversation

hye-on
Copy link
Contributor

@hye-on hye-on commented Jan 21, 2025

Description

Added the time field to the GetStats schema in _common.yml.

Issues Resolved

Related to opensearch-project/OpenSearch#16894

Related PR

opensearch-project/OpenSearch#17009

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.

@dblock
Copy link
Member

dblock commented Jan 21, 2025

getTime should be marked deprecated too, right?

Copy link
Contributor

Changes Analysis

Commit SHA: 5fe4310
Comparing To SHA: d8e4583

API Changes

Summary

└─┬Components
  └─┬_common___GetStats
    └──[➕] properties (35016:9)

Document Element Total Changes Breaking Changes
components 1 0
  • Total Changes: 1
  • Additions: 1

Report

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

API Coverage

Before After Δ
Covered (%) 662 (64.84 %) 662 (64.84 %) 0 (0 %)
Uncovered (%) 359 (35.16 %) 359 (35.16 %) 0 (0 %)
Unknown 45 45 0

Copy link
Contributor

Spec Test Coverage Analysis

Total Tested
594 593 (99.83 %)

@hye-on
Copy link
Contributor Author

hye-on commented Jan 22, 2025

@dblock Yes, that’s correct. getTime has been marked as deprecated. bb26c8e Thank you for letting me know!

Copy link
Collaborator

@Xtansia Xtansia left a comment

Choose a reason for hiding this comment

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

Thanks for PR'ing this and the accompanying fix. Just a couple things to change related to marking the field as deprecated in the spec.

@@ -1714,6 +1714,9 @@ components:
format: int64
getTime:
$ref: '#/components/schemas/Duration'
deprecated: true
Copy link
Collaborator

Choose a reason for hiding this comment

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

This should have x-version-deprecated: '2.19' as well

@@ -1714,6 +1714,9 @@ components:
format: int64
getTime:
$ref: '#/components/schemas/Duration'
deprecated: true
time:
$ref: '#/components/schemas/Duration'
Copy link
Collaborator

Choose a reason for hiding this comment

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

This should have x-version-added: '2.19' as well

@hye-on
Copy link
Contributor Author

hye-on commented Jan 22, 2025

@Xtansia Updated it! Sorry I missed it, and thanks for letting me know! :) 8521c54

Signed-off-by: Daniel (dB.) Doubrovkine <[email protected]>
@dblock dblock requested a review from Xtansia January 22, 2025 14:36
@Xtansia Xtansia merged commit 7c6e3b7 into opensearch-project:main Jan 22, 2025
2 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.

3 participants