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 direct get request payload in ADR-31 #324

Merged
merged 1 commit into from
Feb 4, 2025
Merged

Update direct get request payload in ADR-31 #324

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
33 changes: 20 additions & 13 deletions adr/ADR-31.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,23 +75,30 @@ When Allow Direct is true, each of the stream's servers configures a responder a
Clients may make requests with the same payload as the Get message API populating the following server struct:

```text
Seq uint64 `json:"seq,omitempty"`
LastFor string `json:"last_by_subj,omitempty"`
NextFor string `json:"next_by_subj,omitempty"`
Batch int `json:"batch,omitempty"`
MaxBytes int `json:"max_bytes,omitempty"`
StartTime *time.Time `json:"start_time,omitempty"`
Seq uint64 `json:"seq,omitempty"`
LastFor string `json:"last_by_subj,omitempty"`
NextFor string `json:"next_by_subj,omitempty"`
Batch int `json:"batch,omitempty"`
MaxBytes int `json:"max_bytes,omitempty"`
StartTime *time.Time `json:"start_time,omitempty"`
MultiLastFor []string `json:"multi_last,omitempty"`
UpToSeq uint64 `json:"up_to_seq,omitempty"`
UpToTime *time.Time `json:"up_to_time,omitempty"`
```

Example request payloads:

* `{seq: number}` - get a message by sequence
* `{last_by_subj: string}` - get the last message having the subject
* `{next_by_subj: string}` - get the first message (lowest seq) having the specified subject
* `{start_time: string}` - get the first message at or newer than the time specified in RFC 3339 format (since server 2.11)
* `{seq: number, next_by_subj: string}` - get the first message with a seq >= to the input seq that has the specified subject
* `{seq: number, batch: number, next_by_subj: string}` - gets up to batch number of messages >= than seq that has specified subject
* `{seq: number, batch: number, next_by_subj: string, max_bytes: number}` - as above but limited to a maximum size of messages received in bytes
- `{seq: number}` - get a message by sequence
- `{last_by_subj: string}` - get the last message having the subject
- `{next_by_subj: string}` - get the first message (lowest seq) having the specified subject
- `{start_time: string}` - get the first message at or newer than the time specified in RFC 3339 format (since server 2.11)
- `{seq: number, next_by_subj: string}` - get the first message with a seq >= to the input seq that has the specified subject
- `{seq: number, batch: number, next_by_subj: string}` - gets up to batch number of messages >= than seq that has specified subject
- `{seq: number, batch: number, next_by_subj: string, max_bytes: number}` - as above but limited to a maximum size of messages received in bytes
- `{multi_last: [string]}` - get the last message for each subject in the list (subjects can include wildcards)
- `{multi_last: [string], up_to_seq: number}` - get the last message for each subject in the list up to the sequence number
- `{multi_last: [string], up_to_time: string}` - get the last message for each subject in the list up to the time specified in RFC 3339 format
- `{multi_last: [string], batch: number}` - get the last message for each subject in the list up to the batch size

#### Subject-Appended Direct Get API

Expand Down