From 2cb70e6e3dc4742d622378ea1c523bda61376d02 Mon Sep 17 00:00:00 2001 From: reivilibre Date: Wed, 28 Feb 2024 00:15:21 +0000 Subject: [PATCH] Use a POST request in Federation request signing example (#1721) * Use a POST request in Federation request signing example Otherwise the GET request having a body is confusing, since it is not valid HTTP * Newsfile --- changelogs/server_server/newsfragments/1721.clarification | 1 + content/server-server-api.md | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) create mode 100644 changelogs/server_server/newsfragments/1721.clarification diff --git a/changelogs/server_server/newsfragments/1721.clarification b/changelogs/server_server/newsfragments/1721.clarification new file mode 100644 index 00000000..a742501b --- /dev/null +++ b/changelogs/server_server/newsfragments/1721.clarification @@ -0,0 +1 @@ +Clarify Server-Server API request signing example by using the `POST` HTTP method, as `GET` requests don't have request bodies. diff --git a/content/server-server-api.md b/content/server-server-api.md index e7c23179..fb1b06f4 100644 --- a/content/server-server-api.md +++ b/content/server-server-api.md @@ -290,7 +290,7 @@ Step 1 sign JSON: ``` { - "method": "GET", + "method": "POST", "uri": "/target", "origin": "origin.hs.example.com", "destination": "destination.hs.example.com", @@ -311,7 +311,7 @@ condition applies throughout the request signing process. Step 2 add Authorization header: - GET /target HTTP/1.1 + POST /target HTTP/1.1 Authorization: X-Matrix origin="origin.hs.example.com",destination="destination.hs.example.com",key="ed25519:key1",sig="ABCDEF..." Content-Type: application/json