diff --git a/changelogs/client_server/newsfragments/1836.clarification b/changelogs/client_server/newsfragments/1836.clarification new file mode 100644 index 000000000..9e9f45890 --- /dev/null +++ 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 index 89a0d44f9..3ebcdf958 100644 --- 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"]