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

Split get_all variants out of ml.get_memory and ml.get_message #796

Merged
merged 5 commits into from
Jan 15, 2025

Conversation

Xtansia
Copy link
Collaborator

@Xtansia Xtansia commented Jan 15, 2025

Description

Split get_all variants out of ml.get_memory and ml.get_message

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
Contributor

github-actions bot commented Jan 15, 2025

Changes Analysis

Commit SHA: 30f5235
Comparing To SHA: 1681adc

API Changes

Summary

├─┬Paths
│ ├─┬/_plugins/_ml/models/_register_meta
│ │ └─┬POST
│ │   └─┬Requestbody
│ │     └─┬application/json
│ │       └─┬Schema
│ │         └─┬model_format
│ │           └──[🔀] $ref (56080:13)❌ 
│ ├─┬/_plugins/_ml/memory/{memory_id}
│ │ └─┬GET
│ │   ├──[➖] requestBody (28229:7)❌ 
│ │   ├──[🔀] operationId (4998:20)❌ 
│ │   └─┬Responses
│ │     └─┬200
│ │       └─┬application/json
│ │         └─┬Schema
│ │           └──[🔀] $ref (55942:13)❌ 
│ ├─┬/_plugins/_ml/models/{model_id}/_unload
│ │ └─┬POST
│ │   └─┬Requestbody
│ │     └─┬application/json
│ │       └─┬Schema
│ │         └──[➖] required (28561:17)❌ 
│ ├─┬/_plugins/_ml/models/_register
│ │ └─┬POST
│ │   └─┬Requestbody
│ │     └─┬application/json
│ │       └─┬Schema
│ │         └─┬model_format
│ │           └──[🔀] $ref (56080:13)❌ 
│ ├─┬/_plugins/_ml/models/_unload
│ │ └─┬POST
│ │   └─┬Requestbody
│ │     └─┬application/json
│ │       └─┬Schema
│ │         └──[➖] required (28561:17)❌ 
│ ├─┬/_plugins/_ml/models/{model_id}/_undeploy
│ │ └─┬POST
│ │   └─┬Requestbody
│ │     └─┬application/json
│ │       └─┬Schema
│ │         └──[➖] required (28545:17)❌ 
│ ├─┬/_plugins/_ml/memory/message/{message_id}/traces
│ │ └─┬GET
│ │   ├──[➕] parameters (23820:13)❌ 
│ │   ├──[➕] parameters (23827:13)❌ 
│ │   └─┬Responses
│ │     └─┬200
│ │       └─┬application/json
│ │         └─┬Schema
│ │           └──[🔀] $ref (31911:13)❌ 
│ ├─┬/_plugins/_ml/memory
│ │ └─┬GET
│ │   ├──[➕] parameters (23760:13)❌ 
│ │   ├──[➕] parameters (23768:13)❌ 
│ │   ├──[➖] requestBody (28229:7)❌ 
│ │   ├──[🔀] description (4920:20)
│ │   ├──[🔀] operationId (4917:20)❌ 
│ │   ├─┬Responses
│ │   │ └─┬200
│ │   │   └─┬application/json
│ │   │     └─┬Schema
│ │   │       └──[🔀] $ref (31852:13)❌ 
│ │   └─┬Extensions
│ │     └──[🔀] x-operation-group (4918:26)
│ ├─┬/_plugins/_ml/models/_upload
│ │ └─┬POST
│ │   └─┬Requestbody
│ │     └─┬application/json
│ │       └─┬Schema
│ │         └─┬model_format
│ │           └──[🔀] $ref (56080:13)❌ 
│ ├─┬/_plugins/_ml/memory/message/{message_id}
│ │ └─┬GET
│ │   ├──[🔀] operationId (5101:20)❌ 
│ │   └─┬Responses
│ │     └─┬200
│ │       └─┬application/json
│ │         └─┬Schema
│ │           └──[🔀] $ref (55964:13)❌ 
│ ├─┬/_plugins/_ml/models/_undeploy
│ │ └─┬POST
│ │   └─┬Requestbody
│ │     └─┬application/json
│ │       └─┬Schema
│ │         └──[➖] required (28545:17)❌ 
│ ├─┬/_plugins/_ml/models/meta
│ │ └─┬POST
│ │   └─┬Requestbody
│ │     └─┬application/json
│ │       └─┬Schema
│ │         └─┬model_format
│ │           └──[🔀] $ref (56080:13)❌ 
│ ├─┬/_plugins/_ml/models/{model_id}
│ │ └─┬PUT
│ │   └─┬Responses
│ │     └─┬200
│ │       └─┬application/json
│ │         └─┬Schema
│ │           └──[🔀] $ref (36470:13)❌ 
│ ├─┬/_plugins/_ml/memory/{memory_id}/messages
│ │ └─┬GET
│ │   ├──[➕] parameters (23782:13)❌ 
│ │   ├──[➕] parameters (23789:13)❌ 
│ │   ├──[🔀] description (5069:20)
│ │   ├──[🔀] operationId (5066:20)❌ 
│ │   ├─┬Responses
│ │   │ └─┬200
│ │   │   └─┬application/json
│ │   │     └─┬Schema
│ │   │       └──[🔀] $ref (31869:13)❌ 
│ │   └─┬Extensions
│ │     └──[🔀] x-operation-group (5067:26)
│ └─┬/_plugins/_ml/controllers/{model_id}
│   ├─┬GET
│   │ └─┬Responses
│   │   └─┬200
│   │     └─┬application/json
│   │       └─┬Schema
│   │         └─┬user_rate_limiter
│   │           └──[🔀] $ref (31895:17)❌ 
│   ├─┬PUT
│   │ └─┬Requestbody
│   │   └─┬application/json
│   │     └─┬Schema
│   │       └─┬user_rate_limiter
│   │         └──[🔀] $ref (28641:17)❌ 
│   └─┬POST
│     └─┬Requestbody
│       └─┬application/json
│         └─┬Schema
│           └─┬user_rate_limiter
│             └──[🔀] $ref (28208:17)❌ 
└─┬Components
  ├──[➖] requestBodies (28229:7)❌ 
  ├──[➕] responses (31866:7)
  ├──[➕] responses (31849:7)
  ├──[➖] parameters (23782:7)❌ 
  ├──[➕] parameters (23776:7)
  ├──[➕] parameters (23827:7)
  ├──[➕] parameters (23789:7)
  ├──[➕] parameters (23760:7)
  ├──[➕] parameters (23782:7)
  ├──[➕] parameters (23820:7)
  ├──[➕] parameters (23768:7)
  ├──[➖] schemas (55718:7)❌ 
  ├──[➖] schemas (56129:7)❌ 
  ├──[➖] schemas (56971:7)❌ 
  ├──[➖] schemas (55696:7)❌ 
  ├──[➖] schemas (34968:7)❌ 
  ├──[➖] schemas (56995:7)❌ 
  ├──[➖] schemas (55709:7)❌ 
  ├──[➖] schemas (57014:7)❌ 
  ├──[➕] schemas (56080:7)
  ├──[➕] schemas (56178:7)
  ├─┬ml._common___Deploy
  │ └──[🔀] $ref (55715:13)❌ 
  ├─┬ml._common___Source
  │ └─┬model_format
  │   └──[🔀] $ref (56080:13)❌ 
  ├─┬ml._common___Model
  │ └─┬model_format
  │   └──[🔀] $ref (56080:13)❌ 
  ├─┬ml._common___Train
  │ └──[🔀] $ref (56947:13)❌ 
  ├─┬ml._common___Register
  │ └──[🔀] $ref (56505:13)❌ 
  ├─┬ml._common___Undeploy
  │ └──[🔀] $ref (56985:13)❌ 
  ├─┬ml._common___Predict
  │ └──[🔀] $ref (56337:13)❌ 
  └─┬ml._common___RateLimiter
    └─┬limit
      └──[🔀] $ref (36201:9)❌ 

