api.fluff4.me 1.0.1078 → 1.0.1081

package/index.d.ts

@@ -1093,11 +1093,17 @@ export interface Shelves {
 }
 
 export interface ShelvesPreviewResponse {
+	recommendations: Recommendation[]
 	shelves: ShelvesPreview[]
 	authors: AuthorMetadata[]
 	works: WorkMetadata[]
 }
 
+export interface Recommendation {
+	recommendation: Comment
+	work: WorkReference
+}
+
 export interface ShelvesPreview {
 	shelf_id: string
 	shelf_order: number
@@ -1122,6 +1128,16 @@ export interface EmbedSearch {
 	url: string
 }
 
+export interface Recommendations {
+	recommendations: Recommendation[]
+	works: WorkMetadata[]
+	authors: AuthorMetadata[]
+}
+
+export interface RecommendationsSearchSchema {
+	following_only?: boolean | null
+}
+
 export interface ErrorResponse {
 	code: number
 	detail?: string | null
@@ -2310,4 +2326,10 @@ export interface Paths {
 		search: EmbedSearch
 		response: void | ErrorResponse
 	},
+	"/recommendations": {
+		method: "get"
+		body?: undefined
+		search: RecommendationsSearchSchema & PaginationSearch
+		response: PaginatedResponse<Recommendations> | ErrorResponse
+	},
 }

package/openapi.json

@@ -6479,6 +6479,12 @@
 			"ShelvesPreviewResponse": {
 				"type": "object",
 				"properties": {
+					"recommendations": {
+						"type": "array",
+						"items": {
+							"$ref": "#/components/schema/Recommendation"
+						}
+					},
 					"shelves": {
 						"type": "array",
 						"items": {
@@ -6499,11 +6505,27 @@
 					}
 				},
 				"required": [
+					"recommendations",
 					"shelves",
 					"authors",
 					"works"
 				]
 			},
+			"Recommendation": {
+				"type": "object",
+				"properties": {
+					"recommendation": {
+						"$ref": "#/components/schema/Comment"
+					},
+					"work": {
+						"$ref": "#/components/schema/WorkReference"
+					}
+				},
+				"required": [
+					"recommendation",
+					"work"
+				]
+			},
 			"ShelvesPreview": {
 				"type": "object",
 				"properties": {
@@ -6609,6 +6631,49 @@
 					"url"
 				]
 			},
+			"Recommendations": {
+				"type": "object",
+				"properties": {
+					"recommendations": {
+						"type": "array",
+						"items": {
+							"$ref": "#/components/schema/Recommendation"
+						}
+					},
+					"works": {
+						"type": "array",
+						"items": {
+							"$ref": "#/components/schema/WorkMetadata"
+						}
+					},
+					"authors": {
+						"type": "array",
+						"items": {
+							"$ref": "#/components/schema/AuthorMetadata"
+						}
+					}
+				},
+				"required": [
+					"recommendations",
+					"works",
+					"authors"
+				]
+			},
+			"RecommendationsSearchSchema": {
+				"type": "object",
+				"properties": {
+					"following_only": {
+						"anyOf": [
+							{
+								"type": "boolean"
+							},
+							{
+								"type": "null"
+							}
+						]
+					}
+				}
+			},
 			"ErrorResponse": {
 				"type": "object",
 				"properties": {
@@ -15240,6 +15305,107 @@
 					}
 				}
 			}
+		},
+		"/recommendations": {
+			"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
+						}
+					},
+					{
+						"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
+						}
+					},
+					{
+						"name": "following_only",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"anyOf": [
+								{
+									"type": "boolean"
+								},
+								{
+									"type": "null"
+								}
+							]
+						}
+					}
+				],
+				"responses": {
+					"200": {
+						"description": "200 response",
+						"content": {
+							"application/json": {
+								"schema": {
+									"type": "object",
+									"properties": {
+										"data": {
+											"$ref": "#/components/schemas/Recommendations"
+										},
+										"has_more": {
+											"type": "boolean"
+										},
+										"page": {
+											"type": "number",
+											"minimum": 0
+										},
+										"page_count": {
+											"type": [
+												"boolean",
+												"number"
+											],
+											"anyOf": [
+												{
+													"type": "boolean",
+													"enum": [
+														true
+													]
+												},
+												{
+													"type": "number",
+													"minimum": 0
+												}
+											]
+										}
+									},
+									"required": [
+										"data",
+										"has_more",
+										"page",
+										"page_count"
+									]
+								}
+							}
+						}
+					},
+					"304": {
+						"description": "304 response"
+					},
+					"default": {
+						"description": "Error",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/ErrorResponse"
+								}
+							}
+						}
+					}
+				}
+			}
 		}
 	}
 }

package/package.json

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