Skip to content

Commit abd26e1

Browse files
chore: add JSDoc comments to types
1 parent 9e38274 commit abd26e1

File tree

6 files changed

+31
-16
lines changed

6 files changed

+31
-16
lines changed

src/types/api/compute.ts

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,11 @@ import {EFlag} from './enums';
22
import {TEndpoint, TLegacyNodeLocation, TPoolStats} from './nodes';
33
import {TMetrics} from './tenant';
44

5-
// endpoint: viewer/json/compute
6-
// source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/viewer/protos/viewer.proto
7-
5+
/**
6+
* endpoint: viewer/json/compute
7+
*
8+
* source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/viewer/protos/viewer.proto
9+
*/
810
export interface TComputeInfo {
911
Overall: EFlag;
1012
Tenants?: TComputeTenantInfo[];

src/types/api/nodes.ts

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,11 @@ import {TPDiskStateInfo} from './pdisk';
33
import {TTabletStateInfo} from './tablet';
44
import {TVDiskStateInfo} from './vdisk';
55

6-
// endpoint: /viewer/json/nodes
7-
// source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/viewer/protos/viewer.proto
8-
6+
/**
7+
* endpoint: /viewer/json/nodes
8+
*
9+
* source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/viewer/protos/viewer.proto
10+
*/
911
export interface TNodesInfo {
1012
Overall?: EFlag;
1113
Nodes?: TNodeInfo[];

src/types/api/pdisk.ts

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
import {EFlag} from './enums';
22

3-
// endpoint: /viewer/json/pdiskinfo
4-
// source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/protos/node_whiteboard.proto
5-
3+
/**
4+
* endpoint: /viewer/json/pdiskinfo
5+
*
6+
* source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/protos/node_whiteboard.proto
7+
*/
68
export interface TPDiskStateInfo {
79
PDiskId?: number;
810
/** uint64 */

src/types/api/storage.ts

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
import {EFlag} from './enums';
22
import {TVDiskStateInfo} from './vdisk';
33

4-
// endpoint: /viewer/json/storage
5-
// source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/viewer/protos/viewer.proto
6-
4+
/**
5+
* endpoint: /viewer/json/storage
6+
*
7+
* source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/viewer/protos/viewer.proto
8+
*/
79
export interface TStorageInfo {
810
Overall?: EFlag;
911
StoragePools?: TStoragePoolInfo[];

src/types/api/tenant.ts

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,19 @@ import {TPoolStats, TSystemStateInfo} from './nodes';
33
import {TTabletStateInfo} from './tablet';
44

55
/**
6-
* endpoint: /viewer/json/tenantinfo
6+
* endpoint: /viewer/json/tenants
77
*
88
* source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/viewer/protos/viewer.proto
99
*/
1010
export interface TTenants {
1111
Tenants?: TTenant[];
1212
}
1313

14+
/**
15+
* endpoint: /viewer/json/tenantinfo
16+
*
17+
* source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/viewer/protos/viewer.proto
18+
*/
1419
export interface TTenantInfo {
1520
TenantInfo?: TTenant[];
1621
Errors?: string[];

src/types/api/vdisk.ts

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
import {EFlag} from './enums';
22
import {TPDiskStateInfo} from './pdisk';
33

4-
// endpoint: /viewer/json/vdiskinfo
5-
// source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/protos/node_whiteboard.proto
6-
4+
/**
5+
* endpoint: /viewer/json/vdiskinfo
6+
*
7+
* source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/protos/node_whiteboard.proto
8+
*/
79
export interface TVDiskStateInfo {
810
VDiskId?: TVDiskID;
911
/** uint64 */

0 commit comments

Comments
 (0)