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

Update Query Group API descriptions #674

Merged
merged 4 commits into from
Nov 14, 2024

Conversation

Naarcha-AWS
Copy link
Contributor

Updates the Query Group API descriptions to add automation to Query Group API reference.

@natebower should approve these descriptions before merging.

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.

Will have @natebower review before merging.

Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
spec/namespaces/wlm.yaml Outdated Show resolved Hide resolved
Copy link
Contributor

github-actions bot commented Nov 14, 2024

Changes Analysis

Commit SHA: 5d8895c
Comparing To SHA: 1c46b69

API Changes

Summary

├─┬Paths
│ ├─┬/_wlm/query_group/{name}
│ │ ├─┬GET
│ │ │ ├──[🔀] description (9431:20)
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (25825:20)
│ │ ├─┬PUT
│ │ │ └─┬Parameters
│ │ │   └──[🔀] description (25832:20)
│ │ └─┬DELETE
│ │   ├──[🔀] description (9416:20)
│ │   └─┬Parameters
│ │     └──[🔀] description (25818:20)
│ └─┬/_wlm/query_group
│   ├─┬GET
│   │ └──[🔀] description (9385:20)
│   └─┬PUT
│     └──[🔀] description (9399:20)
└─┬Components
  └─┬wlm._common___QueryGroupResponse
    ├─┬_id
    │ └──[➕] description (57155:24)
    ├─┬updated_at
    │ └──[➕] description (57168:24)
    ├─┬name
    │ └──[➕] description (57158:24)
    ├─┬resiliency_mode
    │ └──[➕] description (57161:24)
    └─┬resource_limits
      └──[➕] description (57172:24)

Document Element Total Changes Breaking Changes
components 5 0
paths 7 0
  • Total Changes: 12
  • Modifications: 7
  • Additions: 5

Report

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

API Coverage

Before After Δ
Covered (%) 588 (57.59 %) 588 (57.59 %) 0 (0 %)
Uncovered (%) 433 (42.41 %) 433 (42.41 %) 0 (0 %)
Unknown 42 42 0

Copy link
Contributor

Spec Test Coverage Analysis

Total Tested
517 349 (67.5 %)

Copy link
Contributor

@natebower natebower left a comment

Choose a reason for hiding this comment

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

@Naarcha-AWS Please see my comment and changes and let me know if you have any questions. Thanks!

spec/namespaces/wlm.yaml Outdated Show resolved Hide resolved
title: OpenSearch Workload Management Query Group API
description: Query group lifecycle APIs for the workload management plugin.
title: Workload Management Query Group API
description: The Query Group Lifecycle APIs creates, updates, and deletes Workload Management query groups.
version: 1.0.0
Copy link
Contributor

Choose a reason for hiding this comment

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

"workload management" is lowercase in the docs.

spec/namespaces/wlm.yaml Outdated Show resolved Hide resolved
spec/namespaces/wlm.yaml Outdated Show resolved Hide resolved
spec/schemas/wlm._common.yaml Outdated Show resolved Hide resolved
spec/schemas/wlm._common.yaml Outdated Show resolved Hide resolved
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
@Naarcha-AWS
Copy link
Contributor Author

@dblock: Editorial review complete. Let me know if I need to make any additional tweaks.

@dblock dblock added the skip-changelog No need to update CHANGELOG. label Nov 14, 2024
@dblock dblock merged commit 0f40a0e into opensearch-project:main Nov 14, 2024
25 of 26 checks passed
@Naarcha-AWS Naarcha-AWS deleted the patch-2 branch November 14, 2024 22:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog No need to update CHANGELOG.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants