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

event examples include spurious 'age' field #1524

Closed
richvdh opened this issue Aug 16, 2018 · 3 comments
Closed

event examples include spurious 'age' field #1524

richvdh opened this issue Aug 16, 2018 · 3 comments
Labels
spec-bug Something which is in the spec, but is wrong

Comments

@richvdh
Copy link
Member

richvdh commented Aug 16, 2018

most of the event examples include an age field, which isn't really part of the event - in particular it will be absent over federation. /sync and /messages will add an age, but put it in the unsigned object. /intialSync probably does put an age where the examples suggest, but it's deprecated.

The example for m.room.redaction puts age under unsigned, but I'm not sure that's very clear either.

Basically I think we should remove both age and unsigned from these examples.

@richvdh
Copy link
Member Author

richvdh commented Aug 16, 2018

related: #684

@richvdh richvdh added the spec-bug Something which is in the spec, but is wrong label Aug 16, 2018
@turt2live
Copy link
Member

The age part is duplicated by #630, although the removal of unsigned where not necessary makes sense to me.

@turt2live
Copy link
Member

Related: #1294

turt2live added a commit to turt2live/matrix-doc that referenced this issue Aug 23, 2018
Fixes matrix-org#1269

This is also supposed to fix the 'age' problem, however that is a larger problem with the event schemas that is reserved for a future PR/commit.
Reference: matrix-org#1294
Reference: matrix-org#1524
turt2live added a commit to turt2live/matrix-doc that referenced this issue Aug 25, 2018
This commit adds support for event schema examples to have references to help reduce the chance of fields being forgotten. This also helps reduce duplication of fields, allowing for a more consistent spec that uses the same values everywhere.

This also removes both `unsigned` and `age` from the examples as per:
* matrix-org#1524
* matrix-org#630

Finally, this replaces "localhost" in the examples with an example domain. This is really just a nitpick thing on my part where seeing a "real world" domain is preferred. 

Fixes matrix-org#1524
Fixes matrix-org#630
Step towards https://github.com/matrix-org/matrix-doc/issues/1530
turt2live added a commit to turt2live/matrix-doc that referenced this issue Aug 29, 2018
This is useful for a lot of things, like bridges (appservices), VoIP handling, and clients which generally may wish to do something with the field. Might as well include it on every event, despite the recommendation of matrix-org#1524
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
spec-bug Something which is in the spec, but is wrong
Projects
None yet
Development

No branches or pull requests

2 participants