matrix-spec/data/api/client-server/definitions/errors/error.yaml
Paarth Shah d0f371987b
Add missing error.soft_logout
Signed-off-by: Paarth Shah <mail@shahpaarth.com>
2024-06-02 01:03:32 -07:00

30 lines
994 B
YAML

# Copyright 2016 OpenMarket Ltd
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
type: object
title: Error
description: A Matrix-level Error
properties:
errcode:
type: string
description: An error code.
example: M_UNKNOWN
error:
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"]