Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update comment to reflect availability with WebSockets #1449

Merged
merged 2 commits into from
Feb 12, 2024
Merged

Update comment to reflect availability with WebSockets #1449

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
193c4a0
Update comment to reflect availability with WebSockets
peterbroadhurst Jan 19, 2024
0c9117d
Update copyright year
nguyer Feb 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/reference/types/subscription.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ nav_order: 3
| `firstEvent` | Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' | `SubOptsFirstEvent` |
| `readAhead` | The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts | `uint16` |
| `withData` | Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. | `bool` |
| `batch` | Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch. Commonly used with Webhooks to allow events to be delivered and acknowledged in batches. | `bool` |
| `batch` | Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch, allowing client-side optimizations when processing the events in a group. Available for both Webhooks and WebSockets. | `bool` |
| `batchTimeout` | When batching is enabled, the optional timeout to send events even when the batch hasn't filled. | `string` |
| `fastack` | Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations | `bool` |
| `url` | Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config | `string` |
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/types/wsstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ nav_order: 23
| `firstEvent` | Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest' | `SubOptsFirstEvent` |
| `readAhead` | The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts | `uint16` |
| `withData` | Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports. | `bool` |
| `batch` | Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch. Commonly used with Webhooks to allow events to be delivered and acknowledged in batches. | `bool` |
| `batch` | Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch, allowing client-side optimizations when processing the events in a group. Available for both Webhooks and WebSockets. | `bool` |
| `batchTimeout` | When batching is enabled, the optional timeout to send events even when the batch hasn't filled. | `string` |
| `fastack` | Webhooks only: When true the event will be acknowledged before the webhook is invoked, allowing parallel invocations | `bool` |
| `url` | Webhooks only: HTTP url to invoke. Can be relative if a base URL is set in the webhook plugin config | `string` |
Expand Down
56 changes: 32 additions & 24 deletions docs/swagger/swagger.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27717,8 +27717,9 @@ paths:
description: Events are delivered in batches in an ordered
array. The batch size is capped to the readAhead limit.
The event payload is always an array even if there is
a single event in the batch. Commonly used with Webhooks
to allow events to be delivered and acknowledged in batches.
a single event in the batch, allowing client-side optimizations
when processing the events in a group. Available for both
Webhooks and WebSockets.
type: boolean
batchTimeout:
description: When batching is enabled, the optional timeout
Expand Down Expand Up @@ -28006,8 +28007,8 @@ paths:
description: Events are delivered in batches in an ordered array.
The batch size is capped to the readAhead limit. The event
payload is always an array even if there is a single event
in the batch. Commonly used with Webhooks to allow events
to be delivered and acknowledged in batches.
in the batch, allowing client-side optimizations when processing
the events in a group. Available for both Webhooks and WebSockets.
type: boolean
batchTimeout:
description: When batching is enabled, the optional timeout
Expand Down Expand Up @@ -28276,8 +28277,9 @@ paths:
description: Events are delivered in batches in an ordered
array. The batch size is capped to the readAhead limit.
The event payload is always an array even if there is a
single event in the batch. Commonly used with Webhooks to
allow events to be delivered and acknowledged in batches.
single event in the batch, allowing client-side optimizations
when processing the events in a group. Available for both
Webhooks and WebSockets.
type: boolean
batchTimeout:
description: When batching is enabled, the optional timeout
Expand Down Expand Up @@ -28561,8 +28563,8 @@ paths:
description: Events are delivered in batches in an ordered array.
The batch size is capped to the readAhead limit. The event
payload is always an array even if there is a single event
in the batch. Commonly used with Webhooks to allow events
to be delivered and acknowledged in batches.
in the batch, allowing client-side optimizations when processing
the events in a group. Available for both Webhooks and WebSockets.
type: boolean
batchTimeout:
description: When batching is enabled, the optional timeout
Expand Down Expand Up @@ -28831,8 +28833,9 @@ paths:
description: Events are delivered in batches in an ordered
array. The batch size is capped to the readAhead limit.
The event payload is always an array even if there is a
single event in the batch. Commonly used with Webhooks to
allow events to be delivered and acknowledged in batches.
single event in the batch, allowing client-side optimizations
when processing the events in a group. Available for both
Webhooks and WebSockets.
type: boolean
batchTimeout:
description: When batching is enabled, the optional timeout
Expand Down Expand Up @@ -29178,8 +29181,9 @@ paths:
description: Events are delivered in batches in an ordered
array. The batch size is capped to the readAhead limit.
The event payload is always an array even if there is a
single event in the batch. Commonly used with Webhooks to
allow events to be delivered and acknowledged in batches.
single event in the batch, allowing client-side optimizations
when processing the events in a group. Available for both
Webhooks and WebSockets.
type: boolean
batchTimeout:
description: When batching is enabled, the optional timeout
Expand Down Expand Up @@ -36660,8 +36664,9 @@ paths:
description: Events are delivered in batches in an ordered
array. The batch size is capped to the readAhead limit.
The event payload is always an array even if there is
a single event in the batch. Commonly used with Webhooks
to allow events to be delivered and acknowledged in batches.
a single event in the batch, allowing client-side optimizations
when processing the events in a group. Available for both
Webhooks and WebSockets.
type: boolean
batchTimeout:
description: When batching is enabled, the optional timeout
Expand Down Expand Up @@ -36942,8 +36947,8 @@ paths:
description: Events are delivered in batches in an ordered array.
The batch size is capped to the readAhead limit. The event
payload is always an array even if there is a single event
in the batch. Commonly used with Webhooks to allow events
to be delivered and acknowledged in batches.
in the batch, allowing client-side optimizations when processing
the events in a group. Available for both Webhooks and WebSockets.
type: boolean
batchTimeout:
description: When batching is enabled, the optional timeout
Expand Down Expand Up @@ -37212,8 +37217,9 @@ paths:
description: Events are delivered in batches in an ordered
array. The batch size is capped to the readAhead limit.
The event payload is always an array even if there is a
single event in the batch. Commonly used with Webhooks to
allow events to be delivered and acknowledged in batches.
single event in the batch, allowing client-side optimizations
when processing the events in a group. Available for both
Webhooks and WebSockets.
type: boolean
batchTimeout:
description: When batching is enabled, the optional timeout
Expand Down Expand Up @@ -37490,8 +37496,8 @@ paths:
description: Events are delivered in batches in an ordered array.
The batch size is capped to the readAhead limit. The event
payload is always an array even if there is a single event
in the batch. Commonly used with Webhooks to allow events
to be delivered and acknowledged in batches.
in the batch, allowing client-side optimizations when processing
the events in a group. Available for both Webhooks and WebSockets.
type: boolean
batchTimeout:
description: When batching is enabled, the optional timeout
Expand Down Expand Up @@ -37760,8 +37766,9 @@ paths:
description: Events are delivered in batches in an ordered
array. The batch size is capped to the readAhead limit.
The event payload is always an array even if there is a
single event in the batch. Commonly used with Webhooks to
allow events to be delivered and acknowledged in batches.
single event in the batch, allowing client-side optimizations
when processing the events in a group. Available for both
Webhooks and WebSockets.
type: boolean
batchTimeout:
description: When batching is enabled, the optional timeout
Expand Down Expand Up @@ -38093,8 +38100,9 @@ paths:
description: Events are delivered in batches in an ordered
array. The batch size is capped to the readAhead limit.
The event payload is always an array even if there is a
single event in the batch. Commonly used with Webhooks to
allow events to be delivered and acknowledged in batches.
single event in the batch, allowing client-side optimizations
when processing the events in a group. Available for both
Webhooks and WebSockets.
type: boolean
batchTimeout:
description: When batching is enabled, the optional timeout
Expand Down
4 changes: 2 additions & 2 deletions internal/coremsgs/en_struct_descriptions.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright © 2023 Kaleido, Inc.
// Copyright © 2024 Kaleido, Inc.
//
// SPDX-License-Identifier: Apache-2.0
//
Expand Down Expand Up @@ -540,7 +540,7 @@ var (
SubscriptionCoreOptionsFirstEvent = ffm("SubscriptionCoreOptions.firstEvent", "Whether your application would like to receive events from the 'oldest' event emitted by your FireFly node (from the beginning of time), or the 'newest' event (from now), or a specific event sequence. Default is 'newest'")
SubscriptionCoreOptionsReadAhead = ffm("SubscriptionCoreOptions.readAhead", "The number of events to stream ahead to your application, while waiting for confirmation of consumption of those events. At least once delivery semantics are used in FireFly, so if your application crashes/reconnects this is the maximum number of events you would expect to be redelivered after it restarts")
SubscriptionCoreOptionsWithData = ffm("SubscriptionCoreOptions.withData", "Whether message events delivered over the subscription, should be packaged with the full data of those messages in-line as part of the event JSON payload. Or if the application should make separate REST calls to download that data. May not be supported on some transports.")
SubscriptionCoreOptionsBatch = ffm("SubscriptionCoreOptions.batch", "Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch. Commonly used with Webhooks to allow events to be delivered and acknowledged in batches.")
SubscriptionCoreOptionsBatch = ffm("SubscriptionCoreOptions.batch", "Events are delivered in batches in an ordered array. The batch size is capped to the readAhead limit. The event payload is always an array even if there is a single event in the batch, allowing client-side optimizations when processing the events in a group. Available for both Webhooks and WebSockets.")
SubscriptionCoreOptionsBatchTimeout = ffm("SubscriptionCoreOptions.batchTimeout", "When batching is enabled, the optional timeout to send events even when the batch hasn't filled.")

// TokenApproval field descriptions
Expand Down
Loading