Skip to content

Commit 8c5bd49

Browse files
authored
Merge branch 'main' into typo-fix
2 parents fa191b8 + a96b39f commit 8c5bd49

File tree

88 files changed

+1627
-266
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

88 files changed

+1627
-266
lines changed

.gitignore

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,6 @@ __debug*
1212
!deploy/charts/firefly
1313
containerlogs
1414
.vscode/*.log
15-
.idea
16-
doc-site/site
15+
.idea/
16+
doc-site/site
17+
*.iml

.golangci.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ linters-settings:
2121
values:
2222
regexp:
2323
COMPANY: .*
24+
YEAR: '\d\d\d\d(-\d\d\d\d)?'
2425
template: |-
2526
Copyright © {{ YEAR }} {{ COMPANY }}
2627

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ GOGC=30
1414

1515
all: build test go-mod-tidy
1616
test: deps lint
17-
$(VGO) test ./internal/... ./pkg/... ./cmd/... ./doc-site ./ffconfig/... -cover -coverprofile=coverage.txt -covermode=atomic -timeout=30s ${TEST_ARGS}
17+
$(VGO) test ./internal/... ./pkg/... ./cmd/... ./doc-site ./ffconfig/... -cover -coverprofile=coverage.txt -covermode=atomic -timeout=45s ${TEST_ARGS}
1818
coverage.html:
1919
$(VGO) tool cover -html=coverage.txt
2020
coverage: test coverage.html

doc-site/docs/reference/types/subscription.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ title: Subscription
8686
| Field Name | Description | Type |
8787
|------------|-------------|------|
8888
| `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` |
89-
| `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` |
89+
| `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 | `uint` |
9090
| `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` |
9191
| `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` |
9292
| `batchTimeout` | When batching is enabled, the optional timeout to send events even when the batch hasn't filled. | `string` |

doc-site/docs/reference/types/wsstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ title: WSStart
7777
| Field Name | Description | Type |
7878
|------------|-------------|------|
7979
| `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` |
80-
| `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` |
80+
| `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 | `uint` |
8181
| `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` |
8282
| `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` |
8383
| `batchTimeout` | When batching is enabled, the optional timeout to send events even when the batch hasn't filled. | `string` |

doc-site/docs/swagger/swagger.yaml

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -29287,7 +29287,6 @@ paths:
2928729287
used in FireFly, so if your application crashes/reconnects
2928829288
this is the maximum number of events you would expect
2928929289
to be redelivered after it restarts
29290-
maximum: 65535
2929129290
minimum: 0
2929229291
type: integer
2929329292
reply:
@@ -29572,7 +29571,6 @@ paths:
2957229571
At least once delivery semantics are used in FireFly, so if
2957329572
your application crashes/reconnects this is the maximum number
2957429573
of events you would expect to be redelivered after it restarts
29575-
maximum: 65535
2957629574
minimum: 0
2957729575
type: integer
2957829576
reply:
@@ -29846,7 +29844,6 @@ paths:
2984629844
in FireFly, so if your application crashes/reconnects this
2984729845
is the maximum number of events you would expect to be redelivered
2984829846
after it restarts
29849-
maximum: 65535
2985029847
minimum: 0
2985129848
type: integer
2985229849
reply:
@@ -30128,7 +30125,6 @@ paths:
3012830125
At least once delivery semantics are used in FireFly, so if
3012930126
your application crashes/reconnects this is the maximum number
3013030127
of events you would expect to be redelivered after it restarts
30131-
maximum: 65535
3013230128
minimum: 0
3013330129
type: integer
3013430130
reply:
@@ -30402,7 +30398,6 @@ paths:
3040230398
in FireFly, so if your application crashes/reconnects this
3040330399
is the maximum number of events you would expect to be redelivered
3040430400
after it restarts
30405-
maximum: 65535
3040630401
minimum: 0
3040730402
type: integer
3040830403
reply:
@@ -30750,7 +30745,6 @@ paths:
3075030745
in FireFly, so if your application crashes/reconnects this
3075130746
is the maximum number of events you would expect to be redelivered
3075230747
after it restarts
30753-
maximum: 65535
3075430748
minimum: 0
3075530749
type: integer
3075630750
reply:
@@ -38574,7 +38568,6 @@ paths:
3857438568
used in FireFly, so if your application crashes/reconnects
3857538569
this is the maximum number of events you would expect
3857638570
to be redelivered after it restarts
38577-
maximum: 65535
3857838571
minimum: 0
3857938572
type: integer
3858038573
reply:
@@ -38852,7 +38845,6 @@ paths:
3885238845
At least once delivery semantics are used in FireFly, so if
3885338846
your application crashes/reconnects this is the maximum number
3885438847
of events you would expect to be redelivered after it restarts
38855-
maximum: 65535
3885638848
minimum: 0
3885738849
type: integer
3885838850
reply:
@@ -39126,7 +39118,6 @@ paths:
3912639118
in FireFly, so if your application crashes/reconnects this
3912739119
is the maximum number of events you would expect to be redelivered
3912839120
after it restarts
39129-
maximum: 65535
3913039121
minimum: 0
3913139122
type: integer
3913239123
reply:
@@ -39401,7 +39392,6 @@ paths:
3940139392
At least once delivery semantics are used in FireFly, so if
3940239393
your application crashes/reconnects this is the maximum number
3940339394
of events you would expect to be redelivered after it restarts
39404-
maximum: 65535
3940539395
minimum: 0
3940639396
type: integer
3940739397
reply:
@@ -39675,7 +39665,6 @@ paths:
3967539665
in FireFly, so if your application crashes/reconnects this
3967639666
is the maximum number of events you would expect to be redelivered
3967739667
after it restarts
39678-
maximum: 65535
3967939668
minimum: 0
3968039669
type: integer
3968139670
reply:
@@ -40009,7 +39998,6 @@ paths:
4000939998
in FireFly, so if your application crashes/reconnects this
4001039999
is the maximum number of events you would expect to be redelivered
4001140000
after it restarts
40012-
maximum: 65535
4001340001
minimum: 0
4001440002
type: integer
4001540003
reply:

0 commit comments

Comments
 (0)