chore: add comments to types

Author: artemmufazalov

src/types/api/enums.ts

@@ -1,6 +1,6 @@
 // Shows system status
-// Currently is used in response types of viewer/json/nodes and viewer/json/storage
-// Probably will appear in /viewer/json/tenantinfo /viewer/json/cluster /viewer/json/tabletinfo /viewer/json/compute
+// Currently is used in response types viewer/json/ storage, nodes, compute
+// pdiskinfo, vdiskinfo, tabletinfo, tenantinfo
 export enum EFlag {
     Grey = 'Grey',
     Green = 'Green',

src/types/api/nodes.ts

@@ -2,6 +2,9 @@ import {EFlag} from './enums';
 import {TPDiskStateInfo} from './pdisk';
 import {TTabletStateInfo} from './tablet';
 
+// endpoint: /viewer/json/nodes
+// source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/viewer/protos/viewer.proto
+
 export interface TNodesInfo {
     Overall: EFlag;
     Nodes?: TNodeInfo[];
@@ -64,12 +67,12 @@ export interface TPoolStats {
     Threads?: number;
 }
 
-interface TEndpoint {
+export interface TEndpoint {
     Name?: string;
     Address?: string;
 }
 
-interface TLegacyNodeLocation {
+export interface TLegacyNodeLocation {
     DataCenter?: number;
     Room?: number;
     Rack?: number;

src/types/api/pdisk.ts

@@ -1,5 +1,8 @@
 import {EFlag} from './enums';
 
+// endpoint: /viewer/json/pdiskinfo
+// source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/protos/node_whiteboard.proto
+
 export interface TPDiskStateInfo {
     PDiskId?: number;
     /** uint64 */

src/types/api/schema.ts

@@ -37,6 +37,7 @@ enum EStatus {
     StatusResourceExhausted = 'StatusResourceExhausted',
 }
 
+// source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/protos/flat_scheme_op.proto
 // incomplete interface, only currently used fields are covered
 export interface TPathDescription {
     /** info about the path itself */

src/types/api/storage.ts

@@ -1,6 +1,37 @@
 import {EFlag} from './enums';
 import {TVDiskStateInfo} from './vdisk';
 
+// endpoint: /viewer/json/storage
+// source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/viewer/protos/viewer.proto
+
+export interface TStorageInfo {
+    Overall?: EFlag;
+    StoragePools?: TStoragePoolInfo[];
+    /** uint64 */
+    TotalGroups?: string;
+    /** uint64 */
+    FoundGroups?: string;
+}
+
+interface TStoragePoolInfo {
+    Overall?: EFlag;
+    Name?: string;
+    Kind?: string;
+    Groups?: (TBSGroupStateInfo & THiveStorageGroupStats)[];
+    /** uint64 */
+    AcquiredUnits?: string;
+    AcquiredIOPS?: number;
+    /** uint64 */
+    AcquiredThroughput?: string;
+    /** uint64 */
+    AcquiredSize?: string;
+    MaximumIOPS?: number;
+    /** uint64 */
+    MaximumThroughput?: string;
+    /** uint64 */
+    MaximumSize?: string;
+}
+
 export interface TBSGroupStateInfo {
     GroupID?: number;
     ErasureSpecies?: string;
@@ -43,31 +74,3 @@ interface THiveStorageGroupStats {
     /** uint64 */
     AvailableSize?: string;
 }
-
-interface TStoragePoolInfo {
-    Overall?: EFlag;
-    Name?: string;
-    Kind?: string;
-    Groups?: (TBSGroupStateInfo & THiveStorageGroupStats)[];
-    /** uint64 */
-    AcquiredUnits?: string;
-    AcquiredIOPS?: number;
-    /** uint64 */
-    AcquiredThroughput?: string;
-    /** uint64 */
-    AcquiredSize?: string;
-    MaximumIOPS?: number;
-    /** uint64 */
-    MaximumThroughput?: string;
-    /** uint64 */
-    MaximumSize?: string;
-}
-
-export interface TStorageInfo {
-    Overall?: EFlag;
-    StoragePools?: TStoragePoolInfo[];
-    /** uint64 */
-    TotalGroups?: string;
-    /** uint64 */
-    FoundGroups?: string;
-}

src/types/api/tablet.ts

@@ -1,5 +1,8 @@
 import {EFlag} from './enums';
 
+// endpoint: /viewer/json/tabletinfo
+// source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/protos/sys_view.proto
+
 export interface TEvTabletStateResponse {
     TabletStateInfo?: TTabletStateInfo[];
 

src/types/api/tenant.ts

@@ -2,6 +2,9 @@ import {EFlag} from './enums';
 import {TPoolStats, TSystemStateInfo} from './nodes';
 import {TTabletStateInfo} from './tablet';
 
+// endpoint: /viewer/json/tenantinfo
+// source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/viewer/protos/viewer.proto
+
 export interface TTenants {
     Tenants?: TTenant[];
 }

src/types/api/vdisk.ts

@@ -1,6 +1,9 @@
 import {EFlag} from './enums';
 import {TPDiskStateInfo} from './pdisk';
 
+// endpoint: /viewer/json/vdiskinfo
+// source: https://github.com/ydb-platform/ydb/blob/main/ydb/core/protos/node_whiteboard.proto
+
 export interface TVDiskStateInfo {
     VDiskId?: TVDiskID;
     /** uint64 */