@cirrobio/api-client 0.0.15-alpha → 0.0.18-alpha

package/dist/models/UploadDatasetRequest.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Cirro Data
+ * Cirro Data Platform service API
+ *
+ * The version of the OpenAPI document: latest
+ * Contact: support@cirro.bio
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface UploadDatasetRequest
+ */
+export interface UploadDatasetRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof UploadDatasetRequest
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof UploadDatasetRequest
+     */
+    description: string;
+    /**
+     *
+     * @type {string}
+     * @memberof UploadDatasetRequest
+     */
+    processId: string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof UploadDatasetRequest
+     */
+    expectedFiles: Array<string>;
+}
+/**
+ * Check if a given object implements the UploadDatasetRequest interface.
+ */
+export declare function instanceOfUploadDatasetRequest(value: object): boolean;
+export declare function UploadDatasetRequestFromJSON(json: any): UploadDatasetRequest;
+export declare function UploadDatasetRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UploadDatasetRequest;
+export declare function UploadDatasetRequestToJSON(value?: UploadDatasetRequest | null): any;

package/dist/models/UploadDatasetRequest.js

@@ -0,0 +1,59 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Cirro Data
+ * Cirro Data Platform service API
+ *
+ * The version of the OpenAPI document: latest
+ * Contact: support@cirro.bio
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UploadDatasetRequestToJSON = exports.UploadDatasetRequestFromJSONTyped = exports.UploadDatasetRequestFromJSON = exports.instanceOfUploadDatasetRequest = void 0;
+/**
+ * Check if a given object implements the UploadDatasetRequest interface.
+ */
+function instanceOfUploadDatasetRequest(value) {
+    var isInstance = true;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "description" in value;
+    isInstance = isInstance && "processId" in value;
+    isInstance = isInstance && "expectedFiles" in value;
+    return isInstance;
+}
+exports.instanceOfUploadDatasetRequest = instanceOfUploadDatasetRequest;
+function UploadDatasetRequestFromJSON(json) {
+    return UploadDatasetRequestFromJSONTyped(json, false);
+}
+exports.UploadDatasetRequestFromJSON = UploadDatasetRequestFromJSON;
+function UploadDatasetRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'description': json['description'],
+        'processId': json['processId'],
+        'expectedFiles': json['expectedFiles'],
+    };
+}
+exports.UploadDatasetRequestFromJSONTyped = UploadDatasetRequestFromJSONTyped;
+function UploadDatasetRequestToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'name': value.name,
+        'description': value.description,
+        'processId': value.processId,
+        'expectedFiles': value.expectedFiles,
+    };
+}
+exports.UploadDatasetRequestToJSON = UploadDatasetRequestToJSON;

package/dist/models/index.d.ts

@@ -11,10 +11,14 @@ export * from './CustomerType';
 export * from './Dashboard';
 export * from './DashboardRequest';
 export * from './Dataset';
+export * from './DatasetAssetsManifest';
 export * from './DatasetDetail';
+export * from './DatasetFile';
+export * from './DatasetViz';
 export * from './Executor';
 export * from './FormSchema';
 export * from './GetExecutionLogsResponse';
+export * from './ImportDataRequest';
 export * from './LogEntry';
 export * from './MetricRecord';
 export * from './NotebookInstance';
@@ -33,8 +37,6 @@ export * from './ProjectSettings';
 export * from './ProjectUser';
 export * from './Reference';
 export * from './ReferenceType';
-export * from './RegisterDatasetRequest';
-export * from './RegisterPublicDataRequest';
 export * from './Sample';
 export * from './SampleRequest';
 export * from './ServiceConnection';
@@ -46,4 +48,6 @@ export * from './Tag';
 export * from './Task';
 export * from './UpdateDatasetRequest';
 export * from './UpdateUserRequest';
+export * from './UploadDatasetCreateResponse';
+export * from './UploadDatasetRequest';
 export * from './User';

package/dist/models/index.js

@@ -29,10 +29,14 @@ __exportStar(require("./CustomerType"), exports);
 __exportStar(require("./Dashboard"), exports);
 __exportStar(require("./DashboardRequest"), exports);
 __exportStar(require("./Dataset"), exports);
+__exportStar(require("./DatasetAssetsManifest"), exports);
 __exportStar(require("./DatasetDetail"), exports);
