@celigo/api-specs 0.2.66 → 0.2.67
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/export.yml +25 -3
- package/dist/import.yml +10 -0
- package/dist/tool.yml +35 -3
- package/dist/topic.yml +5 -1
- package/package.json +1 -1
- package/schemas.json +2 -2
package/dist/export.yml
CHANGED
|
@@ -5954,9 +5954,25 @@ components:
|
|
|
5954
5954
|
with their defaults when they are omitted.
|
|
5955
5955
|
x-celigo-ai-guidance:
|
|
5956
5956
|
- |-
|
|
5957
|
-
Send `type: "stream"` together with this object, as the listener form always does
|
|
5958
|
-
save also succeeds without `type`,
|
|
5959
|
-
|
|
5957
|
+
Send `type: "stream"` together with this object, as the listener form always does. The
|
|
5958
|
+
save also succeeds without `type`, and the listener then runs as a batch export: its flow
|
|
5959
|
+
never starts when a message is published, a manual run re-reads every retained message
|
|
5960
|
+
without committing a position, and `GET /v1/topics/{_id}/exports/{_exportId}/offsets`
|
|
5961
|
+
reports `hasCursor: false`. `PATCH` cannot add the type afterwards (`/type` is not a
|
|
5962
|
+
whitelisted property): `PUT` the full document with `type: "stream"`, then disable and
|
|
5963
|
+
enable the flow. Sending this object without `adaptorType` is enough for the server to
|
|
5964
|
+
infer `TopicExport`.
|
|
5965
|
+
- |-
|
|
5966
|
+
The subscription is created when the listener's flow goes from disabled to enabled (a
|
|
5967
|
+
`PATCH` or `PUT` that changes `disabled`); the first run after a publish follows within
|
|
5968
|
+
about a minute. A flow created with `disabled: false` in one request has not subscribed,
|
|
5969
|
+
and a save that leaves `disabled` unchanged (a rename) does not subscribe it — toggle the
|
|
5970
|
+
flow. Under `startPosition: latest`, messages published before the subscription exists
|
|
5971
|
+
are skipped. A disabled flow keeps its position and resumes from it when enabled again.
|
|
5972
|
+
- |-
|
|
5973
|
+
A topic listener cannot be a lookup: `isLookup: true` with `type: "stream"` fails the save
|
|
5974
|
+
with 422 `not_supported` ("Lookup functionality is not available for Stream Export"), and a
|
|
5975
|
+
lookup-shaped TopicExport saved without `type` never runs.
|
|
5960
5976
|
- |-
|
|
5961
5977
|
Never add a `_connectionId`: the server then validates the document as that connection's
|
|
5962
5978
|
adaptor instead (an http connection fails with 422 missing_required_field "http subschema
|
|
@@ -16358,6 +16374,12 @@ components:
|
|
|
16358
16374
|
response for the record, up to 5 MB, so `pageSize` does not limit or extend what a lookup
|
|
16359
16375
|
returns. A lookup that must return more than that is better modeled as a standalone
|
|
16360
16376
|
export step.
|
|
16377
|
+
x-celigo-ai-guidance:
|
|
16378
|
+
- |-
|
|
16379
|
+
Not supported together with `type: "stream"`: a topic listener (`adaptorType:
|
|
16380
|
+
TopicExport`) with `isLookup: true` fails the save with 422 `not_supported`
|
|
16381
|
+
("Lookup functionality is not available for Stream Export"). Enrich from a topic by
|
|
16382
|
+
listening to it in its own flow.
|
|
16361
16383
|
examples:
|
|
16362
16384
|
- true
|
|
16363
16385
|
- false
|
package/dist/import.yml
CHANGED
|
@@ -8352,6 +8352,16 @@ components:
|
|
|
8352
8352
|
from it. Never add a `_connectionId`: the server then validates the document as that
|
|
8353
8353
|
connection's adaptor instead (an http connection fails with 422 missing_required_field
|
|
8354
8354
|
"http subschema not defined").
|
|
8355
|
+
- |-
|
|
8356
|
+
Without a mapping, each message is the record as the step received it. With
|
|
8357
|
+
`oneToMany: true` and `pathToMany`, every element of that array is published as its own
|
|
8358
|
+
message and the rest of the parent record rides inside each one under `_PARENT` (the parent
|
|
8359
|
+
without the array); a mapping reshapes the message instead.
|
|
8360
|
+
- |-
|
|
8361
|
+
Publishing is not limited to flows. Verified surfaces: a flow step; an API step (the API
|
|
8362
|
+
invoked at `POST /apis/{version}/{relativeURI}`); a Tool reached through a `ToolImport`
|
|
8363
|
+
step in a flow; and `POST /v1/imports/{_id}/invoke` with `{"data": [record, ...]}`. A flow
|
|
8364
|
+
or API test run (`/test/run`) publishes nothing — import steps are mocked there.
|
|
8355
8365
|
properties:
|
|
8356
8366
|
_topicId:
|
|
8357
8367
|
type: string
|
package/dist/tool.yml
CHANGED
|
@@ -18628,6 +18628,16 @@ components:
|
|
|
18628
18628
|
from it. Never add a `_connectionId`: the server then validates the document as that
|
|
18629
18629
|
connection's adaptor instead (an http connection fails with 422 missing_required_field
|
|
18630
18630
|
"http subschema not defined").
|
|
18631
|
+
- |-
|
|
18632
|
+
Without a mapping, each message is the record as the step received it. With
|
|
18633
|
+
`oneToMany: true` and `pathToMany`, every element of that array is published as its own
|
|
18634
|
+
message and the rest of the parent record rides inside each one under `_PARENT` (the parent
|
|
18635
|
+
without the array); a mapping reshapes the message instead.
|
|
18636
|
+
- |-
|
|
18637
|
+
Publishing is not limited to flows. Verified surfaces: a flow step; an API step (the API
|
|
18638
|
+
invoked at `POST /apis/{version}/{relativeURI}`); a Tool reached through a `ToolImport`
|
|
18639
|
+
step in a flow; and `POST /v1/imports/{_id}/invoke` with `{"data": [record, ...]}`. A flow
|
|
18640
|
+
or API test run (`/test/run`) publishes nothing — import steps are mocked there.
|
|
18631
18641
|
properties:
|
|
18632
18642
|
_topicId:
|
|
18633
18643
|
type: string
|
|
@@ -28985,9 +28995,25 @@ components:
|
|
|
28985
28995
|
with their defaults when they are omitted.
|
|
28986
28996
|
x-celigo-ai-guidance:
|
|
28987
28997
|
- |-
|
|
28988
|
-
Send `type: "stream"` together with this object, as the listener form always does
|
|
28989
|
-
save also succeeds without `type`,
|
|
28990
|
-
|
|
28998
|
+
Send `type: "stream"` together with this object, as the listener form always does. The
|
|
28999
|
+
save also succeeds without `type`, and the listener then runs as a batch export: its flow
|
|
29000
|
+
never starts when a message is published, a manual run re-reads every retained message
|
|
29001
|
+
without committing a position, and `GET /v1/topics/{_id}/exports/{_exportId}/offsets`
|
|
29002
|
+
reports `hasCursor: false`. `PATCH` cannot add the type afterwards (`/type` is not a
|
|
29003
|
+
whitelisted property): `PUT` the full document with `type: "stream"`, then disable and
|
|
29004
|
+
enable the flow. Sending this object without `adaptorType` is enough for the server to
|
|
29005
|
+
infer `TopicExport`.
|
|
29006
|
+
- |-
|
|
29007
|
+
The subscription is created when the listener's flow goes from disabled to enabled (a
|
|
29008
|
+
`PATCH` or `PUT` that changes `disabled`); the first run after a publish follows within
|
|
29009
|
+
about a minute. A flow created with `disabled: false` in one request has not subscribed,
|
|
29010
|
+
and a save that leaves `disabled` unchanged (a rename) does not subscribe it — toggle the
|
|
29011
|
+
flow. Under `startPosition: latest`, messages published before the subscription exists
|
|
29012
|
+
are skipped. A disabled flow keeps its position and resumes from it when enabled again.
|
|
29013
|
+
- |-
|
|
29014
|
+
A topic listener cannot be a lookup: `isLookup: true` with `type: "stream"` fails the save
|
|
29015
|
+
with 422 `not_supported` ("Lookup functionality is not available for Stream Export"), and a
|
|
29016
|
+
lookup-shaped TopicExport saved without `type` never runs.
|
|
28991
29017
|
- |-
|
|
28992
29018
|
Never add a `_connectionId`: the server then validates the document as that connection's
|
|
28993
29019
|
adaptor instead (an http connection fails with 422 missing_required_field "http subschema
|
|
@@ -36327,6 +36353,12 @@ components:
|
|
|
36327
36353
|
response for the record, up to 5 MB, so `pageSize` does not limit or extend what a lookup
|
|
36328
36354
|
returns. A lookup that must return more than that is better modeled as a standalone
|
|
36329
36355
|
export step.
|
|
36356
|
+
x-celigo-ai-guidance:
|
|
36357
|
+
- |-
|
|
36358
|
+
Not supported together with `type: "stream"`: a topic listener (`adaptorType:
|
|
36359
|
+
TopicExport`) with `isLookup: true` fails the save with 422 `not_supported`
|
|
36360
|
+
("Lookup functionality is not available for Stream Export"). Enrich from a topic by
|
|
36361
|
+
listening to it in its own flow.
|
|
36330
36362
|
examples:
|
|
36331
36363
|
- true
|
|
36332
36364
|
- false
|
package/dist/topic.yml
CHANGED
|
@@ -1636,6 +1636,9 @@ components:
|
|
|
1636
1636
|
from `offset`. False when the export has never consumed the topic, when its last committed
|
|
1637
1637
|
position has expired from the stream, or when it does not listen to this topic at all — a
|
|
1638
1638
|
listener without a cursor starts from its own `topic.startPosition` (`latest` or `earliest`).
|
|
1639
|
+
A listener whose flow is disabled keeps its position; a listener saved without
|
|
1640
|
+
`type: "stream"`, or whose flow has not been enabled since the listener was saved, has
|
|
1641
|
+
never subscribed and reports false.
|
|
1639
1642
|
examples:
|
|
1640
1643
|
- true
|
|
1641
1644
|
- false
|
|
@@ -1644,7 +1647,8 @@ components:
|
|
|
1644
1647
|
minimum: -1
|
|
1645
1648
|
description: |-
|
|
1646
1649
|
Zero-based position of the next message the export will read. `-1` when `hasCursor` is
|
|
1647
|
-
false.
|
|
1650
|
+
false. The position counts from the start of the stream, so while no message has expired
|
|
1651
|
+
the retained message count minus `offset` is the listener's backlog.
|
|
1648
1652
|
examples:
|
|
1649
1653
|
- 1287
|
|
1650
1654
|
- -1
|
package/package.json
CHANGED