@knowledge-stack/ksapi 1.128.0 → 1.129.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.
- package/README.md +2 -2
- package/dist/esm/models/WorkflowRunAsset.d.ts +11 -0
- package/dist/esm/models/WorkflowRunAsset.js +3 -0
- package/dist/models/WorkflowRunAsset.d.ts +11 -0
- package/dist/models/WorkflowRunAsset.js +3 -0
- package/docs/WorkflowRunAsset.md +3 -1
- package/package.json +1 -1
- package/src/models/WorkflowRunAsset.ts +19 -0
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @knowledge-stack/ksapi@1.
|
|
1
|
+
# @knowledge-stack/ksapi@1.129.0
|
|
2
2
|
|
|
3
3
|
A TypeScript SDK client for the localhost API.
|
|
4
4
|
|
|
@@ -617,7 +617,7 @@ and is automatically generated by the
|
|
|
617
617
|
[OpenAPI Generator](https://openapi-generator.tech) project:
|
|
618
618
|
|
|
619
619
|
- API version: `0.1.0`
|
|
620
|
-
- Package version: `1.
|
|
620
|
+
- Package version: `1.129.0`
|
|
621
621
|
- Generator version: `7.21.0`
|
|
622
622
|
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
|
|
623
623
|
|
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import type { PartType } from './PartType';
|
|
13
|
+
import type { InputOrigin } from './InputOrigin';
|
|
13
14
|
import type { PathPartApprovalState } from './PathPartApprovalState';
|
|
14
15
|
/**
|
|
15
16
|
* One input or output file/reference of a run, actionable in one call.
|
|
@@ -21,6 +22,10 @@ import type { PathPartApprovalState } from './PathPartApprovalState';
|
|
|
21
22
|
* download_document_version (a version-pinned input, e.g. a cloned run's
|
|
22
23
|
* inputs); ``FOLDER`` / ``DATA_SOURCE`` / ``API_CONNECTION`` → list/query via
|
|
23
24
|
* that type's endpoint. Output assets are always ``DOCUMENT``.
|
|
25
|
+
*
|
|
26
|
+
* ``origin`` tags an input asset's provenance (definition common file vs run
|
|
27
|
+
* reference vs upload) so the FE can group them; it is ``None`` on output
|
|
28
|
+
* assets.
|
|
24
29
|
* @export
|
|
25
30
|
* @interface WorkflowRunAsset
|
|
26
31
|
*/
|
|
@@ -61,6 +66,12 @@ export interface WorkflowRunAsset {
|
|
|
61
66
|
* @memberof WorkflowRunAsset
|
|
62
67
|
*/
|
|
63
68
|
approvalState: PathPartApprovalState;
|
|
69
|
+
/**
|
|
70
|
+
*
|
|
71
|
+
* @type {InputOrigin}
|
|
72
|
+
* @memberof WorkflowRunAsset
|
|
73
|
+
*/
|
|
74
|
+
origin?: InputOrigin;
|
|
64
75
|
}
|
|
65
76
|
export declare const WorkflowRunAssetPropertyValidationAttributesMap: {
|
|
66
77
|
[property: string]: {
|
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
14
|
import { PartTypeFromJSON, PartTypeToJSON, } from './PartType';
|
|
15
|
+
import { InputOriginFromJSON, InputOriginToJSON, } from './InputOrigin';
|
|
15
16
|
import { PathPartApprovalStateFromJSON, PathPartApprovalStateToJSON, } from './PathPartApprovalState';
|
|
16
17
|
export const WorkflowRunAssetPropertyValidationAttributesMap = {};
|
|
17
18
|
/**
|
|
@@ -46,6 +47,7 @@ export function WorkflowRunAssetFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
46
47
|
'partType': PartTypeFromJSON(json['part_type']),
|
|
47
48
|
'materializedPath': json['materialized_path'],
|
|
48
49
|
'approvalState': PathPartApprovalStateFromJSON(json['approval_state']),
|
|
50
|
+
'origin': json['origin'] == null ? undefined : InputOriginFromJSON(json['origin']),
|
|
49
51
|
};
|
|
50
52
|
}
|
|
51
53
|
export function WorkflowRunAssetToJSON(json) {
|
|
@@ -62,5 +64,6 @@ export function WorkflowRunAssetToJSONTyped(value, ignoreDiscriminator = false)
|
|
|
62
64
|
'part_type': PartTypeToJSON(value['partType']),
|
|
63
65
|
'materialized_path': value['materializedPath'],
|
|
64
66
|
'approval_state': PathPartApprovalStateToJSON(value['approvalState']),
|
|
67
|
+
'origin': InputOriginToJSON(value['origin']),
|
|
65
68
|
};
|
|
66
69
|
}
|
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import type { PartType } from './PartType';
|
|
13
|
+
import type { InputOrigin } from './InputOrigin';
|
|
13
14
|
import type { PathPartApprovalState } from './PathPartApprovalState';
|
|
14
15
|
/**
|
|
15
16
|
* One input or output file/reference of a run, actionable in one call.
|
|
@@ -21,6 +22,10 @@ import type { PathPartApprovalState } from './PathPartApprovalState';
|
|
|
21
22
|
* download_document_version (a version-pinned input, e.g. a cloned run's
|
|
22
23
|
* inputs); ``FOLDER`` / ``DATA_SOURCE`` / ``API_CONNECTION`` → list/query via
|
|
23
24
|
* that type's endpoint. Output assets are always ``DOCUMENT``.
|
|
25
|
+
*
|
|
26
|
+
* ``origin`` tags an input asset's provenance (definition common file vs run
|
|
27
|
+
* reference vs upload) so the FE can group them; it is ``None`` on output
|
|
28
|
+
* assets.
|
|
24
29
|
* @export
|
|
25
30
|
* @interface WorkflowRunAsset
|
|
26
31
|
*/
|
|
@@ -61,6 +66,12 @@ export interface WorkflowRunAsset {
|
|
|
61
66
|
* @memberof WorkflowRunAsset
|
|
62
67
|
*/
|
|
63
68
|
approvalState: PathPartApprovalState;
|
|
69
|
+
/**
|
|
70
|
+
*
|
|
71
|
+
* @type {InputOrigin}
|
|
72
|
+
* @memberof WorkflowRunAsset
|
|
73
|
+
*/
|
|
74
|
+
origin?: InputOrigin;
|
|
64
75
|
}
|
|
65
76
|
export declare const WorkflowRunAssetPropertyValidationAttributesMap: {
|
|
66
77
|
[property: string]: {
|
|
@@ -20,6 +20,7 @@ exports.WorkflowRunAssetFromJSONTyped = WorkflowRunAssetFromJSONTyped;
|
|
|
20
20
|
exports.WorkflowRunAssetToJSON = WorkflowRunAssetToJSON;
|
|
21
21
|
exports.WorkflowRunAssetToJSONTyped = WorkflowRunAssetToJSONTyped;
|
|
22
22
|
const PartType_1 = require("./PartType");
|
|
23
|
+
const InputOrigin_1 = require("./InputOrigin");
|
|
23
24
|
const PathPartApprovalState_1 = require("./PathPartApprovalState");
|
|
24
25
|
exports.WorkflowRunAssetPropertyValidationAttributesMap = {};
|
|
25
26
|
/**
|
|
@@ -54,6 +55,7 @@ function WorkflowRunAssetFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
54
55
|
'partType': (0, PartType_1.PartTypeFromJSON)(json['part_type']),
|
|
55
56
|
'materializedPath': json['materialized_path'],
|
|
56
57
|
'approvalState': (0, PathPartApprovalState_1.PathPartApprovalStateFromJSON)(json['approval_state']),
|
|
58
|
+
'origin': json['origin'] == null ? undefined : (0, InputOrigin_1.InputOriginFromJSON)(json['origin']),
|
|
57
59
|
};
|
|
58
60
|
}
|
|
59
61
|
function WorkflowRunAssetToJSON(json) {
|
|
@@ -70,5 +72,6 @@ function WorkflowRunAssetToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
70
72
|
'part_type': (0, PartType_1.PartTypeToJSON)(value['partType']),
|
|
71
73
|
'materialized_path': value['materializedPath'],
|
|
72
74
|
'approval_state': (0, PathPartApprovalState_1.PathPartApprovalStateToJSON)(value['approvalState']),
|
|
75
|
+
'origin': (0, InputOrigin_1.InputOriginToJSON)(value['origin']),
|
|
73
76
|
};
|
|
74
77
|
}
|
package/docs/WorkflowRunAsset.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
|
|
2
2
|
# WorkflowRunAsset
|
|
3
3
|
|
|
4
|
-
One input or output file/reference of a run, actionable in one call. ``id`` is the PDO id (``path_part.metadata_obj_id``); ``path_part_id`` is the underlying path part (kept for approval-state / path-part lookups). Route on ``part_type`` to pick the API that takes ``id``: ``DOCUMENT`` → download_document / bulk-download (active version); ``DOCUMENT_VERSION`` → download_document_version (a version-pinned input, e.g. a cloned run\'s inputs); ``FOLDER`` / ``DATA_SOURCE`` / ``API_CONNECTION`` → list/query via that type\'s endpoint. Output assets are always ``DOCUMENT``.
|
|
4
|
+
One input or output file/reference of a run, actionable in one call. ``id`` is the PDO id (``path_part.metadata_obj_id``); ``path_part_id`` is the underlying path part (kept for approval-state / path-part lookups). Route on ``part_type`` to pick the API that takes ``id``: ``DOCUMENT`` → download_document / bulk-download (active version); ``DOCUMENT_VERSION`` → download_document_version (a version-pinned input, e.g. a cloned run\'s inputs); ``FOLDER`` / ``DATA_SOURCE`` / ``API_CONNECTION`` → list/query via that type\'s endpoint. Output assets are always ``DOCUMENT``. ``origin`` tags an input asset\'s provenance (definition common file vs run reference vs upload) so the FE can group them; it is ``None`` on output assets.
|
|
5
5
|
|
|
6
6
|
## Properties
|
|
7
7
|
|
|
@@ -13,6 +13,7 @@ Name | Type
|
|
|
13
13
|
`partType` | [PartType](PartType.md)
|
|
14
14
|
`materializedPath` | string
|
|
15
15
|
`approvalState` | [PathPartApprovalState](PathPartApprovalState.md)
|
|
16
|
+
`origin` | [InputOrigin](InputOrigin.md)
|
|
16
17
|
|
|
17
18
|
## Example
|
|
18
19
|
|
|
@@ -27,6 +28,7 @@ const example = {
|
|
|
27
28
|
"partType": null,
|
|
28
29
|
"materializedPath": null,
|
|
29
30
|
"approvalState": null,
|
|
31
|
+
"origin": null,
|
|
30
32
|
} satisfies WorkflowRunAsset
|
|
31
33
|
|
|
32
34
|
console.log(example)
|
package/package.json
CHANGED
|
@@ -20,6 +20,13 @@ import {
|
|
|
20
20
|
PartTypeToJSON,
|
|
21
21
|
PartTypeToJSONTyped,
|
|
22
22
|
} from './PartType';
|
|
23
|
+
import type { InputOrigin } from './InputOrigin';
|
|
24
|
+
import {
|
|
25
|
+
InputOriginFromJSON,
|
|
26
|
+
InputOriginFromJSONTyped,
|
|
27
|
+
InputOriginToJSON,
|
|
28
|
+
InputOriginToJSONTyped,
|
|
29
|
+
} from './InputOrigin';
|
|
23
30
|
import type { PathPartApprovalState } from './PathPartApprovalState';
|
|
24
31
|
import {
|
|
25
32
|
PathPartApprovalStateFromJSON,
|
|
@@ -38,6 +45,10 @@ import {
|
|
|
38
45
|
* download_document_version (a version-pinned input, e.g. a cloned run's
|
|
39
46
|
* inputs); ``FOLDER`` / ``DATA_SOURCE`` / ``API_CONNECTION`` → list/query via
|
|
40
47
|
* that type's endpoint. Output assets are always ``DOCUMENT``.
|
|
48
|
+
*
|
|
49
|
+
* ``origin`` tags an input asset's provenance (definition common file vs run
|
|
50
|
+
* reference vs upload) so the FE can group them; it is ``None`` on output
|
|
51
|
+
* assets.
|
|
41
52
|
* @export
|
|
42
53
|
* @interface WorkflowRunAsset
|
|
43
54
|
*/
|
|
@@ -78,6 +89,12 @@ export interface WorkflowRunAsset {
|
|
|
78
89
|
* @memberof WorkflowRunAsset
|
|
79
90
|
*/
|
|
80
91
|
approvalState: PathPartApprovalState;
|
|
92
|
+
/**
|
|
93
|
+
*
|
|
94
|
+
* @type {InputOrigin}
|
|
95
|
+
* @memberof WorkflowRunAsset
|
|
96
|
+
*/
|
|
97
|
+
origin?: InputOrigin;
|
|
81
98
|
}
|
|
82
99
|
|
|
83
100
|
|
|
@@ -128,6 +145,7 @@ export function WorkflowRunAssetFromJSONTyped(json: any, ignoreDiscriminator: bo
|
|
|
128
145
|
'partType': PartTypeFromJSON(json['part_type']),
|
|
129
146
|
'materializedPath': json['materialized_path'],
|
|
130
147
|
'approvalState': PathPartApprovalStateFromJSON(json['approval_state']),
|
|
148
|
+
'origin': json['origin'] == null ? undefined : InputOriginFromJSON(json['origin']),
|
|
131
149
|
};
|
|
132
150
|
}
|
|
133
151
|
|
|
@@ -148,6 +166,7 @@ export function WorkflowRunAssetToJSONTyped(value?: WorkflowRunAsset | null, ign
|
|
|
148
166
|
'part_type': PartTypeToJSON(value['partType']),
|
|
149
167
|
'materialized_path': value['materializedPath'],
|
|
150
168
|
'approval_state': PathPartApprovalStateToJSON(value['approvalState']),
|
|
169
|
+
'origin': InputOriginToJSON(value['origin']),
|
|
151
170
|
};
|
|
152
171
|
}
|
|
153
172
|
|