+__exportStar(require("./DatasetFile"), exports);
+__exportStar(require("./DatasetViz"), exports);
 __exportStar(require("./Executor"), exports);
 __exportStar(require("./FormSchema"), exports);
 __exportStar(require("./GetExecutionLogsResponse"), exports);
+__exportStar(require("./ImportDataRequest"), exports);
 __exportStar(require("./LogEntry"), exports);
 __exportStar(require("./MetricRecord"), exports);
 __exportStar(require("./NotebookInstance"), exports);
@@ -51,8 +55,6 @@ __exportStar(require("./ProjectSettings"), exports);
 __exportStar(require("./ProjectUser"), exports);
 __exportStar(require("./Reference"), exports);
 __exportStar(require("./ReferenceType"), exports);
-__exportStar(require("./RegisterDatasetRequest"), exports);
-__exportStar(require("./RegisterPublicDataRequest"), exports);
 __exportStar(require("./Sample"), exports);
 __exportStar(require("./SampleRequest"), exports);
 __exportStar(require("./ServiceConnection"), exports);
@@ -64,4 +66,6 @@ __exportStar(require("./Tag"), exports);
 __exportStar(require("./Task"), exports);
 __exportStar(require("./UpdateDatasetRequest"), exports);
 __exportStar(require("./UpdateUserRequest"), exports);
