Specification for MSC4311: Create event availability in stripped state#2207
Conversation
| x-changedInMatrixVersion: | ||
| "1.16": | | ||
| `m.room.create` and format requirements were added. |
There was a problem hiding this comment.
(I am belatedly wishing that we had just deprecated /v1/invite and mandated that everyone uses /v2, rather than adding more changes to /v1.)
Do you think it's worth trying to do some $ref trickery to reduce the duplication in the yaml, at least?
There was a problem hiding this comment.
I've been bitten by $ref not working in weird and unpredictable ways in the past, so I'm incentivized to copy/paste. The endpoints are also slightly different in error responses, which makes it especially annoying.
If given a choice, I'd rather not fight $ref more than I already have to.
There was a problem hiding this comment.
I think that @zecakeh has done a bunch of work to make $ref work better, so it might be worth taking another look.
The endpoints are also slightly different in error responses, which makes it especially annoying.
Ok, but you don't have to duplicate the whole endpoint -- you can just share some parameter type definitions, for example.
I'm really not a big fan of having two copies of all this stuff - it makes it much harder to maintain and review. Doing this review was particularly annoying because I kept getting confused about which bits I'd seen and which I hadn't. Making the job harder for the reviewer to save a bit of authoring time is not a great investment.
I'll not insist on it this time around though.
There was a problem hiding this comment.
The concern with the error responses is that it's harder to deduplicate that part is all - the request parameters can be deduplicated, but that's only so helpful.
I'll experiment with $ref separate from this, and open a PR if it works.
richvdh
left a comment
There was a problem hiding this comment.
A few things I'd still like to see cleaned up, but no blockers here from me
| x-changedInMatrixVersion: | ||
| "1.16": | | ||
| `m.room.create` and format requirements were added. |
There was a problem hiding this comment.
I think that @zecakeh has done a bunch of work to make $ref work better, so it might be worth taking another look.
The endpoints are also slightly different in error responses, which makes it especially annoying.
Ok, but you don't have to duplicate the whole endpoint -- you can just share some parameter type definitions, for example.
I'm really not a big fan of having two copies of all this stuff - it makes it much harder to maintain and review. Doing this review was particularly annoying because I kept getting confused about which bits I'd seen and which I hadn't. Making the job harder for the reviewer to save a bit of authoring time is not a great investment.
I'll not insist on it this time around though.
MSC: matrix-org/matrix-spec-proposals#4311
Reviewable(ish) commit-by-commit.
Note: In line with existing spec, this change reminds readers constantly about the event format being different depending on room version.
Pull Request Checklist
Preview: https://pr2207--matrix-spec-previews.netlify.app