@celigo/api-specs 0.2.30 → 0.2.31
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 +60 -16
- package/package.json +1 -1
- package/schemas.json +2 -2
package/dist/sync.yml
CHANGED
|
@@ -2602,9 +2602,10 @@ paths:
|
|
|
2602
2602
|
summary: List supported sync destination applications
|
|
2603
2603
|
description: |-
|
|
2604
2604
|
Returns the catalog of applications that can be used as the **destination** of a sync — the
|
|
2605
|
-
data warehouse a sync loads records into.
|
|
2606
|
-
|
|
2607
|
-
|
|
2605
|
+
data warehouse a sync loads records into. A sync's destination application is the type of
|
|
2606
|
+
its destination connection (`rdbms.type` for warehouse connections), which must match one
|
|
2607
|
+
of the returned ids. Identifiers include `snowflake` (Snowflake), `nsaw` (NetSuite
|
|
2608
|
+
Analytics Warehouse), `bigquery` (Google BigQuery), and `mssql` (Microsoft SQL Server).
|
|
2608
2609
|
tags:
|
|
2609
2610
|
- Syncs
|
|
2610
2611
|
operationId: listSyncDestinations
|
|
@@ -2629,8 +2630,10 @@ paths:
|
|
|
2629
2630
|
examples:
|
|
2630
2631
|
default:
|
|
2631
2632
|
value:
|
|
2632
|
-
- id:
|
|
2633
|
+
- id: bigquery
|
|
2634
|
+
- id: mssql
|
|
2633
2635
|
- id: nsaw
|
|
2636
|
+
- id: snowflake
|
|
2634
2637
|
'401':
|
|
2635
2638
|
$ref: '#/components/responses/401-unauthorized'
|
|
2636
2639
|
/v1/di/metadata/connections/{_connectionId}/datasets:
|
|
@@ -3848,27 +3851,35 @@ components:
|
|
|
3848
3851
|
type: object
|
|
3849
3852
|
description: |-
|
|
3850
3853
|
Data warehouse the sync loads records into. Empty (`{}`) on a draft that has no
|
|
3851
|
-
destination yet.
|
|
3852
|
-
|
|
3853
|
-
|
|
3854
|
+
destination yet. The destination application is the connection's own type
|
|
3855
|
+
(`rdbms.type` for warehouse connections), so `database` and `schema` are read in that
|
|
3856
|
+
application's terms — Google BigQuery treats them as the GCP project and the dataset.
|
|
3857
|
+
Each source + destination host/database/schema combination must be unique across
|
|
3858
|
+
syncs — reusing one fails with `422 duplicate_destination_host` — and all syncs in an
|
|
3859
|
+
integration must target the same destination application type.
|
|
3854
3860
|
properties:
|
|
3855
3861
|
_connectionId:
|
|
3856
3862
|
type: string
|
|
3857
3863
|
format: objectId
|
|
3858
3864
|
x-celigo-refModel: connections
|
|
3859
3865
|
description: |-
|
|
3860
|
-
Connection to the destination warehouse.
|
|
3861
|
-
|
|
3866
|
+
Connection to the destination warehouse. Its application (`rdbms.type` such as
|
|
3867
|
+
`snowflake`, `bigquery` or `mssql`, or a NetSuite Analytics Warehouse JDBC
|
|
3868
|
+
connection) is one of the ids returned by `GET /v1/di/metadata/destinations`.
|
|
3862
3869
|
examples:
|
|
3863
3870
|
- 68d02dbe0839a514623c1d6d
|
|
3864
3871
|
database:
|
|
3865
3872
|
type: string
|
|
3866
|
-
description:
|
|
3873
|
+
description: |-
|
|
3874
|
+
Database in the destination warehouse the sync loads into. For Google BigQuery this
|
|
3875
|
+
is the GCP project id the tables are created in (`project.dataset.table`).
|
|
3867
3876
|
examples:
|
|
3868
3877
|
- ANALYTICS_DB
|
|
3869
3878
|
schema:
|
|
3870
3879
|
type: string
|
|
3871
|
-
description:
|
|
3880
|
+
description: |-
|
|
3881
|
+
Schema within `database` where the sync creates and loads tables. For Google
|
|
3882
|
+
BigQuery this is the dataset name, with case preserved.
|
|
3872
3883
|
examples:
|
|
3873
3884
|
- salesforce_raw
|
|
3874
3885
|
tablePrefix:
|
|
@@ -4017,27 +4028,60 @@ components:
|
|
|
4017
4028
|
description: |-
|
|
4018
4029
|
Data warehouse the sync loads records into. Omit while drafting; a complete
|
|
4019
4030
|
destination (connection, database, schema) is required before the sync can be
|
|
4020
|
-
enabled. The
|
|
4031
|
+
enabled. The destination application is the connection's own type (`rdbms.type`
|
|
4032
|
+
for warehouse connections), so `database` and `schema` are read in that
|
|
4033
|
+
application's terms — Google BigQuery treats them as the GCP project and the
|
|
4034
|
+
dataset. The source + destination host/database/schema combination must be unique
|
|
4021
4035
|
across syncs (`422 duplicate_destination_host`), and all syncs in an integration
|
|
4022
4036
|
must target the same destination application type.
|
|
4037
|
+
x-celigo-ai-guidance:
|
|
4038
|
+
- |-
|
|
4039
|
+
Send the block complete or not at all. A partial block is rejected in the destination's
|
|
4040
|
+
own vocabulary with 422 `invalid_destination_sync_config`: `GCP project is required on
|
|
4041
|
+
sync destination` / `BigQuery dataset is required on sync destination` (BigQuery),
|
|
4042
|
+
`SQL Server database is required on sync destination` / `SQL Server schema is required
|
|
4043
|
+
on sync destination` (Microsoft SQL Server). A partial Snowflake block is not caught
|
|
4044
|
+
by validation — the save reaches the warehouse and fails with Snowflake's own
|
|
4045
|
+
`002003` "Database 'UNDEFINED' does not exist" error.
|
|
4046
|
+
- |-
|
|
4047
|
+
Saving a complete destination connects to the warehouse to create the schema
|
|
4048
|
+
(dataset) when it is missing. An unreachable host or unusable credentials fail the
|
|
4049
|
+
save with the connection's error — 422 `invalid_host` for SQL Server,
|
|
4050
|
+
`big_query_unexpected_error` for BigQuery — and no sync document is created or
|
|
4051
|
+
updated; fix the connection rather than changing database or schema names.
|
|
4052
|
+
- |-
|
|
4053
|
+
Microsoft SQL Server validates `database` and `schema` as identifiers (start with a
|
|
4054
|
+
letter or underscore; letters, digits, underscore or `$`; at most 128 characters) and
|
|
4055
|
+
rejects others with 422 `invalid_destination_sync_config`
|
|
4056
|
+
(`SQL Server schema name is invalid: ...`).
|
|
4023
4057
|
properties:
|
|
4024
4058
|
_connectionId:
|
|
4025
4059
|
type: string
|
|
4026
4060
|
format: objectId
|
|
4027
4061
|
x-celigo-refModel: connections
|
|
4028
4062
|
description: |-
|
|
4029
|
-
Connection to the destination warehouse.
|
|
4030
|
-
|
|
4063
|
+
Connection to the destination warehouse. Its application (`rdbms.type` such as
|
|
4064
|
+
`snowflake`, `bigquery` or `mssql`, or a NetSuite Analytics Warehouse JDBC
|
|
4065
|
+
connection) must be one of the ids returned by `GET /v1/di/metadata/destinations`;
|
|
4066
|
+
any other connection fails with `422 invalid_destination_type`.
|
|
4031
4067
|
examples:
|
|
4032
4068
|
- 68d02dbe0839a514623c1d6d
|
|
4033
4069
|
database:
|
|
4034
4070
|
type: string
|
|
4035
|
-
description:
|
|
4071
|
+
description: |-
|
|
4072
|
+
Database in the destination warehouse the sync loads into; it must already exist.
|
|
4073
|
+
For Google BigQuery this is the GCP project id the tables are created in
|
|
4074
|
+
(`project.dataset.table`).
|
|
4075
|
+
x-celigo-ui-override: For a BigQuery destination the Create Sync wizard shows no database picker and fills this field with the selected connection's rdbms.bigquery.projectId (IO-195900).
|
|
4036
4076
|
examples:
|
|
4037
4077
|
- ANALYTICS_DB
|
|
4038
4078
|
schema:
|
|
4039
4079
|
type: string
|
|
4040
|
-
description:
|
|
4080
|
+
description: |-
|
|
4081
|
+
Schema within `database` where the sync creates and loads tables; created on save
|
|
4082
|
+
when it does not exist. For Google BigQuery this is the dataset name, with case
|
|
4083
|
+
preserved.
|
|
4084
|
+
x-celigo-ui-override: For a BigQuery destination the Create Sync wizard labels this field "dataset" and accepts only letters, digits and underscore (no $), starting with a letter or underscore, at most 1024 characters (IO-195900); Snowflake and NSAW validation is unchanged.
|
|
4041
4085
|
examples:
|
|
4042
4086
|
- salesforce_raw
|
|
4043
4087
|
tablePrefix:
|
package/package.json
CHANGED