@celigo/api-specs 0.2.161 → 0.2.162
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/alert.yml +5 -1
- package/dist/api.yml +7 -1
- package/dist/flow.yml +6 -0
- package/dist/integration.yml +17 -3
- package/dist/notification.yml +10 -8
- package/dist/recyclebin.yml +3 -1
- package/dist/tool.yml +5 -0
- package/package.json +1 -1
- package/schemas.json +1 -1
package/dist/alert.yml
CHANGED
|
@@ -176,6 +176,8 @@ paths:
|
|
|
176
176
|
Creates a proactive alert. Validates type, flow/integration, and duplicate
|
|
177
177
|
constraints, then resolves `_recipientEmails` to `_recipientUserIds` and
|
|
178
178
|
dual-writes the long-runtime threshold onto the related flow document(s).
|
|
179
|
+
A flow read doesn't return that threshold, but the flow's `lastModified`
|
|
180
|
+
moves, and the flow's own audit log gets no entry for it.
|
|
179
181
|
|
|
180
182
|
Requires permission `put:alert:models`. Returns `403` when
|
|
181
183
|
`ENABLE_PROACTIVE_ALERTS` is off. Response is always unpopulated.
|
|
@@ -474,7 +476,9 @@ paths:
|
|
|
474
476
|
summary: Delete an alert
|
|
475
477
|
description: |-
|
|
476
478
|
Soft-deletes an alert and clears `__longRuntimeThresholdMinutes` on the
|
|
477
|
-
related flow document(s)
|
|
479
|
+
related flow document(s), which moves each flow's `lastModified`. A
|
|
480
|
+
deleted alert reads 404 and has no recycle-bin entry. Requires permission
|
|
481
|
+
`put:alert:models`. Returns
|
|
478
482
|
`403` when `ENABLE_PROACTIVE_ALERTS` is off.
|
|
479
483
|
parameters:
|
|
480
484
|
- name: _id
|
package/dist/api.yml
CHANGED
|
@@ -2967,7 +2967,13 @@ components:
|
|
|
2967
2967
|
properties:
|
|
2968
2968
|
id:
|
|
2969
2969
|
type: string
|
|
2970
|
-
|
|
2970
|
+
maxLength: 36
|
|
2971
|
+
pattern: ^[A-Za-z0-9_-]+$
|
|
2972
|
+
description: |-
|
|
2973
|
+
Unique identifier for this router within the API. Use at most 36 letters, digits,
|
|
2974
|
+
underscores and hyphens: a longer id fails the save with 422 ("Router id is missing or
|
|
2975
|
+
contains more than 36 characters or invalid characters. Please correct the router
|
|
2976
|
+
id."), as on flow routers.
|
|
2971
2977
|
examples:
|
|
2972
2978
|
- router_001
|
|
2973
2979
|
- validation_router
|
package/dist/flow.yml
CHANGED
|
@@ -4780,11 +4780,17 @@ components:
|
|
|
4780
4780
|
properties:
|
|
4781
4781
|
id:
|
|
4782
4782
|
type: string
|
|
4783
|
+
maxLength: 36
|
|
4784
|
+
pattern: ^[A-Za-z0-9_-]+$
|
|
4783
4785
|
description: |
|
|
4784
4786
|
Unique identifier for this router within the flow.
|
|
4785
4787
|
|
|
4786
4788
|
Used to reference this router from branches (`branches[].nextRouterId`)
|
|
4787
4789
|
when chaining routers. Must be unique within the flow's router collection.
|
|
4790
|
+
Use at most 36 letters, digits, underscores and hyphens: a longer id, or one
|
|
4791
|
+
with a space or a period, fails the save with 422 ("Router id is missing or
|
|
4792
|
+
contains more than 36 characters or invalid characters. Please correct the
|
|
4793
|
+
router id.").
|
|
4788
4794
|
examples:
|
|
4789
4795
|
- router_001
|
|
4790
4796
|
- customer_type_router
|
package/dist/integration.yml
CHANGED
|
@@ -340,8 +340,8 @@ paths:
|
|
|
340
340
|
- Integrations
|
|
341
341
|
description: |-
|
|
342
342
|
Deletes an integration. The integration is soft-deleted and retained in the
|
|
343
|
-
recycle bin for 30 days before permanent removal. Delete the APIs and
|
|
344
|
-
contains, and remove its aliases that point at lookup caches, first.
|
|
343
|
+
recycle bin for 30 days before permanent removal. Delete the flows, syncs, APIs and
|
|
344
|
+
Tools it contains, and remove its aliases that point at lookup caches, first.
|
|
345
345
|
parameters:
|
|
346
346
|
- name: _id
|
|
347
347
|
in: path
|
|
@@ -364,12 +364,26 @@ paths:
|
|
|
364
364
|
description: |-
|
|
365
365
|
The integration still contains resources that must be deleted first, APIs and Tools
|
|
366
366
|
among them (`dependencies_not_deleted`, one entry per blocking resource), or one of its
|
|
367
|
-
`aliases[]` still points at a lookup cache.
|
|
367
|
+
`aliases[]` still points at a lookup cache. Flows and syncs block it the same way, with
|
|
368
|
+
one entry per flow or sync still in the integration ("flow <id> must be deleted before
|
|
369
|
+
you can delete integration <id>", "sync <id> must be deleted before you can delete
|
|
370
|
+
integration <id>"), and nothing is deleted.
|
|
368
371
|
content:
|
|
369
372
|
application/json:
|
|
370
373
|
schema:
|
|
371
374
|
$ref: '#/components/schemas/Error'
|
|
372
375
|
examples:
|
|
376
|
+
flows_remaining:
|
|
377
|
+
summary: The integration still holds flows
|
|
378
|
+
value:
|
|
379
|
+
errors:
|
|
380
|
+
- message: flow <flowId> must be deleted before you can delete integration <integrationId>
|
|
381
|
+
- message: flow <secondFlowId> must be deleted before you can delete integration <integrationId>
|
|
382
|
+
syncs_remaining:
|
|
383
|
+
summary: The integration still holds a sync
|
|
384
|
+
value:
|
|
385
|
+
errors:
|
|
386
|
+
- message: sync <syncId> must be deleted before you can delete integration <integrationId>
|
|
373
387
|
lookup_cache_alias:
|
|
374
388
|
value:
|
|
375
389
|
errors:
|
package/dist/notification.yml
CHANGED
|
@@ -149,8 +149,9 @@ paths:
|
|
|
149
149
|
'200':
|
|
150
150
|
description: |-
|
|
151
151
|
Per-item result array (parallel to the request). Each entry is
|
|
152
|
-
`{statusCode, errors?}` — `statusCode
|
|
153
|
-
|
|
152
|
+
`{statusCode, errors?}` — `statusCode` 201 for a created subscription
|
|
153
|
+
and 200 for one that already existed or was removed, or a 4xx status
|
|
154
|
+
with an `errors[]` array on per-item failures. Overall HTTP is
|
|
154
155
|
still 200 even when individual items fail.
|
|
155
156
|
content:
|
|
156
157
|
application/json:
|
|
@@ -163,12 +164,13 @@ paths:
|
|
|
163
164
|
statusCode:
|
|
164
165
|
type: integer
|
|
165
166
|
description: |-
|
|
166
|
-
Per-item outcome:
|
|
167
|
-
|
|
168
|
-
|
|
167
|
+
Per-item outcome: 201 when the subscription was created;
|
|
168
|
+
200 when it already existed (subscribing again keeps the one
|
|
169
|
+
record) or was removed; 422 when the referenced resource
|
|
170
|
+
doesn't exist (details in `errors[]`).
|
|
169
171
|
errors:
|
|
170
172
|
type: array
|
|
171
|
-
description: Per-item error details — present on
|
|
173
|
+
description: Per-item error details — present on 4xx per-item failures, never on a 201 or 200.
|
|
172
174
|
items:
|
|
173
175
|
type: object
|
|
174
176
|
properties:
|
|
@@ -186,9 +188,9 @@ paths:
|
|
|
186
188
|
- Please ensure that connection with 000000000000000000000001 exists for creating the notification.
|
|
187
189
|
examples:
|
|
188
190
|
allSuccess:
|
|
189
|
-
summary:
|
|
191
|
+
summary: A new subscription and one that already existed
|
|
190
192
|
value:
|
|
191
|
-
- statusCode:
|
|
193
|
+
- statusCode: 201
|
|
192
194
|
- statusCode: 200
|
|
193
195
|
mixed:
|
|
194
196
|
summary: One item referenced a non-existent connection
|
package/dist/recyclebin.yml
CHANGED
|
@@ -419,7 +419,9 @@ paths:
|
|
|
419
419
|
Resources are auto-purged after 30 days. A purge removes only the
|
|
420
420
|
named resource: purge the bin entries that still reference it first
|
|
421
421
|
(a deleted flow references its integration and the exports and imports
|
|
422
|
-
it used).
|
|
422
|
+
it used). An integration's Celigo Storage system folder is the
|
|
423
|
+
exception: the folder and everything in it go to the bin with the
|
|
424
|
+
integration and are purged with it.
|
|
423
425
|
parameters:
|
|
424
426
|
- $ref: '#/components/parameters/ResourceType'
|
|
425
427
|
- name: _id
|
package/dist/tool.yml
CHANGED
|
@@ -6674,10 +6674,15 @@ components:
|
|
|
6674
6674
|
properties:
|
|
6675
6675
|
id:
|
|
6676
6676
|
type: string
|
|
6677
|
+
maxLength: 36
|
|
6678
|
+
pattern: ^[A-Za-z0-9_-]+$
|
|
6677
6679
|
description: |
|
|
6678
6680
|
Unique identifier for this router within the tool.
|
|
6679
6681
|
|
|
6680
6682
|
Used to reference this router from other routers' branch `nextRouterId`.
|
|
6683
|
+
Use at most 36 letters, digits, underscores and hyphens: a longer id fails
|
|
6684
|
+
the save with 422 ("Router id is missing or contains more than 36 characters
|
|
6685
|
+
or invalid characters. Please correct the router id."), as on flow routers.
|
|
6681
6686
|
examples:
|
|
6682
6687
|
- router_001
|
|
6683
6688
|
- validation_router
|
package/package.json
CHANGED