From 52643a92c6981e04e68d9d5b4be34edff1509d9c Mon Sep 17 00:00:00 2001 From: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> Date: Tue, 9 Jul 2019 17:54:45 +0100 Subject: [PATCH] Less confusing wording on Application Service's Legacy Routes (#2160) https://matrix.org/docs/spec/application_service/r0.1.1#legacy-routes The "becomes" wording made it a little bit confusing for which was the new route and which was the old. --- .../newsfragments/2160.clarification | 1 + specification/application_service_api.rst | 16 ++++++++-------- 2 files changed, 9 insertions(+), 8 deletions(-) create mode 100644 changelogs/application_service/newsfragments/2160.clarification diff --git a/changelogs/application_service/newsfragments/2160.clarification b/changelogs/application_service/newsfragments/2160.clarification new file mode 100644 index 00000000..3e9c1c02 --- /dev/null +++ b/changelogs/application_service/newsfragments/2160.clarification @@ -0,0 +1 @@ +Clearer wording for the legacy routes section. diff --git a/specification/application_service_api.rst b/specification/application_service_api.rst index 11a07839..302f0980 100644 --- a/specification/application_service_api.rst +++ b/specification/application_service_api.rst @@ -213,14 +213,14 @@ should fall back to the older endpoints for the application service. The older endpoints have the exact same request body and response format, they just belong at a different path. The equivalent path for each is as follows: -* ``/_matrix/app/v1/transactions/{txnId}`` becomes ``/transactions/{txnId}`` -* ``/_matrix/app/v1/users/{userId}`` becomes ``/users/{userId}`` -* ``/_matrix/app/v1/rooms/{roomAlias}`` becomes ``/rooms/{roomAlias}`` -* ``/_matrix/app/v1/thirdparty/protocol/{protocol}`` becomes ``/_matrix/app/unstable/thirdparty/protocol/{protocol}`` -* ``/_matrix/app/v1/thirdparty/user/{user}`` becomes ``/_matrix/app/unstable/thirdparty/user/{user}`` -* ``/_matrix/app/v1/thirdparty/location/{location}`` becomes ``/_matrix/app/unstable/thirdparty/location/{location}`` -* ``/_matrix/app/v1/thirdparty/user`` becomes ``/_matrix/app/unstable/thirdparty/user`` -* ``/_matrix/app/v1/thirdparty/location`` becomes ``/_matrix/app/unstable/thirdparty/location`` +* ``/_matrix/app/v1/transactions/{txnId}`` should fall back to ``/transactions/{txnId}`` +* ``/_matrix/app/v1/users/{userId}`` should fall back to ``/users/{userId}`` +* ``/_matrix/app/v1/rooms/{roomAlias}`` should fall back to ``/rooms/{roomAlias}`` +* ``/_matrix/app/v1/thirdparty/protocol/{protocol}`` should fall back to ``/_matrix/app/unstable/thirdparty/protocol/{protocol}`` +* ``/_matrix/app/v1/thirdparty/user/{user}`` should fall back to ``/_matrix/app/unstable/thirdparty/user/{user}`` +* ``/_matrix/app/v1/thirdparty/location/{location}`` should fall back to ``/_matrix/app/unstable/thirdparty/location/{location}`` +* ``/_matrix/app/v1/thirdparty/user`` should fall back to ``/_matrix/app/unstable/thirdparty/user`` +* ``/_matrix/app/v1/thirdparty/location`` should fall back to ``/_matrix/app/unstable/thirdparty/location`` Homeservers should periodically try again for the newer endpoints because the application service may have been updated.