@celigo/api-specs 0.2.108 → 0.2.109

package/dist/export.yml

@@ -923,6 +923,22 @@ components:
         Not a webhook listener feature: on a `webhook` export the platform applies it only within each page, after
         the request has been paged, and only to adjacent rows — the field is not offered for listeners in the UI.
       x-celigo-ai-guidance:
+        - |-
+          Only adjacent rows with equal values merge — on an HTTP export and on a database export
+          alike, a row for key A, then key B, then key A again yields three groups. The platform's
+          `sortByFields` setting exists on file exports (`file.sortByFields`) and is ignored as a
+          top-level field on an HTTP or database export, so those sources must return same-key rows
+          already adjacent — on a database export the query's `ORDER BY` is what turns the three
+          groups into two.
+        - |-
+          Not accepted on a NetSuite export: the platform rejects it with `[invalid_config]
+          netsuite connection is not supported for groupByFields property`. A NetSuite saved
+          search groups through `netsuite.skipGrouping` (the UI's *Group rows*), keyed on the
+          record's internal id.
+        - |-
+          In `POST /v1/exports/preview` the grouped records are the `group` stage that follows
+          `parse` (mirrored in top-level `data`); the `parse` stage still holds the ungrouped
+          rows, so read `group` when it is present.
         - |-
           Never set this on a webhook listener to keep a request's rows together —
           the listener pages the request's records at ``pageSize`` FIRST and then
@@ -10320,12 +10336,28 @@ components:
         skipGrouping:
           type: boolean
           description: |-
-            When true, each result row is processed individually instead of being aggregated with
-            related rows. When false or omitted, related rows are grouped before processing.
+            When true, each saved-search result row becomes its own record. When false or omitted,
+            consecutive result rows that share the record's internal id are grouped into one record
+            shaped as an array of rows — the *Group rows* option in the UI.
           x-celigo-ai-guidance:
+            - |-
+              A saved search that returns several rows per record (a sublist or multi-select column)
+              is grouped by leaving this false or omitted: each record arrives as an array of its
+              rows, every row carrying the same internal id as the record's trace key, and the
+              preview reports no duplicate trace keys. With `true` the same search emits one object
+              per row and the repeated internal ids surface as duplicate trace keys
+              (`traceKeysDuplicate` in the preview). Grouping keys on the internal id only — a
+              different key needs a `preSavePage` hook, which sees one page at a time.
+            - |-
+              Celigo's documentation requires the saved search to be sorted by Internal ID for
+              grouping to apply.
+            - |-
+              The generic `groupByFields` setting is not the NetSuite mechanism: the platform rejects
+              it on a NetSuite export with `[invalid_config] netsuite connection is not supported for
+              groupByFields property`.
             - |-
               Set `true` for an ad-hoc RESTlet search (criteria and columns without a saved
-              search): grouping needs the search sorted by the grouping key, and an unsorted ad-hoc
+              search): grouping needs the search sorted by internal id, and an unsorted ad-hoc
               search fails with `[search_not_sorted]`.
             - '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`).'
         statsOnly:

package/dist/tool.yml

@@ -25445,6 +25445,22 @@ components:
         Not a webhook listener feature: on a `webhook` export the platform applies it only within each page, after
         the request has been paged, and only to adjacent rows — the field is not offered for listeners in the UI.
       x-celigo-ai-guidance:
+        - |-
+          Only adjacent rows with equal values merge — on an HTTP export and on a database export
+          alike, a row for key A, then key B, then key A again yields three groups. The platform's
+          `sortByFields` setting exists on file exports (`file.sortByFields`) and is ignored as a
+          top-level field on an HTTP or database export, so those sources must return same-key rows
+          already adjacent — on a database export the query's `ORDER BY` is what turns the three
+          groups into two.
+        - |-
+          Not accepted on a NetSuite export: the platform rejects it with `[invalid_config]
+          netsuite connection is not supported for groupByFields property`. A NetSuite saved
+          search groups through `netsuite.skipGrouping` (the UI's *Group rows*), keyed on the
+          record's internal id.
+        - |-
+          In `POST /v1/exports/preview` the grouped records are the `group` stage that follows
+          `parse` (mirrored in top-level `data`); the `parse` stage still holds the ungrouped
+          rows, so read `group` when it is present.
         - |-
           Never set this on a webhook listener to keep a request's rows together —
           the listener pages the request's records at ``pageSize`` FIRST and then
@@ -34425,12 +34441,28 @@ components:
         skipGrouping:
           type: boolean
           description: |-
-            When true, each result row is processed individually instead of being aggregated with
-            related rows. When false or omitted, related rows are grouped before processing.
+            When true, each saved-search result row becomes its own record. When false or omitted,
+            consecutive result rows that share the record's internal id are grouped into one record
+            shaped as an array of rows — the *Group rows* option in the UI.
           x-celigo-ai-guidance:
+            - |-
+              A saved search that returns several rows per record (a sublist or multi-select column)
+              is grouped by leaving this false or omitted: each record arrives as an array of its
+              rows, every row carrying the same internal id as the record's trace key, and the
+              preview reports no duplicate trace keys. With `true` the same search emits one object
+              per row and the repeated internal ids surface as duplicate trace keys
+              (`traceKeysDuplicate` in the preview). Grouping keys on the internal id only — a
+              different key needs a `preSavePage` hook, which sees one page at a time.
+            - |-
+              Celigo's documentation requires the saved search to be sorted by Internal ID for
+              grouping to apply.
+            - |-
+              The generic `groupByFields` setting is not the NetSuite mechanism: the platform rejects
+              it on a NetSuite export with `[invalid_config] netsuite connection is not supported for
+              groupByFields property`.
             - |-
               Set `true` for an ad-hoc RESTlet search (criteria and columns without a saved
-              search): grouping needs the search sorted by the grouping key, and an unsorted ad-hoc
+              search): grouping needs the search sorted by internal id, and an unsorted ad-hoc
               search fails with `[search_not_sorted]`.
             - '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`).'
         statsOnly:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@celigo/api-specs",
-  "version": "0.2.108",
+  "version": "0.2.109",
   "private": false,
   "description": "Public OpenAPI bundles (dist/) and the celigo-cli lint schema pack (schemas.json).",
   "keywords": [

package/schemas.json

@@ -1,7 +1,7 @@
 {
 	"provenance": {
 		"repo": "celigo/integrator-api-specs",
-		"iasCommit": "79679bbe",
+		"iasCommit": "9dfc0b9c",
 		"generatedAt": "2026-10-14"
 	},
 	"roots": {