blah/blahrs
1
0
Fork 0
mirror of https://github.com/Blah-IM/blahrs.git synced 2025-07-02 12:35:33 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

refactor(blahd,webapi)!: overhaul error type

Browse source 
Error types are now collected into a single place. Similar errors are
merged.

Request invariant violations are now all under 400 with type
"invalid_request" if it's a client mistake; and if it's caused by a
server restrction, under 403 with type "disabled".
This commit is contained in:
oxalica 2024-09-24 19:04:30 -04:00
parent 5f03a4ca03
commit 0911d56e22
9 changed files with 267 additions and 312 deletions
Download patch file Download diff file Expand all files Collapse all files

28
docs/webapi.yaml
View file

@ -108,7 +108,7 @@ paths:
description: User successfully registered.
400:
description: Invalid request format, or invalid challenge.
description: Invalid request format or any invalid fields in the request.
content:
application/json:
schema:
@ -123,6 +123,15 @@ paths:
schema:
$ref: '#/components/schemas/ApiError'
403:
description: |
Server disallows registration, either due to server restriction or
unacceptable id_url.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
409:
description: |
User state changed during the operation. Could retry later.
@ -131,6 +140,16 @@ paths:
schema:
$ref: '#/components/schemas/ApiError'
422:
description: |
Fail to process identity description. Could be failure to fetch
remote description, unacceptable result from id_url, or any fields
(eg. signatures) in the returned description being invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/_blah/room:
get:
summary: List rooms
@ -283,6 +302,13 @@ paths:
schema:
$ref: '#/components/schemas/ApiError'
404:
description: |
Room does not exist or the user does not have permission to access it.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/_blah/room/{rid}/admin:
post: