Clarify formats of string types in account sections #2046
Conversation
Signed-off-by: Kévin Commaille <[email protected]>
…tion Signed-off-by: Kévin Commaille <[email protected]>
Signed-off-by: Kévin Commaille <[email protected]>
Signed-off-by: Kévin Commaille <[email protected]>
| anyOf: | ||
| - type: string | ||
| format: uri | ||
| - type: "null" |
There was a problem hiding this comment.
I also changed this definition to make it clearer that a null value has a different meaning than if the field is absent.
| @@ -120,6 +120,7 @@ paths: | |||
| description: The client secret used in the session with the identity server. | |||
| id_server: | |||
| type: string | |||
| format: mx-server-name | |||
There was a problem hiding this comment.
are you sure that id_server is supposed to be a server name?
AIUI, synapse accepts things with trailing paths here, which is obviously not allowed by a server name.
See also matrix-org/synapse#9802 (comment) which has a bit of historical debate about this. It's certainly questionable whether Synapse should allow trailing paths here, but changing it probably needs an MSC.
There was a problem hiding this comment.
I am not sure of anything, this is what I understood from descriptions like:
The hostname of the identity server to communicate with. May optionally include a port.
But it is indeed not clear everywhere what this should look like, and looking at the PR you linked it is clear that at least Synapse allows to set a path too.
So I will revert the changes about id_server. Should we open an issue that this needs to be clarified?
There was a problem hiding this comment.
Should we open an issue that this needs to be clarified?
I think that would be a great idea, yes.
There was a problem hiding this comment.
Alright I reverted the id_server formats and opened #2056.
Signed-off-by: Kévin Commaille <[email protected]>
This should cover sections 4.7 through 4.9 of the CS API.
Pull Request Checklist
Preview: https://pr2046--matrix-spec-previews.netlify.app