/password: formalise 'default' for logout_devices

3 years ago · 92db4e20da
parent 7abdd45c06
commit 92db4e20da
1 changed files with 2 additions and 1 deletions
--- a/data/api/client-server/registration.yaml
+++ b/data/api/client-server/registration.yaml
@ -352,9 +352,10 @@ paths:
                example: "ihatebananas"
              logout_devices:
                type: boolean
+                default: true
                description: |-
                  Whether the user's other access tokens, and their associated devices, should be
-                  revoked if the request succeeds. Defaults to true.
+                  revoked if the request succeeds.

                  When `false`, the server can still take advantage of the [soft logout method](/client-server-api/#soft-logout)
                  for the user's remaining devices.