api.fluff4.me 1.0.1086 → 1.0.1088

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 +30 -21
  2. package/openapi.json +179 -74
  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
@@ -764,7 +779,10 @@ export interface ManifestFormInputLengths {
764
779
  name: number
765
780
  description: number
766
781
  }
767
- comment: { body: number }
782
+ comment: {
783
+ body: number
784
+ body_on_work: number
785
+ }
768
786
  work_tags: {
769
787
  global: number
770
788
  custom: number
@@ -1099,11 +1117,6 @@ export interface ShelvesPreviewResponse {
1099
1117
  works: WorkMetadata[]
1100
1118
  }
1101
1119
 
1102
- export interface Recommendation {
1103
- recommendation: Comment
1104
- work: WorkReference
1105
- }
1106
-
1107
1120
  export interface ShelvesPreview {
1108
1121
  shelf_id: string
1109
1122
  shelf_order: number
@@ -1128,16 +1141,6 @@ export interface EmbedSearch {
1128
1141
  url: string
1129
1142
  }
1130
1143
 
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
1144
  export interface ErrorResponse {
1142
1145
  code: number
1143
1146
  detail?: string | null
@@ -1354,6 +1357,12 @@ export interface Paths {
1354
1357
  search?: undefined
1355
1358
  response: void | ErrorResponse
1356
1359
  },
1360
+ "/v2/comment/all/work": {
1361
+ method: "get"
1362
+ body?: undefined
1363
+ search: RecommendationsSearchSchema & PaginationSearch
1364
+ response: PaginatedResponse<Recommendations> | ErrorResponse
1365
+ },
1357
1366
  "/work/create": {
1358
1367
  method: "post"
1359
1368
  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": {
@@ -4583,10 +4641,14 @@
4583
4641
  "properties": {
4584
4642
  "body": {
4585
4643
  "type": "number"
4644
+ },
4645
+ "body_on_work": {
4646
+ "type": "number"
4586
4647
  }
4587
4648
  },
4588
4649
  "required": [
4589
- "body"
4650
+ "body",
4651
+ "body_on_work"
4590
4652
  ]
4591
4653
  },
4592
4654
  "work_tags": {
@@ -6511,21 +6573,6 @@
6511
6573
  "works"
6512
6574
  ]
6513
6575
  },
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
6576
  "ShelvesPreview": {
6530
6577
  "type": "object",
6531
6578
  "properties": {
@@ -6631,49 +6678,6 @@
6631
6678
  "url"
6632
6679
  ]
6633
6680
  },
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
6681
  "ErrorResponse": {
6678
6682
  "type": "object",
6679
6683
  "properties": {
@@ -7858,6 +7862,107 @@
7858
7862
  }
7859
7863
  }
7860
7864
  },
7865
+ "/v2/comment/all/work": {
7866
+ "get": {
7867
+ "parameters": [
7868
+ {
7869
+ "name": "page",
7870
+ "in": "query",
7871
+ "description": "The page of data to query from. This endpoint uses a page size of 25 by default.",
7872
+ "schema": {
7873
+ "type": "integer",
7874
+ "minimum": 0
7875
+ }
7876
+ },
7877
+ {
7878
+ "name": "page_size",
7879
+ "in": "query",
7880
+ "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.",
7881
+ "schema": {
7882
+ "type": "integer",
7883
+ "minimum": 1,
7884
+ "maximum": 25
7885
+ }
7886
+ },
7887
+ {
7888
+ "name": "following_only",
7889
+ "in": "query",
7890
+ "required": false,
7891
+ "schema": {
7892
+ "anyOf": [
7893
+ {
7894
+ "type": "boolean"
7895
+ },
7896
+ {
7897
+ "type": "null"
7898
+ }
7899
+ ]
7900
+ }
7901
+ }
7902
+ ],
7903
+ "responses": {
7904
+ "200": {
7905
+ "description": "200 response",
7906
+ "content": {
7907
+ "application/json": {
7908
+ "schema": {
7909
+ "type": "object",
7910
+ "properties": {
7911
+ "data": {
7912
+ "$ref": "#/components/schemas/Recommendations"
7913
+ },
7914
+ "has_more": {
7915
+ "type": "boolean"
7916
+ },
7917
+ "page": {
7918
+ "type": "number",
7919
+ "minimum": 0
7920
+ },
7921
+ "page_count": {
7922
+ "type": [
7923
+ "boolean",
7924
+ "number"
7925
+ ],
7926
+ "anyOf": [
7927
+ {
7928
+ "type": "boolean",
7929
+ "enum": [
7930
+ true
7931
+ ]
7932
+ },
7933
+ {
7934
+ "type": "number",
7935
+ "minimum": 0
7936
+ }
7937
+ ]
7938
+ }
7939
+ },
7940
+ "required": [
7941
+ "data",
7942
+ "has_more",
7943
+ "page",
7944
+ "page_count"
7945
+ ]
7946
+ }
7947
+ }
7948
+ }
7949
+ },
7950
+ "304": {
7951
+ "description": "304 response"
7952
+ },
7953
+ "default": {
7954
+ "description": "Error",
7955
+ "content": {
7956
+ "application/json": {
7957
+ "schema": {
7958
+ "$ref": "#/components/schemas/ErrorResponse"
7959
+ }
7960
+ }
7961
+ }
7962
+ }
7963
+ }
7964
+ }
7965
+ },
7861
7966
  "/work/create": {
7862
7967
  "post": {
7863
7968
  "requestBody": {
package/package.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "api.fluff4.me",
3
- "version": "1.0.1086",
3
+ "version": "1.0.1088",
4
4
  "types": "index.d.ts"
5
5
  }