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

refactor(webapi)!: put all API under path /_blah

Browse source
This commit is contained in:
oxalica 2024-09-19 04:56:57 -04:00
parent ab756f78ab
commit 0c28c00c3d
5 changed files with 34 additions and 28 deletions
Download patch file Download diff file Expand all files Collapse all files

18
docs/webapi.yaml
View file

@ -6,7 +6,7 @@ info:
paths:
# OAPI does not support WebSocket interface definitions.
# See: https://github.com/OAI/OpenAPI-Specification/issues/55#issuecomment-929382279
/ws:
/_blah/ws:
get:
summary: WebSocket endpoint
description: |
@ -46,7 +46,7 @@ paths:
schema:
$ref: '#/components/schemas/WSServerToClient'
/user/me:
/_blah/user/me:
get:
summary: Check registration status of the current user
parameters:
@ -131,7 +131,7 @@ paths:
schema:
$ref: '#/components/schemas/ApiError'
/room:
/_blah/room:
get:
summary: List rooms
parameters:
@ -190,7 +190,7 @@ paths:
schema:
$ref: '#/components/schemas/ApiError'
/room/create:
/_blah/room/create:
post:
summary: Create a room
@ -238,7 +238,7 @@ paths:
schema:
$ref: '#/components/schemas/ApiError'
/room/{rid}:
/_blah/room/{rid}:
get:
summary: Get room metadata
parameters:
@ -264,7 +264,7 @@ paths:
schema:
$ref: '#/components/schemas/ApiError'
/room/{rid}/admin:
/_blah/room/{rid}/admin:
post:
summary: Room management
@ -295,7 +295,7 @@ paths:
schema:
$ref: '#/components/schemas/ApiError'
/room/{rid}/feed.json:
/_blah/room/{rid}/feed.json:
get:
summary: Get JSON feed of room
description: |
@ -316,7 +316,7 @@ paths:
schema:
$ref: '#/components/schemas/ApiError'
/room/{rid}/msg:
/_blah/room/{rid}/msg:
get:
summary: List messages in a room
description: |
@ -395,7 +395,7 @@ paths:
schema:
$ref: '#/components/schemas/ApiError'
/room/{rid}/msg/{cid}/seen:
/_blah/room/{rid}/msg/{cid}/seen:
post:
summary: Mark a message seen
description: |