@knowledge-stack/ksapi 1.160.2 → 1.161.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
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @knowledge-stack/ksapi@1.
|
|
1
|
+
# @knowledge-stack/ksapi@1.161.0
|
|
2
2
|
|
|
3
3
|
A TypeScript SDK client for the localhost API.
|
|
4
4
|
|
|
@@ -710,7 +710,7 @@ and is automatically generated by the
|
|
|
710
710
|
[OpenAPI Generator](https://openapi-generator.tech) project:
|
|
711
711
|
|
|
712
712
|
- API version: `0.1.0`
|
|
713
|
-
- Package version: `1.
|
|
713
|
+
- Package version: `1.161.0`
|
|
714
714
|
- Generator version: `7.21.0`
|
|
715
715
|
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
|
|
716
716
|
|
|
@@ -43,6 +43,7 @@ export interface ListPathPartEventsRequest {
|
|
|
43
43
|
since?: Date | null;
|
|
44
44
|
until?: Date | null;
|
|
45
45
|
recursive?: boolean;
|
|
46
|
+
includeChurn?: boolean;
|
|
46
47
|
limit?: number;
|
|
47
48
|
offset?: number;
|
|
48
49
|
}
|
|
@@ -241,6 +242,7 @@ export interface PathPartsApiInterface {
|
|
|
241
242
|
* @param {Date} [since] Only events at or after this timestamp
|
|
242
243
|
* @param {Date} [until] Only events strictly before this timestamp
|
|
243
244
|
* @param {boolean} [recursive] Include events from descendant path_parts as well as the subject itself
|
|
245
|
+
* @param {boolean} [includeChurn] Include intra-document churn hidden by default (raw chunk/section edits, version-metadata updates, and the v0 version-created row). Off by default so one upload / one logical edit shows as one event; ignored when an explicit kind is set.
|
|
244
246
|
* @param {number} [limit] Number of items per page
|
|
245
247
|
* @param {number} [offset] Number of items to skip
|
|
246
248
|
* @throws {RequiredError}
|
|
@@ -248,13 +250,14 @@ export interface PathPartsApiInterface {
|
|
|
248
250
|
*/
|
|
249
251
|
listPathPartEventsRequestOpts(requestParameters: ListPathPartEventsRequest): Promise<runtime.RequestOpts>;
|
|
250
252
|
/**
|
|
251
|
-
* List events anchored to a specific path_part subject. Subject permission is enforced via the existing ``PathPermissionService`` — caller must have ``can_read`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Events are ordered newest-first by ``ts`` and paginated. When ``recursive=True``, events on any descendant of the subject are included — useful for \"all events under this folder\" or \"all events under this workflow definition\".
|
|
253
|
+
* List events anchored to a specific path_part subject. Subject permission is enforced via the existing ``PathPermissionService`` — caller must have ``can_read`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Events are ordered newest-first by ``ts`` and paginated. When ``recursive=True``, events on any descendant of the subject are included — useful for \"all events under this folder\" or \"all events under this workflow definition\". By default the feed collapses intra-document churn to match the tenant-wide admin view; pass ``include_churn=True`` for the complete forensic feed (the agent\'s ``list_events`` tool does this).
|
|
252
254
|
* @summary List Path Part Events Handler
|
|
253
255
|
* @param {string} pathPartId
|
|
254
256
|
* @param {string} [kind] Filter to a single event kind
|
|
255
257
|
* @param {Date} [since] Only events at or after this timestamp
|
|
256
258
|
* @param {Date} [until] Only events strictly before this timestamp
|
|
257
259
|
* @param {boolean} [recursive] Include events from descendant path_parts as well as the subject itself
|
|
260
|
+
* @param {boolean} [includeChurn] Include intra-document churn hidden by default (raw chunk/section edits, version-metadata updates, and the v0 version-created row). Off by default so one upload / one logical edit shows as one event; ignored when an explicit kind is set.
|
|
258
261
|
* @param {number} [limit] Number of items per page
|
|
259
262
|
* @param {number} [offset] Number of items to skip
|
|
260
263
|
* @param {*} [options] Override http request option.
|
|
@@ -263,7 +266,7 @@ export interface PathPartsApiInterface {
|
|
|
263
266
|
*/
|
|
264
267
|
listPathPartEventsRaw(requestParameters: ListPathPartEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseEventResponse>>;
|
|
265
268
|
/**
|
|
266
|
-
* List events anchored to a specific path_part subject. Subject permission is enforced via the existing ``PathPermissionService`` — caller must have ``can_read`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Events are ordered newest-first by ``ts`` and paginated. When ``recursive=True``, events on any descendant of the subject are included — useful for \"all events under this folder\" or \"all events under this workflow definition\".
|
|
269
|
+
* List events anchored to a specific path_part subject. Subject permission is enforced via the existing ``PathPermissionService`` — caller must have ``can_read`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Events are ordered newest-first by ``ts`` and paginated. When ``recursive=True``, events on any descendant of the subject are included — useful for \"all events under this folder\" or \"all events under this workflow definition\". By default the feed collapses intra-document churn to match the tenant-wide admin view; pass ``include_churn=True`` for the complete forensic feed (the agent\'s ``list_events`` tool does this).
|
|
267
270
|
* List Path Part Events Handler
|
|
268
271
|
*/
|
|
269
272
|
listPathPartEvents(requestParameters: ListPathPartEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseEventResponse>;
|
|
@@ -483,12 +486,12 @@ export declare class PathPartsApi extends runtime.BaseAPI implements PathPartsAp
|
|
|
483
486
|
*/
|
|
484
487
|
listPathPartEventsRequestOpts(requestParameters: ListPathPartEventsRequest): Promise<runtime.RequestOpts>;
|
|
485
488
|
/**
|
|
486
|
-
* List events anchored to a specific path_part subject. Subject permission is enforced via the existing ``PathPermissionService`` — caller must have ``can_read`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Events are ordered newest-first by ``ts`` and paginated. When ``recursive=True``, events on any descendant of the subject are included — useful for \"all events under this folder\" or \"all events under this workflow definition\".
|
|
489
|
+
* List events anchored to a specific path_part subject. Subject permission is enforced via the existing ``PathPermissionService`` — caller must have ``can_read`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Events are ordered newest-first by ``ts`` and paginated. When ``recursive=True``, events on any descendant of the subject are included — useful for \"all events under this folder\" or \"all events under this workflow definition\". By default the feed collapses intra-document churn to match the tenant-wide admin view; pass ``include_churn=True`` for the complete forensic feed (the agent\'s ``list_events`` tool does this).
|
|
487
490
|
* List Path Part Events Handler
|
|
488
491
|
*/
|
|
489
492
|
listPathPartEventsRaw(requestParameters: ListPathPartEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseEventResponse>>;
|
|
490
493
|
/**
|
|
491
|
-
* List events anchored to a specific path_part subject. Subject permission is enforced via the existing ``PathPermissionService`` — caller must have ``can_read`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Events are ordered newest-first by ``ts`` and paginated. When ``recursive=True``, events on any descendant of the subject are included — useful for \"all events under this folder\" or \"all events under this workflow definition\".
|
|
494
|
+
* List events anchored to a specific path_part subject. Subject permission is enforced via the existing ``PathPermissionService`` — caller must have ``can_read`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Events are ordered newest-first by ``ts`` and paginated. When ``recursive=True``, events on any descendant of the subject are included — useful for \"all events under this folder\" or \"all events under this workflow definition\". By default the feed collapses intra-document churn to match the tenant-wide admin view; pass ``include_churn=True`` for the complete forensic feed (the agent\'s ``list_events`` tool does this).
|
|
492
495
|
* List Path Part Events Handler
|
|
493
496
|
*/
|
|
494
497
|
listPathPartEvents(requestParameters: ListPathPartEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseEventResponse>;
|
|
@@ -441,6 +441,9 @@ class PathPartsApi extends runtime.BaseAPI {
|
|
|
441
441
|
if (requestParameters['recursive'] != null) {
|
|
442
442
|
queryParameters['recursive'] = requestParameters['recursive'];
|
|
443
443
|
}
|
|
444
|
+
if (requestParameters['includeChurn'] != null) {
|
|
445
|
+
queryParameters['include_churn'] = requestParameters['includeChurn'];
|
|
446
|
+
}
|
|
444
447
|
if (requestParameters['limit'] != null) {
|
|
445
448
|
queryParameters['limit'] = requestParameters['limit'];
|
|
446
449
|
}
|
|
@@ -466,7 +469,7 @@ class PathPartsApi extends runtime.BaseAPI {
|
|
|
466
469
|
});
|
|
467
470
|
}
|
|
468
471
|
/**
|
|
469
|
-
* List events anchored to a specific path_part subject. Subject permission is enforced via the existing ``PathPermissionService`` — caller must have ``can_read`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Events are ordered newest-first by ``ts`` and paginated. When ``recursive=True``, events on any descendant of the subject are included — useful for \"all events under this folder\" or \"all events under this workflow definition\".
|
|
472
|
+
* List events anchored to a specific path_part subject. Subject permission is enforced via the existing ``PathPermissionService`` — caller must have ``can_read`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Events are ordered newest-first by ``ts`` and paginated. When ``recursive=True``, events on any descendant of the subject are included — useful for \"all events under this folder\" or \"all events under this workflow definition\". By default the feed collapses intra-document churn to match the tenant-wide admin view; pass ``include_churn=True`` for the complete forensic feed (the agent\'s ``list_events`` tool does this).
|
|
470
473
|
* List Path Part Events Handler
|
|
471
474
|
*/
|
|
472
475
|
listPathPartEventsRaw(requestParameters, initOverrides) {
|
|
@@ -477,7 +480,7 @@ class PathPartsApi extends runtime.BaseAPI {
|
|
|
477
480
|
});
|
|
478
481
|
}
|
|
479
482
|
/**
|
|
480
|
-
* List events anchored to a specific path_part subject. Subject permission is enforced via the existing ``PathPermissionService`` — caller must have ``can_read`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Events are ordered newest-first by ``ts`` and paginated. When ``recursive=True``, events on any descendant of the subject are included — useful for \"all events under this folder\" or \"all events under this workflow definition\".
|
|
483
|
+
* List events anchored to a specific path_part subject. Subject permission is enforced via the existing ``PathPermissionService`` — caller must have ``can_read`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Events are ordered newest-first by ``ts`` and paginated. When ``recursive=True``, events on any descendant of the subject are included — useful for \"all events under this folder\" or \"all events under this workflow definition\". By default the feed collapses intra-document churn to match the tenant-wide admin view; pass ``include_churn=True`` for the complete forensic feed (the agent\'s ``list_events`` tool does this).
|
|
481
484
|
* List Path Part Events Handler
|
|
482
485
|
*/
|
|
483
486
|
listPathPartEvents(requestParameters, initOverrides) {
|
|
@@ -43,6 +43,7 @@ export interface ListPathPartEventsRequest {
|
|
|
43
43
|
since?: Date | null;
|
|
44
44
|
until?: Date | null;
|
|
45
45
|
recursive?: boolean;
|
|
46
|
+
includeChurn?: boolean;
|
|
46
47
|
limit?: number;
|
|
47
48
|
offset?: number;
|
|
48
49
|
}
|
|
@@ -241,6 +242,7 @@ export interface PathPartsApiInterface {
|
|
|
241
242
|
* @param {Date} [since] Only events at or after this timestamp
|
|
242
243
|
* @param {Date} [until] Only events strictly before this timestamp
|
|
243
244
|
* @param {boolean} [recursive] Include events from descendant path_parts as well as the subject itself
|
|
245
|
+
* @param {boolean} [includeChurn] Include intra-document churn hidden by default (raw chunk/section edits, version-metadata updates, and the v0 version-created row). Off by default so one upload / one logical edit shows as one event; ignored when an explicit kind is set.
|
|
244
246
|
* @param {number} [limit] Number of items per page
|
|
245
247
|
* @param {number} [offset] Number of items to skip
|
|
246
248
|
* @throws {RequiredError}
|
|
@@ -248,13 +250,14 @@ export interface PathPartsApiInterface {
|
|
|
248
250
|
*/
|
|
249
251
|
listPathPartEventsRequestOpts(requestParameters: ListPathPartEventsRequest): Promise<runtime.RequestOpts>;
|
|
250
252
|
/**
|
|
251
|
-
* List events anchored to a specific path_part subject. Subject permission is enforced via the existing ``PathPermissionService`` — caller must have ``can_read`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Events are ordered newest-first by ``ts`` and paginated. When ``recursive=True``, events on any descendant of the subject are included — useful for \"all events under this folder\" or \"all events under this workflow definition\".
|
|
253
|
+
* List events anchored to a specific path_part subject. Subject permission is enforced via the existing ``PathPermissionService`` — caller must have ``can_read`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Events are ordered newest-first by ``ts`` and paginated. When ``recursive=True``, events on any descendant of the subject are included — useful for \"all events under this folder\" or \"all events under this workflow definition\". By default the feed collapses intra-document churn to match the tenant-wide admin view; pass ``include_churn=True`` for the complete forensic feed (the agent\'s ``list_events`` tool does this).
|
|
252
254
|
* @summary List Path Part Events Handler
|
|
253
255
|
* @param {string} pathPartId
|
|
254
256
|
* @param {string} [kind] Filter to a single event kind
|
|
255
257
|
* @param {Date} [since] Only events at or after this timestamp
|
|
256
258
|
* @param {Date} [until] Only events strictly before this timestamp
|
|
257
259
|
* @param {boolean} [recursive] Include events from descendant path_parts as well as the subject itself
|
|
260
|
+
* @param {boolean} [includeChurn] Include intra-document churn hidden by default (raw chunk/section edits, version-metadata updates, and the v0 version-created row). Off by default so one upload / one logical edit shows as one event; ignored when an explicit kind is set.
|
|
258
261
|
* @param {number} [limit] Number of items per page
|
|
259
262
|
* @param {number} [offset] Number of items to skip
|
|
260
263
|
* @param {*} [options] Override http request option.
|
|
@@ -263,7 +266,7 @@ export interface PathPartsApiInterface {
|
|
|
263
266
|
*/
|
|
264
267
|
listPathPartEventsRaw(requestParameters: ListPathPartEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseEventResponse>>;
|
|
265
268
|
/**
|
|
266
|
-
* List events anchored to a specific path_part subject. Subject permission is enforced via the existing ``PathPermissionService`` — caller must have ``can_read`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Events are ordered newest-first by ``ts`` and paginated. When ``recursive=True``, events on any descendant of the subject are included — useful for \"all events under this folder\" or \"all events under this workflow definition\".
|
|
269
|
+
* List events anchored to a specific path_part subject. Subject permission is enforced via the existing ``PathPermissionService`` — caller must have ``can_read`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Events are ordered newest-first by ``ts`` and paginated. When ``recursive=True``, events on any descendant of the subject are included — useful for \"all events under this folder\" or \"all events under this workflow definition\". By default the feed collapses intra-document churn to match the tenant-wide admin view; pass ``include_churn=True`` for the complete forensic feed (the agent\'s ``list_events`` tool does this).
|
|
267
270
|
* List Path Part Events Handler
|
|
268
271
|
*/
|
|
269
272
|
listPathPartEvents(requestParameters: ListPathPartEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseEventResponse>;
|
|
@@ -483,12 +486,12 @@ export declare class PathPartsApi extends runtime.BaseAPI implements PathPartsAp
|
|
|
483
486
|
*/
|
|
484
487
|
listPathPartEventsRequestOpts(requestParameters: ListPathPartEventsRequest): Promise<runtime.RequestOpts>;
|
|
485
488
|
/**
|
|
486
|
-
* List events anchored to a specific path_part subject. Subject permission is enforced via the existing ``PathPermissionService`` — caller must have ``can_read`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Events are ordered newest-first by ``ts`` and paginated. When ``recursive=True``, events on any descendant of the subject are included — useful for \"all events under this folder\" or \"all events under this workflow definition\".
|
|
489
|
+
* List events anchored to a specific path_part subject. Subject permission is enforced via the existing ``PathPermissionService`` — caller must have ``can_read`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Events are ordered newest-first by ``ts`` and paginated. When ``recursive=True``, events on any descendant of the subject are included — useful for \"all events under this folder\" or \"all events under this workflow definition\". By default the feed collapses intra-document churn to match the tenant-wide admin view; pass ``include_churn=True`` for the complete forensic feed (the agent\'s ``list_events`` tool does this).
|
|
487
490
|
* List Path Part Events Handler
|
|
488
491
|
*/
|
|
489
492
|
listPathPartEventsRaw(requestParameters: ListPathPartEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseEventResponse>>;
|
|
490
493
|
/**
|
|
491
|
-
* List events anchored to a specific path_part subject. Subject permission is enforced via the existing ``PathPermissionService`` — caller must have ``can_read`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Events are ordered newest-first by ``ts`` and paginated. When ``recursive=True``, events on any descendant of the subject are included — useful for \"all events under this folder\" or \"all events under this workflow definition\".
|
|
494
|
+
* List events anchored to a specific path_part subject. Subject permission is enforced via the existing ``PathPermissionService`` — caller must have ``can_read`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Events are ordered newest-first by ``ts`` and paginated. When ``recursive=True``, events on any descendant of the subject are included — useful for \"all events under this folder\" or \"all events under this workflow definition\". By default the feed collapses intra-document churn to match the tenant-wide admin view; pass ``include_churn=True`` for the complete forensic feed (the agent\'s ``list_events`` tool does this).
|
|
492
495
|
* List Path Part Events Handler
|
|
493
496
|
*/
|
|
494
497
|
listPathPartEvents(requestParameters: ListPathPartEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseEventResponse>;
|
|
@@ -405,6 +405,9 @@ export class PathPartsApi extends runtime.BaseAPI {
|
|
|
405
405
|
if (requestParameters['recursive'] != null) {
|
|
406
406
|
queryParameters['recursive'] = requestParameters['recursive'];
|
|
407
407
|
}
|
|
408
|
+
if (requestParameters['includeChurn'] != null) {
|
|
409
|
+
queryParameters['include_churn'] = requestParameters['includeChurn'];
|
|
410
|
+
}
|
|
408
411
|
if (requestParameters['limit'] != null) {
|
|
409
412
|
queryParameters['limit'] = requestParameters['limit'];
|
|
410
413
|
}
|
|
@@ -430,7 +433,7 @@ export class PathPartsApi extends runtime.BaseAPI {
|
|
|
430
433
|
});
|
|
431
434
|
}
|
|
432
435
|
/**
|
|
433
|
-
* List events anchored to a specific path_part subject. Subject permission is enforced via the existing ``PathPermissionService`` — caller must have ``can_read`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Events are ordered newest-first by ``ts`` and paginated. When ``recursive=True``, events on any descendant of the subject are included — useful for \"all events under this folder\" or \"all events under this workflow definition\".
|
|
436
|
+
* List events anchored to a specific path_part subject. Subject permission is enforced via the existing ``PathPermissionService`` — caller must have ``can_read`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Events are ordered newest-first by ``ts`` and paginated. When ``recursive=True``, events on any descendant of the subject are included — useful for \"all events under this folder\" or \"all events under this workflow definition\". By default the feed collapses intra-document churn to match the tenant-wide admin view; pass ``include_churn=True`` for the complete forensic feed (the agent\'s ``list_events`` tool does this).
|
|
434
437
|
* List Path Part Events Handler
|
|
435
438
|
*/
|
|
436
439
|
listPathPartEventsRaw(requestParameters, initOverrides) {
|
|
@@ -441,7 +444,7 @@ export class PathPartsApi extends runtime.BaseAPI {
|
|
|
441
444
|
});
|
|
442
445
|
}
|
|
443
446
|
/**
|
|
444
|
-
* List events anchored to a specific path_part subject. Subject permission is enforced via the existing ``PathPermissionService`` — caller must have ``can_read`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Events are ordered newest-first by ``ts`` and paginated. When ``recursive=True``, events on any descendant of the subject are included — useful for \"all events under this folder\" or \"all events under this workflow definition\".
|
|
447
|
+
* List events anchored to a specific path_part subject. Subject permission is enforced via the existing ``PathPermissionService`` — caller must have ``can_read`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Events are ordered newest-first by ``ts`` and paginated. When ``recursive=True``, events on any descendant of the subject are included — useful for \"all events under this folder\" or \"all events under this workflow definition\". By default the feed collapses intra-document churn to match the tenant-wide admin view; pass ``include_churn=True`` for the complete forensic feed (the agent\'s ``list_events`` tool does this).
|
|
445
448
|
* List Path Part Events Handler
|
|
446
449
|
*/
|
|
447
450
|
listPathPartEvents(requestParameters, initOverrides) {
|
package/docs/PathPartsApi.md
CHANGED
|
@@ -561,11 +561,11 @@ example().catch(console.error);
|
|
|
561
561
|
|
|
562
562
|
## listPathPartEvents
|
|
563
563
|
|
|
564
|
-
> PaginatedResponseEventResponse listPathPartEvents(pathPartId, kind, since, until, recursive, limit, offset)
|
|
564
|
+
> PaginatedResponseEventResponse listPathPartEvents(pathPartId, kind, since, until, recursive, includeChurn, limit, offset)
|
|
565
565
|
|
|
566
566
|
List Path Part Events Handler
|
|
567
567
|
|
|
568
|
-
List events anchored to a specific path_part subject. Subject permission is enforced via the existing ``PathPermissionService`` — caller must have ``can_read`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Events are ordered newest-first by ``ts`` and paginated. When ``recursive=True``, events on any descendant of the subject are included — useful for \"all events under this folder\" or \"all events under this workflow definition\".
|
|
568
|
+
List events anchored to a specific path_part subject. Subject permission is enforced via the existing ``PathPermissionService`` — caller must have ``can_read`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Events are ordered newest-first by ``ts`` and paginated. When ``recursive=True``, events on any descendant of the subject are included — useful for \"all events under this folder\" or \"all events under this workflow definition\". By default the feed collapses intra-document churn to match the tenant-wide admin view; pass ``include_churn=True`` for the complete forensic feed (the agent\'s ``list_events`` tool does this).
|
|
569
569
|
|
|
570
570
|
### Example
|
|
571
571
|
|
|
@@ -597,6 +597,8 @@ async function example() {
|
|
|
597
597
|
until: 2013-10-20T19:20:30+01:00,
|
|
598
598
|
// boolean | Include events from descendant path_parts as well as the subject itself (optional)
|
|
599
599
|
recursive: true,
|
|
600
|
+
// boolean | Include intra-document churn hidden by default (raw chunk/section edits, version-metadata updates, and the v0 version-created row). Off by default so one upload / one logical edit shows as one event; ignored when an explicit kind is set. (optional)
|
|
601
|
+
includeChurn: true,
|
|
600
602
|
// number | Number of items per page (optional)
|
|
601
603
|
limit: 56,
|
|
602
604
|
// number | Number of items to skip (optional)
|
|
@@ -625,6 +627,7 @@ example().catch(console.error);
|
|
|
625
627
|
| **since** | `Date` | Only events at or after this timestamp | [Optional] [Defaults to `undefined`] |
|
|
626
628
|
| **until** | `Date` | Only events strictly before this timestamp | [Optional] [Defaults to `undefined`] |
|
|
627
629
|
| **recursive** | `boolean` | Include events from descendant path_parts as well as the subject itself | [Optional] [Defaults to `false`] |
|
|
630
|
+
| **includeChurn** | `boolean` | Include intra-document churn hidden by default (raw chunk/section edits, version-metadata updates, and the v0 version-created row). Off by default so one upload / one logical edit shows as one event; ignored when an explicit kind is set. | [Optional] [Defaults to `false`] |
|
|
628
631
|
| **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
|
|
629
632
|
| **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
|
|
630
633
|
|
package/package.json
CHANGED
package/src/apis/PathPartsApi.ts
CHANGED
|
@@ -112,6 +112,7 @@ export interface ListPathPartEventsRequest {
|
|
|
112
112
|
since?: Date | null;
|
|
113
113
|
until?: Date | null;
|
|
114
114
|
recursive?: boolean;
|
|
115
|
+
includeChurn?: boolean;
|
|
115
116
|
limit?: number;
|
|
116
117
|
offset?: number;
|
|
117
118
|
}
|
|
@@ -336,6 +337,7 @@ export interface PathPartsApiInterface {
|
|
|
336
337
|
* @param {Date} [since] Only events at or after this timestamp
|
|
337
338
|
* @param {Date} [until] Only events strictly before this timestamp
|
|
338
339
|
* @param {boolean} [recursive] Include events from descendant path_parts as well as the subject itself
|
|
340
|
+
* @param {boolean} [includeChurn] Include intra-document churn hidden by default (raw chunk/section edits, version-metadata updates, and the v0 version-created row). Off by default so one upload / one logical edit shows as one event; ignored when an explicit kind is set.
|
|
339
341
|
* @param {number} [limit] Number of items per page
|
|
340
342
|
* @param {number} [offset] Number of items to skip
|
|
341
343
|
* @throws {RequiredError}
|
|
@@ -344,13 +346,14 @@ export interface PathPartsApiInterface {
|
|
|
344
346
|
listPathPartEventsRequestOpts(requestParameters: ListPathPartEventsRequest): Promise<runtime.RequestOpts>;
|
|
345
347
|
|
|
346
348
|
/**
|
|
347
|
-
* List events anchored to a specific path_part subject. Subject permission is enforced via the existing ``PathPermissionService`` — caller must have ``can_read`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Events are ordered newest-first by ``ts`` and paginated. When ``recursive=True``, events on any descendant of the subject are included — useful for \"all events under this folder\" or \"all events under this workflow definition\".
|
|
349
|
+
* List events anchored to a specific path_part subject. Subject permission is enforced via the existing ``PathPermissionService`` — caller must have ``can_read`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Events are ordered newest-first by ``ts`` and paginated. When ``recursive=True``, events on any descendant of the subject are included — useful for \"all events under this folder\" or \"all events under this workflow definition\". By default the feed collapses intra-document churn to match the tenant-wide admin view; pass ``include_churn=True`` for the complete forensic feed (the agent\'s ``list_events`` tool does this).
|
|
348
350
|
* @summary List Path Part Events Handler
|
|
349
351
|
* @param {string} pathPartId
|
|
350
352
|
* @param {string} [kind] Filter to a single event kind
|
|
351
353
|
* @param {Date} [since] Only events at or after this timestamp
|
|
352
354
|
* @param {Date} [until] Only events strictly before this timestamp
|
|
353
355
|
* @param {boolean} [recursive] Include events from descendant path_parts as well as the subject itself
|
|
356
|
+
* @param {boolean} [includeChurn] Include intra-document churn hidden by default (raw chunk/section edits, version-metadata updates, and the v0 version-created row). Off by default so one upload / one logical edit shows as one event; ignored when an explicit kind is set.
|
|
354
357
|
* @param {number} [limit] Number of items per page
|
|
355
358
|
* @param {number} [offset] Number of items to skip
|
|
356
359
|
* @param {*} [options] Override http request option.
|
|
@@ -360,7 +363,7 @@ export interface PathPartsApiInterface {
|
|
|
360
363
|
listPathPartEventsRaw(requestParameters: ListPathPartEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseEventResponse>>;
|
|
361
364
|
|
|
362
365
|
/**
|
|
363
|
-
* List events anchored to a specific path_part subject. Subject permission is enforced via the existing ``PathPermissionService`` — caller must have ``can_read`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Events are ordered newest-first by ``ts`` and paginated. When ``recursive=True``, events on any descendant of the subject are included — useful for \"all events under this folder\" or \"all events under this workflow definition\".
|
|
366
|
+
* List events anchored to a specific path_part subject. Subject permission is enforced via the existing ``PathPermissionService`` — caller must have ``can_read`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Events are ordered newest-first by ``ts`` and paginated. When ``recursive=True``, events on any descendant of the subject are included — useful for \"all events under this folder\" or \"all events under this workflow definition\". By default the feed collapses intra-document churn to match the tenant-wide admin view; pass ``include_churn=True`` for the complete forensic feed (the agent\'s ``list_events`` tool does this).
|
|
364
367
|
* List Path Part Events Handler
|
|
365
368
|
*/
|
|
366
369
|
listPathPartEvents(requestParameters: ListPathPartEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseEventResponse>;
|
|
@@ -945,6 +948,10 @@ export class PathPartsApi extends runtime.BaseAPI implements PathPartsApiInterfa
|
|
|
945
948
|
queryParameters['recursive'] = requestParameters['recursive'];
|
|
946
949
|
}
|
|
947
950
|
|
|
951
|
+
if (requestParameters['includeChurn'] != null) {
|
|
952
|
+
queryParameters['include_churn'] = requestParameters['includeChurn'];
|
|
953
|
+
}
|
|
954
|
+
|
|
948
955
|
if (requestParameters['limit'] != null) {
|
|
949
956
|
queryParameters['limit'] = requestParameters['limit'];
|
|
950
957
|
}
|
|
@@ -976,7 +983,7 @@ export class PathPartsApi extends runtime.BaseAPI implements PathPartsApiInterfa
|
|
|
976
983
|
}
|
|
977
984
|
|
|
978
985
|
/**
|
|
979
|
-
* List events anchored to a specific path_part subject. Subject permission is enforced via the existing ``PathPermissionService`` — caller must have ``can_read`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Events are ordered newest-first by ``ts`` and paginated. When ``recursive=True``, events on any descendant of the subject are included — useful for \"all events under this folder\" or \"all events under this workflow definition\".
|
|
986
|
+
* List events anchored to a specific path_part subject. Subject permission is enforced via the existing ``PathPermissionService`` — caller must have ``can_read`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Events are ordered newest-first by ``ts`` and paginated. When ``recursive=True``, events on any descendant of the subject are included — useful for \"all events under this folder\" or \"all events under this workflow definition\". By default the feed collapses intra-document churn to match the tenant-wide admin view; pass ``include_churn=True`` for the complete forensic feed (the agent\'s ``list_events`` tool does this).
|
|
980
987
|
* List Path Part Events Handler
|
|
981
988
|
*/
|
|
982
989
|
async listPathPartEventsRaw(requestParameters: ListPathPartEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseEventResponse>> {
|
|
@@ -987,7 +994,7 @@ export class PathPartsApi extends runtime.BaseAPI implements PathPartsApiInterfa
|
|
|
987
994
|
}
|
|
988
995
|
|
|
989
996
|
/**
|
|
990
|
-
* List events anchored to a specific path_part subject. Subject permission is enforced via the existing ``PathPermissionService`` — caller must have ``can_read`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Events are ordered newest-first by ``ts`` and paginated. When ``recursive=True``, events on any descendant of the subject are included — useful for \"all events under this folder\" or \"all events under this workflow definition\".
|
|
997
|
+
* List events anchored to a specific path_part subject. Subject permission is enforced via the existing ``PathPermissionService`` — caller must have ``can_read`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Events are ordered newest-first by ``ts`` and paginated. When ``recursive=True``, events on any descendant of the subject are included — useful for \"all events under this folder\" or \"all events under this workflow definition\". By default the feed collapses intra-document churn to match the tenant-wide admin view; pass ``include_churn=True`` for the complete forensic feed (the agent\'s ``list_events`` tool does this).
|
|
991
998
|
* List Path Part Events Handler
|
|
992
999
|
*/
|
|
993
1000
|
async listPathPartEvents(requestParameters: ListPathPartEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseEventResponse> {
|