From ad93aa65467033b9865ab5c22c807701dbeb3b4c Mon Sep 17 00:00:00 2001
From: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
Date: Wed, 5 May 2021 11:47:23 +0100
Subject: [PATCH] Update client_secret examples so that they are valid (#2985)

The regex of allowed characters for a `client_secret` parameter is `[0-9a-zA-Z.=_-]`.

This PR updates the `client_secret` spec examples, which currently include an invalid character (an apostrophe).
---
 changelogs/client_server/newsfragments/2985.clarification | 1 +
 data/api/client-server/administrative_contact.yaml        | 6 +++---
 2 files changed, 4 insertions(+), 3 deletions(-)
 create mode 100644 changelogs/client_server/newsfragments/2985.clarification

diff --git a/changelogs/client_server/newsfragments/2985.clarification b/changelogs/client_server/newsfragments/2985.clarification
new file mode 100644
index 000000000..d3c768e3b
--- /dev/null
+++ b/changelogs/client_server/newsfragments/2985.clarification
@@ -0,0 +1 @@
+Correct examples of `client_secret` request body parameters so that they do not include invalid characters.
diff --git a/data/api/client-server/administrative_contact.yaml b/data/api/client-server/administrative_contact.yaml
index cea8538e5..72458b6b1 100644
--- a/data/api/client-server/administrative_contact.yaml
+++ b/data/api/client-server/administrative_contact.yaml
@@ -139,7 +139,7 @@ paths:
                   "id_server": "matrix.org",
                   "id_access_token": "abc123_OpaqueString",
                   "sid": "abc123987",
-                  "client_secret": "d0n'tT3ll"
+                  "client_secret": "d0nt-T3ll"
                 }
               }
       responses:
@@ -215,7 +215,7 @@ paths:
             required: ["client_secret",  "sid"]
             example: {
               "sid": "abc123987",
-              "client_secret": "d0n'tT3ll"
+              "client_secret": "d0nt-T3ll"
             }
       responses:
         200:
@@ -272,7 +272,7 @@ paths:
               "id_server": "example.org",
               "id_access_token": "abc123_OpaqueString",
               "sid": "abc123987",
-              "client_secret": "d0n'tT3ll"
+              "client_secret": "d0nt-T3ll"
             }
       responses:
         200: