Skip to content

API Spec compatible with 3.0.0-beta1 #883

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
May 5, 2025
Merged

API Spec compatible with 3.0.0-beta1 #883

merged 1 commit into from
May 5, 2025

Conversation

prudhvigodithi
Copy link
Member

@prudhvigodithi prudhvigodithi commented May 5, 2025 •
edited
Loading

Description

Initially seen test failures in PR #879. This PR is for

  • Fixing the tests failing search only.
  • Update the version to 3.0.0-beta1

Issues Resolved

Coming from opensearch-project/opensearch-build#3747 (comment)

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.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented May 5, 2025 •
edited
Loading

Changes Analysis

Commit SHA: b14233a
Comparing To SHA: eb0f803

API Changes

Summary

└─┬Components
  ├─┬indices._common___IndexSettingBlocks
  │ └──[➕] properties (53414:9)
  ├─┬nodes.stats___ShardTaskCancellationStats
  │ └──[➕] properties (61269:9)
  └─┬_common___NodeShard
    ├──[➕] properties (35903:9)
    ├─┬unassigned_info
    │ └──[🔀] $ref (55466:13)❌ 
    ├─┬shard
    │ ├──[🔀] type (35904:17)❌ 
    │ ├──[➖] format (35900:19)❌ 
    │ └──[➕] description (35905:24)
    └─┬state
      └──[🔀] $ref (35899:11)❌
Document Element Total Changes Breaking Changes
components 8 4
  • ❌ BREAKING Changes: 4 out of 8
  • Modifications: 3
  • Removals: 1
  • Additions: 4
  • Breaking Removals: 1
  • Breaking Modifications: 3

Report

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

API Coverage

Before After Δ
Covered (%) 663 (64.94 %) 663 (64.94 %) 0 (0 %)
Uncovered (%) 358 (35.06 %) 358 (35.06 %) 0 (0 %)
Unknown 49 49 0

@prudhvigodithi prudhvigodithi force-pushed the scale branch 3 times, most recently from a9a15e3 to 8b825ca Compare May 5, 2025 04:38
@prudhvigodithi prudhvigodithi changed the title Fix search only tests and update to 3.0.0-beta1 API Spec compatible with 3.0.0-beta1 May 5, 2025
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented May 5, 2025

Spec Test Coverage Analysis

Total Tested
599 597 (99.67 %)

@prudhvigodithi prudhvigodithi marked this pull request as ready for review May 5, 2025 04:53
This was referenced May 5, 2025
Closed
Closed
Open
prudhvigodithi
prudhvigodithi commented May 5, 2025
View reviewed changes
tests/default/security/sslinfo.yaml
@@ -3,6 +3,7 @@ $schema: ../../../json_schemas/test_story.schema.yaml
description: Test sslinfo endpoint.
warnings:
invalid-path-detected: false
version: < 3
Copy link
Member Author

Choose a reason for hiding this comment

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

Adding @cwperks, the _security/sslinfo output has changed for 3.0.0-beta1, for now the existing tests/default/security/sslinfo.yaml I have added < 3. For the new response tests can the security team please create new tests for this endpoint. Thanks

Copy link
Collaborator

Choose a reason for hiding this comment

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

I've created #885 for fixing this

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks

andrross
andrross reviewed May 5, 2025
View reviewed changes
spec/schemas/_common.yaml
@@ -2656,6 +2656,9 @@ components:
format: int32
index:
$ref: '#/components/schemas/IndexName'
searchOnly:
Copy link
Member

Choose a reason for hiding this comment

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

@mch2 This is unfortunately too late to change for the 3.0 release, but we should introduce search_replica as the replacement here and mark this field as deprecated.

@peterzhuamazon peterzhuamazon mentioned this pull request May 5, 2025
Open
@prudhvigodithi prudhvigodithi self-assigned this May 5, 2025
@prudhvigodithi
Copy link
Member Author

Just a follow up to see if we can merge this PR. Thanks

@github-project-automation github-project-automation bot moved this from Todo to In Progress in Performance Roadmap May 5, 2025
@Xtansia Xtansia merged commit c3be298 into opensearch-project:main May 5, 2025
41 checks passed
@github-project-automation github-project-automation bot moved this from In Progress to Done in Performance Roadmap May 5, 2025
@q-andy q-andy mentioned this pull request May 6, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Xtansia Xtansia Xtansia approved these changes

@andrross andrross andrross left review comments

@dblock dblock Awaiting requested review from dblock dblock is a code owner

@harshavamsi harshavamsi Awaiting requested review from harshavamsi harshavamsi is a code owner

@sachetalva sachetalva Awaiting requested review from sachetalva sachetalva is a code owner

@nhtruong nhtruong Awaiting requested review from nhtruong nhtruong is a code owner

@VachaShah VachaShah Awaiting requested review from VachaShah VachaShah is a code owner

@Tokesh Tokesh Awaiting requested review from Tokesh Tokesh is a code owner

@aabeshov aabeshov Awaiting requested review from aabeshov aabeshov is a code owner

Assignees

@prudhvigodithi prudhvigodithi

Labels
None yet
Projects
Performance Roadmap
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@prudhvigodithi @Xtansia @andrross