@celigo/api-specs 0.2.164 → 0.2.165
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/topic.yml +17 -12
- package/package.json +1 -1
- package/schemas.json +1 -1
package/dist/topic.yml
CHANGED
|
@@ -743,8 +743,10 @@ paths:
|
|
|
743
743
|
summary: Get a listener's read position
|
|
744
744
|
description: |-
|
|
745
745
|
Reports how far a topic export (listener) has read on this topic — where its next run resumes.
|
|
746
|
-
Use it to check whether a listener is keeping up or
|
|
747
|
-
|
|
746
|
+
Use it to check whether a listener is keeping up, or whether it has a read position at all: it
|
|
747
|
+
has none while it has not subscribed, or while its topic has never received a message. The export
|
|
748
|
+
must belong to the account but need not subscribe to this topic; an export that does not simply
|
|
749
|
+
has no cursor.
|
|
748
750
|
operationId: getTopicExportOffsets
|
|
749
751
|
tags:
|
|
750
752
|
- Topics
|
|
@@ -783,7 +785,7 @@ paths:
|
|
|
783
785
|
hasCursor: true
|
|
784
786
|
offset: 1287
|
|
785
787
|
never_consumed:
|
|
786
|
-
summary: Listener that has not
|
|
788
|
+
summary: Listener that has not subscribed, or whose topic has never received a message
|
|
787
789
|
value:
|
|
788
790
|
hasCursor: false
|
|
789
791
|
offset: -1
|
|
@@ -1657,15 +1659,18 @@ components:
|
|
|
1657
1659
|
hasCursor:
|
|
1658
1660
|
type: boolean
|
|
1659
1661
|
description: |-
|
|
1660
|
-
When true, the listener is subscribed to this topic and its next run resumes from
|
|
1661
|
-
The position appears when the listener's flow goes from disabled to enabled,
|
|
1662
|
-
is read: at the end of the stream under `topic.startPosition: latest`,
|
|
1663
|
-
message under `earliest`.
|
|
1664
|
-
|
|
1665
|
-
|
|
1666
|
-
|
|
1667
|
-
|
|
1668
|
-
|
|
1662
|
+
When true, the listener is subscribed to this topic and its next run resumes from
|
|
1663
|
+
`offset`. The position appears when the listener's flow goes from disabled to enabled,
|
|
1664
|
+
before anything is read: at the end of the stream under `topic.startPosition: latest`,
|
|
1665
|
+
at the first retained message under `earliest`. On a topic nothing has ever been
|
|
1666
|
+
published to, it appears only with the first publish, and the listener still receives
|
|
1667
|
+
that first message. False in two cases: the listener has never subscribed — it was saved
|
|
1668
|
+
without `type: "stream"`, its flow has not gone from disabled to enabled since it was
|
|
1669
|
+
saved (a flow created enabled never subscribes), or it does not listen to this topic; or
|
|
1670
|
+
its topic has never received a message, until the first publish. A listener whose flow
|
|
1671
|
+
is disabled keeps its position. When the message at that position is no longer retained
|
|
1672
|
+
— it expired past `retentionMs` or was purged — the listener still reports true with the
|
|
1673
|
+
old `offset`, and its next run resumes from the earliest message still retained,
|
|
1669
1674
|
whatever its `startPosition`.
|
|
1670
1675
|
examples:
|
|
1671
1676
|
- true
|
package/package.json
CHANGED