@knowledge-stack/ksapi 1.118.0 → 1.119.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (205) hide show
  1. package/.openapi-generator/FILES +38 -4
  2. package/README.md +25 -4
  3. package/dist/apis/DataSourcesApi.d.ts +170 -9
  4. package/dist/apis/DataSourcesApi.js +207 -4
  5. package/dist/apis/DocumentVersionsApi.d.ts +4 -4
  6. package/dist/apis/DocumentVersionsApi.js +2 -2
  7. package/dist/apis/FoldersApi.d.ts +9 -9
  8. package/dist/apis/FoldersApi.js +2 -2
  9. package/dist/esm/apis/DataSourcesApi.d.ts +170 -9
  10. package/dist/esm/apis/DataSourcesApi.js +208 -5
  11. package/dist/esm/apis/DocumentVersionsApi.d.ts +4 -4
  12. package/dist/esm/apis/DocumentVersionsApi.js +2 -2
  13. package/dist/esm/apis/FoldersApi.d.ts +9 -9
  14. package/dist/esm/apis/FoldersApi.js +3 -3
  15. package/dist/esm/models/BlockChangeType.d.ts +26 -0
  16. package/dist/esm/models/BlockChangeType.js +44 -0
  17. package/dist/esm/models/BlockKind.d.ts +28 -0
  18. package/dist/esm/models/BlockKind.js +46 -0
  19. package/dist/esm/models/BulkModelTablesRequest.d.ts +48 -0
  20. package/dist/esm/models/BulkModelTablesRequest.js +50 -0
  21. package/dist/esm/models/BulkModelTablesResponse.d.ts +48 -0
  22. package/dist/esm/models/BulkModelTablesResponse.js +45 -0
  23. package/dist/esm/models/CellChange.d.ts +47 -0
  24. package/dist/esm/models/CellChange.js +14 -0
  25. package/dist/esm/models/CellDiff.d.ts +7 -0
  26. package/dist/esm/models/CellDiff.js +5 -0
  27. package/dist/esm/models/ChangeClass.d.ts +29 -0
  28. package/dist/esm/models/ChangeClass.js +47 -0
  29. package/dist/esm/models/DataSourceDescriptionResponse.d.ts +53 -0
  30. package/dist/esm/models/DataSourceDescriptionResponse.js +48 -0
  31. package/dist/esm/models/DataSourceDetailResponse.d.ts +13 -4
  32. package/dist/esm/models/DataSourceDetailResponse.js +6 -4
  33. package/dist/esm/models/DataSourceSchemaListItem.d.ts +53 -0
  34. package/dist/esm/models/DataSourceSchemaListItem.js +48 -0
  35. package/dist/esm/models/DataSourceSchemaListResponse.d.ts +3 -3
  36. package/dist/esm/models/DataSourceSchemaListResponse.js +3 -3
  37. package/dist/esm/models/DataSourceSchemaResponse.d.ts +95 -1
  38. package/dist/esm/models/DataSourceSchemaResponse.js +61 -0
  39. package/dist/esm/models/DataSourceTableResponse.d.ts +8 -5
  40. package/dist/esm/models/DataSourceTableResponse.js +4 -2
  41. package/dist/esm/models/DiffFormat.d.ts +2 -0
  42. package/dist/esm/models/DiffFormat.js +3 -1
  43. package/dist/esm/models/DocumentBlockChange.d.ts +174 -0
  44. package/dist/esm/models/DocumentBlockChange.js +97 -0
  45. package/dist/esm/models/DocumentDiff.d.ts +102 -0
  46. package/dist/esm/models/DocumentDiff.js +77 -0
  47. package/dist/esm/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.d.ts → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.d.ts} +9 -6
  48. package/dist/esm/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.js → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.js} +11 -6
  49. package/dist/esm/models/ModelTableResult.d.ts +81 -0
  50. package/dist/esm/models/ModelTableResult.js +63 -0
  51. package/dist/esm/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.d.ts +66 -0
  52. package/dist/esm/models/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.js → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.js} +12 -12
  53. package/dist/esm/models/PartType.d.ts +1 -0
  54. package/dist/esm/models/PartType.js +1 -0
  55. package/dist/esm/models/PixelRegion.d.ts +65 -0
  56. package/dist/esm/models/PixelRegion.js +56 -0
  57. package/dist/esm/models/ReferenceType.d.ts +1 -0
  58. package/dist/esm/models/ReferenceType.js +1 -0
  59. package/dist/esm/models/RevisionEdit.d.ts +71 -0
  60. package/dist/esm/models/RevisionEdit.js +57 -0
  61. package/dist/esm/models/SearchablePartType.d.ts +2 -0
  62. package/dist/esm/models/SearchablePartType.js +2 -0
  63. package/dist/esm/models/SheetVisibilityChange.d.ts +63 -0
  64. package/dist/esm/models/SheetVisibilityChange.js +52 -0
  65. package/dist/esm/models/StructuredChange.d.ts +69 -0
  66. package/dist/esm/models/StructuredChange.js +57 -0
  67. package/dist/esm/models/StructuredChangeType.d.ts +26 -0
  68. package/dist/esm/models/StructuredChangeType.js +44 -0
  69. package/dist/esm/models/StructuredDiff.d.ts +82 -0
  70. package/dist/esm/models/StructuredDiff.js +65 -0
  71. package/dist/esm/models/TableCellChange.d.ts +72 -0
  72. package/dist/esm/models/TableCellChange.js +61 -0
  73. package/dist/esm/models/VersionDiffResponse.d.ts +72 -1
  74. package/dist/esm/models/VersionDiffResponse.js +25 -0
  75. package/dist/esm/models/index.d.ts +19 -2
  76. package/dist/esm/models/index.js +19 -2
  77. package/dist/models/BlockChangeType.d.ts +26 -0
  78. package/dist/models/BlockChangeType.js +52 -0
  79. package/dist/models/BlockKind.d.ts +28 -0
  80. package/dist/models/BlockKind.js +54 -0
  81. package/dist/models/BulkModelTablesRequest.d.ts +48 -0
  82. package/dist/models/BulkModelTablesRequest.js +58 -0
  83. package/dist/models/BulkModelTablesResponse.d.ts +48 -0
  84. package/dist/models/BulkModelTablesResponse.js +53 -0
  85. package/dist/models/CellChange.d.ts +47 -0
  86. package/dist/models/CellChange.js +14 -0
  87. package/dist/models/CellDiff.d.ts +7 -0
  88. package/dist/models/CellDiff.js +5 -0
  89. package/dist/models/ChangeClass.d.ts +29 -0
  90. package/dist/models/ChangeClass.js +55 -0
  91. package/dist/models/DataSourceDescriptionResponse.d.ts +53 -0
  92. package/dist/models/DataSourceDescriptionResponse.js +56 -0
  93. package/dist/models/DataSourceDetailResponse.d.ts +13 -4
  94. package/dist/models/DataSourceDetailResponse.js +6 -4
  95. package/dist/models/DataSourceSchemaListItem.d.ts +53 -0
  96. package/dist/models/DataSourceSchemaListItem.js +56 -0
  97. package/dist/models/DataSourceSchemaListResponse.d.ts +3 -3
  98. package/dist/models/DataSourceSchemaListResponse.js +3 -3
  99. package/dist/models/DataSourceSchemaResponse.d.ts +95 -1
  100. package/dist/models/DataSourceSchemaResponse.js +62 -1
  101. package/dist/models/DataSourceTableResponse.d.ts +8 -5
  102. package/dist/models/DataSourceTableResponse.js +4 -2
  103. package/dist/models/DiffFormat.d.ts +2 -0
  104. package/dist/models/DiffFormat.js +3 -1
  105. package/dist/models/DocumentBlockChange.d.ts +174 -0
  106. package/dist/models/DocumentBlockChange.js +105 -0
  107. package/dist/models/DocumentDiff.d.ts +102 -0
  108. package/dist/models/DocumentDiff.js +85 -0
  109. package/dist/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.d.ts → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.d.ts} +9 -6
  110. package/dist/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.js → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.js} +15 -10
  111. package/dist/models/ModelTableResult.d.ts +81 -0
  112. package/dist/models/ModelTableResult.js +71 -0
  113. package/dist/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.d.ts +66 -0
  114. package/dist/models/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.js → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.js} +18 -18
  115. package/dist/models/PartType.d.ts +1 -0
  116. package/dist/models/PartType.js +1 -0
  117. package/dist/models/PixelRegion.d.ts +65 -0
  118. package/dist/models/PixelRegion.js +64 -0
  119. package/dist/models/ReferenceType.d.ts +1 -0
  120. package/dist/models/ReferenceType.js +1 -0
  121. package/dist/models/RevisionEdit.d.ts +71 -0
  122. package/dist/models/RevisionEdit.js +65 -0
  123. package/dist/models/SearchablePartType.d.ts +2 -0
  124. package/dist/models/SearchablePartType.js +2 -0
  125. package/dist/models/SheetVisibilityChange.d.ts +63 -0
  126. package/dist/models/SheetVisibilityChange.js +60 -0
  127. package/dist/models/StructuredChange.d.ts +69 -0
  128. package/dist/models/StructuredChange.js +65 -0
  129. package/dist/models/StructuredChangeType.d.ts +26 -0
  130. package/dist/models/StructuredChangeType.js +52 -0
  131. package/dist/models/StructuredDiff.d.ts +82 -0
  132. package/dist/models/StructuredDiff.js +73 -0
  133. package/dist/models/TableCellChange.d.ts +72 -0
  134. package/dist/models/TableCellChange.js +69 -0
  135. package/dist/models/VersionDiffResponse.d.ts +72 -1
  136. package/dist/models/VersionDiffResponse.js +25 -0
  137. package/dist/models/index.d.ts +19 -2
  138. package/dist/models/index.js +19 -2
  139. package/docs/BlockChangeType.md +32 -0
  140. package/docs/BlockKind.md +32 -0
  141. package/docs/BulkModelTablesRequest.md +35 -0
  142. package/docs/BulkModelTablesResponse.md +35 -0
  143. package/docs/CellChange.md +15 -1
  144. package/docs/CellDiff.md +2 -0
  145. package/docs/ChangeClass.md +33 -0
  146. package/docs/ChunksApi.md +1 -1
  147. package/docs/DataSourceDescriptionResponse.md +37 -0
  148. package/docs/DataSourceDetailResponse.md +5 -3
  149. package/docs/DataSourceSchemaListItem.md +37 -0
  150. package/docs/DataSourceSchemaListResponse.md +1 -1
  151. package/docs/DataSourceSchemaResponse.md +29 -0
  152. package/docs/DataSourceTableResponse.md +3 -3
  153. package/docs/DataSourcesApi.md +315 -2
  154. package/docs/DocumentBlockChange.md +73 -0
  155. package/docs/DocumentDiff.md +51 -0
  156. package/docs/DocumentVersionsApi.md +1 -1
  157. package/docs/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.md → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.md} +12 -6
  158. package/docs/FoldersApi.md +5 -5
  159. package/docs/ModelTableResult.md +43 -0
  160. package/docs/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.md → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.md} +5 -5
  161. package/docs/PixelRegion.md +41 -0
  162. package/docs/RevisionEdit.md +41 -0
  163. package/docs/SheetVisibilityChange.md +39 -0
  164. package/docs/StructuredChange.md +41 -0
  165. package/docs/StructuredChangeType.md +32 -0
  166. package/docs/StructuredDiff.md +45 -0
  167. package/docs/TableCellChange.md +43 -0
  168. package/docs/VersionDiffResponse.md +23 -1
  169. package/package.json +1 -1
  170. package/src/apis/DataSourcesApi.ts +382 -8
  171. package/src/apis/DocumentVersionsApi.ts +4 -4
  172. package/src/apis/FoldersApi.ts +13 -13
  173. package/src/models/BlockChangeType.ts +54 -0
  174. package/src/models/BlockKind.ts +56 -0
  175. package/src/models/BulkModelTablesRequest.ts +95 -0
  176. package/src/models/BulkModelTablesResponse.ts +91 -0
  177. package/src/models/CellChange.ts +61 -0
  178. package/src/models/CellDiff.ts +16 -0
  179. package/src/models/ChangeClass.ts +57 -0
  180. package/src/models/DataSourceDescriptionResponse.ts +92 -0
  181. package/src/models/DataSourceDetailResponse.ts +24 -13
  182. package/src/models/DataSourceSchemaListItem.ts +92 -0
  183. package/src/models/DataSourceSchemaListResponse.ts +10 -10
  184. package/src/models/DataSourceSchemaResponse.ts +157 -1
  185. package/src/models/DataSourceTableResponse.ts +11 -7
  186. package/src/models/DiffFormat.ts +3 -1
  187. package/src/models/DocumentBlockChange.ts +297 -0
  188. package/src/models/DocumentDiff.ts +169 -0
  189. package/src/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.ts → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.ts} +19 -8
  190. package/src/models/ModelTableResult.ts +136 -0
  191. package/src/models/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.ts → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.ts} +25 -25
  192. package/src/models/PartType.ts +1 -0
  193. package/src/models/PixelRegion.ts +110 -0
  194. package/src/models/ReferenceType.ts +1 -0
  195. package/src/models/RevisionEdit.ts +125 -0
  196. package/src/models/SearchablePartType.ts +2 -0
  197. package/src/models/SheetVisibilityChange.ts +105 -0
  198. package/src/models/StructuredChange.ts +123 -0
  199. package/src/models/StructuredChangeType.ts +54 -0
  200. package/src/models/StructuredDiff.ts +140 -0
  201. package/src/models/TableCellChange.ts +129 -0
  202. package/src/models/VersionDiffResponse.ts +112 -1
  203. package/src/models/index.ts +19 -2
  204. package/dist/esm/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.d.ts +0 -66
  205. package/dist/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.d.ts +0 -66
