From 3b2c0ff2337f8cf88aea6c7a02beb0ad2a561830 Mon Sep 17 00:00:00 2001
From: Travis Ralston <travisr@matrix.org>
Date: Sat, 1 May 2021 21:21:13 -0600
Subject: [PATCH] Spec device_id on whoami

Spec for https://github.com/matrix-org/matrix-doc/pull/2033
---
 data/api/client-server/whoami.yaml | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/data/api/client-server/whoami.yaml b/data/api/client-server/whoami.yaml
index 713ed3702..3458c4d0d 100644
--- a/data/api/client-server/whoami.yaml
+++ b/data/api/client-server/whoami.yaml
@@ -47,7 +47,8 @@ paths:
             The token belongs to a known user.
           examples:
             application/json: {
-              "user_id": "@joe:example.org"
+              "user_id": "@joe:example.org",
+              "device_id": "ABC1234"
             }
           schema:
             type: object
@@ -55,7 +56,14 @@ paths:
             properties:
               user_id:
                 type: string
-                description: The user id that owns the access token.
+                description: The user ID that owns the access token.
+              device_id:
+                type: string
+                description: |-
+                  Device ID associated with the access token. If no device
+                  is associated with the access token (such as in the case
+                  of application services) then this field can be omitted.
+                  Otherwise this is required.
         401:
           description:
             The token is not recognised