@celigo/api-specs 0.2.117 → 0.2.118
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/sync.yml +33 -8
- package/package.json +1 -1
- package/schemas.json +1 -1
package/dist/sync.yml
CHANGED
|
@@ -2547,6 +2547,11 @@ paths:
|
|
|
2547
2547
|
Returns the catalog of applications that can be used as the **source** of a sync — the system
|
|
2548
2548
|
a sync extracts records from. Use the returned `id` as the source application when building a
|
|
2549
2549
|
sync, and `category` to group the options in a picker.
|
|
2550
|
+
|
|
2551
|
+
The list is the set of applications that offer object-based extraction (a browsable catalog of
|
|
2552
|
+
tables/objects, no export resource needed); HTTP connectors join it as they are enabled, so read
|
|
2553
|
+
it at build time rather than caching it. An application missing from the list can still feed a
|
|
2554
|
+
sync through export-backed datasets — see `GET /v1/di/metadata/connections/{_connectionId}/datasets`.
|
|
2550
2555
|
tags:
|
|
2551
2556
|
- Syncs
|
|
2552
2557
|
operationId: listSyncSources
|
|
@@ -2565,7 +2570,10 @@ paths:
|
|
|
2565
2570
|
properties:
|
|
2566
2571
|
id:
|
|
2567
2572
|
type: string
|
|
2568
|
-
description:
|
|
2573
|
+
description: |-
|
|
2574
|
+
Application identifier to use as the sync source. For HTTP-connector-backed
|
|
2575
|
+
sources this is the connector's display name, identical to `displayName`
|
|
2576
|
+
(for example `Stripe`, `Loop Returns`), not a lowercase key.
|
|
2569
2577
|
examples:
|
|
2570
2578
|
- salesforce
|
|
2571
2579
|
category:
|
|
@@ -2621,7 +2629,7 @@ paths:
|
|
|
2621
2629
|
category: Sales & Marketing
|
|
2622
2630
|
- id: netsuite
|
|
2623
2631
|
category: Sales & Marketing
|
|
2624
|
-
- id:
|
|
2632
|
+
- id: Stripe
|
|
2625
2633
|
category: HTTP Connector
|
|
2626
2634
|
displayName: Stripe
|
|
2627
2635
|
source: httpConnectorMetadata
|
|
@@ -2740,7 +2748,14 @@ paths:
|
|
|
2740
2748
|
properties:
|
|
2741
2749
|
datasets:
|
|
2742
2750
|
type: array
|
|
2743
|
-
description:
|
|
2751
|
+
description: |-
|
|
2752
|
+
Tables/objects the source application exposes. Present unless `type` is `exports`.
|
|
2753
|
+
Empty — with a `200`, not an error — when the connection offers no object-based
|
|
2754
|
+
extraction: an HTTP connector that `GET /v1/di/metadata/sources` does not list, an
|
|
2755
|
+
HTTP connection with no connector, or a connection on a listed connector whose API
|
|
2756
|
+
or version is not the one the sources entry names (`httpConnector._apiId` /
|
|
2757
|
+
`_versionId`). Such a connection feeds a sync only through export-backed datasets
|
|
2758
|
+
(`exports`).
|
|
2744
2759
|
items:
|
|
2745
2760
|
type: object
|
|
2746
2761
|
description: One syncable table/object in the source application.
|
|
@@ -3878,8 +3893,13 @@ components:
|
|
|
3878
3893
|
format: objectId
|
|
3879
3894
|
x-celigo-refModel: connections
|
|
3880
3895
|
description: |-
|
|
3881
|
-
Connection to the source application.
|
|
3882
|
-
|
|
3896
|
+
Connection to the source application. Any application can be the source; the
|
|
3897
|
+
connection's dataset mode is read from
|
|
3898
|
+
`GET /v1/di/metadata/connections/{_connectionId}/datasets`: a non-empty
|
|
3899
|
+
`datasets` array is object mode, an empty one means the connection feeds the
|
|
3900
|
+
sync through export-backed datasets (`isExport: true`) only — including a
|
|
3901
|
+
connection on a listed HTTP connector whose API or version is not the one
|
|
3902
|
+
`GET /v1/di/metadata/sources` names.
|
|
3883
3903
|
examples:
|
|
3884
3904
|
- 6a2a95909e994395f3c2a4e6
|
|
3885
3905
|
destination:
|
|
@@ -4063,9 +4083,14 @@ components:
|
|
|
4063
4083
|
format: objectId
|
|
4064
4084
|
x-celigo-refModel: connections
|
|
4065
4085
|
description: |-
|
|
4066
|
-
Connection to the source application.
|
|
4067
|
-
|
|
4068
|
-
|
|
4086
|
+
Connection to the source application. Any application can be the source; the
|
|
4087
|
+
connection's dataset mode is read from
|
|
4088
|
+
`GET /v1/di/metadata/connections/{_connectionId}/datasets`: a non-empty
|
|
4089
|
+
`datasets` array is object mode, an empty one means the connection feeds the
|
|
4090
|
+
sync through export-backed datasets (`isExport: true`) only — including a
|
|
4091
|
+
connection on a listed HTTP connector whose API or version is not the one
|
|
4092
|
+
`GET /v1/di/metadata/sources` names. Omitting it fails with
|
|
4093
|
+
`422 missing_source_connection`.
|
|
4069
4094
|
examples:
|
|
4070
4095
|
- 6a2a95909e994395f3c2a4e6
|
|
4071
4096
|
destination:
|
package/package.json
CHANGED