mirror of
https://gitlab.archlinux.org/archlinux/aurweb.git
synced 2025-02-03 10:43:03 +01:00
doc(rpc): include route doc at the top of aurweb.routers.rpc
Signed-off-by: Kevin Morris <kevr@0cost.org>
This commit is contained in:
parent
17f2c05fd3
commit
624954042b
1 changed files with 25 additions and 0 deletions
|
@ -1,3 +1,28 @@
|
||||||
|
"""
|
||||||
|
RPC API routing module
|
||||||
|
|
||||||
|
For legacy route documentation, see https://aur.archlinux.org/rpc
|
||||||
|
|
||||||
|
Legacy Routes:
|
||||||
|
- GET /rpc
|
||||||
|
- POST /rpc
|
||||||
|
|
||||||
|
Legacy example (version 5): /rpc?v=5&type=info&arg=my-package
|
||||||
|
|
||||||
|
For OpenAPI route documentation, see https://aur.archlinux.org/docs
|
||||||
|
|
||||||
|
OpenAPI Routes:
|
||||||
|
- GET /rpc/v{version}/info/{arg}
|
||||||
|
- GET /rpc/v{version}/info
|
||||||
|
- POST /rpc/v{version}/info
|
||||||
|
- GET /rpc/v{version}/search/{arg}
|
||||||
|
- GET /rpc/v{version}/search
|
||||||
|
- POST /rpc/v{version}/search
|
||||||
|
- GET /rpc/v{version}/suggest/{arg}
|
||||||
|
|
||||||
|
OpenAPI example (version 5): /rpc/v5/info/my-package
|
||||||
|
|
||||||
|
"""
|
||||||
import hashlib
|
import hashlib
|
||||||
import re
|
import re
|
||||||
from http import HTTPStatus
|
from http import HTTPStatus
|
||||||
|
|
Loading…
Add table
Reference in a new issue