Skip to main content

Module model

Module model 

Source
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.
AuthResponse
Auth response from POST /api/auth/login.
AuthUserModel
The authenticated user model.
BodySearchHit
A body-search hit with <mark>-highlighted snippet.
BodySearchResponse
Response from GET /api/search/body?q=.
ClusterRow
A roadmap consensus cluster row.
ConsensusResponse
Response from GET /api/roadmap/consensus.
ConvertResponse
Response from GET /api/epub/convert?format=mobi|pdf|azw3.
ExportResponse
Response from GET /api/epub?q= and GET /api/meta?q=.
ExportUrls
A single export’s download URLs. Keys: epub, html, txt, md, mobi, pdf, azw3, docx, fb2, kepub.
FeedItem
A feed item (GET /api/v1/feed).
FeedResponse
Response from GET /api/v1/feed.
FicMeta
Fic metadata object returned by /api/epub and /api/meta.
ForumCategoriesResponse
Response envelope from GET /api/forum/categories.
ForumCategory
A forum category (GET /api/forum/categories item).
ForumCreateTopicResponse
Response from POST /api/forum/topics (create topic).
ForumFollowState
Follow state (POST toggle and GET read on /api/forum/topics/{id}/follow).
ForumMarkRead
Response from POST /api/forum/topics/{id}/read (mark read).
ForumMetamodItem
A metamoderation-queue row (GET /api/forum/metamod/queue item, F6).
ForumMetamodQueue
Response envelope from GET /api/forum/metamod/queue (F6).
ForumMetamodVoteResponse
Response from POST /api/forum/metamod/{actionId}/vote (F6).
ForumModQueueItem
A moderation-queue row (GET /api/forum/moderation/queue item, F5).
ForumModerateResponse
Response from POST /api/forum/posts/{id}/moderate (F5).
ForumModerationQueue
Response envelope from GET /api/forum/moderation/queue (F5).
ForumModerationStatus
Response from GET /api/forum/moderation/status (F5).
ForumPost
A single post in a topic detail (GET /api/forum/topics/{id} item).
ForumPostCreated
Response from POST /api/forum/topics/{id}/posts (reply).
ForumQuote
A quoted-post preview attached to a forum post (best-effort server-side).
ForumSearchHit
A forum search hit (GET /api/forum/search result).
ForumSearchResponse
Response envelope from GET /api/forum/search.
ForumTopic
A topic row in the category listing (GET /api/forum/topics item).
ForumTopicDetail
Topic detail + posts (GET /api/forum/topics/{id} and /by-slug/{slug}).
ForumTopicList
Response envelope from GET /api/forum/topics.
MeResponse
Me response from GET /api/auth/me.
PersonalRecommendationsResponse
Personal recommendations response (GET /api/recommendations/personal).
RecResult
A single recommendation result.
RecommendationsResponse
Response from GET /api/recommendations?q=&n=.
RequestItem
A Fic Request board item (GET /api/requests).
RequestsResponse
Response from GET /api/requests?status=.
SearchFacets
Search facets (GET /api/search).
SearchResponse
Response envelope from GET /api/search.
SearchResult
A search result row (GET /api/search, POST /api/search/ask).
Suggestion
A community suggestion for a fic (GET /api/recommendations/votes).
VotesResponse
Response from GET /api/recommendations/votes?url_id=.