s2s/query: clarify profile behaviour and API responses#2326
s2s/query: clarify profile behaviour and API responses#2326famfo wants to merge 4 commits intomatrix-org:mainfrom
Conversation
| The display name of the user. MUST either be omitted or set to `null` if | ||
| the user does not have a display name set. |
There was a problem hiding this comment.
Aside: I was a bit surprised by this, but then I found d914c40, and this seems to be just a clarification of that changes.
|
@richvdh it's not clear to me if this is ready to merge or not |
|
sorry, I thought it was, but then I saw the requests from @zecakeh for further changes |
Signed-off-by: famfo <famfo@famfo.xyz>
|
@famfo please don't force-push between rounds of review: it makes it very hard to see what has changed since the previous round. |
| public, such as the display name and avatar. | ||
| The profile for the user. If a `field` is specified in the request, the response | ||
| MUST only included the specified `field`. If no `field` was specified, the response | ||
| SHOULD include all of the fields of the user's profile, which can be made public. |
There was a problem hiding this comment.
This doesn't mean what you want it to mean. In any case, why have you removed the examples of display name and avatar?
| SHOULD include all of the fields of the user's profile, which can be made public. | |
| SHOULD include all of the fields of the user's profile that can be made | |
| public, such as the display name and avatar. |
There was a problem hiding this comment.
Huh, why doesn't that mean what I want it to?
Anyway, I recently encountered a case where this was explicitly not the case but yea, it might be slightly pedantic to remove the note.
There was a problem hiding this comment.
Huh, why doesn't that mean what I want it to?
Because of the comma. "The response SHOULD include all of the fields of the user's profile, which can be made public" means "The response SHOULD include all of the fields of the user's profile. Also, the profile can be made public".
Obviously, it's not the case that the whole of the user's profile can be made public, but that's what's implied by your sentence.
Are you a native German speaker by any chance? I think this is a difference between German and English. (And, for the record, my German is far far worse than your English, so please don't take this as a criticism!)
There was a problem hiding this comment.
Ok this is the only outstanding thread on this PR. If you're happy with my suggestion, please commit it and we can merge.
6 participants
Since the existing specification of the behavior is relatively fuzzy, I have chosen the stricter interpretations from multiple places saying something similar.
Pull Request Checklist
Preview: https://pr2326--matrix-spec-previews.netlify.app