@knowledge-stack/ksapi 1.138.1 → 1.139.1

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 CHANGED
@@ -1,4 +1,4 @@
1
- # @knowledge-stack/ksapi@1.138.1
1
+ # @knowledge-stack/ksapi@1.139.1
2
2
 
3
3
  A TypeScript SDK client for the localhost API.
4
4
 
@@ -654,7 +654,7 @@ and is automatically generated by the
654
654
  [OpenAPI Generator](https://openapi-generator.tech) project:
655
655
 
656
656
  - API version: `0.1.0`
657
- - Package version: `1.138.1`
657
+ - Package version: `1.139.1`
658
658
  - Generator version: `7.21.0`
659
659
  - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
660
660
 
@@ -226,7 +226,7 @@ export interface SkillsApiInterface {
226
226
  */
227
227
  getSkillRequestOpts(requestParameters: GetSkillRequest): Promise<runtime.RequestOpts>;
228
228
  /**
229
- * Skill detail: SKILL.md, scripts, has_unpublished_changes, permissions.
229
+ * Skill detail: SKILL.md, script contents, has_unpublished_changes, perms.
230
230
  * @summary Get Skill Handler
231
231
  * @param {string} skillId
232
232
  * @param {*} [options] Override http request option.
@@ -235,7 +235,7 @@ export interface SkillsApiInterface {
235
235
  */
236
236
  getSkillRaw(requestParameters: GetSkillRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SkillResponse>>;
237
237
  /**
238
- * Skill detail: SKILL.md, scripts, has_unpublished_changes, permissions.
238
+ * Skill detail: SKILL.md, script contents, has_unpublished_changes, perms.
239
239
  * Get Skill Handler
240
240
  */
241
241
  getSkill(requestParameters: GetSkillRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SkillResponse>;
@@ -483,12 +483,12 @@ export declare class SkillsApi extends runtime.BaseAPI implements SkillsApiInter
483
483
  */
484
484
  getSkillRequestOpts(requestParameters: GetSkillRequest): Promise<runtime.RequestOpts>;
485
485
  /**
486
- * Skill detail: SKILL.md, scripts, has_unpublished_changes, permissions.
486
+ * Skill detail: SKILL.md, script contents, has_unpublished_changes, perms.
487
487
  * Get Skill Handler
488
488
  */
489
489
  getSkillRaw(requestParameters: GetSkillRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SkillResponse>>;
490
490
  /**
491
- * Skill detail: SKILL.md, scripts, has_unpublished_changes, permissions.
491
+ * Skill detail: SKILL.md, script contents, has_unpublished_changes, perms.
492
492
  * Get Skill Handler
493
493
  */
494
494
  getSkill(requestParameters: GetSkillRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SkillResponse>;
@@ -439,7 +439,7 @@ class SkillsApi extends runtime.BaseAPI {
439
439
  });
440
440
  }
441
441
  /**
442
- * Skill detail: SKILL.md, scripts, has_unpublished_changes, permissions.
442
+ * Skill detail: SKILL.md, script contents, has_unpublished_changes, perms.
443
443
  * Get Skill Handler
444
444
  */
445
445
  getSkillRaw(requestParameters, initOverrides) {
@@ -450,7 +450,7 @@ class SkillsApi extends runtime.BaseAPI {
450
450
  });
451
451
  }
452
452
  /**
453
- * Skill detail: SKILL.md, scripts, has_unpublished_changes, permissions.
453
+ * Skill detail: SKILL.md, script contents, has_unpublished_changes, perms.
454
454
  * Get Skill Handler
455
455
  */
456
456
  getSkill(requestParameters, initOverrides) {
@@ -226,7 +226,7 @@ export interface SkillsApiInterface {
226
226
  */
227
227
  getSkillRequestOpts(requestParameters: GetSkillRequest): Promise<runtime.RequestOpts>;
228
228
  /**
229
- * Skill detail: SKILL.md, scripts, has_unpublished_changes, permissions.
229
+ * Skill detail: SKILL.md, script contents, has_unpublished_changes, perms.
230
230
  * @summary Get Skill Handler
231
231
  * @param {string} skillId
232
232
  * @param {*} [options] Override http request option.
@@ -235,7 +235,7 @@ export interface SkillsApiInterface {
235
235
  */
236
236
  getSkillRaw(requestParameters: GetSkillRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SkillResponse>>;
237
237
  /**
238
- * Skill detail: SKILL.md, scripts, has_unpublished_changes, permissions.
238
+ * Skill detail: SKILL.md, script contents, has_unpublished_changes, perms.
239
239
  * Get Skill Handler
240
240
  */
241
241
  getSkill(requestParameters: GetSkillRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SkillResponse>;
@@ -483,12 +483,12 @@ export declare class SkillsApi extends runtime.BaseAPI implements SkillsApiInter
483
483
  */
484
484
  getSkillRequestOpts(requestParameters: GetSkillRequest): Promise<runtime.RequestOpts>;
485
485
  /**
486
- * Skill detail: SKILL.md, scripts, has_unpublished_changes, permissions.
486
+ * Skill detail: SKILL.md, script contents, has_unpublished_changes, perms.
487
487
  * Get Skill Handler
488
488
  */
489
489
  getSkillRaw(requestParameters: GetSkillRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SkillResponse>>;
490
490
  /**
491
- * Skill detail: SKILL.md, scripts, has_unpublished_changes, permissions.
491
+ * Skill detail: SKILL.md, script contents, has_unpublished_changes, perms.
492
492
  * Get Skill Handler
493
493
  */
494
494
  getSkill(requestParameters: GetSkillRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SkillResponse>;
@@ -403,7 +403,7 @@ export class SkillsApi extends runtime.BaseAPI {
403
403
  });
404
404
  }
405
405
  /**
406
- * Skill detail: SKILL.md, scripts, has_unpublished_changes, permissions.
406
+ * Skill detail: SKILL.md, script contents, has_unpublished_changes, perms.
407
407
  * Get Skill Handler
408
408
  */
409
409
  getSkillRaw(requestParameters, initOverrides) {
@@ -414,7 +414,7 @@ export class SkillsApi extends runtime.BaseAPI {
414
414
  });
415
415
  }
416
416
  /**
417
- * Skill detail: SKILL.md, scripts, has_unpublished_changes, permissions.
417
+ * Skill detail: SKILL.md, script contents, has_unpublished_changes, perms.
418
418
  * Get Skill Handler
419
419
  */
420
420
  getSkill(requestParameters, initOverrides) {
@@ -10,6 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import type { ItemPermissions } from './ItemPermissions';
13
+ import type { SkillScriptFile } from './SkillScriptFile';
13
14
  import type { PathPartApprovalState } from './PathPartApprovalState';
14
15
  import type { UserInfo } from './UserInfo';
15
16
  /**
@@ -67,17 +68,23 @@ export interface SkillResponse {
67
68
  */
68
69
  description: string;
69
70
  /**
70
- * Full SKILL.md content; populated on detail reads, null on list.
71
+ * Full SKILL.md content; populated on the detail read and on mutation responses, null on list.
71
72
  * @type {string}
72
73
  * @memberof SkillResponse
73
74
  */
74
75
  skillMd?: string | null;
75
76
  /**
76
- * Bundled script file names; populated on detail reads.
77
+ * Bundled script file names; populated on the detail read and on mutation responses, empty on list.
77
78
  * @type {Array<string>}
78
79
  * @memberof SkillResponse
79
80
  */
80
81
  scriptNames?: Array<string>;
82
+ /**
83
+ * Bundled scripts with their contents; populated only on the detail read (GET /skills/{id}), null on list. Lets the editor read the current script set so a PATCH can safely resubmit the whole set.
84
+ * @type {Array<SkillScriptFile>}
85
+ * @memberof SkillResponse
86
+ */
87
+ scripts?: Array<SkillScriptFile> | null;
81
88
  /**
82
89
  * Whether the working copy differs from the active published version. Always present (incl. list responses) so the UI can flag a skill with an unpublished draft.
83
90
  * @type {boolean}
@@ -109,7 +116,7 @@ export interface SkillResponse {
109
116
  */
110
117
  updatedAt: Date;
111
118
  /**
112
- * Caller's effective rights; null on mutation responses.
119
+ * Caller's effective rights; populated on the list, detail read, and mutation responses.
113
120
  * @type {ItemPermissions}
114
121
  * @memberof SkillResponse
115
122
  */
@@ -12,6 +12,7 @@
12
12
  * Do not edit the class manually.
13
13
  */
14
14
  import { ItemPermissionsFromJSON, ItemPermissionsToJSON, } from './ItemPermissions';
15
+ import { SkillScriptFileFromJSON, SkillScriptFileToJSON, } from './SkillScriptFile';
15
16
  import { PathPartApprovalStateFromJSON, PathPartApprovalStateToJSON, } from './PathPartApprovalState';
16
17
  import { UserInfoFromJSON, UserInfoToJSON, } from './UserInfo';
17
18
  /**
@@ -65,6 +66,7 @@ export function SkillResponseFromJSONTyped(json, ignoreDiscriminator) {
65
66
  'description': json['description'],
66
67
  'skillMd': json['skill_md'] == null ? undefined : json['skill_md'],
67
68
  'scriptNames': json['script_names'] == null ? undefined : json['script_names'],
69
+ 'scripts': json['scripts'] == null ? undefined : (json['scripts'].map(SkillScriptFileFromJSON)),
68
70
  'hasUnpublishedChanges': json['has_unpublished_changes'] == null ? undefined : json['has_unpublished_changes'],
69
71
  'approvalState': PathPartApprovalStateFromJSON(json['approval_state']),
70
72
  'owner': json['owner'] == null ? undefined : UserInfoFromJSON(json['owner']),
@@ -91,6 +93,7 @@ export function SkillResponseToJSONTyped(value, ignoreDiscriminator = false) {
91
93
  'description': value['description'],
92
94
  'skill_md': value['skillMd'],
93
95
  'script_names': value['scriptNames'],
96
+ 'scripts': value['scripts'] == null ? undefined : (value['scripts'].map(SkillScriptFileToJSON)),
94
97
  'has_unpublished_changes': value['hasUnpublishedChanges'],
95
98
  'approval_state': PathPartApprovalStateToJSON(value['approvalState']),
96
99
  'owner': UserInfoToJSON(value['owner']),
@@ -10,6 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import type { ItemPermissions } from './ItemPermissions';
13
+ import type { SkillScriptFile } from './SkillScriptFile';
13
14
  import type { PathPartApprovalState } from './PathPartApprovalState';
14
15
  import type { UserInfo } from './UserInfo';
15
16
  /**
@@ -67,17 +68,23 @@ export interface SkillResponse {
67
68
  */
68
69
  description: string;
69
70
  /**
70
- * Full SKILL.md content; populated on detail reads, null on list.
71
+ * Full SKILL.md content; populated on the detail read and on mutation responses, null on list.
71
72
  * @type {string}
72
73
  * @memberof SkillResponse
73
74
  */
74
75
  skillMd?: string | null;
75
76
  /**
76
- * Bundled script file names; populated on detail reads.
77
+ * Bundled script file names; populated on the detail read and on mutation responses, empty on list.
77
78
  * @type {Array<string>}
78
79
  * @memberof SkillResponse
79
80
  */
80
81
  scriptNames?: Array<string>;
82
+ /**
83
+ * Bundled scripts with their contents; populated only on the detail read (GET /skills/{id}), null on list. Lets the editor read the current script set so a PATCH can safely resubmit the whole set.
84
+ * @type {Array<SkillScriptFile>}
85
+ * @memberof SkillResponse
86
+ */
87
+ scripts?: Array<SkillScriptFile> | null;
81
88
  /**
82
89
  * Whether the working copy differs from the active published version. Always present (incl. list responses) so the UI can flag a skill with an unpublished draft.
83
90
  * @type {boolean}
@@ -109,7 +116,7 @@ export interface SkillResponse {
109
116
  */
110
117
  updatedAt: Date;
111
118
  /**
112
- * Caller's effective rights; null on mutation responses.
119
+ * Caller's effective rights; populated on the list, detail read, and mutation responses.
113
120
  * @type {ItemPermissions}
114
121
  * @memberof SkillResponse
115
122
  */
@@ -20,6 +20,7 @@ exports.SkillResponseFromJSONTyped = SkillResponseFromJSONTyped;
20
20
  exports.SkillResponseToJSON = SkillResponseToJSON;
21
21
  exports.SkillResponseToJSONTyped = SkillResponseToJSONTyped;
22
22
  const ItemPermissions_1 = require("./ItemPermissions");
23
+ const SkillScriptFile_1 = require("./SkillScriptFile");
23
24
  const PathPartApprovalState_1 = require("./PathPartApprovalState");
24
25
  const UserInfo_1 = require("./UserInfo");
25
26
  /**
@@ -73,6 +74,7 @@ function SkillResponseFromJSONTyped(json, ignoreDiscriminator) {
73
74
  'description': json['description'],
74
75
  'skillMd': json['skill_md'] == null ? undefined : json['skill_md'],
75
76
  'scriptNames': json['script_names'] == null ? undefined : json['script_names'],
77
+ 'scripts': json['scripts'] == null ? undefined : (json['scripts'].map(SkillScriptFile_1.SkillScriptFileFromJSON)),
76
78
  'hasUnpublishedChanges': json['has_unpublished_changes'] == null ? undefined : json['has_unpublished_changes'],
77
79
  'approvalState': (0, PathPartApprovalState_1.PathPartApprovalStateFromJSON)(json['approval_state']),
78
80
  'owner': json['owner'] == null ? undefined : (0, UserInfo_1.UserInfoFromJSON)(json['owner']),
@@ -99,6 +101,7 @@ function SkillResponseToJSONTyped(value, ignoreDiscriminator = false) {
99
101
  'description': value['description'],
100
102
  'skill_md': value['skillMd'],
101
103
  'script_names': value['scriptNames'],
104
+ 'scripts': value['scripts'] == null ? undefined : (value['scripts'].map(SkillScriptFile_1.SkillScriptFileToJSON)),
102
105
  'has_unpublished_changes': value['hasUnpublishedChanges'],
103
106
  'approval_state': (0, PathPartApprovalState_1.PathPartApprovalStateToJSON)(value['approvalState']),
104
107
  'owner': (0, UserInfo_1.UserInfoToJSON)(value['owner']),
@@ -66,6 +66,7 @@ Name | Type
66
66
  `disclaimerAcceptedBy` | string
67
67
  `skillMd` | string
68
68
  `scriptNames` | Array&lt;string&gt;
69
+ `scripts` | [Array&lt;SkillScriptFile&gt;](SkillScriptFile.md)
69
70
  `hasUnpublishedChanges` | boolean
70
71
 
71
72
  ## Example
@@ -135,6 +136,7 @@ const example = {
135
136
  "disclaimerAcceptedBy": null,
136
137
  "skillMd": null,
137
138
  "scriptNames": null,
139
+ "scripts": null,
138
140
  "hasUnpublishedChanges": null,
139
141
  } satisfies FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaR
140
142
 
@@ -17,6 +17,7 @@ Name | Type
17
17
  `description` | string
18
18
  `skillMd` | string
19
19
  `scriptNames` | Array&lt;string&gt;
20
+ `scripts` | [Array&lt;SkillScriptFile&gt;](SkillScriptFile.md)
20
21
  `hasUnpublishedChanges` | boolean
21
22
  `approvalState` | [PathPartApprovalState](PathPartApprovalState.md)
22
23
  `owner` | [UserInfo](UserInfo.md)
@@ -41,6 +42,7 @@ const example = {
41
42
  "description": null,
42
43
  "skillMd": null,
43
44
  "scriptNames": null,
45
+ "scripts": null,
44
46
  "hasUnpublishedChanges": null,
45
47
  "approvalState": null,
46
48
  "owner": null,
package/docs/SkillsApi.md CHANGED
@@ -558,7 +558,7 @@ example().catch(console.error);
558
558
 
559
559
  Get Skill Handler
560
560
 
561
- Skill detail: SKILL.md, scripts, has_unpublished_changes, permissions.
561
+ Skill detail: SKILL.md, script contents, has_unpublished_changes, perms.
562
562
 
563
563
  ### Example
564
564
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@knowledge-stack/ksapi",
3
- "version": "1.138.1",
3
+ "version": "1.139.1",
4
4
  "description": "OpenAPI client for @knowledge-stack/ksapi",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
@@ -306,7 +306,7 @@ export interface SkillsApiInterface {
306
306
  getSkillRequestOpts(requestParameters: GetSkillRequest): Promise<runtime.RequestOpts>;
307
307
 
308
308
  /**
309
- * Skill detail: SKILL.md, scripts, has_unpublished_changes, permissions.
309
+ * Skill detail: SKILL.md, script contents, has_unpublished_changes, perms.
310
310
  * @summary Get Skill Handler
311
311
  * @param {string} skillId
312
312
  * @param {*} [options] Override http request option.
@@ -316,7 +316,7 @@ export interface SkillsApiInterface {
316
316
  getSkillRaw(requestParameters: GetSkillRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SkillResponse>>;
317
317
 
318
318
  /**
319
- * Skill detail: SKILL.md, scripts, has_unpublished_changes, permissions.
319
+ * Skill detail: SKILL.md, script contents, has_unpublished_changes, perms.
320
320
  * Get Skill Handler
321
321
  */
322
322
  getSkill(requestParameters: GetSkillRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SkillResponse>;
@@ -925,7 +925,7 @@ export class SkillsApi extends runtime.BaseAPI implements SkillsApiInterface {
925
925
  }
926
926
 
927
927
  /**
928
- * Skill detail: SKILL.md, scripts, has_unpublished_changes, permissions.
928
+ * Skill detail: SKILL.md, script contents, has_unpublished_changes, perms.
929
929
  * Get Skill Handler
930
930
  */
931
931
  async getSkillRaw(requestParameters: GetSkillRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SkillResponse>> {
@@ -936,7 +936,7 @@ export class SkillsApi extends runtime.BaseAPI implements SkillsApiInterface {
936
936
  }
937
937
 
938
938
  /**
939
- * Skill detail: SKILL.md, scripts, has_unpublished_changes, permissions.
939
+ * Skill detail: SKILL.md, script contents, has_unpublished_changes, perms.
940
940
  * Get Skill Handler
941
941
  */
942
942
  async getSkill(requestParameters: GetSkillRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SkillResponse> {
@@ -20,6 +20,13 @@ import {
20
20
  ItemPermissionsToJSON,
21
21
  ItemPermissionsToJSONTyped,
22
22
  } from './ItemPermissions';
23
+ import type { SkillScriptFile } from './SkillScriptFile';
24
+ import {
25
+ SkillScriptFileFromJSON,
26
+ SkillScriptFileFromJSONTyped,
27
+ SkillScriptFileToJSON,
28
+ SkillScriptFileToJSONTyped,
29
+ } from './SkillScriptFile';
23
30
  import type { PathPartApprovalState } from './PathPartApprovalState';
24
31
  import {
25
32
  PathPartApprovalStateFromJSON,
@@ -90,17 +97,23 @@ export interface SkillResponse {
90
97
  */
91
98
  description: string;
92
99
  /**
93
- * Full SKILL.md content; populated on detail reads, null on list.
100
+ * Full SKILL.md content; populated on the detail read and on mutation responses, null on list.
94
101
  * @type {string}
95
102
  * @memberof SkillResponse
96
103
  */
97
104
  skillMd?: string | null;
98
105
  /**
99
- * Bundled script file names; populated on detail reads.
106
+ * Bundled script file names; populated on the detail read and on mutation responses, empty on list.
100
107
  * @type {Array<string>}
101
108
  * @memberof SkillResponse
102
109
  */
103
110
  scriptNames?: Array<string>;
111
+ /**
112
+ * Bundled scripts with their contents; populated only on the detail read (GET /skills/{id}), null on list. Lets the editor read the current script set so a PATCH can safely resubmit the whole set.
113
+ * @type {Array<SkillScriptFile>}
114
+ * @memberof SkillResponse
115
+ */
116
+ scripts?: Array<SkillScriptFile> | null;
104
117
  /**
105
118
  * Whether the working copy differs from the active published version. Always present (incl. list responses) so the UI can flag a skill with an unpublished draft.
106
119
  * @type {boolean}
@@ -132,7 +145,7 @@ export interface SkillResponse {
132
145
  */
133
146
  updatedAt: Date;
134
147
  /**
135
- * Caller's effective rights; null on mutation responses.
148
+ * Caller's effective rights; populated on the list, detail read, and mutation responses.
136
149
  * @type {ItemPermissions}
137
150
  * @memberof SkillResponse
138
151
  */
@@ -203,6 +216,7 @@ export function SkillResponseFromJSONTyped(json: any, ignoreDiscriminator: boole
203
216
  'description': json['description'],
204
217
  'skillMd': json['skill_md'] == null ? undefined : json['skill_md'],
205
218
  'scriptNames': json['script_names'] == null ? undefined : json['script_names'],
219
+ 'scripts': json['scripts'] == null ? undefined : ((json['scripts'] as Array<any>).map(SkillScriptFileFromJSON)),
206
220
  'hasUnpublishedChanges': json['has_unpublished_changes'] == null ? undefined : json['has_unpublished_changes'],
207
221
  'approvalState': PathPartApprovalStateFromJSON(json['approval_state']),
208
222
  'owner': json['owner'] == null ? undefined : UserInfoFromJSON(json['owner']),
@@ -233,6 +247,7 @@ export function SkillResponseToJSONTyped(value?: SkillResponse | null, ignoreDis
233
247
  'description': value['description'],
234
248
  'skill_md': value['skillMd'],
235
249
  'script_names': value['scriptNames'],
250
+ 'scripts': value['scripts'] == null ? undefined : ((value['scripts'] as Array<any>).map(SkillScriptFileToJSON)),
236
251
  'has_unpublished_changes': value['hasUnpublishedChanges'],
237
252
  'approval_state': PathPartApprovalStateToJSON(value['approvalState']),
238
253
  'owner': UserInfoToJSON(value['owner']),