summary refs log tree commit diff
path: root/docs/client-server/swagger_matrix/api-docs-profile
blob: 188259fa3d1b0bf800812af4e8bfe4cf12669529 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
{
  "apiVersion": "1.0.0",
  "swaggerVersion": "1.2",
  "basePath": "http://localhost:8080/_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."
        }
      }
    }
  }
}