@explo-tech/fido-api 0.0.11 → 0.0.13

package/core/OpenAPI.ts

@@ -20,7 +20,7 @@ export type OpenAPIConfig = {
 
 export const OpenAPI: OpenAPIConfig = {
     BASE: '',
-    VERSION: 'unspecified',
+    VERSION: '1.0',
     WITH_CREDENTIALS: false,
     CREDENTIALS: 'include',
     TOKEN: undefined,

package/index.ts

@@ -27,14 +27,12 @@ export type { DecimalPropertyValue } from './models/DecimalPropertyValue';
 export type { DoublePropertyValue } from './models/DoublePropertyValue';
 export type { Filter } from './models/Filter';
 export type { IntegerPropertyValue } from './models/IntegerPropertyValue';
-export type { LocalDate } from './models/LocalDate';
 export type { MySql } from './models/MySql';
 export type { MySqlAuthentication } from './models/MySqlAuthentication';
 export type { Namespace } from './models/Namespace';
 export type { NamespaceRequest } from './models/NamespaceRequest';
 export type { NamespaceResponse } from './models/NamespaceResponse';
 export type { NamespaceResponseMetadata } from './models/NamespaceResponseMetadata';
-export type { OffsetDateTime } from './models/OffsetDateTime';
 export type { PagingConfiguration } from './models/PagingConfiguration';
 export type { PasswordAuthentication } from './models/PasswordAuthentication';
 export type { Postgres } from './models/Postgres';
@@ -64,7 +62,7 @@ export type { ViewResponse } from './models/ViewResponse';
 export type { ViewRunRequest } from './models/ViewRunRequest';
 
 export { BulkViewsResourceService } from './services/BulkViewsResourceService';
-export { DatasourceResourceService } from './services/DatasourceResourceService';
+export { DataSourceResourceService } from './services/DataSourceResourceService';
 export { HealthResourceService } from './services/HealthResourceService';
 export { NamespaceResourceService } from './services/NamespaceResourceService';
 export { QueryResourceService } from './services/QueryResourceService';

package/models/ComputedView.ts

@@ -6,10 +6,10 @@ import type { PropertySchema } from './PropertySchema';
 
 export type ComputedView = {
     name: string;
-    description: string;
+    description: string | null;
     columnDefinitions: Array<PropertySchema>;
-    id: string | null;
-    namespaceId: string | null;
+    readonly id: string;
+    readonly namespaceId: string;
     query: string;
 };
 

package/models/DataSource.ts

@@ -7,8 +7,8 @@ import type { DataSourceConfiguration } from './DataSourceConfiguration';
 export type DataSource = {
     name: string;
     externalId: string;
-    id: string | null;
-    namespaceId: string | null;
+    readonly id: string;
+    readonly namespaceId: string;
     configuration: DataSourceConfiguration;
 };
 

package/models/DatePropertyValue.ts

@@ -2,9 +2,7 @@
 /* tslint:disable */
 /* eslint-disable */
 
-import type { LocalDate } from './LocalDate';
-
 export type DatePropertyValue = {
-    value: LocalDate;
+    value: string;
 };
 

package/models/DateTimePropertyValue.ts

@@ -2,9 +2,7 @@
 /* tslint:disable */
 /* eslint-disable */
 
-import type { OffsetDateTime } from './OffsetDateTime';
-
 export type DateTimePropertyValue = {
-    value: OffsetDateTime;
+    value: string;
 };
 

package/models/Namespace.ts

@@ -4,6 +4,6 @@
 
 export type Namespace = {
     name: string;
-    id: string | null;
+    readonly id: string;
 };
 

package/models/TableView.ts

@@ -6,10 +6,10 @@ import type { PropertySchema } from './PropertySchema';
 
 export type TableView = {
     name: string;
-    description: string;
+    description: string | null;
     columnDefinitions: Array<PropertySchema>;
-    id: string | null;
-    namespaceId: string | null;
+    readonly id: string;
+    readonly namespaceId: string;
     tableName: string;
 };
 

package/models/View.ts

@@ -8,9 +8,9 @@ import type { TableView } from './TableView';
 
 export type View = (TableView | ComputedView | {
     name: string;
-    description: string;
+    description: string | null;
     columnDefinitions: Array<PropertySchema>;
-    id: string | null;
-    namespaceId: string | null;
+    readonly id: string;
+    readonly namespaceId: string;
 });
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@explo-tech/fido-api",
-  "version": "0.0.11",
+  "version": "0.0.13",
   "description": "Fido api",
   "homepage": "https://github.com/trust-kaz/fido",
   "license": "MIT",

package/services/BulkViewsResourceService.ts

@@ -12,12 +12,12 @@ export class BulkViewsResourceService {
 
     /**
      * Clones the request set of views
-     * @param requestBody
+     * @param requestBody View ids to clone
      * @returns any The cloned views
      * @throws ApiError
      */
     public static cloneViews(
-        requestBody?: BulkViewsRequest,
+        requestBody: BulkViewsRequest,
     ): CancelablePromise<{
         views: Array<View>;
     }> {
@@ -25,18 +25,18 @@ export class BulkViewsResourceService {
             method: 'POST',
             url: '/v1/views/clone',
             body: requestBody,
-            mediaType: 'application/json',
+            mediaType: '*/*',
         });
     }
 
     /**
      * Deletes a view
-     * @param requestBody
+     * @param requestBody View ids to get
      * @returns any The requested views
      * @throws ApiError
      */
     public static getViews(
-        requestBody?: BulkViewsRequest,
+        requestBody: BulkViewsRequest,
     ): CancelablePromise<{
         views: Array<View>;
     }> {
@@ -44,7 +44,7 @@ export class BulkViewsResourceService {
             method: 'POST',
             url: '/v1/views/get',
             body: requestBody,
-            mediaType: 'application/json',
+            mediaType: '*/*',
         });
     }
 

package/services/{DatasourceResourceService.ts → DataSourceResourceService.ts}

@@ -9,7 +9,7 @@ import type { CancelablePromise } from '../core/CancelablePromise';
 import { OpenAPI } from '../core/OpenAPI';
 import { request as __request } from '../core/request';
 
-export class DatasourceResourceService {
+export class DataSourceResourceService {
 
     /**
      * Gets a data source
@@ -36,14 +36,14 @@ export class DatasourceResourceService {
      * Updates a data source's metadata
      * @param id
      * @param namespaceId
-     * @param requestBody
+     * @param requestBody Data Source object to update
      * @returns DataSourceResponse The updated data source
      * @throws ApiError
      */
     public static updateDataSource(
         id: UUID,
         namespaceId: UUID,
-        requestBody?: DataSourceRequest,
+        requestBody: DataSourceRequest,
     ): CancelablePromise<DataSourceResponse> {
         return __request(OpenAPI, {
             method: 'PUT',
@@ -53,7 +53,7 @@ export class DatasourceResourceService {
                 'namespaceId': namespaceId,
             },
             body: requestBody,
-            mediaType: 'application/json',
+            mediaType: '*/*',
         });
     }
 
@@ -61,14 +61,14 @@ export class DatasourceResourceService {
      * Creates a data source
      * @param id
      * @param namespaceId
-     * @param requestBody
+     * @param requestBody Data Source object to create
      * @returns DataSourceResponse The requested data source
      * @throws ApiError
      */
     public static createDataSource(
         id: UUID,
         namespaceId: UUID,
-        requestBody?: DataSourceRequest,
+        requestBody: DataSourceRequest,
     ): CancelablePromise<DataSourceResponse> {
         return __request(OpenAPI, {
             method: 'POST',
@@ -78,7 +78,7 @@ export class DatasourceResourceService {
                 'namespaceId': namespaceId,
             },
             body: requestBody,
-            mediaType: 'application/json',
+            mediaType: '*/*',
         });
     }
 

package/services/NamespaceResourceService.ts

@@ -37,13 +37,13 @@ export class NamespaceResourceService {
     /**
      * Updates a namespace's metadata
      * @param id
-     * @param requestBody
+     * @param requestBody Namespace object to update
      * @returns NamespaceResponse The updated namespace, along with its associated data sources
      * @throws ApiError
      */
     public static updateNamespace(
         id: UUID,
-        requestBody?: NamespaceRequest,
+        requestBody: NamespaceRequest,
     ): CancelablePromise<NamespaceResponse> {
         return __request(OpenAPI, {
             method: 'PUT',
@@ -52,20 +52,20 @@ export class NamespaceResourceService {
                 'id': id,
             },
             body: requestBody,
-            mediaType: 'application/json',
+            mediaType: '*/*',
         });
     }
 
     /**
      * Creates a namespace and optionally a data source associated with it
      * @param id
-     * @param requestBody
+     * @param requestBody Namespace object to create
      * @returns NamespaceResponse The requested namespace, along with its associated data source if applicable
      * @throws ApiError
      */
     public static createNamespace(
         id: UUID,
-        requestBody?: NamespaceRequest,
+        requestBody: NamespaceRequest,
     ): CancelablePromise<NamespaceResponse> {
         return __request(OpenAPI, {
             method: 'POST',
@@ -74,7 +74,7 @@ export class NamespaceResourceService {
                 'id': id,
             },
             body: requestBody,
-            mediaType: 'application/json',
+            mediaType: '*/*',
         });
     }
 

package/services/QueryResourceService.ts

@@ -17,14 +17,14 @@ export class QueryResourceService {
      * Runs a provided query against the provided data source
      * @param dataSourceId
      * @param namespaceId
-     * @param requestBody
+     * @param requestBody Query to preview against the provided data source
      * @returns QueryExecutionResponse A DataPage of the provided query
      * @throws ApiError
      */
     public static getQueryPreview(
         dataSourceId: UUID,
         namespaceId: UUID,
-        requestBody?: QueryPreviewRequest,
+        requestBody: QueryPreviewRequest,
     ): CancelablePromise<QueryExecutionResponse> {
         return __request(OpenAPI, {
             method: 'POST',
@@ -34,7 +34,7 @@ export class QueryResourceService {
                 'namespaceId': namespaceId,
             },
             body: requestBody,
-            mediaType: 'application/json',
+            mediaType: '*/*',
         });
     }
 
@@ -42,14 +42,14 @@ export class QueryResourceService {
      * Gets a preview of a specified table in a Data Source
      * @param dataSourceId
      * @param namespaceId
-     * @param requestBody
+     * @param requestBody Table to preview against the provided data source
      * @returns QueryExecutionResponse A DataPage of the resulting Data Source's data
      * @throws ApiError
      */
     public static getTablePreview(
         dataSourceId: UUID,
         namespaceId: UUID,
-        requestBody?: TablePreviewRequest,
+        requestBody: TablePreviewRequest,
     ): CancelablePromise<QueryExecutionResponse> {
         return __request(OpenAPI, {
             method: 'POST',
@@ -59,7 +59,7 @@ export class QueryResourceService {
                 'namespaceId': namespaceId,
             },
             body: requestBody,
-            mediaType: 'application/json',
+            mediaType: '*/*',
         });
     }
 
@@ -68,7 +68,7 @@ export class QueryResourceService {
      * @param dataSourceId
      * @param namespaceId
      * @param viewId
-     * @param requestBody
+     * @param requestBody View to run against the provided data source
      * @returns QueryExecutionResponse A DataPage of the provided query
      * @throws ApiError
      */
@@ -76,7 +76,7 @@ export class QueryResourceService {
         dataSourceId: UUID,
         namespaceId: UUID,
         viewId: UUID,
-        requestBody?: ViewRunRequest,
+        requestBody: ViewRunRequest,
     ): CancelablePromise<QueryExecutionResponse> {
         return __request(OpenAPI, {
             method: 'POST',
@@ -87,7 +87,7 @@ export class QueryResourceService {
                 'viewId': viewId,
             },
             body: requestBody,
-            mediaType: 'application/json',
+            mediaType: '*/*',
         });
     }
 

package/services/ViewResourceService.ts

@@ -36,14 +36,14 @@ export class ViewResourceService {
      * Updates a view's metadata
      * @param id
      * @param namespaceId
-     * @param requestBody
+     * @param requestBody View object to update
      * @returns ViewResponse The updated view
      * @throws ApiError
      */
     public static updateView(
         id: UUID,
         namespaceId: UUID,
-        requestBody?: ViewRequest,
+        requestBody: ViewRequest,
     ): CancelablePromise<ViewResponse> {
         return __request(OpenAPI, {
             method: 'PUT',
@@ -53,7 +53,7 @@ export class ViewResourceService {
                 'namespaceId': namespaceId,
             },
             body: requestBody,
-            mediaType: 'application/json',
+            mediaType: '*/*',
         });
     }
 
@@ -61,14 +61,14 @@ export class ViewResourceService {
      * Creates a view
      * @param id
      * @param namespaceId
-     * @param requestBody
+     * @param requestBody View object to create
      * @returns ViewResponse The requested view
      * @throws ApiError
      */
     public static createView(
         id: UUID,
         namespaceId: UUID,
-        requestBody?: ViewRequest,
+        requestBody: ViewRequest,
     ): CancelablePromise<ViewResponse> {
         return __request(OpenAPI, {
             method: 'POST',
@@ -78,7 +78,7 @@ export class ViewResourceService {
                 'namespaceId': namespaceId,
             },
             body: requestBody,
-            mediaType: 'application/json',
+            mediaType: '*/*',
         });
     }
 

package/models/LocalDate.ts

@@ -1,5 +0,0 @@
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-
-export type LocalDate = string;

package/models/OffsetDateTime.ts

@@ -1,5 +0,0 @@
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-
-export type OffsetDateTime = string;