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.

Sign up for GitHub

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

Jump to bottom

[DOCS] Adds description to Node APIs #2248

Merged
merged 9 commits into from
Aug 25, 2023
Merged

[DOCS] Adds description to Node APIs #2248

merged 9 commits into from
Aug 25, 2023

Conversation

szabosteve
Copy link
Contributor

Overview

Related to #964.

Adds descriptions to Node API properties. Source of info:

@szabosteve szabosteve mentioned this pull request Aug 25, 2023
Closed
64 tasks
@szabosteve szabosteve marked this pull request as ready for review August 25, 2023 11:34
abdonpijpelink
abdonpijpelink approved these changes Aug 25, 2023
View reviewed changes
Copy link
Contributor

@abdonpijpelink abdonpijpelink left a comment

Choose a reason for hiding this comment

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

LGTM. Left a few small suggestions.

specification/nodes/_types/Stats.ts Outdated Show resolved Hide resolved
specification/nodes/_types/Stats.ts Outdated Show resolved Hide resolved
specification/nodes/_types/Stats.ts Outdated Show resolved Hide resolved
specification/nodes/_types/Stats.ts Outdated Show resolved Hide resolved
specification/nodes/_types/Stats.ts Outdated Show resolved Hide resolved
specification/nodes/_types/Stats.ts Outdated Show resolved Hide resolved
@github-actions
Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
nodes.clear_repositories_metering_archive ⚪ Missing test Missing test
nodes.get_repositories_metering_info ⚪ Missing test Missing test
nodes.hot_threads 🔴 5/5 0/5
nodes.info 🔴 84/84 16/84
nodes.reload_secure_settings 🟢 2/2 2/2
nodes.stats 🟢 42/42 42/42
nodes.usage 🟢 1/1 1/1

You can validate these APIs yourself by using the make validate target.

3 similar comments
@github-actions
Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
nodes.clear_repositories_metering_archive ⚪ Missing test Missing test
nodes.get_repositories_metering_info ⚪ Missing test Missing test
nodes.hot_threads 🔴 5/5 0/5
nodes.info 🔴 84/84 16/84
nodes.reload_secure_settings 🟢 2/2 2/2
nodes.stats 🟢 42/42 42/42
nodes.usage 🟢 1/1 1/1

You can validate these APIs yourself by using the make validate target.

@github-actions
Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
nodes.clear_repositories_metering_archive ⚪ Missing test Missing test
nodes.get_repositories_metering_info ⚪ Missing test Missing test
nodes.hot_threads 🔴 5/5 0/5
nodes.info 🔴 84/84 16/84
nodes.reload_secure_settings 🟢 2/2 2/2
nodes.stats 🟢 42/42 42/42
nodes.usage 🟢 1/1 1/1

You can validate these APIs yourself by using the make validate target.

@github-actions
Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
nodes.clear_repositories_metering_archive ⚪ Missing test Missing test
nodes.get_repositories_metering_info ⚪ Missing test Missing test
nodes.hot_threads 🔴 5/5 0/5
nodes.info 🔴 84/84 16/84
nodes.reload_secure_settings 🟢 2/2 2/2
nodes.stats 🟢 42/42 42/42
nodes.usage 🟢 1/1 1/1

You can validate these APIs yourself by using the make validate target.

@szabosteve szabosteve merged commit 19aa151 into main Aug 25, 2023
5 checks passed
@szabosteve szabosteve deleted the szabosteve/node branch August 25, 2023 13:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@abdonpijpelink abdonpijpelink abdonpijpelink approved these changes

Assignees
No one assigned
Labels
specification
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@szabosteve @abdonpijpelink