@celigo/api-specs 0.2.141 → 0.2.143
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/dist/api.yml +4 -5
- package/dist/connection.yml +4 -5
- package/dist/enduser.yml +4 -5
- package/dist/filestorage.yml +24 -7
- package/dist/mcp-server.yml +4 -5
- package/dist/storagequery.yml +8 -3
- package/dist/tool.yml +4 -5
- package/package.json +1 -1
- package/schemas.json +1 -1
package/dist/api.yml
CHANGED
|
@@ -7772,9 +7772,8 @@ components:
|
|
|
7772
7772
|
## REQUIRED FIELDS
|
|
7773
7773
|
|
|
7774
7774
|
The Celigo backend rejects the connection POST with HTTP 422 if these
|
|
7775
|
-
type-specific required fields are missing.
|
|
7776
|
-
|
|
7777
|
-
`integrator-models/src/models/connection.js`.
|
|
7775
|
+
type-specific required fields are missing. The rules are enforced by
|
|
7776
|
+
server-side validation when the connection is saved.
|
|
7778
7777
|
|
|
7779
7778
|
- `type` — always required; selects the database system.
|
|
7780
7779
|
- `host` — required for every type EXCEPT `bigquery` and `redshift`.
|
|
@@ -8650,7 +8649,7 @@ components:
|
|
|
8650
8649
|
properties:
|
|
8651
8650
|
function:
|
|
8652
8651
|
type: string
|
|
8653
|
-
description:
|
|
8652
|
+
description: Function in the routing script that returns the target flow.
|
|
8654
8653
|
examples:
|
|
8655
8654
|
- routeByDocType
|
|
8656
8655
|
_scriptId:
|
|
@@ -10013,7 +10012,7 @@ components:
|
|
|
10013
10012
|
properties:
|
|
10014
10013
|
function:
|
|
10015
10014
|
type: string
|
|
10016
|
-
description:
|
|
10015
|
+
description: Function in the referenced script that returns the target flow for each inbound document.
|
|
10017
10016
|
examples:
|
|
10018
10017
|
- contentBasedFlowRouter
|
|
10019
10018
|
_scriptId:
|
package/dist/connection.yml
CHANGED
|
@@ -6627,9 +6627,8 @@ components:
|
|
|
6627
6627
|
## REQUIRED FIELDS
|
|
6628
6628
|
|
|
6629
6629
|
The Celigo backend rejects the connection POST with HTTP 422 if these
|
|
6630
|
-
type-specific required fields are missing.
|
|
6631
|
-
|
|
6632
|
-
`integrator-models/src/models/connection.js`.
|
|
6630
|
+
type-specific required fields are missing. The rules are enforced by
|
|
6631
|
+
server-side validation when the connection is saved.
|
|
6633
6632
|
|
|
6634
6633
|
- `type` — always required; selects the database system.
|
|
6635
6634
|
- `host` — required for every type EXCEPT `bigquery` and `redshift`.
|
|
@@ -7505,7 +7504,7 @@ components:
|
|
|
7505
7504
|
properties:
|
|
7506
7505
|
function:
|
|
7507
7506
|
type: string
|
|
7508
|
-
description:
|
|
7507
|
+
description: Function in the routing script that returns the target flow.
|
|
7509
7508
|
examples:
|
|
7510
7509
|
- routeByDocType
|
|
7511
7510
|
_scriptId:
|
|
@@ -8868,7 +8867,7 @@ components:
|
|
|
8868
8867
|
properties:
|
|
8869
8868
|
function:
|
|
8870
8869
|
type: string
|
|
8871
|
-
description:
|
|
8870
|
+
description: Function in the referenced script that returns the target flow for each inbound document.
|
|
8872
8871
|
examples:
|
|
8873
8872
|
- contentBasedFlowRouter
|
|
8874
8873
|
_scriptId:
|
package/dist/enduser.yml
CHANGED
|
@@ -4724,9 +4724,8 @@ components:
|
|
|
4724
4724
|
## REQUIRED FIELDS
|
|
4725
4725
|
|
|
4726
4726
|
The Celigo backend rejects the connection POST with HTTP 422 if these
|
|
4727
|
-
type-specific required fields are missing.
|
|
4728
|
-
|
|
4729
|
-
`integrator-models/src/models/connection.js`.
|
|
4727
|
+
type-specific required fields are missing. The rules are enforced by
|
|
4728
|
+
server-side validation when the connection is saved.
|
|
4730
4729
|
|
|
4731
4730
|
- `type` — always required; selects the database system.
|
|
4732
4731
|
- `host` — required for every type EXCEPT `bigquery` and `redshift`.
|
|
@@ -5602,7 +5601,7 @@ components:
|
|
|
5602
5601
|
properties:
|
|
5603
5602
|
function:
|
|
5604
5603
|
type: string
|
|
5605
|
-
description:
|
|
5604
|
+
description: Function in the routing script that returns the target flow.
|
|
5606
5605
|
examples:
|
|
5607
5606
|
- routeByDocType
|
|
5608
5607
|
_scriptId:
|
|
@@ -6965,7 +6964,7 @@ components:
|
|
|
6965
6964
|
properties:
|
|
6966
6965
|
function:
|
|
6967
6966
|
type: string
|
|
6968
|
-
description:
|
|
6967
|
+
description: Function in the referenced script that returns the target flow for each inbound document.
|
|
6969
6968
|
examples:
|
|
6970
6969
|
- contentBasedFlowRouter
|
|
6971
6970
|
_scriptId:
|
package/dist/filestorage.yml
CHANGED
|
@@ -389,8 +389,10 @@ paths:
|
|
|
389
389
|
account. Switches the endpoint to search mode, where `_parentId` is
|
|
390
390
|
ignored and each item carries its `location`. Matches names only, not
|
|
391
391
|
contents or descriptions; a query of several words matches names that
|
|
392
|
-
contain any of them
|
|
393
|
-
`
|
|
392
|
+
contain any of them, and hyphens separate words too, so
|
|
393
|
+
`orders-2026-q3` also matches every name containing `orders`. To find
|
|
394
|
+
one item by its exact name, list its folder with `name`. Cannot be
|
|
395
|
+
combined with `name`, `prefix`, or `_integrationId`.
|
|
394
396
|
schema:
|
|
395
397
|
type: string
|
|
396
398
|
minLength: 2
|
|
@@ -834,6 +836,10 @@ paths:
|
|
|
834
836
|
unknown ids come back inline as
|
|
835
837
|
`{_id, notFound: true, reason: "STORAGE_BATCH_ITEM_NOT_FOUND"}` entries
|
|
836
838
|
alongside the found items.
|
|
839
|
+
|
|
840
|
+
Only files are looked up: a folder's id is treated as unknown, so it
|
|
841
|
+
fails the request or comes back as a `notFound` entry. Read folder
|
|
842
|
+
metadata from `GET /v1/storage/items`.
|
|
837
843
|
operationId: batchGetStorageItems
|
|
838
844
|
tags:
|
|
839
845
|
- File Storage
|
|
@@ -1552,8 +1558,14 @@ paths:
|
|
|
1552
1558
|
Merges the contents of a source folder into an existing destination
|
|
1553
1559
|
folder, then removes the source. Runs asynchronously: the request is
|
|
1554
1560
|
validated and queued, and the endpoint immediately returns `202` with a
|
|
1555
|
-
job receipt — contents move in the background and the source folder
|
|
1556
|
-
disappears once the merge completes
|
|
1561
|
+
job receipt — contents move in the background, and the source folder
|
|
1562
|
+
disappears once the merge completes, without passing through the
|
|
1563
|
+
recycle bin. A file whose name is free in the destination moves with its
|
|
1564
|
+
`_id`. A file whose name the destination already holds overwrites that
|
|
1565
|
+
file: the destination file keeps its `_id` and takes the source file's
|
|
1566
|
+
content, its previous content is discarded, and the source file's `_id`
|
|
1567
|
+
is removed — neither goes to the recycle bin, so references to the
|
|
1568
|
+
source file break. A soft-deleted source folder may be
|
|
1557
1569
|
merged, which restores its contents into the destination. Folders only —
|
|
1558
1570
|
move individual files with the move endpoint. Requires delete access on
|
|
1559
1571
|
the source folder and write access on the destination.
|
|
@@ -2746,7 +2758,10 @@ components:
|
|
|
2746
2758
|
integration's root folder and inherited by everything created inside
|
|
2747
2759
|
it; null for user-created folders and files at the account root and
|
|
2748
2760
|
their descendants. Filter the list endpoint with `_integrationId` to
|
|
2749
|
-
scope a listing to one integration.
|
|
2761
|
+
scope a listing to one integration. The root folder is created with
|
|
2762
|
+
the integration and follows it: deleting the integration sends the
|
|
2763
|
+
folder and everything in it to the recycle bin, and purging the
|
|
2764
|
+
integration purges them.
|
|
2750
2765
|
examples:
|
|
2751
2766
|
- 6ab1e7ab38d7733b4594d0d2
|
|
2752
2767
|
integrationName:
|
|
@@ -2816,8 +2831,10 @@ components:
|
|
|
2816
2831
|
readOnly: true
|
|
2817
2832
|
description: |-
|
|
2818
2833
|
When true, the platform created the item (for example a system or
|
|
2819
|
-
integration folder) and protects it — move, content replace,
|
|
2820
|
-
delete, and purge are rejected with
|
|
2834
|
+
integration folder) and protects it — rename, move, content replace,
|
|
2835
|
+
copy, delete, and purge are rejected with 403
|
|
2836
|
+
`STORAGE_SYSTEM_ITEM_PROTECTED` ("System items cannot be modified or
|
|
2837
|
+
deleted").
|
|
2821
2838
|
deletedAt:
|
|
2822
2839
|
type: string
|
|
2823
2840
|
format: date-time
|
package/dist/mcp-server.yml
CHANGED
|
@@ -6572,9 +6572,8 @@ components:
|
|
|
6572
6572
|
## REQUIRED FIELDS
|
|
6573
6573
|
|
|
6574
6574
|
The Celigo backend rejects the connection POST with HTTP 422 if these
|
|
6575
|
-
type-specific required fields are missing.
|
|
6576
|
-
|
|
6577
|
-
`integrator-models/src/models/connection.js`.
|
|
6575
|
+
type-specific required fields are missing. The rules are enforced by
|
|
6576
|
+
server-side validation when the connection is saved.
|
|
6578
6577
|
|
|
6579
6578
|
- `type` — always required; selects the database system.
|
|
6580
6579
|
- `host` — required for every type EXCEPT `bigquery` and `redshift`.
|
|
@@ -7450,7 +7449,7 @@ components:
|
|
|
7450
7449
|
properties:
|
|
7451
7450
|
function:
|
|
7452
7451
|
type: string
|
|
7453
|
-
description:
|
|
7452
|
+
description: Function in the routing script that returns the target flow.
|
|
7454
7453
|
examples:
|
|
7455
7454
|
- routeByDocType
|
|
7456
7455
|
_scriptId:
|
|
@@ -8813,7 +8812,7 @@ components:
|
|
|
8813
8812
|
properties:
|
|
8814
8813
|
function:
|
|
8815
8814
|
type: string
|
|
8816
|
-
description:
|
|
8815
|
+
description: Function in the referenced script that returns the target flow for each inbound document.
|
|
8817
8816
|
examples:
|
|
8818
8817
|
- contentBasedFlowRouter
|
|
8819
8818
|
_scriptId:
|
package/dist/storagequery.yml
CHANGED
|
@@ -52,8 +52,10 @@ paths:
|
|
|
52
52
|
references no file is accepted only when it is a pure constant expression. Supported
|
|
53
53
|
file formats are CSV/TSV, JSON, NDJSON/JSONL, and Parquet; the reader is chosen from
|
|
54
54
|
the file's extension (or its MIME type), and an explicit reader function must match
|
|
55
|
-
it. A
|
|
56
|
-
|
|
55
|
+
it. A compressed file such as `orders.csv.gz` is refused, even through a reader call
|
|
56
|
+
that passes `compression = 'gzip'`. A folder is referenced with a
|
|
57
|
+
trailing slash and contributes its direct child files only; wildcard paths are not
|
|
58
|
+
supported. A file whose upload has not finished yet is refused until it is active.
|
|
57
59
|
|
|
58
60
|
Read options are named arguments of the reader call, checked against a per-reader
|
|
59
61
|
allowlist — for `read_csv`/`read_csv_auto`: `header`, `delim`, `quote`, `escape`,
|
|
@@ -192,7 +194,10 @@ paths:
|
|
|
192
194
|
catalog-qualified table name, or a path carrying a wildcard
|
|
193
195
|
(`STORAGE_QUERY_INVALID_SOURCE`); a folder path without its trailing slash
|
|
194
196
|
(`STORAGE_NOT_A_FILE`) or a file path with one (`STORAGE_ITEM_NOT_FOLDER`); an
|
|
195
|
-
unsupported file type (`STORAGE_QUERY_UNSUPPORTED_FILE_TYPE`)
|
|
197
|
+
unsupported file type (`STORAGE_QUERY_UNSUPPORTED_FILE_TYPE`) — a compressed
|
|
198
|
+
file is refused too, with "Querying `<name>` is not supported; supported formats
|
|
199
|
+
are CSV, JSON, NDJSON, and Parquet"; a file still uploading ("Upload for `<path>`
|
|
200
|
+
is not yet complete"); a folder that is
|
|
196
201
|
empty, mixes formats, or holds too many files (`STORAGE_QUERY_FOLDER_EMPTY`,
|
|
197
202
|
`STORAGE_QUERY_MIXED_FORMAT_FOLDER`, `STORAGE_QUERY_FOLDER_TOO_MANY_FILES`); too
|
|
198
203
|
many distinct files (`STORAGE_QUERY_TOO_MANY_SOURCES`); or more input bytes than
|
package/dist/tool.yml
CHANGED
|
@@ -9955,9 +9955,8 @@ components:
|
|
|
9955
9955
|
## REQUIRED FIELDS
|
|
9956
9956
|
|
|
9957
9957
|
The Celigo backend rejects the connection POST with HTTP 422 if these
|
|
9958
|
-
type-specific required fields are missing.
|
|
9959
|
-
|
|
9960
|
-
`integrator-models/src/models/connection.js`.
|
|
9958
|
+
type-specific required fields are missing. The rules are enforced by
|
|
9959
|
+
server-side validation when the connection is saved.
|
|
9961
9960
|
|
|
9962
9961
|
- `type` — always required; selects the database system.
|
|
9963
9962
|
- `host` — required for every type EXCEPT `bigquery` and `redshift`.
|
|
@@ -10833,7 +10832,7 @@ components:
|
|
|
10833
10832
|
properties:
|
|
10834
10833
|
function:
|
|
10835
10834
|
type: string
|
|
10836
|
-
description:
|
|
10835
|
+
description: Function in the routing script that returns the target flow.
|
|
10837
10836
|
examples:
|
|
10838
10837
|
- routeByDocType
|
|
10839
10838
|
_scriptId:
|
|
@@ -12196,7 +12195,7 @@ components:
|
|
|
12196
12195
|
properties:
|
|
12197
12196
|
function:
|
|
12198
12197
|
type: string
|
|
12199
|
-
description:
|
|
12198
|
+
description: Function in the referenced script that returns the target flow for each inbound document.
|
|
12200
12199
|
examples:
|
|
12201
12200
|
- contentBasedFlowRouter
|
|
12202
12201
|
_scriptId:
|
package/package.json
CHANGED