Skip to content

Updated message spec and related endpoints - #270

Open
sacOO7 wants to merge 3 commits into
mainfrom
fix/operation-struct
Open

Updated message spec and related endpoints#270
sacOO7 wants to merge 3 commits into
mainfrom
fix/operation-struct

Conversation

@sacOO7

@sacOO7sacOO7 commented Jan 21, 2025

Copy link
Copy Markdown
Contributor

@sacOO7sacOO7 changed the title Fix operation structFix message operation structJan 21, 2025
@sacOO7
sacOO7force-pushed the fix/operation-struct branch from 1d76f98 to 9b04985CompareJanuary 21, 2025 13:50
@sacOO7
sacOO7 marked this pull request as ready for review January 21, 2025 13:52
@sacOO7sacOO7 changed the title Fix message operation structAdded note for operation metadata typeJan 21, 2025
@sacOO7
sacOO7force-pushed the fix/operation-struct branch from a948cc6 to a5baa77CompareJanuary 22, 2025 12:09
@sacOO7sacOO7 changed the title Added note for operation metadata typeUpdated message spec and related endpointsJan 22, 2025

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
Copy Markdown
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>.


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
Copy Markdown
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?

"baz": "qux"
},
}
"createdAt": 1726232498871,

Copy link
Copy Markdown
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.

}
"serial": "01726232498871-001@abcdefghij:001",
"version": "01726585978590-001@abcdefghij:001"
"serial": "01726585978590-001@abcdefghij:001",

Copy link
Copy Markdown
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.

@lawrence-forooghian

Copy link
Copy Markdown
Contributor

Hey @sacOO7, this one has been open for a while; I was wondering if you're planning to address the feedback?

@sacOO7

Copy link
Copy Markdown
ContributorAuthor

Yeah thanks @lawrence-forooghian I am planning to address this 👍

Sign up for freeto 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.

3 participants

@sacOO7@lawrence-forooghian@AndyTWF