Add missing error.soft_logout

Signed-off-by: Paarth Shah <mail@shahpaarth.com>
matrix-org · Jun 2, 2024 · d0f3719 · d0f3719
1 parent a175506
commit d0f3719
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/changelogs/client_server/newsfragments/1836.clarification b/changelogs/client_server/newsfragments/1836.clarification
@@ -0,0 +1 @@
+Add missing `soft_logout` property to `error.yaml`, as used by `refresh.yaml`. Contributed by @PaarthShah.
diff --git a/data/api/client-server/definitions/errors/error.yaml b/data/api/client-server/definitions/errors/error.yaml
@@ -23,4 +23,7 @@ properties:
     type: string
     description: A human-readable error message.
     example: An unknown error occurred
+  soft_logout:
+    type: boolean
+    description: If true within a 401 response, the client can offer to re-log in the user.
 required: ["errcode"]
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Add missing `soft_logout` property to `error.yaml`, as used by `refresh.yaml`. Contributed by @PaarthShah.