Skip to content

Commit 9faf545

Browse files
Update API Types (#77)
1 parent 6cd168c commit 9faf545

File tree

1 file changed

+243
-0
lines changed

1 file changed

+243
-0
lines changed

src/types/api.types.ts

Lines changed: 243 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -251,6 +251,30 @@ export interface paths {
251251
patch?: never;
252252
trace?: never;
253253
};
254+
'/datasets/{dataset_id}/groups': {
255+
parameters: {
256+
query?: never;
257+
header?: never;
258+
path?: never;
259+
cookie?: never;
260+
};
261+
/**
262+
* List Group Dataset Collaborators
263+
* @description List the groups with which the dataset has been shared.
264+
*/
265+
get: operations['list_group_dataset_collaborators_datasets__dataset_id__groups_get'];
266+
put?: never;
267+
/**
268+
* Create Group Dataset Collaborators
269+
* @description Share a dataset with groups.
270+
*/
271+
post: operations['create_group_dataset_collaborators_datasets__dataset_id__groups_post'];
272+
delete?: never;
273+
options?: never;
274+
head?: never;
275+
patch?: never;
276+
trace?: never;
277+
};
254278
'/datasets/{dataset_id}/users/{user_id}': {
255279
parameters: {
256280
query?: never;
@@ -275,6 +299,30 @@ export interface paths {
275299
patch: operations['update_user_dataset_collaborator_datasets__dataset_id__users__user_id__patch'];
276300
trace?: never;
277301
};
302+
'/datasets/{dataset_id}/groups/{group_id}': {
303+
parameters: {
304+
query?: never;
305+
header?: never;
306+
path?: never;
307+
cookie?: never;
308+
};
309+
get?: never;
310+
put?: never;
311+
post?: never;
312+
/**
313+
* Delete Group Dataset Collaborator
314+
* @description Remove a group's access to a dataset.
315+
*/
316+
delete: operations['delete_group_dataset_collaborator_datasets__dataset_id__groups__group_id__delete'];
317+
options?: never;
318+
head?: never;
319+
/**
320+
* Update Group Dataset Collaborator
321+
* @description Update the sharing permissions of a group on a dataset.
322+
*/
323+
patch: operations['update_group_dataset_collaborator_datasets__dataset_id__groups__group_id__patch'];
324+
trace?: never;
325+
};
278326
'/datasets/{dataset_id}/versions/query': {
279327
parameters: {
280328
query?: never;
@@ -752,6 +800,42 @@ export interface components {
752800
* @enum {string}
753801
*/
754802
GroupAction: 'update' | 'list_members' | 'join' | 'request_to_join';
803+
/** GroupCollaborator */
804+
GroupCollaborator: {
805+
/**
806+
* Id
807+
* Format: uuid4
808+
*/
809+
id: string;
810+
/**
811+
* Permissions
812+
* @default []
813+
*/
814+
permissions?: components['schemas']['Permission'][];
815+
role: components['schemas']['CollaboratorRole'];
816+
/**
817+
* Created At
818+
* Format: date-time
819+
*/
820+
created_at: string;
821+
/**
822+
* Group Id
823+
* Format: uuid4
824+
*/
825+
group_id: string;
826+
/** Group Name */
827+
group_name: string;
828+
};
829+
/** GroupCollaboratorCreate */
830+
GroupCollaboratorCreate: {
831+
/** @default viewer */
832+
role?: components['schemas']['CollaboratorRole'];
833+
/**
834+
* Group Id
835+
* Format: uuid4
836+
*/
837+
group_id: string;
838+
};
755839
/**
756840
* GroupMemberAction
757841
* @enum {string}
@@ -846,6 +930,28 @@ export interface components {
846930
/** Versions */
847931
versions: components['schemas']['DatasetVersionDB'][];
848932
};
933+
/** ListGroupCollaboratorsResponse */
934+
ListGroupCollaboratorsResponse: {
935+
/**
936+
* Starting Token
937+
* @default 0
938+
*/
939+
starting_token?: number;
940+
/**
941+
* Limit
942+
* @default 100
943+
*/
944+
limit?: number;
945+
/**
946+
* Paginated
947+
* @default false
948+
*/
949+
paginated?: boolean;
950+
/** Next Starting Token */
951+
next_starting_token?: number | null;
952+
/** Collaborators */
953+
collaborators: components['schemas']['GroupCollaborator'][];
954+
};
849955
/** ListPromptDatasetResponse */
850956
ListPromptDatasetResponse: {
851957
/**
@@ -1791,6 +1897,75 @@ export interface operations {
17911897
};
17921898
};
17931899
};
1900+
list_group_dataset_collaborators_datasets__dataset_id__groups_get: {
1901+
parameters: {
1902+
query?: {
1903+
starting_token?: number;
1904+
limit?: number;
1905+
};
1906+
header?: never;
1907+
path: {
1908+
dataset_id: string;
1909+
};
1910+
cookie?: never;
1911+
};
1912+
requestBody?: never;
1913+
responses: {
1914+
/** @description Successful Response */
1915+
200: {
1916+
headers: {
1917+
[name: string]: unknown;
1918+
};
1919+
content: {
1920+
'application/json': components['schemas']['ListGroupCollaboratorsResponse'];
1921+
};
1922+
};
1923+
/** @description Validation Error */
1924+
422: {
1925+
headers: {
1926+
[name: string]: unknown;
1927+
};
1928+
content: {
1929+
'application/json': components['schemas']['HTTPValidationError'];
1930+
};
1931+
};
1932+
};
1933+
};
1934+
create_group_dataset_collaborators_datasets__dataset_id__groups_post: {
1935+
parameters: {
1936+
query?: never;
1937+
header?: never;
1938+
path: {
1939+
dataset_id: string;
1940+
};
1941+
cookie?: never;
1942+
};
1943+
requestBody: {
1944+
content: {
1945+
'application/json': components['schemas']['GroupCollaboratorCreate'][];
1946+
};
1947+
};
1948+
responses: {
1949+
/** @description Successful Response */
1950+
200: {
1951+
headers: {
1952+
[name: string]: unknown;
1953+
};
1954+
content: {
1955+
'application/json': components['schemas']['GroupCollaborator'][];
1956+
};
1957+
};
1958+
/** @description Validation Error */
1959+
422: {
1960+
headers: {
1961+
[name: string]: unknown;
1962+
};
1963+
content: {
1964+
'application/json': components['schemas']['HTTPValidationError'];
1965+
};
1966+
};
1967+
};
1968+
};
17941969
delete_user_dataset_collaborator_datasets__dataset_id__users__user_id__delete: {
17951970
parameters: {
17961971
query?: never;
@@ -1859,6 +2034,74 @@ export interface operations {
18592034
};
18602035
};
18612036
};
2037+
delete_group_dataset_collaborator_datasets__dataset_id__groups__group_id__delete: {
2038+
parameters: {
2039+
query?: never;
2040+
header?: never;
2041+
path: {
2042+
dataset_id: string;
2043+
group_id: string;
2044+
};
2045+
cookie?: never;
2046+
};
2047+
requestBody?: never;
2048+
responses: {
2049+
/** @description Successful Response */
2050+
200: {
2051+
headers: {
2052+
[name: string]: unknown;
2053+
};
2054+
content: {
2055+
'application/json': unknown;
2056+
};
2057+
};
2058+
/** @description Validation Error */
2059+
422: {
2060+
headers: {
2061+
[name: string]: unknown;
2062+
};
2063+
content: {
2064+
'application/json': components['schemas']['HTTPValidationError'];
2065+
};
2066+
};
2067+
};
2068+
};
2069+
update_group_dataset_collaborator_datasets__dataset_id__groups__group_id__patch: {
2070+
parameters: {
2071+
query?: never;
2072+
header?: never;
2073+
path: {
2074+
dataset_id: string;
2075+
group_id: string;
2076+
};
2077+
cookie?: never;
2078+
};
2079+
requestBody: {
2080+
content: {
2081+
'application/json': components['schemas']['CollaboratorUpdate'];
2082+
};
2083+
};
2084+
responses: {
2085+
/** @description Successful Response */
2086+
200: {
2087+
headers: {
2088+
[name: string]: unknown;
2089+
};
2090+
content: {
2091+
'application/json': components['schemas']['GroupCollaborator'];
2092+
};
2093+
};
2094+
/** @description Validation Error */
2095+
422: {
2096+
headers: {
2097+
[name: string]: unknown;
2098+
};
2099+
content: {
2100+
'application/json': components['schemas']['HTTPValidationError'];
2101+
};
2102+
};
2103+
};
2104+
};
18622105
query_dataset_versions_datasets__dataset_id__versions_query_post: {
18632106
parameters: {
18642107
query?: {

0 commit comments

Comments
 (0)