mirror of
https://mau.dev/maunium/synapse.git
synced 2024-11-18 07:52:56 +01:00
122 lines
3.2 KiB
Text
122 lines
3.2 KiB
Text
{
|
|
"apiVersion": "1.0.0",
|
|
"swaggerVersion": "1.2",
|
|
"basePath": "http://localhost:8008/_matrix/client/api/v1",
|
|
"resourcePath": "/profile",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"apis": [
|
|
{
|
|
"path": "/profile/{userId}/displayname",
|
|
"operations": [
|
|
{
|
|
"method": "PUT",
|
|
"summary": "Set a display name.",
|
|
"notes": "This can only be done by the logged in user.",
|
|
"type": "void",
|
|
"nickname": "set_display_name",
|
|
"parameters": [
|
|
{
|
|
"name": "body",
|
|
"description": "The new display name for this user.",
|
|
"required": true,
|
|
"type": "DisplayName",
|
|
"paramType": "body"
|
|
},
|
|
{
|
|
"name": "userId",
|
|
"description": "The user whose display name to set.",
|
|
"required": true,
|
|
"type": "string",
|
|
"paramType": "path"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"method": "GET",
|
|
"summary": "Get a display name.",
|
|
"notes": "This can be done by anyone.",
|
|
"type": "DisplayName",
|
|
"nickname": "get_display_name",
|
|
"parameters": [
|
|
{
|
|
"name": "userId",
|
|
"description": "The user whose display name to get.",
|
|
"required": true,
|
|
"type": "string",
|
|
"paramType": "path"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path": "/profile/{userId}/avatar_url",
|
|
"operations": [
|
|
{
|
|
"method": "PUT",
|
|
"summary": "Set an avatar URL.",
|
|
"notes": "This can only be done by the logged in user.",
|
|
"type": "void",
|
|
"nickname": "set_avatar_url",
|
|
"parameters": [
|
|
{
|
|
"name": "body",
|
|
"description": "The new avatar url for this user.",
|
|
"required": true,
|
|
"type": "AvatarUrl",
|
|
"paramType": "body"
|
|
},
|
|
{
|
|
"name": "userId",
|
|
"description": "The user whose avatar url to set.",
|
|
"required": true,
|
|
"type": "string",
|
|
"paramType": "path"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"method": "GET",
|
|
"summary": "Get an avatar url.",
|
|
"notes": "This can be done by anyone.",
|
|
"type": "AvatarUrl",
|
|
"nickname": "get_avatar_url",
|
|
"parameters": [
|
|
{
|
|
"name": "userId",
|
|
"description": "The user whose avatar url to get.",
|
|
"required": true,
|
|
"type": "string",
|
|
"paramType": "path"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"models": {
|
|
"DisplayName": {
|
|
"id": "DisplayName",
|
|
"properties": {
|
|
"displayname": {
|
|
"type": "string",
|
|
"description": "The textual display name"
|
|
}
|
|
}
|
|
},
|
|
"AvatarUrl": {
|
|
"id": "AvatarUrl",
|
|
"properties": {
|
|
"avatar_url": {
|
|
"type": "string",
|
|
"description": "A url to an image representing an avatar."
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|