NotAShelf/pinakes
1
0
Fork 0
Code Issues 6 Pull requests Projects Releases Packages Wiki Activity Actions

nix: set up project-wide formatter

Browse source 
Signed-off-by: NotAShelf <raf@notashelf.dev>
Change-Id: I4806c58aa0a17f504c9312723ad770166a6a6964
This commit is contained in:
raf 2026-03-22 23:42:02 +03:00
commit 9e5eb41d39
Signed by: NotAShelf
GPG key ID: 29D95B64378DB4BF
78 changed files with 7406 additions and 2504 deletions
Download patch file Download diff file Expand all files Collapse all files

147
docs/api/books.md vendored
View file

@ -12,23 +12,23 @@ List all books with optional search filters
#### Parameters
| Name | In | Required | Description |
|------|----|----------|-------------|
| `isbn` | query | No | Filter by ISBN |
| `author` | query | No | Filter by author |
| `series` | query | No | Filter by series |
| `publisher` | query | No | Filter by publisher |
| `language` | query | No | Filter by language |
| `offset` | query | No | Pagination offset |
| `limit` | query | No | Pagination limit |
| Name | In | Required | Description |
| ----------- | ----- | -------- | ------------------- |
| `isbn` | query | No | Filter by ISBN |
| `author` | query | No | Filter by author |
| `series` | query | No | Filter by series |
| `publisher` | query | No | Filter by publisher |
| `language` | query | No | Filter by language |
| `offset` | query | No | Pagination offset |
| `limit` | query | No | Pagination limit |
#### Responses
| Status | Description |
|--------|-------------|
| 200 | List of books |
| 401 | Unauthorized |
| 500 | Internal server error |
| Status | Description |
| ------ | --------------------- |
| 200 | List of books |
| 401 | Unauthorized |
| 500 | Internal server error |
---
@ -40,17 +40,17 @@ List all authors with book counts
#### Parameters
| Name | In | Required | Description |
|------|----|----------|-------------|
| `offset` | query | No | Pagination offset |
| `limit` | query | No | Pagination limit |
| Name | In | Required | Description |
| -------- | ----- | -------- | ----------------- |
| `offset` | query | No | Pagination offset |
| `limit` | query | No | Pagination limit |
#### Responses
| Status | Description |
|--------|-------------|
| 200 | Authors with book counts |
| 401 | Unauthorized |
| Status | Description |
| ------ | ------------------------ |
| 200 | Authors with book counts |
| 401 | Unauthorized |
---
@ -62,18 +62,18 @@ Get books by a specific author
#### Parameters
| Name | In | Required | Description |
|------|----|----------|-------------|
| `name` | path | Yes | Author name |
| `offset` | query | No | Pagination offset |
| `limit` | query | No | Pagination limit |
| Name | In | Required | Description |
| -------- | ----- | -------- | ----------------- |
| `name` | path | Yes | Author name |
| `offset` | query | No | Pagination offset |
| `limit` | query | No | Pagination limit |
#### Responses
| Status | Description |
|--------|-------------|
| 200 | Books by author |
| 401 | Unauthorized |
| Status | Description |
| ------ | --------------- |
| 200 | Books by author |
| 401 | Unauthorized |
---
@ -85,16 +85,16 @@ Get user's reading list
#### Parameters
| Name | In | Required | Description |
|------|----|----------|-------------|
| `status` | query | No | Filter by reading status |
| Name | In | Required | Description |
| -------- | ----- | -------- | ------------------------ |
| `status` | query | No | Filter by reading status |
#### Responses
| Status | Description |
|--------|-------------|
| 200 | Reading list |
| 401 | Unauthorized |
| Status | Description |
| ------ | ------------ |
| 200 | Reading list |
| 401 | Unauthorized |
---
@ -106,10 +106,10 @@ List all series with book counts
#### Responses
| Status | Description |
|--------|-------------|
| 200 | List of series with counts |
| 401 | Unauthorized |
| Status | Description |
| ------ | -------------------------- |
| 200 | List of series with counts |
| 401 | Unauthorized |
---
@ -121,16 +121,16 @@ Get books in a specific series
#### Parameters
| Name | In | Required | Description |
|------|----|----------|-------------|
| `name` | path | Yes | Series name |
| Name | In | Required | Description |
| ------ | ---- | -------- | ----------- |
| `name` | path | Yes | Series name |
#### Responses
| Status | Description |
|--------|-------------|
| 200 | Books in series |
| 401 | Unauthorized |
| Status | Description |
| ------ | --------------- |
| 200 | Books in series |
| 401 | Unauthorized |
---
@ -142,17 +142,17 @@ Get book metadata by media ID
#### Parameters
| Name | In | Required | Description |
|------|----|----------|-------------|
| `id` | path | Yes | Media item ID |
| Name | In | Required | Description |
| ---- | ---- | -------- | ------------- |
| `id` | path | Yes | Media item ID |
#### Responses
| Status | Description |
|--------|-------------|
| 200 | Book metadata |
| 401 | Unauthorized |
| 404 | Not found |
| Status | Description |
| ------ | ------------- |
| 200 | Book metadata |
| 401 | Unauthorized |
| 404 | Not found |
---
@ -164,17 +164,17 @@ Get reading progress for a book
#### Parameters
| Name | In | Required | Description |
|------|----|----------|-------------|
| `id` | path | Yes | Media item ID |
| Name | In | Required | Description |
| ---- | ---- | -------- | ------------- |
| `id` | path | Yes | Media item ID |
#### Responses
| Status | Description |
|--------|-------------|
| 200 | Reading progress |
| 401 | Unauthorized |
| 404 | Not found |
| Status | Description |
| ------ | ---------------- |
| 200 | Reading progress |
| 401 | Unauthorized |
| 404 | Not found |
---
@ -186,9 +186,9 @@ Update reading progress for a book
#### Parameters
| Name | In | Required | Description |
|------|----|----------|-------------|
| `id` | path | Yes | Media item ID |
| Name | In | Required | Description |
| ---- | ---- | -------- | ------------- |
| `id` | path | Yes | Media item ID |
#### Request Body
@ -198,11 +198,10 @@ See `docs/api/openapi.json` for the full schema.
#### Responses
| Status | Description |
|--------|-------------|
| 204 | Progress updated |
| 400 | Bad request |
| 401 | Unauthorized |
| Status | Description |
| ------ | ---------------- |
| 204 | Progress updated |
| 400 | Bad request |
| 401 | Unauthorized |
---