Merge pull request #269 from matrix-org/dbkr/profile_return_null

Clarify what profile endpoints return if avatar url / display name isn't set
This commit is contained in:
David Baker 2016-02-03 15:07:54 +00:00
commit 2e1c2c23e4

View file

@ -87,7 +87,7 @@ paths:
properties: properties:
displayname: displayname:
type: string type: string
description: The user's display name if they have set one. description: The user's display name if they have set one, otherwise not present.
404: 404:
description: There is no display name for this user or this user does not exist. description: There is no display name for this user or this user does not exist.
tags: tags:
@ -161,7 +161,7 @@ paths:
properties: properties:
avatar_url: avatar_url:
type: string type: string
description: The user's avatar URL if they have set one. description: The user's avatar URL if they have set one, otherwise not present.
404: 404:
description: There is no avatar URL for this user or this user does not exist. description: There is no avatar URL for this user or this user does not exist.
tags: tags:
@ -195,10 +195,10 @@ paths:
properties: properties:
avatar_url: avatar_url:
type: string type: string
description: The user's avatar URL if they have set one. description: The user's avatar URL if they have set one, otherwise not present.
displayname: displayname:
type: string type: string
description: The user's display name if they have set one. description: The user's display name if they have set one, otherwise not present.
404: 404:
description: There is no profile information for this user or this user does not exist. description: There is no profile information for this user or this user does not exist.
tags: tags: