Tom Foster
f44ccf4c03
Update data/api/client-server/profile.yaml
...
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2025-08-06 07:46:42 +01:00
Richard van der Hoff
f2c14eee9c
Fix invalid YAML
2025-08-05 17:42:47 +01:00
Tom Foster
c9057ed1b0
Update data/api/client-server/profile.yaml
...
Co-authored-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2025-07-31 14:19:04 +01:00
Tom Foster
df9d3e6991
Update data/api/client-server/profile.yaml
...
Co-authored-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2025-07-31 14:18:26 +01:00
Tom Foster
c67980a58d
Update data/api/client-server/profile.yaml
...
Co-authored-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2025-07-31 14:10:39 +01:00
Tom Foster
e78b073bb8
Update data/api/client-server/profile.yaml
...
Co-authored-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2025-07-31 14:10:32 +01:00
Tom Foster
4408198e49
Update data/api/client-server/profile.yaml
...
Co-authored-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2025-07-31 14:10:20 +01:00
Tom Foster
0a87d1b0a1
Update data/api/client-server/profile.yaml
...
Co-authored-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2025-07-31 14:10:07 +01:00
Tom Foster
3da3b18779
Update data/api/client-server/profile.yaml
...
Co-authored-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2025-07-31 14:10:00 +01:00
Tom Foster
6a8b542d2c
Update data/api/client-server/profile.yaml
...
Co-authored-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2025-07-31 14:09:53 +01:00
Tom Foster
48ee9cf59c
Update data/api/client-server/profile.yaml
...
Co-authored-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2025-07-31 14:09:03 +01:00
Tom Foster
648c05002a
Update data/api/client-server/profile.yaml
...
Co-authored-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2025-07-31 14:08:41 +01:00
Tom Foster
b834933171
Update data/api/client-server/profile.yaml
...
Co-authored-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2025-07-31 14:08:24 +01:00
Tom Foster
5a082635f7
Update data/api/client-server/profile.yaml
...
Co-authored-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2025-07-31 14:08:13 +01:00
Patrick Cloke
6646146f8c
Accept minor suggestions from code review
...
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2025-06-13 10:26:20 -04:00
Tom Foster
6183f2410f
Clarify value validation requirements
2025-02-21 10:32:28 +00:00
Tom Foster
dd4ea948b6
Clarify why avatar_url and displayname can't be returned as null
2025-02-21 09:53:43 +00:00
Tom Foster
50eab3501e
Standardise line-wrapping and update avatar_url format to mx-mxc-uri
2025-02-21 09:28:46 +00:00
Tom Foster
37b1362bc1
Attempt to describe variable payload content
2025-02-20 18:08:10 +00:00
Tom Foster
d8cc250d20
Tag x-addedInMatrixVersion on additionalProperties in entire profile GET
2025-02-20 17:02:23 +00:00
Tom Foster
b5e2edf2e5
Add x-addedInMatrixVersion
2025-02-20 16:59:44 +00:00
Tom Foster
7ef1d9d0ec
Add x-changedInMatrixVersion
2025-02-20 16:56:53 +00:00
Tom Foster
3a5e5555fa
Correct PUT/GET payload definitions
2025-02-20 16:48:20 +00:00
Tom Foster
1cc93ec951
Attempt to make descriptions look better in HTML rendered spec
2025-02-14 14:53:29 +00:00
Tom Foster
79af78022e
Camel case for endpoint variables
2025-02-14 13:47:49 +00:00
Tom Foster
76b48e25d0
Specify CNIG pattern for custom fields
2025-02-14 12:56:16 +00:00
Tom Foster
9327793007
Inline information from MSC4133, remove links
2025-02-14 12:39:19 +00:00
Tom Foster
3311b084bf
Alphabetise avatar_url and displayname and remove redundant descriptions on displayname
2025-02-14 12:03:49 +00:00
Tom Foster
992cf9dc35
Clarify null behaviour for PUT and DELETE
2025-02-14 11:53:19 +00:00
Tom Foster
4f8999be0a
Tweak wording on full profile GET
2025-02-14 11:32:39 +00:00
Tom Foster
82adcec491
Clarify avatar_url should be MXC
2025-02-14 11:21:45 +00:00
Tom Foster
ee9b5ddcca
Correct types and errors
2025-02-14 11:02:11 +00:00
Tom Foster
59d2c62d2d
Link to MSC4133 in endpoint descriptions
2025-02-14 10:40:09 +00:00
Tom Foster
fdc012ac01
Describe MSC4133 profile endpoint changes
2025-02-13 17:54:21 +00:00
Johannes Marbach
871c10577e
MSC4170: 403 error responses for profile APIs ( #1867 )
...
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2024-10-07 10:45:17 +01:00
Johannes Marbach
5d91b628c9
Don't mention that GET /_matrix/client/v3/profile/{userId} can return additional properties because this is true for almost every endpoint ( #1910 )
...
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2024-07-30 18:37:29 +01:00
Kévin Commaille
efe72d3b26
Fix security schemes in OpenAPI definitions ( #1772 )
2024-04-09 18:12:30 +02:00
Kévin Commaille
45b6aaf07a
Upgrade Swagger data to OpenAPI 3.1 ( #1310 )
...
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2023-06-07 13:16:29 +01:00
Michael Telatynski
7ab3aecf29
Update profile.yaml ( #1238 )
...
* Update profile.yaml
* Create 1238.clarification
* Update changelogs/client_server/newsfragments/1238.clarification
Co-authored-by: Alexey Rusakov <Kitsune-Ral@users.sf.net>
Co-authored-by: Alexey Rusakov <Kitsune-Ral@users.sf.net>
2022-09-22 09:04:50 -06:00
Alexey Rusakov
e38c4e6f17
Revert accidentally pushed commits
...
This reverts commits:
c11991f9de .
f8bf0fa0ac .
7abdd45c06 .
92db4e20da .
2022-05-27 18:23:06 +02:00
Alexey Rusakov
f8bf0fa0ac
profile.yaml: require displayname/avatar_url
...
This makes a deliberate choice for the question stated in #2717 .
2022-05-27 18:18:47 +02:00
Dan Callahan
48d8f7202d
Add HTTP 403 to possible profile responses ( #3530 )
...
* Add HTTP 403 to possible profile responses
Some servers may not allow profile lookup over federation, and thus
respond to GET /_matrix/client/v3/profile/{userId} with an HTTP 403.
For example, Synapse can be configured to behave in this way by setting:
allow_profile_lookup_over_federation=false
Thus, this behavior already exists in the wild, and may cause issues for
clients such as https://github.com/vector-im/element-web/issues/17269 .
Synapse could alter its behavior and return an HTTP 404 in these cases,
but amending the Spec seems preferable to align with extant behavior.
Further, allowing HTTP 403 gives clients more specific information as to
why a request has failed, enabling more precise error handling.
Signed-off-by: Dan Callahan <danc@element.io>
* Update changelogs/client_server/newsfragments/3530.clarification
Co-authored-by: Travis Ralston <travpc@gmail.com>
* Annotate misc data about error
Co-authored-by: Travis Ralston <travpc@gmail.com>
Co-authored-by: Travis Ralston <travisr@matrix.org>
2021-12-29 11:30:32 -07:00
Travis Ralston
95d850c418
Update client-server API endpoints to move from r0 to v3 (plus whitespace fixes) ( #3421 )
...
* Blind find & replace all on client major version -> v3
* Fix up bad replacements
* Fix anchors for r0->v3
* Changelog
2021-10-12 11:07:01 -06:00
Lukas Lihotzki
91b232df48
OpenAPI: use uri format
...
In avatar_url, pusher url, wellknown base_url, getUrlPreview, and submit_url.
Signed-off-by: Lukas Lihotzki <lukas@lihotzki.de>
2021-08-27 19:17:17 +01:00
Will
27f8867aa0
Change RST code formatting markup to Markdown
2021-08-27 19:16:42 +01:00
Will
00c6a866e2
Move raw API and event schemas into /data directory
...
Historical note: this was originally a series of several commits, spread out
over several weeks. They have been squashed together to make `git annotate`
work properly.
The original commits were:
* 91ab3934 <Will> 2021-01-25 21:16:42 -0800 Add raw API end event schemas into /data directory
* aae22f47 <Will> 2021-01-25 21:33:06 -0800 Remove non-data files
* 1092d4ca <Will> 2021-01-26 20:41:33 -0800 Add data-compatiuble extension (.yaml) to all data files that currently omit one
* 21060109 <Will> 2021-01-26 20:57:28 -0800 Remove symlink to event-schemas, and update openAPI schema paths accordingly
* 4f633845 <Travis Ralston> 2021-04-12 21:54:54 -0600 Fix event schema examples too
* 301c7b2f <Will> 2021-02-05 10:15:42 -0800 Restore docs describing OpenAPI extensions that we use
2021-08-27 19:16:39 +01:00