api.fluff4.me 1.0.1085 → 1.0.1087

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/index.d.ts +26 -20
  2. package/openapi.json +174 -73
  3. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -307,6 +307,26 @@ export interface CommentsResponse {
307
307
  authors: AuthorMetadata[]
308
308
  }
309
309
 
310
+ export interface Recommendations {
311
+ recommendations: Recommendation[]
312
+ works: WorkMetadata[]
313
+ authors: AuthorMetadata[]
314
+ }
315
+
316
+ export interface RecommendationsSearchSchema {
317
+ following_only?: boolean | null
318
+ }
319
+
320
+ export interface Recommendation {
321
+ recommendation: Comment
322
+ work: WorkReference
323
+ }
324
+
325
+ export interface WorkReference {
326
+ author: string
327
+ vanity: string
328
+ }
329
+
310
330
  export interface Work {
311
331
  name: string
312
332
  description: string
@@ -534,11 +554,6 @@ export interface WorkResolveSearch {
534
554
  works: WorkReference[]
535
555
  }
536
556
 
537
- export interface WorkReference {
538
- author: string
539
- vanity: string
540
- }
541
-
542
557
  export interface Follow {
543
558
  author?: string | null
544
559
  work?: WorkReference | null
@@ -1099,11 +1114,6 @@ export interface ShelvesPreviewResponse {
1099
1114
  works: WorkMetadata[]
1100
1115
  }
1101
1116
 
1102
- export interface Recommendation {
1103
- recommendation: Comment
1104
- work: WorkReference
1105
- }
1106
-
1107
1117
  export interface ShelvesPreview {
1108
1118
  shelf_id: string
1109
1119
  shelf_order: number
@@ -1128,16 +1138,6 @@ export interface EmbedSearch {
1128
1138
  url: string
1129
1139
  }
1130
1140
 
1131
- export interface Recommendations {
1132
- recommendations: Recommendation[]
1133
- works: WorkMetadata[]
1134
- authors: AuthorMetadata[]
1135
- }
1136
-
1137
- export interface RecommendationsSearchSchema {
1138
- following_only?: boolean | null
1139
- }
1140
-
1141
1141
  export interface ErrorResponse {
1142
1142
  code: number
1143
1143
  detail?: string | null
@@ -1354,6 +1354,12 @@ export interface Paths {
1354
1354
  search?: undefined
1355
1355
  response: void | ErrorResponse
1356
1356
  },
1357
+ "/v2/comment/all/work": {
1358
+ method: "get"
1359
+ body?: undefined
1360
+ search: RecommendationsSearchSchema & PaginationSearch
1361
+ response: PaginatedResponse<Recommendations> | ErrorResponse
1362
+ },
1357
1363
  "/work/create": {
1358
1364
  method: "post"
1359
1365
  body: WorkCreateBody
package/openapi.json CHANGED
@@ -1855,6 +1855,79 @@
1855
1855
  "authors"
1856
1856
  ]
1857
1857
  },
1858
+ "Recommendations": {
1859
+ "type": "object",
1860
+ "properties": {
1861
+ "recommendations": {
1862
+ "type": "array",
1863
+ "items": {
1864
+ "$ref": "#/components/schema/Recommendation"
1865
+ }
1866
+ },
1867
+ "works": {
1868
+ "type": "array",
1869
+ "items": {
1870
+ "$ref": "#/components/schema/WorkMetadata"
1871
+ }
1872
+ },
1873
+ "authors": {
1874
+ "type": "array",
1875
+ "items": {
1876
+ "$ref": "#/components/schema/AuthorMetadata"
1877
+ }
1878
+ }
1879
+ },
1880
+ "required": [
1881
+ "recommendations",
1882
+ "works",
1883
+ "authors"
1884
+ ]
1885
+ },
1886
+ "RecommendationsSearchSchema": {
1887
+ "type": "object",
1888
+ "properties": {
1889
+ "following_only": {
1890
+ "anyOf": [
1891
+ {
1892
+ "type": "boolean"
1893
+ },
1894
+ {
1895
+ "type": "null"
1896
+ }
1897
+ ]
1898
+ }
1899
+ }
1900
+ },
1901
+ "Recommendation": {
1902
+ "type": "object",
1903
+ "properties": {
1904
+ "recommendation": {
1905
+ "$ref": "#/components/schema/Comment"
1906
+ },
1907
+ "work": {
1908
+ "$ref": "#/components/schema/WorkReference"
1909
+ }
1910
+ },
1911
+ "required": [
1912
+ "recommendation",
1913
+ "work"
1914
+ ]
1915
+ },
1916
+ "WorkReference": {
1917
+ "type": "object",
1918
+ "properties": {
1919
+ "author": {
1920
+ "type": "string"
1921
+ },
1922
+ "vanity": {
1923
+ "type": "string"
1924
+ }
1925
+ },
1926
+ "required": [
1927
+ "author",
1928
+ "vanity"
1929
+ ]
1930
+ },
1858
1931
  "Work": {
1859
1932
  "type": "object",
1860
1933
  "properties": {
@@ -3462,21 +3535,6 @@
3462
3535
  "works"
3463
3536
  ]
3464
3537
  },
3465
- "WorkReference": {
3466
- "type": "object",
3467
- "properties": {
3468
- "author": {
3469
- "type": "string"
3470
- },
3471
- "vanity": {
3472
- "type": "string"
3473
- }
3474
- },
3475
- "required": [
3476
- "author",
3477
- "vanity"
3478
- ]
3479
- },
3480
3538
  "Follow": {
3481
3539
  "type": "object",
3482
3540
  "properties": {
@@ -6511,21 +6569,6 @@
6511
6569
  "works"
6512
6570
  ]
6513
6571
  },
6514
- "Recommendation": {
6515
- "type": "object",
6516
- "properties": {
6517
- "recommendation": {
6518
- "$ref": "#/components/schema/Comment"
6519
- },
6520
- "work": {
6521
- "$ref": "#/components/schema/WorkReference"
6522
- }
6523
- },
6524
- "required": [
6525
- "recommendation",
6526
- "work"
6527
- ]
6528
- },
6529
6572
  "ShelvesPreview": {
6530
6573
  "type": "object",
6531
6574
  "properties": {
@@ -6631,49 +6674,6 @@
6631
6674
  "url"
6632
6675
  ]
6633
6676
  },
6634
- "Recommendations": {
6635
- "type": "object",
6636
- "properties": {
6637
- "recommendations": {
6638
- "type": "array",
6639
- "items": {
6640
- "$ref": "#/components/schema/Recommendation"
6641
- }
6642
- },
6643
- "works": {
6644
- "type": "array",
6645
- "items": {
6646
- "$ref": "#/components/schema/WorkMetadata"
6647
- }
6648
- },
6649
- "authors": {
6650
- "type": "array",
6651
- "items": {
6652
- "$ref": "#/components/schema/AuthorMetadata"
6653
- }
6654
- }
6655
- },
6656
- "required": [
6657
- "recommendations",
6658
- "works",
6659
- "authors"
6660
- ]
6661
- },
6662
- "RecommendationsSearchSchema": {
6663
- "type": "object",
6664
- "properties": {
6665
- "following_only": {
6666
- "anyOf": [
6667
- {
6668
- "type": "boolean"
6669
- },
6670
- {
6671
- "type": "null"
6672
- }
6673
- ]
6674
- }
6675
- }
6676
- },
6677
6677
  "ErrorResponse": {
6678
6678
  "type": "object",
6679
6679
  "properties": {
@@ -7858,6 +7858,107 @@
7858
7858
  }
7859
7859
  }
7860
7860
  },
7861
+ "/v2/comment/all/work": {
7862
+ "get": {
7863
+ "parameters": [
7864
+ {
7865
+ "name": "page",
7866
+ "in": "query",
7867
+ "description": "The page of data to query from. This endpoint uses a page size of 25 by default.",
7868
+ "schema": {
7869
+ "type": "integer",
7870
+ "minimum": 0
7871
+ }
7872
+ },
7873
+ {
7874
+ "name": "page_size",
7875
+ "in": "query",
7876
+ "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.",
7877
+ "schema": {
7878
+ "type": "integer",
7879
+ "minimum": 1,
7880
+ "maximum": 25
7881
+ }
7882
+ },
7883
+ {
7884
+ "name": "following_only",
7885
+ "in": "query",
7886
+ "required": false,
7887
+ "schema": {
7888
+ "anyOf": [
7889
+ {
7890
+ "type": "boolean"
7891
+ },
7892
+ {
7893
+ "type": "null"
7894
+ }
7895
+ ]
7896
+ }
7897
+ }
7898
+ ],
7899
+ "responses": {
7900
+ "200": {
7901
+ "description": "200 response",
7902
+ "content": {
7903
+ "application/json": {
7904
+ "schema": {
7905
+ "type": "object",
7906
+ "properties": {
7907
+ "data": {
7908
+ "$ref": "#/components/schemas/Recommendations"
7909
+ },
7910
+ "has_more": {
7911
+ "type": "boolean"
7912
+ },
7913
+ "page": {
7914
+ "type": "number",
7915
+ "minimum": 0
7916
+ },
7917
+ "page_count": {
7918
+ "type": [
7919
+ "boolean",
7920
+ "number"
7921
+ ],
7922
+ "anyOf": [
7923
+ {
7924
+ "type": "boolean",
7925
+ "enum": [
7926
+ true
7927
+ ]
7928
+ },
7929
+ {
7930
+ "type": "number",
7931
+ "minimum": 0
7932
+ }
7933
+ ]
7934
+ }
7935
+ },
7936
+ "required": [
7937
+ "data",
7938
+ "has_more",
7939
+ "page",
7940
+ "page_count"
7941
+ ]
7942
+ }
7943
+ }
7944
+ }
7945
+ },
7946
+ "304": {
7947
+ "description": "304 response"
7948
+ },
7949
+ "default": {
7950
+ "description": "Error",
7951
+ "content": {
7952
+ "application/json": {
7953
+ "schema": {
7954
+ "$ref": "#/components/schemas/ErrorResponse"
7955
+ }
7956
+ }
7957
+ }
7958
+ }
7959
+ }
7960
+ }
7961
+ },
7861
7962
  "/work/create": {
7862
7963
  "post": {
7863
7964
  "requestBody": {
package/package.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "api.fluff4.me",
3
- "version": "1.0.1085",
3
+ "version": "1.0.1087",
4
4
  "types": "index.d.ts"
5
5
  }