Document Element Total Changes Breaking Changes
paths 33 29
components 29 18
  • BREAKING Changes: 47 out of 62
  • Modifications: 29
  • Removals: 16
  • Additions: 17
  • Breaking Removals: 16
  • Breaking Modifications: 25
  • Breaking Additions: 6

Report

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

API Coverage

Before After Δ
Covered (%) 655 (64.15 %) 655 (64.15 %) 0 (0 %)
Uncovered (%) 366 (35.85 %) 366 (35.85 %) 0 (0 %)
Unknown 44 44 0

Copy link
Contributor

github-actions bot commented Jan 15, 2025

Spec Test Coverage Analysis

Total Tested
586 585 (99.83 %)

@Xtansia Xtansia marked this pull request as ready for review January 15, 2025 03:52
status: [200, 404]
parameters:
memory_id: ${create_memory.memory_id}
chapters:
Copy link
Member

Choose a reason for hiding this comment

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

This file should be memory/messages.yaml.

Signed-off-by: Thomas Farr <[email protected]>
Signed-off-by: Thomas Farr <[email protected]>
Signed-off-by: Thomas Farr <[email protected]>
@Xtansia Xtansia requested a review from dblock January 15, 2025 22:13
Signed-off-by: Thomas Farr <[email protected]>
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.

Naming of files is still off, but I can deal with this later as part of what I am working on.

@dblock dblock merged commit 1422af3 into opensearch-project:main Jan 15, 2025
30 checks passed
@Xtansia Xtansia deleted the fix/ml-schemas branch January 15, 2025 23:03
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