@knowledge-stack/ksapi 3.14.0 → 3.15.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@3.
|
|
1
|
+
# @knowledge-stack/ksapi@3.15.0
|
|
2
2
|
|
|
3
3
|
A TypeScript SDK client for the localhost API.
|
|
4
4
|
|
|
@@ -756,7 +756,7 @@ and is automatically generated by the
|
|
|
756
756
|
[OpenAPI Generator](https://openapi-generator.tech) project:
|
|
757
757
|
|
|
758
758
|
- API version: `0.1.0`
|
|
759
|
-
- Package version: `3.
|
|
759
|
+
- Package version: `3.15.0`
|
|
760
760
|
- Generator version: `7.21.0`
|
|
761
761
|
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
|
|
762
762
|
|
|
@@ -356,7 +356,7 @@ export interface DocumentsApiInterface {
|
|
|
356
356
|
*/
|
|
357
357
|
ingestZipRequestOpts(requestParameters: IngestZipRequest): Promise<runtime.RequestOpts>;
|
|
358
358
|
/**
|
|
359
|
-
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes)
|
|
359
|
+
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes). ``skipped`` carries OS artifacts (skipped) and the members rejected up front (nested archive, empty, over the size cap) as errors; with nothing left to ingest no workflow starts and ``workflow_id`` is null. Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes; a re-upload whose ZIP-named folder already exists returns 409. Failures of accepted members (for example an unsupported file type) surface in the polled workflow results, not in this response. Each member reuses the single-file ingest path, so run-enrollment and completion events fire per member there.
|
|
360
360
|
* @summary Ingest Zip Handler
|
|
361
361
|
* @param {Blob} file
|
|
362
362
|
* @param {string} pathPartId Parent path part ID (must be a FOLDER type)
|
|
@@ -368,7 +368,7 @@ export interface DocumentsApiInterface {
|
|
|
368
368
|
*/
|
|
369
369
|
ingestZipRaw(requestParameters: IngestZipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IngestZipResponse>>;
|
|
370
370
|
/**
|
|
371
|
-
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes)
|
|
371
|
+
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes). ``skipped`` carries OS artifacts (skipped) and the members rejected up front (nested archive, empty, over the size cap) as errors; with nothing left to ingest no workflow starts and ``workflow_id`` is null. Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes; a re-upload whose ZIP-named folder already exists returns 409. Failures of accepted members (for example an unsupported file type) surface in the polled workflow results, not in this response. Each member reuses the single-file ingest path, so run-enrollment and completion events fire per member there.
|
|
372
372
|
* Ingest Zip Handler
|
|
373
373
|
*/
|
|
374
374
|
ingestZip(requestParameters: IngestZipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestZipResponse>;
|
|
@@ -615,12 +615,12 @@ export declare class DocumentsApi extends runtime.BaseAPI implements DocumentsAp
|
|
|
615
615
|
*/
|
|
616
616
|
ingestZipRequestOpts(requestParameters: IngestZipRequest): Promise<runtime.RequestOpts>;
|
|
617
617
|
/**
|
|
618
|
-
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes)
|
|
618
|
+
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes). ``skipped`` carries OS artifacts (skipped) and the members rejected up front (nested archive, empty, over the size cap) as errors; with nothing left to ingest no workflow starts and ``workflow_id`` is null. Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes; a re-upload whose ZIP-named folder already exists returns 409. Failures of accepted members (for example an unsupported file type) surface in the polled workflow results, not in this response. Each member reuses the single-file ingest path, so run-enrollment and completion events fire per member there.
|
|
619
619
|
* Ingest Zip Handler
|
|
620
620
|
*/
|
|
621
621
|
ingestZipRaw(requestParameters: IngestZipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IngestZipResponse>>;
|
|
622
622
|
/**
|
|
623
|
-
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes)
|
|
623
|
+
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes). ``skipped`` carries OS artifacts (skipped) and the members rejected up front (nested archive, empty, over the size cap) as errors; with nothing left to ingest no workflow starts and ``workflow_id`` is null. Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes; a re-upload whose ZIP-named folder already exists returns 409. Failures of accepted members (for example an unsupported file type) surface in the polled workflow results, not in this response. Each member reuses the single-file ingest path, so run-enrollment and completion events fire per member there.
|
|
624
624
|
* Ingest Zip Handler
|
|
625
625
|
*/
|
|
626
626
|
ingestZip(requestParameters: IngestZipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestZipResponse>;
|
|
@@ -700,7 +700,7 @@ class DocumentsApi extends runtime.BaseAPI {
|
|
|
700
700
|
});
|
|
701
701
|
}
|
|
702
702
|
/**
|
|
703
|
-
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes)
|
|
703
|
+
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes). ``skipped`` carries OS artifacts (skipped) and the members rejected up front (nested archive, empty, over the size cap) as errors; with nothing left to ingest no workflow starts and ``workflow_id`` is null. Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes; a re-upload whose ZIP-named folder already exists returns 409. Failures of accepted members (for example an unsupported file type) surface in the polled workflow results, not in this response. Each member reuses the single-file ingest path, so run-enrollment and completion events fire per member there.
|
|
704
704
|
* Ingest Zip Handler
|
|
705
705
|
*/
|
|
706
706
|
ingestZipRaw(requestParameters, initOverrides) {
|
|
@@ -711,7 +711,7 @@ class DocumentsApi extends runtime.BaseAPI {
|
|
|
711
711
|
});
|
|
712
712
|
}
|
|
713
713
|
/**
|
|
714
|
-
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes)
|
|
714
|
+
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes). ``skipped`` carries OS artifacts (skipped) and the members rejected up front (nested archive, empty, over the size cap) as errors; with nothing left to ingest no workflow starts and ``workflow_id`` is null. Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes; a re-upload whose ZIP-named folder already exists returns 409. Failures of accepted members (for example an unsupported file type) surface in the polled workflow results, not in this response. Each member reuses the single-file ingest path, so run-enrollment and completion events fire per member there.
|
|
715
715
|
* Ingest Zip Handler
|
|
716
716
|
*/
|
|
717
717
|
ingestZip(requestParameters, initOverrides) {
|
|
@@ -356,7 +356,7 @@ export interface DocumentsApiInterface {
|
|
|
356
356
|
*/
|
|
357
357
|
ingestZipRequestOpts(requestParameters: IngestZipRequest): Promise<runtime.RequestOpts>;
|
|
358
358
|
/**
|
|
359
|
-
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes)
|
|
359
|
+
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes). ``skipped`` carries OS artifacts (skipped) and the members rejected up front (nested archive, empty, over the size cap) as errors; with nothing left to ingest no workflow starts and ``workflow_id`` is null. Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes; a re-upload whose ZIP-named folder already exists returns 409. Failures of accepted members (for example an unsupported file type) surface in the polled workflow results, not in this response. Each member reuses the single-file ingest path, so run-enrollment and completion events fire per member there.
|
|
360
360
|
* @summary Ingest Zip Handler
|
|
361
361
|
* @param {Blob} file
|
|
362
362
|
* @param {string} pathPartId Parent path part ID (must be a FOLDER type)
|
|
@@ -368,7 +368,7 @@ export interface DocumentsApiInterface {
|
|
|
368
368
|
*/
|
|
369
369
|
ingestZipRaw(requestParameters: IngestZipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IngestZipResponse>>;
|
|
370
370
|
/**
|
|
371
|
-
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes)
|
|
371
|
+
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes). ``skipped`` carries OS artifacts (skipped) and the members rejected up front (nested archive, empty, over the size cap) as errors; with nothing left to ingest no workflow starts and ``workflow_id`` is null. Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes; a re-upload whose ZIP-named folder already exists returns 409. Failures of accepted members (for example an unsupported file type) surface in the polled workflow results, not in this response. Each member reuses the single-file ingest path, so run-enrollment and completion events fire per member there.
|
|
372
372
|
* Ingest Zip Handler
|
|
373
373
|
*/
|
|
374
374
|
ingestZip(requestParameters: IngestZipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestZipResponse>;
|
|
@@ -615,12 +615,12 @@ export declare class DocumentsApi extends runtime.BaseAPI implements DocumentsAp
|
|
|
615
615
|
*/
|
|
616
616
|
ingestZipRequestOpts(requestParameters: IngestZipRequest): Promise<runtime.RequestOpts>;
|
|
617
617
|
/**
|
|
618
|
-
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes)
|
|
618
|
+
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes). ``skipped`` carries OS artifacts (skipped) and the members rejected up front (nested archive, empty, over the size cap) as errors; with nothing left to ingest no workflow starts and ``workflow_id`` is null. Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes; a re-upload whose ZIP-named folder already exists returns 409. Failures of accepted members (for example an unsupported file type) surface in the polled workflow results, not in this response. Each member reuses the single-file ingest path, so run-enrollment and completion events fire per member there.
|
|
619
619
|
* Ingest Zip Handler
|
|
620
620
|
*/
|
|
621
621
|
ingestZipRaw(requestParameters: IngestZipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IngestZipResponse>>;
|
|
622
622
|
/**
|
|
623
|
-
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes)
|
|
623
|
+
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes). ``skipped`` carries OS artifacts (skipped) and the members rejected up front (nested archive, empty, over the size cap) as errors; with nothing left to ingest no workflow starts and ``workflow_id`` is null. Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes; a re-upload whose ZIP-named folder already exists returns 409. Failures of accepted members (for example an unsupported file type) surface in the polled workflow results, not in this response. Each member reuses the single-file ingest path, so run-enrollment and completion events fire per member there.
|
|
624
624
|
* Ingest Zip Handler
|
|
625
625
|
*/
|
|
626
626
|
ingestZip(requestParameters: IngestZipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestZipResponse>;
|
|
@@ -664,7 +664,7 @@ export class DocumentsApi extends runtime.BaseAPI {
|
|
|
664
664
|
});
|
|
665
665
|
}
|
|
666
666
|
/**
|
|
667
|
-
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes)
|
|
667
|
+
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes). ``skipped`` carries OS artifacts (skipped) and the members rejected up front (nested archive, empty, over the size cap) as errors; with nothing left to ingest no workflow starts and ``workflow_id`` is null. Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes; a re-upload whose ZIP-named folder already exists returns 409. Failures of accepted members (for example an unsupported file type) surface in the polled workflow results, not in this response. Each member reuses the single-file ingest path, so run-enrollment and completion events fire per member there.
|
|
668
668
|
* Ingest Zip Handler
|
|
669
669
|
*/
|
|
670
670
|
ingestZipRaw(requestParameters, initOverrides) {
|
|
@@ -675,7 +675,7 @@ export class DocumentsApi extends runtime.BaseAPI {
|
|
|
675
675
|
});
|
|
676
676
|
}
|
|
677
677
|
/**
|
|
678
|
-
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes)
|
|
678
|
+
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes). ``skipped`` carries OS artifacts (skipped) and the members rejected up front (nested archive, empty, over the size cap) as errors; with nothing left to ingest no workflow starts and ``workflow_id`` is null. Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes; a re-upload whose ZIP-named folder already exists returns 409. Failures of accepted members (for example an unsupported file type) surface in the polled workflow results, not in this response. Each member reuses the single-file ingest path, so run-enrollment and completion events fire per member there.
|
|
679
679
|
* Ingest Zip Handler
|
|
680
680
|
*/
|
|
681
681
|
ingestZip(requestParameters, initOverrides) {
|
package/docs/DocumentsApi.md
CHANGED
|
@@ -832,7 +832,7 @@ example().catch(console.error);
|
|
|
832
832
|
|
|
833
833
|
Ingest Zip Handler
|
|
834
834
|
|
|
835
|
-
Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes)
|
|
835
|
+
Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes). ``skipped`` carries OS artifacts (skipped) and the members rejected up front (nested archive, empty, over the size cap) as errors; with nothing left to ingest no workflow starts and ``workflow_id`` is null. Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes; a re-upload whose ZIP-named folder already exists returns 409. Failures of accepted members (for example an unsupported file type) surface in the polled workflow results, not in this response. Each member reuses the single-file ingest path, so run-enrollment and completion events fire per member there.
|
|
836
836
|
|
|
837
837
|
### Example
|
|
838
838
|
|
package/package.json
CHANGED
package/src/apis/DocumentsApi.ts
CHANGED
|
@@ -472,7 +472,7 @@ export interface DocumentsApiInterface {
|
|
|
472
472
|
ingestZipRequestOpts(requestParameters: IngestZipRequest): Promise<runtime.RequestOpts>;
|
|
473
473
|
|
|
474
474
|
/**
|
|
475
|
-
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes)
|
|
475
|
+
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes). ``skipped`` carries OS artifacts (skipped) and the members rejected up front (nested archive, empty, over the size cap) as errors; with nothing left to ingest no workflow starts and ``workflow_id`` is null. Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes; a re-upload whose ZIP-named folder already exists returns 409. Failures of accepted members (for example an unsupported file type) surface in the polled workflow results, not in this response. Each member reuses the single-file ingest path, so run-enrollment and completion events fire per member there.
|
|
476
476
|
* @summary Ingest Zip Handler
|
|
477
477
|
* @param {Blob} file
|
|
478
478
|
* @param {string} pathPartId Parent path part ID (must be a FOLDER type)
|
|
@@ -485,7 +485,7 @@ export interface DocumentsApiInterface {
|
|
|
485
485
|
ingestZipRaw(requestParameters: IngestZipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IngestZipResponse>>;
|
|
486
486
|
|
|
487
487
|
/**
|
|
488
|
-
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes)
|
|
488
|
+
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes). ``skipped`` carries OS artifacts (skipped) and the members rejected up front (nested archive, empty, over the size cap) as errors; with nothing left to ingest no workflow starts and ``workflow_id`` is null. Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes; a re-upload whose ZIP-named folder already exists returns 409. Failures of accepted members (for example an unsupported file type) surface in the polled workflow results, not in this response. Each member reuses the single-file ingest path, so run-enrollment and completion events fire per member there.
|
|
489
489
|
* Ingest Zip Handler
|
|
490
490
|
*/
|
|
491
491
|
ingestZip(requestParameters: IngestZipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestZipResponse>;
|
|
@@ -1361,7 +1361,7 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
|
|
|
1361
1361
|
}
|
|
1362
1362
|
|
|
1363
1363
|
/**
|
|
1364
|
-
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes)
|
|
1364
|
+
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes). ``skipped`` carries OS artifacts (skipped) and the members rejected up front (nested archive, empty, over the size cap) as errors; with nothing left to ingest no workflow starts and ``workflow_id`` is null. Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes; a re-upload whose ZIP-named folder already exists returns 409. Failures of accepted members (for example an unsupported file type) surface in the polled workflow results, not in this response. Each member reuses the single-file ingest path, so run-enrollment and completion events fire per member there.
|
|
1365
1365
|
* Ingest Zip Handler
|
|
1366
1366
|
*/
|
|
1367
1367
|
async ingestZipRaw(requestParameters: IngestZipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IngestZipResponse>> {
|
|
@@ -1372,7 +1372,7 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
|
|
|
1372
1372
|
}
|
|
1373
1373
|
|
|
1374
1374
|
/**
|
|
1375
|
-
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes)
|
|
1375
|
+
* Upload a ZIP archive; ingest each member asynchronously via a fan-out. The whole archive nests under a single FOLDER named after the ZIP file (``report.zip`` -> ``report/``), with the ZIP\'s directory structure mirrored beneath it as FOLDER PathParts — all created synchronously. Returns 202 with the fan-out ``workflow_id`` (poll ``GET /v1/system-jobs/zip-ingestions/{workflow_id}`` for per-member outcomes). ``skipped`` carries OS artifacts (skipped) and the members rejected up front (nested archive, empty, over the size cap) as errors; with nothing left to ingest no workflow starts and ``workflow_id`` is null. Whole-archive failures (not a ZIP, zip-bomb, >500 files) return 400 before any DB writes; a re-upload whose ZIP-named folder already exists returns 409. Failures of accepted members (for example an unsupported file type) surface in the polled workflow results, not in this response. Each member reuses the single-file ingest path, so run-enrollment and completion events fire per member there.
|
|
1376
1376
|
* Ingest Zip Handler
|
|
1377
1377
|
*/
|
|
1378
1378
|
async ingestZip(requestParameters: IngestZipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestZipResponse> {
|