-
Notifications
You must be signed in to change notification settings - Fork 64
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 cat namespace descriptions #751
Conversation
Updates all cat namespace descriptions to add automation. Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Changes AnalysisCommit SHA: bc5bce5 API ChangesSummary
ReportThe full API changes report is available at: https://github.com/opensearch-project/opensearch-api-specification/actions/runs/12549169555/artifacts/2371950395 API Coverage
|
Spec Test Coverage Analysis
|
Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Checked the style annotations and errors. Several are for different files, and the majority of errors pertaining to this are either misidentified, for example, the |
Looks like a bug in the linter that should be ignoring links. Can you open an issue please? We ignore that for now. |
There was a problem hiding this 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 comments and changes and let me know if you have any questions. Thanks!
spec/namespaces/cat.yaml
Outdated
schema: | ||
type: boolean | ||
default: false | ||
description: Return local information, do not retrieve the state from cluster-manager node. | ||
description: Returns local information, but does not retrieve the state from cluster-manager node. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
description: Returns local information, but does not retrieve the state from cluster-manager node. | |
description: Returns local information but does not retrieve the state from the cluster manager node. |
spec/namespaces/cat.yaml
Outdated
cat.thread_pool::query.master_timeout: | ||
name: master_timeout | ||
in: query | ||
description: Operation timeout for connection to cluster-manager node. | ||
description: A timeout for connection to the cluster manager node. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"The" timeout? Or, even better, do we mean "The amount of time allowed to establish a connection to the cluster manager node"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Used the last option.
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Hello! Please rebase your PR onto the main branch. I've already prepared PR #753. |
@Tokesh: Done. All tests are passing, besides the Changelog test, which I believe isn't required for description updates. |
@Tokesh You good with this? Re-review/merge pls? (I added a |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, Thank you very much! :)
Happy upcoming New Year!
* Update cat namespace descriptions Updates all cat namespace descriptions to add automation. Signed-off-by: Naarcha-AWS <[email protected]> * Fix linting error Signed-off-by: Naarcha-AWS <[email protected]> * Fix various errors. Signed-off-by: Naarcha-AWS <[email protected]> * Fix remaining linting errors Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Update spec/namespaces/cat.yaml Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
Updates all cat namespace descriptions to add automation.
Must be reviewed by @natebower 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.