47 lines
2.6 KiB
Python
47 lines
2.6 KiB
Python
# retoor <retoor@molodetz.nl>
|
|
from molodetz.docs_api.registry import endpoint, field
|
|
|
|
GROUP = {
|
|
"slug": "inhoud",
|
|
"title": "Inhoud",
|
|
"description": "Publieke leesroutes: de rol, de standaard, berichten, galerijen en mensen.",
|
|
"endpoints": [
|
|
endpoint("GET", "/", "Voorpagina", "Laatste berichten en uitgelichte flyer.", sample={"posts": [], "flyer_count": 4, "meme_count": 20}),
|
|
endpoint(
|
|
"GET",
|
|
"/rol",
|
|
"De rol",
|
|
"Gepubliceerde notities in het onderwerp rol, nieuwste eerst, cursor-gepagineerd.",
|
|
fields=[field("before", description="Cursor uit next_cursor", location="query")],
|
|
sample={"title": "Rol", "topic": "rol", "posts": [], "next_cursor": None},
|
|
),
|
|
endpoint("GET", "/standaard", "De standaard", "Gepubliceerde berichten in het onderwerp standaard.", sample={"title": "Standaard", "topic": "standaard", "posts": []}),
|
|
endpoint(
|
|
"GET",
|
|
"/posts/{slug}",
|
|
"Bericht",
|
|
"Een gepubliceerd bericht via slug of uid.",
|
|
fields=[field("slug", required=True, location="path", example="een-zes-is-geen-ambitie")],
|
|
sample={"post": {"title": "Een zes is geen ambitie.", "topic": "rol"}, "author": {"username": "retoor"}},
|
|
probe_path="/posts/bestaat-niet",
|
|
),
|
|
endpoint("GET", "/flyers", "Flyers", "Galerij met flyers.", sample={"kind": "flyer", "title": "Flyers", "items": []}),
|
|
endpoint("GET", "/memes", "Memes", "Galerij met memes.", sample={"kind": "meme", "title": "Memes", "items": []}),
|
|
endpoint("GET", "/mensen", "Mensen", "Mensen op de rol.", sample={"people": [{"username": "retoor", "post_count": 5}]}),
|
|
endpoint(
|
|
"GET",
|
|
"/mensen/{username}",
|
|
"Persoon",
|
|
"Profiel met berichten.",
|
|
fields=[field("username", required=True, location="path", example="retoor")],
|
|
sample={"person": {"username": "retoor"}, "posts": []},
|
|
probe_path="/mensen/retoor",
|
|
),
|
|
endpoint("GET", "/robots.txt", "robots.txt", negotiation="none", interactive=False),
|
|
endpoint("GET", "/sitemap.xml", "Sitemap", negotiation="none", interactive=False),
|
|
endpoint("GET", "/avatar/svg/{seed}", "Avatar", "Deterministische SVG-avatar.", negotiation="none", interactive=False, probe_path="/avatar/svg/retoor"),
|
|
endpoint("GET", "/health", "Health", "Liveness en versie.", negotiation="json", sample={"status": "ok", "version": "1.0.0"}),
|
|
endpoint("GET", "/presence/roster", "Presence", "Online-set (uids).", negotiation="json", sample={"online": [], "tracked": 0}),
|
|
],
|
|
}
|