Skip to content

Commit 6cd168c

Browse files
Update API Types (#74)
Co-authored-by: Jonah Eisen <jonah@galileo.ai>
1 parent 80469b8 commit 6cd168c

File tree

4 files changed

+319
-4
lines changed

4 files changed

+319
-4
lines changed

src/types/api.types.ts

Lines changed: 312 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,11 @@ export interface paths {
170170
};
171171
/** Get Dataset Content */
172172
get: operations['get_dataset_content_datasets__dataset_id__content_get'];
173-
put?: never;
173+
/**
174+
* Rollback Dataset Content
175+
* @description Rollback the content of a dataset to a previous version.
176+
*/
177+
put: operations['rollback_dataset_content_datasets__dataset_id__content_put'];
174178
post?: never;
175179
delete?: never;
176180
options?: never;
@@ -209,6 +213,23 @@ export interface paths {
209213
patch?: never;
210214
trace?: never;
211215
};
216+
'/datasets/{dataset_id}/content/query': {
217+
parameters: {
218+
query?: never;
219+
header?: never;
220+
path?: never;
221+
cookie?: never;
222+
};
223+
get?: never;
224+
put?: never;
225+
/** Query Dataset Content */
226+
post: operations['query_dataset_content_datasets__dataset_id__content_query_post'];
227+
delete?: never;
228+
options?: never;
229+
head?: never;
230+
patch?: never;
231+
trace?: never;
232+
};
212233
'/datasets/{dataset_id}/users': {
213234
parameters: {
214235
query?: never;
@@ -254,6 +275,40 @@ export interface paths {
254275
patch: operations['update_user_dataset_collaborator_datasets__dataset_id__users__user_id__patch'];
255276
trace?: never;
256277
};
278+
'/datasets/{dataset_id}/versions/query': {
279+
parameters: {
280+
query?: never;
281+
header?: never;
282+
path?: never;
283+
cookie?: never;
284+
};
285+
get?: never;
286+
put?: never;
287+
/** Query Dataset Versions */
288+
post: operations['query_dataset_versions_datasets__dataset_id__versions_query_post'];
289+
delete?: never;
290+
options?: never;
291+
head?: never;
292+
patch?: never;
293+
trace?: never;
294+
};
295+
'/datasets/{dataset_id}/versions/{version_index}/content': {
296+
parameters: {
297+
query?: never;
298+
header?: never;
299+
path?: never;
300+
cookie?: never;
301+
};
302+
/** Get Dataset Version Content */
303+
get: operations['get_dataset_version_content_datasets__dataset_id__versions__version_index__content_get'];
304+
put?: never;
305+
post?: never;
306+
delete?: never;
307+
options?: never;
308+
head?: never;
309+
patch?: never;
310+
trace?: never;
311+
};
257312
}
258313
export type webhooks = Record<string, never>;
259314
export interface components {
@@ -371,6 +426,30 @@ export interface components {
371426
/** Rows */
372427
rows?: components['schemas']['DatasetRow'][];
373428
};
429+
/** DatasetContentFilter */
430+
DatasetContentFilter: {
431+
/** Column Name */
432+
column_name: string;
433+
/** Value */
434+
value: string;
435+
/** @default contains */
436+
operator?: components['schemas']['DatasetContentFilterOperator'];
437+
};
438+
/**
439+
* DatasetContentFilterOperator
440+
* @enum {string}
441+
*/
442+
DatasetContentFilterOperator: 'eq' | 'ne' | 'contains';
443+
/** DatasetContentSortClause */
444+
DatasetContentSortClause: {
445+
/** Column Name */
446+
column_name: string;
447+
/**
448+
* Ascending
449+
* @default true
450+
*/
451+
ascending?: boolean;
452+
};
374453
/** DatasetCreatedAtSort */
375454
DatasetCreatedAtSort: {
376455
/**
@@ -421,6 +500,8 @@ export interface components {
421500
/** Column Names */
422501
column_names: string[] | null;
423502
created_by_user: components['schemas']['UserInfo'] | null;
503+
/** Current Version Index */
504+
current_version_index: number;
424505
};
425506
/** DatasetDeleteColumn */
426507
DatasetDeleteColumn: {
@@ -613,6 +694,54 @@ export interface components {
613694
*/
614695
value: string;
615696
};
697+
/** DatasetVersionDB */
698+
DatasetVersionDB: {
699+
/** Version Index */
700+
version_index: number;
701+
/** Name */
702+
name: string | null;
703+
/**
704+
* Created At
705+
* Format: date-time
706+
*/
707+
created_at: string;
708+
created_by_user: components['schemas']['UserInfo'] | null;
709+
/** Num Rows */
710+
num_rows: number;
711+
/** Column Names */
712+
column_names: string[];
713+
/** Rows Added */
714+
rows_added: number;
715+
/** Rows Removed */
716+
rows_removed: number;
717+
/** Rows Edited */
718+
rows_edited: number;
719+
/** Columns Added */
720+
columns_added: number;
721+
/** Columns Removed */
722+
columns_removed: number;
723+
/** Columns Renamed */
724+
columns_renamed: number;
725+
};
726+
/** DatasetVersionIndexSort */
727+
DatasetVersionIndexSort: {
728+
/**
729+
* @description discriminator enum property added by openapi-typescript
730+
* @enum {string}
731+
*/
732+
name: 'version_index';
733+
/**
734+
* Ascending
735+
* @default true
736+
*/
737+
ascending?: boolean;
738+
/**
739+
* Sort Type
740+
* @default column
741+
* @constant
742+
*/
743+
sort_type?: 'column';
744+
};
616745
/**
617746
* GeneratedScorerAction
618747
* @enum {string}
@@ -690,6 +819,33 @@ export interface components {
690819
/** Datasets */
691820
datasets?: components['schemas']['DatasetDB'][];
692821
};
822+
/** ListDatasetVersionParams */
823+
ListDatasetVersionParams: {
824+
/** Sort */
825+
sort?: components['schemas']['DatasetVersionIndexSort'] | null;
826+
};
827+
/** ListDatasetVersionResponse */
828+
ListDatasetVersionResponse: {
829+
/**
830+
* Starting Token
831+
* @default 0
832+
*/
833+
starting_token?: number;
834+
/**
835+
* Limit
836+
* @default 100
837+
*/
838+
limit?: number;
839+
/**
840+
* Paginated
841+
* @default false
842+
*/
843+
paginated?: boolean;
844+
/** Next Starting Token */
845+
next_starting_token?: number | null;
846+
/** Versions */
847+
versions: components['schemas']['DatasetVersionDB'][];
848+
};
693849
/** ListPromptDatasetResponse */
694850
ListPromptDatasetResponse: {
695851
/**
@@ -800,11 +956,22 @@ export interface components {
800956
/** Rows */
801957
rows?: number | null;
802958
};
959+
/** QueryDatasetParams */
960+
QueryDatasetParams: {
961+
/** Filters */
962+
filters?: components['schemas']['DatasetContentFilter'][];
963+
sort?: components['schemas']['DatasetContentSortClause'] | null;
964+
};
803965
/**
804966
* RegisteredScorerAction
805967
* @enum {string}
806968
*/
807969
RegisteredScorerAction: 'update' | 'delete';
970+
/** RollbackRequest */
971+
RollbackRequest: {
972+
/** Rollback Version */
973+
rollback_version: number;
974+
};
808975
/** Token */
809976
Token: {
810977
/** Access Token */
@@ -1412,6 +1579,39 @@ export interface operations {
14121579
};
14131580
};
14141581
};
1582+
rollback_dataset_content_datasets__dataset_id__content_put: {
1583+
parameters: {
1584+
query?: never;
1585+
header?: never;
1586+
path: {
1587+
dataset_id: string;
1588+
};
1589+
cookie?: never;
1590+
};
1591+
requestBody: {
1592+
content: {
1593+
'application/json': components['schemas']['RollbackRequest'];
1594+
};
1595+
};
1596+
responses: {
1597+
/** @description Successful Response */
1598+
204: {
1599+
headers: {
1600+
[name: string]: unknown;
1601+
};
1602+
content?: never;
1603+
};
1604+
/** @description Validation Error */
1605+
422: {
1606+
headers: {
1607+
[name: string]: unknown;
1608+
};
1609+
content: {
1610+
'application/json': components['schemas']['HTTPValidationError'];
1611+
};
1612+
};
1613+
};
1614+
};
14151615
update_dataset_content_datasets__dataset_id__content_patch: {
14161616
parameters: {
14171617
query?: never;
@@ -1484,6 +1684,44 @@ export interface operations {
14841684
};
14851685
};
14861686
};
1687+
query_dataset_content_datasets__dataset_id__content_query_post: {
1688+
parameters: {
1689+
query?: {
1690+
starting_token?: number;
1691+
limit?: number;
1692+
};
1693+
header?: never;
1694+
path: {
1695+
dataset_id: string;
1696+
};
1697+
cookie?: never;
1698+
};
1699+
requestBody?: {
1700+
content: {
1701+
'application/json': components['schemas']['QueryDatasetParams'];
1702+
};
1703+
};
1704+
responses: {
1705+
/** @description Successful Response */
1706+
200: {
1707+
headers: {
1708+
[name: string]: unknown;
1709+
};
1710+
content: {
1711+
'application/json': components['schemas']['DatasetContent'];
1712+
};
1713+
};
1714+
/** @description Validation Error */
1715+
422: {
1716+
headers: {
1717+
[name: string]: unknown;
1718+
};
1719+
content: {
1720+
'application/json': components['schemas']['HTTPValidationError'];
1721+
};
1722+
};
1723+
};
1724+
};
14871725
list_user_dataset_collaborators_datasets__dataset_id__users_get: {
14881726
parameters: {
14891727
query?: {
@@ -1621,4 +1859,77 @@ export interface operations {
16211859
};
16221860
};
16231861
};
1862+
query_dataset_versions_datasets__dataset_id__versions_query_post: {
1863+
parameters: {
1864+
query?: {
1865+
starting_token?: number;
1866+
limit?: number;
1867+
};
1868+
header?: never;
1869+
path: {
1870+
dataset_id: string;
1871+
};
1872+
cookie?: never;
1873+
};
1874+
requestBody?: {
1875+
content: {
1876+
'application/json': components['schemas']['ListDatasetVersionParams'];
1877+
};
1878+
};
1879+
responses: {
1880+
/** @description Successful Response */
1881+
200: {
1882+
headers: {
1883+
[name: string]: unknown;
1884+
};
1885+
content: {
1886+
'application/json': components['schemas']['ListDatasetVersionResponse'];
1887+
};
1888+
};
1889+
/** @description Validation Error */
1890+
422: {
1891+
headers: {
1892+
[name: string]: unknown;
1893+
};
1894+
content: {
1895+
'application/json': components['schemas']['HTTPValidationError'];
1896+
};
1897+
};
1898+
};
1899+
};
1900+
get_dataset_version_content_datasets__dataset_id__versions__version_index__content_get: {
1901+
parameters: {
1902+
query?: {
1903+
starting_token?: number;
1904+
limit?: number;
1905+
};
1906+
header?: never;
1907+
path: {
1908+
dataset_id: string;
1909+
version_index: number;
1910+
};
1911+
cookie?: never;
1912+
};
1913+
requestBody?: never;
1914+
responses: {
1915+
/** @description Successful Response */
1916+
200: {
1917+
headers: {
1918+
[name: string]: unknown;
1919+
};
1920+
content: {
1921+
'application/json': components['schemas']['DatasetContent'];
1922+
};
1923+
};
1924+
/** @description Validation Error */
1925+
422: {
1926+
headers: {
1927+
[name: string]: unknown;
1928+
};
1929+
content: {
1930+
'application/json': components['schemas']['HTTPValidationError'];
1931+
};
1932+
};
1933+
};
1934+
};
16241935
}

src/types/dataset.types.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,5 @@ export interface Dataset {
99
updated_at: string;
1010
num_rows: number | null;
1111
created_by_user: User | null;
12+
current_version_index: number;
1213
}

0 commit comments

Comments
 (0)