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

Fix data stream schemas #725

Merged
merged 4 commits into from
Dec 11, 2024
Merged

Conversation

Xtansia
Copy link
Collaborator

@Xtansia Xtansia commented Dec 11, 2024

Description

Fixing data stream schemas

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.

Signed-off-by: Thomas Farr <tsfarr@amazon.com>
Signed-off-by: Thomas Farr <tsfarr@amazon.com>
Signed-off-by: Thomas Farr <tsfarr@amazon.com>
Copy link
Contributor

github-actions bot commented Dec 11, 2024

Changes Analysis

Commit SHA: 0628b75
Comparing To SHA: 01f222e

API Changes

Summary

├─┬Paths
│ ├─┬/_cat/indices/{index}
│ │ └─┬GET
│ │   └──Parameters
│ ├─┬/_template/{name}
│ │ ├─┬PUT
│ │ │ └─┬Parameters
│ │ │   └─┬Schema
│ │ │     ├──[🔀] type (21011:15)❌ 
│ │ │     └──[➕] format (21012:17)❌ 
│ │ └─┬POST
│ │   └─┬Parameters
│ │     └─┬Schema
│ │       ├──[🔀] type (21011:15)❌ 
│ │       └──[➕] format (21012:17)❌ 
│ ├─┬/_list/indices
│ │ └─┬GET
│ │   └──Parameters
│ ├─┬/_cluster/health/{index}
│ │ └─┬GET
│ │   └──Parameters
│ ├─┬/_plugins/_ml/agents/_register
│ │ └─┬POST
│ │   └─┬Requestbody
│ │     └──application/json
│ ├─┬/_cat/indices
│ │ └─┬GET
│ │   └──Parameters
│ ├─┬/_plugins/_ml/connectors/_create
│ │ └─┬POST
│ │   └─┬Requestbody
│ │     └──application/json
│ ├─┬/_data_stream/_stats
│ │ └─┬GET
│ │   └─┬Responses
│ │     └─┬200
│ │       └─┬application/json
│ │         └─┬Schema
│ │           ├──[➕] properties (29380:15)
│ │           ├──[➖] properties (29316:15)❌ 
│ │           ├─┬backing_indices
│ │           │ ├──[🔀] type (29369:23)❌ 
│ │           │ └──[➕] format (29370:25)❌ 
│ │           ├─┬data_stream_count
│ │           │ ├──[🔀] type (29373:23)❌ 
│ │           │ └──[➕] format (29374:25)❌ 
│ │           └─┬data_streams
│ │             └─┬Schema
│ │               └──[🔀] $ref (49638:13)❌ 
│ ├─┬/_data_stream/{name}/_stats
│ │ └─┬GET
│ │   └─┬Responses
│ │     └─┬200
│ │       └─┬application/json
│ │         └─┬Schema
│ │           ├──[➕] properties (29380:15)
│ │           ├──[➖] properties (29316:15)❌ 
│ │           ├─┬backing_indices
│ │           │ ├──[🔀] type (29369:23)❌ 
│ │           │ └──[➕] format (29370:25)❌ 
│ │           ├─┬data_stream_count
│ │           │ ├──[🔀] type (29373:23)❌ 
│ │           │ └──[➕] format (29374:25)❌ 
│ │           └─┬data_streams
│ │             └─┬Schema
│ │               └──[🔀] $ref (49638:13)❌ 
│ ├─┬/_cluster/health
│ │ └─┬GET
│ │   └──Parameters
│ ├─┬/_plugins/_ml/models/_search
│ │ └─┬GET
│ │   └─┬Requestbody
│ │     └──application/json
│ └─┬/_list/indices/{index}
│   └─┬GET
│     └──Parameters
└─┬Components
  ├──[➖] schemas (53661:7)❌ 
  ├──[➖] schemas (53470:7)❌ 
  ├──[➖] schemas (32714:7)❌ 
  ├──[➖] schemas (53597:7)❌ 
  ├──[➖] schemas (50826:7)❌ 
  ├──[➕] schemas (49638:7)
  ├─┬knn._common___Stats
  │ └─┬model_index_status
  │   └─┬ONEOF
  │     └──[🔀] $ref (32773:9)❌ 
  ├─┬_common___HealthStatus
  │ ├──[➖] enum (32710:11)❌ 
  │ ├──[➖] enum (32711:11)❌ 
  │ ├──[➖] enum (32712:11)❌ 
  │ ├──[➖] type (32708:13)❌ 
  │ ├──[➕] oneOf (32773:11)
  │ ├──[➕] oneOf (32786:11)
  │ └──[➕] oneOf (32778:11)
  └─┬indices._common___DataStream
    ├─┬status
    │ └──[🔀] $ref (32773:9)❌ 
    └─┬generation
      ├──[🔀] type (49580:17)❌ 
      └──[➕] format (49581:19)❌ 

Document Element Total Changes Breaking Changes
components 17 13
paths 18 16
  • BREAKING Changes: 29 out of 35
  • Modifications: 11
  • Removals: 11
  • Additions: 13
  • Breaking Removals: 11
  • Breaking Modifications: 11
  • Breaking Additions: 7

Report

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

API Coverage

Before After Δ
Covered (%) 606 (59.35 %) 606 (59.35 %) 0 (0 %)
Uncovered (%) 415 (40.65 %) 415 (40.65 %) 0 (0 %)
Unknown 43 43 0

Copy link
Contributor

github-actions bot commented Dec 11, 2024

Spec Test Coverage Analysis

Total Tested
536 475 (88.62 %)

@dblock
Copy link
Member

dblock commented Dec 11, 2024

Can we please have some tests that exercise these?

Signed-off-by: Thomas Farr <tsfarr@amazon.com>
@dblock dblock merged commit 25c1c67 into opensearch-project:main Dec 11, 2024
28 checks passed
@Xtansia Xtansia deleted the fix/indices-types branch December 11, 2024 23:02
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