Updated types from json-schema (#461)

This commit is contained in:
darth-coder00 2021-09-10 13:35:01 +05:30 committed by GitHub
parent 9aec3ebc2c
commit 4501e26ad1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 119 additions and 9 deletions

View File

@ -2,10 +2,6 @@
* Create Chart entity request
*/
export interface CreateChart {
/**
* Unique Identifier of the Chart from the Source Service.
*/
chartId?: string;
chartType?: ChartType;
/**
* Chart URL, pointing to its own Service URL
@ -15,6 +11,11 @@ export interface CreateChart {
* Description of the database instance. What it has and how to use it.
*/
description?: string;
/**
* Display Name that identifies this Chart. It could be title or label from the source
* services
*/
displayName?: string;
/**
* Name that identifies this dashboard.
*/

View File

@ -14,6 +14,11 @@ export interface CreateDashboard {
* Description of the database instance. What it has and how to use it.
*/
description?: string;
/**
* Display Name that identifies this Dashboard. It could be title or label from the source
* services
*/
displayName?: string;
/**
* Name that identifies this dashboard.
*/

View File

@ -31,6 +31,10 @@ export interface CreateTopic {
* Number of partitions into which the topic is divided.
*/
partitions: number;
/**
* Replication Factor in integer (more than 1).
*/
replicationFactor?: number;
/**
* Maximum size of a partition in bytes before old data is discarded. For Kafka -
* `retention.bytes` configuration.

View File

@ -3,10 +3,6 @@
* analyzing the data. Charts can be part of Dashboard
*/
export interface Chart {
/**
* Unique Identifier of the Chart from the Source Service.
*/
chartId?: string;
chartType?: ChartType;
/**
* Chart URL, pointing to its own Service URL
@ -16,6 +12,11 @@ export interface Chart {
* Description of the dashboard, what it is, and how to use it.
*/
description?: string;
/**
* Display Name that identifies this Chart. It could be title or label from the source
* services
*/
displayName?: string;
/**
* Followers of this chart.
*/

View File

@ -16,6 +16,11 @@ export interface Dashboard {
* Description of the dashboard, what it is, and how to use it.
*/
description?: string;
/**
* Display Name that identifies this Dashboard. It could be title or label from the source
* services
*/
displayName?: string;
/**
* Followers of this dashboard.
*/

View File

@ -52,6 +52,10 @@ export interface Table {
* Table constraints.
*/
tableConstraints?: TableConstraint[];
/**
* Data profile for a table.
*/
tableProfile?: TableProfile[];
tableType?: TableType;
/**
* Tags for this table.
@ -277,7 +281,8 @@ export interface TableData {
/**
* Data for multiple rows of the table.
*/
rows?: Array<Array<number | string>>;
// eslint-disable-next-line @typescript-eslint/no-explicit-any
rows?: Array<any[]>;
}
/**
@ -297,6 +302,74 @@ export enum ConstraintType {
Unique = 'UNIQUE',
}
/**
* This schema defines the type to capture the table's data profile.
*/
export interface TableProfile {
/**
* No.of columns in the table.
*/
columnCount?: number;
/**
* List of local column profiles of the table.
*/
columnProfile?: ColumnProfile[];
/**
* Data one which profile is taken.
*/
profileDate?: Date;
/**
* No.of rows in the table.
*/
rowCount?: number;
}
/**
* This schema defines the type to capture the table's column profile.
*/
export interface ColumnProfile {
/**
* Maximum value in a column.
*/
max?: string;
/**
* Avg value in a column.
*/
mean?: string;
/**
* Median value in a column.
*/
median?: string;
/**
* Minimum value in a column.
*/
min?: string;
/**
* Column Name.
*/
name?: string;
/**
* No.of null values in a column
*/
nullCount?: number;
/**
* No.of null value proportion in columns
*/
nullProportion?: number;
/**
* Standard deviation of a column.
*/
stddev?: number;
/**
* No. of unique values in the column
*/
uniqueCount?: number;
/**
* Proportion of number of unique values in a column
*/
uniqueProportion?: number;
}
/**
* This schema defines the type used for describing different types of tables.
*/

View File

@ -48,6 +48,10 @@ export interface Topic {
* Number of partitions into which the topic is divided.
*/
partitions: number;
/**
* Replication Factor in integer (more than 1).
*/
replicationFactor?: number;
/**
* Maximum size of a partition in bytes before old data is discarded. For Kafka -
* `retention.bytes` configuration.

View File

@ -0,0 +1,17 @@
/**
* Type used for cursor based pagination information in GET list responses.
*/
export interface Paging {
/**
* After cursor used for getting the next page (see API pagination for details).
*/
after?: string;
/**
* Before cursor used for getting the previous page (see API pagination for details).
*/
before?: string;
/**
* Total number of entries available to page through.
*/
total: number;
}