@celigo/api-specs 0.2.96 → 0.2.98
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/flow.yml +9 -10
- package/dist/iclient.yml +8 -19
- package/dist/lookupcache.yml +28 -12
- package/package.json +1 -1
- package/schemas.json +1 -1
package/dist/flow.yml
CHANGED
|
@@ -418,7 +418,7 @@ paths:
|
|
|
418
418
|
summary: Patch a flow
|
|
419
419
|
description: |-
|
|
420
420
|
Partially updates a flow using a JSON Patch document (RFC 6902).
|
|
421
|
-
|
|
421
|
+
`replace`, `add`, and `remove` operations are accepted only on the following
|
|
422
422
|
whitelisted paths:
|
|
423
423
|
|
|
424
424
|
| Path | Description |
|
|
@@ -430,13 +430,12 @@ paths:
|
|
|
430
430
|
| `/logging/mode` | Logging mode |
|
|
431
431
|
| `/runPageGeneratorsInParallel` | Run page generators in parallel |
|
|
432
432
|
| `/aiDescription` | AI-generated description object |
|
|
433
|
-
| `/schedule
|
|
434
|
-
| `/
|
|
435
|
-
| `/schedule/endDate` | Schedule end date |
|
|
436
|
-
| `/schedule/days` | Schedule days |
|
|
437
|
-
| `/schedule/cron` | Cron expression |
|
|
433
|
+
| `/schedule` | Celigo 6-field cron string (same as PUT `schedule`) |
|
|
434
|
+
| `/timezone` | IANA timezone string |
|
|
438
435
|
|
|
439
|
-
All other paths are rejected with 422
|
|
436
|
+
All other paths are rejected with 422, except pointers nested under `/schedule`
|
|
437
|
+
(such as `/schedule/cron`): `schedule` is a string, so those return 204 and change
|
|
438
|
+
nothing. Send the whole cron string to `/schedule` instead.
|
|
440
439
|
|
|
441
440
|
PATCH is safer than PUT for toggling `disabled` or arming debug logging because it won't
|
|
442
441
|
accidentally reset other fields. To arm debug logging, `replace` `/logging/debugUntil` with
|
|
@@ -476,11 +475,11 @@ paths:
|
|
|
476
475
|
path: /logging/debugUntil
|
|
477
476
|
value: '2026-05-02T16:00:00.000Z'
|
|
478
477
|
update_schedule:
|
|
479
|
-
summary: Change schedule
|
|
478
|
+
summary: Change Celigo 6-field schedule cron
|
|
480
479
|
value:
|
|
481
480
|
- op: replace
|
|
482
|
-
path: /schedule
|
|
483
|
-
value: 0
|
|
481
|
+
path: /schedule
|
|
482
|
+
value: '? 5 0,6,12,18 ? * *'
|
|
484
483
|
responses:
|
|
485
484
|
'204':
|
|
486
485
|
description: Flow patched successfully.
|
package/dist/iclient.yml
CHANGED
|
@@ -1160,27 +1160,16 @@ components:
|
|
|
1160
1160
|
clientSecret:
|
|
1161
1161
|
type: string
|
|
1162
1162
|
description: |-
|
|
1163
|
-
OAuth 2.0 client secret. Returned masked as `"******"
|
|
1164
|
-
|
|
1163
|
+
OAuth 2.0 client secret. Returned masked as `"******"`; re-send that mask
|
|
1164
|
+
on update to keep the stored secret. Required whenever `oauth2` is sent, on
|
|
1165
|
+
create and update: omitting it or sending an empty string fails with 422
|
|
1166
|
+
`missing_required_field` rather than clearing the secret.
|
|
1165
1167
|
x-celigo-ai-guidance:
|
|
1166
1168
|
- |-
|
|
1167
|
-
|
|
1168
|
-
|
|
1169
|
-
|
|
1170
|
-
|
|
1171
|
-
This is the value you provide to configure or update the iClient.
|
|
1172
|
-
Internally,
|
|
1173
|
-
integrator.io stores this secret encrypted at rest (for example as
|
|
1174
|
-
`clientSecret_crypt` and `clientSecret_salt` fields in the underlying model),
|
|
1175
|
-
and API responses typically return a masked value (e.g.,
|
|
1176
|
-
`"******"`) when a secret is already set.
|
|
1177
|
-
- |-
|
|
1178
|
-
This is the value you provide to configure or update the iClient.
|
|
1179
|
-
Internally,
|
|
1180
|
-
integrator.io stores this secret encrypted at rest (for example as
|
|
1181
|
-
`clientSecret_crypt` and `clientSecret_salt` fields in the underlying model),
|
|
1182
|
-
and API responses typically return a masked value (e.g.,
|
|
1183
|
-
`"******"`) when a secret is already set.
|
|
1169
|
+
Send the plain secret to set or replace it. To keep the stored secret on a
|
|
1170
|
+
PUT, send "******" (the masked value GET returns). Never omit clientSecret
|
|
1171
|
+
while sending other oauth2 fields: create and update both fail with 422
|
|
1172
|
+
missing_required_field on oauth2.clientSecret.
|
|
1184
1173
|
- |-
|
|
1185
1174
|
This is the value you provide to configure or update the iClient.
|
|
1186
1175
|
Internally,
|
package/dist/lookupcache.yml
CHANGED
|
@@ -410,9 +410,11 @@ paths:
|
|
|
410
410
|
summary: Upsert entries into a lookup cache
|
|
411
411
|
description: |-
|
|
412
412
|
Writes key-value entries to a lookup cache. Keys that already exist are
|
|
413
|
-
overwritten; new keys are created.
|
|
414
|
-
objects — arrays at the top level are rejected (wrap them in an
|
|
415
|
-
invalid
|
|
413
|
+
overwritten; new keys are created. Values may be null, numbers, booleans,
|
|
414
|
+
strings, or objects — arrays at the top level are rejected (wrap them in an
|
|
415
|
+
object). One invalid entry fails the entire batch and nothing in it is written:
|
|
416
|
+
a bad value returns `400 invalid_value`, and an empty, missing, or over-length
|
|
417
|
+
key returns `400 cache_dynamodb_invalid_key`.
|
|
416
418
|
|
|
417
419
|
The service rejects batches larger than ~1000 entries or ~5 MB of JSON.
|
|
418
420
|
Callers uploading more than that should split their payload; the Celigo CLI
|
|
@@ -979,15 +981,17 @@ components:
|
|
|
979
981
|
LookupCacheDataEntry:
|
|
980
982
|
type: object
|
|
981
983
|
description: |-
|
|
982
|
-
A single key-value pair stored in a lookup cache.
|
|
983
|
-
|
|
984
|
-
|
|
985
|
-
`400 invalid_value "The value provided corresponding to the key: <k> is invalid"
|
|
986
|
-
|
|
987
|
-
(e.g. `{ "items": [...] }`).
|
|
984
|
+
A single key-value pair stored in a lookup cache. Values may be JSON null, number,
|
|
985
|
+
boolean, string, or object, and each is read back with the type it was upserted
|
|
986
|
+
with. Top-level arrays are **rejected** at upsert with
|
|
987
|
+
`400 invalid_value "The value provided corresponding to the key: <k> is invalid"`,
|
|
988
|
+
as are objects that carry their own top-level `key` property; callers that need to
|
|
989
|
+
store an array should wrap it in an object (e.g. `{ "items": [...] }`).
|
|
988
990
|
properties:
|
|
989
991
|
key:
|
|
990
992
|
type: string
|
|
993
|
+
minLength: 1
|
|
994
|
+
maxLength: 255
|
|
991
995
|
description: |-
|
|
992
996
|
Lookup key. Treated as an opaque string by the cache — case-sensitive, no
|
|
993
997
|
normalization. The same cache can hold multiple entries that differ only in
|
|
@@ -997,19 +1001,31 @@ components:
|
|
|
997
1001
|
- ext-customer-12345
|
|
998
1002
|
value:
|
|
999
1003
|
description: |-
|
|
1000
|
-
Value associated with the key.
|
|
1001
|
-
|
|
1002
|
-
|
|
1004
|
+
Value associated with the key. Nested arrays inside an object are fine; a
|
|
1005
|
+
top-level array is rejected — wrap it. Consumers should check the runtime type
|
|
1006
|
+
before use.
|
|
1003
1007
|
oneOf:
|
|
1008
|
+
- title: Null value
|
|
1009
|
+
type: 'null'
|
|
1010
|
+
- title: Number value
|
|
1011
|
+
type: number
|
|
1012
|
+
- title: Boolean value
|
|
1013
|
+
type: boolean
|
|
1004
1014
|
- title: String value
|
|
1005
1015
|
type: string
|
|
1006
1016
|
- title: Object value
|
|
1007
1017
|
type: object
|
|
1008
1018
|
additionalProperties: true
|
|
1009
1019
|
examples:
|
|
1020
|
+
- null
|
|
1021
|
+
- 42
|
|
1022
|
+
- true
|
|
1010
1023
|
- California
|
|
1011
1024
|
- customerId: 0015g00000abc
|
|
1012
1025
|
- ts: '2026-04-22T00:00:00Z'
|
|
1026
|
+
required:
|
|
1027
|
+
- key
|
|
1028
|
+
- value
|
|
1013
1029
|
LookupCacheDataUpsertRequest:
|
|
1014
1030
|
type: object
|
|
1015
1031
|
description: |-
|
package/package.json
CHANGED