@celigo/api-specs 0.2.23 → 0.2.25

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/ai-agent.yml CHANGED
@@ -4958,11 +4958,6 @@ components:
4958
4958
  `hooks.preSavePage` script, or for a file-definition export make the repeating segment the
4959
4959
  record boundary in the definition's rules.
4960
4960
  x-celigo-ai-guidance:
4961
- - |-
4962
- Two modes, decided by the SHAPE of the record entering the step. Object record with a child
4963
- array under a field → set ``pathToMany`` to that field. Array record (a ``groupByFields``
4964
- export, a CSV/file group, a script that returns an array) → leave ``pathToMany`` blank; each
4965
- element becomes one record. Live-verified 2026-09-10 on flows, Tools, and APIs.
4966
4961
  - |-
4967
4962
  Only imports and lookups (exports placed as page processors) fan out. On a standalone export
4968
4963
  (a flow's page generator) the API saves ``oneToMany`` / ``pathToMany`` and applies neither:
@@ -4971,6 +4966,12 @@ components:
4971
4966
  the setting on the export, and as THREE child records with the same setting on the import.
4972
4967
  Never propose these fields as the way to split a standalone export's records; that is
4973
4968
  ``hooks.preSavePage`` work (or, for a file definition, the definition's record boundary).
4969
+ The rules below apply only on a step that receives a record.
4970
+ - |-
4971
+ Two modes, decided by the SHAPE of the record entering the step. Object record with a child
4972
+ array under a field → set ``pathToMany`` to that field. Array record (a ``groupByFields``
4973
+ export, a CSV/file group, a script that returns an array) → leave ``pathToMany`` blank; each
4974
+ element becomes one record. Live-verified 2026-09-10 on flows, Tools, and APIs.
4974
4975
  - |-
4975
4976
  Blank ``pathToMany`` on an OBJECT record fails every record with code ``oneToMany_error``:
4976
4977
  "Failed to extract child records from oneToMany import data. Record at index 0 was not an
package/dist/api.yml CHANGED
@@ -3001,14 +3001,37 @@ components:
3001
3001
  - Customer API
3002
3002
  - Order Management API
3003
3003
  _integrationId:
3004
- type: string
3004
+ type:
3005
+ - string
3006
+ - 'null'
3005
3007
  format: objectId
3006
3008
  x-celigo-refModel: integrations
3007
- description: Integration this API belongs to. Omitted for standalone APIs (an API can be created without an integration).
3009
+ description: |-
3010
+ Integration this API belongs to. **Builder mode only** — a script-mode
3011
+ API is always account-level and the server silently drops this field.
3012
+ Send `null` (or omit) to keep the API account-level; on reads the field
3013
+ is omitted when unset, never `null`.
3008
3014
  examples:
3009
3015
  - 5e9a8f7c6b3d2a0011c4e5f6
3010
3016
  x-celigo-ai-guidance:
3011
3017
  - To move the API to a different integration, PUT with a changed _integrationId; the platform registers the API's step connections in the target integration on save.
3018
+ - |-
3019
+ PUT is a full replace: omitting _integrationId (or sending null) on an
3020
+ integration-owned API moves it back to the account level and clears
3021
+ _apiGroupingId with it.
3022
+ _apiGroupingId:
3023
+ type:
3024
+ - string
3025
+ - 'null'
3026
+ format: objectId
3027
+ description: |-
3028
+ One of the owning integration's `apiGroupings`, subdividing its APIs.
3029
+ Requires `_integrationId` in the same write — sent without it, the server
3030
+ silently drops both — so builder mode only. `PUT /v1/apis/updateApiGrouping`
3031
+ regroups many APIs at once; this field carries the same value on a single
3032
+ API. On reads the field is omitted when unset, never `null`.
3033
+ examples:
3034
+ - 60a1b2c3d4e5f60012345678
3012
3035
  description:
3013
3036
  type: string
3014
3037
  description: Optional description of the API's purpose.
@@ -3208,18 +3231,6 @@ components:
3208
3231
  description: Unique identifier for the API.
3209
3232
  examples:
3210
3233
  - 68ae4264b5f755d2dd3796b4
3211
- _apiGroupingId:
3212
- type:
3213
- - string
3214
- - 'null'
3215
- format: objectId
3216
- readOnly: true
3217
- description: |-
3218
- API grouping this API belongs to. Set only via
3219
- `PUT /apis/grouping`; the server ignores this field in POST/PUT
3220
- bodies on this resource. May be `null` after ungrouping.
3221
- examples:
3222
- - 60a1b2c3d4e5f60012345678
3223
3234
  _scriptId:
3224
3235
  type: string
3225
3236
  format: objectId
@@ -927,6 +927,87 @@ paths:
927
927
  Deletes a connection permanently. This operation cannot be undone.
928
928
  The connection must not be in use by any active flows or integrations.
929
929
  /v1/connections/{_id}/ping:
930
+ get:
931
+ x-internal: false
932
+ summary: Ping an existing connection via GET
933
+ description: |-
934
+ GET variant of the saved-connection ping — identical behavior to
935
+ `POST /v1/connections/{_id}/ping`, with no request body to send. Runs the adaptor's ping
936
+ routine against the connection identified by `_id` to verify its credentials and network
937
+ configuration still work; no data is read, written, or modified.
938
+
939
+ Inspect the response body, not the HTTP status, to determine the outcome: success and
940
+ adaptor-level failures both return HTTP 200 — success is `{code: 200}`, failures are
941
+ `{errors: [...]}`. The only non-success status is 404, when `_id` does not resolve to a
942
+ connection.
943
+ operationId: pingConnectionByGet
944
+ tags:
945
+ - Connections
946
+ parameters:
947
+ - in: path
948
+ name: _id
949
+ required: true
950
+ schema:
951
+ type: string
952
+ format: objectId
953
+ x-celigo-refModel: connections
954
+ description: Connection ID to ping.
955
+ responses:
956
+ '200':
957
+ description: |-
958
+ Ping executed. **Inspect the body** to determine outcome — success and
959
+ adaptor-level failures both return HTTP 200. Success returns
960
+ `{code: 200}`; adaptor-level failures return `{errors: [...]}`.
961
+ content:
962
+ application/json:
963
+ schema:
964
+ oneOf:
965
+ - title: Ping success
966
+ type: object
967
+ required:
968
+ - code
969
+ properties:
970
+ code:
971
+ type: integer
972
+ description: Mirrors the HTTP status — always 200 on success.
973
+ example: 200
974
+ additionalProperties: true
975
+ - $ref: '#/components/schemas/Error'
976
+ examples:
977
+ success:
978
+ summary: Connection reachable
979
+ value:
980
+ code: 200
981
+ dns_failure:
982
+ summary: Connection's baseURI host could not be resolved
983
+ value:
984
+ errors:
985
+ - code: invalid_host
986
+ message: 'Unknown host: api.example.invalid. We were unable to verify this host using a DNS lookup.'
987
+ source: resource
988
+ '401':
989
+ $ref: '#/components/responses/401-unauthorized'
990
+ '404':
991
+ description: |-
992
+ No connection found for the given `_id`. The body is an `invalid_ref`
993
+ error — note this is a 404, not a 400, and the field pointer is `_id`.
994
+ content:
995
+ application/json:
996
+ schema:
997
+ $ref: '#/components/schemas/Error'
998
+ examples:
999
+ invalid_ref:
1000
+ value:
1001
+ errors:
1002
+ - field: _id
1003
+ code: invalid_ref
1004
+ message: unable to find connection for the given id.
1005
+ x-celigo-ai-guidance:
1006
+ - |-
1007
+ Behaves identically to POST /v1/connections/{_id}/ping and takes no request body — use
1008
+ whichever verb the client supports. Both verbs return HTTP 200 with {code: 200} on
1009
+ success and HTTP 200 with {errors: [...]} on adaptor-level failure, so inspect the body,
1010
+ not the status code.
930
1011
  post:
931
1012
  x-internal: false
932
1013
  summary: Ping an existing connection
@@ -1047,13 +1047,13 @@ components:
1047
1047
  - rejected
1048
1048
  - failed
1049
1049
  x-enumDescriptions:
1050
- inProgress: Acknowledgment is pending from the trading partner
1051
- notApplicable: Transaction type does not require a functional acknowledgment
1052
- notReceived: Acknowledgment window expired without a response
1053
- accepted: Trading partner accepted the transaction without errors
1054
- acceptedWithErrors: Trading partner accepted but reported non-fatal errors
1055
- rejected: Trading partner rejected the transaction entirely
1056
- failed: Acknowledgment processing failed due to a system error
1050
+ inProgress: Awaiting functional acknowledgment from the trading partner.
1051
+ notApplicable: No functional acknowledgment expected — the document is itself an FA, or the trading partner does not require one.
1052
+ notReceived: Functional acknowledgment expected but not yet received.
1053
+ accepted: Functional acknowledgment received and transaction was accepted.
1054
+ acceptedWithErrors: Functional acknowledgment received with errors but transaction was accepted.
1055
+ rejected: Functional acknowledgment received and transaction was rejected.
1056
+ failed: Functional acknowledgment processing failed.
1057
1057
  description: |-
1058
1058
  Filter by functional acknowledgment status. Pass an array of one or
1059
1059
  more values to match. Must be an array, not a bare string. Omit to
package/dist/export.yml CHANGED
@@ -810,11 +810,6 @@ components:
810
810
  `hooks.preSavePage` script, or for a file-definition export make the repeating segment the
811
811
  record boundary in the definition's rules.
812
812
  x-celigo-ai-guidance:
813
- - |-
814
- Two modes, decided by the SHAPE of the record entering the step. Object record with a child
815
- array under a field → set ``pathToMany`` to that field. Array record (a ``groupByFields``
816
- export, a CSV/file group, a script that returns an array) → leave ``pathToMany`` blank; each
817
- element becomes one record. Live-verified 2026-09-10 on flows, Tools, and APIs.
818
813
  - |-
819
814
  Only imports and lookups (exports placed as page processors) fan out. On a standalone export
820
815
  (a flow's page generator) the API saves ``oneToMany`` / ``pathToMany`` and applies neither:
@@ -823,6 +818,12 @@ components:
823
818
  the setting on the export, and as THREE child records with the same setting on the import.
824
819
  Never propose these fields as the way to split a standalone export's records; that is
825
820
  ``hooks.preSavePage`` work (or, for a file definition, the definition's record boundary).
821
+ The rules below apply only on a step that receives a record.
822
+ - |-
823
+ Two modes, decided by the SHAPE of the record entering the step. Object record with a child
824
+ array under a field → set ``pathToMany`` to that field. Array record (a ``groupByFields``
825
+ export, a CSV/file group, a script that returns an array) → leave ``pathToMany`` blank; each
826
+ element becomes one record. Live-verified 2026-09-10 on flows, Tools, and APIs.
826
827
  - |-
827
828
  Blank ``pathToMany`` on an OBJECT record fails every record with code ``oneToMany_error``:
828
829
  "Failed to extract child records from oneToMany import data. Record at index 0 was not an
@@ -15528,6 +15529,8 @@ components:
15528
15529
  - prepareFormData
15529
15530
  _scriptId:
15530
15531
  type: string
15532
+ format: objectId
15533
+ x-celigo-refModel: scripts
15531
15534
  description: |
15532
15535
  Reference to a predefined script resource containing the initialization function.
15533
15536
 
@@ -15740,6 +15743,8 @@ components:
15740
15743
  - prepareResourceForSave
15741
15744
  _scriptId:
15742
15745
  type: string
15746
+ format: objectId
15747
+ x-celigo-refModel: scripts
15743
15748
  description: |
15744
15749
  Reference to a predefined script resource containing the preSave function.
15745
15750
 
package/dist/import.yml CHANGED
@@ -10592,11 +10592,6 @@ components:
10592
10592
  `hooks.preSavePage` script, or for a file-definition export make the repeating segment the
10593
10593
  record boundary in the definition's rules.
10594
10594
  x-celigo-ai-guidance:
10595
- - |-
10596
- Two modes, decided by the SHAPE of the record entering the step. Object record with a child
10597
- array under a field → set ``pathToMany`` to that field. Array record (a ``groupByFields``
10598
- export, a CSV/file group, a script that returns an array) → leave ``pathToMany`` blank; each
10599
- element becomes one record. Live-verified 2026-09-10 on flows, Tools, and APIs.
10600
10595
  - |-
10601
10596
  Only imports and lookups (exports placed as page processors) fan out. On a standalone export
10602
10597
  (a flow's page generator) the API saves ``oneToMany`` / ``pathToMany`` and applies neither:
@@ -10605,6 +10600,12 @@ components:
10605
10600
  the setting on the export, and as THREE child records with the same setting on the import.
10606
10601
  Never propose these fields as the way to split a standalone export's records; that is
10607
10602
  ``hooks.preSavePage`` work (or, for a file definition, the definition's record boundary).
10603
+ The rules below apply only on a step that receives a record.
10604
+ - |-
10605
+ Two modes, decided by the SHAPE of the record entering the step. Object record with a child
10606
+ array under a field → set ``pathToMany`` to that field. Array record (a ``groupByFields``
10607
+ export, a CSV/file group, a script that returns an array) → leave ``pathToMany`` blank; each
10608
+ element becomes one record. Live-verified 2026-09-10 on flows, Tools, and APIs.
10608
10609
  - |-
10609
10610
  Blank ``pathToMany`` on an OBJECT record fails every record with code ``oneToMany_error``:
10610
10611
  "Failed to extract child records from oneToMany import data. Record at index 0 was not an
@@ -13856,6 +13857,8 @@ components:
13856
13857
  - prepareFormData
13857
13858
  _scriptId:
13858
13859
  type: string
13860
+ format: objectId
13861
+ x-celigo-refModel: scripts
13859
13862
  description: |
13860
13863
  Reference to a predefined script resource containing the initialization function.
13861
13864
 
@@ -13924,6 +13927,8 @@ components:
13924
13927
  - prepareResourceForSave
13925
13928
  _scriptId:
13926
13929
  type: string
13930
+ format: objectId
13931
+ x-celigo-refModel: scripts
13927
13932
  description: |
13928
13933
  Reference to a predefined script resource containing the preSave function.
13929
13934
 
@@ -2751,6 +2751,8 @@ components:
2751
2751
  - prepareFormData
2752
2752
  _scriptId:
2753
2753
  type: string
2754
+ format: objectId
2755
+ x-celigo-refModel: scripts
2754
2756
  description: |
2755
2757
  Reference to a predefined script resource containing the initialization function.
2756
2758
 
@@ -2819,6 +2821,8 @@ components:
2819
2821
  - prepareResourceForSave
2820
2822
  _scriptId:
2821
2823
  type: string
2824
+ format: objectId
2825
+ x-celigo-refModel: scripts
2822
2826
  description: |
2823
2827
  Reference to a predefined script resource containing the preSave function.
2824
2828
 
package/dist/tool.yml CHANGED
@@ -19450,11 +19450,6 @@ components:
19450
19450
  `hooks.preSavePage` script, or for a file-definition export make the repeating segment the
19451
19451
  record boundary in the definition's rules.
19452
19452
  x-celigo-ai-guidance:
19453
- - |-
19454
- Two modes, decided by the SHAPE of the record entering the step. Object record with a child
19455
- array under a field → set ``pathToMany`` to that field. Array record (a ``groupByFields``
19456
- export, a CSV/file group, a script that returns an array) → leave ``pathToMany`` blank; each
19457
- element becomes one record. Live-verified 2026-09-10 on flows, Tools, and APIs.
19458
19453
  - |-
19459
19454
  Only imports and lookups (exports placed as page processors) fan out. On a standalone export
19460
19455
  (a flow's page generator) the API saves ``oneToMany`` / ``pathToMany`` and applies neither:
@@ -19463,6 +19458,12 @@ components:
19463
19458
  the setting on the export, and as THREE child records with the same setting on the import.
19464
19459
  Never propose these fields as the way to split a standalone export's records; that is
19465
19460
  ``hooks.preSavePage`` work (or, for a file definition, the definition's record boundary).
19461
+ The rules below apply only on a step that receives a record.
19462
+ - |-
19463
+ Two modes, decided by the SHAPE of the record entering the step. Object record with a child
19464
+ array under a field → set ``pathToMany`` to that field. Array record (a ``groupByFields``
19465
+ export, a CSV/file group, a script that returns an array) → leave ``pathToMany`` blank; each
19466
+ element becomes one record. Live-verified 2026-09-10 on flows, Tools, and APIs.
19466
19467
  - |-
19467
19468
  Blank ``pathToMany`` on an OBJECT record fails every record with code ``oneToMany_error``:
19468
19469
  "Failed to extract child records from oneToMany import data. Record at index 0 was not an
@@ -20635,6 +20636,8 @@ components:
20635
20636
  - prepareFormData
20636
20637
  _scriptId:
20637
20638
  type: string
20639
+ format: objectId
20640
+ x-celigo-refModel: scripts
20638
20641
  description: |
20639
20642
  Reference to a predefined script resource containing the initialization function.
20640
20643
 
@@ -20703,6 +20706,8 @@ components:
20703
20706
  - prepareResourceForSave
20704
20707
  _scriptId:
20705
20708
  type: string
20709
+ format: objectId
20710
+ x-celigo-refModel: scripts
20706
20711
  description: |
20707
20712
  Reference to a predefined script resource containing the preSave function.
20708
20713
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@celigo/api-specs",
3
- "version": "0.2.23",
3
+ "version": "0.2.25",
4
4
  "private": false,
5
5
  "description": "Public OpenAPI bundles (dist/) and the celigo-cli lint schema pack (schemas.json).",
6
6
  "keywords": [
package/schemas.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "provenance": {
3
3
  "repo": "celigo/integrator-api-specs",
4
- "iasCommit": "ed5e198",
4
+ "iasCommit": "a1f6b8b",
5
5
  "generatedAt": "2026-09-18"
6
6
  },
7
7
  "roots": {
@@ -1629,7 +1629,8 @@
1629
1629
  "object"
1630
1630
  ],
1631
1631
  "p": {
1632
- "_integrationId": 1,
1632
+ "_apiGroupingId": 88,
1633
+ "_integrationId": 88,
1633
1634
  "builder": 162,
1634
1635
  "description": 1,
1635
1636
  "disabled": 9,
@@ -2058,7 +2059,7 @@
2058
2059
  "p": {
2059
2060
  "_apiGroupingId": 88,
2060
2061
  "_id": 1,
2061
- "_integrationId": 1,
2062
+ "_integrationId": 88,
2062
2063
  "_scriptId": 1,
2063
2064
  "_templateId": 1,
2064
2065
  "apim": 199,