@celigo/api-specs 0.2.107 → 0.2.109
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 +9 -3
- package/dist/connection.yml +9 -3
- package/dist/enduser.yml +9 -3
- package/dist/export.yml +35 -3
- package/dist/mcp-server.yml +9 -3
- package/dist/tool.yml +44 -6
- package/package.json +1 -1
- package/schemas.json +1 -1
package/dist/api.yml
CHANGED
|
@@ -5634,14 +5634,20 @@ components:
|
|
|
5634
5634
|
x-celigo-ui-override: 'Required by the connection form: a password for ftp/ftps, or a password or SSH key (authKey) for sftp (see the if/then/else rule below). Encoded here to mirror the form so builders produce complete, connectable configurations.'
|
|
5635
5635
|
x-celigo-ai-guidance:
|
|
5636
5636
|
- For ftp/ftps set password; for sftp set password or authKey. The connection cannot authenticate without credentials.
|
|
5637
|
+
- For key-only sftp, omit password rather than filling it with a stand-in value — the form's required marker on Password does not apply once authKey is set, and the Help Center notes that servers enforcing a strict authentication order (public key first, then password) are not compatible with supplying both.
|
|
5637
5638
|
examples:
|
|
5638
5639
|
- s3cr3t-ftp-passw0rd
|
|
5639
5640
|
authKey:
|
|
5640
5641
|
type: string
|
|
5641
|
-
description:
|
|
5642
|
+
description: |-
|
|
5642
5643
|
SSH private key for SFTP key-based authentication (encrypted at rest; returned masked as `"******"`).
|
|
5643
|
-
Only used when type is "sftp".
|
|
5644
|
-
|
|
5644
|
+
Only used when type is "sftp"; can be used alone or alongside a password. Must be an RSA (SSH-2) key
|
|
5645
|
+
in PEM format, supplied whole from its BEGIN line to its END line — OpenSSH-format keys (first line
|
|
5646
|
+
`-----BEGIN OPENSSH PRIVATE KEY-----`), passphrase-protected keys, SSH-1 keys and PuTTY `.ppk` files
|
|
5647
|
+
are not supported and must be converted to an unencrypted PEM key first.
|
|
5648
|
+
x-celigo-ai-guidance:
|
|
5649
|
+
- Never take the key through chat; write a placeholder the user replaces in the connection editor. The matching public key must be in the server's authorized_keys for the username — Celigo holds only the private half.
|
|
5650
|
+
- A key whose first line is `-----BEGIN OPENSSH PRIVATE KEY-----`, or one that asks for a passphrase, is outside the supported format per the Help Center; `ssh-keygen -p -m PEM -f <key>` rewrites it as PEM (`-N ""` also removes the passphrase).
|
|
5645
5651
|
writeOnly: true
|
|
5646
5652
|
usePassiveMode:
|
|
5647
5653
|
type: boolean
|
package/dist/connection.yml
CHANGED
|
@@ -4745,14 +4745,20 @@ components:
|
|
|
4745
4745
|
x-celigo-ui-override: 'Required by the connection form: a password for ftp/ftps, or a password or SSH key (authKey) for sftp (see the if/then/else rule below). Encoded here to mirror the form so builders produce complete, connectable configurations.'
|
|
4746
4746
|
x-celigo-ai-guidance:
|
|
4747
4747
|
- For ftp/ftps set password; for sftp set password or authKey. The connection cannot authenticate without credentials.
|
|
4748
|
+
- For key-only sftp, omit password rather than filling it with a stand-in value — the form's required marker on Password does not apply once authKey is set, and the Help Center notes that servers enforcing a strict authentication order (public key first, then password) are not compatible with supplying both.
|
|
4748
4749
|
examples:
|
|
4749
4750
|
- s3cr3t-ftp-passw0rd
|
|
4750
4751
|
authKey:
|
|
4751
4752
|
type: string
|
|
4752
|
-
description:
|
|
4753
|
+
description: |-
|
|
4753
4754
|
SSH private key for SFTP key-based authentication (encrypted at rest; returned masked as `"******"`).
|
|
4754
|
-
Only used when type is "sftp".
|
|
4755
|
-
|
|
4755
|
+
Only used when type is "sftp"; can be used alone or alongside a password. Must be an RSA (SSH-2) key
|
|
4756
|
+
in PEM format, supplied whole from its BEGIN line to its END line — OpenSSH-format keys (first line
|
|
4757
|
+
`-----BEGIN OPENSSH PRIVATE KEY-----`), passphrase-protected keys, SSH-1 keys and PuTTY `.ppk` files
|
|
4758
|
+
are not supported and must be converted to an unencrypted PEM key first.
|
|
4759
|
+
x-celigo-ai-guidance:
|
|
4760
|
+
- Never take the key through chat; write a placeholder the user replaces in the connection editor. The matching public key must be in the server's authorized_keys for the username — Celigo holds only the private half.
|
|
4761
|
+
- A key whose first line is `-----BEGIN OPENSSH PRIVATE KEY-----`, or one that asks for a passphrase, is outside the supported format per the Help Center; `ssh-keygen -p -m PEM -f <key>` rewrites it as PEM (`-N ""` also removes the passphrase).
|
|
4756
4762
|
writeOnly: true
|
|
4757
4763
|
usePassiveMode:
|
|
4758
4764
|
type: boolean
|
package/dist/enduser.yml
CHANGED
|
@@ -2846,14 +2846,20 @@ components:
|
|
|
2846
2846
|
x-celigo-ui-override: 'Required by the connection form: a password for ftp/ftps, or a password or SSH key (authKey) for sftp (see the if/then/else rule below). Encoded here to mirror the form so builders produce complete, connectable configurations.'
|
|
2847
2847
|
x-celigo-ai-guidance:
|
|
2848
2848
|
- For ftp/ftps set password; for sftp set password or authKey. The connection cannot authenticate without credentials.
|
|
2849
|
+
- For key-only sftp, omit password rather than filling it with a stand-in value — the form's required marker on Password does not apply once authKey is set, and the Help Center notes that servers enforcing a strict authentication order (public key first, then password) are not compatible with supplying both.
|
|
2849
2850
|
examples:
|
|
2850
2851
|
- s3cr3t-ftp-passw0rd
|
|
2851
2852
|
authKey:
|
|
2852
2853
|
type: string
|
|
2853
|
-
description:
|
|
2854
|
+
description: |-
|
|
2854
2855
|
SSH private key for SFTP key-based authentication (encrypted at rest; returned masked as `"******"`).
|
|
2855
|
-
Only used when type is "sftp".
|
|
2856
|
-
|
|
2856
|
+
Only used when type is "sftp"; can be used alone or alongside a password. Must be an RSA (SSH-2) key
|
|
2857
|
+
in PEM format, supplied whole from its BEGIN line to its END line — OpenSSH-format keys (first line
|
|
2858
|
+
`-----BEGIN OPENSSH PRIVATE KEY-----`), passphrase-protected keys, SSH-1 keys and PuTTY `.ppk` files
|
|
2859
|
+
are not supported and must be converted to an unencrypted PEM key first.
|
|
2860
|
+
x-celigo-ai-guidance:
|
|
2861
|
+
- Never take the key through chat; write a placeholder the user replaces in the connection editor. The matching public key must be in the server's authorized_keys for the username — Celigo holds only the private half.
|
|
2862
|
+
- A key whose first line is `-----BEGIN OPENSSH PRIVATE KEY-----`, or one that asks for a passphrase, is outside the supported format per the Help Center; `ssh-keygen -p -m PEM -f <key>` rewrites it as PEM (`-N ""` also removes the passphrase).
|
|
2857
2863
|
writeOnly: true
|
|
2858
2864
|
usePassiveMode:
|
|
2859
2865
|
type: boolean
|
package/dist/export.yml
CHANGED
|
@@ -923,6 +923,22 @@ components:
|
|
|
923
923
|
Not a webhook listener feature: on a `webhook` export the platform applies it only within each page, after
|
|
924
924
|
the request has been paged, and only to adjacent rows — the field is not offered for listeners in the UI.
|
|
925
925
|
x-celigo-ai-guidance:
|
|
926
|
+
- |-
|
|
927
|
+
Only adjacent rows with equal values merge — on an HTTP export and on a database export
|
|
928
|
+
alike, a row for key A, then key B, then key A again yields three groups. The platform's
|
|
929
|
+
`sortByFields` setting exists on file exports (`file.sortByFields`) and is ignored as a
|
|
930
|
+
top-level field on an HTTP or database export, so those sources must return same-key rows
|
|
931
|
+
already adjacent — on a database export the query's `ORDER BY` is what turns the three
|
|
932
|
+
groups into two.
|
|
933
|
+
- |-
|
|
934
|
+
Not accepted on a NetSuite export: the platform rejects it with `[invalid_config]
|
|
935
|
+
netsuite connection is not supported for groupByFields property`. A NetSuite saved
|
|
936
|
+
search groups through `netsuite.skipGrouping` (the UI's *Group rows*), keyed on the
|
|
937
|
+
record's internal id.
|
|
938
|
+
- |-
|
|
939
|
+
In `POST /v1/exports/preview` the grouped records are the `group` stage that follows
|
|
940
|
+
`parse` (mirrored in top-level `data`); the `parse` stage still holds the ungrouped
|
|
941
|
+
rows, so read `group` when it is present.
|
|
926
942
|
- |-
|
|
927
943
|
Never set this on a webhook listener to keep a request's rows together —
|
|
928
944
|
the listener pages the request's records at ``pageSize`` FIRST and then
|
|
@@ -10320,12 +10336,28 @@ components:
|
|
|
10320
10336
|
skipGrouping:
|
|
10321
10337
|
type: boolean
|
|
10322
10338
|
description: |-
|
|
10323
|
-
When true, each result row
|
|
10324
|
-
|
|
10339
|
+
When true, each saved-search result row becomes its own record. When false or omitted,
|
|
10340
|
+
consecutive result rows that share the record's internal id are grouped into one record
|
|
10341
|
+
shaped as an array of rows — the *Group rows* option in the UI.
|
|
10325
10342
|
x-celigo-ai-guidance:
|
|
10343
|
+
- |-
|
|
10344
|
+
A saved search that returns several rows per record (a sublist or multi-select column)
|
|
10345
|
+
is grouped by leaving this false or omitted: each record arrives as an array of its
|
|
10346
|
+
rows, every row carrying the same internal id as the record's trace key, and the
|
|
10347
|
+
preview reports no duplicate trace keys. With `true` the same search emits one object
|
|
10348
|
+
per row and the repeated internal ids surface as duplicate trace keys
|
|
10349
|
+
(`traceKeysDuplicate` in the preview). Grouping keys on the internal id only — a
|
|
10350
|
+
different key needs a `preSavePage` hook, which sees one page at a time.
|
|
10351
|
+
- |-
|
|
10352
|
+
Celigo's documentation requires the saved search to be sorted by Internal ID for
|
|
10353
|
+
grouping to apply.
|
|
10354
|
+
- |-
|
|
10355
|
+
The generic `groupByFields` setting is not the NetSuite mechanism: the platform rejects
|
|
10356
|
+
it on a NetSuite export with `[invalid_config] netsuite connection is not supported for
|
|
10357
|
+
groupByFields property`.
|
|
10326
10358
|
- |-
|
|
10327
10359
|
Set `true` for an ad-hoc RESTlet search (criteria and columns without a saved
|
|
10328
|
-
search): grouping needs the search sorted by
|
|
10360
|
+
search): grouping needs the search sorted by internal id, and an unsorted ad-hoc
|
|
10329
10361
|
search fails with `[search_not_sorted]`.
|
|
10330
10362
|
- 'For `exportSelect` / `refreshableSelect` dropdowns backed by a NetSuite RESTlet, set `skipGrouping: true`: the UI''s option mapper expects flat per-row results, and the platform otherwise wraps each row in its own grouping list (every option''s `label` then renders as `undefined`).'
|
|
10331
10363
|
statsOnly:
|
package/dist/mcp-server.yml
CHANGED
|
@@ -4671,14 +4671,20 @@ components:
|
|
|
4671
4671
|
x-celigo-ui-override: 'Required by the connection form: a password for ftp/ftps, or a password or SSH key (authKey) for sftp (see the if/then/else rule below). Encoded here to mirror the form so builders produce complete, connectable configurations.'
|
|
4672
4672
|
x-celigo-ai-guidance:
|
|
4673
4673
|
- For ftp/ftps set password; for sftp set password or authKey. The connection cannot authenticate without credentials.
|
|
4674
|
+
- For key-only sftp, omit password rather than filling it with a stand-in value — the form's required marker on Password does not apply once authKey is set, and the Help Center notes that servers enforcing a strict authentication order (public key first, then password) are not compatible with supplying both.
|
|
4674
4675
|
examples:
|
|
4675
4676
|
- s3cr3t-ftp-passw0rd
|
|
4676
4677
|
authKey:
|
|
4677
4678
|
type: string
|
|
4678
|
-
description:
|
|
4679
|
+
description: |-
|
|
4679
4680
|
SSH private key for SFTP key-based authentication (encrypted at rest; returned masked as `"******"`).
|
|
4680
|
-
Only used when type is "sftp".
|
|
4681
|
-
|
|
4681
|
+
Only used when type is "sftp"; can be used alone or alongside a password. Must be an RSA (SSH-2) key
|
|
4682
|
+
in PEM format, supplied whole from its BEGIN line to its END line — OpenSSH-format keys (first line
|
|
4683
|
+
`-----BEGIN OPENSSH PRIVATE KEY-----`), passphrase-protected keys, SSH-1 keys and PuTTY `.ppk` files
|
|
4684
|
+
are not supported and must be converted to an unencrypted PEM key first.
|
|
4685
|
+
x-celigo-ai-guidance:
|
|
4686
|
+
- Never take the key through chat; write a placeholder the user replaces in the connection editor. The matching public key must be in the server's authorized_keys for the username — Celigo holds only the private half.
|
|
4687
|
+
- A key whose first line is `-----BEGIN OPENSSH PRIVATE KEY-----`, or one that asks for a passphrase, is outside the supported format per the Help Center; `ssh-keygen -p -m PEM -f <key>` rewrites it as PEM (`-N ""` also removes the passphrase).
|
|
4682
4688
|
writeOnly: true
|
|
4683
4689
|
usePassiveMode:
|
|
4684
4690
|
type: boolean
|
package/dist/tool.yml
CHANGED
|
@@ -8000,14 +8000,20 @@ components:
|
|
|
8000
8000
|
x-celigo-ui-override: 'Required by the connection form: a password for ftp/ftps, or a password or SSH key (authKey) for sftp (see the if/then/else rule below). Encoded here to mirror the form so builders produce complete, connectable configurations.'
|
|
8001
8001
|
x-celigo-ai-guidance:
|
|
8002
8002
|
- For ftp/ftps set password; for sftp set password or authKey. The connection cannot authenticate without credentials.
|
|
8003
|
+
- For key-only sftp, omit password rather than filling it with a stand-in value — the form's required marker on Password does not apply once authKey is set, and the Help Center notes that servers enforcing a strict authentication order (public key first, then password) are not compatible with supplying both.
|
|
8003
8004
|
examples:
|
|
8004
8005
|
- s3cr3t-ftp-passw0rd
|
|
8005
8006
|
authKey:
|
|
8006
8007
|
type: string
|
|
8007
|
-
description:
|
|
8008
|
+
description: |-
|
|
8008
8009
|
SSH private key for SFTP key-based authentication (encrypted at rest; returned masked as `"******"`).
|
|
8009
|
-
Only used when type is "sftp".
|
|
8010
|
-
|
|
8010
|
+
Only used when type is "sftp"; can be used alone or alongside a password. Must be an RSA (SSH-2) key
|
|
8011
|
+
in PEM format, supplied whole from its BEGIN line to its END line — OpenSSH-format keys (first line
|
|
8012
|
+
`-----BEGIN OPENSSH PRIVATE KEY-----`), passphrase-protected keys, SSH-1 keys and PuTTY `.ppk` files
|
|
8013
|
+
are not supported and must be converted to an unencrypted PEM key first.
|
|
8014
|
+
x-celigo-ai-guidance:
|
|
8015
|
+
- Never take the key through chat; write a placeholder the user replaces in the connection editor. The matching public key must be in the server's authorized_keys for the username — Celigo holds only the private half.
|
|
8016
|
+
- A key whose first line is `-----BEGIN OPENSSH PRIVATE KEY-----`, or one that asks for a passphrase, is outside the supported format per the Help Center; `ssh-keygen -p -m PEM -f <key>` rewrites it as PEM (`-N ""` also removes the passphrase).
|
|
8011
8017
|
writeOnly: true
|
|
8012
8018
|
usePassiveMode:
|
|
8013
8019
|
type: boolean
|
|
@@ -25439,6 +25445,22 @@ components:
|
|
|
25439
25445
|
Not a webhook listener feature: on a `webhook` export the platform applies it only within each page, after
|
|
25440
25446
|
the request has been paged, and only to adjacent rows — the field is not offered for listeners in the UI.
|
|
25441
25447
|
x-celigo-ai-guidance:
|
|
25448
|
+
- |-
|
|
25449
|
+
Only adjacent rows with equal values merge — on an HTTP export and on a database export
|
|
25450
|
+
alike, a row for key A, then key B, then key A again yields three groups. The platform's
|
|
25451
|
+
`sortByFields` setting exists on file exports (`file.sortByFields`) and is ignored as a
|
|
25452
|
+
top-level field on an HTTP or database export, so those sources must return same-key rows
|
|
25453
|
+
already adjacent — on a database export the query's `ORDER BY` is what turns the three
|
|
25454
|
+
groups into two.
|
|
25455
|
+
- |-
|
|
25456
|
+
Not accepted on a NetSuite export: the platform rejects it with `[invalid_config]
|
|
25457
|
+
netsuite connection is not supported for groupByFields property`. A NetSuite saved
|
|
25458
|
+
search groups through `netsuite.skipGrouping` (the UI's *Group rows*), keyed on the
|
|
25459
|
+
record's internal id.
|
|
25460
|
+
- |-
|
|
25461
|
+
In `POST /v1/exports/preview` the grouped records are the `group` stage that follows
|
|
25462
|
+
`parse` (mirrored in top-level `data`); the `parse` stage still holds the ungrouped
|
|
25463
|
+
rows, so read `group` when it is present.
|
|
25442
25464
|
- |-
|
|
25443
25465
|
Never set this on a webhook listener to keep a request's rows together —
|
|
25444
25466
|
the listener pages the request's records at ``pageSize`` FIRST and then
|
|
@@ -34419,12 +34441,28 @@ components:
|
|
|
34419
34441
|
skipGrouping:
|
|
34420
34442
|
type: boolean
|
|
34421
34443
|
description: |-
|
|
34422
|
-
When true, each result row
|
|
34423
|
-
|
|
34444
|
+
When true, each saved-search result row becomes its own record. When false or omitted,
|
|
34445
|
+
consecutive result rows that share the record's internal id are grouped into one record
|
|
34446
|
+
shaped as an array of rows — the *Group rows* option in the UI.
|
|
34424
34447
|
x-celigo-ai-guidance:
|
|
34448
|
+
- |-
|
|
34449
|
+
A saved search that returns several rows per record (a sublist or multi-select column)
|
|
34450
|
+
is grouped by leaving this false or omitted: each record arrives as an array of its
|
|
34451
|
+
rows, every row carrying the same internal id as the record's trace key, and the
|
|
34452
|
+
preview reports no duplicate trace keys. With `true` the same search emits one object
|
|
34453
|
+
per row and the repeated internal ids surface as duplicate trace keys
|
|
34454
|
+
(`traceKeysDuplicate` in the preview). Grouping keys on the internal id only — a
|
|
34455
|
+
different key needs a `preSavePage` hook, which sees one page at a time.
|
|
34456
|
+
- |-
|
|
34457
|
+
Celigo's documentation requires the saved search to be sorted by Internal ID for
|
|
34458
|
+
grouping to apply.
|
|
34459
|
+
- |-
|
|
34460
|
+
The generic `groupByFields` setting is not the NetSuite mechanism: the platform rejects
|
|
34461
|
+
it on a NetSuite export with `[invalid_config] netsuite connection is not supported for
|
|
34462
|
+
groupByFields property`.
|
|
34425
34463
|
- |-
|
|
34426
34464
|
Set `true` for an ad-hoc RESTlet search (criteria and columns without a saved
|
|
34427
|
-
search): grouping needs the search sorted by
|
|
34465
|
+
search): grouping needs the search sorted by internal id, and an unsorted ad-hoc
|
|
34428
34466
|
search fails with `[search_not_sorted]`.
|
|
34429
34467
|
- 'For `exportSelect` / `refreshableSelect` dropdowns backed by a NetSuite RESTlet, set `skipGrouping: true`: the UI''s option mapper expects flat per-row results, and the platform otherwise wraps each row in its own grouping list (every option''s `label` then renders as `undefined`).'
|
|
34430
34468
|
statsOnly:
|
package/package.json
CHANGED