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

Added _ml/agents and ml/connectors specs #585

Merged
merged 6 commits into from
Sep 20, 2024

Conversation

junweid62
Copy link
Contributor

Description

This PR documents a subset of the ML Commons APIs consumed by the Flow Framework client.

Previously covered API specs (in other PRs):

  • POST /_plugins/_ml/model_groups/_register
  • POST /_plugins/_ml/models/_register
  • DELETE /_plugins/_ml/models/{model_id}
  • POST /_plugins/_ml/models/{model_id}/_deploy
  • POST /_plugins/_ml/models/{model_id}/_undeploy

New API specs added in this PR:

  • POST /_plugins/_ml/agents/_register
  • DELETE /_plugins/_ml/agents/{agent_id}
  • POST /_plugins/_ml/connectors/_create
  • DELETE /_plugins/_ml/connectors/{connector_id}

Issues Resolved

Part of #228
Task 3 of #833

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

github-actions bot commented Sep 18, 2024

Changes Analysis

Commit SHA: 030944a
Comparing To SHA: 2487252

API Changes

Summary

├─┬Paths
│ ├──[➕] path (4380:3)
│ ├──[➕] path (4364:3)
│ ├──[➕] path (4395:3)
│ └──[➕] path (4411:3)
└─┬Components
  ├──[➕] responses (28100:7)
  ├──[➕] responses (28095:7)
  ├──[➕] responses (28087:7)
  ├──[➕] responses (28145:7)
  ├──[➕] requestBodies (25655:7)
  ├──[➕] requestBodies (25660:7)
  ├──[➕] parameters (21611:7)
  ├──[➕] parameters (21617:7)
  ├──[➕] schemas (50205:7)
  ├──[➕] schemas (50166:7)
  ├──[➕] schemas (50230:7)
  ├──[➕] schemas (50276:7)
  ├──[➕] schemas (50386:7)
  ├──[➕] schemas (50132:7)
  ├──[➕] schemas (50223:7)
  ├──[➕] schemas (50195:7)
  ├──[➕] schemas (50273:7)
  └──[➕] schemas (50149:7)

Document Element Total Changes Breaking Changes
components 18 0
paths 4 0
  • Total Changes: 22
  • Additions: 22

Report

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

API Coverage

Before After Δ
Covered (%) 584 (57.2 %) 588 (57.59 %) 4 (0.39 %)
Uncovered (%) 437 (42.8 %) 433 (42.41 %) -4 (-0.39 %)
Unknown 25 25 0

Signed-off-by: Junwei Dai <[email protected]>
Copy link

Spec Test Coverage Analysis

Total Tested
500 302 (60.4 %)

Copy link
Member

@dbwiddis dbwiddis left a comment

Choose a reason for hiding this comment

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

LGTM from an API standpoint!

Comment on lines +180 to +187
required:
- actions
- credential
- description
- name
- parameters
- protocol
- version
Copy link
Member

Choose a reason for hiding this comment

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

This is exactly the data we're going to want to pull programmatically to validate our templates. Glad to see it being added!

Copy link
Member

@dblock dblock left a comment

Choose a reason for hiding this comment

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

LGTM, small stuff for the broken link in CHANGELOG (missing a )).

CHANGELOG.md Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
junweid62 and others added 3 commits September 19, 2024 09:57
Co-authored-by: Daniel (dB.) Doubrovkine <[email protected]>
Signed-off-by: Junwei Dai <[email protected]>
Signed-off-by: Junwei Dai <[email protected]>
@dblock dblock merged commit c6c0c41 into opensearch-project:main Sep 20, 2024
18 checks passed
dblock added a commit to dblock/opensearch-api-specification that referenced this pull request Sep 23, 2024
* Add Ml api Spec , /connector/_register and /connector/{connector_id} with test

Signed-off-by: Junwei Dai <[email protected]>

* Add Ml api Spec , /agents/_register and /agents/{agent_id} with test

Signed-off-by: Junwei Dai <[email protected]>

* fix: agent_id error

Signed-off-by: Junwei Dai <[email protected]>

* Update CHANGELOG.md

Co-authored-by: Daniel (dB.) Doubrovkine <[email protected]>
Signed-off-by: Junwei Dai <[email protected]>

* Readded empty line

Signed-off-by: Junwei Dai <[email protected]>

---------

Signed-off-by: Junwei Dai <[email protected]>
Signed-off-by: Junwei Dai <[email protected]>
Co-authored-by: Junwei Dai <[email protected]>
Co-authored-by: Daniel (dB.) Doubrovkine <[email protected]>
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