Skip to content

improve annotations #18470

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

Merged
merged 1 commit into from
May 20, 2025
Merged

improve annotations #18470

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 38 additions & 50 deletions ydb/core/viewer/storage_groups.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2190,8 +2190,14 @@ class TStorageGroups : public TViewerPipeClient {
get:
tags:
- storage
summary: Storage groups
description: Information about storage groups
summary: Gets information about storage and groups.
description: >
It can get groups of storage groups or all storage groups.
It's always better to get groups of storage groups first, then get all storage groups in a group.
To get list of groups of storage groups we call it with `group` parameter first,
then we call it with `filter_group` and `filter_group_by` parameters to get content of a group.
For example, to get groups of storage groups we call it with `group=State` parameter,
then we call it with `filter_group_by=State` and `filter_group=ok` parameters.
parameters:
- name: database
in: query
Expand All @@ -2218,56 +2224,14 @@ class TStorageGroups : public TViewerPipeClient {
description: group id
required: false
type: integer
- name: need_groups
in: query
description: return groups information
required: false
type: boolean
default: true
- name: need_disks
in: query
description: return disks information
required: false
type: boolean
default: true
- name: with
in: query
description: >
filter groups by missing or space:
* `missing`
* `space`
required: false
type: string
- name: filter
description: filter to search for in group ids and pool names
required: false
type: string
- name: filter_group_by
in: query
description: >
filter group by:
* `GroupId`
* `Erasure`
* `Usage`
* `DiskSpaceUsage`
* `PoolName`
* `Kind`
* `Encryption`
* `MediaType`
* `MissingDisks`
* `State`
* `Latency`
required: false
type: string
- name: filter_group
in: query
description: content for filter group by
required: false
type: string
- name: sort
in: query
description: >
sort by:
sort storage groups by:
* `PoolName`
* `Kind`
* `MediaType`
Expand All @@ -2291,7 +2255,26 @@ class TStorageGroups : public TViewerPipeClient {
- name: group
in: query
description: >
group by:
returns groups of storage groups with number of storage groups in every group.
grouping by:
* `GroupId`
* `Erasure`
* `Usage`
* `DiskSpaceUsage`
* `PoolName`
* `Kind`
* `Encryption`
* `MediaType`
* `MissingDisks`
* `State`
* `Latency`
required: false
type: string
- name: filter_group_by
in: query
description: >
returns conent of a group of storage groups, expects to have filter_group parameter.
grouping by:
* `GroupId`
* `Erasure`
* `Usage`
Expand All @@ -2305,6 +2288,11 @@ class TStorageGroups : public TViewerPipeClient {
* `Latency`
required: false
type: string
- name: filter_group
in: query
description: name of a group of storage groups, used for filter_group_by
required: false
type: string
- name: fields_required
in: query
description: >
Expand Down Expand Up @@ -2333,12 +2321,12 @@ class TStorageGroups : public TViewerPipeClient {
type: string
- name: offset
in: query
description: skip N nodes
description: skip N nodes, used together with limit to implement paging
required: false
type: integer
- name: limit
in: query
description: limit to N nodes
description: limit result to N nodes, used together with offset to implement paging
required: false
type: integer
- name: timeout
Expand Down Expand Up @@ -2378,8 +2366,8 @@ class TStorageGroups : public TViewerPipeClient {
" * `ok` - group is okay\n"
" * `starting:n` - group is okay, but n disks are starting\n"
" * `replicating:n` - group is okay, all disks are available, but n disks are replicating\n"
" * `degraded:n(m, m...)` - group is okay, but n fail realms are not available (with m fail domains)\n"
" * `dead:n` - group is not okay, n fail realms are not available\n";
" * `degraded:n(m, m...)` - group is okay, but n data centers / racks are not available (with m devices)\n"
" * `dead:n` - group is not okay, n data centers / racks are not available\n";
storageGroupProperties["Kind"]["description"] = "kind of the disks in this group (specified by the user)";
storageGroupProperties["MediaType"]["description"] = "actual physical media type of the disks in this group";
storageGroupProperties["MissingDisks"]["description"] = "number of disks missing";
Expand Down
18 changes: 2 additions & 16 deletions ydb/core/viewer/viewer_healthcheck.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,25 +242,11 @@ class TJsonHealthCheck : public TViewerPipeClient {
.Summary = "Self-check result",
.Description = "Performs self-check and returns result",
});
yaml.AddParameter({
.Name = "enums",
.Description = "convert enums to strings",
.Type = "boolean",
});
yaml.AddParameter({
.Name = "ui64",
.Description = "return ui64 as number",
.Type = "boolean",
});
yaml.AddParameter({
.Name = "timeout",
.Description = "timeout in ms",
.Type = "integer",
});
yaml.AddParameter({
.Name = "database",
.Description = "database name",
.Description = "database name, use cluster domain name to get cluster storage status",
.Type = "string",
.Required = true,
});
yaml.AddParameter({
.Name = "cache",
Expand Down
8 changes: 1 addition & 7 deletions ydb/core/viewer/viewer_nodes.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3282,7 +3282,7 @@ class TJsonNodes : public TViewerPipeClient {
get:
tags:
- viewer
summary: Nodes info
summary: To get information about nodes
description: Information about nodes
parameters:
- name: database
Expand Down Expand Up @@ -3318,12 +3318,6 @@ class TJsonNodes : public TViewerPipeClient {
* `dynamic`
* `storage`
* `any`
- name: with
in: query
description: >
filter groups by missing or space:
* `missing`
* `space`
- name: storage
in: query
description: return storage info
Expand Down
Loading