api.fluff4.me 1.0.1064 → 1.0.1066

package/index.d.ts

@@ -1087,6 +1087,22 @@ export interface Shelves {
 	authors: AuthorMetadata[]
 }
 
+export interface ShelvesPreviewResponse {
+	shelves: ShelvesPreview[]
+	authors: AuthorMetadata[]
+	works: WorkMetadata[]
+}
+
+export interface ShelvesPreview {
+	shelf_id: string
+	shelf_order: number
+	recently_updated: WorkReference[]
+	recently_completed: WorkReference[]
+	hot: WorkReference[]
+	new: WorkReference[]
+	rss_url?: string | null
+}
+
 export interface SearchResponse {
 	authors: string[]
 	works: WorkMetadata[]
@@ -2259,11 +2275,17 @@ export interface Paths {
 		search?: undefined
 		response: void | ErrorResponse
 	},
+	"/shelves/details": {
+		method: "get"
+		body?: undefined
+		search?: undefined
+		response: Response<Shelves> | ErrorResponse
+	},
 	"/shelves": {
 		method: "get"
 		body?: undefined
-		search: PaginationSearch
-		response: PaginatedResponse<Shelves> | ErrorResponse
+		search?: undefined
+		response: Response<ShelvesPreviewResponse> | ErrorResponse
 	},
 	"/search": {
 		method: "get"

package/openapi.json

@@ -6441,6 +6441,87 @@
 					"authors"
 				]
 			},
+			"ShelvesPreviewResponse": {
+				"type": "object",
+				"properties": {
+					"shelves": {
+						"type": "array",
+						"items": {
+							"$ref": "#/components/schema/ShelvesPreview"
+						}
+					},
+					"authors": {
+						"type": "array",
+						"items": {
+							"$ref": "#/components/schema/AuthorMetadata"
+						}
+					},
+					"works": {
+						"type": "array",
+						"items": {
+							"$ref": "#/components/schema/WorkMetadata"
+						}
+					}
+				},
+				"required": [
+					"shelves",
+					"authors",
+					"works"
+				]
+			},
+			"ShelvesPreview": {
+				"type": "object",
+				"properties": {
+					"shelf_id": {
+						"type": "string"
+					},
+					"shelf_order": {
+						"type": "number"
+					},
+					"recently_updated": {
+						"type": "array",
+						"items": {
+							"$ref": "#/components/schema/WorkReference"
+						}
+					},
+					"recently_completed": {
+						"type": "array",
+						"items": {
+							"$ref": "#/components/schema/WorkReference"
+						}
+					},
+					"hot": {
+						"type": "array",
+						"items": {
+							"$ref": "#/components/schema/WorkReference"
+						}
+					},
+					"new": {
+						"type": "array",
+						"items": {
+							"$ref": "#/components/schema/WorkReference"
+						}
+					},
+					"rss_url": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "null"
+							}
+						]
+					}
+				},
+				"required": [
+					"shelf_id",
+					"shelf_order",
+					"recently_updated",
+					"recently_completed",
+					"hot",
+					"new"
+				]
+			},
 			"SearchResponse": {
 				"type": "object",
 				"properties": {
@@ -14953,29 +15034,42 @@
 				}
 			}
 		},
-		"/shelves": {
+		"/shelves/details": {
 			"get": {
-				"parameters": [
-					{
-						"name": "page",
-						"in": "query",
-						"description": "The page of data to query from. This endpoint uses a page size of 25 by default.",
-						"schema": {
-							"type": "integer",
-							"minimum": 0
+				"responses": {
+					"200": {
+						"description": "200 response",
+						"content": {
+							"application/json": {
+								"schema": {
+									"type": "object",
+									"properties": {
+										"data": {
+											"$ref": "#/components/schemas/Shelves"
+										}
+									},
+									"required": [
+										"data"
+									]
+								}
+							}
 						}
 					},
-					{
-						"name": "page_size",
-						"in": "query",
-						"description": "The custom page size to return. This endpoint uses a page size of 25 by default. The custom page size cannot be raised above the default.",
-						"schema": {
-							"type": "integer",
-							"minimum": 1,
-							"maximum": 25
+					"default": {
+						"description": "Error",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/ErrorResponse"
+								}
+							}
 						}
 					}
-				],
+				}
+			}
+		},
+		"/shelves": {
+			"get": {
 				"responses": {
 					"200": {
 						"description": "200 response",
@@ -14985,39 +15079,11 @@
 									"type": "object",
 									"properties": {
 										"data": {
-											"$ref": "#/components/schemas/Shelves"
-										},
-										"has_more": {
-											"type": "boolean"
-										},
-										"page": {
-											"type": "number",
-											"minimum": 0
-										},
-										"page_count": {
-											"type": [
-												"boolean",
-												"number"
-											],
-											"anyOf": [
-												{
-													"type": "boolean",
-													"enum": [
-														true
-													]
-												},
-												{
-													"type": "number",
-													"minimum": 0
-												}
-											]
+											"$ref": "#/components/schemas/ShelvesPreviewResponse"
 										}
 									},
 									"required": [
-										"data",
-										"has_more",
-										"page",
-										"page_count"
+										"data"
 									]
 								}
 							}

package/package.json

@@ -1,5 +1,5 @@
 {
 	"name": "api.fluff4.me",
-	"version": "1.0.1064",
+	"version": "1.0.1066",
 	"types": "index.d.ts"
 }