+__exportStar(require("./UploadDatasetCreateResponse"), exports);
+__exportStar(require("./UploadDatasetRequest"), exports);
 __exportStar(require("./User"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cirrobio/api-client",
-  "version": "0.0.15-alpha",
+  "version": "0.0.18-alpha",
   "description": "API client for Cirro",
   "author": "CirroBio",
   "repository": {

package/src/apis/DatasetsApi.ts

@@ -16,25 +16,31 @@
 import * as runtime from '../runtime';
 import type {
   CreateResponse,
+  DatasetAssetsManifest,
   DatasetDetail,
+  ImportDataRequest,
   PaginatedResponseDatasetListDto,
-  RegisterDatasetRequest,
-  RegisterPublicDataRequest,
   UpdateDatasetRequest,
+  UploadDatasetCreateResponse,
+  UploadDatasetRequest,
 } from '../models/index';
 import {
     CreateResponseFromJSON,
     CreateResponseToJSON,
+    DatasetAssetsManifestFromJSON,
+    DatasetAssetsManifestToJSON,
     DatasetDetailFromJSON,
     DatasetDetailToJSON,
+    ImportDataRequestFromJSON,
+    ImportDataRequestToJSON,
     PaginatedResponseDatasetListDtoFromJSON,
     PaginatedResponseDatasetListDtoToJSON,
-    RegisterDatasetRequestFromJSON,
-    RegisterDatasetRequestToJSON,
-    RegisterPublicDataRequestFromJSON,
-    RegisterPublicDataRequestToJSON,
     UpdateDatasetRequestFromJSON,
     UpdateDatasetRequestToJSON,
+    UploadDatasetCreateResponseFromJSON,
+    UploadDatasetCreateResponseToJSON,
+    UploadDatasetRequestFromJSON,
+    UploadDatasetRequestToJSON,
 } from '../models/index';
 
 export interface DeleteDatasetRequest {
@@ -47,18 +53,25 @@ export interface GetDatasetRequest {
     projectId: string;
 }
 
+export interface GetDatasetManifestRequest {
+    datasetId: string;
+    projectId: string;
+}
+
 export interface GetDatasetsRequest {
     projectId: string;
+    limit?: number;
+    nextToken?: string;
 }
 
-export interface RegisterDatasetOperationRequest {
+export interface ImportPublicDatasetRequest {
     projectId: string;
-    registerDatasetRequest: RegisterDatasetRequest;
+    importDataRequest: ImportDataRequest;
 }
 
-export interface RegisterPublicDatasetRequest {
+export interface RegisterDatasetRequest {
     projectId: string;
-    registerPublicDataRequest: RegisterPublicDataRequest;
+    uploadDatasetRequest: UploadDatasetRequest;
 }
 
 export interface UpdateDatasetOperationRequest {
@@ -164,6 +177,50 @@ export class DatasetsApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Gets a listing of files, charts, and other assets available for the dataset
+     * Get dataset manifest
+     */
+    async getDatasetManifestRaw(requestParameters: GetDatasetManifestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DatasetAssetsManifest>> {
+        if (requestParameters.datasetId === null || requestParameters.datasetId === undefined) {
+            throw new runtime.RequiredError('datasetId','Required parameter requestParameters.datasetId was null or undefined when calling getDatasetManifest.');
+        }
+
+        if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
+            throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling getDatasetManifest.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("accessToken", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/projects/{projectId}/datasets/{datasetId}/files`.replace(`{${"datasetId"}}`, encodeURIComponent(String(requestParameters.datasetId))).replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => DatasetAssetsManifestFromJSON(jsonValue));
+    }
+
+    /**
+     * Gets a listing of files, charts, and other assets available for the dataset
+     * Get dataset manifest
+     */
+    async getDatasetManifest(requestParameters: GetDatasetManifestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DatasetAssetsManifest> {
+        const response = await this.getDatasetManifestRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Retrieves a list of datasets for a given project
      * List datasets
@@ -175,6 +232,14 @@ export class DatasetsApi extends runtime.BaseAPI {
 
         const queryParameters: any = {};
 
+        if (requestParameters.limit !== undefined) {
+            queryParameters['limit'] = requestParameters.limit;
+        }
+
+        if (requestParameters.nextToken !== undefined) {
+            queryParameters['nextToken'] = requestParameters.nextToken;
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
         if (this.configuration && this.configuration.accessToken) {
@@ -205,16 +270,16 @@ export class DatasetsApi extends runtime.BaseAPI {
     }
 
     /**
-     * Registers a dataset in the system
-     * Register private dataset
+     * Download data from public repositories
+     * Import public dataset
      */
-    async registerDatasetRaw(requestParameters: RegisterDatasetOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateResponse>> {
+    async importPublicDatasetRaw(requestParameters: ImportPublicDatasetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateResponse>> {
         if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
-            throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling registerDataset.');
+            throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling importPublicDataset.');
         }
 
-        if (requestParameters.registerDatasetRequest === null || requestParameters.registerDatasetRequest === undefined) {
-            throw new runtime.RequiredError('registerDatasetRequest','Required parameter requestParameters.registerDatasetRequest was null or undefined when calling registerDataset.');
+        if (requestParameters.importDataRequest === null || requestParameters.importDataRequest === undefined) {
+            throw new runtime.RequiredError('importDataRequest','Required parameter requestParameters.importDataRequest was null or undefined when calling importPublicDataset.');
         }
 
         const queryParameters: any = {};
@@ -232,36 +297,36 @@ export class DatasetsApi extends runtime.BaseAPI {
             }
         }
         const response = await this.request({
-            path: `/projects/{projectId}/datasets/upload`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
+            path: `/projects/{projectId}/datasets/import`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
-            body: RegisterDatasetRequestToJSON(requestParameters.registerDatasetRequest),
+            body: ImportDataRequestToJSON(requestParameters.importDataRequest),
         }, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => CreateResponseFromJSON(jsonValue));
     }
 
     /**
-     * Registers a dataset in the system
-     * Register private dataset
+     * Download data from public repositories
+     * Import public dataset
      */
-    async registerDataset(requestParameters: RegisterDatasetOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateResponse> {
-        const response = await this.registerDatasetRaw(requestParameters, initOverrides);
+    async importPublicDataset(requestParameters: ImportPublicDatasetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateResponse> {
+        const response = await this.importPublicDatasetRaw(requestParameters, initOverrides);
         return await response.value();
     }
 
     /**
-     * Download data from public repositories
-     * Register public dataset
+     * Registers a dataset in the system that you upload files into
+     * Upload private dataset
      */
-    async registerPublicDatasetRaw(requestParameters: RegisterPublicDatasetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateResponse>> {
+    async registerDatasetRaw(requestParameters: RegisterDatasetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UploadDatasetCreateResponse>> {
         if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
-            throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling registerPublicDataset.');
+            throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling registerDataset.');
         }
 
-        if (requestParameters.registerPublicDataRequest === null || requestParameters.registerPublicDataRequest === undefined) {
-            throw new runtime.RequiredError('registerPublicDataRequest','Required parameter requestParameters.registerPublicDataRequest was null or undefined when calling registerPublicDataset.');
+        if (requestParameters.uploadDatasetRequest === null || requestParameters.uploadDatasetRequest === undefined) {
+            throw new runtime.RequiredError('uploadDatasetRequest','Required parameter requestParameters.uploadDatasetRequest was null or undefined when calling registerDataset.');
         }
 
         const queryParameters: any = {};
@@ -279,22 +344,22 @@ export class DatasetsApi extends runtime.BaseAPI {
             }
         }
         const response = await this.request({
-            path: `/projects/{projectId}/datasets/public`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
+            path: `/projects/{projectId}/datasets/upload`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
-            body: RegisterPublicDataRequestToJSON(requestParameters.registerPublicDataRequest),
+            body: UploadDatasetRequestToJSON(requestParameters.uploadDatasetRequest),
         }, initOverrides);
 
-        return new runtime.JSONApiResponse(response, (jsonValue) => CreateResponseFromJSON(jsonValue));
+        return new runtime.JSONApiResponse(response, (jsonValue) => UploadDatasetCreateResponseFromJSON(jsonValue));
     }
 
     /**
-     * Download data from public repositories
-     * Register public dataset
+     * Registers a dataset in the system that you upload files into
+     * Upload private dataset
      */
-    async registerPublicDataset(requestParameters: RegisterPublicDatasetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateResponse> {
-        const response = await this.registerPublicDatasetRaw(requestParameters, initOverrides);
+    async registerDataset(requestParameters: RegisterDatasetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UploadDatasetCreateResponse> {
+        const response = await this.registerDatasetRaw(requestParameters, initOverrides);
         return await response.value();
     }
 

package/src/apis/MetadataApi.ts

@@ -41,6 +41,11 @@ export interface GetProjectSchemaRequest {
     projectId: string;
 }
 
+export interface UpdateProjectSchemaRequest {
+    projectId: string;
+    formSchema: FormSchema;
+}
+
 export interface UpdateSampleRequest {
     projectId: string;
     sampleId: string;
@@ -53,6 +58,7 @@ export interface UpdateSampleRequest {
 export class MetadataApi extends runtime.BaseAPI {
 
     /**
+     * Retrieves a list of samples associated with a project along with their metadata
      * Get project samples
      */
     async getProjectSamplesRaw(requestParameters: GetProjectSamplesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseSampleDto>> {
@@ -91,6 +97,7 @@ export class MetadataApi extends runtime.BaseAPI {
     }
 
     /**
+     * Retrieves a list of samples associated with a project along with their metadata
      * Get project samples
      */
     async getProjectSamples(requestParameters: GetProjectSamplesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseSampleDto> {
@@ -137,6 +144,51 @@ export class MetadataApi extends runtime.BaseAPI {
     }
 
     /**
+     * Update project metadata schema
+     */
+    async updateProjectSchemaRaw(requestParameters: UpdateProjectSchemaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
+            throw new runtime.RequiredError('projectId','Required parameter requestParameters.projectId was null or undefined when calling updateProjectSchema.');
+        }
+
+        if (requestParameters.formSchema === null || requestParameters.formSchema === undefined) {
+            throw new runtime.RequiredError('formSchema','Required parameter requestParameters.formSchema was null or undefined when calling updateProjectSchema.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("accessToken", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/projects/{projectId}/schema`.replace(`{${"projectId"}}`, encodeURIComponent(String(requestParameters.projectId))),
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: FormSchemaToJSON(requestParameters.formSchema),
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Update project metadata schema
+     */
+    async updateProjectSchema(requestParameters: UpdateProjectSchemaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.updateProjectSchemaRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Updates metadata on a sample
      * Update sample
      */
     async updateSampleRaw(requestParameters: UpdateSampleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Sample>> {
@@ -178,6 +230,7 @@ export class MetadataApi extends runtime.BaseAPI {
     }
 
     /**
+     * Updates metadata on a sample
      * Update sample
      */
     async updateSample(requestParameters: UpdateSampleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Sample> {

package/src/apis/NotebooksApi.ts

@@ -69,6 +69,8 @@ export interface StopNotebookInstanceRequest {
 export class NotebooksApi extends runtime.BaseAPI {
 
     /**
+     * Creates a notebook instance within the project
+     * Create notebook instance
      */
     async createNotebookInstanceRaw(requestParameters: CreateNotebookInstanceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateResponse>> {
         if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
@@ -105,6 +107,8 @@ export class NotebooksApi extends runtime.BaseAPI {
     }
 
     /**
+     * Creates a notebook instance within the project
+     * Create notebook instance
      */
     async createNotebookInstance(requestParameters: CreateNotebookInstanceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateResponse> {
         const response = await this.createNotebookInstanceRaw(requestParameters, initOverrides);
@@ -112,6 +116,8 @@ export class NotebooksApi extends runtime.BaseAPI {
     }
 
     /**
+     * Triggers a deletion of the notebook instance
+     * Delete notebook instance
      */
     async deleteNotebookInstanceRaw(requestParameters: DeleteNotebookInstanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
         if (requestParameters.notebookInstanceId === null || requestParameters.notebookInstanceId === undefined) {
@@ -145,12 +151,16 @@ export class NotebooksApi extends runtime.BaseAPI {
     }
 
     /**
+     * Triggers a deletion of the notebook instance
+     * Delete notebook instance
      */
     async deleteNotebookInstance(requestParameters: DeleteNotebookInstanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
         await this.deleteNotebookInstanceRaw(requestParameters, initOverrides);
     }
 
     /**
+     * Creates an authenticated URL to open up the notebook instance in your browser
+     * Generate notebook instance URL
      */
     async generateNotebookInstanceUrlRaw(requestParameters: GenerateNotebookInstanceUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OpenNotebookInstanceResponse>> {
         if (requestParameters.notebookInstanceId === null || requestParameters.notebookInstanceId === undefined) {
@@ -184,6 +194,8 @@ export class NotebooksApi extends runtime.BaseAPI {
     }
 
     /**
+     * Creates an authenticated URL to open up the notebook instance in your browser
+     * Generate notebook instance URL
      */
     async generateNotebookInstanceUrl(requestParameters: GenerateNotebookInstanceUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OpenNotebookInstanceResponse> {
         const response = await this.generateNotebookInstanceUrlRaw(requestParameters, initOverrides);
@@ -191,6 +203,8 @@ export class NotebooksApi extends runtime.BaseAPI {
     }
 
     /**
+     * Retrieves the status of the instance
+     * Get notebook instance status
      */
     async getNotebookInstanceStatusRaw(requestParameters: GetNotebookInstanceStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NotebookInstanceStatusResponse>> {
         if (requestParameters.notebookInstanceId === null || requestParameters.notebookInstanceId === undefined) {
@@ -224,6 +238,8 @@ export class NotebooksApi extends runtime.BaseAPI {
     }
 
     /**
+     * Retrieves the status of the instance
+     * Get notebook instance status
      */
     async getNotebookInstanceStatus(requestParameters: GetNotebookInstanceStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NotebookInstanceStatusResponse> {
         const response = await this.getNotebookInstanceStatusRaw(requestParameters, initOverrides);
@@ -231,6 +247,8 @@ export class NotebooksApi extends runtime.BaseAPI {
     }
 
     /**
+     * Retrieves a list of notebook instances that the user has access to
+     * Get notebook instances
      */
     async getNotebookInstancesRaw(requestParameters: GetNotebookInstancesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<NotebookInstance>>> {
         if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
@@ -260,6 +278,8 @@ export class NotebooksApi extends runtime.BaseAPI {
     }
 
     /**
+     * Retrieves a list of notebook instances that the user has access to
+     * Get notebook instances
      */
     async getNotebookInstances(requestParameters: GetNotebookInstancesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<NotebookInstance>> {
         const response = await this.getNotebookInstancesRaw(requestParameters, initOverrides);
@@ -267,6 +287,8 @@ export class NotebooksApi extends runtime.BaseAPI {
     }
 
     /**
+     * Shuts down a running notebook instance
+     * Stop notebook instance
      */
     async stopNotebookInstanceRaw(requestParameters: StopNotebookInstanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
         if (requestParameters.notebookInstanceId === null || requestParameters.notebookInstanceId === undefined) {
@@ -300,6 +322,8 @@ export class NotebooksApi extends runtime.BaseAPI {
     }
 
     /**
+     * Shuts down a running notebook instance
+     * Stop notebook instance
      */
     async stopNotebookInstance(requestParameters: StopNotebookInstanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
         await this.stopNotebookInstanceRaw(requestParameters, initOverrides);