Document the instance_id field of Protocol Instance in the CS API
#2051
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It is used as the `third_party_instance_id` of `POST /_matrix/client/v3/publicRooms`. It has always been present since before the thirdparty protocol endpoints were added to the spec. Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It is used as the
third_party_instance_idofPOST /_matrix/client/v3/publicRooms.It has always been present since before the thirdparty protocol endpoints were added to the spec:
I marked it as required because that is how it is defined in the TypeScript definition of the type in matrix-js-sdk, and according to the corresponding code in Synapse it is defined if
network_idis defined, and according to the spec the latter is required.Fixes #833.
Pull Request Checklist
Preview: https://pr2051--matrix-spec-previews.netlify.app