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

"Attachments" used throughout the text but unclear at first reading. #53

Open
daidoji opened this issue Feb 12, 2024 · 3 comments
Open
Assignees
Labels

Comments

@daidoji
Copy link
Contributor

daidoji commented Feb 12, 2024

In https://trustoverip.github.io/tswg-cesr-specification/#terms-and-definitions we have the definition

Message
Consists of a serialized data structure that comprises its body and a set of serialized data structures that are its attachments. Attachments may include but are not limited to signatures on the body.

This could be considered sufficient as we do specify that they're just serialized data structures that follow the message but is a bit confusing as a reader until you find this definition (with sub-definition for attachments embedded).

I wasn't quite sure though how to fix this in a PR so I created this issue so that wiser heads than mine could think about it. It came up as I'm working with my partner who doesn't really read the specs as closely as I do and there was some ambiguity until we searched around for a bit in the spec.

A fix for this issue might be one or more of the following (but I don't know which is best):

  1. More concrete representations in the spec with "message" and "attachments" that will come over the wire clearly specified.
  2. Another definition for "attachment" specifically pulled out from that message definition above.
  3. A general description in "Composability and Domain Representations" section of Messages and Attachments of what these things will look like over the wire (maybe just in the text domain with a link to how it can be sent in the binary domain).
@pfeairheller
Copy link
Contributor

Discussed 2024-02-13: We should promote the mention of "Attachment" in the definition of "Message" to its own definition.

@SmithSamuelM
Copy link
Contributor

Added description of messages as message body plus attachments to introduction. Added explanitory text for self-framing groups not just primiitives.

@SmithSamuelM
Copy link
Contributor

Woops. still need definition of Attachment separate from Message, Message Body

@SmithSamuelM SmithSamuelM reopened this Feb 15, 2024
@pfeairheller pfeairheller self-assigned this Apr 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants