Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-01-10 18:03:41 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Add profile API examples and extract examples for template usage.

Browse source
This commit is contained in:
Kegan Dougal 2015-06-01 10:44:03 +01:00
parent fe7ffafc15
commit 5795e1ceda
2 changed files with 20 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
api/client-server/v1/profile.yaml
View file

@ -42,6 +42,9 @@ paths:
responses:
200:
description: The display name was set.
examples:
application/json: |-
{}
schema:
type: object # empty json object
429:
@ -59,6 +62,11 @@ paths:
responses:
200:
description: The display name for this user.
examples:
application/json: |-
{
"displayname": "Alice Margatroid"
}
schema:
type: object
properties:
@ -91,6 +99,9 @@ paths:
responses:
200:
description: The avatar URL was set.
examples:
application/json: |-
{}
schema:
type: object # empty json object
429:
@ -108,6 +119,11 @@ paths:
responses:
200:
description: The avatar URL for this user.
examples:
application/json: |-
{
"avatar_url": "mxc://matrix.org/SDGdghriugerRg"
}
schema:
type: object
properties:

5
templating/matrix_templates/units.py
View file

@ -184,7 +184,10 @@ class MatrixUnits(Units):
"code": 200,
"http": "200 OK",
"desc": res200["description"],
"params": res200params
"params": res200params,
"example": res200.get("examples", {}).get(
"application/json", ""
)
}
endpoint["responses"].append(ok_res)