Expand description
Typed response models matching the FicHub REST API.
Shapes mirror frontend/src/lib/api/types.ts (the frontend is the
authoritative contract). Fields are Option where the API can omit them.
Structs§
- AskResponse
- Response from
POST /api/search/ask— search envelope plus ask metadata. - Auth
Response - Auth response from
POST /api/auth/login. - Auth
User Model - The authenticated user model.
- Body
Search Hit - A body-search hit with
<mark>-highlighted snippet. - Body
Search Response - Response from
GET /api/search/body?q=. - Cluster
Row - A roadmap consensus cluster row.
- Consensus
Response - Response from
GET /api/roadmap/consensus. - Convert
Response - Response from
GET /api/epub/convert?format=mobi|pdf|azw3. - Export
Response - Response from
GET /api/epub?q=andGET /api/meta?q=. - Export
Urls - A single export’s download URLs. Keys: epub, html, txt, md, mobi, pdf, azw3, docx, fb2, kepub.
- Feed
Item - A feed item (
GET /api/v1/feed). - Feed
Response - Response from
GET /api/v1/feed. - FicMeta
- Fic metadata object returned by
/api/epuband/api/meta. - Forum
Categories Response - Response envelope from
GET /api/forum/categories. - Forum
Category - A forum category (
GET /api/forum/categoriesitem). - Forum
Create Topic Response - Response from
POST /api/forum/topics(create topic). - Forum
Follow State - Follow state (
POSTtoggle andGETread on/api/forum/topics/{id}/follow). - Forum
Mark Read - Response from
POST /api/forum/topics/{id}/read(mark read). - Forum
Metamod Item - A metamoderation-queue row (
GET /api/forum/metamod/queueitem, F6). - Forum
Metamod Queue - Response envelope from
GET /api/forum/metamod/queue(F6). - Forum
Metamod Vote Response - Response from
POST /api/forum/metamod/{actionId}/vote(F6). - Forum
ModQueue Item - A moderation-queue row (
GET /api/forum/moderation/queueitem, F5). - Forum
Moderate Response - Response from
POST /api/forum/posts/{id}/moderate(F5). - Forum
Moderation Queue - Response envelope from
GET /api/forum/moderation/queue(F5). - Forum
Moderation Status - Response from
GET /api/forum/moderation/status(F5). - Forum
Post - A single post in a topic detail (
GET /api/forum/topics/{id}item). - Forum
Post Created - Response from
POST /api/forum/topics/{id}/posts(reply). - Forum
Quote - A quoted-post preview attached to a forum post (best-effort server-side).
- Forum
Search Hit - A forum search hit (
GET /api/forum/searchresult). - Forum
Search Response - Response envelope from
GET /api/forum/search. - Forum
Topic - A topic row in the category listing (
GET /api/forum/topicsitem). - Forum
Topic Detail - Topic detail + posts (
GET /api/forum/topics/{id}and/by-slug/{slug}). - Forum
Topic List - Response envelope from
GET /api/forum/topics. - MeResponse
- Me response from
GET /api/auth/me. - Personal
Recommendations Response - Personal recommendations response (
GET /api/recommendations/personal). - RecResult
- A single recommendation result.
- Recommendations
Response - Response from
GET /api/recommendations?q=&n=. - Request
Item - A Fic Request board item (
GET /api/requests). - Requests
Response - Response from
GET /api/requests?status=. - Search
Facets - Search facets (
GET /api/search). - Search
Response - Response envelope from
GET /api/search. - Search
Result - A search result row (
GET /api/search,POST /api/search/ask). - Suggestion
- A community suggestion for a fic (
GET /api/recommendations/votes). - Votes
Response - Response from
GET /api/recommendations/votes?url_id=.