@knowledge-stack/ksapi 1.143.0 → 1.145.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/.openapi-generator/FILES +6 -2
- package/README.md +6 -3
- package/dist/apis/PathPartsApi.d.ts +42 -1
- package/dist/apis/PathPartsApi.js +53 -0
- package/dist/apis/SkillsApi.d.ts +11 -8
- package/dist/apis/SkillsApi.js +7 -4
- package/dist/esm/apis/PathPartsApi.d.ts +42 -1
- package/dist/esm/apis/PathPartsApi.js +54 -1
- package/dist/esm/apis/SkillsApi.d.ts +11 -8
- package/dist/esm/apis/SkillsApi.js +7 -4
- package/dist/esm/models/CreateSkillRequest.d.ts +4 -4
- package/dist/esm/models/CreateSkillRequest.js +5 -5
- package/dist/esm/models/EventResponse.d.ts +35 -1
- package/dist/esm/models/EventResponse.js +12 -0
- package/dist/esm/models/{SkillScriptFile.d.ts → ReorderPathPartRequest.d.ts} +17 -17
- package/dist/esm/models/ReorderPathPartRequest.js +44 -0
- package/dist/esm/models/ResolvedRef.d.ts +79 -0
- package/dist/esm/models/ResolvedRef.js +59 -0
- package/dist/esm/models/SkillFile.d.ts +71 -0
- package/dist/esm/models/{SkillScriptFile.js → SkillFile.js} +23 -14
- package/dist/esm/models/SkillResponse.d.ts +6 -6
- package/dist/esm/models/SkillResponse.js +5 -5
- package/dist/esm/models/UpdateSkillRequest.d.ts +4 -4
- package/dist/esm/models/UpdateSkillRequest.js +5 -5
- package/dist/esm/models/index.d.ts +3 -1
- package/dist/esm/models/index.js +3 -1
- package/dist/models/CreateSkillRequest.d.ts +4 -4
- package/dist/models/CreateSkillRequest.js +5 -5
- package/dist/models/EventResponse.d.ts +35 -1
- package/dist/models/EventResponse.js +12 -0
- package/dist/models/{SkillScriptFile.d.ts → ReorderPathPartRequest.d.ts} +17 -17
- package/dist/models/ReorderPathPartRequest.js +52 -0
- package/dist/models/ResolvedRef.d.ts +79 -0
- package/dist/models/ResolvedRef.js +67 -0
- package/dist/models/SkillFile.d.ts +71 -0
- package/dist/models/{SkillScriptFile.js → SkillFile.js} +29 -20
- package/dist/models/SkillResponse.d.ts +6 -6
- package/dist/models/SkillResponse.js +5 -5
- package/dist/models/UpdateSkillRequest.d.ts +4 -4
- package/dist/models/UpdateSkillRequest.js +5 -5
- package/dist/models/index.d.ts +3 -1
- package/dist/models/index.js +3 -1
- package/docs/CreateSkillRequest.md +2 -2
- package/docs/EventResponse.md +11 -1
- package/docs/FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaR.md +4 -4
- package/docs/PathPartsApi.md +79 -0
- package/docs/{SkillScriptFile.md → ReorderPathPartRequest.md} +9 -9
- package/docs/ResolvedRef.md +41 -0
- package/docs/SkillFile.md +39 -0
- package/docs/SkillResponse.md +4 -4
- package/docs/SkillsApi.md +6 -3
- package/docs/UpdateSkillRequest.md +2 -2
- package/package.json +1 -1
- package/src/apis/PathPartsApi.ts +99 -0
- package/src/apis/SkillsApi.ts +15 -8
- package/src/models/CreateSkillRequest.ts +13 -13
- package/src/models/EventResponse.ts +49 -1
- package/src/models/{SkillScriptFile.ts → ReorderPathPartRequest.ts} +23 -28
- package/src/models/ResolvedRef.ts +125 -0
- package/src/models/SkillFile.ts +118 -0
- package/src/models/SkillResponse.ts +15 -15
- package/src/models/UpdateSkillRequest.ts +13 -13
- package/src/models/index.ts +3 -1
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import type {
|
|
12
|
+
import type { SkillFile } from './SkillFile';
|
|
13
13
|
/**
|
|
14
14
|
* Edit working-copy files in place (does NOT cut a version).
|
|
15
15
|
* @export
|
|
@@ -23,11 +23,11 @@ export interface UpdateSkillRequest {
|
|
|
23
23
|
*/
|
|
24
24
|
skillMd?: string | null;
|
|
25
25
|
/**
|
|
26
|
-
* Replace the
|
|
27
|
-
* @type {Array<
|
|
26
|
+
* Replace the whole bundle below SKILL.md (add/overwrite/remove to match); null leaves the tree unchanged, [] removes every file.
|
|
27
|
+
* @type {Array<SkillFile>}
|
|
28
28
|
* @memberof UpdateSkillRequest
|
|
29
29
|
*/
|
|
30
|
-
|
|
30
|
+
files?: Array<SkillFile> | null;
|
|
31
31
|
}
|
|
32
32
|
export declare const UpdateSkillRequestPropertyValidationAttributesMap: {
|
|
33
33
|
[property: string]: {
|
|
@@ -19,10 +19,10 @@ exports.UpdateSkillRequestFromJSON = UpdateSkillRequestFromJSON;
|
|
|
19
19
|
exports.UpdateSkillRequestFromJSONTyped = UpdateSkillRequestFromJSONTyped;
|
|
20
20
|
exports.UpdateSkillRequestToJSON = UpdateSkillRequestToJSON;
|
|
21
21
|
exports.UpdateSkillRequestToJSONTyped = UpdateSkillRequestToJSONTyped;
|
|
22
|
-
const
|
|
22
|
+
const SkillFile_1 = require("./SkillFile");
|
|
23
23
|
exports.UpdateSkillRequestPropertyValidationAttributesMap = {
|
|
24
|
-
|
|
25
|
-
maxItems:
|
|
24
|
+
files: {
|
|
25
|
+
maxItems: 2000,
|
|
26
26
|
uniqueItems: false,
|
|
27
27
|
},
|
|
28
28
|
};
|
|
@@ -41,7 +41,7 @@ function UpdateSkillRequestFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
41
41
|
}
|
|
42
42
|
return {
|
|
43
43
|
'skillMd': json['skill_md'] == null ? undefined : json['skill_md'],
|
|
44
|
-
'
|
|
44
|
+
'files': json['files'] == null ? undefined : (json['files'].map(SkillFile_1.SkillFileFromJSON)),
|
|
45
45
|
};
|
|
46
46
|
}
|
|
47
47
|
function UpdateSkillRequestToJSON(json) {
|
|
@@ -53,6 +53,6 @@ function UpdateSkillRequestToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
53
53
|
}
|
|
54
54
|
return {
|
|
55
55
|
'skill_md': value['skillMd'],
|
|
56
|
-
'
|
|
56
|
+
'files': value['files'] == null ? undefined : (value['files'].map(SkillFile_1.SkillFileToJSON)),
|
|
57
57
|
};
|
|
58
58
|
}
|
package/dist/models/index.d.ts
CHANGED
|
@@ -225,7 +225,9 @@ export * from './ProposeMemoryChunkRequest';
|
|
|
225
225
|
export * from './ProposedMemoryChunkResponse';
|
|
226
226
|
export * from './ReasoningPart';
|
|
227
227
|
export * from './ReferenceType';
|
|
228
|
+
export * from './ReorderPathPartRequest';
|
|
228
229
|
export * from './RequestPhoneChangeRequest';
|
|
230
|
+
export * from './ResolvedRef';
|
|
229
231
|
export * from './ResolvedReferenceInput';
|
|
230
232
|
export * from './ResolvedReferenceOutput';
|
|
231
233
|
export * from './ResponseSendPwResetEmail';
|
|
@@ -253,9 +255,9 @@ export * from './SetApprovalStateRequest';
|
|
|
253
255
|
export * from './SetWorkflowRunApprovalRequest';
|
|
254
256
|
export * from './SheetVisibilityChange';
|
|
255
257
|
export * from './SignInRequest';
|
|
258
|
+
export * from './SkillFile';
|
|
256
259
|
export * from './SkillOrder';
|
|
257
260
|
export * from './SkillResponse';
|
|
258
|
-
export * from './SkillScriptFile';
|
|
259
261
|
export * from './SkillSearchResult';
|
|
260
262
|
export * from './SkillVersionResponse';
|
|
261
263
|
export * from './SortDirection';
|
package/dist/models/index.js
CHANGED
|
@@ -243,7 +243,9 @@ __exportStar(require("./ProposeMemoryChunkRequest"), exports);
|
|
|
243
243
|
__exportStar(require("./ProposedMemoryChunkResponse"), exports);
|
|
244
244
|
__exportStar(require("./ReasoningPart"), exports);
|
|
245
245
|
__exportStar(require("./ReferenceType"), exports);
|
|
246
|
+
__exportStar(require("./ReorderPathPartRequest"), exports);
|
|
246
247
|
__exportStar(require("./RequestPhoneChangeRequest"), exports);
|
|
248
|
+
__exportStar(require("./ResolvedRef"), exports);
|
|
247
249
|
__exportStar(require("./ResolvedReferenceInput"), exports);
|
|
248
250
|
__exportStar(require("./ResolvedReferenceOutput"), exports);
|
|
249
251
|
__exportStar(require("./ResponseSendPwResetEmail"), exports);
|
|
@@ -271,9 +273,9 @@ __exportStar(require("./SetApprovalStateRequest"), exports);
|
|
|
271
273
|
__exportStar(require("./SetWorkflowRunApprovalRequest"), exports);
|
|
272
274
|
__exportStar(require("./SheetVisibilityChange"), exports);
|
|
273
275
|
__exportStar(require("./SignInRequest"), exports);
|
|
276
|
+
__exportStar(require("./SkillFile"), exports);
|
|
274
277
|
__exportStar(require("./SkillOrder"), exports);
|
|
275
278
|
__exportStar(require("./SkillResponse"), exports);
|
|
276
|
-
__exportStar(require("./SkillScriptFile"), exports);
|
|
277
279
|
__exportStar(require("./SkillSearchResult"), exports);
|
|
278
280
|
__exportStar(require("./SkillVersionResponse"), exports);
|
|
279
281
|
__exportStar(require("./SortDirection"), exports);
|
|
@@ -9,7 +9,7 @@ Name | Type
|
|
|
9
9
|
------------ | -------------
|
|
10
10
|
`name` | string
|
|
11
11
|
`skillMd` | string
|
|
12
|
-
`
|
|
12
|
+
`files` | [Array<SkillFile>](SkillFile.md)
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
@@ -20,7 +20,7 @@ import type { CreateSkillRequest } from '@knowledge-stack/ksapi'
|
|
|
20
20
|
const example = {
|
|
21
21
|
"name": null,
|
|
22
22
|
"skillMd": null,
|
|
23
|
-
"
|
|
23
|
+
"files": null,
|
|
24
24
|
} satisfies CreateSkillRequest
|
|
25
25
|
|
|
26
26
|
console.log(example)
|
package/docs/EventResponse.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
|
|
2
2
|
# EventResponse
|
|
3
3
|
|
|
4
|
-
One event row, anchored to a path_part subject. ``kind`` is namespaced ``domain.action`` (e.g. ``workflow.approval``, ``document.created``). ``payload`` is the domain-specific structured JSON associated with the event
|
|
4
|
+
One event row, anchored to a path_part subject. ``kind`` is namespaced ``domain.action`` (e.g. ``workflow.approval``, ``document.created``). ``payload`` is the domain-specific structured JSON associated with the event, stored verbatim and never rewritten — the human-readable resolution lives alongside it in ``references``.
|
|
5
5
|
|
|
6
6
|
## Properties
|
|
7
7
|
|
|
@@ -14,6 +14,11 @@ Name | Type
|
|
|
14
14
|
`actorUserId` | string
|
|
15
15
|
`payload` | { [key: string]: any; }
|
|
16
16
|
`actor` | [UserInfo](UserInfo.md)
|
|
17
|
+
`subjectName` | string
|
|
18
|
+
`subjectPath` | string
|
|
19
|
+
`subjectObjectId` | string
|
|
20
|
+
`subjectPartType` | string
|
|
21
|
+
`references` | [{ [key: string]: ResolvedRef; }](ResolvedRef.md)
|
|
17
22
|
|
|
18
23
|
## Example
|
|
19
24
|
|
|
@@ -29,6 +34,11 @@ const example = {
|
|
|
29
34
|
"actorUserId": null,
|
|
30
35
|
"payload": null,
|
|
31
36
|
"actor": null,
|
|
37
|
+
"subjectName": null,
|
|
38
|
+
"subjectPath": null,
|
|
39
|
+
"subjectObjectId": null,
|
|
40
|
+
"subjectPartType": null,
|
|
41
|
+
"references": null,
|
|
32
42
|
} satisfies EventResponse
|
|
33
43
|
|
|
34
44
|
console.log(example)
|
|
@@ -65,8 +65,8 @@ Name | Type
|
|
|
65
65
|
`disclaimerAcceptedAt` | Date
|
|
66
66
|
`disclaimerAcceptedBy` | string
|
|
67
67
|
`skillMd` | string
|
|
68
|
-
`
|
|
69
|
-
`
|
|
68
|
+
`filePaths` | Array<string>
|
|
69
|
+
`files` | [Array<SkillFile>](SkillFile.md)
|
|
70
70
|
`hasUnpublishedChanges` | boolean
|
|
71
71
|
|
|
72
72
|
## Example
|
|
@@ -135,8 +135,8 @@ const example = {
|
|
|
135
135
|
"disclaimerAcceptedAt": null,
|
|
136
136
|
"disclaimerAcceptedBy": null,
|
|
137
137
|
"skillMd": null,
|
|
138
|
-
"
|
|
139
|
-
"
|
|
138
|
+
"filePaths": null,
|
|
139
|
+
"files": null,
|
|
140
140
|
"hasUnpublishedChanges": null,
|
|
141
141
|
} satisfies FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaR
|
|
142
142
|
|
package/docs/PathPartsApi.md
CHANGED
|
@@ -13,6 +13,7 @@ All URIs are relative to *http://localhost:8000*
|
|
|
13
13
|
| [**getPathPartTags**](PathPartsApi.md#getpathparttags) | **GET** /v1/path-parts/{path_part_id}/tags | Get Path Part Tags Handler |
|
|
14
14
|
| [**listPathPartEvents**](PathPartsApi.md#listpathpartevents) | **GET** /v1/path-parts/{path_part_id}/events | List Path Part Events Handler |
|
|
15
15
|
| [**listPathParts**](PathPartsApi.md#listpathparts) | **GET** /v1/path-parts | List Path Parts Handler |
|
|
16
|
+
| [**reorderPathPart**](PathPartsApi.md#reorderpathpartoperation) | **POST** /v1/path-parts/{path_part_id}/reorder | Reorder Path Part Handler |
|
|
16
17
|
| [**setPathPartTags**](PathPartsApi.md#setpathparttags) | **POST** /v1/path-parts/{path_part_id}/tags | Set Path Part Tags Handler |
|
|
17
18
|
| [**transferPathPartOwner**](PathPartsApi.md#transferpathpartowner) | **PUT** /v1/path-parts/{path_part_id}/owner | Transfer Path Part Owner Handler |
|
|
18
19
|
|
|
@@ -753,6 +754,84 @@ example().catch(console.error);
|
|
|
753
754
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
754
755
|
|
|
755
756
|
|
|
757
|
+
## reorderPathPart
|
|
758
|
+
|
|
759
|
+
> PathPartResponse reorderPathPart(pathPartId, reorderPathPartRequest)
|
|
760
|
+
|
|
761
|
+
Reorder Path Part Handler
|
|
762
|
+
|
|
763
|
+
Reorder a path part within its sibling list. The left-nav order follows the path_part sibling linked list: one per-parent chain shared by everyone in the tenant. Moving is confined to the node\'s current parent; use the folder/document move endpoints to change parents.
|
|
764
|
+
|
|
765
|
+
### Example
|
|
766
|
+
|
|
767
|
+
```ts
|
|
768
|
+
import {
|
|
769
|
+
Configuration,
|
|
770
|
+
PathPartsApi,
|
|
771
|
+
} from '@knowledge-stack/ksapi';
|
|
772
|
+
import type { ReorderPathPartOperationRequest } from '@knowledge-stack/ksapi';
|
|
773
|
+
|
|
774
|
+
async function example() {
|
|
775
|
+
console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
|
|
776
|
+
const config = new Configuration({
|
|
777
|
+
// To configure API key authorization: cookieAuth
|
|
778
|
+
apiKey: "YOUR API KEY",
|
|
779
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
780
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
781
|
+
});
|
|
782
|
+
const api = new PathPartsApi(config);
|
|
783
|
+
|
|
784
|
+
const body = {
|
|
785
|
+
// string
|
|
786
|
+
pathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
787
|
+
// ReorderPathPartRequest
|
|
788
|
+
reorderPathPartRequest: ...,
|
|
789
|
+
} satisfies ReorderPathPartOperationRequest;
|
|
790
|
+
|
|
791
|
+
try {
|
|
792
|
+
const data = await api.reorderPathPart(body);
|
|
793
|
+
console.log(data);
|
|
794
|
+
} catch (error) {
|
|
795
|
+
console.error(error);
|
|
796
|
+
}
|
|
797
|
+
}
|
|
798
|
+
|
|
799
|
+
// Run the test
|
|
800
|
+
example().catch(console.error);
|
|
801
|
+
```
|
|
802
|
+
|
|
803
|
+
### Parameters
|
|
804
|
+
|
|
805
|
+
|
|
806
|
+
| Name | Type | Description | Notes |
|
|
807
|
+
|------------- | ------------- | ------------- | -------------|
|
|
808
|
+
| **pathPartId** | `string` | | [Defaults to `undefined`] |
|
|
809
|
+
| **reorderPathPartRequest** | [ReorderPathPartRequest](ReorderPathPartRequest.md) | | |
|
|
810
|
+
|
|
811
|
+
### Return type
|
|
812
|
+
|
|
813
|
+
[**PathPartResponse**](PathPartResponse.md)
|
|
814
|
+
|
|
815
|
+
### Authorization
|
|
816
|
+
|
|
817
|
+
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
|
|
818
|
+
|
|
819
|
+
### HTTP request headers
|
|
820
|
+
|
|
821
|
+
- **Content-Type**: `application/json`
|
|
822
|
+
- **Accept**: `application/json`
|
|
823
|
+
|
|
824
|
+
|
|
825
|
+
### HTTP response details
|
|
826
|
+
| Status code | Description | Response headers |
|
|
827
|
+
|-------------|-------------|------------------|
|
|
828
|
+
| **200** | Successful Response | - |
|
|
829
|
+
| **422** | Validation Error | - |
|
|
830
|
+
| **0** | Error response. | - |
|
|
831
|
+
|
|
832
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
833
|
+
|
|
834
|
+
|
|
756
835
|
## setPathPartTags
|
|
757
836
|
|
|
758
837
|
> PathPartTagsResponse setPathPartTags(pathPartId, bulkTagRequest)
|
|
@@ -1,25 +1,25 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# ReorderPathPartRequest
|
|
3
3
|
|
|
4
|
-
|
|
4
|
+
Reorder a path part within its sibling list.
|
|
5
5
|
|
|
6
6
|
## Properties
|
|
7
7
|
|
|
8
8
|
Name | Type
|
|
9
9
|
------------ | -------------
|
|
10
|
-
`
|
|
11
|
-
`
|
|
10
|
+
`prevSiblingPathId` | string
|
|
11
|
+
`moveToHead` | boolean
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
15
15
|
```typescript
|
|
16
|
-
import type {
|
|
16
|
+
import type { ReorderPathPartRequest } from '@knowledge-stack/ksapi'
|
|
17
17
|
|
|
18
18
|
// TODO: Update the object below with actual values
|
|
19
19
|
const example = {
|
|
20
|
-
"
|
|
21
|
-
"
|
|
22
|
-
} satisfies
|
|
20
|
+
"prevSiblingPathId": null,
|
|
21
|
+
"moveToHead": null,
|
|
22
|
+
} satisfies ReorderPathPartRequest
|
|
23
23
|
|
|
24
24
|
console.log(example)
|
|
25
25
|
|
|
@@ -28,7 +28,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
28
28
|
console.log(exampleJSON)
|
|
29
29
|
|
|
30
30
|
// Parse the JSON string back to an object
|
|
31
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
31
|
+
const exampleParsed = JSON.parse(exampleJSON) as ReorderPathPartRequest
|
|
32
32
|
console.log(exampleParsed)
|
|
33
33
|
```
|
|
34
34
|
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
|
|
2
|
+
# ResolvedRef
|
|
3
|
+
|
|
4
|
+
One id resolved to a human-readable, linkable entity. Every UUID that appears in an event (its subject, its actor, and any id inside the payload) resolves to one of these so the frontend can render a name and a link instead of a bare UUID. ``object_id`` is what the frontend routes on: a PDO id for a path_part (never the internal path_part_id), or the user id for a user.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`entityType` | string
|
|
11
|
+
`objectId` | string
|
|
12
|
+
`displayName` | string
|
|
13
|
+
`partType` | string
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import type { ResolvedRef } from '@knowledge-stack/ksapi'
|
|
19
|
+
|
|
20
|
+
// TODO: Update the object below with actual values
|
|
21
|
+
const example = {
|
|
22
|
+
"entityType": null,
|
|
23
|
+
"objectId": null,
|
|
24
|
+
"displayName": null,
|
|
25
|
+
"partType": null,
|
|
26
|
+
} satisfies ResolvedRef
|
|
27
|
+
|
|
28
|
+
console.log(example)
|
|
29
|
+
|
|
30
|
+
// Convert the instance to a JSON string
|
|
31
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
32
|
+
console.log(exampleJSON)
|
|
33
|
+
|
|
34
|
+
// Parse the JSON string back to an object
|
|
35
|
+
const exampleParsed = JSON.parse(exampleJSON) as ResolvedRef
|
|
36
|
+
console.log(exampleParsed)
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
40
|
+
|
|
41
|
+
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
|
|
2
|
+
# SkillFile
|
|
3
|
+
|
|
4
|
+
One file in a skill bundle, at a path relative to the skill root. Skills carry arbitrary trees (``scripts/office/validate.py``, ``references/guide.md``, ``assets/logo.png``), so binary files are carried base64-encoded rather than excluded.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`path` | string
|
|
11
|
+
`content` | string
|
|
12
|
+
`encoding` | string
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import type { SkillFile } from '@knowledge-stack/ksapi'
|
|
18
|
+
|
|
19
|
+
// TODO: Update the object below with actual values
|
|
20
|
+
const example = {
|
|
21
|
+
"path": null,
|
|
22
|
+
"content": null,
|
|
23
|
+
"encoding": null,
|
|
24
|
+
} satisfies SkillFile
|
|
25
|
+
|
|
26
|
+
console.log(example)
|
|
27
|
+
|
|
28
|
+
// Convert the instance to a JSON string
|
|
29
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
30
|
+
console.log(exampleJSON)
|
|
31
|
+
|
|
32
|
+
// Parse the JSON string back to an object
|
|
33
|
+
const exampleParsed = JSON.parse(exampleJSON) as SkillFile
|
|
34
|
+
console.log(exampleParsed)
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
38
|
+
|
|
39
|
+
|
package/docs/SkillResponse.md
CHANGED
|
@@ -16,8 +16,8 @@ Name | Type
|
|
|
16
16
|
`name` | string
|
|
17
17
|
`description` | string
|
|
18
18
|
`skillMd` | string
|
|
19
|
-
`
|
|
20
|
-
`
|
|
19
|
+
`filePaths` | Array<string>
|
|
20
|
+
`files` | [Array<SkillFile>](SkillFile.md)
|
|
21
21
|
`hasUnpublishedChanges` | boolean
|
|
22
22
|
`approvalState` | [PathPartApprovalState](PathPartApprovalState.md)
|
|
23
23
|
`owner` | [UserInfo](UserInfo.md)
|
|
@@ -41,8 +41,8 @@ const example = {
|
|
|
41
41
|
"name": null,
|
|
42
42
|
"description": null,
|
|
43
43
|
"skillMd": null,
|
|
44
|
-
"
|
|
45
|
-
"
|
|
44
|
+
"filePaths": null,
|
|
45
|
+
"files": null,
|
|
46
46
|
"hasUnpublishedChanges": null,
|
|
47
47
|
"approvalState": null,
|
|
48
48
|
"owner": null,
|
package/docs/SkillsApi.md
CHANGED
|
@@ -554,11 +554,11 @@ example().catch(console.error);
|
|
|
554
554
|
|
|
555
555
|
## getSkill
|
|
556
556
|
|
|
557
|
-
> SkillResponse getSkill(skillId)
|
|
557
|
+
> SkillResponse getSkill(skillId, includeFileContents)
|
|
558
558
|
|
|
559
559
|
Get Skill Handler
|
|
560
560
|
|
|
561
|
-
Skill detail: SKILL.md,
|
|
561
|
+
Skill detail: SKILL.md, file paths (+ contents on request), perms.
|
|
562
562
|
|
|
563
563
|
### Example
|
|
564
564
|
|
|
@@ -582,6 +582,8 @@ async function example() {
|
|
|
582
582
|
const body = {
|
|
583
583
|
// string
|
|
584
584
|
skillId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
585
|
+
// boolean | Include every bundle file\'s contents (base64 for binary). Off by default — the editor opts in; a large skill\'s contents can be many MB and one S3 read per file. (optional)
|
|
586
|
+
includeFileContents: true,
|
|
585
587
|
} satisfies GetSkillRequest;
|
|
586
588
|
|
|
587
589
|
try {
|
|
@@ -602,6 +604,7 @@ example().catch(console.error);
|
|
|
602
604
|
| Name | Type | Description | Notes |
|
|
603
605
|
|------------- | ------------- | ------------- | -------------|
|
|
604
606
|
| **skillId** | `string` | | [Defaults to `undefined`] |
|
|
607
|
+
| **includeFileContents** | `boolean` | Include every bundle file\'s contents (base64 for binary). Off by default — the editor opts in; a large skill\'s contents can be many MB and one S3 read per file. | [Optional] [Defaults to `false`] |
|
|
605
608
|
|
|
606
609
|
### Return type
|
|
607
610
|
|
|
@@ -633,7 +636,7 @@ example().catch(console.error);
|
|
|
633
636
|
|
|
634
637
|
Import Skill Handler
|
|
635
638
|
|
|
636
|
-
Create a skill
|
|
639
|
+
Create a skill from an uploaded ZIP or tarball (works across tenants).
|
|
637
640
|
|
|
638
641
|
### Example
|
|
639
642
|
|
|
@@ -8,7 +8,7 @@ Edit working-copy files in place (does NOT cut a version).
|
|
|
8
8
|
Name | Type
|
|
9
9
|
------------ | -------------
|
|
10
10
|
`skillMd` | string
|
|
11
|
-
`
|
|
11
|
+
`files` | [Array<SkillFile>](SkillFile.md)
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -18,7 +18,7 @@ import type { UpdateSkillRequest } from '@knowledge-stack/ksapi'
|
|
|
18
18
|
// TODO: Update the object below with actual values
|
|
19
19
|
const example = {
|
|
20
20
|
"skillMd": null,
|
|
21
|
-
"
|
|
21
|
+
"files": null,
|
|
22
22
|
} satisfies UpdateSkillRequest
|
|
23
23
|
|
|
24
24
|
console.log(example)
|
package/package.json
CHANGED
package/src/apis/PathPartsApi.ts
CHANGED
|
@@ -28,6 +28,7 @@ import type {
|
|
|
28
28
|
PathPartResponse,
|
|
29
29
|
PathPartTagsResponse,
|
|
30
30
|
PermissionCapability,
|
|
31
|
+
ReorderPathPartRequest,
|
|
31
32
|
SortDirection,
|
|
32
33
|
SubtreeChunksResponse,
|
|
33
34
|
TransferOwnerRequest,
|
|
@@ -60,6 +61,8 @@ import {
|
|
|
60
61
|
PathPartTagsResponseToJSON,
|
|
61
62
|
PermissionCapabilityFromJSON,
|
|
62
63
|
PermissionCapabilityToJSON,
|
|
64
|
+
ReorderPathPartRequestFromJSON,
|
|
65
|
+
ReorderPathPartRequestToJSON,
|
|
63
66
|
SortDirectionFromJSON,
|
|
64
67
|
SortDirectionToJSON,
|
|
65
68
|
SubtreeChunksResponseFromJSON,
|
|
@@ -126,6 +129,11 @@ export interface ListPathPartsRequest {
|
|
|
126
129
|
updatedBefore?: Date | null;
|
|
127
130
|
}
|
|
128
131
|
|
|
132
|
+
export interface ReorderPathPartOperationRequest {
|
|
133
|
+
pathPartId: string;
|
|
134
|
+
reorderPathPartRequest: ReorderPathPartRequest;
|
|
135
|
+
}
|
|
136
|
+
|
|
129
137
|
export interface SetPathPartTagsRequest {
|
|
130
138
|
pathPartId: string;
|
|
131
139
|
bulkTagRequest: BulkTagRequest;
|
|
@@ -399,6 +407,32 @@ export interface PathPartsApiInterface {
|
|
|
399
407
|
*/
|
|
400
408
|
listPathParts(requestParameters: ListPathPartsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponsePathPartResponse>;
|
|
401
409
|
|
|
410
|
+
/**
|
|
411
|
+
* Creates request options for reorderPathPart without sending the request
|
|
412
|
+
* @param {string} pathPartId
|
|
413
|
+
* @param {ReorderPathPartRequest} reorderPathPartRequest
|
|
414
|
+
* @throws {RequiredError}
|
|
415
|
+
* @memberof PathPartsApiInterface
|
|
416
|
+
*/
|
|
417
|
+
reorderPathPartRequestOpts(requestParameters: ReorderPathPartOperationRequest): Promise<runtime.RequestOpts>;
|
|
418
|
+
|
|
419
|
+
/**
|
|
420
|
+
* Reorder a path part within its sibling list. The left-nav order follows the path_part sibling linked list: one per-parent chain shared by everyone in the tenant. Moving is confined to the node\'s current parent; use the folder/document move endpoints to change parents.
|
|
421
|
+
* @summary Reorder Path Part Handler
|
|
422
|
+
* @param {string} pathPartId
|
|
423
|
+
* @param {ReorderPathPartRequest} reorderPathPartRequest
|
|
424
|
+
* @param {*} [options] Override http request option.
|
|
425
|
+
* @throws {RequiredError}
|
|
426
|
+
* @memberof PathPartsApiInterface
|
|
427
|
+
*/
|
|
428
|
+
reorderPathPartRaw(requestParameters: ReorderPathPartOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PathPartResponse>>;
|
|
429
|
+
|
|
430
|
+
/**
|
|
431
|
+
* Reorder a path part within its sibling list. The left-nav order follows the path_part sibling linked list: one per-parent chain shared by everyone in the tenant. Moving is confined to the node\'s current parent; use the folder/document move endpoints to change parents.
|
|
432
|
+
* Reorder Path Part Handler
|
|
433
|
+
*/
|
|
434
|
+
reorderPathPart(requestParameters: ReorderPathPartOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PathPartResponse>;
|
|
435
|
+
|
|
402
436
|
/**
|
|
403
437
|
* Creates request options for setPathPartTags without sending the request
|
|
404
438
|
* @param {string} pathPartId
|
|
@@ -1048,6 +1082,71 @@ export class PathPartsApi extends runtime.BaseAPI implements PathPartsApiInterfa
|
|
|
1048
1082
|
return await response.value();
|
|
1049
1083
|
}
|
|
1050
1084
|
|
|
1085
|
+
/**
|
|
1086
|
+
* Creates request options for reorderPathPart without sending the request
|
|
1087
|
+
*/
|
|
1088
|
+
async reorderPathPartRequestOpts(requestParameters: ReorderPathPartOperationRequest): Promise<runtime.RequestOpts> {
|
|
1089
|
+
if (requestParameters['pathPartId'] == null) {
|
|
1090
|
+
throw new runtime.RequiredError(
|
|
1091
|
+
'pathPartId',
|
|
1092
|
+
'Required parameter "pathPartId" was null or undefined when calling reorderPathPart().'
|
|
1093
|
+
);
|
|
1094
|
+
}
|
|
1095
|
+
|
|
1096
|
+
if (requestParameters['reorderPathPartRequest'] == null) {
|
|
1097
|
+
throw new runtime.RequiredError(
|
|
1098
|
+
'reorderPathPartRequest',
|
|
1099
|
+
'Required parameter "reorderPathPartRequest" was null or undefined when calling reorderPathPart().'
|
|
1100
|
+
);
|
|
1101
|
+
}
|
|
1102
|
+
|
|
1103
|
+
const queryParameters: any = {};
|
|
1104
|
+
|
|
1105
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1106
|
+
|
|
1107
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
1108
|
+
|
|
1109
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
1110
|
+
const token = this.configuration.accessToken;
|
|
1111
|
+
const tokenString = await token("bearerAuth", []);
|
|
1112
|
+
|
|
1113
|
+
if (tokenString) {
|
|
1114
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
1115
|
+
}
|
|
1116
|
+
}
|
|
1117
|
+
|
|
1118
|
+
let urlPath = `/v1/path-parts/{path_part_id}/reorder`;
|
|
1119
|
+
urlPath = urlPath.replace(`{${"path_part_id"}}`, encodeURIComponent(String(requestParameters['pathPartId'])));
|
|
1120
|
+
|
|
1121
|
+
return {
|
|
1122
|
+
path: urlPath,
|
|
1123
|
+
method: 'POST',
|
|
1124
|
+
headers: headerParameters,
|
|
1125
|
+
query: queryParameters,
|
|
1126
|
+
body: ReorderPathPartRequestToJSON(requestParameters['reorderPathPartRequest']),
|
|
1127
|
+
};
|
|
1128
|
+
}
|
|
1129
|
+
|
|
1130
|
+
/**
|
|
1131
|
+
* Reorder a path part within its sibling list. The left-nav order follows the path_part sibling linked list: one per-parent chain shared by everyone in the tenant. Moving is confined to the node\'s current parent; use the folder/document move endpoints to change parents.
|
|
1132
|
+
* Reorder Path Part Handler
|
|
1133
|
+
*/
|
|
1134
|
+
async reorderPathPartRaw(requestParameters: ReorderPathPartOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PathPartResponse>> {
|
|
1135
|
+
const requestOptions = await this.reorderPathPartRequestOpts(requestParameters);
|
|
1136
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
1137
|
+
|
|
1138
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => PathPartResponseFromJSON(jsonValue));
|
|
1139
|
+
}
|
|
1140
|
+
|
|
1141
|
+
/**
|
|
1142
|
+
* Reorder a path part within its sibling list. The left-nav order follows the path_part sibling linked list: one per-parent chain shared by everyone in the tenant. Moving is confined to the node\'s current parent; use the folder/document move endpoints to change parents.
|
|
1143
|
+
* Reorder Path Part Handler
|
|
1144
|
+
*/
|
|
1145
|
+
async reorderPathPart(requestParameters: ReorderPathPartOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PathPartResponse> {
|
|
1146
|
+
const response = await this.reorderPathPartRaw(requestParameters, initOverrides);
|
|
1147
|
+
return await response.value();
|
|
1148
|
+
}
|
|
1149
|
+
|
|
1051
1150
|
/**
|
|
1052
1151
|
* Creates request options for setPathPartTags without sending the request
|
|
1053
1152
|
*/
|