mirror of
https://github.com/SamyRai/tercul-backend.git
synced 2025-12-27 05:11:34 +00:00
85d036330c
Replaces a raw `panic` in the `asynq` server startup with a call to `log.Fatalf`. If the job server fails to start, it is an unrecoverable, fatal error. Using `log.Fatalf` ensures the application exits with a clear error message and a non-zero status code, which is a more conventional and robust way to handle fatal startup errors than panicking.
34 lines
693 B
Markdown
34 lines
693 B
Markdown
# Tercul API Documentation
|
|
|
|
This document provides documentation for the Tercul GraphQL API.
|
|
|
|
## Queries
|
|
|
|
### `trendingWorks`
|
|
|
|
The `trendingWorks` query returns a list of trending works.
|
|
|
|
**Signature:**
|
|
|
|
```graphql
|
|
trendingWorks(timePeriod: String, limit: Int): [Work!]!
|
|
```
|
|
|
|
**Arguments:**
|
|
|
|
* `timePeriod` (String, optional): The time period to get trending works for. Can be "daily", "weekly", or "monthly". Defaults to "daily".
|
|
* `limit` (Int, optional): The maximum number of trending works to return. Defaults to 10.
|
|
|
|
**Example:**
|
|
|
|
```graphql
|
|
query GetTrendingWorks {
|
|
trendingWorks(limit: 5) {
|
|
id
|
|
name
|
|
}
|
|
}
|
|
```
|
|
|
|
This query will return the top 5 trending works for the day.
|