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.

Sign up for GitHub

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

Jump to bottom

publicRooms and thirdparty protocols lack in documentation #833

Open
t3chguy opened this issue May 19, 2021 · 0 comments · May be fixed by #2051
Open

publicRooms and thirdparty protocols lack in documentation #833

t3chguy opened this issue May 19, 2021 · 0 comments · May be fixed by #2051
Labels
clarification An area where the expected behaviour is understood, but the spec could do with being more explicit

Comments

@t3chguy
Copy link
Member

t3chguy commented May 19, 2021

https://matrix.org/docs/spec/client_server/r0.6.1#get-matrix-client-r0-thirdparty-protocols does not sufficiently describe the shape of the response, it tells you about the various types within it but not that the response is a Map<string, Protocol> nor that field_types is of type Map<string, FieldType>

ProtocolInstance also does not document the instance_id field which Synapse emits and Element depends on.
https://matrix.org/docs/spec/client_server/r0.6.1#post-matrix-client-r0-publicrooms seems to also depend on it for the third_party_instance_id field.
jsparber referenced this issue in jsparber/ruma Jun 9, 2021
@jsparber
common: Add instance-id field to ProtocolInstance
ab5ae72 
It's not included in the specs.
See https://github.com/matrix-org/matrix-doc/issues/3203
@jsparber jsparber mentioned this issue Jun 9, 2021
Merged
jsparber referenced this issue in jsparber/ruma Jun 9, 2021
@jsparber
common: Add instance-id field to ProtocolInstance
1a71043 
It's not included in the specs.
See https://github.com/matrix-org/matrix-doc/issues/3203
jplatte referenced this issue in ruma/ruma Jun 9, 2021
@jsparber @jplatte
common: Add instance-id field to ProtocolInstance
9d34524 
It's not included in the specs.
See https://github.com/matrix-org/matrix-doc/issues/3203
@richvdh richvdh transferred this issue from matrix-org/matrix-spec-proposals Mar 2, 2022
@turt2live turt2live added the clarification An area where the expected behaviour is understood, but the spec could do with being more explicit label May 28, 2022
@zecakeh zecakeh mentioned this issue Sep 26, 2023
Merged
@zecakeh zecakeh linked a pull request Jan 13, 2025 that will close this issue
Open
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
clarification An area where the expected behaviour is understood, but the spec could do with being more explicit
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Document the instance_id field of Protocol Instance in the CS API zecakeh/matrix-spec
2 participants
@turt2live @t3chguy