summaryrefslogtreecommitdiff
path: root/Documentation/source/reference/api.rst
blob: 85081aaae91d9bce96e244dfdf74ff3a2c24eecb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
API Reference
=============

Search Index
------------

Path
   ``/api/search``

Purpose
   Provides search data for the frontend search experience.

Rules
   Return public published content only. Keep the response shape stable for the
   search client.

Comments
--------

Path
   ``/api/comments/[...comment]``

Purpose
   Handles Fuma Comments operations.

Rules
   Authentication and authorization belong on the server side. Client code
   should not decide comment privileges.

Auth
----

Path
   ``/api/auth/[...all]``

Purpose
   Handles better-auth routes for OAuth and session behavior.

Rules
   Keep provider configuration in ``src/server/auth`` and environment
   validation in ``src/env.js``.

Feed
----

Path
   ``/rss.xml``

Purpose
   Publishes feed output for readers and feed clients.

Rules
   Include published content only and keep route references canonical.