matrix.org/static/jira/browse/SPEC-314

59 lines
2.3 KiB
Plaintext

---
summary: Provide a specification for the various types of ID strings
---
created: 2015-12-26 08:09:12.0
creator: jimmycuadra
description: |-
There a few different kinds of IDs in the Matrix specification. In some cases the user has the user has the ability to choose what an ID will be for a given event or record, but sometimes they are generated by the server. In either case, the specification should be explicit about any formatting and uniqueness restrictions on IDs. Even if these values have no constraints and are dependent on the server implementation, this should be stated explicitly. For example, it's stated that a user ID local part must be generated by the server if not supplied by the user during the registration process, but there's no information about how this value would be generated and what its constraints are.
All the types of IDs I can think of:
* Call ID
* Event ID
* Filter ID
* Media ID
* Room ID
* Session ID
* Transaction ID
* User ID
id: '12245'
key: SPEC-314
number: '314'
priority: '3'
project: '10001'
reporter: jimmycuadra
resolution: '3'
resolutiondate: 2016-04-19 12:08:07.0
status: '5'
type: '4'
updated: 2016-04-19 12:08:07.0
votes: '0'
watches: '2'
workflowId: '12348'
---
actions:
- author: jimmycuadra
body: In Synapse, when a user ID is generated by the server, it consists of a string beginning with "-" followed by 18 random ASCII letters. There's also a check to ensure user ID local parts supplied in the registration request don't contain characters that need to be URL encoded. It's not clear which of these constraints, if any, are required by the spec and which are just implementation details of Synapse.
created: 2016-02-09 09:39:53.0
id: '12599'
issue: '12245'
type: comment
updateauthor: jimmycuadra
updated: 2016-02-09 09:39:53.0
- author: richvdh
body: This is part of SPEC-1, which is a topic I hope to start addressing imminently.
created: 2016-04-18 16:15:49.0
id: '12836'
issue: '12245'
type: comment
updateauthor: richvdh
updated: 2016-04-18 16:15:49.0
- author: richvdh
body: I think these are now covered by the children of SPEC-1, so I'm going to close this.
created: 2016-04-19 12:07:37.0
id: '12852'
issue: '12245'
type: comment
updateauthor: richvdh
updated: 2016-04-19 12:07:37.0