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.

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

Updated message spec and related endpoints #270

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

sacOO7
Copy link
Collaborator

@sacOO7 sacOO7 commented Jan 21, 2025

@sacOO7 sacOO7 changed the title Fix operation struct Fix message operation struct Jan 21, 2025
@sacOO7 sacOO7 force-pushed the fix/operation-struct branch from 1d76f98 to 9b04985 Compare January 21, 2025 13:50
@sacOO7 sacOO7 marked this pull request as ready for review January 21, 2025 13:52
@sacOO7 sacOO7 changed the title Fix message operation struct Added note for operation metadata type Jan 21, 2025
@sacOO7 sacOO7 force-pushed the fix/operation-struct branch from a948cc6 to a5baa77 Compare January 22, 2025 12:09
@sacOO7 sacOO7 changed the title Added note for operation metadata type Updated message spec and related endpoints Jan 22, 2025
@@ -580,7 +574,7 @@ h3(#rest-updating-messages). Updating Messages
h4(#rest-updating-messages-request). Request

Below is the full REST payload format for the endpoint. The @description@, @headers@ and both @metadata@ keys are optional.

Note that outer @metadata@ is of type map<string, string>.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Note that outer @metadata@ is of type map<string, string>.
Note that the root level @metadata@ field is of type map<string, string>.

@@ -518,7 +512,7 @@ h4(#rest-sending-messages-request-v1). Corresponding Realtime Event V1 @(depreca
h4(#rest-sending-messages-request-v2). Request V2

Below is the full REST payload format for the V2 endpoint. The @metadata@ and @headers@ keys are optional.

Note that @metadata@ is of type map<string, any> or jsonObject.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We probably don't need to specify jsonObject here - map<string, any> covers everything?

"extras": {
"headers": {
"baz": "qux"
},
}
"createdAt": 1726232498871,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The timestamp here should match that in the serial.

"extras": {
"headers": {
"baz": "qux"
}
}
"serial": "01726232498871-001@abcdefghij:001",
"version": "01726585978590-001@abcdefghij:001"
"serial": "01726585978590-001@abcdefghij:001",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The createdAt should match the timestamp in the serial.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants