Document threepids #1068
Merged
Document threepids #1068
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
Adds the /msisdn' 3pid type and generally fleshes out what a 3pid is and how they work. This merges most of the work from Max Dor in #1039 with some tweaks and additions.
|
cc @maxidor fwiw. |
richvdh
reviewed
Nov 14, 2017
specification/targets.yaml
Outdated
| @@ -33,6 +33,7 @@ targets: | |||
| files: | |||
| - appendices.rst | |||
| - appendices/base64.rst | |||
| - appendices/threepids.rst | |||
There was a problem hiding this comment.
this feels a bit weird shoved in between base64 and signing json. Any reason to put it here?
There was a problem hiding this comment.
Yeah, I see what you mean. I've moved it to before the threat vectors stuff.
api/identity/lookup.yaml
Outdated
| @@ -32,13 +34,13 @@ paths: | |||
| type: string | |||
| name: medium | |||
| required: true | |||
| description: The literal string "email". | |||
| description: The medium type of the 3pid. See `Appendices`_. | |||
There was a problem hiding this comment.
can you make these links more specific too?
richvdh
reviewed
Nov 14, 2017
|
|
||
| 3PID Types | ||
| ---------- | ||
| 3PIDs represent identifiers on other namespaces that might be associated with a |
There was a problem hiding this comment.
can we spell this out in full? "Third-party identifiers (3PIDs) ..."
richvdh
reviewed
Nov 14, 2017
| well-defined manner. | ||
|
|
||
| For example, for e-mail, the `medium` is 'email' and the `address` would be the | ||
| email address, eg. the string 'bob@example.com'. Since domain resolution is |
There was a problem hiding this comment.
probably want double-backticks here to stop them being linkified
richvdh
reviewed
Nov 14, 2017
| 3PID Types | ||
| ---------- | ||
| 3PIDs represent identifiers on other namespaces that might be associated with a | ||
| particular person. They comprise a tuple of `medium` which is a string that |
richvdh
reviewed
Nov 14, 2017
| ---------- | ||
| 3PIDs represent identifiers on other namespaces that might be associated with a | ||
| particular person. They comprise a tuple of `medium` which is a string that | ||
| identifies the namespace in which the identifier exists and an `address`: a |
| particular person. They comprise a tuple of `medium` which is a string that | ||
| identifies the namespace in which the identifier exists and an `address`: a | ||
| string representing the identifier in that namespace. This must be a canonical | ||
| form of the identifier, ie. if multiple strings could represent the same |
There was a problem hiding this comment.
i.e., and normally we italicise it because it's like foreign innit
*i.e.*
(and consequently rejig all the fixed-width formatting)
richvdh
approved these changes
Nov 14, 2017
| might be associated with a particular person. They comprise a tuple of ``medium`` | ||
| which is a string that identifies the namespace in which the identifier exists, | ||
| and an ``address``: a string representing the identifier in that namespace. This | ||
| must be a canonical form of the identifier, *ie.* if multiple strings could |
There was a problem hiding this comment.
still needs a . in the middle please
| address, in a well-defined manner. | ||
|
|
||
| For example, for e-mail, the ``medium`` is 'email' and the ``address`` would be the | ||
| email address, eg. the string ``bob@example.com``. Since domain resolution is |
| Medium: ``email`` | ||
|
|
||
| Represents E-Mail addresses. The ``address`` is the raw email address in | ||
| user@domain form with the domain in lowercase. It must not contain other text |
|
|
||
| For example, for e-mail, the ``medium`` is 'email' and the ``address`` would be the | ||
| email address, eg. the string ``bob@example.com``. Since domain resolution is | ||
| case-insensitive, the email address ``bob@Example.com`` also has a 3PID address |
There was a problem hiding this comment.
I don't really understand this sentence, but it may be better to just land it and worry about clarifying it later.
There was a problem hiding this comment.
have added an attempt to make it clearer
|
Awesome! thanks |
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.
Adds the
msisdn3pid type and generally fleshes out what a 3pidis and how they work.
This merges most of the work from Max Dor in #1039
with some tweaks and additions.