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

Change ml.get_tools to have two different operation groups: ml.get_all_tools and ml.get_tool #799

Merged
merged 2 commits into from
Jan 17, 2025

Conversation

nathaliellenaa
Copy link
Contributor

Description

Changed ml.get_tools to have two different operation groups: ml.get_all_tools and ml.get_tool.

Issues Resolved

Resolve #797 (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.

…l_tools and ml.get_tool.

Signed-off-by: Nathalie Jonathan <[email protected]>
Copy link
Contributor

github-actions bot commented Jan 17, 2025

Changes Analysis

Commit SHA: 9afdf3c
Comparing To SHA: 639fd57

API Changes

Summary

├─┬Paths
│ ├─┬/_plugins/_ml/tools/{tool_name}
│ │ └─┬GET
│ │   ├──[🔀] operationId (5763:20)❌ 
│ │   ├─┬Responses
│ │   │ └─┬200
│ │   │   └─┬application/json
│ │   │     └─┬Schema
│ │   │       └──[🔀] $ref (57126:13)❌ 
│ │   └─┬Extensions
│ │     └──[🔀] x-operation-group (5764:26)
│ └─┬/_plugins/_ml/tools
│   └─┬GET
│     ├──[🔀] operationId (5748:20)❌ 
│     ├─┬Responses
│     │ └─┬200
│     │   └─┬application/json
│     │     └─┬Schema
│     │       ├──[➕] items (31995:15)❌ 
│     │       ├──[➕] type (31993:19)❌ 
│     │       ├──[➖] oneOf (55961:7)❌ 
│     │       └──[➖] oneOf (32083:17)❌ 
│     └─┬Extensions
│       └──[🔀] x-operation-group (5749:26)
└─┬Components
  ├──[➖] responses (32079:7)❌ 
  ├──[➕] responses (31990:7)
  ├──[➕] responses (32087:7)
  ├──[➖] parameters (23956:7)❌ 
  ├──[➕] parameters (23956:7)
  ├──[➖] schemas (55961:7)❌ 
  └──[➕] schemas (57126:7)

Document Element Total Changes Breaking Changes
paths 9 7
components 7 3
  • BREAKING Changes: 10 out of 16
  • Modifications: 5
  • Removals: 5
  • Additions: 6
  • Breaking Removals: 5
  • Breaking Modifications: 3
  • Breaking Additions: 2

Report

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

API Coverage

Before After Δ
Covered (%) 659 (64.54 %) 659 (64.54 %) 0 (0 %)
Uncovered (%) 362 (35.46 %) 362 (35.46 %) 0 (0 %)
Unknown 44 44 0

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.

Changes look good, thanks for making this change @nathaliellenaa.
Just had one minor naming change request.

spec/namespaces/ml.yaml Outdated Show resolved Hide resolved
Signed-off-by: Nathalie Jonathan <[email protected]>
Copy link
Contributor

Spec Test Coverage Analysis

Total Tested
590 589 (99.83 %)

@Xtansia Xtansia merged commit c571230 into opensearch-project:main Jan 17, 2025
30 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