@@ -0,0 +1,53 @@
1
+ /**
2
+ * Knowledge Stack API
3
+ * Knowledge Stack backend API for authentication and knowledge management
4
+ *
5
+ * The version of the OpenAPI document: 0.1.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * Result of (re)generating a connector's searchable description Document.
14
+ * @export
15
+ * @interface DataSourceDescriptionResponse
16
+ */
17
+ export interface DataSourceDescriptionResponse {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof DataSourceDescriptionResponse
22
+ */
23
+ dataSourceId: string;
24
+ /**
25
+ * PDO id of the generated, ingested 'Database overview' doc
26
+ * @type {string}
27
+ * @memberof DataSourceDescriptionResponse
28
+ */
29
+ descriptionDocumentId: string;
30
+ }
31
+ export declare const DataSourceDescriptionResponsePropertyValidationAttributesMap: {
32
+ [property: string]: {
33
+ maxLength?: number;
34
+ minLength?: number;
35
+ pattern?: string;
36
+ maximum?: number;
37
+ exclusiveMaximum?: boolean;
38
+ minimum?: number;
39
+ exclusiveMinimum?: boolean;
40
+ multipleOf?: number;
41
+ maxItems?: number;
42
+ minItems?: number;
43
+ uniqueItems?: boolean;
44
+ };
45
+ };
46
+ /**
47
+ * Check if a given object implements the DataSourceDescriptionResponse interface.
48
+ */
49
+ export declare function instanceOfDataSourceDescriptionResponse(value: object): value is DataSourceDescriptionResponse;
50
+ export declare function DataSourceDescriptionResponseFromJSON(json: any): DataSourceDescriptionResponse;
51
+ export declare function DataSourceDescriptionResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DataSourceDescriptionResponse;
52
+ export declare function DataSourceDescriptionResponseToJSON(json: any): DataSourceDescriptionResponse;
53
+ export declare function DataSourceDescriptionResponseToJSONTyped(value?: DataSourceDescriptionResponse | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,48 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Knowledge Stack API
5
+ * Knowledge Stack backend API for authentication and knowledge management
6
+ *
7
+ * The version of the OpenAPI document: 0.1.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export const DataSourceDescriptionResponsePropertyValidationAttributesMap = {};
15
+ /**
16
+ * Check if a given object implements the DataSourceDescriptionResponse interface.
17
+ */
18
+ export function instanceOfDataSourceDescriptionResponse(value) {
19
+ if (!('dataSourceId' in value) || value['dataSourceId'] === undefined)
20
+ return false;
21
+ if (!('descriptionDocumentId' in value) || value['descriptionDocumentId'] === undefined)
22
+ return false;
23
+ return true;
24
+ }
25
+ export function DataSourceDescriptionResponseFromJSON(json) {
26
+ return DataSourceDescriptionResponseFromJSONTyped(json, false);
27
+ }
28
+ export function DataSourceDescriptionResponseFromJSONTyped(json, ignoreDiscriminator) {
29
+ if (json == null) {
30
+ return json;
31
+ }
32
+ return {
33
+ 'dataSourceId': json['data_source_id'],
34
+ 'descriptionDocumentId': json['description_document_id'],
35
+ };
36
+ }
37
+ export function DataSourceDescriptionResponseToJSON(json) {
38
+ return DataSourceDescriptionResponseToJSONTyped(json, false);
39
+ }
40
+ export function DataSourceDescriptionResponseToJSONTyped(value, ignoreDiscriminator = false) {
41
+ if (value == null) {
42
+ return value;
43
+ }
44
+ return {
45
+ 'data_source_id': value['dataSourceId'],
46
+ 'description_document_id': value['descriptionDocumentId'],
47
+ };
48
+ }
@@ -9,10 +9,13 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import type { DataSourceSchemaResponse } from './DataSourceSchemaResponse';
12
13
  import type { DataSourceResponse } from './DataSourceResponse';
13
- import type { DataSourceTableResponse } from './DataSourceTableResponse';
14
14
  /**
15
- * A connector plus the modeled tables the caller can read (describe).
15
+ * A connector plus the schemas (and their readable tables) the caller sees.
16
+ *
17
+ * ``description_document_id`` points at the connector's generated, ingested
18
+ * "Database overview" Document (a hidden system file); null until generated.
16
19
  * @export
17
20
  * @interface DataSourceDetailResponse
18
21
  */
@@ -25,10 +28,16 @@ export interface DataSourceDetailResponse {
25
28
  dataSource: DataSourceResponse;
26
29
  /**
27
30
  *
28
- * @type {Array<DataSourceTableResponse>}
31
+ * @type {Array<DataSourceSchemaResponse>}
32
+ * @memberof DataSourceDetailResponse
33
+ */
34
+ schemas: Array<DataSourceSchemaResponse>;
35
+ /**
36
+ *
37
+ * @type {string}
29
38
  * @memberof DataSourceDetailResponse
30
39
  */
31
- tables: Array<DataSourceTableResponse>;
40
+ descriptionDocumentId?: string | null;
32
41
  }
33
42
  export declare const DataSourceDetailResponsePropertyValidationAttributesMap: {
34
43
  [property: string]: {
@@ -11,8 +11,8 @@
11
11
  * https://openapi-generator.tech
12
12
  * Do not edit the class manually.
13
13
  */
14
+ import { DataSourceSchemaResponseFromJSON, DataSourceSchemaResponseToJSON, } from './DataSourceSchemaResponse';
14
15
  import { DataSourceResponseFromJSON, DataSourceResponseToJSON, } from './DataSourceResponse';
15
- import { DataSourceTableResponseFromJSON, DataSourceTableResponseToJSON, } from './DataSourceTableResponse';
16
16
  export const DataSourceDetailResponsePropertyValidationAttributesMap = {};
17
17
  /**
18
18
  * Check if a given object implements the DataSourceDetailResponse interface.
@@ -20,7 +20,7 @@ export const DataSourceDetailResponsePropertyValidationAttributesMap = {};
20
20
  export function instanceOfDataSourceDetailResponse(value) {
21
21
  if (!('dataSource' in value) || value['dataSource'] === undefined)
22
22
  return false;
23
- if (!('tables' in value) || value['tables'] === undefined)
23
+ if (!('schemas' in value) || value['schemas'] === undefined)
24
24
  return false;
25
25
  return true;
26
26
  }
@@ -33,7 +33,8 @@ export function DataSourceDetailResponseFromJSONTyped(json, ignoreDiscriminator)
33
33
  }
34
34
  return {
35
35
  'dataSource': DataSourceResponseFromJSON(json['data_source']),
36
- 'tables': (json['tables'].map(DataSourceTableResponseFromJSON)),
36
+ 'schemas': (json['schemas'].map(DataSourceSchemaResponseFromJSON)),
37
+ 'descriptionDocumentId': json['description_document_id'] == null ? undefined : json['description_document_id'],
37
38
  };
38
39
  }
39
40
  export function DataSourceDetailResponseToJSON(json) {
@@ -45,6 +46,7 @@ export function DataSourceDetailResponseToJSONTyped(value, ignoreDiscriminator =
45
46
  }
46
47
  return {
47
48
  'data_source': DataSourceResponseToJSON(value['dataSource']),
48
- 'tables': (value['tables'].map(DataSourceTableResponseToJSON)),
49
+ 'schemas': (value['schemas'].map(DataSourceSchemaResponseToJSON)),
50
+ 'description_document_id': value['descriptionDocumentId'],
49
51
  };
50
52
  }
@@ -0,0 +1,53 @@
1
+ /**
2
+ * Knowledge Stack API
3
+ * Knowledge Stack backend API for authentication and knowledge management
4
+ *
5
+ * The version of the OpenAPI document: 0.1.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * A namespace discovered by live introspection (not a persisted PDO).
14
+ * @export
15
+ * @interface DataSourceSchemaListItem
16
+ */
17
+ export interface DataSourceSchemaListItem {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof DataSourceSchemaListItem
22
+ */
23
+ name: string;
24
+ /**
25
+ *
26
+ * @type {boolean}
27
+ * @memberof DataSourceSchemaListItem
28
+ */
29
+ isDefault: boolean;
30
+ }
31
+ export declare const DataSourceSchemaListItemPropertyValidationAttributesMap: {
32
+ [property: string]: {
33
+ maxLength?: number;
34
+ minLength?: number;
35
+ pattern?: string;
36
+ maximum?: number;
37
+ exclusiveMaximum?: boolean;
38
+ minimum?: number;
39
+ exclusiveMinimum?: boolean;
40
+ multipleOf?: number;
41
+ maxItems?: number;
42
+ minItems?: number;
43
+ uniqueItems?: boolean;
44
+ };
45
+ };
46
+ /**
47
+ * Check if a given object implements the DataSourceSchemaListItem interface.
48
+ */
49
+ export declare function instanceOfDataSourceSchemaListItem(value: object): value is DataSourceSchemaListItem;
50
+ export declare function DataSourceSchemaListItemFromJSON(json: any): DataSourceSchemaListItem;
51
+ export declare function DataSourceSchemaListItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): DataSourceSchemaListItem;
52
+ export declare function DataSourceSchemaListItemToJSON(json: any): DataSourceSchemaListItem;
53
+ export declare function DataSourceSchemaListItemToJSONTyped(value?: DataSourceSchemaListItem | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,48 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Knowledge Stack API
5
+ * Knowledge Stack backend API for authentication and knowledge management
6
+ *
7
+ * The version of the OpenAPI document: 0.1.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export const DataSourceSchemaListItemPropertyValidationAttributesMap = {};
15
+ /**
16
+ * Check if a given object implements the DataSourceSchemaListItem interface.
17
+ */
18
+ export function instanceOfDataSourceSchemaListItem(value) {
19
+ if (!('name' in value) || value['name'] === undefined)
20
+ return false;
21
+ if (!('isDefault' in value) || value['isDefault'] === undefined)
22
+ return false;
23
+ return true;
24
+ }
25
+ export function DataSourceSchemaListItemFromJSON(json) {
26
+ return DataSourceSchemaListItemFromJSONTyped(json, false);
27
+ }
28
+ export function DataSourceSchemaListItemFromJSONTyped(json, ignoreDiscriminator) {
29
+ if (json == null) {
30
+ return json;
31
+ }
32
+ return {
33
+ 'name': json['name'],
34
+ 'isDefault': json['is_default'],
35
+ };
36
+ }
37
+ export function DataSourceSchemaListItemToJSON(json) {
38
+ return DataSourceSchemaListItemToJSONTyped(json, false);
39
+ }
40
+ export function DataSourceSchemaListItemToJSONTyped(value, ignoreDiscriminator = false) {
41
+ if (value == null) {
42
+ return value;
43
+ }
44
+ return {
45
+ 'name': value['name'],
46
+ 'is_default': value['isDefault'],
47
+ };
48
+ }
@@ -9,7 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- import type { DataSourceSchemaResponse } from './DataSourceSchemaResponse';
12
+ import type { DataSourceSchemaListItem } from './DataSourceSchemaListItem';
13
13
  /**
14
14
  * The source's user namespaces (PG schemas / MySQL databases).
15
15
  * @export
@@ -18,10 +18,10 @@ import type { DataSourceSchemaResponse } from './DataSourceSchemaResponse';
18
18
  export interface DataSourceSchemaListResponse {
19
19
  /**
20
20
  *
21
- * @type {Array<DataSourceSchemaResponse>}
21
+ * @type {Array<DataSourceSchemaListItem>}
22
22
  * @memberof DataSourceSchemaListResponse
23
23
  */
24
- schemas: Array<DataSourceSchemaResponse>;
24
+ schemas: Array<DataSourceSchemaListItem>;
25
25
  }
26
26
  export declare const DataSourceSchemaListResponsePropertyValidationAttributesMap: {
27
27
  [property: string]: {
@@ -11,7 +11,7 @@
11
11
  * https://openapi-generator.tech
12
12
  * Do not edit the class manually.
13
13
  */
14
- import { DataSourceSchemaResponseFromJSON, DataSourceSchemaResponseToJSON, } from './DataSourceSchemaResponse';
14
+ import { DataSourceSchemaListItemFromJSON, DataSourceSchemaListItemToJSON, } from './DataSourceSchemaListItem';
15
15
  export const DataSourceSchemaListResponsePropertyValidationAttributesMap = {};
16
16
  /**
17
17
  * Check if a given object implements the DataSourceSchemaListResponse interface.
@@ -29,7 +29,7 @@ export function DataSourceSchemaListResponseFromJSONTyped(json, ignoreDiscrimina
29
29
  return json;
30
30
  }
31
31
  return {
32
- 'schemas': (json['schemas'].map(DataSourceSchemaResponseFromJSON)),
32
+ 'schemas': (json['schemas'].map(DataSourceSchemaListItemFromJSON)),
33
33
  };
34
34
  }
35
35
  export function DataSourceSchemaListResponseToJSON(json) {
@@ -40,6 +40,6 @@ export function DataSourceSchemaListResponseToJSONTyped(value, ignoreDiscriminat
40
40
  return value;
41
41
  }
42
42
  return {
43
- 'schemas': (value['schemas'].map(DataSourceSchemaResponseToJSON)),
43
+ 'schemas': (value['schemas'].map(DataSourceSchemaListItemToJSON)),
44
44
  };
45
45
  }
@@ -9,12 +9,51 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import type { ItemPermissions } from './ItemPermissions';
13
+ import type { PathPartApprovalState } from './PathPartApprovalState';
14
+ import type { DataSourceTableResponse } from './DataSourceTableResponse';
12
15
  /**
13
- *
16
+ * A schema PDO under a connector, with the readable tables it contains.
14
17
  * @export
15
18
  * @interface DataSourceSchemaResponse
16
19
  */
17
20
  export interface DataSourceSchemaResponse {
21
+ /**
22
+ * Path part type
23
+ * @type {DataSourceSchemaResponsePartTypeEnum}
24
+ * @memberof DataSourceSchemaResponse
25
+ */
26
+ partType?: DataSourceSchemaResponsePartTypeEnum;
27
+ /**
28
+ *
29
+ * @type {string}
30
+ * @memberof DataSourceSchemaResponse
31
+ */
32
+ id: string;
33
+ /**
34
+ * DATA_SOURCE_SCHEMA path_part of this schema
35
+ * @type {string}
36
+ * @memberof DataSourceSchemaResponse
37
+ */
38
+ pathPartId: string;
39
+ /**
40
+ * DATA_SOURCE path_part of the parent connector
41
+ * @type {string}
42
+ * @memberof DataSourceSchemaResponse
43
+ */
44
+ parentPathPartId: string | null;
45
+ /**
46
+ * Full materialized path from root
47
+ * @type {string}
48
+ * @memberof DataSourceSchemaResponse
49
+ */
50
+ materializedPath: string;
51
+ /**
52
+ *
53
+ * @type {string}
54
+ * @memberof DataSourceSchemaResponse
55
+ */
56
+ tenantId: string;
18
57
  /**
19
58
  *
20
59
  * @type {string}
@@ -23,11 +62,66 @@ export interface DataSourceSchemaResponse {
23
62
  name: string;
24
63
  /**
25
64
  *
65
+ * @type {string}
66
+ * @memberof DataSourceSchemaResponse
67
+ */
68
+ dataSourceId: string;
69
+ /**
70
+ * Real namespace in the external DB
71
+ * @type {string}
72
+ * @memberof DataSourceSchemaResponse
73
+ */
74
+ schemaName: string;
75
+ /**
76
+ * True for the connection's default namespace
26
77
  * @type {boolean}
27
78
  * @memberof DataSourceSchemaResponse
28
79
  */
29
80
  isDefault: boolean;
81
+ /**
82
+ *
83
+ * @type {string}
84
+ * @memberof DataSourceSchemaResponse
85
+ */
86
+ description: string | null;
87
+ /**
88
+ *
89
+ * @type {PathPartApprovalState}
90
+ * @memberof DataSourceSchemaResponse
91
+ */
92
+ approvalState: PathPartApprovalState;
93
+ /**
94
+ *
95
+ * @type {ItemPermissions}
96
+ * @memberof DataSourceSchemaResponse
97
+ */
98
+ permissions: ItemPermissions;
99
+ /**
100
+ *
101
+ * @type {Date}
102
+ * @memberof DataSourceSchemaResponse
103
+ */
104
+ createdAt: Date;
105
+ /**
106
+ *
107
+ * @type {Date}
108
+ * @memberof DataSourceSchemaResponse
109
+ */
110
+ updatedAt: Date;
111
+ /**
112
+ * Readable modeled tables in this schema
113
+ * @type {Array<DataSourceTableResponse>}
114
+ * @memberof DataSourceSchemaResponse
115
+ */
116
+ tables?: Array<DataSourceTableResponse>;
30
117
  }
118
+ /**
119
+ * @export
120
+ */
121
+ export declare const DataSourceSchemaResponsePartTypeEnum: {
122
+ readonly DataSourceSchema: "DATA_SOURCE_SCHEMA";
123
+ };
124
+ export type DataSourceSchemaResponsePartTypeEnum = typeof DataSourceSchemaResponsePartTypeEnum[keyof typeof DataSourceSchemaResponsePartTypeEnum];
31
125
  export declare const DataSourceSchemaResponsePropertyValidationAttributesMap: {
32
126
  [property: string]: {
33
127
  maxLength?: number;
@@ -11,15 +11,48 @@
11
11
  * https://openapi-generator.tech
12
12
  * Do not edit the class manually.
13
13
  */
14
+ import { ItemPermissionsFromJSON, ItemPermissionsToJSON, } from './ItemPermissions';
15
+ import { PathPartApprovalStateFromJSON, PathPartApprovalStateToJSON, } from './PathPartApprovalState';
16
+ import { DataSourceTableResponseFromJSON, DataSourceTableResponseToJSON, } from './DataSourceTableResponse';
17
+ /**
18
+ * @export
19
+ */
20
+ export const DataSourceSchemaResponsePartTypeEnum = {
21
+ DataSourceSchema: 'DATA_SOURCE_SCHEMA'
22
+ };
14
23
  export const DataSourceSchemaResponsePropertyValidationAttributesMap = {};
15
24
  /**
16
25
  * Check if a given object implements the DataSourceSchemaResponse interface.
17
26
  */
18
27
  export function instanceOfDataSourceSchemaResponse(value) {
28
+ if (!('id' in value) || value['id'] === undefined)
29
+ return false;
30
+ if (!('pathPartId' in value) || value['pathPartId'] === undefined)
31
+ return false;
32
+ if (!('parentPathPartId' in value) || value['parentPathPartId'] === undefined)
33
+ return false;
34
+ if (!('materializedPath' in value) || value['materializedPath'] === undefined)
35
+ return false;
36
+ if (!('tenantId' in value) || value['tenantId'] === undefined)
37
+ return false;
19
38
  if (!('name' in value) || value['name'] === undefined)
20
39
  return false;
40
+ if (!('dataSourceId' in value) || value['dataSourceId'] === undefined)
41
+ return false;
42
+ if (!('schemaName' in value) || value['schemaName'] === undefined)
43
+ return false;
21
44
  if (!('isDefault' in value) || value['isDefault'] === undefined)
22
45
  return false;
46
+ if (!('description' in value) || value['description'] === undefined)
47
+ return false;
48
+ if (!('approvalState' in value) || value['approvalState'] === undefined)
49
+ return false;
50
+ if (!('permissions' in value) || value['permissions'] === undefined)
51
+ return false;
52
+ if (!('createdAt' in value) || value['createdAt'] === undefined)
53
+ return false;
54
+ if (!('updatedAt' in value) || value['updatedAt'] === undefined)
55
+ return false;
23
56
  return true;
24
57
  }
25
58
  export function DataSourceSchemaResponseFromJSON(json) {
@@ -30,8 +63,22 @@ export function DataSourceSchemaResponseFromJSONTyped(json, ignoreDiscriminator)
30
63
  return json;
31
64
  }
32
65
  return {
66
+ 'partType': json['part_type'] == null ? undefined : json['part_type'],
67
+ 'id': json['id'],
68
+ 'pathPartId': json['path_part_id'],
69
+ 'parentPathPartId': json['parent_path_part_id'],
70
+ 'materializedPath': json['materialized_path'],
71
+ 'tenantId': json['tenant_id'],
33
72
  'name': json['name'],
73
+ 'dataSourceId': json['data_source_id'],
74
+ 'schemaName': json['schema_name'],
34
75
  'isDefault': json['is_default'],
76
+ 'description': json['description'],
77
+ 'approvalState': PathPartApprovalStateFromJSON(json['approval_state']),
78
+ 'permissions': ItemPermissionsFromJSON(json['permissions']),
79
+ 'createdAt': (new Date(json['created_at'])),
80
+ 'updatedAt': (new Date(json['updated_at'])),
81
+ 'tables': json['tables'] == null ? undefined : (json['tables'].map(DataSourceTableResponseFromJSON)),
35
82
  };
36
83
  }
37
84
  export function DataSourceSchemaResponseToJSON(json) {
@@ -42,7 +89,21 @@ export function DataSourceSchemaResponseToJSONTyped(value, ignoreDiscriminator =
42
89
  return value;
43
90
  }
44
91
  return {
92
+ 'part_type': value['partType'],
93
+ 'id': value['id'],
94
+ 'path_part_id': value['pathPartId'],
95
+ 'parent_path_part_id': value['parentPathPartId'],
96
+ 'materialized_path': value['materializedPath'],
97
+ 'tenant_id': value['tenantId'],
45
98
  'name': value['name'],
99
+ 'data_source_id': value['dataSourceId'],
100
+ 'schema_name': value['schemaName'],
46
101
  'is_default': value['isDefault'],
102
+ 'description': value['description'],
103
+ 'approval_state': PathPartApprovalStateToJSON(value['approvalState']),
104
+ 'permissions': ItemPermissionsToJSON(value['permissions']),
105
+ 'created_at': value['createdAt'].toISOString(),
106
+ 'updated_at': value['updatedAt'].toISOString(),
107
+ 'tables': value['tables'] == null ? undefined : (value['tables'].map(DataSourceTableResponseToJSON)),
47
108
  };
48
109
  }
@@ -13,6 +13,9 @@ import type { ItemPermissions } from './ItemPermissions';
13
13
  import type { PathPartApprovalState } from './PathPartApprovalState';
14
14
  /**
15
15
  * Modeled-table response; a discriminated-union variant for listings.
16
+ *
17
+ * The table's schema is its parent ``DataSourceSchema`` PDO; the table no
18
+ * longer carries a ``schema_name`` of its own.
16
19
  * @export
17
20
  * @interface DataSourceTableResponse
18
21
  */
@@ -36,7 +39,7 @@ export interface DataSourceTableResponse {
36
39
  */
37
40
  pathPartId: string;
38
41
  /**
39
- * DATA_SOURCE path_part of the parent connector
42
+ * DATA_SOURCE_SCHEMA path_part of the parent schema
40
43
  * @type {string}
41
44
  * @memberof DataSourceTableResponse
42
45
  */
@@ -66,17 +69,17 @@ export interface DataSourceTableResponse {
66
69
  */
67
70
  dataSourceId: string;
68
71
  /**
69
- *
72
+ * PDO id of the parent schema this table belongs to
70
73
  * @type {string}
71
74
  * @memberof DataSourceTableResponse
72
75
  */
73
- tableName: string;
76
+ dataSourceSchemaId: string;
74
77
  /**
75
- * Schema/namespace in the external DB; null = default schema
78
+ *
76
79
  * @type {string}
77
80
  * @memberof DataSourceTableResponse
78
81
  */
79
- schemaName?: string | null;
82
+ tableName: string;
80
83
  /**
81
84
  *
82
85
  * @type {string}
@@ -38,6 +38,8 @@ export function instanceOfDataSourceTableResponse(value) {
38
38
  return false;
39
39
  if (!('dataSourceId' in value) || value['dataSourceId'] === undefined)
40
40
  return false;
41
+ if (!('dataSourceSchemaId' in value) || value['dataSourceSchemaId'] === undefined)
42
+ return false;
41
43
  if (!('tableName' in value) || value['tableName'] === undefined)
42
44
  return false;
43
45
  if (!('description' in value) || value['description'] === undefined)
@@ -70,8 +72,8 @@ export function DataSourceTableResponseFromJSONTyped(json, ignoreDiscriminator)
70
72
  'tenantId': json['tenant_id'],
71
73
  'name': json['name'],
72
74
  'dataSourceId': json['data_source_id'],
75
+ 'dataSourceSchemaId': json['data_source_schema_id'],
73
76
  'tableName': json['table_name'],
74
- 'schemaName': json['schema_name'] == null ? undefined : json['schema_name'],
75
77
  'description': json['description'],
76
78
  'columnConfig': json['column_config'],
77
79
  'approvalState': PathPartApprovalStateFromJSON(json['approval_state']),
@@ -96,8 +98,8 @@ export function DataSourceTableResponseToJSONTyped(value, ignoreDiscriminator =
96
98
  'tenant_id': value['tenantId'],
97
99
  'name': value['name'],
98
100
  'data_source_id': value['dataSourceId'],
101
+ 'data_source_schema_id': value['dataSourceSchemaId'],
99
102
  'table_name': value['tableName'],
100
- 'schema_name': value['schemaName'],
101
103
  'description': value['description'],
102
104
  'column_config': value['columnConfig'],
103
105
  'approval_state': PathPartApprovalStateToJSON(value['approvalState']),
@@ -16,6 +16,8 @@
16
16
  export declare const DiffFormat: {
17
17
  readonly Text: "text";
18
18
  readonly Cells: "cells";
19
+ readonly Structured: "structured";
20
+ readonly Document: "document";
19
21
  };
20
22
  export type DiffFormat = typeof DiffFormat[keyof typeof DiffFormat];
21
23
  export declare function instanceOfDiffFormat(value: any): boolean;
@@ -17,7 +17,9 @@
17
17
  */
18
18
  export const DiffFormat = {
19
19
  Text: 'text',
20
- Cells: 'cells'
20
+ Cells: 'cells',
21
+ Structured: 'structured',
22
+ Document: 'document'
21
23
  };
22
24
  export function instanceOfDiffFormat(value) {
23
25
  for (const key in DiffFormat) {