1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
8625
8626
8627
8628
8629
8630
8631
8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
8703
8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
8781
8782
8783
8784
8785
8786
8787
8788
8789
8790
8791
8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
8829
8830
8831
8832
8833
8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
8856
8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
8903
8904
8905
8906
8907
8908
8909
8910
8911
8912
8913
8914
8915
8916
8917
8918
8919
8920
8921
8922
8923
8924
8925
8926
8927
8928
8929
8930
8931
8932
8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
8978
8979
8980
8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
8994
8995
8996
8997
8998
8999
9000
9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
9050
9051
9052
9053
9054
9055
9056
9057
9058
9059
9060
9061
9062
9063
9064
9065
9066
9067
9068
9069
9070
9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
9085
9086
9087
9088
9089
9090
9091
9092
9093
9094
9095
9096
9097
9098
9099
9100
9101
9102
9103
9104
9105
9106
9107
9108
9109
9110
9111
9112
9113
9114
9115
9116
9117
9118
9119
9120
9121
9122
9123
9124
9125
9126
9127
9128
9129
9130
9131
9132
9133
9134
9135
9136
9137
9138
9139
9140
9141
9142
9143
9144
9145
9146
9147
9148
9149
9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
9167
9168
9169
9170
9171
9172
9173
9174
9175
9176
9177
9178
9179
9180
9181
9182
9183
9184
9185
9186
9187
9188
9189
9190
9191
9192
9193
9194
9195
9196
9197
9198
9199
9200
9201
9202
9203
9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
9229
9230
9231
9232
9233
9234
9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250
9251
9252
9253
9254
9255
9256
9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
9292
9293
9294
9295
9296
9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
9372
9373
9374
9375
9376
9377
9378
9379
9380
9381
9382
9383
9384
9385
9386
9387
9388
9389
9390
9391
9392
9393
9394
9395
9396
9397
9398
9399
9400
9401
9402
9403
9404
9405
9406
9407
9408
9409
9410
9411
9412
9413
9414
9415
9416
9417
9418
9419
9420
9421
9422
9423
9424
9425
9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
9443
9444
9445
9446
9447
9448
9449
9450
9451
9452
9453
9454
9455
9456
9457
9458
9459
9460
9461
9462
9463
9464
9465
9466
9467
9468
9469
9470
9471
9472
9473
9474
9475
9476
9477
9478
9479
9480
9481
9482
9483
9484
9485
9486
9487
9488
9489
9490
9491
9492
9493
9494
9495
9496
9497
9498
9499
9500
9501
9502
9503
9504
9505
9506
9507
9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
9530
9531
9532
9533
9534
9535
9536
9537
9538
9539
9540
9541
9542
9543
9544
9545
9546
9547
9548
9549
9550
9551
9552
9553
9554
9555
9556
9557
9558
9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
9612
9613
9614
9615
9616
9617
9618
9619
9620
9621
9622
9623
9624
9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
9648
9649
9650
9651
9652
9653
9654
9655
9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
9667
9668
9669
9670
9671
9672
9673
9674
9675
9676
9677
9678
9679
9680
9681
9682
9683
9684
9685
9686
9687
9688
9689
9690
9691
9692
9693
9694
9695
9696
9697
9698
9699
9700
9701
9702
9703
9704
9705
9706
9707
9708
9709
9710
9711
9712
9713
9714
9715
9716
9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
9739
9740
9741
9742
9743
9744
9745
9746
9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
9764
9765
9766
9767
9768
9769
9770
9771
9772
9773
9774
9775
9776
9777
9778
9779
9780
9781
9782
9783
9784
9785
9786
9787
9788
9789
9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
9809
9810
9811
9812
9813
9814
9815
9816
9817
9818
9819
9820
9821
9822
9823
9824
9825
9826
9827
9828
9829
9830
9831
9832
9833
9834
9835
9836
9837
9838
9839
9840
9841
9842
9843
9844
9845
9846
9847
9848
9849
9850
9851
9852
9853
9854
9855
9856
9857
9858
9859
9860
9861
9862
9863
9864
9865
9866
9867
9868
9869
9870
9871
9872
9873
9874
9875
9876
9877
9878
9879
9880
9881
9882
9883
9884
9885
9886
9887
9888
9889
9890
9891
9892
9893
9894
9895
9896
9897
9898
9899
9900
9901
9902
9903
9904
9905
9906
9907
9908
9909
9910
9911
9912
9913
9914
9915
9916
9917
9918
9919
9920
9921
9922
9923
9924
9925
9926
9927
9928
9929
9930
9931
9932
9933
9934
9935
9936
9937
9938
9939
9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
9974
9975
9976
9977
9978
9979
9980
9981
9982
9983
9984
9985
9986
9987
9988
9989
9990
9991
9992
9993
9994
9995
9996
9997
9998
9999
10000
10001
10002
10003
10004
10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
10020
10021
10022
10023
10024
10025
10026
10027
10028
10029
10030
10031
10032
10033
10034
10035
10036
10037
10038
10039
10040
10041
10042
10043
10044
10045
10046
10047
10048
10049
10050
10051
10052
10053
10054
10055
10056
10057
10058
10059
10060
10061
10062
10063
10064
10065
10066
10067
10068
10069
10070
10071
10072
10073
10074
10075
10076
10077
10078
10079
10080
10081
10082
10083
10084
10085
10086
10087
10088
10089
10090
10091
10092
10093
10094
10095
10096
10097
10098
10099
10100
10101
10102
10103
10104
10105
10106
10107
10108
10109
10110
10111
10112
10113
10114
10115
10116
10117
10118
10119
10120
10121
10122
10123
10124
10125
10126
10127
10128
10129
10130
10131
10132
10133
10134
10135
10136
10137
10138
10139
10140
10141
10142
10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
10165
10166
10167
10168
10169
10170
10171
10172
10173
10174
10175
10176
10177
10178
10179
10180
10181
10182
10183
10184
10185
10186
10187
10188
10189
10190
10191
10192
10193
10194
10195
10196
10197
10198
10199
10200
10201
10202
10203
10204
10205
10206
10207
10208
10209
10210
10211
10212
10213
10214
10215
10216
10217
10218
10219
10220
10221
10222
10223
10224
10225
10226
10227
10228
10229
10230
10231
10232
10233
10234
10235
10236
10237
10238
10239
10240
10241
10242
10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
10257
10258
10259
10260
10261
10262
10263
10264
10265
10266
10267
10268
10269
10270
10271
10272
10273
10274
10275
10276
10277
10278
10279
10280
10281
10282
10283
10284
10285
10286
10287
10288
10289
10290
10291
10292
10293
10294
10295
10296
10297
10298
10299
10300
10301
10302
10303
10304
10305
10306
10307
10308
10309
10310
10311
10312
10313
10314
10315
10316
10317
10318
10319
10320
10321
10322
10323
10324
10325
10326
10327
10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
10367
10368
10369
10370
10371
10372
10373
10374
10375
10376
10377
10378
10379
10380
10381
10382
10383
10384
10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
10414
10415
10416
10417
10418
10419
10420
10421
10422
10423
10424
10425
10426
10427
10428
10429
10430
10431
10432
10433
10434
10435
10436
10437
10438
10439
10440
10441
10442
10443
10444
10445
10446
10447
10448
10449
10450
10451
10452
10453
10454
10455
10456
10457
10458
10459
10460
10461
10462
10463
10464
10465
10466
10467
10468
10469
10470
10471
10472
10473
10474
10475
10476
10477
10478
10479
10480
10481
10482
10483
10484
10485
10486
10487
10488
10489
10490
10491
10492
10493
10494
10495
10496
10497
10498
10499
10500
10501
10502
10503
10504
10505
10506
10507
10508
10509
10510
10511
10512
10513
10514
10515
10516
10517
10518
10519
10520
10521
10522
10523
10524
10525
10526
10527
10528
10529
10530
10531
10532
10533
10534
10535
10536
10537
10538
10539
10540
10541
10542
10543
10544
10545
10546
10547
10548
10549
10550
10551
10552
10553
10554
10555
10556
10557
10558
10559
10560
10561
10562
10563
10564
10565
10566
10567
10568
10569
10570
10571
10572
10573
10574
10575
10576
10577
10578
10579
10580
10581
10582
10583
10584
10585
10586
10587
10588
10589
10590
10591
10592
10593
10594
10595
10596
10597
10598
10599
10600
10601
10602
10603
10604
10605
10606
10607
10608
10609
10610
10611
10612
10613
10614
10615
10616
10617
10618
10619
10620
10621
10622
10623
10624
10625
10626
10627
10628
10629
10630
10631
10632
10633
10634
10635
10636
10637
10638
10639
10640
10641
10642
10643
10644
10645
10646
10647
10648
10649
10650
10651
10652
10653
10654
10655
10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
10674
10675
10676
10677
10678
10679
10680
10681
10682
10683
10684
10685
10686
10687
10688
10689
10690
10691
10692
10693
10694
10695
10696
10697
10698
10699
10700
10701
10702
10703
10704
10705
10706
10707
10708
10709
10710
10711
10712
10713
10714
10715
10716
10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
10747
10748
10749
10750
10751
10752
10753
10754
10755
10756
10757
10758
10759
10760
10761
10762
10763
10764
10765
10766
10767
10768
10769
10770
10771
10772
10773
10774
10775
10776
10777
10778
10779
10780
10781
10782
10783
10784
10785
10786
10787
10788
10789
10790
10791
10792
10793
10794
10795
10796
10797
10798
10799
10800
10801
10802
10803
10804
10805
10806
10807
10808
10809
10810
10811
10812
10813
10814
10815
10816
10817
10818
10819
10820
10821
10822
10823
10824
10825
10826
10827
10828
10829
10830
10831
10832
10833
10834
10835
10836
10837
10838
10839
10840
10841
10842
10843
10844
10845
10846
10847
10848
10849
10850
10851
10852
10853
10854
10855
10856
10857
10858
10859
10860
10861
10862
10863
10864
10865
10866
10867
10868
10869
10870
10871
10872
10873
10874
10875
10876
10877
10878
10879
10880
10881
10882
10883
10884
10885
10886
10887
10888
10889
10890
10891
10892
10893
10894
10895
10896
10897
10898
10899
10900
10901
10902
10903
10904
10905
10906
10907
10908
10909
10910
10911
10912
10913
10914
10915
10916
10917
10918
10919
10920
10921
10922
10923
10924
10925
10926
10927
10928
10929
10930
10931
10932
10933
10934
10935
10936
10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
10988
10989
10990
10991
10992
10993
10994
10995
10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
11021
11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
11037
11038
11039
11040
11041
11042
11043
11044
11045
11046
11047
11048
11049
11050
11051
11052
11053
11054
11055
11056
11057
11058
11059
11060
11061
11062
11063
11064
11065
11066
11067
11068
11069
11070
11071
11072
11073
11074
11075
11076
11077
11078
11079
11080
11081
11082
11083
11084
11085
11086
11087
11088
11089
11090
11091
11092
11093
11094
11095
11096
11097
11098
11099
11100
11101
11102
11103
11104
11105
11106
11107
11108
11109
11110
11111
11112
11113
11114
11115
11116
11117
11118
11119
11120
11121
11122
11123
11124
11125
11126
11127
11128
11129
11130
11131
11132
11133
11134
11135
11136
11137
11138
11139
11140
11141
11142
11143
11144
11145
11146
11147
11148
11149
11150
11151
11152
11153
11154
11155
11156
11157
11158
11159
11160
11161
11162
11163
11164
11165
11166
11167
11168
11169
11170
11171
11172
11173
11174
11175
11176
11177
11178
11179
11180
11181
11182
11183
11184
11185
11186
11187
11188
11189
11190
11191
11192
11193
11194
11195
11196
11197
11198
11199
11200
11201
11202
11203
11204
11205
11206
11207
11208
11209
11210
11211
11212
11213
11214
11215
11216
11217
11218
11219
11220
11221
11222
11223
11224
11225
11226
11227
11228
11229
11230
11231
11232
11233
11234
11235
11236
11237
11238
11239
11240
11241
11242
11243
11244
11245
11246
11247
11248
11249
11250
11251
11252
11253
11254
11255
11256
11257
11258
11259
11260
11261
11262
11263
11264
11265
11266
11267
11268
11269
11270
11271
11272
11273
11274
11275
11276
11277
11278
11279
11280
11281
11282
11283
11284
11285
11286
11287
11288
11289
11290
11291
11292
11293
11294
11295
11296
11297
11298
11299
11300
11301
11302
11303
11304
11305
11306
11307
11308
11309
11310
11311
11312
11313
11314
11315
11316
11317
11318
11319
11320
11321
11322
11323
11324
11325
11326
11327
11328
11329
11330
11331
11332
11333
11334
11335
11336
11337
11338
11339
11340
11341
11342
11343
11344
11345
11346
11347
11348
11349
11350
11351
11352
11353
11354
11355
11356
11357
11358
11359
11360
11361
11362
11363
11364
11365
11366
11367
11368
11369
11370
11371
11372
11373
11374
11375
11376
11377
11378
11379
11380
11381
11382
11383
11384
11385
11386
11387
11388
11389
11390
11391
11392
11393
11394
11395
11396
11397
11398
11399
11400
11401
11402
11403
11404
11405
11406
11407
11408
11409
11410
11411
11412
11413
11414
11415
11416
11417
11418
11419
11420
11421
11422
11423
11424
11425
11426
11427
11428
11429
11430
11431
11432
11433
11434
11435
11436
11437
11438
11439
11440
11441
11442
11443
11444
11445
11446
11447
11448
11449
11450
11451
11452
11453
11454
11455
11456
11457
11458
11459
11460
11461
11462
11463
11464
11465
11466
11467
11468
11469
11470
11471
11472
11473
11474
11475
11476
11477
11478
11479
11480
11481
11482
11483
11484
11485
11486
11487
11488
11489
11490
11491
11492
11493
11494
11495
11496
11497
11498
11499
11500
11501
11502
11503
11504
11505
11506
11507
11508
11509
11510
11511
11512
11513
11514
11515
11516
11517
11518
11519
11520
11521
11522
11523
11524
11525
11526
11527
11528
11529
11530
11531
11532
11533
11534
11535
11536
11537
11538
11539
11540
11541
11542
11543
11544
11545
11546
11547
11548
11549
11550
11551
11552
11553
11554
11555
11556
11557
11558
11559
11560
11561
11562
11563
11564
11565
11566
11567
11568
11569
11570
11571
11572
11573
11574
11575
11576
11577
11578
11579
11580
11581
11582
11583
11584
11585
11586
11587
11588
11589
11590
11591
11592
11593
11594
11595
11596
11597
11598
11599
11600
11601
11602
11603
11604
11605
11606
11607
11608
11609
11610
11611
11612
11613
11614
11615
11616
11617
11618
11619
11620
11621
11622
11623
11624
11625
11626
11627
11628
11629
11630
11631
11632
11633
11634
11635
11636
11637
11638
11639
11640
11641
11642
11643
11644
11645
11646
11647
11648
11649
11650
11651
11652
11653
11654
11655
11656
11657
11658
11659
11660
11661
11662
11663
11664
11665
11666
11667
11668
11669
11670
11671
11672
11673
11674
11675
11676
11677
11678
11679
11680
11681
11682
11683
11684
11685
11686
11687
11688
11689
11690
11691
11692
11693
11694
11695
11696
11697
11698
11699
11700
11701
11702
11703
11704
11705
11706
11707
11708
11709
11710
11711
11712
11713
11714
11715
11716
11717
11718
11719
11720
11721
11722
11723
11724
11725
11726
11727
11728
11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
11739
11740
11741
11742
11743
11744
11745
11746
11747
11748
11749
11750
11751
11752
11753
11754
11755
11756
11757
11758
11759
11760
11761
11762
11763
11764
11765
11766
11767
11768
11769
11770
11771
11772
11773
11774
11775
11776
11777
11778
11779
11780
11781
11782
11783
11784
11785
11786
11787
11788
11789
11790
11791
11792
11793
11794
11795
11796
11797
11798
11799
11800
11801
11802
11803
11804
11805
11806
11807
11808
11809
11810
11811
11812
11813
11814
11815
11816
11817
11818
11819
11820
11821
11822
11823
11824
11825
11826
11827
11828
11829
11830
11831
11832
11833
11834
11835
11836
11837
11838
11839
11840
11841
11842
11843
11844
11845
11846
11847
11848
11849
11850
11851
11852
11853
11854
11855
11856
11857
11858
11859
11860
11861
11862
11863
11864
11865
11866
11867
11868
11869
11870
11871
11872
11873
11874
11875
11876
11877
11878
11879
11880
11881
11882
11883
11884
11885
11886
11887
11888
11889
11890
11891
11892
11893
11894
11895
11896
11897
11898
11899
11900
11901
11902
11903
11904
11905
11906
11907
11908
11909
11910
11911
11912
11913
11914
11915
11916
11917
11918
11919
11920
11921
11922
11923
11924
11925
11926
11927
11928
11929
11930
11931
11932
11933
11934
11935
11936
11937
11938
11939
11940
11941
11942
11943
11944
11945
11946
11947
11948
11949
11950
11951
11952
11953
11954
11955
11956
11957
11958
11959
11960
11961
11962
11963
11964
11965
11966
11967
11968
11969
11970
11971
11972
11973
11974
11975
11976
11977
11978
11979
11980
11981
11982
11983
11984
11985
11986
11987
11988
11989
11990
11991
11992
11993
11994
11995
11996
11997
11998
11999
12000
12001
12002
12003
12004
12005
12006
12007
12008
12009
12010
12011
12012
12013
12014
12015
12016
12017
12018
12019
12020
12021
12022
12023
12024
12025
12026
12027
12028
12029
12030
12031
12032
12033
12034
12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
12045
12046
12047
12048
12049
12050
12051
12052
12053
12054
12055
12056
12057
12058
12059
12060
12061
12062
12063
12064
12065
12066
12067
12068
12069
12070
12071
12072
12073
12074
12075
12076
12077
12078
12079
12080
12081
12082
12083
12084
12085
12086
12087
12088
12089
12090
12091
12092
12093
12094
12095
12096
12097
12098
12099
12100
12101
12102
12103
12104
12105
12106
12107
12108
12109
12110
12111
12112
12113
12114
12115
12116
12117
12118
12119
12120
12121
12122
12123
12124
12125
12126
12127
12128
12129
12130
12131
12132
12133
12134
12135
12136
12137
12138
12139
12140
12141
12142
12143
12144
12145
12146
12147
12148
12149
12150
12151
12152
12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
12178
12179
12180
12181
12182
12183
12184
12185
12186
12187
12188
12189
12190
12191
12192
12193
12194
12195
12196
12197
12198
12199
12200
12201
12202
12203
12204
12205
12206
12207
12208
12209
12210
12211
12212
12213
12214
12215
12216
12217
12218
12219
12220
12221
12222
12223
12224
12225
12226
12227
12228
12229
12230
12231
12232
12233
12234
12235
12236
12237
12238
12239
12240
12241
12242
12243
12244
12245
12246
12247
12248
12249
12250
12251
12252
12253
12254
12255
12256
12257
12258
12259
12260
12261
12262
12263
12264
12265
12266
12267
12268
12269
12270
12271
12272
12273
12274
12275
12276
12277
12278
12279
12280
12281
12282
12283
12284
12285
12286
12287
12288
12289
12290
12291
12292
12293
12294
12295
12296
12297
12298
12299
12300
12301
12302
12303
12304
12305
12306
12307
12308
12309
12310
12311
12312
12313
12314
12315
12316
12317
12318
12319
12320
12321
12322
12323
12324
12325
12326
12327
12328
12329
12330
12331
12332
12333
12334
12335
12336
12337
12338
12339
12340
12341
12342
12343
12344
12345
12346
12347
12348
12349
12350
12351
12352
12353
12354
12355
12356
12357
12358
12359
12360
12361
12362
12363
12364
12365
12366
12367
12368
12369
12370
12371
12372
12373
12374
12375
12376
12377
12378
12379
12380
12381
12382
12383
12384
12385
12386
12387
12388
12389
12390
12391
12392
12393
12394
12395
12396
12397
12398
12399
12400
12401
12402
12403
12404
12405
12406
12407
12408
12409
12410
12411
12412
12413
12414
12415
12416
12417
12418
12419
12420
12421
12422
12423
12424
12425
12426
12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
12448
12449
12450
12451
12452
12453
12454
12455
12456
12457
12458
12459
12460
12461
12462
12463
12464
12465
12466
12467
12468
12469
12470
12471
12472
12473
12474
12475
12476
12477
12478
12479
12480
12481
12482
12483
12484
12485
12486
12487
12488
12489
12490
12491
12492
12493
12494
12495
12496
12497
12498
12499
12500
12501
12502
12503
12504
12505
12506
12507
12508
12509
12510
12511
12512
12513
12514
12515
12516
12517
12518
12519
12520
12521
12522
12523
12524
12525
12526
12527
12528
12529
12530
12531
12532
12533
12534
12535
12536
12537
12538
12539
12540
12541
12542
12543
12544
12545
12546
12547
12548
12549
12550
12551
12552
12553
12554
12555
12556
12557
12558
12559
12560
12561
12562
12563
12564
12565
12566
12567
12568
12569
12570
12571
12572
12573
12574
12575
12576
12577
12578
12579
12580
12581
12582
12583
12584
12585
12586
12587
12588
12589
12590
12591
12592
12593
12594
12595
12596
12597
12598
12599
12600
12601
12602
12603
12604
12605
12606
12607
12608
12609
12610
12611
12612
12613
12614
12615
12616
12617
12618
12619
12620
12621
12622
12623
12624
12625
12626
12627
12628
12629
12630
12631
12632
12633
12634
12635
12636
12637
12638
12639
12640
12641
12642
12643
12644
12645
12646
12647
12648
12649
12650
12651
12652
12653
12654
12655
12656
12657
12658
12659
12660
12661
12662
12663
12664
12665
12666
12667
12668
12669
12670
12671
12672
12673
12674
12675
12676
12677
12678
12679
12680
12681
12682
12683
12684
12685
12686
12687
12688
12689
12690
12691
12692
12693
12694
12695
12696
12697
12698
12699
12700
12701
12702
12703
12704
12705
12706
12707
12708
12709
12710
12711
12712
12713
12714
12715
12716
12717
12718
12719
12720
12721
12722
12723
12724
12725
12726
12727
12728
12729
12730
12731
12732
12733
12734
12735
12736
12737
12738
12739
12740
12741
12742
12743
12744
12745
12746
12747
12748
12749
12750
12751
12752
12753
12754
12755
12756
12757
12758
12759
12760
12761
12762
12763
12764
12765
12766
12767
12768
12769
12770
12771
12772
12773
12774
12775
12776
12777
12778
12779
12780
12781
12782
12783
12784
12785
12786
12787
12788
12789
12790
12791
12792
12793
12794
12795
12796
12797
12798
12799
12800
12801
12802
12803
12804
12805
12806
12807
12808
12809
12810
12811
12812
12813
12814
12815
12816
12817
12818
12819
12820
12821
12822
12823
12824
12825
12826
12827
12828
12829
12830
12831
12832
12833
12834
12835
12836
12837
12838
12839
12840
12841
12842
12843
12844
12845
12846
12847
12848
12849
12850
12851
12852
12853
12854
12855
12856
12857
12858
12859
12860
12861
12862
12863
12864
12865
12866
12867
12868
12869
12870
12871
12872
12873
12874
12875
12876
12877
12878
12879
12880
12881
12882
12883
12884
12885
12886
12887
12888
12889
12890
12891
12892
12893
12894
12895
12896
12897
12898
12899
12900
12901
12902
12903
12904
12905
12906
12907
12908
12909
12910
12911
12912
12913
12914
12915
12916
12917
12918
12919
12920
12921
12922
12923
12924
12925
12926
12927
12928
12929
12930
12931
12932
12933
12934
12935
12936
12937
12938
12939
12940
12941
12942
12943
12944
12945
12946
12947
12948
12949
12950
12951
12952
12953
12954
12955
12956
12957
12958
12959
12960
12961
12962
12963
12964
12965
12966
12967
12968
12969
12970
12971
12972
12973
12974
12975
12976
12977
12978
12979
12980
12981
12982
12983
12984
12985
12986
12987
12988
12989
12990
12991
12992
12993
12994
12995
12996
12997
12998
12999
13000
13001
13002
13003
13004
13005
13006
13007
13008
13009
13010
13011
13012
13013
13014
13015
13016
13017
13018
13019
13020
13021
13022
13023
13024
13025
13026
13027
13028
13029
13030
13031
13032
13033
13034
13035
13036
13037
13038
13039
13040
13041
13042
13043
13044
13045
13046
13047
13048
13049
13050
13051
13052
13053
13054
13055
13056
13057
13058
13059
13060
13061
13062
13063
13064
13065
13066
13067
13068
13069
13070
13071
13072
13073
13074
13075
13076
13077
13078
13079
13080
13081
13082
13083
13084
13085
13086
13087
13088
13089
13090
13091
13092
13093
13094
13095
13096
13097
13098
13099
13100
13101
13102
13103
13104
13105
13106
13107
13108
13109
13110
13111
13112
13113
13114
13115
13116
13117
13118
13119
13120
13121
13122
13123
13124
13125
13126
13127
13128
13129
13130
13131
13132
13133
13134
13135
13136
13137
13138
13139
13140
13141
13142
13143
13144
13145
13146
13147
13148
13149
13150
13151
13152
13153
13154
13155
13156
13157
13158
13159
13160
13161
13162
13163
13164
13165
13166
13167
13168
13169
13170
13171
13172
13173
13174
13175
13176
13177
13178
13179
13180
13181
13182
13183
13184
13185
13186
13187
13188
13189
13190
13191
13192
13193
13194
13195
13196
13197
13198
13199
13200
13201
13202
13203
13204
13205
13206
13207
13208
13209
13210
13211
13212
13213
13214
13215
13216
13217
13218
13219
13220
13221
13222
13223
13224
13225
13226
13227
13228
13229
13230
13231
13232
13233
13234
13235
13236
13237
13238
13239
13240
13241
13242
13243
13244
13245
13246
13247
13248
13249
13250
13251
13252
13253
13254
13255
13256
13257
13258
13259
13260
13261
13262
13263
13264
13265
13266
13267
13268
13269
13270
13271
13272
13273
13274
13275
13276
13277
13278
13279
13280
13281
13282
13283
13284
13285
13286
13287
13288
13289
13290
13291
13292
13293
13294
13295
13296
13297
13298
13299
13300
13301
13302
13303
13304
13305
13306
13307
13308
13309
13310
13311
13312
13313
13314
13315
13316
13317
13318
13319
13320
13321
13322
13323
13324
13325
13326
13327
13328
13329
13330
13331
13332
13333
13334
13335
13336
13337
13338
13339
13340
13341
13342
13343
13344
13345
13346
13347
13348
13349
13350
13351
13352
13353
13354
13355
13356
13357
13358
13359
13360
13361
13362
13363
13364
13365
13366
13367
13368
13369
13370
13371
13372
13373
13374
13375
13376
13377
13378
13379
13380
13381
13382
13383
13384
13385
13386
13387
13388
13389
13390
13391
13392
13393
13394
13395
13396
13397
13398
13399
13400
13401
13402
13403
13404
13405
13406
13407
13408
13409
13410
13411
13412
13413
13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
13432
13433
13434
13435
13436
13437
13438
13439
13440
13441
13442
13443
13444
13445
13446
13447
13448
13449
13450
13451
13452
13453
13454
13455
13456
13457
13458
13459
13460
13461
13462
13463
13464
13465
13466
13467
13468
13469
13470
13471
13472
13473
13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
13553
13554
13555
13556
13557
13558
13559
13560
13561
13562
13563
13564
13565
13566
13567
13568
13569
13570
13571
13572
13573
13574
13575
13576
13577
13578
13579
13580
13581
13582
13583
13584
13585
13586
13587
13588
13589
13590
13591
13592
13593
13594
13595
13596
13597
13598
13599
13600
13601
13602
13603
13604
13605
13606
13607
13608
13609
13610
13611
13612
13613
13614
13615
13616
13617
13618
13619
13620
13621
13622
13623
13624
13625
13626
13627
13628
|
basePath: /
definitions:
FilterAction:
title: FilterAction
description: FilterAction 是针对与过滤规则匹配的贴文所执行的操作。
type: string
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
InstanceConfigurationEmojis:
properties:
emoji_size_limit:
description: 最大自定义表情文件大小(字节)。
example: 51200
format: int64
type: integer
x-go-name: EmojiSizeLimit
title: InstanceConfigurationEmojis
description: InstanceConfigurationEmojis 结构体包含有关自定义表情的配置信息。
type: object
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
Link:
description: Link 代表针对查询请求返回的链接组中的一个“链接”。详见 https://webfinger.net/ 和 https://www.rfc-editor.org/rfc/rfc6415.html#section-3.1
properties:
href:
type: string
x-go-name: Href
rel:
type: string
x-go-name: Rel
template:
type: string
x-go-name: Template
type:
type: string
x-go-name: Type
title: Link
type: object
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
Mention:
properties:
acct:
description: |-
通过webfinger发现的帐户URI。
对于本站用户,等于"用户名",对于外站用户,等于"用户名@域名"。
example: some_user@example.org
type: string
x-go-name: Acct
id:
description: 被提及的帐户的ID。
example: 01FBYJHQWQZAVWFRK9PDYTKGMB
type: string
x-go-name: ID
url:
description: 被提及的账户的Web资料页。
example: https://example.org/@some_user
type: string
x-go-name: URL
username:
description: 被提及账户的用户名。
example: some_user
type: string
x-go-name: Username
title: Mention
description: Mention 表示对另一个账户的一次提及。
type: object
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
NodeInfoServices:
properties:
inbound:
items:
type: string
type: array
x-go-name: Inbound
outbound:
items:
type: string
type: array
x-go-name: Outbound
title: NodeInfoServices
description: 表示此节点对入站和出站连接提供的服务。
type: object
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
NodeInfoSoftware:
properties:
homepage:
description: 该软件的主页,此字段在版本 2.0 中被省略。
example: https://docs.gotosocial.org/zh-cn/
type: string
x-go-name: Homepage
name:
example: gotosocial
type: string
x-go-name: Name
repository:
description: 该软件的存储库,此字段在版本 2.0 中被省略。
example: https://codeberg.org/superseriousbusiness/gotosocial
type: string
x-go-name: Repository
version:
example: 0.1.2 1234567
type: string
x-go-name: Version
title: NodeInfoSoftware
description: NodeInfoSoftware 表示此节点软件的名称和版本号。
type: object
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
NodeInfoUsage:
properties:
localComments:
format: int64
type: integer
x-go-name: LocalComments
localPosts:
format: int64
type: integer
x-go-name: LocalPosts
users:
$ref: '#/definitions/NodeInfoUsers'
title: NodeInfoUsage
description: 表示有关此服务器的使用信息,例如用户数量。
type: object
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
NodeInfoUsers:
properties:
activeHalfYear:
format: int64
type: integer
x-go-name: ActiveHalfYear
activeMonth:
format: int64
type: integer
x-go-name: ActiveMonth
total:
format: int64
type: integer
x-go-name: Total
title: NodeInfoUsers
description: NodeInfoUsers 表示有关服务器上用户的聚合信息。
type: object
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
Source:
description: Source 表示用户自己账户的内容展示或发布偏好。在验证和更新凭据时,作为 Account 的一个属性返回的附加实体。
properties:
also_known_as_uris:
description: |-
要设置此值,请调用 `/api/v1/accounts/alias`。
若为空或为设置,将从json中省略。
items:
type: string
type: array
x-go-name: AlsoKnownAsURIs
fields:
description: 此账户的元数据。
items:
$ref: '#/definitions/field'
type: array
x-go-name: Fields
follow_requests_count:
description: 待处理的关注请求数量。
format: int64
type: integer
x-go-name: FollowRequestsCount
language:
description: 新贴文的默认发布语言。
type: string
x-go-name: Language
note:
description: 个人资料简介。
type: string
x-go-name: Note
privacy:
description: |-
新贴文的默认可见性。
public = 公开贴文
unlisted = 未列出/不公开/悄悄公开贴文
private = 仅粉丝可见的贴文
direct = 私信贴文
type: string
x-go-name: Privacy
sensitive:
description: 是否将新贴文默认标记为敏感。
type: boolean
x-go-name: Sensitive
status_content_type:
description: 新贴文的默认内容格式。
type: string
x-go-name: StatusContentType
web_layout:
description: |-
账户的网页布局。
"microblog": 默认值,经典微博客布局。
"gallery": 仅显示媒体的画廊布局。
type: string
x-go-name: WebLayout
web_visibility:
description: |-
通过网页端API显示的该账户下贴文的最低可见性。
"public" = 默认值,此时仅显示公开贴文。
"unlisted" = 显示公开贴文 *和* 未列出的贴文。
"none" = 不在网页端显示任何贴文,即使贴文为公开贴文。
type: string
x-go-name: WebVisibility
title: Source
type: object
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
TimelineMarker:
properties:
last_read_id:
description: 最近查看的内容实体的ID。
type: string
x-go-name: LastReadID
updated_at:
description: 设定标记时的时间戳 (ISO 8601 Datetime)。
type: string
x-go-name: UpdatedAt
version:
description: 用于锁定以防止写冲突。
format: int64
type: integer
x-go-name: Version
title: TimelineMarker
description: TimelineMarker 包含有关用户在特定时间线上的阅读进度的信息。
type: object
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
WebPushNotificationPolicy:
description: WebPushNotificationPolicy 包含可以生成通知的帐户集合。
type: string
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
account:
description: Account 是一个 Fediverse 账户的抽象模型。被抽象的账户可以是本站账户,也可以是外站账户。
properties:
acct:
description: |-
通过 WebFinger 发现的帐户 URI。
对于本站用户,等于“用户名”,对于外站用户,等于“用户名@域名”。
example: some_user@example.org
type: string
x-go-name: Acct
avatar:
description: 账户头像的网络地址。
example: https://example.org/media/some_user/avatar/original/avatar.jpeg
type: string
x-go-name: Avatar
avatar_description:
description: 该账户头像的文字描述,用于提供 Alt 文本。
example: 一只微笑的树懒的可爱图画。
type: string
x-go-name: AvatarDescription
avatar_media_id:
description: |-
此账户的头像对应的媒体附件的数据库 ID。
如果此账户没有上传头像(即默认头像),则省略。
example: 01JAJ3XCD66K3T99JZESCR137W
type: string
x-go-name: AvatarMediaID
avatar_static:
description: |-
该账户头像的静态版本的网络地址。
仅在账户的主头像是视频或 gif 时才起实际作用。
example: https://example.org/media/some_user/avatar/static/avatar.png
type: string
x-go-name: AvatarStatic
bot:
description: 表示账户是一个机器人。
type: boolean
x-go-name: Bot
created_at:
description: 账户创建时间 (ISO 8601 Datetime)。
example: "2021-07-30T09:20:25+00:00"
type: string
x-go-name: CreatedAt
custom_css:
description: 渲染该账户的资料页或贴文页时要包含的自定义 CSS。
type: string
x-go-name: CustomCSS
discoverable:
description: 表示账户已选择加入内容发现功能。
type: boolean
x-go-name: Discoverable
display_name:
description: 该账户的昵称
example: 树懒一号
type: string
x-go-name: DisplayName
emojis:
description: |-
该账户的简介或昵称中使用的自定义表情组成的数组。
如果账户被屏蔽,则始终为空。
items:
$ref: '#/definitions/emoji'
type: array
x-go-name: Emojis
enable_rss:
description: |-
账户已启用 RSS 订阅。
如果为 false,则省略键/值。
type: boolean
x-go-name: EnableRSS
fields:
description: |-
账户设置的附加元数据。
如果账户被屏蔽,则始终为空。
items:
$ref: '#/definitions/field'
type: array
x-go-name: Fields
followers_count:
description: 该账户的粉丝数量(数据来源于本站)。
format: int64
type: integer
x-go-name: FollowersCount
following_count:
description: 该账户关注的账户数量(数据来源于本站)。
format: int64
type: integer
x-go-name: FollowingCount
group:
description: 该账户被标记为 Group 类型的行为体。
type: boolean
x-go-name: Group
header:
description: 该账户的资料卡横幅背景图片的网络地址。
example: https://example.org/media/some_user/header/original/header.jpeg
type: string
x-go-name: Header
header_description:
description: 该账户的资料卡横幅背景图片的文字描述,用于提供 Alt 文本。
example: 一只树懒和一只小象在一起的可爱图画。
type: string
x-go-name: HeaderDescription
header_media_id:
description: |-
此账户的资料卡横幅背景图片对应的媒体附件的数据库 ID。
如果此账户没有上传资料卡横幅背景图(即使用默认横幅背景),则省略。
example: 01JAJ3XCD66K3T99JZESCR137W
type: string
x-go-name: HeaderMediaID
header_static:
description: |-
该账户的资料卡横幅背景图片的静态版本的网络地址。
仅在账户的资料卡横幅背景图片是视频或 gif 时才起实际作用。
example: https://example.org/media/some_user/header/static/header.png
type: string
x-go-name: HeaderStatic
hide_collections:
description: |-
账户选择隐藏其粉丝/关注数据。
如果为 false,则省略键/值。
type: boolean
x-go-name: HideCollections
id:
description: 账户的 ID。
example: 01FBVD42CQ3ZEEVMW180SBX03B
type: string
x-go-name: ID
last_status_at:
description: 账户最近一条贴文的发布时间 (ISO 8601 Date)。
example: "2021-07-30"
type: string
x-go-name: LastStatusAt
locked:
description: 账户选择手动批准关注请求。
type: boolean
x-go-name: Locked
moved:
$ref: '#/definitions/account'
note:
description: 账户的简介。
type: string
x-go-name: Note
role:
$ref: '#/definitions/accountRole'
roles:
description: |-
Roles 列出了账户在本站上的公开身份组。
与 Role 不同,Roles 始终可用,但从不包含权限细节。
对于外站账户,键/值被省略。
items:
$ref: '#/definitions/accountDisplayRole'
type: array
x-go-name: Roles
source:
$ref: '#/definitions/Source'
statuses_count:
description: Number of statuses posted by this account, according to our instance. 账户发布的贴文数量 (数据来源于本站)。
format: int64
type: integer
x-go-name: StatusesCount
suspended:
description: 账户已被本站封禁。
type: boolean
x-go-name: Suspended
theme:
description: 用户选择的 CSS 主题文件名,用于在渲染此账户的资料页或贴文页时包含。
type: string
x-go-name: Theme
url:
description: 账户资料页的 Web 地址。
example: https://example.org/@some_user
type: string
x-go-name: URL
username:
description: 账户的用户名,不包括域名。
example: some_user
type: string
x-go-name: Username
title: Account
type: object
x-go-name: Account
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
accountDisplayRole:
description: AccountDisplayRole 是账户的公开、可显示身份组的抽象模型。它是 AccountRole 的一个子集。
properties:
color:
description: |-
Color 是一个带有前导 `#` 的 6 位 CSS 风格十六进制颜色码,如果此身份组没有设置颜色,则为空字符串。
GotoSocial 不使用身份组颜色,因此我们将其留空。
type: string
x-go-name: Color
id:
description: |-
身份组的 ID。
GotoSocial 不使用该属性,但我们将其设置为身份组名称,以防客户端期望唯一 ID。
type: string
x-go-name: ID
name:
description: 身份组的名称。
type: string
x-go-name: Name
title: AccountDisplayRole
type: object
x-go-name: AccountDisplayRole
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
accountExportStats:
description: |-
AccountExportStats 专门用于在 /api/v1/exports/stats 端点上通知有关导出大小的账户统计信息。
properties:
blocks_count:
description: 被此账户屏蔽的账户数量。
example: 15
format: int64
type: integer
x-go-name: BlocksCount
followers_count:
description: 此账户的粉丝数量。
example: 50
format: int64
type: integer
x-go-name: FollowersCount
following_count:
description: 此账户关注的账户数量。
example: 50
format: int64
type: integer
x-go-name: FollowingCount
lists_count:
description: 此账户创建的列表数量。
example: 10
format: int64
type: integer
x-go-name: ListsCount
media_storage:
description: 'TODO: 此账户使用的媒体存储空间大小的字符串表示。'
example: 500MB
type: string
x-go-name: MediaStorage
mutes_count:
description: 此账户静音/隐藏的账户数量。
example: 11
format: int64
type: integer
x-go-name: MutesCount
statuses_count:
description: 此账户发布的贴文数量。
example: 81986
format: int64
type: integer
x-go-name: StatusesCount
type: object
x-go-name: AccountExportStats
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
accountRelationship:
properties:
blocked_by:
description: 你被此账户屏蔽。
type: boolean
x-go-name: BlockedBy
blocking:
description: 你屏蔽了此账户。
type: boolean
x-go-name: Blocking
domain_blocking:
description: 你屏蔽了此账户所在的实例。
type: boolean
x-go-name: DomainBlocking
endorsed:
description: 你在你的资料页上展示了此账户。
type: boolean
x-go-name: Endorsed
followed_by:
description: 此账户关注了你。
type: boolean
x-go-name: FollowedBy
following:
description: 你关注了此账户。
type: boolean
x-go-name: Following
id:
description: 账户 ID。
example: 01FBW9XGEP7G6K88VY4S9MPE1R
type: string
x-go-name: ID
muting:
description: 你静音/隐藏了此账户。
type: boolean
x-go-name: Muting
muting_notifications:
description: 你静音/隐藏了此账户的通知。
type: boolean
x-go-name: MutingNotifications
note:
description: 你对此账户的备注。
type: string
x-go-name: Note
notifying:
description: 你在此账户发布贴文时收到通知。
type: boolean
x-go-name: Notifying
requested:
description: 你向此账户发送了关注请求,请求正在等待对方处理。
type: boolean
x-go-name: Requested
requested_by:
description: 此账户请求关注你,请求正在等待你处理。
type: boolean
x-go-name: RequestedBy
showing_reblogs:
description: 你选择在主页时间线上看到此账户转发的贴文。
type: boolean
x-go-name: ShowingReblogs
title: Relationship
description: Relationship 表示账户之间的关系。
type: object
x-go-name: Relationship
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
accountRole:
properties:
color:
description: |-
Color 是一个带有 `#` 前缀的 6 位 CSS 风格十六进制颜色码,如果此身份组没有设置颜色,则为空字符串。
GotoSocial 不使用身份组颜色,因此我们将其留空。
type: string
x-go-name: Color
highlighted:
description: |-
Highlighted 表示该身份组是否在用户资料页上公开显示。
对于 GotoSocial 内置的管理员和站务身份组,此值始终为 true,否则为 false。
type: boolean
x-go-name: Highlighted
id:
description: |-
该身份组的 ID。
GotoSocial 不使用该属性,但我们将其设置为身份组名称,以防客户端期望唯一 ID。
type: string
x-go-name: ID
name:
description: 身份组的名称。
type: string
x-go-name: Name
permissions:
description: Permissions 是一个按位序列化的数字字符串,指示用户可以执行哪些管理员/站务操作。
type: string
x-go-name: Permissions
title: AccountRole
description: AccountRole 是账户的身份组的抽象模型。
type: object
x-go-name: AccountRole
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
adminAccountInfo:
properties:
account:
$ref: '#/definitions/account'
approved:
description: 账户是否已被批准。
type: boolean
x-go-name: Approved
confirmed:
description: 账户是否已验证其电子邮件地址。
type: boolean
x-go-name: Confirmed
created_at:
description: 账户首次被发现的时间 (ISO 8601 Datetime)。
example: "2021-07-30T09:20:25+00:00"
type: string
x-go-name: CreatedAt
created_by_application_id:
description: 创建此账户的应用程序的 ID。
type: string
x-go-name: CreatedByApplicationID
disabled:
description: 账户目前是否已被停用。
type: boolean
x-go-name: Disabled
domain:
description: |-
账户所在实例的域名。
对于本站账户,为 null。
example: example.org
type: string
x-go-name: Domain
email:
description: |-
与账户关联的电子邮件地址。
对于外站账户或没有已知电子邮件地址的账户,为空字符串。
example: someone@somewhere.com
type: string
x-go-name: Email
id:
description: 该账户在数据库中的 ID。
example: 01GQ4PHNT622DQ9X95XQX4KKNR
type: string
x-go-name: ID
invite_request:
description: |-
账户填写的注册理由。
如果未提供理由或为外站账户,则为 null。
example: 快给爷通过a!!
type: string
x-go-name: InviteRequest
invited_by_account_id:
description: 邀请此用户的账户的 ID。
type: string
x-go-name: InvitedByAccountID
ip:
description: |-
此账户上次登录的 IP 地址。
如果未知,则为 null。
example: 192.0.2.1
type: string
x-go-name: IP
ips:
description: |-
与此账户关联的所有已知 IP 地址。
未实现(将始终为空数组)。
example: []
items: {}
type: array
x-go-name: IPs
locale:
description: The locale of the account. (ISO 639 Part 1 two-letter language code) 账户的语言偏好。 (ISO 639 Part 1 两字母语言代码)
example: zh
type: string
x-go-name: Locale
role:
$ref: '#/definitions/accountRole'
silenced:
description: 此账户是否被静音/隐藏。
type: boolean
x-go-name: Silenced
suspended:
description: 账户目前是否已被封禁。
type: boolean
x-go-name: Suspended
username:
description: 账户的用户名。
example: dril
type: string
x-go-name: Username
title: AdminAccountInfo
description: AdminAccountInfo 是管理员视图下账户详情的抽象模型。
type: object
x-go-name: AdminAccountInfo
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
adminActionResponse:
description: |-
AdminActionResponse 是服务器对管理员操作的响应的抽象模型。
properties:
action_id:
description: 操作的内部 ID。
example: 01H9QG6TZ9W5P0402VFRVM17TH
type: string
x-go-name: ActionID
type: object
x-go-name: AdminActionResponse
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
adminEmoji:
properties:
category:
description: 于在表情选择器中对自定义表情进行排序。
example: blobcats
type: string
x-go-name: Category
content_type:
description: 该表情的 MIME 内容类型。
example: image/png
type: string
x-go-name: ContentType
disabled:
description: 若此表情已被管理员操作禁用,则为 true。
example: false
type: boolean
x-go-name: Disabled
domain:
description: 该表情的来源实例域名。仅用于外站域名,否则键/值将不会设置。
example: example.org
type: string
x-go-name: Domain
id:
description: 该表情的 ID。
example: 01GEM7SFDZ7GZNRXFVZ3X4E4N1
type: string
x-go-name: ID
shortcode:
description: 自定义表情的名称。
example: blobcat_uwu
type: string
x-go-name: Shortcode
static_url:
description: 一个指向此自定义表情的静态副本的链接。
example: https://example.org/fileserver/emojis/blogcat_uwu.png
type: string
x-go-name: StaticURL
total_file_size:
description: 表情占用的总文件大小(字节),包括静态和动画版本。
example: 69420
format: int64
type: integer
x-go-name: TotalFileSize
updated_at:
description: 该表情的最后更新时间。
example: "2022-10-05T09:21:26.419Z"
type: string
x-go-name: UpdatedAt
uri:
description: 该表情的 ActivityPub URI。
example: https://example.org/emojis/016T5Q3SQKBT337DAKVSKNXXW1
type: string
x-go-name: URI
url:
description: 该自定义表情的 Web URL。
example: https://example.org/fileserver/emojis/blogcat_uwu.gif
type: string
x-go-name: URL
visible_in_picker:
description: 该表情是否在实例的表情选择器中可见。
example: true
type: boolean
x-go-name: VisibleInPicker
title: AdminEmoji
description: AdminEmoji 是管理员视图下自定义表情的抽象模型。
type: object
x-go-name: AdminEmoji
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
adminReport:
properties:
account:
$ref: '#/definitions/adminAccountInfo'
action_taken:
description: 管理员是否已对该举报采取行动。
example: false
type: boolean
x-go-name: ActionTaken
action_taken_at:
description: |-
若已采取行动,在何时采取的行动? (ISO 8601 Datetime)
如果未设置/尚未采取行动,则为null。
example: "2021-07-30T09:20:25+00:00"
type: string
x-go-name: ActionTakenAt
action_taken_by_account:
$ref: '#/definitions/adminAccountInfo'
action_taken_comment:
description: |-
若已采取行动,管理员对采取的行动做了什么评论?
如果未设置/尚未采取行动,则为null。
example: 账户已被封禁。
type: string
x-go-name: ActionTakenComment
assigned_account:
$ref: '#/definitions/adminAccountInfo'
category:
description: 该举报的类别是?
example: spam
type: string
x-go-name: Category
comment:
description: |-
该举报创建时提交的评论。
如果未提交评论,则为空。
example: 此人一直在骚扰我。
type: string
x-go-name: Comment
created_at:
description: 举报创建时间 (ISO 8601 Datetime)。
example: "2021-07-30T09:20:25+00:00"
type: string
x-go-name: CreatedAt
forwarded:
description: 用于指示是否应将举报抄送外站实例的布尔值。
example: true
type: boolean
x-go-name: Forwarded
id:
description: 举报的 ID。
example: 01FBVD42CQ3ZEEVMW180SBX03B
type: string
x-go-name: ID
rules:
description: |-
该举报中提交的违反的规则数组。
如果未提交规则 ID,则为空。
items:
$ref: '#/definitions/instanceRule'
type: array
x-go-name: Rules
statuses:
description: |-
该举报中提交的贴文数组。
如果未提交贴文 ID,则为空。
items:
$ref: '#/definitions/status'
type: array
x-go-name: Statuses
target_account:
$ref: '#/definitions/adminAccountInfo'
updated_at:
description: 针对此举报的最后一次操作的操作时间 (ISO 8601 Datetime)。
example: "2021-07-30T09:20:25+00:00"
type: string
x-go-name: UpdatedAt
title: AdminReport
description: AdminReport 是管理员视图下举报的抽象模型。
type: object
x-go-name: AdminReport
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
application:
properties:
client_id:
description: 应用程序关联的客户端 ID。
type: string
x-go-name: ClientID
client_secret:
description: 应用程序关联的客户端密钥。
type: string
x-go-name: ClientSecret
created_at:
description: 应用程序创建时间。 (ISO 8601 Datetime)
example: "2021-07-30T09:20:25+00:00"
type: string
x-go-name: CreatedAt
id:
description: 应用程序的 ID。
example: 01FBVD42CQ3ZEEVMW180SBX03B
type: string
x-go-name: ID
name:
description: 应用程序的名称。
example: Moshidon
type: string
x-go-name: Name
redirect_uri:
description: 授权后重定向 URI,用于应用程序 (OAuth2)。
example: https://example.org/callback?some=query
type: string
x-go-name: RedirectURI
redirect_uris:
description: 授权后重定向的 URI 列表,用于应用程序 (OAuth2)。
example: '[https://example.org/callback?some=query]'
items:
type: string
type: array
x-go-name: RedirectURIs
scopes:
description: 应用的 OAuth 授权范围。
items:
type: string
type: array
x-go-name: Scopes
vapid_key:
description: 用于推送 API 的密钥。
type: string
x-go-name: VapidKey
website:
description: 与应用程序关联的网站 (url)。
example: https://tusky.app
type: string
x-go-name: Website
title: Application
description: Application 是对 API 应用程序的抽象模型。
type: object
x-go-name: Application
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
attachment:
properties:
blurhash:
description: |-
通过 BlurHash 算法计算的哈希,用于在媒体尚未下载时生成彩色预览缩略图。
参见 https://github.com/woltapp/blurhash
type: string
x-go-name: Blurhash
description:
description: 用于描述媒体附件内容的 Alt 文本。
example: 一只橘猫在阳光下打盹。
type: string
x-go-name: Description
id:
description: 媒体附件的 ID。
example: 01FC31DZT1AYWDZ8XTCRWRBYRK
type: string
x-go-name: ID
meta:
$ref: '#/definitions/mediaMeta'
preview_remote_url:
description: |-
外站服务器上的媒体附件缩略图地址。
仅在非本站实例上定义。
example: https://some-other-server.org/attachments/small/ahhhhh.jpeg
type: string
x-go-name: PreviewRemoteURL
preview_url:
description: 该媒体附件的缩略图地址。
example: https://example.org/fileserver/some_id/attachments/some_id/small/attachment.jpeg
type: string
x-go-name: PreviewURL
remote_url:
description: |-
外站服务器上的媒体附件原图地址。
仅在非本站实例上定义。
example: https://some-other-server.org/attachments/original/ahhhhh.jpeg
type: string
x-go-name: RemoteURL
text_url:
description: |-
该媒体附件的短链接。
对于 GoToSocial,该值与 URL 相同,因为我们不创建较短的 URL。
type: string
x-go-name: TextURL
type:
description: 附件的类型。
example: image
type: string
x-go-name: Type
url:
description: 附件的原图地址。
example: https://example.org/fileserver/some_id/attachments/some_id/original/attachment.jpeg
type: string
x-go-name: URL
title: Attachment
description: Attachment 是媒体附件的抽象模型。
type: object
x-go-name: Attachment
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
card:
properties:
author_name:
description: 原始资源的作者。
example: weewee@buzzfeed.com
type: string
x-go-name: AuthorName
author_url:
description: 指向原始资源作者的链接。
example: https://buzzfeed.com/authors/weewee
type: string
x-go-name: AuthorURL
blurhash:
description: 通过 BlurHash 算法计算的哈希,用于在媒体尚未下载时生成彩色预览缩略图。
type: string
x-go-name: Blurhash
description:
description: 预览的描述。
example: 水是湿的吗?这很不好说。在这篇文章中,我们请教了一位专家...
type: string
x-go-name: Description
embed_url:
description: 用于照片嵌入,而非自定义 HTML。
type: string
x-go-name: EmbedURL
height:
description: 预览的高度,以像素为单位。
format: int64
type: integer
x-go-name: Height
html:
description: 用于生成预览卡片的 HTML。
type: string
x-go-name: HTML
image:
description: 预览缩略图。
example: https://example.org/fileserver/preview/thumb.jpg
type: string
x-go-name: Image
provider_name:
description: 原始资源的提供者。
example: 惊爆新闻
type: string
x-go-name: ProviderName
provider_url:
description: 一个指向原始资源提供者的链接。
example: https://buzzfeed.com
type: string
x-go-name: ProviderURL
title:
description: 链接到的资源的标题。
example: 惊爆新闻:水是湿的吗?
type: string
x-go-name: Title
type:
description: 预览卡片的类型。
example: link
type: string
x-go-name: Type
url:
description: 链接指向的资源的地址。
example: https://buzzfeed.com/some/fuckin/buzzfeed/article
type: string
x-go-name: URL
width:
description: 预览的宽度,单位为像素。
format: int64
type: integer
x-go-name: Width
title: Card
description: Card 表示使用 OpenGraph 标签从 URL 生成的丰富预览卡片。
type: object
x-go-name: Card
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
conversation:
description: |-
Conversation 表示具有“私信”可见性的对话。
properties:
accounts:
description: |-
对话的参与者。
如果这是没有目标账户的对话(即仅自己可见的私信),
则仅包含请求账户本身。否则,将包括对话中的所有其他账户,但不包括请求账户。
items:
$ref: '#/definitions/account'
type: array
x-go-name: Accounts
id:
description: 对话在本地数据库中的 ID。
type: string
x-go-name: ID
last_status:
$ref: '#/definitions/status'
unread:
description: 该对话当前是否被标记为未读?
type: boolean
x-go-name: Unread
type: object
x-go-name: Conversation
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
debugAPUrlResponse:
description: |-
DebugAPUrlResponse 提供对 AP URL 解引用请求的详细调试信息。
properties:
request_headers:
additionalProperties:
items:
type: string
type: array
description: 发送请求时使用的 HTTP 标头。
type: object
x-go-name: RequestHeaders
request_url:
description: 请求的外站 AP URL。
type: string
x-go-name: RequestURL
response_body:
description: |-
外站实例返回的 Body。
将是字符串化的字节;可能是 JSON,可能是错误文本,也可能同时是以上两者!
type: string
x-go-name: ResponseBody
response_code:
description: 外站实例返回的 HTTP 状态码。
format: int64
type: integer
x-go-name: ResponseCode
response_headers:
additionalProperties:
items:
type: string
type: array
description: 外站实例返回的 HTTP 标头。
type: object
x-go-name: ResponseHeaders
type: object
x-go-name: DebugAPUrlResponse
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
defaultPolicies:
properties:
direct:
$ref: '#/definitions/interactionPolicy'
private:
$ref: '#/definitions/interactionPolicy'
public:
$ref: '#/definitions/interactionPolicy'
unlisted:
$ref: '#/definitions/interactionPolicy'
title: 发起请求的账户的新贴文的默认互动规则。
type: object
x-go-name: DefaultPolicies
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
domain:
description: Domain 表示一个外站实例
properties:
comment:
description: |-
如果域名被屏蔽,公开声明的屏蔽原因是什么。
可用于在通过 /api/v1/instance 执行序列化/反序列化时替代 `public_comment`。
example: 这个实例有股味
type: string
x-go-name: Comment
domain:
description: 实例的主机名。
example: example.org
type: string
x-go-name: Domain
public_comment:
description: |-
如果实例被屏蔽,公开的屏蔽原因是什么。
可用于在 **不** 通过 /api/v1/instance 执行序列化/反序列化时替代 `comment`。
example: 它们被骚扰账号攻陷了。
type: string
x-go-name: PublicComment
silenced_at:
description: 实例被静音/隐藏的时间。对于开放实例,此键将不会存在。
example: "2021-07-30T09:20:25+00:00"
type: string
x-go-name: SilencedAt
suspended_at:
description: 实例被屏蔽的时间。对于开放实例,此键将不会存在。
example: "2021-07-30T09:20:25+00:00"
type: string
x-go-name: SuspendedAt
type: object
x-go-name: Domain
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
domainPermission:
properties:
comment:
description: |-
如果域名被屏蔽,公开声明的屏蔽原因是什么。
可用于在通过 /api/v1/instance 执行序列化/反序列化时替代 `public_comment`。
example: 它们闻起来很糟糕
type: string
x-go-name: Comment
created_at:
description: 此权限条目创建的时间 (ISO 8601 Datetime)。
example: "2021-07-30T09:20:25+00:00"
type: string
x-go-name: CreatedAt
created_by:
description: 创建此实例权限条目的账户的 ID。
example: 01FBW2758ZB6PBR200YPDDJK4C
type: string
x-go-name: CreatedBy
domain:
description: 此实例的主机名。
example: example.org
type: string
x-go-name: Domain
id:
description: 此实例权限条目的 ID。
example: 01FBW21XJA09XYX51KV5JVBW0F
readOnly: true
type: string
x-go-name: ID
obfuscate:
description: 是否在公开此实例权限条目时对域名进行模糊处理。
example: false
type: boolean
x-go-name: Obfuscate
private_comment:
description: 对此权限条目的私密评论,仅对本站管理员可见。
example: 它们管理员都是啥b啊
type: string
x-go-name: PrivateComment
public_comment:
description: |-
若实例被屏蔽,公开的屏蔽原因是什么。
可用于在 **不** 通过 /api/v1/instance 执行序列化/反序列化时替代 `comment`。
example: 它们被骚扰账号攻陷了。
type: string
x-go-name: PublicComment
silenced_at:
description: 该实例被静音/隐藏的时间。对于开放实例,此键将不会存在。
example: "2021-07-30T09:20:25+00:00"
type: string
x-go-name: SilencedAt
subscription_id:
description: 如果可用,导致此实例权限条目被创建的订阅的 ID。
example: 01FBW25TF5J67JW3HFHZCSD23K
type: string
x-go-name: SubscriptionID
suspended_at:
description: 此实例被屏蔽的时间。对于开放实例,此键将不会存在。
example: "2021-07-30T09:20:25+00:00"
type: string
x-go-name: SuspendedAt
title: DomainPermission
description: DomainPermission 表示应用于某个实例的权限(显式阻止/允许)。
type: object
x-go-name: DomainPermission
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
domainPermissionSubscription:
properties:
adopt_orphans:
description: '若为 true,则此域名权限订阅将“接管”实例上已存在的、符合以下条件的域名权限: 1)它们没有关联的订阅 ID(即,它们是“孤立”的), 2)它们存在于订阅列表中。这些孤立的域名权限条目将被关联到此订阅的订阅 ID,并由此订阅管理。'
example: false
type: boolean
x-go-name: AdoptOrphans
as_draft:
description: 若为 true,则此域名权限订阅将创建为草稿,须由管理员批准后才能生效。若为 false,此域名权限订阅将立即生效。
example: true
type: boolean
x-go-name: AsDraft
content_type:
description: 解析权限列表时采用的 MIME 内容类型。
example: text/csv
type: string
x-go-name: ContentType
count:
description: 上次(成功)获取时在订阅地址上发现的域名权限条目数量。
example: 53
format: uint64
readOnly: true
type: integer
x-go-name: Count
created_at:
description: 订阅创建的时间(ISO 8601 Datetime)。
example: "2021-07-30T09:20:25+00:00"
type: string
x-go-name: CreatedAt
created_by:
description: 创建此订阅的帐户的 ID。
example: 01FBW21XJA09XYX51KV5JVBW0F
readOnly: true
type: string
x-go-name: CreatedBy
error:
description: 如果最近的获取尝试失败,此字段将包含与获取尝试相关的错误消息。
example: Oopsie doopsie, we made a fucky wucky.
readOnly: true
type: string
x-go-name: Error
fetch_password:
description: (可选)更新订阅时进行基本身份验证(Basic Auth)的密码。
example: admin123
type: string
x-go-name: FetchPassword
fetch_username:
description: (可选)更新订阅时进行基本身份验证(Basic Auth)的用户名。
example: admin123
type: string
x-go-name: FetchUsername
fetched_at:
description: 上次更新订阅(不论是否成功)的时间(ISO 8601 Datetime)。
example: "2021-07-30T09:20:25+00:00"
readOnly: true
type: string
x-go-name: FetchedAt
id:
description: 域名权限订阅的 ID。
example: 01FBW21XJA09XYX51KV5JVBW0F
readOnly: true
type: string
x-go-name: ID
permission_type:
description: 域名权限订阅的类型(允许, 阻止)。
example: block
type: string
x-go-name: PermissionType
priority:
description: 域名权限订阅的优先级(0-255, 数字越大, 优先级越高)。
example: 100
format: uint8
type: integer
x-go-name: Priority
successfully_fetched_at:
description: 上次成功更新订阅的时间(ISO 8601 Datetime)。
example: "2021-07-30T09:20:25+00:00"
readOnly: true
type: string
x-go-name: SuccessfullyFetchedAt
title:
description: 域名权限订阅的标题。由管理员在创建或更新时设置。
example: really cool list of neato pals
type: string
x-go-name: Title
uri:
description: 域名权限订阅的 URI, 用于从中获取域名权限条目列表。
example: https://www.example.org/blocklists/list1.csv
type: string
x-go-name: URI
title: DomainPermissionSubscription
description: DomainPermissionSubscription (域名权限订阅)表示一个可以自动更新的域名权限列表订阅(类型可以为允许或阻止)
type: object
x-go-name: DomainPermissionSubscription
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
emoji:
properties:
category:
description: 用于在表情选择器中对自定义表情进行排序。
example: blobcats
type: string
x-go-name: Category
shortcode:
description: 自定义表情的名称。
example: blobcat_uwu
type: string
x-go-name: Shortcode
static_url:
description: 该自定义表情的静态副本链接。
example: https://example.org/fileserver/emojis/blogcat_uwu.png
type: string
x-go-name: StaticURL
url:
description: 该自定义表情的 Web URL。
example: https://example.org/fileserver/emojis/blogcat_uwu.gif
type: string
x-go-name: URL
visible_in_picker:
description: 该表情是否在实例的表情选择器中可见。
example: true
type: boolean
x-go-name: VisibleInPicker
title: Emoji
description: Emoji 表示一个自定义表情。
type: object
x-go-name: Emoji
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
emojiCategory:
properties:
id:
description: 自定义表情类别的 ID。
type: string
x-go-name: ID
name:
description: 自定义表情类别的名称。
type: string
x-go-name: Name
title: EmojiCategory
description: EmojiCategory 表示自定义表情的类别。
type: object
x-go-name: EmojiCategory
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
field:
properties:
name:
description: 该附加字段的键/名称。
example: 人称代词
type: string
x-go-name: Name
value:
description: 该附加字段的值。
example: they/them
type: string
x-go-name: Value
verified_at:
description: 如果此字段已被验证,是何时验证的? (ISO 8601 Datetime)
example: "2021-07-30T09:20:25+00:00"
type: string
x-go-name: VerifiedAt
title: Field
description: Field 表示要在账户资料上显示的名称/值对。
type: object
x-go-name: Field
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
filterContext:
description: FilterContext 表示过滤规则要应用到的上下文。Filter API 的 v1 和 v2 使用相同的上下文集合。
title: FilterContext
type: string
x-go-name: FilterContext
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
filterKeyword:
properties:
id:
description: 数据库中过滤关键词条目的 ID。
type: string
x-go-name: ID
keyword:
description: 被过滤的文本。
example: 挂人
type: string
x-go-name: Keyword
whole_word:
description: 该过滤关键词是否应考虑单词边界?(整词匹配)
example: true
type: boolean
x-go-name: WholeWord
title: FilterKeyword
description: FilterKeyword 表示 v2 过滤规则中要过滤的关键词文本。
type: object
x-go-name: FilterKeyword
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
filterResult:
properties:
filter:
$ref: '#/definitions/filterV2'
keyword_matches:
description: 该过滤规则中被匹配到的关键词。
items:
type: string
type: array
x-go-name: KeywordMatches
status_matches:
description: 命中该过滤规则的贴文 ID。
items:
type: string
type: array
x-go-name: StatusMatches
title: FilterResult
description: FilterResult 与被过滤的贴文一起返回,以解释为什么被过滤。
type: object
x-go-name: FilterResult
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
filterStatus:
properties:
id:
description: 数据库中过滤贴文条目的 ID。
type: string
x-go-name: ID
phrase:
description: 被过滤的贴文 ID。
type: string
x-go-name: StatusID
title: FilterStatus
description: FilterStatus 表示 v2 过滤规则中被过滤的贴文 ID。
type: object
x-go-name: FilterStatus
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
filterV1:
description: |-
FilterV1 表示用户定义的过滤规则,用于确定哪些贴文不应显示给用户。
注意,v1 过滤规则在内部处理时会映射到 v2 过滤规则和 v2 过滤关键词。
若 whole_word 为 true,则客户端应执行:
为您的应用程序定义“单词组成字符 (word constituent character)”。在官方实现中,它是 [A-Za-z0-9_] (JavaScript) 和 [[:word:]] (Ruby)。
Ruby 使用 POSIX 字符类 (Letter | Mark | Decimal_Number | Connector_Punctuation)。
如果短语以单词字符开头,并且匹配范围之前的前一个字符是单词字符,则应将其匹配范围视为不匹配。
如果短语以单词字符结尾,并且匹配范围之后的下一个字符是单词字符,则应将其匹配范围视为不匹配。
请查看 Mastodon 源代码中的 app/javascript/mastodon/selectors/index.js 和 app/lib/feed_manager.rb 以获取更多详细信息。
properties:
context:
description: 该过滤规则被应用到的上下文。
example:
- home
- public
items:
$ref: '#/definitions/filterContext'
minItems: 1
type: array
uniqueItems: true
x-go-name: Context
expires_at:
description: 过滤规则不再生效的时间。如果过滤规则不会过期,则为 null。
example: "2024-02-01T02:57:49Z"
type: string
x-go-name: ExpiresAt
id:
description: 数据库中过滤规则条目的 ID。
type: string
x-go-name: ID
irreversible:
description: 命中的条目是否应从用户的时间线/视图中移除,而不是隐藏?
example: false
type: boolean
x-go-name: Irreversible
phrase:
description: 被过滤的文本。
example: 挂人
type: string
x-go-name: Phrase
whole_word:
description: 过滤规则是否应考虑单词边界?
example: true
type: boolean
x-go-name: WholeWord
title: FilterV1
type: object
x-go-name: FilterV1
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
filterV2:
description: FilterV2 表示用户定义的过滤规则,用于确定哪些贴文不应显示给用户。v2 过滤规则具有名称,并且可以包含多个短语和贴文 ID 以进行过滤。
properties:
context:
description: 过滤规则应用的上下文。
example:
- home
- public
items:
$ref: '#/definitions/filterContext'
minItems: 1
type: array
uniqueItems: true
x-go-name: Context
expires_at:
description: 过滤规则不再生效的时间。如果过滤规则不会过期,则为 null。
example: "2024-02-01T02:57:49Z"
type: string
x-go-name: ExpiresAt
filter_action:
$ref: '#/definitions/FilterAction'
id:
description: 数据库中过滤规则条目的 ID。
type: string
x-go-name: ID
keywords:
description: 此过滤规则下的关键词。
items:
$ref: '#/definitions/filterKeyword'
type: array
x-go-name: Keywords
statuses:
description: 此过滤规则下的贴文。
items:
$ref: '#/definitions/filterStatus'
type: array
x-go-name: Statuses
title:
description: 此过滤规则的名称。
example: Linux 相关
type: string
x-go-name: Title
title: FilterV2
type: object
x-go-name: FilterV2
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
headerFilter:
properties:
created_at:
description: 标头过滤规则创建时间 (ISO 8601 Datetime)。
example: "2021-07-30T09:20:25+00:00"
readOnly: true
type: string
x-go-name: CreatedAt
created_by:
description: 创建此标头过滤规则的管理员账户的 ID。
example: 01FBW2758ZB6PBR200YPDDJK4C
readOnly: true
type: string
x-go-name: CreatedBy
header:
description: 此标头过滤规则匹配的 HTTP 标头。
example: User-Agent
type: string
x-go-name: Header
id:
description: 此标头过滤规则的 ID。
example: 01FBW21XJA09XYX51KV5JVBW0F
readOnly: true
type: string
x-go-name: ID
regex:
description: 此标头过滤规则的正则表达式。
example: .*Firefox.*
type: string
x-go-name: Regex
title: HeaderFilter
description: HeaderFilter 表示应用于特定 HTTP 标头的正则过滤规则(允许/阻止)。
type: object
x-go-name: HeaderFilter
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
hostmeta:
description: 'HostMeta 表示一份 hostmeta 文档。参见: https://www.rfc-editor.org/rfc/rfc6415.html#section-3'
properties:
Link:
items:
$ref: '#/definitions/Link'
type: array
XMLNS:
type: string
XMLName: {}
title: HostMeta
type: object
x-go-name: HostMeta
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
instanceConfigurationAccounts:
properties:
allow_custom_css:
description: 此实例是否允许账户上传用于资料页和贴文页的自定义 CSS。
example: false
type: boolean
x-go-name: AllowCustomCSS
max_featured_tags:
description: |-
此实例允许每个账户设置的最大特色标签数。
format: int64
type: integer
x-go-name: MaxFeaturedTags
max_profile_fields:
description: |-
此实例允许每个账户设置的最大附加字段数。
目前不可配置,硬编码为 6。详见 (https://codeberg.org/superseriousbusiness/gotosocial/issues/1876)
format: int64
type: integer
x-go-name: MaxProfileFields
title: InstanceConfigurationAccounts
description: InstanceConfigurationAccounts 是实例账户配置参数的抽象模型。
type: object
x-go-name: InstanceConfigurationAccounts
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
instanceConfigurationMediaAttachments:
properties:
image_matrix_limit:
description: |-
图像的最大尺寸,以像素为单位,高度*宽度。
GtS 不对此设置限制,但为了保持兼容性,我们在这里给出 Mastodon 的 4096x4096px 值。
example: 16777216
format: int64
type: integer
x-go-name: ImageMatrixLimit
image_size_limit:
description: 图像的最大大小,以字节为单位。
example: 2097152
format: int64
type: integer
x-go-name: ImageSizeLimit
supported_mime_types:
description: 此实例支持上传的 MIME 类型列表。
example:
- image/jpeg
- image/gif
items:
type: string
type: array
x-go-name: SupportedMimeTypes
video_frame_rate_limit:
description: 此实例支持的最大视频帧率。
example: 60
format: int64
type: integer
x-go-name: VideoFrameRateLimit
video_matrix_limit:
description: |-
此实例支持的最大视频尺寸,以像素为单位,高度*宽度。
GtS 不对此设置限制,但为了保持兼容性,我们在这里给出 Mastodon 的 4096x4096px 值。
example: 16777216
format: int64
type: integer
x-go-name: VideoMatrixLimit
video_size_limit:
description: 视频的最大大小,以字节为单位。
example: 10485760
format: int64
type: integer
x-go-name: VideoSizeLimit
title: InstanceConfigurationMediaAttachments
description: InstanceConfigurationMediaAttachments 是实例媒体附件配置参数的抽象模型。
type: object
x-go-name: InstanceConfigurationMediaAttachments
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
instanceConfigurationPolls:
properties:
max_characters_per_option:
description: 投票选项中允许的最大字符数。
example: 50
format: int64
type: integer
x-go-name: MaxCharactersPerOption
max_expiration:
description: 投票的最大时长,以秒为单位。
example: 2629746
format: int64
type: integer
x-go-name: MaxExpiration
max_options:
description: 此实例允许的最大投票选项数。
example: 4
format: int64
type: integer
x-go-name: MaxOptions
min_expiration:
description: 投票的最小时长,以秒为单位。
example: 300
format: int64
type: integer
x-go-name: MinExpiration
title: InstanceConfigurationPolls
description: InstanceConfigurationPolls 是实例投票配置参数的抽象模型。
type: object
x-go-name: InstanceConfigurationPolls
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
instanceConfigurationStatuses:
properties:
characters_reserved_per_url:
description: 客户端应假设 URL 占用的字符数。
example: 25
format: int64
type: integer
x-go-name: CharactersReservedPerURL
max_characters:
description: 此实例允许的最大贴文长度,以字符为单位。
example: 5000
format: int64
type: integer
x-go-name: MaxCharacters
max_media_attachments:
description: 此实例允许的最大媒体附件数。
example: 4
format: int64
type: integer
x-go-name: MaxMediaAttachments
supported_mime_types:
description: 此实例的贴文可用的 MIME 类型列表。
example:
- text/plain
- text/markdown
items:
type: string
type: array
x-go-name: SupportedMimeTypes
title: InstanceConfigurationStatuses
description: InstanceConfigurationStatuses 是实例贴文配置参数的抽象模型。
type: object
x-go-name: InstanceConfigurationStatuses
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
instanceRule:
properties:
id:
type: string
x-go-name: ID
text:
type: string
x-go-name: Text
title: InstanceRule
description: InstanceRule 表示一条实例规则。
type: object
x-go-name: InstanceRule
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
instanceV1:
properties:
account_domain:
description: |-
此实例上的账户的域名。
这不一定与 URI 的 Host 部分相同。
example: example.org
type: string
x-go-name: AccountDomain
approval_required:
description: 新账户注册需要管理员批准。
type: boolean
x-go-name: ApprovalRequired
configuration:
$ref: '#/definitions/instanceV1Configuration'
contact_account:
$ref: '#/definitions/account'
custom_css:
description: 此实例的自定义 CSS。
type: string
x-go-name: CustomCSS
debug:
description: 此实例是否在 DEBUG 模式下运行。如果为 false,则省略。
type: boolean
x-go-name: Debug
description:
description: |-
此实例的描述。
应为 HTML 格式,但可能是纯文本。
这应该显示在实例的“关于”页面上。
type: string
x-go-name: Description
description_text:
description: 描述的原始(未解析)版本。
type: string
x-go-name: DescriptionText
email:
description: 用于咨询的电子邮件地址。
example: social@example.org
type: string
x-go-name: Email
invites_enabled:
description: 此实例是否允许邀请注册。
type: boolean
x-go-name: InvitesEnabled
languages:
description: 此实例的主要语言。
example:
- zh
items:
type: string
type: array
x-go-name: Languages
max_toot_chars:
description: |-
此实例允许的最大贴文长度,以字符为单位。
这是为了与 Tusky 和其他应用程序兼容而提供的。
example: 5000
format: uint64
type: integer
x-go-name: MaxTootChars
registrations:
description: 此实例上启用了新账户注册。
type: boolean
x-go-name: Registrations
rules:
description: 此实例的规则的条目化列表。
items:
$ref: '#/definitions/instanceRule'
type: array
x-go-name: Rules
short_description:
description: |-
此实例的简要描述。
应为 HTML 格式,但可能是纯文本。
这应该显示在实例的首页上。
type: string
x-go-name: ShortDescription
short_description_text:
description: 短描述的原始(未解析)版本。
type: string
x-go-name: ShortDescriptionText
stats:
additionalProperties:
format: int64
type: integer
description: |-
此实例的统计信息:贴文数、账户数等。
值为指针,因为我们不希望在通过 Web 模板渲染统计信息时跳过 0 值。
type: object
x-go-name: Stats
terms:
description: 此实例的条款与条件。
type: string
x-go-name: Terms
terms_text:
description: 条款与条件的原始(未解析)版本。
type: string
x-go-name: TermsRaw
thumbnail:
description: 此实例的头像/横幅图像的 URL。
example: https://example.org/files/instance/thumbnail.jpeg
type: string
x-go-name: Thumbnail
thumbnail_description:
description: 此实例的头像描述。
example: 一张可爱的卡通小懒
type: string
x-go-name: ThumbnailDescription
thumbnail_static:
description: 此实例头像/横幅图的静态版本的 URL。
example: https://example.org/files/instance/static/thumbnail.webp
type: string
x-go-name: ThumbnailStatic
thumbnail_static_type:
description: 此实例的头像/横幅图的静态版本的 MIME 类型。
example: image/webp
type: string
x-go-name: ThumbnailStaticType
thumbnail_type:
description: 此实例头像的 MIME 类型。
example: image/png
type: string
x-go-name: ThumbnailType
title:
description: 实例的标题。
example: GoToSocial 演示实例
type: string
x-go-name: Title
uri:
description: 实例的 URI。
example: https://gts.example.org
type: string
x-go-name: URI
urls:
$ref: '#/definitions/instanceV1URLs'
version:
description: |-
此实例部署的 GoToSocial 版本。
至少包含一个语义版本号。
它还可能包含当前软件的 git 提交短 ID。
example: 0.1.1 cb85f65
type: string
x-go-name: Version
title: InstanceV1
description: InstanceV1 是关于此实例的信息的抽象模型。
type: object
x-go-name: InstanceV1
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
instanceV1Configuration:
properties:
accounts:
$ref: '#/definitions/instanceConfigurationAccounts'
emojis:
$ref: '#/definitions/InstanceConfigurationEmojis'
media_attachments:
$ref: '#/definitions/instanceConfigurationMediaAttachments'
oidc_enabled:
description: 若实例使用 OIDC 作为身份验证/身份后端,则为 true,否则省略。
type: boolean
x-go-name: OIDCEnabled
polls:
$ref: '#/definitions/instanceConfigurationPolls'
statuses:
$ref: '#/definitions/instanceConfigurationStatuses'
title: InstanceV1Configuration
description: InstanceV1Configuration 是实例配置参数的抽象模型。
type: object
x-go-name: InstanceV1Configuration
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
instanceV1URLs:
properties:
streaming_api:
description: 用于贴文和通知的流式传输的 Websockets 地址。
example: wss://example.org
type: string
x-go-name: StreamingAPI
title: InstanceV1URLs
description: InstanceV1URLs 是客户端应用程序使用的与实例相关的 URL 的抽象模型。
type: object
x-go-name: InstanceV1URLs
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
instanceV2:
properties:
account_domain:
description: |-
此实例上的账户的域名。
这不一定与 URI 的 Host 部分相同。
example: example.org
type: string
x-go-name: AccountDomain
configuration:
$ref: '#/definitions/instanceV2Configuration'
contact:
$ref: '#/definitions/instanceV2Contact'
custom_css:
description: 此实例的自定义 CSS。
type: string
x-go-name: CustomCSS
debug:
description: 此实例是否在 DEBUG 模式下运行。如果为 false,则省略。
type: boolean
x-go-name: Debug
description:
description: |-
此实例的描述。
应为 HTML 格式,但可能是纯文本。
这应该显示在实例的“关于”页面上。
type: string
x-go-name: Description
description_text:
description: 描述的原始(未解析)版本。
type: string
x-go-name: DescriptionText
domain:
description: 实例的域名。
example: gts.example.org
type: string
x-go-name: Domain
languages:
description: 实例和实例站务/管理员的主要语言。
example:
- zh
items:
type: string
type: array
x-go-name: Languages
registrations:
$ref: '#/definitions/instanceV2Registrations'
rules:
description: 该实例的规则的条目化列表。
items:
$ref: '#/definitions/instanceRule'
type: array
x-go-name: Rules
source_url:
description: 本实例部署的软件的源代码 URL,应 AGPL 许可要求提供。
example: https://codeberg.org/superseriousbusiness/gotosocial
type: string
x-go-name: SourceURL
terms:
description: 本实例的账户条款与条件。
type: string
x-go-name: Terms
terms_text:
description: 条款与条件的原始(未解析)版本。
type: string
x-go-name: TermsText
thumbnail:
$ref: '#/definitions/instanceV2Thumbnail'
title:
description: 实例的标题。
example: GoToSocial 演示实例
type: string
x-go-name: Title
usage:
$ref: '#/definitions/instanceV2Usage'
version:
description: |-
此实例部署的 GoToSocial 版本。
至少包含一个语义版本号。
它还可能包含当前软件的 git 提交短 ID。
example: 0.1.1 cb85f65
type: string
x-go-name: Version
title: InstanceV2
description: InstanceV2 是关于此实例的信息的抽象模型。
type: object
x-go-name: InstanceV2
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
instanceV2Configuration:
properties:
accounts:
$ref: '#/definitions/instanceConfigurationAccounts'
emojis:
$ref: '#/definitions/InstanceConfigurationEmojis'
media_attachments:
$ref: '#/definitions/instanceConfigurationMediaAttachments'
oidc_enabled:
description: 若实例使用 OIDC 作为身份验证/身份后端,则为 true,否则省略。
type: boolean
x-go-name: OIDCEnabled
polls:
$ref: '#/definitions/instanceConfigurationPolls'
statuses:
$ref: '#/definitions/instanceConfigurationStatuses'
translation:
$ref: '#/definitions/instanceV2ConfigurationTranslation'
urls:
$ref: '#/definitions/instanceV2URLs'
vapid:
$ref: '#/definitions/instanceV2ConfigurationVAPID'
title: InstanceV2Configuration
description: 此实例的配置值和限制。
type: object
x-go-name: InstanceV2Configuration
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
instanceV2ConfigurationTranslation:
properties:
enabled:
description: |-
此实例是否支持翻译 API。
由于尚未实现,因此此值始终为 false。
type: boolean
x-go-name: Enabled
title: InstanceV2ConfigurationTranslation
description: 关于翻译功能的提示。
type: object
x-go-name: InstanceV2ConfigurationTranslation
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
instanceV2ConfigurationVAPID:
properties:
public_key:
description: The instance's VAPID public key, Base64-encoded.
type: string
x-go-name: PublicKey
title: InstanceV2ConfigurationVAPID 存储实例的 VAPID 配置信息。
type: object
x-go-name: InstanceV2ConfigurationVAPID
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
instanceV2Contact:
properties:
account:
$ref: '#/definitions/account'
email:
description: |-
可用于咨询和问题反馈的电子邮件地址。
如果未设置电子邮件地址,则为空字符串。
example: someone@example.org
type: string
x-go-name: Email
title: InstanceV2Contact
description: 此实例的联系信息。
type: object
x-go-name: InstanceV2Contact
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
instanceV2Registrations:
properties:
approval_required:
description: 此实例是否需要管理员批准新账户注册。
example: true
type: boolean
x-go-name: ApprovalRequired
enabled:
description: 是否开放注册。
example: false
type: boolean
x-go-name: Enabled
message:
description: |-
一条自定义消息(HTML 字符串),用于在关闭注册时显示。
example: <p>由于骚扰猖獗,example.org 目前关闭了注册,请联系管理员以获取帮助。</p>
type: string
x-go-name: Message
title: InstanceV2Registrations
description: 此实例有关注册的信息。
type: object
x-go-name: InstanceV2Registrations
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
instanceV2Thumbnail:
properties:
blurhash:
description: |-
通过 BlurHash 算法计算的哈希,用于在媒体尚未下载时生成彩色预览缩略图。
example: UeKUpFxuo~R%0nW;WCnhF6RjaJt757oJodS$
type: string
x-go-name: Blurhash
static_url:
description: 缩略图图像的静态版本的 URL。
example: https://example.org/fileserver/01BPSX2MKCRVMD4YN4D71G9CP5/attachment/static/01H88X0KQ2DFYYDSWYP93VDJZA.webp
type: string
x-go-name: StaticURL
thumbnail_description:
description: |-
实例缩略图的描述。
如果没有描述可用,则不设置键/值。
example: 一只可爱的小懒
type: string
x-go-name: Description
thumbnail_static_type:
description: |-
实例缩略图的静态版本的 MIME 类型。
如果类型未知,则不设置键/值。
example: image/png
type: string
x-go-name: StaticType
thumbnail_type:
description: |-
实例缩略图的 MIME 类型。
如果类型未知,则不设置键/值。
example: image/png
type: string
x-go-name: Type
url:
description: 缩略图的 URL。
example: https://example.org/fileserver/01BPSX2MKCRVMD4YN4D71G9CP5/attachment/original/01H88X0KQ2DFYYDSWYP93VDJZA.png
type: string
x-go-name: URL
versions:
$ref: '#/definitions/instanceV2ThumbnailVersions'
title: InstanceV2Thumbnail
description: 代表此实例的图像。
type: object
x-go-name: InstanceV2Thumbnail
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
instanceV2ThumbnailVersions:
properties:
'@1x':
description: |-
此缩略图的 1 倍分辨率缩放版本的 URL。
如果未提供此缩放版本,则不设置键/值。
type: string
x-go-name: Size1URL
'@2x':
description: |-
此缩略图的 2 倍分辨率缩放版本的 URL。
如果未提供此缩放版本,则不设置键/值。
type: string
x-go-name: Size2URL
title: InstanceV2ThumbnailVersions
description: 缩略图的高分辨率版本,用于高 DPI 屏幕。
type: object
x-go-name: InstanceV2ThumbnailVersions
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
instanceV2URLs:
properties:
streaming:
description: 用于流式传输贴文和通知的 Websockets 地址。
example: wss://example.org
type: string
x-go-name: Streaming
title: InstanceV2URLs
description: InstanceV2URLs 是客户端应用程序使用的与实例相关的 URL 的抽象模型。
type: object
x-go-name: InstanceV2URLs
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
instanceV2Usage:
properties:
users:
$ref: '#/definitions/instanceV2Users'
title: InstanceV2Usage
description: InstanceV2Usage 是关于此实例的使用数据的抽象模型。
type: object
x-go-name: InstanceV2Usage
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
instanceV2Users:
properties:
active_month:
description: |-
此实例过去 4 周内的活跃用户数。
目前未实现:将始终为 0。
example: 0
format: int64
type: integer
x-go-name: ActiveMonth
title: InstanceV2Users
description: 此实例的用户使用数据。
type: object
x-go-name: InstanceV2Users
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
interactionPolicy:
properties:
can_favourite:
$ref: '#/definitions/interactionPolicyRules'
can_reblog:
$ref: '#/definitions/interactionPolicyRules'
can_reply:
$ref: '#/definitions/interactionPolicyRules'
title: InteractionPolicy
description: 某条贴文的互动规则。
type: object
x-go-name: InteractionPolicy
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
interactionPolicyRules:
properties:
always:
description: 始终可以执行此类互动的账户的规则条目。
items:
$ref: '#/definitions/interactionPolicyValue'
type: array
x-go-name: Always
with_approval:
description: 执行此类互动需要批准的账户的规则条目。
items:
$ref: '#/definitions/interactionPolicyValue'
type: array
x-go-name: WithApproval
title: InteractionPolicyRules
description: 某类互动的规则。
type: object
x-go-name: PolicyRules
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
interactionPolicyValue:
description: |-
一条贴文的互动规则条目。
可以是以下内部关键字之一,也可以是一个完整的 ActivityPub Actor URI,如 "https://example.org/users/some_user"。
内部关键字:
public - 公开,即任何可以根据其可见性级别看到此贴文的人。
followers - 贴文作者的粉丝。
following - 贴文作者关注的人。
mutuals - 贴文作者的互相关注(保留,未使用)。
mentioned - 在贴文中提到的账户,或者在贴文中回复的账户。
author - 贴文作者本人。
me - 如果请求是由授权用户发出的,则 "me" 代表发出请求的、现在正在查询此互动策略的用户。
title: InteractionPolicyValue
type: string
x-go-name: PolicyValue
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
interactionRequest:
properties:
accepted_at:
description: The timestamp that the interaction request was accepted (ISO 8601 Datetime). Field omitted if request not accepted (yet). 互动请求被接受的时间戳 (ISO 8601 Datetime)。如果请求尚未被接受,则省略此字段。
type: string
x-go-name: AcceptedAt
account:
$ref: '#/definitions/account'
created_at:
description: 互动请求的时间戳 (ISO 8601 Datetime)
type: string
x-go-name: CreatedAt
id:
description: 互动请求在数据库中的 ID。
type: string
x-go-name: ID
rejected_at:
description: 互动请求被拒绝的时间戳 (ISO 8601 Datetime)。如果请求尚未被拒绝,则省略此字段。
type: string
x-go-name: RejectedAt
reply:
$ref: '#/definitions/status'
status:
$ref: '#/definitions/status'
type:
description: |-
该互动请求所涉及的互动类型。
`favourite` - 有人点赞了一条贴文。
`reply` - 有人回复了一条贴文。
`reblog` - 有人转发了一条贴文。
type: string
x-go-name: Type
uri:
description: 接受或拒绝的 URI。仅在设置了 accepted_at 或 rejected_at 时设置,否则省略。
type: string
x-go-name: URI
title: InteractionRequest
description: InteractionRequest 表示待处理、已批准或已拒绝的点赞、回复或转发互动。
type: object
x-go-name: InteractionRequest
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
list:
properties:
exclusive:
description: |-
此列表是否为单独列表。
如果为 true,则在主页时间线中隐藏此列表的成员的贴文。
type: boolean
x-go-name: Exclusive
id:
description: 列表的 ID。
type: string
x-go-name: ID
replies_policy:
description: |-
此列表的回复显示规则。
followed = 显示任何对已关注用户的回复
list = 显示对列表成员的回复
none = 不显示任何回复
type: string
x-go-name: RepliesPolicy
title:
description: 用户设定的列表名称。
type: string
x-go-name: Title
title: List
description: List 表示用户为关注的账户创建的列表。
type: object
x-go-name: List
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
markers:
properties:
home:
$ref: '#/definitions/TimelineMarker'
notifications:
$ref: '#/definitions/TimelineMarker'
title: Marker
description: Marker 表示用户时间线中的上次阅读位置。
type: object
x-go-name: Marker
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
mediaDimensions:
properties:
aspect:
description: |-
媒体附件的宽高比。
等于宽度 / 高度。
example: 1.777777778
format: float
type: number
x-go-name: Aspect
bitrate:
description: 媒体附件的比特率,以每秒位数为单位。
example: 1000000
format: uint64
type: integer
x-go-name: Bitrate
duration:
description: |-
媒体的时长(秒)。
仅对视频和音频设置。
example: 5.43
format: float
type: number
x-go-name: Duration
frame_rate:
description: |-
媒体的帧率。
仅对视频和 GIF 设置。
example: "30"
type: string
x-go-name: FrameRate
height:
description: |-
媒体的高度(像素)。
对于音频不设置。
example: 1080
format: int64
type: integer
x-go-name: Height
size:
description: |-
媒体的尺寸,格式为 `[width]x[height]`。
对于音频不设置。
example: 1920x1080
type: string
x-go-name: Size
width:
description: |-
媒体的宽度(像素)。
对于音频不设置。
example: 1920
format: int64
type: integer
x-go-name: Width
title: MediaDimensions
description: MediaDimensions 是一份媒体附件的详细属性的抽象模型。
type: object
x-go-name: MediaDimensions
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
mediaFocus:
properties:
x:
description: |-
焦点的 x 轴位置,应在 -1 和 1 之间
format: float
type: number
x-go-name: X
"y":
description: |-
焦点的 y 轴位置,应在 -1 和 1 之间
format: float
type: number
x-go-name: "Y"
title: MediaFocus
description: MediaFocus 是媒体附件的焦点的抽象模型。
type: object
x-go-name: MediaFocus
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
mediaMeta:
description: MediaMeta 是媒体附件的元数据的抽象模型。这可以是有关图像、音频文件、视频等的元数据。
properties:
focus:
$ref: '#/definitions/mediaFocus'
original:
$ref: '#/definitions/mediaDimensions'
small:
$ref: '#/definitions/mediaDimensions'
title: MediaMeta
type: object
x-go-name: MediaMeta
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
mutedAccount:
properties:
acct:
description: |-
通过 webfinger 发现的账户 URI。
对于本地用户,等于用户名;对于远程用户,等于用户名@域名。
example: some_user@example.org
type: string
x-go-name: Acct
avatar:
description: 该账户的头像的 Web 地址。
example: https://example.org/media/some_user/avatar/original/avatar.jpeg
type: string
x-go-name: Avatar
avatar_description:
description: 该账户的头像描述,用于 alt 文本。
example: 一张微笑的树懒的可爱图画。
type: string
x-go-name: AvatarDescription
avatar_media_id:
description: |-
此账户的头像对应的媒体附件的数据库 ID。
如果此账户没有上传头像(即默认头像),则省略。
example: 01JAJ3XCD66K3T99JZESCR137W
type: string
x-go-name: AvatarMediaID
avatar_static:
description: |-
账户头像的静态版本的 Web 地址。
仅在账户的主头像是视频或 gif 时才有用。
example: https://example.org/media/some_user/avatar/static/avatar.png
type: string
x-go-name: AvatarStatic
bot:
description: 账户被标记为机器人。
type: boolean
x-go-name: Bot
created_at:
description: 该账户创建的时间 (ISO 8601 Datetime)。
example: "2021-07-30T09:20:25+00:00"
type: string
x-go-name: CreatedAt
custom_css:
description: 渲染此账户的资料页或贴文页时包含的自定义 CSS。
type: string
x-go-name: CustomCSS
discoverable:
description: 账户选择加入发现功能。
type: boolean
x-go-name: Discoverable
display_name:
description: 账户的昵称。
example: big jeff (he/him)
type: string
x-go-name: DisplayName
emojis:
description: |-
账户的简介或显示名称中使用的自定义表情符号的数组。
对于被屏蔽的账户为空。
items:
$ref: '#/definitions/emoji'
type: array
x-go-name: Emojis
enable_rss:
description: |-
账户已启用 RSS 订阅。
如果为 false,则省略键/值。
type: boolean
x-go-name: EnableRSS
fields:
description: |-
账户资料中的附加元数据。
对于被屏蔽的账户为空。
items:
$ref: '#/definitions/field'
type: array
x-go-name: Fields
followers_count:
description: 该账户的粉丝数,数据来源于本站实例。
format: int64
type: integer
x-go-name: FollowersCount
following_count:
description: 该账户关注的账户数,数据来源于本站实例。
format: int64
type: integer
x-go-name: FollowingCount
group:
description: 该账户被标记为 Group 类型的行为体。
type: boolean
x-go-name: Group
header:
description: 账户资料卡横幅背景图的 Web 地址。
example: https://example.org/media/some_user/header/original/header.jpeg
type: string
x-go-name: Header
header_description:
description: 账户资料卡横幅背景图的描述,用于 alt 文本。
example: 花开富贵。
type: string
x-go-name: HeaderDescription
header_media_id:
description: |-
此账户的资料卡横幅背景图片对应的媒体附件的数据库 ID。
如果此账户没有上传资料卡横幅背景图(即使用默认横幅背景),则省略。
example: 01JAJ3XCD66K3T99JZESCR137W
type: string
x-go-name: HeaderMediaID
header_static:
description: |-
账户资料卡横幅背景图的静态版本的 Web 地址。
仅在账户的主横幅是视频或 gif 时才有用。
example: https://example.org/media/some_user/header/static/header.png
type: string
x-go-name: HeaderStatic
hide_collections:
description: |-
账户选择隐藏他们的粉丝/关注数据。
如果为 false,则省略键/值。
type: boolean
x-go-name: HideCollections
id:
description: 账户 ID。
example: 01FBVD42CQ3ZEEVMW180SBX03B
type: string
x-go-name: ID
last_status_at:
description: 账户上次发帖的时间 (ISO 8601 Date)。
example: "2021-07-30"
type: string
x-go-name: LastStatusAt
locked:
description: 账户手动批准关注请求。
type: boolean
x-go-name: Locked
moved:
$ref: '#/definitions/account'
mute_expires_at:
description: |-
如果此账户被静音/隐藏,静音/隐藏将在何时到期 (ISO 8601 Datetime)。
如果静音/隐藏是永久的,值将为 null。
example: "2021-07-30T09:20:25+00:00"
type: string
x-go-name: MuteExpiresAt
note:
description: 该账户的简介/描述。
type: string
x-go-name: Note
role:
$ref: '#/definitions/accountRole'
roles:
description: |-
Roles 列出了账户在本实例上的公开身份。
与 Role 不同,此属性始终可用的,但从不包含权限细节。
items:
$ref: '#/definitions/accountDisplayRole'
type: array
x-go-name: Roles
source:
$ref: '#/definitions/Source'
statuses_count:
description: 该账户发布的贴文数,数据来源于本站实例。
format: int64
type: integer
x-go-name: StatusesCount
suspended:
description: 账户已被本站实例封禁。
type: boolean
x-go-name: Suspended
theme:
description: 用户选择的 CSS 主题的文件名,用于在渲染此账户的资料页或贴文页时包含。例如,`blurple-light.css`。
type: string
x-go-name: Theme
url:
description: 该账户资料页的 Web 地址。
example: https://example.org/@some_user
type: string
x-go-name: URL
username:
description: 账户的用户名,不包括域名。
example: some_user
type: string
x-go-name: Username
title: MutedAccount
description: MutedAccount 扩展了 Account,其中包含仅静音/隐藏用户列表使用的字段。
type: object
x-go-name: MutedAccount
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
nodeinfo:
description: 'NodeInfo 表示版本 2.1 或版本 2.0 的 nodeinfo 数据结构。参见: https://nodeinfo.diaspora.software/schema.html'
properties:
metadata:
additionalProperties: {}
description: 自由形式的键值对,用于软件特定值。客户端不应依赖于任何特定的键存在。
type: object
x-go-name: Metadata
openRegistrations:
description: 此服务器是否开放自主注册。
example: false
type: boolean
x-go-name: OpenRegistrations
protocols:
description: 服务器支持的协议。
items:
type: string
type: array
x-go-name: Protocols
services:
$ref: '#/definitions/NodeInfoServices'
software:
$ref: '#/definitions/NodeInfoSoftware'
usage:
$ref: '#/definitions/NodeInfoUsage'
version:
description: NodeInfo 数据结构版本。
example: "2.0"
type: string
x-go-name: Version
title: Nodeinfo
type: object
x-go-name: Nodeinfo
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
notification:
properties:
account:
$ref: '#/definitions/account'
created_at:
description: 通知的时间戳 (ISO 8601 Datetime)
type: string
x-go-name: CreatedAt
id:
description: 通知在数据库中的 ID。
type: string
x-go-name: ID
status:
$ref: '#/definitions/status'
type:
description: |-
触发通知的事件类型。
follow = 有人关注了你。`account` 将被设置。
follow_request = 有人请求关注你。`account` 将被设置。
mention = 有人在他们的贴文中提到了你。`status` 将被设置。`account` 将被设置。
reblog = 有人转发了你的一条贴文。`status` 将被设置。`account` 将被设置。
favourite = 有人点赞了你的一条贴文。`status` 将被设置。`account` 将被设置。
poll = 你参与或创建的一次投票已结束。`status` 将被设置。`account` 将被设置。
status = 你设置的接收发帖通知的某个账户发布了一条贴文。`status` 将被设置。`account` 将被设置。
admin.sign_up = 有人在实例上注册了一个新账户。`account` 将被设置。
type: string
x-go-name: Type
title: Notification
description: Notification 表示与用户相关的事件的通知。
type: object
x-go-name: Notification
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
oauthToken:
properties:
access_token:
description: 用于身份验证的访问令牌。
type: string
x-go-name: AccessToken
created_at:
description: 生成 OAuth 令牌的时间 (UNIX 时间戳格式的秒)。
example: 1627644520
format: int64
type: integer
x-go-name: CreatedAt
scope:
description: 此令牌被授予的 OAuth 作用域,以空格分隔。
example: read write admin
type: string
x-go-name: Scope
token_type:
description: OAuth 令牌类型。将始终为 'Bearer'。
example: bearer
type: string
x-go-name: TokenType
title: Token
description: Token 表示用于 GoToSocial API 身份验证和执行操作的 OAuth 令牌。
type: object
x-go-name: Token
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
poll:
properties:
emojis:
description: 渲染投票选项时使用的自定义表情符号。
items:
$ref: '#/definitions/emoji'
type: array
x-go-name: Emojis
expired:
description: 投票是否已结束?
type: boolean
x-go-name: Expired
expires_at:
description: 投票结束时间 (ISO 8601 Datetime)。
type: string
x-go-name: ExpiresAt
id:
description: 数据库中投票的 ID。
example: 01FBYKMD1KBMJ0W6JF1YZ3VY5D
type: string
x-go-name: ID
multiple:
description: 投票是否允许多选?
type: boolean
x-go-name: Multiple
options:
description: 投票的选项。
items:
$ref: '#/definitions/pollOption'
type: array
x-go-name: Options
own_votes:
description: |-
当使用用户令牌调用时,令牌关联的授权用户选择了哪些选项?包含选项的索引值数组。
未提供用户令牌时省略。
items:
format: int64
type: integer
type: array
x-go-name: OwnVotes
voted:
description: |-
当使用用户令牌调用时,令牌关联的授权用户是否已投票?
未提供用户令牌时省略。
type: boolean
x-go-name: Voted
voters_count:
description: 多选投票中有多少个独立账户投票。
format: int64
type: integer
x-go-name: VotersCount
votes_count:
description: 收到了多少票。
format: int64
type: integer
x-go-name: VotesCount
title: Poll
description: Poll 表示一个附加到贴文的投票。
type: object
x-go-name: Poll
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
pollOption:
properties:
title:
description: 投票选项的文本值。格式为字符串。
type: string
x-go-name: Title
votes_count:
description: 该选项收到的票数。
format: int64
type: integer
x-go-name: VotesCount
title: PollOption
description: PollOption 表示不同投票选项的当前投票计数。
type: object
x-go-name: PollOption
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
report:
properties:
action_taken:
description: 管理员是否已对此举报采取行动。
example: false
type: boolean
x-go-name: ActionTaken
action_taken_at:
description: |-
若已采取行动,在何时采取行动?(ISO 8601 Datetime)
如果未设置/尚未采取行动,则为null。
example: "2021-07-30T09:20:25+00:00"
type: string
x-go-name: ActionTakenAt
action_taken_comment:
description: |-
若已采取行动,管理员在采取行动时发表了什么评论?
如果未设置/尚未采取行动,则为null。
example: 账户已被封禁。
type: string
x-go-name: ActionTakenComment
category:
description: 此举报是在哪个类别下创建的?
example: spam
type: string
x-go-name: Category
comment:
description: |-
提交举报时附带的评论。
如果未提交评论,则为空。
example: 此人一直在骚扰我。
type: string
x-go-name: Comment
created_at:
description: 举报被创建的时间 (ISO 8601 Datetime)。
example: "2021-07-30T09:20:25+00:00"
type: string
x-go-name: CreatedAt
forwarded:
description: 用于指示是否应将举报抄送到外站实例的布尔值。
example: true
type: boolean
x-go-name: Forwarded
id:
description: 举报的 ID。
example: 01FBVD42CQ3ZEEVMW180SBX03B
type: string
x-go-name: ID
rule_ids:
description: |-
与该举报一并提交的实例规则的 ID 数组。
如果未提交规则 ID,则为空。
example:
- 01GPBN5YDY6JKBWE44H7YQBDCQ
- 01GPBN65PDWSBPWVDD0SQCFFY3
items:
type: string
type: array
x-go-name: RuleIDs
status_ids:
description: |-
与此举报一起提交的贴文的 ID 数组。
如果未提交贴文 ID,则为空。
example:
- 01GPBN5YDY6JKBWE44H7YQBDCQ
- 01GPBN65PDWSBPWVDD0SQCFFY3
items:
type: string
type: array
x-go-name: StatusIDs
target_account:
$ref: '#/definitions/account'
title: Report
description: Report 是提交给实例的一份举报的抽象模型,可以通过客户端 API 或联合 API 提交。
type: object
x-go-name: Report
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
searchResult:
properties:
accounts:
items:
$ref: '#/definitions/account'
type: array
x-go-name: Accounts
hashtags:
description: 若为 API v1,则为字符串切片;若为 API v2,则为话题标签切片。
items: {}
type: array
x-go-name: Hashtags
statuses:
items:
$ref: '#/definitions/status'
type: array
x-go-name: Statuses
title: SearchResult
description: SearchResult 是一次搜索结果的抽象模型。
type: object
x-go-name: SearchResult
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
status:
properties:
account:
$ref: '#/definitions/account'
application:
$ref: '#/definitions/application'
bookmarked:
description: 此贴文已被查看的账户收藏。
type: boolean
x-go-name: Bookmarked
card:
$ref: '#/definitions/card'
content:
description: 此贴文的内容。应为 HTML,但在某些情况下也可能为纯文本。
example: <p>你好,我是一条嘟文。</p>
type: string
x-go-name: Content
created_at:
description: 此贴文的创建时间 (ISO 8601 Datetime)。
example: "2021-07-30T09:20:25+00:00"
type: string
x-go-name: CreatedAt
edited_at:
description: 此贴文上次被编辑的时间 (ISO 8601 Datetime)。
example: "2021-07-30T09:20:25+00:00"
type: string
x-go-name: EditedAt
emojis:
description: 此贴文内容中使用的自定义表情符号。
items:
$ref: '#/definitions/emoji'
type: array
x-go-name: Emojis
favourited:
description: 此贴文已被查看它的账户点赞。
type: boolean
x-go-name: Favourited
favourites_count:
description: 此贴文收到的点赞数,数据来源于本站实例。
format: int64
type: integer
x-go-name: FavouritesCount
filtered:
description: 此贴文命中的过滤规则列表,如果有命中的过滤规则,还会包含命中原因。
items:
$ref: '#/definitions/filterResult'
type: array
x-go-name: Filtered
id:
description: 此贴文的 ID。
example: 01FBVD42CQ3ZEEVMW180SBX03B
type: string
x-go-name: ID
in_reply_to_account_id:
description: 此贴文回复的账户的 ID。
example: 01FBVD42CQ3ZEEVMW180SBX03B
type: string
x-go-name: InReplyToAccountID
in_reply_to_id:
description: 此贴文回复的贴文的 ID。
example: 01FBVD42CQ3ZEEVMW180SBX03B
type: string
x-go-name: InReplyToID
interaction_policy:
$ref: '#/definitions/interactionPolicy'
language:
description: |-
此贴文的主要语言 (ISO 639 Part 1 两字母语言代码)。当语言未知时将为 null。
example: en
type: string
x-go-name: Language
local_only:
description: 若贴文不参与联合,则设置为 "true";否则省略。
type: boolean
x-go-name: LocalOnly
media_attachments:
description: 附于到此贴文的媒体。
items:
$ref: '#/definitions/attachment'
type: array
x-go-name: MediaAttachments
mentions:
description: 此贴文内容中提及的用户。
items:
$ref: '#/definitions/Mention'
type: array
x-go-name: Mentions
muted:
description: 此贴文下的回复已被查看它的账户静音。
type: boolean
x-go-name: Muted
pinned:
description: 此贴文已被查看它的账户置顶(仅适用于您自己的贴文)。
type: boolean
x-go-name: Pinned
poll:
$ref: '#/definitions/poll'
reblog:
$ref: '#/definitions/statusReblogged'
reblogged:
description: 此贴文已被查看它的账户转发。
type: boolean
x-go-name: Reblogged
reblogs_count:
description: 此贴文被转发的次数,数据来源于本站实例。
format: int64
type: integer
x-go-name: ReblogsCount
replies_count:
description: 此贴文的回复数,数据来源于本站实例。
format: int64
type: integer
x-go-name: RepliesCount
sensitive:
description: 此贴文包含敏感内容。
example: false
type: boolean
x-go-name: Sensitive
spoiler_text:
description: 此贴文的主题、摘要或内容警告。
example: NSFW 警告
type: string
x-go-name: SpoilerText
tags:
description: 贴文内容中使用的话题标签。
items:
$ref: '#/definitions/tag'
type: array
x-go-name: Tags
text:
description: |-
贴文的纯文本内容。当贴文被删除时返回,以便用户可以从源文本重新起草,而无需客户端从 HTML 内容中逆向出原始文本。
type: string
x-go-name: Text
uri:
description: 此贴文的 ActivityPub URI。等同于贴文的 activitypub ID。
example: https://example.org/users/some_user/statuses/01FBVD42CQ3ZEEVMW180SBX03B
type: string
x-go-name: URI
url:
description: 此贴文的公开 Web URL。仅当贴文的可见性为 'public' 时,此链接才有效。
example: https://example.org/@some_user/statuses/01FBVD42CQ3ZEEVMW180SBX03B
type: string
x-go-name: URL
visibility:
description: 此贴文的可见性。
example: unlisted
type: string
x-go-name: Visibility
title: Status
description: Status 表示一条贴文或帖子。
type: object
x-go-name: Status
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
statusEdit:
description: |-
StatusEdit 表示一条贴文的一个历史修订版本,包含该修订版本的状态的部分信息。
properties:
account:
$ref: '#/definitions/account'
content:
description: |-
本次修订的贴文内容。
应为 HTML,但在某些情况下也可能为纯文本。
example: <p>这是一条嘟文。</p>
type: string
x-go-name: Content
content_type:
description: |-
用于解析帖文文本的内容格式。
当帖文被删除时会返回该值,因此如果用户重新撰写消息,
客户端可以默认使用相同的内容格式。
type: string
x-go-name: ContentType
created_at:
description: 此修订版本创建的时间 (ISO 8601 Datetime)。
example: "2021-07-30T09:20:25+00:00"
type: string
x-go-name: CreatedAt
emojis:
description: 渲染此贴文时用到的自定义表情符号。
items:
$ref: '#/definitions/emoji'
type: array
x-go-name: Emojis
media_attachments:
description: 此贴文随附的媒体。
items:
$ref: '#/definitions/attachment'
type: array
x-go-name: MediaAttachments
poll:
$ref: '#/definitions/poll'
sensitive:
description: 贴文在本次编辑中被标记为敏感。
example: false
type: boolean
x-go-name: Sensitive
spoiler_text:
description: 本次编辑中设定的贴文主题、摘要或内容警告。
example: warning nsfw
type: string
x-go-name: SpoilerText
type: object
x-go-name: StatusEdit
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
statusReblogged:
properties:
account:
$ref: '#/definitions/account'
application:
$ref: '#/definitions/application'
bookmarked:
description: 此贴文已被查看它的账户收藏。
type: boolean
x-go-name: Bookmarked
card:
$ref: '#/definitions/card'
content:
description: 此贴文的内容。应为 HTML,但在某些情况下也可能为纯文本。
example: <p>这是一条嘟文。</p>
type: string
x-go-name: Content
content_type:
description: |-
用于解析帖文文本的内容格式。
当帖文被删除时会返回该值,因此如果用户重新撰写消息,
客户端可以默认使用相同的内容格式。
type: string
x-go-name: ContentType
created_at:
description: 此贴文的创建时间 (ISO 8601 Datetime)。
example: "2021-07-30T09:20:25+00:00"
type: string
x-go-name: CreatedAt
edited_at:
description: 此贴文上次被编辑的时间 (ISO 8601 Datetime)。
example: "2021-07-30T09:20:25+00:00"
type: string
x-go-name: EditedAt
emojis:
description: 渲染此贴文时使用的自定义表情符号。
items:
$ref: '#/definitions/emoji'
type: array
x-go-name: Emojis
favourited:
description: 此贴文已被查看它的账户点赞。
type: boolean
x-go-name: Favourited
favourites_count:
description: 此贴文收到的点赞数,数据来源于本站实例。
format: int64
type: integer
x-go-name: FavouritesCount
filtered:
description: 此贴文命中的过滤规则列表,如果有命中的过滤规则,还会包含命中原因。
items:
$ref: '#/definitions/filterResult'
type: array
x-go-name: Filtered
id:
description: 贴文的 ID。
example: 01FBVD42CQ3ZEEVMW180SBX03B
type: string
x-go-name: ID
in_reply_to_account_id:
description: 贴文回复的账户的 ID。
example: 01FBVD42CQ3ZEEVMW180SBX03B
type: string
x-go-name: InReplyToAccountID
in_reply_to_id:
description: 此贴文回复的贴文的 ID。
example: 01FBVD42CQ3ZEEVMW180SBX03B
type: string
x-go-name: InReplyToID
interaction_policy:
$ref: '#/definitions/interactionPolicy'
language:
description: |-
此贴文的主要语言 (ISO 639 Part 1 两字母语言代码)。
当语言未知时将为 null。
example: zh
type: string
x-go-name: Language
local_only:
description: 若贴文不参与联合,则设置为 "true";否则省略。
type: boolean
x-go-name: LocalOnly
media_attachments:
description: 随附到此贴文的媒体。
items:
$ref: '#/definitions/attachment'
type: array
x-go-name: MediaAttachments
mentions:
description: 此贴文内容中提及的用户。
items:
$ref: '#/definitions/Mention'
type: array
x-go-name: Mentions
muted:
description: 此贴文下的回复已被查看它的账户静音。
type: boolean
x-go-name: Muted
pinned:
description: 此贴文已被查看它的账户置顶(仅适用于您自己的贴文)。
type: boolean
x-go-name: Pinned
poll:
$ref: '#/definitions/poll'
reblog:
$ref: '#/definitions/statusReblogged'
reblogged:
description: 此贴文已被查看它的账户转发。
type: boolean
x-go-name: Reblogged
reblogs_count:
description: 此贴文被转发的次数,数据来源于本站实例。
format: int64
type: integer
x-go-name: ReblogsCount
replies_count:
description: 此贴文的回复数,数据来源于本站实例。
format: int64
type: integer
x-go-name: RepliesCount
sensitive:
description: 贴文包含敏感内容。
example: false
type: boolean
x-go-name: Sensitive
spoiler_text:
description: 此贴文的主题、摘要或内容警告。
example: NSFW
type: string
x-go-name: SpoilerText
tags:
description: 此贴文内容中使用的话题标签。
items:
$ref: '#/definitions/tag'
type: array
x-go-name: Tags
text:
description: |-
此贴文的纯文本内容。当贴文被删除时返回,以便用户可以从源文本重新起草,而无需客户端从 HTML 内容中逆向出原始文本。
type: string
x-go-name: Text
uri:
description: 此贴文的 ActivityPub URI。等同于贴文的 activitypub ID。
example: https://example.org/users/some_user/statuses/01FBVD42CQ3ZEEVMW180SBX03B
type: string
x-go-name: URI
url:
description: 此贴文的公开 Web URL。仅当贴文的可见性为 'public' 时,此链接才有效。
example: https://example.org/@some_user/statuses/01FBVD42CQ3ZEEVMW180SBX03B
type: string
x-go-name: URL
visibility:
description: 此贴文的可见性。
example: unlisted
type: string
x-go-name: Visibility
title: StatusReblogged
description: StatusReblogged 表示一条被转发的贴文。
type: object
x-go-name: StatusReblogged
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
statusSource:
description: |-
StatusSource 表示创建贴文时提交给 API 的贴文源文本。
properties:
content_type:
description: 用于解析贴文文本的内容格式。
type: string
x-go-name: ContentType
id:
description: 贴文的 ID。
example: 01FBVD42CQ3ZEEVMW180SBX03B
type: string
x-go-name: ID
spoiler_text:
description: 贴文折叠提示的纯文本版本。
type: string
x-go-name: SpoilerText
text:
description: 贴文的源文本。
type: string
x-go-name: Text
type: object
x-go-name: StatusSource
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
swaggerCollection:
properties:
'@context':
description: |-
ActivityStreams JSON-LD 上下文。
字符串或字符串数组,或更复杂的嵌套项。
example: https://www.w3.org/ns/activitystreams
x-go-name: Context
first:
$ref: '#/definitions/swaggerCollectionPage'
id:
description: ActivityStreams ID.
example: https://example.org/users/some_user/statuses/106717595988259568/replies
type: string
x-go-name: ID
last:
$ref: '#/definitions/swaggerCollectionPage'
type:
description: ActivityStreams 类型。
example: Collection
type: string
x-go-name: Type
title: SwaggerCollection
description: SwaggerCollection 表示一个 ActivityPub 集合。
type: object
x-go-name: SwaggerCollection
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/activitypub/users
swaggerCollectionPage:
properties:
id:
description: ActivityStreams ID.
example: https://example.org/users/some_user/statuses/106717595988259568/replies?page=true
type: string
x-go-name: ID
items:
description: 此页面上的条目。
example:
- https://example.org/users/some_other_user/statuses/086417595981111564
- https://another.example.com/users/another_user/statuses/01FCN8XDV3YG7B4R42QA6YQZ9R
items:
type: string
type: array
x-go-name: Items
next:
description: 指向下一页的链接。
example: https://example.org/users/some_user/statuses/106717595988259568/replies?only_other_accounts=true&page=true
type: string
x-go-name: Next
partOf:
description: 此页面所属的集合。
example: https://example.org/users/some_user/statuses/106717595988259568/replies
type: string
x-go-name: PartOf
type:
description: ActivityStreams 类型。
example: CollectionPage
type: string
x-go-name: Type
title: SwaggerCollectionPage
description: SwaggerCollectionPage 表示一个 ActivityPub 集合的一页。
type: object
x-go-name: SwaggerCollectionPage
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/activitypub/users
swaggerFeaturedCollection:
properties:
'@context':
description: |-
ActivityStreams JSON-LD 上下文。
字符串或字符串数组,或更复杂的嵌套项。
example: https://www.w3.org/ns/activitystreams
x-go-name: Context
TotalItems:
description: 此集合中的项目数。
example: 2
format: int64
type: integer
id:
description: ActivityStreams ID.
example: https://example.org/users/some_user/collections/featured
type: string
x-go-name: ID
items:
description: 贴文 URI 的列表。
example:
- https://example.org/users/some_user/statuses/01GSZ0F7Q8SJKNRF777GJD271R
- https://example.org/users/some_user/statuses/01GSZ0G012CBQ7TEKX689S3QRE
items:
type: string
type: array
x-go-name: Items
type:
description: ActivityStreams 类型。
example: OrderedCollection
type: string
x-go-name: Type
title: SwaggerFeaturedCollection
description: SwaggerFeaturedCollection 表示一个有序 ActivityPub 集合。
type: object
x-go-name: SwaggerFeaturedCollection
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/activitypub/users
tag:
properties:
following:
description: |-
Following 在当用户关注此标签时为 true,不关注时为 false,如果没有当前认证用户则省略。
type: boolean
x-go-name: Following
history:
description: |-
此话题标签的使用历史。
目前只是一个存根,如果提供将始终为空数组。
example: []
items: {}
type: array
x-go-name: History
name:
description: '此话题标签的名称,不包含 # 符号。'
example: helloworld
type: string
x-go-name: Name
url:
description: 此话题标签的网页链接。
example: https://example.org/tags/helloworld
type: string
x-go-name: URL
title: Tag
description: Tag 表示贴文内容中使用的某个话题标签。
type: object
x-go-name: Tag
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
theme:
properties:
description:
description: 此主题面向用户的描述。
type: string
x-go-name: Description
file_name:
description: 此主题在主题目录中的文件名。
type: string
x-go-name: FileName
title:
description: 此主题的用户可见标题。
type: string
x-go-name: Title
title: Theme
description: Theme 表示一个用户可选的预设 CSS 主题。
type: object
x-go-name: Theme
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
threadContext:
description: |-
ThreadContext 是围绕给定贴文的贴文树/贴文串的抽象模型。
properties:
ancestors:
description: 此贴文的祖先。
items:
$ref: '#/definitions/status'
type: array
x-go-name: Ancestors
descendants:
description: 此贴文的后代。
items:
$ref: '#/definitions/status'
type: array
x-go-name: Descendants
type: object
x-go-name: ThreadContext
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
tokenInfo:
description: |-
TokenInfo 表示与用户关联的访问令牌的元数据。
实际的访问令牌将永远不会通过 API 发送。
properties:
application:
$ref: '#/definitions/application'
created_at:
description: 此令牌的创建时间(ISO 8601 Datetime)。
example: "2021-07-30T09:20:25+00:00"
type: string
x-go-name: CreatedAt
id:
description: 此令牌的数据库 ID。
example: 01JMW7QBAZYZ8T8H73PCEX12XG
type: string
x-go-name: ID
last_used:
description: |-
上一次使用此令牌的大致时间(精确到小时内,格式为 ISO 8601 Datetime)。
如果该令牌从未使用过,或者无法确定其上一次使用的时间(例如,在记录“last_used”之前就已使用过),则会省略此项。
example: "2021-07-30T09:20:25+00:00"
type: string
x-go-name: LastUsed
scope:
description: 此令牌被授予的 OAuth 权限范围,以空格分隔。
example: read write admin
type: string
x-go-name: Scope
title: TokenInfo
type: object
x-go-name: TokenInfo
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
user:
properties:
admin:
description: 用户为管理员。
example: false
type: boolean
x-go-name: Admin
approved:
description: 用户已被管理员批准。
example: true
type: boolean
x-go-name: Approved
confirmation_sent_at:
description: 上次发送“请确认您的电子邮件地址”电子邮件的时间(如果有的话)。 (ISO 8601 Datetime)
example: "2021-07-30T09:20:25+00:00"
type: string
x-go-name: ConfirmationSentAt
confirmed_at:
description: 用户填写的电子邮件地址被确认的时间,如果有的话。 (ISO 8601 Datetime)
example: "2021-07-30T09:20:25+00:00"
type: string
x-go-name: ConfirmedAt
created_at:
description: 用户创建时间。 (ISO 8601 Datetime)
example: "2021-07-30T09:20:25+00:00"
type: string
x-go-name: CreatedAt
disabled:
description: 用户的帐户已被停用。
example: false
type: boolean
x-go-name: Disabled
email:
description: 用户确认的电子邮件地址(如果用户设置了电子邮件地址)。
example: someone@example.org
type: string
x-go-name: Email
id:
description: 此用户的数据库 ID。
example: 01FBVD42CQ3ZEEVMW180SBX03B
type: string
x-go-name: ID
last_emailed_at:
description: 上次给此用户发送电子邮件的时间,如果有的话。 (ISO 8601 Datetime)
example: "2021-07-30T09:20:25+00:00"
type: string
x-go-name: LastEmailedAt
moderator:
description: 用户为站务/监察员。
example: false
type: boolean
x-go-name: Moderator
reason:
description: 用户注册原因(如果用户注册时填写了原因)。
example: Please! Pretty please!
type: string
x-go-name: Reason
reset_password_sent_at:
description: 上次发送“请重置您的密码”电子邮件的时间(如果有的话)。 (ISO 8601 Datetime)
example: "2021-07-30T09:20:25+00:00"
type: string
x-go-name: ResetPasswordSentAt
two_factor_enabled_at:
description: 此用户启用双因素验证的时间。 (ISO 8601 Datetime)
example: "2021-07-30T09:20:25+00:00"
type: string
x-go-name: TwoFactorEnabledAt
unconfirmed_email:
description: 此用户的未确认电子邮件地址(如果用户设置了电子邮件地址)。
example: someone.else@somewhere.else.example.org
type: string
x-go-name: UnconfirmedEmail
title: User
description: User 是单个用户的相关字段的抽象模型。
type: object
x-go-name: User
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
webPushNotification:
description: |-
WebPushNotification 表示 Web 推送服务器传递给客户端的通知摘要。
它不包含完整的通知,仅包含通知 ID 和一些预览信息。
它并不直接用于客户端 API,而是包含在 API 文档中,用于解码 Web 推送通知。
properties:
access_token:
description: |-
AccessToken 是与 Web 推送订阅关联的访问令牌。
尚不清楚为何要发送此令牌,因为客户端理应已知晓,但 Feditext 确实使用了它。
type: string
x-go-name: AccessToken
body:
description: |-
Body 是通知正文的预览,
例如状态的内容警告或文本的第一行,
或帐户的简介的第一行。
type: string
x-go-name: Body
icon:
description: |-
Icon 是通知中显示的图像的 URL,
通常是帐户的头像。
type: string
x-go-name: Icon
notification_id:
description: NotificationID 是所引用的通知的 Notification.ID。
type: string
x-go-name: NotificationID
notification_type:
description: NotificationType 是所引用的通知的 Notification.Type。
type: string
x-go-name: NotificationType
preferred_locale:
description: PreferredLocale 是接收通知的用户的语言标签(BCP 47 标签)。
type: string
x-go-name: PreferredLocale
title:
description: |-
Title 是通知的标题,
通常是用户执行的动作的描述。
type: string
x-go-name: Title
title: WebPushNotification
type: object
x-go-name: WebPushNotification
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
webPushSubscription:
properties:
alerts:
$ref: '#/definitions/webPushSubscriptionAlerts'
endpoint:
description: 通知将被推送到的端点。
type: string
x-go-name: Endpoint
id:
description: 数据库中推送订阅的 ID。
type: string
x-go-name: ID
policy:
$ref: '#/definitions/WebPushNotificationPolicy'
server_key:
description: 此实例的 VAPID 公钥。
type: string
x-go-name: ServerKey
standard:
description: |-
是否使用 RFC 或预 RFC Web 推送标准。
对于 GotoSocial,这将总是为真。
type: boolean
x-go-name: Standard
title: WebPushSubscription
description: WebPushSubscription 表示对 Web 推送服务器的订阅。
type: object
x-go-name: WebPushSubscription
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
webPushSubscriptionAlerts:
properties:
admin.report:
description: 是否在收到新的举报时接收推送通知?
type: boolean
x-go-name: AdminReport
admin.sign_up:
description: 是否在有新用户注册时接收推送通知?
type: boolean
x-go-name: AdminSignup
favourite:
description: 是否在某条贴文被其他人点赞时接收推送通知?
type: boolean
x-go-name: Favourite
follow:
description: 是否在有人关注你时接收推送通知?
type: boolean
x-go-name: Follow
follow_request:
description: 是否在有人向你发出关注请求时接收推送通知?
type: boolean
x-go-name: FollowRequest
mention:
description: 是否在有人在贴文中提及你时接收推送通知?
type: boolean
x-go-name: Mention
pending.favourite:
description: 是否在有点赞待处理时接收推送通知?
type: boolean
x-go-name: PendingFavourite
pending.reblog:
description: 是否在有转发待处理时接收推送通知?
type: boolean
x-go-name: PendingReblog
pending.reply:
description: 是否在有回复待处理时接收推送通知?
type: boolean
x-go-name: PendingReply
poll:
description: 是否在你参与或创建的投票结束时接收推送通知?
type: boolean
x-go-name: Poll
reblog:
description: 是否在你创建的贴文被别人转发时接收推送通知?
type: boolean
x-go-name: Reblog
status:
description: 是否在你订阅的某个账户发帖时接收推送通知?
type: boolean
x-go-name: Status
update:
description: 是否在你互动过的贴文被编辑时接收推送通知?
type: boolean
x-go-name: Update
title: WebPushSubscriptionAlerts
description: WebPushSubscriptionAlerts 代表此 Web 推送订阅将接收的具体事件。
type: object
x-go-name: WebPushSubscriptionAlerts
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
wellKnownResponse:
properties:
aliases:
items:
type: string
type: array
x-go-name: Aliases
links:
items:
$ref: '#/definitions/Link'
type: array
x-go-name: Links
subject:
type: string
x-go-name: Subject
title: WellKnownResponse
description: |-
WellKnownResponse 表示对“acct”资源的 webfinger 请求或对 nodeinfo 请求的响应。
例如,访问 https://example.org/.well-known/webfinger?resource=acct:some_username@example.org 时将返回一个此类型的响应。
参见 https://webfinger.net/
type: object
x-go-name: WellKnownResponse
x-go-package: code.superseriousbusiness.org/gotosocial/internal/api/model
host: example.org
info:
contact:
email: admin@gotosocial.org
name: GotoSocial 开发者
description: |-
该文档描述了 GoToSocial HTTP API。
有关如何使用 OAuth 访问令牌进行 API 身份验证的信息,请参阅此处的文档:https://docs.gotosocial.org/zh-cn/latest/api/authentication/。
可用权限范围:
admin: 授予对所有内容的管理权限
admin:read: 授予对所有内容的管理读权限
admin:read:accounts: 授予对账号的管理读权限
admin:read:domain_allows: 授予对域名白名单的管理读权限
admin:read:domain_blocks: 授予对域名黑名单的管理读权限
admin:read:reports: 授予对举报的管理读权限
admin:write: 授予对所有内容的管理写权限
admin:write:accounts: 授予对账号的管理写权限
admin:write:domain_allows: 授予对域名白名单的管理写权限
admin:write:domain_blocks: 授予对域名黑名单的管理写权限
admin:write:reports: 授予对举报的管理写权限
profile: 授予对 verify_credentials 的读权限
push: 授予对 push 的读写权限
read: 授予对所有内容的读权限
read:accounts: 授予对账号的读权限
read:applications: 授予对用户管理的应用的读权限
read:blocks: 授予对屏蔽的读权限
read:bookmarks: 授予对收藏的读权限
read:favourites: 授予对点赞的读权限
read:filters: 授予对过滤规则的读权限
read:follows: 授予对关注的读权限
read:lists: 授予对列表的读权限
read:mutes: 授予对隐藏的读权限
read:notifications: 授予对通知的读权限
read:search: 授予对搜索的读权限
read:statuses: 授予对贴文的读权限
write: 授予对所有内容的写权限
write:accounts: 授予对账号的写权限
write:applications: 授予对用户管理的应用的写权限
write:blocks: 授予对屏蔽的写权限
write:bookmarks: 授予对收藏的写权限
write:conversations: 授予对对话的写权限
write:favourites: 授予对点赞的写权限
write:filters: 授予对过滤规则的写权限
write:follows: 授予对关注的写权限
write:lists: 授予对列表的写权限
write:media: 授予对媒体的写权限
write:mutes: 授予对隐藏的写权限
write:notifications: 授予对通知的写权限
write:reports: 授予对举报的写权限
write:statuses: 授予对贴文的写权限
license:
name: AGPL3
url: https://www.gnu.org/licenses/agpl-3.0.zh-cn.html
title: GoToSocial Swagger 文档
version: 0.19.1-SNAPSHOT-6c879186
paths:
/.well-known/host-meta:
get:
description: '响应 web 主机元数据查询,返回符合规范的 hostmeta 响应。参见: https://www.rfc-editor.org/rfc/rfc6415.html'
operationId: hostMetaGet
produces:
- application/xrd+xml"
responses:
"200":
description: ""
schema:
$ref: '#/definitions/hostmeta'
summary: 获取 host-meta
tags:
- .well-known
/.well-known/nodeinfo:
get:
description: |-
返回一个 well-known 响应,将调用者重定向到 `/nodeinfo/2.0`。
例如: `{"links":[{"rel":"http://nodeinfo.diaspora.software/ns/schema/2.0","href":"http://example.org/nodeinfo/2.0"}]}`
参见: https://nodeinfo.diaspora.software/protocol.html
operationId: nodeInfoWellKnownGet
produces:
- application/json
responses:
"200":
description: ""
schema:
$ref: '#/definitions/wellKnownResponse'
summary: 获取 nodeinfo
tags:
- .well-known
/.well-known/webfinger:
get:
description: |-
处理 webfinger 账户查询请求。
例如,对 `https://example.org/.well-known/webfinger?resource=acct:admin@example.org` 发送 GET 请求,将返回:
```
{"subject":"acct:admin@example.org","aliases":["https://example.org/users/admin","https://example.org/@admin"],"links":[{"rel":"http://webfinger.net/rel/profile-page","type":"text/html","href":"https://example.org/@admin"},{"rel":"self","type":"application/activity+json","href":"https://example.org/users/admin"}]}
```
参见: https://webfinger.net/
operationId: webfingerGet
produces:
- application/jrd+json
responses:
"200":
description: ""
schema:
$ref: '#/definitions/wellKnownResponse'
summary: Webfinger 账户查询
tags:
- .well-known
/api/{api_version}/media:
post:
consumes:
- multipart/form-data
operationId: mediaCreate
parameters:
- description: 要使用的 API 版本。必须是 `v1` 或 `v2`。
in: path
name: api_version
required: true
type: string
- description: 媒体附件的 alt 文本描述。这对于使用屏幕阅读器的用户非常有用!根据您的实例设置,可能需要也可能不需要。
in: formData
name: description
type: string
- default: 0,0
description: '媒体附件的焦点。如果存在,它应该是两个介于 -1 和 1 之间的逗号分隔的浮点数。例如:`-0.5,0.25`。'
in: formData
name: focus
type: string
- description: 要上传的媒体附件。
in: formData
name: file
required: true
type: file
produces:
- application/json
responses:
"200":
description: 新创建的媒体附件。
schema:
$ref: '#/definitions/attachment'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"422":
description: unprocessable 无法处理
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:media
summary: 上传新附件
description: 上传新的媒体附件。
tags:
- media
/api/{api_version}/search:
get:
description: 在本站或其他地方搜索贴文、帐户或话题标签。如果结果中包含贴文,则它们将按时间顺序(最新的在前)返回,带有连续的 ID(更大 = 更新)。
operationId: searchGet
parameters:
- description: 必须是 `v1` 或 `v2`。如果使用 v1,Hashtag 结果将是字符串切片。如果使用 v2,Hashtag 结果将是 apimodel 标签切片。
in: path
name: api_version
required: true
type: string
- description: 仅返回 *早于* 给定的 max ID 的项目。当前仅在将 type 设置为特定类型时使用。
in: query
name: max_id
type: string
- description: 仅返回 *晚于且紧邻* 给定的 min ID 的项目。当前仅在将 type 设置为特定类型时使用。
in: query
name: min_id
type: string
- default: 20
description: 要返回的每种项目的数量。
in: query
maximum: 40
minimum: 1
name: limit
type: integer
- default: 0
description: 要返回的结果的页数(从 0 开始)。该参数目前未使用,请通过选择特定的查询类型并使用 maxID 和 minID 来分页。
in: query
maximum: 10
minimum: 0
name: offset
type: integer
- description: |-
要搜索的关键词。这可以是以下形式之一:
- `@[username]` -- 搜索任何实例上具有给定用户名的帐户。可以返回多个结果。
- `@[username]@[domain]` -- 精确匹配给定的用户名和实例域名的外站帐户。最多只会返回 1 个结果。
- `https://example.org/some/arbitrary/url` -- 搜索具有给定 URL 的账户或贴文。最多只会返回 1 个结果。
- `#[hashtag_name]` -- 搜索具有给定话题标签名称或以给定话题标签名称开头的话题标签。不区分大小写。可以返回多个结果。
- 任意字符串 -- 搜索包含给定字符串的帐户或贴文。可以返回多个结果。
任意字符串搜索可以包括以下运算符:
- `from:localuser`,`from:remoteuser@instance.tld`:将结果限制为由指定帐户创建的贴文。
in: query
name: q
required: true
type: string
- description: |-
要返回的项目类型。可以是以下之一:
- `` -- 空字符串;返回任何/所有结果。
- `accounts` -- 仅返回帐户。
- `statuses` -- 仅返回贴文。
- `hashtags` -- 仅返回话题标签。
如果指定了 `type`,则可以使用 max_id 和 min_id 参数进行分页。
如果未指定 `type`,使用 `offset` 参数进行分页。
in: query
name: type
type: string
- default: false
description: 若搜索关键词是 `@[username]@[domain]` 或 URL,则允许 GoToSocial 实例通过外站调用(webfinger、ActivityPub 等)来解析搜索关键词。
in: query
name: resolve
type: boolean
- default: false
description: 若搜索类型包括帐户,并且搜索关键词是任意字符串,则仅显示请求帐户关注的帐户。如果设置为 `true`,则 GoToSocial 将在用户名和昵称之外同时检索账户信息来增强搜索。
in: query
name: following
type: boolean
- default: false
description: 若搜索类型包括话题标签,并且搜索关键词是任意字符串,则排除尚未被实例管理员批准的话题标签。目前此参数未使用。
in: query
name: exclude_unreviewed
type: boolean
- description: 将搜索范围限制到由指定帐户创建的贴文。
in: query
name: account_id
type: string
produces:
- application/json
responses:
"200":
description: 搜索结果。
schema:
$ref: '#/definitions/searchResult'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:search
summary: 搜索
tags:
- search
/api/v1/accounts:
post:
consumes:
- application/json
- application/xml
- application/x-www-form-urlencoded
description: |-
使用应用程序令牌创建新帐户。
若 Content-Type 为 `application/json`,则参数也可在请求体中以 JSON 形式给出。
若 Content-Type 为 `application/xml`,则参数也可在请求体中以 XML 形式给出。
operationId: accountCreate
parameters:
- description: 若注册需要手动批准,则此文本将由管理员审核。
in: query
name: reason
type: string
x-go-name: Reason
- description: 账户设置的用户名。
in: query
name: username
type: string
x-go-name: Username
- description: 用于登录的电子邮件地址。
in: query
name: email
type: string
x-go-name: Email
- description: 用于登录的密码。将在存储之前进行哈希处理。
in: query
name: password
type: string
x-go-name: Password
- description: 用户同意实例的条款、条件和政策。
in: query
name: agreement
type: boolean
x-go-name: Agreement
- description: 确认邮件的语言。
in: query
name: locale
type: string
x-go-name: Locale
produces:
- application/json
responses:
"200":
description: 为新创建的帐户提供的 OAuth2 访问令牌。
schema:
$ref: '#/definitions/oauthToken'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"422":
description: unprocessable 无法处理. 你的帐户创建请求无法处理,因为在过去的 24 小时内在此实例上创建了太多帐户,或者待处理的帐户积压已满。
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Application:
- write:accounts
summary: 创建新帐户
tags:
- accounts
/api/v1/accounts/{id}:
get:
operationId: accountGet
parameters:
- description: 请求的帐户 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 请求的帐户。
schema:
$ref: '#/definitions/account'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:accounts
summary: 获取账户详情
description: 获取具有给定 ID 的帐户的信息。
tags:
- accounts
/api/v1/accounts/{id}/block:
post:
operationId: accountBlock
parameters:
- description: 要屏蔽的帐户 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 你与帐户的关系(relationship)。
schema:
$ref: '#/definitions/accountRelationship'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:blocks
summary: 屏蔽帐户
description: 屏蔽具有给定 ID 的帐户。
tags:
- accounts
/api/v1/accounts/{id}/featured_tags:
get:
operationId: accountsFeaturedTags
parameters:
- description: 目标账户的 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: ""
schema:
items:
type: object
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:accounts
summary: 获取账户精选话题标签
description: 以数组的形式获取目标帐户的精选话题标签。此端点目前尚未完全实现:它将始终返回一个空数组。
tags:
- accounts
/api/v1/accounts/{id}/follow:
post:
consumes:
- application/json
- application/xml
- application/x-www-form-urlencoded
description: |-
关注具有给定 ID 的帐户。
若 Content-Type 为 `application/json`,则参数也可在请求体中以 JSON 形式给出。
若 Content-Type 为 `application/xml`,则参数也可在请求体中以 XML 形式给出。
若您已经关注了给定的帐户,则关注(请求)将被更新,不会使用 `reblogs` 和 `notify` 参数。
operationId: accountFollow
parameters:
- description: 要关注的帐户 ID。
in: path
name: id
required: true
type: string
- default: true
description: 显示此帐户的转发。
in: formData
name: reblogs
type: boolean
- default: false
description: 该账户发帖时通知。
in: formData
name: notify
type: boolean
produces:
- application/json
responses:
"200":
description: 你与此帐户的关系(relationship)。
schema:
$ref: '#/definitions/accountRelationship'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:follows
summary: 关注帐户
tags:
- accounts
/api/v1/accounts/{id}/followers:
get:
description: |-
查看关注此帐户的帐户。
下一个/上一个查询可以从返回的 Link 标头中解析。
例如:
```
<https://example.org/api/v1/accounts/0657WMDEC3KQDTD6NZ4XJZBK4M/followers?limit=80&max_id=01FC0SKA48HNSVR6YKZCQGS2V8>; rel="next", <https://example.org/api/v1/accounts/0657WMDEC3KQDTD6NZ4XJZBK4M/followers?limit=80&min_id=01FC0SKW5JK2Q4EVAV2B462YY0>; rel="prev"
```
若帐户 `hide_collections` 为 true,且请求帐户 != 目标帐户,则不会返回结果。
operationId: accountFollowers
parameters:
- description: 帐户 ID。
in: path
name: id
required: true
type: string
- description: '仅返回早于给定的max ID 的粉丝帐户。具有指定 ID 的粉丝帐户不会包含在响应中。注意:ID 是内部关注的 ID,而不是任何返回的帐户的 ID。'
in: query
name: max_id
type: string
- description: '仅返回晚于给定的 since ID 的粉丝帐户。具有指定 ID 的粉丝帐户不会包含在响应中。注意:ID 是内部关注的 ID,而不是任何返回的帐户的 ID。'
in: query
name: since_id
type: string
- description: '仅返回 *晚于且紧邻* 给定的 min ID 的粉丝帐户。具有指定 ID 的粉丝帐户不会包含在响应中。注意:ID 是内部关注的 ID,而不是任何返回的帐户的 ID。'
in: query
name: min_id
type: string
- default: 40
description: 要返回的粉丝帐户数量。
in: query
maximum: 80
minimum: 1
name: limit
type: integer
produces:
- application/json
responses:
"200":
description: 一个关注此帐户的帐户的数组。
headers:
Link:
description: 指向下一/上一查询的链接。
type: string
schema:
items:
$ref: '#/definitions/account'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:accounts
summary: 查看粉丝
tags:
- accounts
/api/v1/accounts/{id}/following:
get:
description: |-
查询此ID对应的帐户关注的帐户。
下一个/上一个查询可以从返回的 Link 标头中解析。
示例:
```
<https://example.org/api/v1/accounts/0657WMDEC3KQDTD6NZ4XJZBK4M/following?limit=80&max_id=01FC0SKA48HNSVR6YKZCQGS2V8>; rel="next", <https://example.org/api/v1/accounts/0657WMDEC3KQDTD6NZ4XJZBK4M/following?limit=80&min_id=01FC0SKW5JK2Q4EVAV2B462YY0>; rel="prev"
```
若帐户 `hide_collections` 为 true,且请求帐户 != 目标帐户,则不会返回结果。
operationId: accountFollowing
parameters:
- description: Account ID.
in: path
name: id
required: true
type: string
- description: '仅返回早于给定的 max ID 的关注帐户。具有指定 ID 的关注帐户不会包含在响应中。注意:ID 是内部关注的 ID,而不是任何返回的帐户的 ID。'
in: query
name: max_id
type: string
- description: '仅返回晚于给定的 since ID 的关注帐户。具有指定 ID 的关注帐户不会包含在响应中。注意:ID 是内部关注的 ID,而不是任何返回的帐户的 ID。'
in: query
name: since_id
type: string
- description: '仅返回 *晚于且紧邻* 给定的 min ID 的关注帐户。具有指定 ID 的关注帐户不会包含在响应中。注意:ID 是内部关注的 ID,而不是任何返回的帐户的 ID。'
in: query
name: min_id
type: string
- default: 40
description: 要返回的关注帐户数量。
in: query
maximum: 80
minimum: 1
name: limit
type: integer
produces:
- application/json
responses:
"200":
description: 此账户关注的账户数组。
headers:
Link:
description: 指向下一/上一查询的链接。
type: string
schema:
items:
$ref: '#/definitions/account'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:accounts
summary: 查看关注
tags:
- accounts
/api/v1/accounts/{id}/lists:
get:
operationId: accountLists
parameters:
- description: 账户 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 一个包含此帐户的所有列表的数组。
schema:
items:
$ref: '#/definitions/list'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:lists
summary: 查看列表
description: 查看你的列表中包含此帐户的所有列表。
tags:
- accounts
/api/v1/accounts/{id}/mute:
post:
description: 根据 ID 静音/隐藏帐户。若此账户已被静音/隐藏,则无论如何都会成功。这可以用来更新静音/隐藏的细节。
operationId: accountMute
parameters:
- description: 要静音/隐藏的帐户 ID。
in: path
name: id
required: true
type: string
- default: false
description: 在静音/隐藏贴文的同时也静音/隐藏通知。
in: formData
name: notifications
type: boolean
- default: 0
description: 静音/隐藏持续时间,以秒为单位。如果为 0 或未提供,则静音/隐藏持续时间无限。
in: formData
name: duration
type: number
produces:
- application/json
responses:
"200":
description: 你与此帐户的关系(relationship)。
schema:
$ref: '#/definitions/accountRelationship'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: 禁止对已迁移的账户设置静音/隐藏
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:mutes
summary: 静音/隐藏帐户
tags:
- accounts
/api/v1/accounts/{id}/note:
post:
consumes:
- multipart/form-data
operationId: accountNote
parameters:
- description: 备注要添加到的帐户的 ID。
in: path
name: id
required: true
type: string
- default: ""
description: 备注的文本。省略此参数或发送空字符串以清除备注。
in: formData
name: comment
type: string
produces:
- application/json
responses:
"200":
description: 你与此账户的关系(relationship)。
schema:
$ref: '#/definitions/accountRelationship'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:accounts
summary: 设置备注
description: 为具有给定 ID 的帐户设置私人备注。
tags:
- accounts
/api/v1/accounts/{id}/statuses:
get:
description: 查看指定账户的贴文。贴文将按时间顺序(最新的在前)返回,带有连续的 ID(更大 = 更新)。
operationId: accountStatuses
parameters:
- description: 账户 ID。
in: path
name: id
required: true
type: string
- default: 30
description: 要返回的贴文数量。
in: query
name: limit
type: integer
- default: false
description: 排除回复。
in: query
name: exclude_replies
type: boolean
- default: false
description: 排除转发。
in: query
name: exclude_reblogs
type: boolean
- description: 仅返回 *早于* 给定的 max status ID 的项目。当前仅在将 type 设置为特定类型时使用。
in: query
name: max_id
type: string
- description: 仅返回 *晚于* 给定的 min status ID 的项目。当前仅在将 type 设置为特定类型时使用。
in: query
name: min_id
type: string
- default: false
description: 仅显示置顶的贴文。即排除未置顶到给定帐户 ID 的贴文。
in: query
name: pinned
type: boolean
- default: false
description: 仅显示带有媒体附件的贴文。
in: query
name: only_media
type: boolean
- default: false
description: 仅显示具有“公开”可见性的贴文。
in: query
name: only_public
type: boolean
produces:
- application/json
responses:
"200":
description: 贴文的数组。
headers:
Link:
description: 下一/上一查询的链接。
type: string
schema:
items:
$ref: '#/definitions/status'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:statuses
summary: 查看贴文
tags:
- accounts
/api/v1/accounts/{id}/unblock:
post:
operationId: accountUnblock
parameters:
- description: 要解除屏蔽的帐户 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 你与此账户的关系(relationship)。
schema:
$ref: '#/definitions/accountRelationship'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:blocks
summary: 解除屏蔽账户
description: 解除对给定 ID 的帐户的屏蔽。
tags:
- accounts
/api/v1/accounts/{id}/unfollow:
post:
operationId: accountUnfollow
parameters:
- description: 要取消关注的帐户 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 你与此账户的关系(relationship)。
schema:
$ref: '#/definitions/accountRelationship'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:follows
summary: 取关账户
description: 取消关注具有给定 ID 的帐户。
tags:
- accounts
/api/v1/accounts/{id}/unmute:
post:
description: 解除对给定 ID 的帐户的静音/隐藏。若账户已被解除静音/隐藏,则无论如何都会成功。
operationId: accountUnmute
parameters:
- description: 要解除静音/隐藏的帐户 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 你与此账户的关系(relationship)。
schema:
$ref: '#/definitions/accountRelationship'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:mutes
summary: 取消静音/隐藏账户
tags:
- accounts
/api/v1/accounts/alias:
post:
consumes:
- multipart/form-data
description: |-
通过将 alsoKnownAs 设置为给定的 URI,将此账户设置为另一个账户的别名。
在需要将其它账户迁移到此账户时很有用。
在这种情况下,你应该将此账户的 alsoKnownAs 设置为要发起迁移的账户的 URI。
operationId: accountAlias
parameters:
- description: |-
要设为别名的账户的 ActivityPub URI/ID。例如,`["https://example.org/users/some_account"]`。
使用空数组也可以清除 alsoKnownAs,清除账户别名。
in: formData
name: also_known_as_uris
required: true
type: string
responses:
"200":
description: 更新后的账户。
schema:
$ref: '#/definitions/account'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"422":
description: unprocessable 无法处理。请查看响应正文以获取更多详细信息。
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:accounts
summary: 设置账户别名
tags:
- accounts
/api/v1/accounts/delete:
post:
consumes:
- multipart/form-data
operationId: accountDelete
parameters:
- description: 账户的密码,用于确认。
in: formData
name: password
required: true
type: string
responses:
"202":
description: 账户删除请求已被接受,账户将被删除。
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:accounts
summary: 删除账户
tags:
- accounts
/api/v1/accounts/lookup:
get:
operationId: accountLookupGet
parameters:
- description: 要查询的用户名或 Webfinger 地址。
in: query
name: acct
required: true
type: string
produces:
- application/json
responses:
"200":
description: 查询结果。
schema:
$ref: '#/definitions/account'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:accounts
summary: 快速查找账户
description: 快速查找用户名以查看其是否可用,跳过 WebFinger 解析。
tags:
- accounts
/api/v1/accounts/move:
post:
consumes:
- multipart/form-data
operationId: accountMove
parameters:
- description: 账户的密码,用于确认。
in: formData
name: password
required: true
type: string
- description: 目标账户的 ActivityPub URI/ID。例如,`https://example.org/users/some_account`。目标账户必须也是请求账户的 alsoKnownAs,才能成功迁移。
in: formData
name: moved_to_uri
required: true
type: string
responses:
"202":
description: 账户迁移请求已被接受,账户将被迁移。
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"422":
description: unprocessable 无法处理。请查看响应正文以获取更多详细信息。
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:accounts
summary: 迁出账户
description: 将此账户迁移到另一个账户。
tags:
- accounts
/api/v1/accounts/relationships:
get:
operationId: accountRelationships
parameters:
- collectionFormat: multi
description: 账户 ID。
in: query
items:
type: string
name: id[]
required: true
type: array
produces:
- application/json
responses:
"200":
description: 账户关系(relationship)的数组。
schema:
items:
$ref: '#/definitions/accountRelationship'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:accounts
summary: 查询账户关系
description: 查看你的账户与给定账户 ID 的关系。
tags:
- accounts
/api/v1/accounts/search:
get:
operationId: accountSearchGet
parameters:
- default: 40
description: 要返回的结果数量。
in: query
maximum: 80
minimum: 1
name: limit
type: integer
- default: 0
description: 要返回的结果所在的页数(从 0 开始)。此参数目前未使用,偏移量大于 0 将始终返回 0 个结果。
in: query
maximum: 10
minimum: 0
name: offset
type: integer
- description: |-
要查找的关键词。可以是以下形式之一:
- `@[username]` -- 在任何实例上搜索具有给定用户名的帐户。可以返回多个结果。
- `@[username]@[domain]` -- 搜索确切的用户名和域名的外站帐户。最多只返回 1 个结果。
- 任意字符串 -- 搜索用户名或昵称中包含给定字符串的帐户。可以返回多个结果。
in: query
name: q
required: true
type: string
- default: false
description: 若关键词为 `@[username]@[domain]` 或 URL,允许 GoToSocial 实例通过调用外站实例(webfinger、ActivityPub 等)来解析搜索。
in: query
name: resolve
type: boolean
- default: false
description: 只显示发起请求的账户关注的账户。如果设置为 `true`,则 GoToSocial 实例将在用户名和昵称之外,同时在账户信息中发起搜索,来增强搜索结果。
in: query
name: following
type: boolean
produces:
- application/json
responses:
"200":
description: 搜索结果。
schema:
items:
$ref: '#/definitions/account'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:accounts
summary: 搜索账户
description: 搜索具有给定用户名或昵称的帐户。
tags:
- accounts
/api/v1/accounts/themes:
get:
operationId: accountThemes
produces:
- application/json
responses:
"200":
description: 主题的数组。
schema:
items:
$ref: '#/definitions/theme'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:accounts
summary: 查看主题
description: 查看此实例上可用于账户的预设 CSS 主题。
tags:
- accounts
/api/v1/accounts/update_credentials:
patch:
consumes:
- multipart/form-data
- application/x-www-form-urlencoded
- application/json
operationId: accountUpdate
parameters:
- description: 账户是否可被发现,并在用户名录中显示。
in: formData
name: discoverable
type: boolean
- description: 账户被标记为机器人。
in: formData
name: bot
type: boolean
- allowEmptyValue: true
description: 账户的昵称。
in: formData
name: display_name
type: string
- allowEmptyValue: true
description: 账户的简介。
in: formData
name: note
type: string
- description: 账户的头像。
in: formData
name: avatar
type: file
- allowEmptyValue: true
description: 账户的头像描述,用于 alt 文本。
in: formData
name: avatar_description
type: string
- description: 用户的资料页横幅背景。
in: formData
name: header
type: file
- allowEmptyValue: true
description: 用户资料页横幅背景的描述,用于 alt 文本。
in: formData
name: header_description
type: string
- description: 关注请求需要手动批准。
in: formData
name: locked
type: boolean
- description: 撰写的贴文的默认可见性。
in: formData
name: source[privacy]
type: string
- description: 将撰写的贴文默认标记为敏感。
in: formData
name: source[sensitive]
type: boolean
- description: 撰写的贴文的默认语言 (ISO 6391)。
in: formData
name: source[language]
type: string
- description: 撰写的贴文的默认内容类型 (text/plain 或 text/markdown)。
in: formData
name: source[status_content_type]
type: string
- description: 渲染此帐户的资料页或贴文时要使用的主题的文件名。主题必须存在于此服务器上,如 /api/v1/accounts/themes 所示。空字符串意味着取消主题偏好并回退到 GoToSocial 默认主题。
in: formData
name: theme
type: string
- description: 渲染此帐户的资料页或贴文时要使用的自定义 CSS。字符串长度不能超过 5,000 个字符(~5kb)。
in: formData
name: custom_css
type: string
- description: 为此帐户的公开贴文启用 RSS 订阅,端点为 `/[username]/feed.rss`。
in: formData
name: enable_rss
type: boolean
- description: 隐藏此帐户的关注/粉丝信息。
in: formData
name: hide_collections
type: boolean
- description: |-
Posts to show on the web view of the account.
"public": default, show only Public visibility posts on the web.
"unlisted": show Public *和* Unlisted visibility posts on the web.
"none": show no posts on the web, not even Public ones.
要在网页端展示的贴文范围。
"public": 默认,只在网页上显示公开的贴文。
"unlisted": 在网页上显示可见性为公开 *和* 不列出的贴文。
"none": 在网页上不显示任何贴文,甚至不显示公开的贴文。
in: formData
name: web_visibility
type: string
- description: |-
此账户使用的网页布局。
"microblog": 默认,经典的微博客布局。
"gallery": 仅显示媒体的画廊布局。
in: formData
name: web_layout
type: string
- description: 要添加到此帐户的资料页的第一个资料字段的名称。 (索引可以是任何字符串;添加更多索引以发送更多字段。)
in: formData
name: fields_attributes[0][name]
type: string
- description: 要添加到此帐户的资料页的第一个资料字段的值。 (索引可以是任何字符串;添加更多索引以发送更多字段。)
in: formData
name: fields_attributes[0][value]
type: string
- description: 要添加到此帐户的资料页的第二个资料字段的名称。
in: formData
name: fields_attributes[1][name]
type: string
- description: 要添加到此帐户的资料页的第二个资料字段的值。
in: formData
name: fields_attributes[1][value]
type: string
- description: 要添加到此帐户的资料页的第三个资料字段的名称。
in: formData
name: fields_attributes[2][name]
type: string
- description: 要添加到此帐户的资料页的第三个资料字段的值。
in: formData
name: fields_attributes[2][value]
type: string
- description: 要添加到此帐户的资料页的第四个资料字段的名称。
in: formData
name: fields_attributes[3][name]
type: string
- description: 要添加到此帐户的资料页的第四个资料字段的值。
in: formData
name: fields_attributes[3][value]
type: string
- description: 要添加到此帐户的资料页的第五个资料字段的名称。
in: formData
name: fields_attributes[4][name]
type: string
- description: 要添加到此帐户的资料页的第五个资料字段的值。
in: formData
name: fields_attributes[4][value]
type: string
- description: 要添加到此帐户的资料页的第六个资料字段的名称。
in: formData
name: fields_attributes[5][name]
type: string
- description: 要添加到此帐户的资料页的第六个资料字段的值。
in: formData
name: fields_attributes[5][value]
type: string
produces:
- application/json
responses:
"200":
description: 更新后的账户。
schema:
$ref: '#/definitions/account'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:accounts
summary: 更新账户信息
description: 更新你的账户信息。
tags:
- accounts
/api/v1/accounts/verify_credentials:
get:
operationId: accountVerify
produces:
- application/json
responses:
"200":
description: ""
schema:
$ref: '#/definitions/account'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:accounts
summary: 验证令牌
description: 验证令牌并返回与之相关的账户详细信息。
tags:
- accounts
/api/v1/admin/accounts:
get:
description: |-
使用特定的过滤规则查看 + 分页浏览已知的账户。
返回的账户将按域名 + 用户名的字母顺序(a-z)排序。
下一个和上一个查询可以从返回的 Link 标头中解析出来。
例如:
```
<https://example.org/api/v1/admin/accounts?limit=80&max_id=example.org%2F%40someone>; rel="next", <https://example.org/api/v1/admin/accounts?limit=80&min_id=example.org%2F%40someone_else>; rel="prev"
````
operationId: adminAccountsGetV1
parameters:
- default: false
description: 只显示本站账户的过滤规则。
in: query
name: local
type: boolean
- default: false
description: 只显示外站账户的过滤规则。
in: query
name: remote
type: boolean
- default: false
description: 只显示当前活跃的账户的过滤规则。
in: query
name: active
type: boolean
- default: false
description: 只显示当前待处理的账户的过滤规则。
in: query
name: pending
type: boolean
- default: false
description: 只显示当前被禁用的账户的过滤规则。
in: query
name: disabled
type: boolean
- default: false
description: 只显示当前被静音的账户的过滤规则。
in: query
name: silenced
type: boolean
- default: false
description: 只显示当前被封禁的账户的过滤规则。
in: query
name: suspended
type: boolean
- default: false
description: 只显示当前被强制标记为敏感的账户的过滤规则。
in: query
name: sensitized
type: boolean
- description: 搜索给定的用户名。
in: query
name: username
type: string
- description: 搜索给定的昵称。
in: query
name: display_name
type: string
- description: 搜索给定的域名。
in: query
name: by_domain
type: string
- description: 搜索具有给定电子邮箱的用户。
in: query
name: email
type: string
- description: 搜索具有给定 IP 地址的用户。
in: query
name: ip
type: string
- default: false
description: 搜索工作人员账户。
in: query
name: staff
type: boolean
- description: "`[domain]/@[username]` 中的 `max_id`。返回的所有结果都将在 `[domain]/@[username]` 之后的字母顺序中。例如,如果 `max_id` = `example.org/@someone`,则返回的条目可能包含 `example.org/@someone_else`、`later.example.org/@someone` 等。在此形式中,本站帐户 ID 使用空字符串作为 `[domain]` 部分,例如具有用户名 `someone` 的本地帐户将是 `/@someone`。"
in: query
name: max_id
type: string
- description: "`[domain]/@[username]` 中的 `min_id`。返回的所有结果都将在 `[domain]/@[username]` 之前的字母顺序中。例如,如果 `min_id` = `example.org/@someone`,则返回的条目可能包含 `example.org/@earlier_account`、`earlier.example.org/@someone` 等。在此形式中,本站帐户 ID 使用空字符串作为 `[domain]` 部分,例如具有用户名 `someone` 的本地帐户将是 `/@someone`。"
in: query
name: min_id
type: string
- default: 50
description: 要返回的最大结果数。
in: query
maximum: 200
minimum: 1
name: limit
type: integer
produces:
- application/json
responses:
"200":
description: ""
headers:
Link:
description: 下一/上一查询的链接。
type: string
schema:
items:
$ref: '#/definitions/adminAccountInfo'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:read:accounts
summary: 查看账户
tags:
- admin
/api/v1/admin/accounts/{id}:
get:
operationId: adminAccountGet
parameters:
- description: 账户的 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/adminAccountInfo'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:read:accounts
summary: 查看单个账户
description: 查看一个账户。
tags:
- admin
/api/v1/admin/accounts/{id}/action:
post:
consumes:
- multipart/form-data
operationId: adminAccountAction
parameters:
- description: 账户的 ID。
in: path
name: id
required: true
type: string
- description: 要执行的操作类型,目前仅支持 `suspend`。
in: formData
name: type
required: true
type: string
- description: 描述执行此操作的原因的文本,可不填。
in: formData
name: text
type: string
produces:
- application/json
responses:
"200":
description: OK
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"409":
description: '冲突: 已经有一个与此操作冲突的管理员操作正在执行。查看响应正文中的错误消息以获取更多信息。这是一个临时错误; 如果稍后再试一次,应该可以处理此操作。'
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:write:accounts
summary: 执行管理操作
description: 对某个账户执行管理员操作。
tags:
- admin
/api/v1/admin/accounts/{id}/approve:
post:
operationId: adminAccountApprove
parameters:
- description: 账户的 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 被批准后的账户。
schema:
$ref: '#/definitions/adminAccountInfo'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:write:accounts
summary: 批准账户
description: 批准待处理的账户。
tags:
- admin
/api/v1/admin/accounts/{id}/reject:
post:
operationId: adminAccountReject
parameters:
- description: 账户的 ID。
in: path
name: id
required: true
type: string
- description: 用于说明为什么拒绝此账户的评论。评论仅对管理员可见。
in: formData
name: private_comment
type: string
- description: 要包含在发送给申请人的电子邮件中的消息。仅在 send_email 为 true 时包含。
in: formData
name: message
type: string
- description: 向申请人发送一封电子邮件,告知他们的注册已被拒绝。
in: formData
name: send_email
type: boolean
produces:
- application/json
responses:
"200":
description: 被拒绝的账户。
schema:
$ref: '#/definitions/adminAccountInfo'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:write:accounts
summary: 拒绝账户
description: 拒绝待处理的账户。
tags:
- admin
/api/v1/admin/custom_emojis:
get:
description: |-
下一个/上一个查询可以从返回的 Link 标头中解析。
例如:
`<http://localhost:8080/api/v1/admin/custom_emojis?limit=30&max_shortcode_domain=yell@fossbros-anonymous.io&filter=domain:all>; rel="next", <http://localhost:8080/api/v1/admin/custom_emojis?limit=30&min_shortcode_domain=rainbow@&filter=domain:all>; rel="prev"`
operationId: emojisGet
parameters:
- default: domain:all
description: |-
查看本站表情和已知的外站表情。
要应用到结果中的过滤规则列表,以逗号分隔。可被识别的过滤规则有:
`domain:[domain]` -- 显示给定域名下的表情,例如 `?filter=domain:example.org` 将只显示 `example.org` 的表情。
除了给定特定域名外,还可以给出关键字 `local` 或 `all`,以仅显示本站表情 (`domain:local`) 或显示所有实例的所有表情 (`domain:all`)。
注意:`domain:*` 等同于 `domain:all`(包括本站)。
如果未提供域名过滤规则,则将假定 `domain:all`。
`disabled` -- 包括已禁用的表情。
`enabled` -- 包括已启用的表情。
`shortcode:[shortcode]` -- 仅显示给定的表情代码,例如 `?filter=shortcode:blob_cat_uwu` 将仅显示表情代码为 `blob_cat_uwu` 的表情(区分大小写)。
如果未提供 `disabled` 或 `enabled`,则将同时显示已禁用和已启用的表情。
如果未提供过滤规则,则将使用默认的 `domain:all`,它将显示所有实例的所有表情。
in: query
name: filter
type: string
- default: 50
description: 要返回的表情数量。小于 1 或未设置表示无限制(所有表情)。
in: query
maximum: 200
minimum: 0
name: limit
type: integer
- description: |-
只返回比给定 `[shortcode]@[domain]` *更低*(按字母顺序)的表情。例如,如果 `max_shortcode_domain=beep@example.org`,则返回的值可能包括 `[shortcode]@[domain]` 为 `car@example.org`, `debian@aaa.com`, `test@` (本站表情) 等。
具有给定 `[shortcode]@[domain]` 的表情将不包含在结果集中。
in: query
name: max_shortcode_domain
type: string
- description: |-
只返回比给定 `[shortcode]@[domain]` *更高*(按字母顺序)的表情。例如,如果 `max_shortcode_domain=beep@example.org`, 则返回的值可能包括 `[shortcode]@[domain]` 为 `arse@test.com`, `0101_binary@hackers.net`, `bee@` (本站表情) 等。
具有给定 `[shortcode]@[domain]` 的表情将不包含在结果集中。
in: query
name: min_shortcode_domain
type: string
produces:
- application/json
responses:
"200":
description: 表情数组,按表情代码和域名字母顺序排列。
headers:
Link:
description: 下一/上一查询的链接。
type: string
schema:
items:
$ref: '#/definitions/adminEmoji'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:read
summary: 查看表情
tags:
- admin
post:
consumes:
- multipart/form-data
operationId: emojiCreate
parameters:
- description: 此表情的代码,将被实例居民用于选定对应表情。此代码在实例上必须是唯一的。
in: formData
name: shortcode
pattern: \w{1,30}
required: true
type: string
- description: 此表情的 png 或 gif 图像。动画 png 也可以!为了确保与其他 fedi 实现的兼容性,默认情况下表情大小限制为 50kb。
in: formData
name: image
required: true
type: file
- description: 此表情所属的类别。如果留空,表情将不属于任何类别。如果给定的类别名称尚不存在,则将创建该类别。
in: formData
name: category
type: string
produces:
- application/json
responses:
"200":
description: 新创建的表情。
schema:
$ref: '#/definitions/emoji'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"409":
description: 冲突 -- 此表情的代码已被使用
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:write
summary: 创建表情
description: 上传和创建一个新的实例表情。
tags:
- admin
/api/v1/admin/custom_emojis/{id}:
delete:
description: |-
在此实例删除一个 **本地** 表情。
给定 ID 的表情将不再在此实例上可用。
如果您只想更新表情图像,请使用 `/api/v1/admin/custom_emojis/{id}` PATCH 路由。
要禁用 **外站** 实例的表情,请使用 `/api/v1/admin/custom_emojis/{id}` PATCH 路由。
operationId: emojiDelete
parameters:
- description: 表情的 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 被删除的表情将被返回给调用者,以便进一步处理。
schema:
$ref: '#/definitions/adminEmoji'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:write
summary: 删除表情
tags:
- admin
get:
operationId: emojiGet
parameters:
- description: 表情的 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 单个表情。
schema:
$ref: '#/definitions/adminEmoji'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:read
summary: 查看表情
description: 在管理视图中查看单个表情。
tags:
- admin
patch:
consumes:
- multipart/form-data
description: |-
对一个 **本站** 或 **外站** 表情执行管理操作。
要执行的操作取决于提供的操作类型 `type` 参数。
`disable`: 禁用一个 **外站** 表情,使其无法在此实例上使用/显示。不适用于本站表情。
`copy`: 将 **外站** 表情复制到此实例。执行此操作时,必须提供一个表情代码,并且它必须在此实例上已有的表情中是唯一的。可以提供一个类别,然后复制的表情将被放入提供的类别中。
`modify`: 修改一个 **本站** 表情。您可以为表情提供一个新的图像和/或更新类别。
本站表情不能使用此端点删除。要删除本站表情,请查看 DELETE /api/v1/admin/custom_emojis/{id}。
operationId: emojiUpdate
parameters:
- description: 表情的 ID。
in: path
name: id
required: true
type: string
- description: |-
要执行的操作类型。需为下列其中之一:(`disable`, `copy`, `modify`)。
对于 **外站** 表情,支持 `copy` 或 `disable`。
对于 **本站** 表情,仅支持 `modify`。
enum:
- copy
- disable
- modify
in: formData
name: type
required: true
type: string
- description: 用于表情的代码,将被实例居民用于选定表情。此代码在实例上必须是唯一的。仅适用于 `copy` 操作类型。
in: formData
name: shortcode
pattern: \w{1,30}
type: string
- description: 此表情的新 png 或 gif 图像。动画 png 也可以!为了确保与其他 fedi 实现的兼容性,默认情况下表情大小限制为 50kb。仅适用于 **本站** 表情。
in: formData
name: image
type: file
- description: 表情所属的类别。如果尚不存在具有给定名称的类别,则将创建该类别。仅适用于 `copy` 和 `modify` 操作类型。
in: formData
name: category
type: string
produces:
- application/json
responses:
"200":
description: 更新后的表情。
schema:
$ref: '#/definitions/adminEmoji'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:write
summary: 修改表情
tags:
- admin
/api/v1/admin/custom_emojis/categories:
get:
operationId: emojiCategoriesGet
produces:
- application/json
responses:
"200":
description: 现有表情类别的数组。
schema:
items:
$ref: '#/definitions/emojiCategory'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:read
summary: 查看表情类别
description: 获取现有表情类别的列表。
tags:
- admin
/api/v1/admin/debug/apurl:
get:
description: 对指定的 ActivityPub URL 执行 GET 请求,并返回详细的调试信息。仅当 GoToSocial 使用 DEBUG=1 标志构建和运行时才启用/公开。
operationId: debugAPUrl
parameters:
- description: 要解析的 URL 或 ActivityPub ID。 如 `https://example.org/users/someone`
in: query
name: url
required: true
type: string
produces:
- application/json
responses:
"200":
description: ""
schema:
$ref: '#/definitions/debugAPUrlResponse'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:write
summary: 解析 ActivityPub URL
tags:
- debug
/api/v1/admin/debug/caches/clear:
post:
description: 清除所有内存中的缓存。仅当 GoToSocial 使用 DEBUG=1 标志构建和运行时才启用/公开。
operationId: debugClearCaches
produces:
- application/json
responses:
"200":
description: 所有缓存都已清除。
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:write
summary: 清除缓存
tags:
- debug
/api/v1/admin/domain_allows:
get:
operationId: domainAllowsGet
parameters:
- description: 如果设为 `true`,则返回的实例白名单列表中的每个条目将仅包含字段 `domain` 和 `public_comment`。这对于当您想要保存和共享您实例上允许的所有域名的列表时非常有用,以便其他人可以轻松导入它们,但您不希望他们看到您的允许的数据库 ID,或私人评论等。
in: query
name: export
type: boolean
produces:
- application/json
responses:
"200":
description: 目前所有被允许的域名。
schema:
items:
$ref: '#/definitions/domainPermission'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:read:domain_allows
summary: 查看实例白名单
description: 查看当前所有被允许联合的域名。
tags:
- admin
post:
consumes:
- multipart/form-data
description: |-
从字符串或文件中创建一个或多个实例白名单。
在使用此端点时,您有两个选项:要么将 `import` 设置为 `true` 并上传一个包含多个要允许的域名的 JSON 文件,要么将 `import` 设置为 `false`,并添加一条要允许的域名。
JSON 文件的格式应该类似于:`[{"domain":"example.org"},{"domain":"whatever.com","public_comment":"它们是我的好厚米"}]`
operationId: domainAllowCreate
parameters:
- default: false
description: 表示正在导入一个包含多个要允许的域名的文件。如果设置为 `true`,则 `domains` 必须作为 JSON 格式的文件存在。如果设置为 `false`,则 `domains` 将被忽略,`domain` 必须存在。
in: query
name: import
type: boolean
- description: JSON 格式的实例白名单列表。仅在 `import` 设置为 `true` 时使用。
in: formData
name: domains
type: file
- description: 要允许的单个域名。仅在 `import` 不是 `true` 时使用。
in: formData
name: domain
type: string
- description: 在公开时对域名的名称进行混淆。例如,`example.org` 变成类似于 `ex***e.org`。仅在 `import` 不是 `true` 时使用。
in: formData
name: obfuscate
type: boolean
- description: 有关此实例白名单的公共评论。如果选择共享允许,则此评论将显示在实例白名单旁边。仅在 `import` 不是 `true` 时使用。
in: formData
name: public_comment
type: string
- description: 有关此实例白名单的私人评论。仅显示给其他管理员,因此这是一个有用的内部方法,用于跟踪为什么某个域名最终被允许。仅在 `import` 不是 `true` 时使用。
in: formData
name: private_comment
type: string
produces:
- application/json
responses:
"200":
description: 如果 `import` != `true`,则返回新创建的实例白名单。如果导入了列表,则将返回新创建的实例白名单的 `array` (数组)。
schema:
$ref: '#/definitions/domainPermission'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"409":
description: '冲突: 已经有一个与此操作冲突的管理员操作正在执行。查看响应正文中的错误消息以获取更多信息。这是一个临时错误; 如果稍后再试一次,应该可以处理此操作。'
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:write:domain_allows
summary: 创建实例白名单
tags:
- admin
/api/v1/admin/domain_allows/{id}:
delete:
operationId: domainAllowDelete
parameters:
- description: 实例白名单条目的 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 刚刚删除的实例白名单条目。
schema:
$ref: '#/definitions/domainPermission'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"409":
description: '冲突: 已经有一个与此操作冲突的管理员操作正在执行。查看响应正文中的错误消息以获取更多信息。这是一个临时错误; 如果稍后再试一次,应该可以处理此操作。'
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:write:domain_allows
summary: 删除实例白名单条目
description: 删除具有给定 ID 的实例白名单条目。
tags:
- admin
get:
operationId: domainAllowGet
parameters:
- description: 实例白名单条目的 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 请求的实例白名单条目。
schema:
$ref: '#/definitions/domainPermission'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:read:domain_allows
summary: 查看实例白名单条目
description: 查看具有给定 ID 的实例白名单条目。
tags:
- admin
put:
consumes:
- multipart/form-data
operationId: domainAllowUpdate
parameters:
- description: 实例白名单条目的 ID。
in: path
name: id
required: true
type: string
- description: 公开展示时对域名进行混淆。例如,`example.org` 将变为类似于 `ex***e.org` 的文本。
in: formData
name: obfuscate
type: boolean
- description: 对该实例白名单条目的公开评论。当选择公开白名单时,此评论将显示在对应的实例白名单条目旁边。
in: formData
name: public_comment
type: string
- description: 对该实例白名单条目的私密评论。仅显示给其他管理员,因此这是一个有用的内部方法,可用于跟踪为什么某个域名最终被允许。
in: formData
name: private_comment
type: string
produces:
- application/json
responses:
"200":
description: 更新后的实例白名单条目。
schema:
$ref: '#/definitions/domainPermission'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:write:domain_allows
summary: 更新单个实例白名单条目
tags:
- admin
/api/v1/admin/domain_blocks:
get:
operationId: domainBlocksGet
parameters:
- description: 如果设为 `true`,则返回的实例黑名单的每个条目将仅包含字段 `domain` 和 `public_comment`。这对于当您想要保存和共享您实例上阻止的所有实例的列表时非常有用,以便其他人可以轻松导入它们,但您不希望他们看到您的黑名单的数据库 ID,或私人评论等。
in: query
name: export
type: boolean
produces:
- application/json
responses:
"200":
description: 目前所有的实例黑名单。
schema:
items:
$ref: '#/definitions/domainPermission'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:read:domain_blocks
summary: 查看实例黑名单
description: 查看当前所有实例黑名单。
tags:
- admin
put:
consumes:
- multipart/form-data
operationId: domainBlockUpdate
parameters:
- description: 实例黑名单条目的 ID。
in: path
name: id
required: true
type: string
- description: 公开展示时对域名进行混淆。例如,`example.org` 将变成类似于 `ex***e.org`。
in: formData
name: obfuscate
type: boolean
- description: 对此实例黑名单条目的公开评论。如果选择公开黑名单,此评论将显示在对应的实例黑名单条目旁边。
in: formData
name: public_comment
type: string
- description: 对此实例黑名单条目的私密评论。仅显示给其他管理员,因此这是一个有用的内部方法,用于追踪为什么某个域名最终被屏蔽。
in: formData
name: private_comment
type: string
produces:
- application/json
responses:
"200":
description: 更新后的实例黑名单条目。
schema:
$ref: '#/definitions/domainPermission'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止访问
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:write:domain_blocks
summary: 更新单个实例黑名单条目
tags:
- admin
post:
consumes:
- multipart/form-data
description: |-
从字符串或文件中创建一个或多个实例黑名单条目。
使用此端点时,您有两个选项:要么将 `import` 设置为 `true` 并上传一个包含多个要阻止联合的实例的 JSON 文件,要么将 `import` 设置为 `false`,并添加一个要阻止的实例。
JSON 文件的格式应该类似于:`[{"domain":"example.org"},{"domain":"whatever.com","public_comment":"它们不是我的好厚米"}]`
operationId: domainBlockCreate
parameters:
- default: false
description: 表示正在导入一个包含多个要阻止联合的实例的文件。如果设置为 `true`,则 `domains` 必须作为 JSON 格式的文件存在。如果设置为 `false`,则 `domains` 将被忽略,`domain` 必须存在。
in: query
name: import
type: boolean
- description: 要导入的 JSON 格式的实例黑名单。仅在 `import` 设置为 `true` 时使用。
in: formData
name: domains
type: file
- description: 单个要阻止联合的实例。仅在 `import` 不是 `true` 时使用。
in: formData
name: domain
type: string
- description: 对外公开时对域名进行混淆。例如,`example.org` 变成类似于 `ex***e.org`。仅在 `import` 不是 `true` 时使用。
in: formData
name: obfuscate
type: boolean
- description: 对此实例黑名单条目的公开评论。如果选择共享阻止,此评论将显示在实例黑名单条目旁边。仅在 `import` 不是 `true` 时使用。
in: formData
name: public_comment
type: string
- description: 对此实例黑名单条目的私人评论。仅显示给其他管理员,因此这是一个有用的内部方法,用于跟踪为什么某个域名最终被阻止。仅在 `import` 不是 `true` 时使用。
in: formData
name: private_comment
type: string
produces:
- application/json
responses:
"200":
description: 如果 `import` != `true`,则返回新创建的实例黑名单条目。如果导入了列表,则将返回新创建的实例黑名单的 `array` (数组)。
schema:
$ref: '#/definitions/domainPermission'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"409":
description: '冲突: 已经有一个与此操作冲突的管理员操作正在执行。查看响应正文中的错误消息以获取更多信息。这是一个临时错误; 如果稍后再试一次,应该可以处理此操作。'
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:write:domain_blocks
summary: 创建实例黑名单
tags:
- admin
/api/v1/admin/domain_blocks/{id}:
delete:
operationId: domainBlockDelete
parameters:
- description: 实例黑名单条目的 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 刚刚删除的实例黑名单条目。
schema:
$ref: '#/definitions/domainPermission'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"409":
description: '冲突: 已经有一个与此操作冲突的管理员操作正在执行。查看响应正文中的错误消息以获取更多信息。这是一个临时错误; 如果稍后再试一次,应该可以处理此操作。'
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:write:domain_blocks
summary: 删除实例黑名单条目
description: 删除具有给定 ID 的实例黑名单条目。
tags:
- admin
get:
operationId: domainBlockGet
parameters:
- description: 实例黑名单条目的 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 请求的实例黑名单条目。
schema:
$ref: '#/definitions/domainPermission'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:read:domain_blocks
summary: 查看实例黑名单条目
description: 查看具有给定 ID 的实例黑名单条目。
tags:
- admin
/api/v1/admin/domain_keys_expire:
post:
consumes:
- multipart/form-data
description: |-
将指定域名的所有帐户的缓存公钥强制吊销,这些公钥存储在您的数据库中。
当外站实例不得不轮转其密钥时(出于安全问题、数据泄漏、例行安全程序等原因),此功能非常有用,您的实例无法使用缓存的密钥与其正常通信。以这种方式标记为过期的密钥将在下次由该密钥所有者签名的请求发送到您的实例时进行懒惰重新获取,因此不需要进一步操作即可重新建立与该域的通信。
此端点务必不能用于轮转您自己的密钥,它仅适用于外站实例。
使用此端点来吊销尚未轮转所有密钥的实例的密钥既不会有害,也不会破坏联合,但是毫无意义,会导致不必要的请求执行。
operationId: domainKeysExpire
parameters:
- description: |-
要吊销密钥的实例域名。
例如:example.org
in: formData
name: domain
type: string
x-go-name: Domain
produces:
- application/json
responses:
"202":
description: 请求已接受并将被处理。检查日志以查看进度/错误。
schema:
$ref: '#/definitions/adminActionResponse'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"409":
description: '冲突: 已经有一个与此操作冲突的管理员操作正在执行。查看响应正文中的错误消息以获取更多信息。这是一个临时错误; 如果稍后再试一次,应该可以处理此操作。'
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:write
summary: 吊销实例密钥
tags:
- admin
/api/v1/admin/domain_permission_drafts:
get:
description: |-
该端点将返回按时间倒序排序(最新优先),并带有连续 ID 的域名权限草案(ID 值越大,草稿越新)。可以通过返回的 Link 标头解析下一页与上一页查询。
示例:
```
<https://example.org/api/v1/admin/domain_permission_drafts?limit=20&max_id=01FC0SKA48HNSVR6YKZCQGS2V8>; rel="next", <https://example.org/api/v1/admin/domain_permission_drafts?limit=20&min_id=01FC0SKW5JK2Q4EVAV2B462YY0>; rel="prev"
````
operationId: domainPermissionDraftsGet
parameters:
- description: 仅显示给定订阅 ID 创建的草案。
in: query
name: subscription_id
type: string
- description: 仅显示针对特定域名的草案。
in: query
name: domain
type: string
- description: 筛选“屏蔽”与“放行”类型的草案。
in: query
name: permission_type
type: string
- description: 仅返回早于给定 max ID 的条目(用于向下分页)。具有对应 ID 的条目不会包含在响应中。
in: query
name: max_id
type: string
- description: 仅返回晚于给定 since ID 的条目(用于向上分页)。具有对应 ID 的条目不会包含在响应中。
in: query
name: since_id
type: string
- description: 仅返回相邻且晚于给定 min ID 的条目(用于向上分页)。具有对应 ID 的条目不会包含在响应中。
in: query
name: min_id
type: string
- default: 20
description: 要返回的条目数量。
in: query
maximum: 100
minimum: 1
name: limit
type: integer
produces:
- application/json
responses:
"200":
description: 域名权限草案。
headers:
Link:
description: 下一查询与上一查询的链接。
type: string
schema:
items:
$ref: '#/definitions/domainPermission'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:read
summary: 查看域名权限草案。
tags:
- admin
post:
consumes:
- multipart/form-data
- application/json
operationId: domainPermissionDraftCreate
parameters:
- description: 该草案要针对的域名。
in: formData
name: domain
type: string
- description: 草案类型为“放行”或“屏蔽”。
in: formData
name: permission_type
type: string
- description: 对外公开展示时混淆具体域名。例如:`example.org` 将变为类似 `ex***e.org` 的字符串。
in: formData
name: obfuscate
type: boolean
- description: 对此域名权限的公开评注。若您选择分享此权限设定,此评注将与权限条目一起显示。
in: formData
name: public_comment
type: string
- description: 对此域名权限的私人评注。仅显示给其他管理员,因此这是一个可用于记录为什么某个域名最终被添加此权限设定的有用的内部手段。
in: formData
name: private_comment
type: string
produces:
- application/json
responses:
"200":
description: 新创建的域名权限草案。
schema:
$ref: '#/definitions/domainPermission'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止访问
"406":
description: not acceptable 不可接受
"409":
description: conflict 冲突
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:write
summary: 使用给定参数创建一条域名权限草案。
tags:
- admin
/api/v1/admin/domain_permission_drafts/{id}:
get:
operationId: domainPermissionDraftGet
parameters:
- description: 域名权限草案的 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 域名权限草案。
schema:
$ref: '#/definitions/domainPermission'
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止访问
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:read
summary: 获取具有给定 ID 的域名权限草案。
tags:
- admin
/api/v1/admin/domain_permission_drafts/{id}/accept:
post:
consumes:
- multipart/form-data
- application/json
operationId: domainPermissionDraftAccept
parameters:
- description: 域名权限草案的 ID。
in: path
name: id
required: true
type: string
- default: false
description: 若已经存在一条具有相同域名与权限设定类型的草案,使用新草案的字段覆盖现有权限设定。
in: formData
name: overwrite
type: boolean
produces:
- application/json
responses:
"200":
description: 新创建的域名权限草案。
schema:
$ref: '#/definitions/domainPermission'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止访问
"406":
description: not acceptable 不可接受
"409":
description: conflict 冲突
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:write
summary: 接受一条域名权限草案,将其转换为会得到强制执行的域名权限。
tags:
- admin
/api/v1/admin/domain_permission_drafts/{id}/remove:
post:
consumes:
- multipart/form-data
- application/json
operationId: domainPermissionDraftRemove
parameters:
- description: 域名权限草案的 ID。
in: path
name: id
required: true
type: string
- default: false
description: 删除此域名权限草案时,为目标域名创建一个域名例外条目,以确保之后不会为此域名创建草案。
in: formData
name: exclude_target
type: boolean
produces:
- application/json
responses:
"200":
description: 被移除的域名权限草案。
schema:
$ref: '#/definitions/domainPermission'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止访问
"406":
description: not acceptable 不可接受
"409":
description: conflict 冲突
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:write
summary: 移除一条域名权限草案,可选择忽略所有之后的针对给定域名的草案。
tags:
- admin
/api/v1/admin/domain_permission_excludes:
get:
description: |-
返回按时间倒序排序(新创建的条目优先),并带有连续 ID 的域名权限例外条目(ID 值越大,例外条目越新)。可以通过返回的 Link 标头解析下一页与上一页查询。
示例:
```
<https://example.org/api/v1/admin/domain_permission_excludes?limit=20&max_id=01FC0SKA48HNSVR6YKZCQGS2V8>; rel="next", <https://example.org/api/v1/admin/domain_permission_excludes?limit=20&min_id=01FC0SKW5JK2Q4EVAV2B462YY0>; rel="prev"
```
operationId: domainPermissionExcludesGet
parameters:
- description: 仅返回针对给定域名的例外条目。
in: query
name: domain
type: string
- description: 仅返回比给定 max ID 新的条目(用于向下分页)。具有对应 ID 的条目不会包含在响应中。
in: query
name: max_id
type: string
- description: 仅返回比给定 since ID 新的条目(用于向上分页)。具有对应 ID 的条目不会包含在响应中。
in: query
name: since_id
type: string
- description: 仅返回比给定 min ID 相邻且更新的条目(用于向上分页)。具有对应 ID 的条目不会包含在响应中。
in: query
name: min_id
type: string
- default: 20
description: 要返回的条目数量。
in: query
maximum: 100
minimum: 1
name: limit
type: integer
produces:
- application/json
responses:
"200":
description: 域名权限例外条目。
headers:
Link:
description: 下一查询与上一查询的链接。
type: string
schema:
items:
$ref: '#/definitions/domainPermission'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止访问
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:read
summary: 查看域名权限例外条目。
tags:
- admin
post:
consumes:
- multipart/form-data
- application/json
description: |-
被设为例外的域名(及其子域名)在导入或订阅域名权限列表时不会被自动阻止或允许。
您仍然可以为被设为例外的域名手动创建域名阻止条目或域名允许条目,被设为例外之后,与该域名关联的任何的已有或新创建的域名阻止条目或域名允许条目都将被继续执行。
operationId: domainPermissionExcludeCreate
parameters:
- description: 要创建的权限例外条目的目标域名。
in: formData
name: domain
type: string
- description: 对该域名例外条目的私密评论。
in: formData
name: private_comment
type: string
produces:
- application/json
responses:
"200":
description: 新创建的域名例外条目。
schema:
$ref: '#/definitions/domainPermission'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止访问
"406":
description: not acceptable 不可接受
"409":
description: conflict 冲突
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:write
summary: 使用给定参数创建一个域名权限例外条目。
tags:
- admin
/api/v1/admin/domain_permission_excludes/{id}:
delete:
operationId: domainPermissionExcludeDelete
parameters:
- description: 该域名权限例外条目的 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 被移除的域名权限例外条目。
schema:
$ref: '#/definitions/domainPermission'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止访问
"406":
description: not acceptable 不可接受
"409":
description: conflict 冲突
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:write
summary: 移除一个域名权限例外条目。
tags:
- admin
get:
operationId: domainPermissionExcludeGet
parameters:
- description: 域名权限例外条目的 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 域名权限例外条目。
schema:
$ref: '#/definitions/domainPermission'
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止访问
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:read
summary: 获取具有给定 ID 的域名权限例外条目。
tags:
- admin
/api/v1/admin/domain_permission_subscriptions:
get:
description: |-
订阅将按时间倒序返回(最新的订阅在前),并带有连续的 ID (值越大代表订阅越新)。
可以通过返回的 Link 标头解析下一页与上一页查询。
示例:
```
<https://example.org/api/v1/admin/domain_permission_subscriptions?limit=20&max_id=01FC0SKA48HNSVR6YKZCQGS2V8>; rel="next", <https://example.org/api/v1/admin/domain_permission_subscriptions?limit=20&min_id=01FC0SKW5JK2Q4EVAV2B462YY0>; rel="prev"
````
operationId: domainPermissionSubscriptionsGet
parameters:
- description: 筛选类型为“阻止”或“允许”的订阅。
in: query
name: permission_type
type: string
- description: 仅返回 ID 小于给定的最大 ID 的条目(用于向下分页)。具有对应 ID 的条目不会包含在结果中。
in: query
name: max_id
type: string
- description: 仅返回 ID 大于给定的最小 ID 的条目(用于向上分页)。具有对应 ID 的条目不会包含在结果中。
in: query
name: since_id
type: string
- description: 仅返回 ID 比指定最小 ID 相邻且*更新* 的条目(用于向上分页)。具有对应 ID 的条目不会包含在结果中。
in: query
name: min_id
type: string
- default: 20
description: 要返回的条目数量。
in: query
maximum: 100
minimum: 1
name: limit
type: integer
produces:
- application/json
responses:
"200":
description: 域名权限订阅列表。
headers:
Link:
description: 下一查询与上一查询的链接
type: string
schema:
items:
$ref: '#/definitions/domainPermissionSubscription'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止访问
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:read
summary: 查看域名权限订阅列表
tags:
- admin
post:
consumes:
- multipart/form-data
- application/json
operationId: domainPermissionSubscriptionCreate
parameters:
- default: 0
description: 此订阅相对于其他同类型的订阅的优先级。取值范围为 0-255 (数值越高,优先级越高)。优先级较高的订阅将会覆盖优先级较低的订阅生成的权限。当两个订阅的`priority`(优先级)值相同时,优先级无法确定,因此建议始终手动设置此值。
in: formData
maximum: 255
minimum: 0
name: priority
type: number
- description: 此订阅的标题(可选)
in: formData
name: title
type: string
- description: 解析订阅列表/订阅目标文件时要创建的域名权限类型。需要为 "allow" 或 "block"。
in: formData
name: permission_type
required: true
type: string
- default: true
description: 如果为 true,此订阅产生的域名权限条目将以草稿形式创建,须管理员批准后才能生效。如果为 false,此订阅下的域名权限条目将立即生效。默认为 true。
in: formData
name: as_draft
type: boolean
- default: false
description: '若为 true,则此域名权限订阅将“接管”实例上已存在的、符合以下条件的域名权限: 1)它们没有关联的订阅 ID(即,它们是“孤立”的), 2)它们存在于订阅列表中。这些孤立的域名权限条目将被关联到此订阅的订阅 ID,并由此订阅管理。'
in: formData
name: adopt_orphans
type: boolean
- description: 此订阅要获取的权限列表的 URI。
in: formData
name: uri
required: true
type: string
- description: 此订阅要使用的 MIME 内容类型。可以为 "text/plain"、"text/csv" 或 "application/json"。
in: formData
name: content_type
required: true
type: string
- description: 可选的基本身份验证(Basic Auth)用户名,用于获取指定 URI。如果设置,则在获取时会与 `fetch_password` 一起传输。
in: formData
name: fetch_username
type: string
- description: 可选的基本身份验证(Basic Auth)密码,用于获取指定 URI。如果设置,则在获取时会与 `fetch_username` 一起传输。
in: formData
name: fetch_password
type: string
produces:
- application/json
responses:
"200":
description: 新创建的域名权限订阅。
schema:
$ref: '#/definitions/domainPermissionSubscription'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止访问
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:write
summary: 创建域名权限订阅
description: 使用给定参数创建一个新的域名权限订阅。
tags:
- admin
/api/v1/admin/domain_permission_subscriptions/${id}:
patch:
consumes:
- multipart/form-data
- application/json
operationId: domainPermissionSubscriptionUpdate
parameters:
- description: 域名权限订阅的 ID。
in: path
name: id
required: true
type: string
- description: 此订阅相对于其他同类型的订阅的优先级。取值范围为 0-255 (数值越高,优先级越高)。优先级较高的订阅将会覆盖优先级较低的订阅生成的权限。当两个订阅的`priority`(优先级)值相同时,优先级无法确定,因此建议始终手动设置此值。
in: formData
maximum: 255
minimum: 0
name: priority
type: number
- description: 此订阅的标题(可选)。
in: formData
name: title
type: string
- description: 此订阅要获取的域名权限列表的 URI。
in: formData
name: uri
type: string
- default: true
description: 如果为 true,此订阅产生的域名权限条目将以草稿形式创建,须管理员批准后才能生效。如果为 false,此订阅下的域名权限条目将立即生效。默认为 true。
in: formData
name: as_draft
type: boolean
- default: false
description: '若为 true,则此域名权限订阅将“接管”实例上已存在的、符合以下条件的域名权限: 1)它们没有关联的订阅 ID(即,它们是“孤立”的), 2)它们存在于订阅列表中。这些孤立的域名权限条目将被关联到此订阅的订阅 ID,并由此订阅管理。'
in: formData
name: adopt_orphans
type: boolean
- description: 此订阅要使用的 MIME 内容类型。可以为 "text/plain"、"text/csv" 或 "application/json"。
in: formData
name: content_type
type: string
- description: 可选的基本身份验证(Basic Auth)用户名,用于获取指定 URI。如果设置,则在获取时会与 `fetch_password` 一起传输。
in: formData
name: fetch_username
type: string
- description: 可选的基本身份验证(Basic Auth)密码,用于获取指定 URI。如果设置,则在获取时会与 `fetch_username` 一起传输。
in: formData
name: fetch_password
type: string
produces:
- application/json
responses:
"200":
description: 更新后的域名权限订阅。
schema:
$ref: '#/definitions/domainPermissionSubscription'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止访问
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:write
summary: 更新域名权限订阅
description: 使用给定参数更新一个域名权限订阅。
tags:
- admin
/api/v1/admin/domain_permission_subscriptions/{id}:
get:
operationId: domainPermissionSubscriptionGet
parameters:
- description: 域名权限订阅的 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 要获取的域名权限订阅。
schema:
$ref: '#/definitions/domainPermissionSubscription'
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止访问
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:read
summary: 获取指定域名权限订阅
description: 获取具有给定 ID 的单个域名权限订阅。
tags:
- admin
/api/v1/admin/domain_permission_subscriptions/{id}/remove:
post:
consumes:
- multipart/form-data
- application/json
operationId: domainPermissionSubscriptionRemove
parameters:
- description: 域名权限订阅的 ID。
in: path
name: id
required: true
type: string
- default: true
description: |-
移除域名权限订阅时,也应移除此订阅的子条目,即由该订阅管理的域名权限。如果为否,则子条目将成为孤立条目,但不会被移除。
请注意,已被移除的权限条目可能稍后会被另一个优先级低于已移除订阅的域名权限订阅重新创建。同样地,孤立子项也可能稍后被另一个订阅接收。
in: formData
name: remove_children
type: boolean
produces:
- application/json
responses:
"200":
description: 被移除的域名权限订阅。
schema:
$ref: '#/definitions/domainPermissionSubscription'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止访问
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:write
summary: 删除单个域名权限订阅
tags:
- admin
/api/v1/admin/domain_permission_subscriptions/{id}/test:
post:
description: |-
让你的实例获取并解析域名权限订阅列表,来测试单个域名权限订阅,*无需实际创建权限*。
响应体将为一个该订阅*将会*创建的域权限列表,或是一条错误消息。
这在你需要检查你的实例是否能够实际获取和解析列表的情况下非常有用。
operationId: domainPermissionSubscriptionTest
parameters:
- description: 该域名权限订阅草稿的 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 一个域名权限条目的数组,或一个说明为何无法获取该列表的,形如 `{"error":"[错误信息]"}` 的错误消息。
schema:
items:
$ref: '#/definitions/domain'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止访问
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:write
summary: 测试单个域名权限订阅
tags:
- admin
/api/v1/admin/domain_permission_subscriptions/preview:
get:
description: 查看给定权限类型的全部域名权限订阅,按优先级顺序排列(从高到低)。此视图可显示实际被获取和创建的域名权限订阅的顺序。
operationId: domainPermissionSubscriptionsPreviewGet
parameters:
- description: 筛选类型为 "block" 或 "allow" 的订阅。
in: query
name: permission_type
required: true
type: string
produces:
- application/json
responses:
"200":
description: 域名权限订阅列表。
schema:
items:
$ref: '#/definitions/domainPermissionSubscription'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止访问
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:read
summary: 预览全部域名权限订阅
tags:
- admin
/api/v1/admin/email/test:
post:
consumes:
- multipart/form-data
description: |-
向指定的电子邮件地址发送一封通用的测试电子邮件。
这可以用来验证实例的 SMTP 配置,并调试任何潜在问题。
如果 SMTP 连接返回错误,此处理程序将返回代码 422,以指示请求无法处理,并将 SMTP 错误返回给调用者。
operationId: testEmailSend
parameters:
- description: 要发送测试电子邮件的电子邮件地址。
in: formData
name: email
required: true
type: string
- description: 要包含在电子邮件中的消息,可不填。
in: formData
name: message
type: string
produces:
- application/json
responses:
"202":
description: 测试邮件已发送。
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"422":
description: 尝试发件时发生了一个 smtp 错误。检查返回的 json 以获取更多信息。将包含 smtp 错误,以帮助您调试与 smtp 服务器的通信。
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:write
summary: 测试电子邮件
tags:
- admin
/api/v1/admin/header_allows:
get:
operationId: headerFilterAllowsGet
responses:
"200":
description: 目前所有的标头 "allow" (放行) 过滤规则。
schema:
items:
$ref: '#/definitions/headerFilter'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:read
summary: 查看标头放行规则
description: 查看当前所有 "allow" (放行) 过滤规则。
tags:
- admin
post:
consumes:
- application/json
- application/xml
- application/x-www-form-urlencoded
description: |-
创建一条新的 "allow" (放行) HTTP 请求标头过滤规则。
若 Content-Type 为 'application/json',则参数也可以在请求体中以 JSON 形式给出。
若 Content-Type 为 'application/xml',则参数也可以在请求体中以 XML 形式给出。
operationId: headerFilterAllowCreate
parameters:
- description: 要匹配的 HTTP 标头 (例如 User-Agent)。
in: formData
name: header
required: true
type: string
x-go-name: Header
- description: 要匹配的标头值的正则表达式。
in: formData
name: regex
required: true
type: string
x-go-name: Regex
produces:
- application/json
responses:
"200":
description: 新创建的 "allow" (放行) 标头过滤规则。
schema:
$ref: '#/definitions/headerFilter'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:write
summary: 创建标头放行规则
tags:
- admin
/api/v1/admin/header_allows/{id}:
delete:
operationId: headerFilterAllowDelete
parameters:
- description: 目标标头过滤规则 ID。
in: path
name: id
required: true
type: string
responses:
"202":
description: Accepted 已接受
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:write
summary: 删除标头放行规则
description: 删除具有给定 ID 的 "allow" (放行) 标头过滤规则。
tags:
- admin
get:
operationId: headerFilterAllowGet
parameters:
- description: 目标标头过滤规则 ID。
in: path
name: id
required: true
type: string
responses:
"200":
description: 请求的 "allow" (放行) 标头过滤规则。
schema:
$ref: '#/definitions/headerFilter'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:read
summary: 获取单个标头放行规则
description: 获取具有给定 ID 的 "allow" (放行) 标头过滤规则。
tags:
- admin
/api/v1/admin/header_blocks:
get:
operationId: headerFilterBlocksGet
responses:
"200":
description: 目前所有的 "block" (阻止) 标头过滤规则。
schema:
items:
$ref: '#/definitions/headerFilter'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:read
summary: 查看标头阻止规则
description: 获取目前所有的 "block" (阻止) 标头过滤规则。
tags:
- admin
post:
consumes:
- application/json
- application/xml
- application/x-www-form-urlencoded
description: |-
创建一条新的 "block" (阻止) HTTP 请求标头过滤规则。
若 Content-Type 为 'application/json',则参数也可以在请求体中以 JSON 形式给出。
若 Content-Type 为 'application/xml',则参数也可以在请求体中以 XML 形式给出。
operationId: headerFilterBlockCreate
parameters:
- description: 要匹配的 HTTP 标头 (例如 User-Agent)。
in: formData
name: header
required: true
type: string
x-go-name: Header
- description: 要匹配的标头值的正则表达式。
in: formData
name: regex
required: true
type: string
x-go-name: Regex
produces:
- application/json
responses:
"200":
description: 新创建的 "block" (阻止) 标头过滤规则。
schema:
$ref: '#/definitions/headerFilter'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:write
summary: 创建标头阻止规则
tags:
- admin
/api/v1/admin/header_blocks/{id}:
delete:
operationId: headerFilterBlockDelete
parameters:
- description: 目标标头过滤规则 ID。
in: path
name: id
required: true
type: string
responses:
"202":
description: Accepted 已接受
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:write
summary: 删除标头阻止规则
description: 删除具有给定 ID 的 "block" (阻止) 标头过滤规则。
tags:
- admin
get:
operationId: headerFilterBlockGet
parameters:
- description: 目标标头过滤规则 ID。
in: path
name: id
required: true
type: string
responses:
"200":
description: 请求的 "block" (阻止) 标头过滤规则。
schema:
$ref: '#/definitions/headerFilter'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:read
summary: 获取单个标头阻止规则
description: 获取具有给定 ID 的 "block" (阻止) 标头过滤规则。
tags:
- admin
/api/v1/admin/instance/rules:
get:
description: 实例规则将按 Order 升序返回。
operationId: adminsRuleGet
produces:
- application/json
responses:
"200":
description: 本站实例的所有规则组成的数组。
schema:
items:
$ref: '#/definitions/instanceRule'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:read
summary: 查看实例规则(含ID)
tags:
- admin
post:
consumes:
- multipart/form-data
operationId: ruleCreate
parameters:
- description: 实例规则的文本内容,纯文本。
in: formData
name: text
required: true
type: string
x-go-name: Text
produces:
- application/json
responses:
"200":
description: 新创建的实例规则。
schema:
$ref: '#/definitions/instanceRule'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:write
summary: 创建实例规则
description: 创建一条新的实例规则。
tags:
- admin
/api/v1/admin/instance/rules/{id}:
delete:
consumes:
- multipart/form-data
operationId: ruleDelete
parameters:
- description: 要删除的规则的 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 被删除的实例规则。
schema:
$ref: '#/definitions/instanceRule'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:write
summary: 删除实例规则
description: 删除一条现有的实例规则。
tags:
- admin
get:
operationId: adminRuleGet
parameters:
- description: 要获取的实例规则的 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 要获取的实例规则。
schema:
$ref: '#/definitions/instanceRule'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:read
summary: 获取单条实例规则
tags:
- admin
patch:
consumes:
- multipart/form-data
operationId: ruleUpdate
parameters:
- description: 要更新的规则的 ID。
in: path
name: id
required: true
type: string
x-go-name: ID
- description: 更新的实例规则的文本内容,纯文本。
in: formData
name: text
required: true
type: string
x-go-name: Text
produces:
- application/json
responses:
"200":
description: 更新后的实例规则。
schema:
$ref: '#/definitions/instanceRule'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:write
summary: 更新实例规则
description: 更新一条现有的实例规则。
tags:
- admin
/api/v1/admin/media_cleanup:
post:
consumes:
- application/json
- application/xml
- application/x-www-form-urlencoded
description: 删除早于给定日期的外站媒体。也会清理未使用的头像和横幅背景头图,并从存储中删除孤立的项目。
operationId: mediaCleanup
parameters:
- description: |-
要保留的外站媒体的天数。本地(Native)值将被视为 0。
若未指定值,则将使用服务器配置中的 media-remote-cache-days 的值。
format: int64
in: query
name: remote_cache_days
type: integer
x-go-name: RemoteCacheDays
produces:
- application/json
responses:
"200":
description: 返回请求的天数。清理将在请求完成后异步执行。
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:write
summary: 清理媒体
tags:
- admin
/api/v1/admin/media_refetch:
post:
description: |-
重新获取数据库中指定但在存储中丢失的媒体。
当前,仅包括外站表情。
当数据丢失时,您可以使用此端点尝试恢复到工作状态。
operationId: mediaRefetch
parameters:
- description: 要重新获取媒体的实例。如果为空,则将重新获取所有实例的媒体。
in: query
name: domain
type: string
produces:
- application/json
responses:
"202":
description: 请求已接受并将被处理。检查日志以查看进度/错误。
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:write
summary: 重新获取媒体
tags:
- admin
/api/v1/admin/reports:
get:
description: |-
查看发给管理员的用户举报。
举报将按时间顺序(最新的在前)返回,带有连续的 ID(更大 = 更新)。
下一个和上一个查询可以从返回的Link标头中解析。
例子:
```
<https://example.org/api/v1/admin/reports?limit=20&max_id=01FC0SKA48HNSVR6YKZCQGS2V8>; rel="next", <https://example.org/api/v1/admin/reports?limit=20&min_id=01FC0SKW5JK2Q4EVAV2B462YY0>; rel="prev"
````
operationId: adminReports
parameters:
- description: 如果设为 true,则只返回已解决的举报。如果设为 false,则只返回未解决的举报。如果未设置,则不会根据其解决状态过滤举报。
in: query
name: resolved
type: boolean
- description: 只返回由给定 ID 的账户创建的举报。
in: query
name: account_id
type: string
- description: 只返回针对给定 ID 的账户的举报。
in: query
name: target_account_id
type: string
- description: 只返回比给定的 max ID *旧* 的举报(用于向下翻页)。具有指定 ID 的举报不会包含在响应中。
in: query
name: max_id
type: string
- description: 只返回比给定的 since ID *新* 的举报。具有指定 ID 的举报不会包含在响应中。
in: query
name: since_id
type: string
- description: 只返回比给定的 min ID 相邻且*更新* 的举报(用于向上翻页)。具有指定 ID 的举报不会包含在响应中。
in: query
name: min_id
type: string
- default: 20
description: 要返回的举报数量。
in: query
maximum: 100
minimum: 1
name: limit
type: integer
produces:
- application/json
responses:
"200":
description: 举报数组。
headers:
Link:
description: 下一/上一查询的链接。
type: string
schema:
items:
$ref: '#/definitions/adminReport'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:read:reports
summary: 查看用户举报
tags:
- admin
/api/v1/admin/reports/{id}:
get:
operationId: adminReportGet
parameters:
- description: 举报的 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 请求的举报。
schema:
$ref: '#/definitions/adminReport'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:read:reports
summary: 查看单个用户举报
description: 查看具有给定 ID 的用户举报。
tags:
- admin
/api/v1/admin/reports/{id}/resolve:
post:
consumes:
- application/json
- application/xml
- multipart/form-data
operationId: adminReportResolve
parameters:
- description: 举报的 ID。
in: path
name: id
required: true
type: string
- description: |-
管理员对此举报采取的行动的评论,可不填。在将举报标记为已处理之前,提供关于采取的行动(如果有)的解释非常有用。这将对创建举报的用户可见!
in: formData
name: action_taken_comment
type: string
produces:
- application/json
responses:
"200":
description: 已处理的举报。
schema:
$ref: '#/definitions/adminReport'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:write:reports
summary: 处理用户举报
description: 将具有给定 ID 的用户举报标记为已处理。
tags:
- admin
/api/v1/announcements:
get:
operationId: announcementsGet
produces:
- application/json
responses:
"200":
description: ""
schema:
items:
type: object
maxItems: 0
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer: []
summary: 获取公告
description: '以数组形式获取当前生效的公告。此端点目前尚未完全实现:它将无条件返回一个空数组。'
tags:
- announcements
/api/v1/apps:
get:
description: |-
获取由请求者管理的应用程序的数组。
可从返回的 Link 标头解析出下一页和上一页的查询地址。
示例:
```
<https://example.org/api/v1/apps?limit=80&max_id=01FC0SKA48HNSVR6YKZCQGS2V8>; rel="next", <https://example.org/api/v1/apps?limit=80&min_id=01FC0SKW5JK2Q4EVAV2B462YY0>; rel="prev"
````
operationId: appsGet
parameters:
- description: 只返回比给定的 max ID *旧* 的应用。具有指定 ID 的应用不会包含在响应中。
in: query
name: max_id
type: string
- description: 只返回比给定的 since ID *新* 的应用。具有指定 ID 的应用不会包含在响应中。
in: query
name: since_id
type: string
- description: 只返回比给定的 min ID *相邻且更新* 的应用(用于向上翻页)。具有指定 ID 的应用不会包含在响应中。
in: query
name: min_id
type: string
- default: 20
description: 要返回的应用数量。
in: query
name: limit
type: integer
produces:
- application/json
responses:
"200":
description: ""
headers:
Link:
description: 下一/上一查询的链接。
type: string
schema:
items:
$ref: '#/definitions/application'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:applications
summary: 获取应用列表
tags:
- apps
post:
consumes:
- application/json
- application/xml
- application/x-www-form-urlencoded
description: |-
在本实例注册一个新的应用程序。
注册的应用程序可用于获取应用程序令牌。
然后可以使用此令牌注册新帐户,或(通过用户身份验证)获取访问令牌。
如果应用程序是通过在 Authorization 标头中使用 Bearer 令牌创建的,则新创建的应用程序将由经过对应的的用户管理(Bearer 令牌必须具有 write:applications 范围)。
若 Content-Type 为 'application/json',则参数也可以在请求体中以 JSON 形式给出。
若 Content-Type 为 'application/xml',则参数也可以在请求体中以 XML 形式给出。
operationId: appCreate
parameters:
- description: 应用程序的名称。
in: formData
name: client_name
required: true
type: string
x-go-name: ClientName
- description: |-
单个重定向 URI 或以换行符分隔的重定向 URI 列表(可选)。
若要向用户显示授权代码而不是重定向到网页,请在此参数中使用 `urn:ietf:wg:oauth:2.0:oob`。
如果未提供重定向 URI,则默认为 `urn:ietf:wg:oauth:2.0:oob`。
in: formData
name: redirect_uris
type: string
x-go-name: RedirectURIs
- description: |-
授权范围,以空格分隔的列表(可选)。
如果未提供范围,则默认为 `read`。
in: formData
name: scopes
type: string
x-go-name: Scopes
- description: 此应用程序的网页 URL(可选)。
in: formData
name: website
type: string
x-go-name: Website
produces:
- application/json
responses:
"200":
description: 新创建的应用程序。
schema:
$ref: '#/definitions/application'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
summary: 创建应用程序
tags:
- apps
/api/v1/apps/{id}:
delete:
operationId: appDelete
parameters:
- description: 要删除的应用程序的 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 被删除的应用程序。
schema:
$ref: '#/definitions/application'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:applications
summary: 删除单个应用
description: 删除单个由请求者管理的应用程序。
tags:
- apps
get:
operationId: appGet
parameters:
- description: 要请求的应用程序的 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 请求的应用程序。
schema:
$ref: '#/definitions/application'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:applications
summary: 获取单个应用
description: 获取单个由请求者管理的应用程序。
tags:
- apps
/api/v1/blocks:
get:
description: |-
获取发起请求的账户已屏蔽的账户数组。
下一个和上一个查询可以从返回的Link标头中解析。
示例:
```
<https://example.org/api/v1/blocks?limit=80&max_id=01FC0SKA48HNSVR6YKZCQGS2V8>; rel="next", <https://example.org/api/v1/blocks?limit=80&min_id=01FC0SKW5JK2Q4EVAV2B462YY0>; rel="prev"
````
operationId: blocksGet
parameters:
- description: '仅返回早于给定的 max ID 的已屏蔽账户。具有指定 ID 的已屏蔽账户不会包含在响应中。注意:ID 是内部屏蔽的 ID,而不是任何返回的账户的 ID。'
in: query
name: max_id
type: string
- description: '仅返回晚于给定的 since ID 的已屏蔽账户。具有指定 ID 的已屏蔽账户不会包含在响应中。注意:ID 是内部屏蔽的 ID,而不是任何返回的账户的 ID。'
in: query
name: since_id
type: string
- description: '仅返回比给定的 min ID *相邻且更新* 的已屏蔽账户。具有指定 ID 的已屏蔽账户不会包含在响应中。注意:ID 是内部屏蔽的 ID,而不是任何返回的账户的 ID。'
in: query
name: min_id
type: string
- default: 40
description: 要返回的已屏蔽账户数量。
in: query
maximum: 80
minimum: 1
name: limit
type: integer
produces:
- application/json
responses:
"200":
description: ""
headers:
Link:
description: 下一/上一查询的链接。
type: string
schema:
items:
$ref: '#/definitions/account'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:blocks
summary: 获取已屏蔽账户
tags:
- blocks
/api/v1/bookmarks:
get:
description: 获取在本站收藏的贴文的数组。
operationId: bookmarksGet
parameters:
- default: 30
description: 要返回的贴文数量。
in: query
name: limit
type: integer
- description: 仅返回早于给定的收藏 ID 的已收藏贴文。具有相应收藏 ID 的贴文不会包含在响应中。
in: query
name: max_id
type: string
- description: 仅返回比给定的收藏 ID *新* 的已收藏贴文。具有相应收藏 ID 的贴文不会包含在响应中。
in: query
name: min_id
type: string
produces:
- application/json
responses:
"200":
description: 已收藏贴文的数组。
headers:
Link:
description: 下一/上一查询的链接。
type: string
schema:
items:
$ref: '#/definitions/status'
type: array
"401":
description: unauthorized 未授权
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:bookmarks
summary: 获取收藏列表
tags:
- bookmarks
/api/v1/conversation/{id}/read:
post:
operationId: conversationRead
parameters:
- description: 对话的 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 更新后的对话。
schema:
$ref: '#/definitions/conversation'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"422":
description: unprocessable 无法处理 content
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:conversations
summary: 标记对话为已读
description: 将具有给定 ID 的对话标记为已读。
tags:
- conversations
/api/v1/conversations:
get:
description: |-
获取发起请求的账户参与的对话(私信)数组。
下一个和上一个查询可以从返回的Link标头中解析。
示例:
```
<https://example.org/api/v1/conversations?limit=80&max_id=01FC0SKA48HNSVR6YKZCQGS2V8>; rel="next", <https://example.org/api/v1/conversations?limit=80&min_id=01FC0SKW5JK2Q4EVAV2B462YY0>; rel="prev"
````
operationId: conversationsGet
parameters:
- description: '仅返回最后贴文早于给定的 max ID 的对话。具有相应贴文 ID 的对话不会包含在响应中。注意:ID 是贴文 ID。使用Link标头进行分页。'
in: query
name: max_id
type: string
- description: '仅返回最后贴文晚于给定的 since ID 的对话。具有相应贴文 ID 的对话不会包含在响应中。注意:ID 是贴文 ID。使用Link标头进行分页。'
in: query
name: since_id
type: string
- description: '仅返回最后贴文 **相邻且晚于** 给定的 since ID 的对话。具有相应贴文 ID 的对话不会包含在响应中。注意:ID 是贴文 ID。使用Link标头进行分页。'
in: query
name: min_id
type: string
- default: 40
description: 要返回的对话数量。
in: query
maximum: 80
minimum: 1
name: limit
type: integer
produces:
- application/json
responses:
"200":
description: ""
headers:
Link:
description: 下一/上一查询的链接。
type: string
schema:
items:
$ref: '#/definitions/conversation'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:statuses
summary: 获取对话列表
tags:
- conversations
/api/v1/conversations/{id}:
delete:
description: |-
删除具有给定 ID 的单个对话。
这不会删除对话包含的实际贴文,也不会阻止参与者稍后从相同的贴文串和参与者创建新对话。
operationId: conversationDelete
parameters:
- description: 对话的 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 对话已删除
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:conversations
summary: 删除对话
tags:
- conversations
/api/v1/custom_emojis:
get:
operationId: customEmojisGet
produces:
- application/json
responses:
"200":
description: 自定义表情数组。
schema:
items:
$ref: '#/definitions/emoji'
type: array
"401":
description: unauthorized 未授权
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer: []
summary: 获取自定义表情
description: 获取本实例可用的自定义表情数组。
tags:
- custom_emojis
/api/v1/exports/blocks.csv:
get:
operationId: exportBlocks
produces:
- text/csv
responses:
"200":
description: 你屏蔽的账户的 CSV 文件。
"401":
description: unauthorized 未授权
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:blocks
summary: 导出屏蔽列表
description: 导出你屏蔽的账户的 CSV 文件。
tags:
- import-export
/api/v1/exports/followers.csv:
get:
operationId: exportFollowers
produces:
- text/csv
responses:
"200":
description: 你的粉丝的 CSV 文件。
"401":
description: unauthorized 未授权
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:accounts
summary: 导出粉丝列表
description: 导出你的粉丝的 CSV 文件。
tags:
- import-export
/api/v1/exports/following.csv:
get:
operationId: exportFollowing
produces:
- text/csv
responses:
"200":
description: 你关注的账户的 CSV 文件。
"401":
description: unauthorized 未授权
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:follows
summary: 导出关注列表
description: 导出你关注的账户的 CSV 文件。
tags:
- import-export
/api/v1/exports/lists.csv:
get:
operationId: exportLists
produces:
- text/csv
responses:
"200":
description: 列表的 CSV 文件。
"401":
description: unauthorized 未授权
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:lists
summary: 导出所有列表
description: 导出你创建的列表的 CSV 文件。
tags:
- import-export
/api/v1/exports/mutes.csv:
get:
operationId: exportMutes
produces:
- text/csv
responses:
"200":
description: 你屏蔽的账户的 CSV 文件。
"401":
description: unauthorized 未授权
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:mutes
summary: 导出静音列表
description: 导出你静音/隐藏的账户的 CSV 文件。
tags:
- import-export
/api/v1/exports/stats:
get:
operationId: exportStats
produces:
- application/json
responses:
"200":
description: 导出统计信息
schema:
$ref: '#/definitions/accountExportStats'
"401":
description: unauthorized 未授权
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:accounts
summary: 查看导出统计信息
description: 返回对应账户有关可以导出的项目数量的统计信息。
tags:
- import-export
/api/v1/favourites:
get:
description: |-
查看发起请求的账户已点赞的贴文数组。
下一个和上一个查询可以从返回的Link标头中解析。
示例:
```
<https://example.org/api/v1/favourites?limit=80&max_id=01FC0SKA48HNSVR6YKZCQGS2V8>; rel="next", <https://example.org/api/v1/favourites?limit=80&min_id=01FC0SKW5JK2Q4EVAV2B462YY0>; rel="prev"
````
operationId: favouritesGet
parameters:
- default: 20
description: 要返回的贴文数量。
in: query
name: limit
type: integer
- description: 仅返回比给定的点赞 ID *旧* 的贴文。具有相应点赞 ID 的贴文不会包含在响应中。
in: query
name: max_id
type: string
- description: 仅返回比给定的点赞 ID *新* 的贴文。具有相应点赞 ID 的贴文不会包含在响应中。
in: query
name: min_id
type: string
produces:
- application/json
responses:
"200":
description: ""
headers:
Link:
description: 下一/上一查询的链接。
type: string
schema:
items:
$ref: '#/definitions/status'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:favourites
summary: 查看点赞贴文
tags:
- favourites
/api/v1/featured_tags:
get:
description: '获取你当前在个人资料上展示的所有话题标签的数组。**此端点尚未完全实现**:它将始终返回一个空数组。'
operationId: getFeaturedTags
produces:
- application/json
responses:
"200":
description: ""
schema:
items:
type: object
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:accounts
summary: 获取精选话题标签
tags:
- tags
/api/v1/filters:
get:
operationId: filtersV1Get
produces:
- application/json
responses:
"200":
description: 请求的过滤规则。
schema:
items:
$ref: '#/definitions/filterV1'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:filters
summary: 获取V1过滤规则
description: 获取发起请求的账户的所有过滤规则。
tags:
- filters
post:
consumes:
- application/json
- application/xml
- application/x-www-form-urlencoded
operationId: filterV1Post
parameters:
- description: |-
要过滤的文本。
示例:挂人
in: formData
maxLength: 40
minLength: 1
name: phrase
required: true
type: string
- collectionFormat: multi
description: |-
此过滤规则要应用的上下文。
示例: home, public
in: formData
items:
enum:
- home
- notifications
- public
- thread
- account
type: string
minItems: 1
name: context[]
required: true
type: array
uniqueItems: true
- description: |-
此过滤规则的过期时间(秒)。如果省略,则过滤规则永不过期。
示例:86400
in: formData
name: expires_in
type: number
- default: false
description: |-
被命中的条目是否应该从用户的时间线/视图中移除,而不是隐藏?目前不支持。
示例:false
in: formData
name: irreversible
type: boolean
- default: false
description: |-
此过滤规则是否应考虑单词边界(整词匹配)?
示例:true
in: formData
name: whole_word
type: boolean
produces:
- application/json
responses:
"200":
description: 新过滤规则。
schema:
$ref: '#/definitions/filterV1'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: 禁止对已迁移的账户执行此操作
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"409":
description: conflict (duplicate keyword)
"422":
description: unprocessable 无法处理 content
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:filters
summary: 创建V1过滤规则
description: 创建一条新的V1过滤规则。
tags:
- filters
/api/v1/filters/{id}:
delete:
operationId: filterV1Delete
parameters:
- description: 过滤规则的 ID
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 过滤规则已删除
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:filters
summary: 删除V1过滤规则
description: 删除具有给定 ID 的单个过滤规则。
tags:
- filters
get:
operationId: filterV1Get
parameters:
- description: 过滤规则的 ID
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 请求的过滤规则。
schema:
$ref: '#/definitions/filterV1'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:filters
summary: 获取单个V1过滤规则
description: 获取具有给定 ID 的单个V1过滤规则。
tags:
- filters
put:
consumes:
- application/json
- application/xml
- application/x-www-form-urlencoded
operationId: filterV1Put
parameters:
- description: 过滤规则的 ID.
in: path
name: id
required: true
type: string
- description: |-
要过滤的文本。
示例: 挂人
in: formData
maxLength: 40
minLength: 1
name: phrase
required: true
type: string
- collectionFormat: multi
description: |-
此过滤规则要应用的上下文。
示例: home, public
in: formData
items:
enum:
- home
- notifications
- public
- thread
- account
type: string
minItems: 1
name: context[]
required: true
type: array
uniqueItems: true
- description: |-
此过滤规则的过期时间(秒)。如果省略,则过滤规则永不过期。
示例: 86400
in: formData
name: expires_in
type: number
- default: false
description: |-
被命中的条目是否应该从用户的时间线/视图中移除,而不是隐藏?目前不支持。
示例: false
in: formData
name: irreversible
type: boolean
- default: false
description: |-
此过滤规则是否应考虑单词边界(整词匹配)?
示例: true
in: formData
name: whole_word
type: boolean
produces:
- application/json
responses:
"200":
description: 更新后的过滤规则。
schema:
$ref: '#/definitions/filterV1'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: 禁止对已迁移的账户执行此操作
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"409":
description: conflict (duplicate keyword)
"422":
description: unprocessable 无法处理 content
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:filters
summary: 更新单个V1过滤规则
description: 更新具有给定 ID 的单个过滤规则。
tags:
- filters
/api/v1/follow_requests:
get:
description: |-
获取向你发起关注请求的账户数组。
下一个和上一个查询可以从返回的Link标头中解析。
示例:
```
<https://example.org/api/v1/follow_requests?limit=80&max_id=01FC0SKA48HNSVR6YKZCQGS2V8>; rel="next", <https://example.org/api/v1/follow_requests?limit=80&min_id=01FC0SKW5JK2Q4EVAV2B462YY0>; rel="prev"
````
operationId: getFollowRequests
parameters:
- description: '仅返回比给定的 max ID *旧* 的关注请求账户。具有指定 ID 的关注请求账户不会包含在响应中。注意:ID 是内部关注请求的 ID,而不是任何返回的账户的 ID。'
in: query
name: max_id
type: string
- description: '仅返回比给定的 since ID *新* 的关注请求账户。具有指定 ID 的关注请求账户不会包含在响应中。注意:ID 是内部关注请求的 ID,而不是任何返回的账户的 ID。'
in: query
name: since_id
type: string
- description: '仅返回比给定的 min ID *相邻且更新* 的关注请求账户。具有指定 ID 的关注请求账户不会包含在响应中。注意:ID 是内部关注请求的 ID,而不是任何返回的账户的 ID。'
in: query
name: min_id
type: string
- default: 40
description: 要返回的关注请求账户数量。
in: query
maximum: 80
minimum: 1
name: limit
type: integer
produces:
- application/json
responses:
"200":
description: ""
headers:
Link:
description: 下一/上一查询的链接。
type: string
schema:
items:
$ref: '#/definitions/account'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:follows
summary: 获取关注请求列表
tags:
- follow_requests
/api/v1/follow_requests/{account_id}/authorize:
post:
description: 接受/批准来自给定账户 ID 的关注请求,并将请求账户放入你的“粉丝”列表。
operationId: authorizeFollowRequest
parameters:
- description: 要接受的账户的 ID。
in: path
name: account_id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 你与此账户的关系(relationship)。
schema:
$ref: '#/definitions/accountRelationship'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:follows
summary: 接受关注请求
tags:
- follow_requests
/api/v1/follow_requests/{account_id}/reject:
post:
operationId: rejectFollowRequest
parameters:
- description: 要拒绝的账户的 ID。
in: path
name: account_id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 你与此账户的关系(relationship)。
schema:
$ref: '#/definitions/accountRelationship'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:follows
summary: 拒绝关注请求
description: 拒绝来自给定账户 ID 的关注请求。
tags:
- follow_requests
/api/v1/followed_tags:
get:
operationId: getFollowedTags
parameters:
- description: '仅返回比给定的 max ID *旧* 的已关注话题标签。具有相应 max ID 的已关注话题标签不会包含在响应中。注意:ID 是已关注话题标签的内部 ID,而不是任何返回的话题标签的 ID。'
in: query
name: max_id
type: string
- description: '仅返回比给定的 since ID *新* 的已关注话题标签。具有相应 since ID 的已关注话题标签不会包含在响应中。注意:ID 是已关注话题标签的内部 ID,而不是任何返回的话题标签的 ID。'
in: query
name: since_id
type: string
- description: '仅返回比给定的 min ID *相邻且更新* 的已关注话题标签。具有相应 min ID 的已关注话题标签不会包含在响应中。注意:ID 是已关注话题标签的内部 ID,而不是任何返回的话题标签的 ID。'
in: query
name: min_id
type: string
- default: 100
description: 要返回的已关注话题标签数量。
in: query
maximum: 200
minimum: 1
name: limit
type: integer
produces:
- application/json
responses:
"200":
description: ""
headers:
Link:
description: 下一/上一查询的链接。
type: string
schema:
items:
$ref: '#/definitions/tag'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:follows
summary: 获取已关注话题标签
description: 获取你当前关注的所有话题标签的数组。
tags:
- tags
/api/v1/import:
post:
consumes:
- multipart/form-data
description: |-
将 CSV 数据文件上传到你的账户。
这可以用于从 Mastodon 兼容的 CSV 文件迁移数据到 GoToSocial 账户。
上传的数据将异步处理,并且可能不会处理所有条目,具体取决于实例屏蔽、用户级屏蔽、引用账户和状态的网络可用性等。
operationId: importData
parameters:
- description: 要上传的 CSV 数据文件。
in: formData
name: data
required: true
type: file
- description: |-
此数据文件中包含的条目类型:
- `following` - 要关注的账户。 - `blocks` - 要屏蔽的账户。 - `mutes` - 要隐藏的账户。
in: formData
name: type
required: true
type: string
- default: merge
description: |-
根据数据文件创建对应的条目时使用的模式:
- `merge` 将数据文件中的条目与现有条目合并。 - `overwrite` 用数据文件中的条目替换现有条目。
in: formData
name: mode
type: string
produces:
- application/json
responses:
"202":
description: 上传的数据文件已被接受。
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write
summary: 导入数据
tags:
- import-export
/api/v1/instance:
get:
operationId: instanceGetV1
produces:
- application/json
responses:
"200":
description: 实例信息
schema:
$ref: '#/definitions/instanceV1'
"406":
description: not acceptable 不可接受
"500":
description: internal error
summary: 查看实例信息
tags:
- instance
patch:
consumes:
- multipart/form-data
description: 更新实例信息和/或上传新的头像/横幅头图。此端点需要实例管理员权限。
operationId: instanceUpdate
parameters:
- allowEmptyValue: true
description: 实例的标题。
in: formData
maxLength: 40
name: title
type: string
- allowEmptyValue: true
description: 联系账户的用户名。这必须是实例管理员的用户名。
in: formData
name: contact_username
type: string
- allowEmptyValue: true
description: 实例联系邮箱。
in: formData
name: contact_email
type: string
- allowEmptyValue: true
description: 实例的简短描述。
in: formData
maxLength: 500
name: short_description
type: string
- allowEmptyValue: true
description: 实例的详细描述。
in: formData
maxLength: 5000
name: description
type: string
- allowEmptyValue: true
description: 实例的条款和条件。
in: formData
maxLength: 5000
name: terms
type: string
- description: 实例的缩略图。
in: formData
name: thumbnail
type: file
- description: 提交的实例缩略图的图像描述。
in: formData
name: thumbnail_description
type: string
- description: 实例的头部背景横幅。
in: formData
name: header
type: file
produces:
- application/json
responses:
"200":
description: 更新后的实例信息。
schema:
$ref: '#/definitions/instanceV1'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:write
summary: 更新实例信息
tags:
- instance
/api/v1/instance/peers:
get:
operationId: instancePeersGet
parameters:
- default: open
description: |-
要应用于结果的过滤规则列表,以逗号分隔。可被识别的过滤规则包括:
- `open` -- 包括未被禁止或静音的同伴实例
- `suspended` -- 包括已被禁止的同伴实例。
如果过滤规则是 `open`,则只会返回未被禁止或静音的实例。
如果过滤规则是 `suspended`,则只会显示已被禁止的实例。
如果过滤规则是 `open,suspended`,则将返回所有已知实例。
如果过滤规则是空字符串或未设置,则将默认为 `open`。
in: query
name: filter
type: string
produces:
- application/json
responses:
"200":
description: |-
如果未提供 filter 参数,或 filter 为空,则将返回一个遗留的、与 Mastodon-API 兼容的响应。这将仅包含一个类似 `["example.com", "example.org"]` 的字符串数组,对应于此实例的同伴实例的域名。
如果提供了 filter 参数,则将返回一个对象数组,每个对象都至少包含一个 `domain` 键。
被静音或被禁止的域名还将有一个包含 iso8601 date 格式字符串的 `suspended_at` 或 `silenced_at` 键。如果域名对象不包含这两个键,则它是开放的。在某些情况下,已被禁止的实例可能会被混淆,这意味着它们的一些字母将被 `*` 替换,以使恶意用户更难以针对实例进行骚扰。
无论返回的是扁平响应还是更详细的响应,域名都将按主机名字母顺序排序。
schema:
items:
$ref: '#/definitions/domain'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer: []
tags:
- instance
/api/v1/instance/rules:
get:
description: 实例规则将按顺序返回(按 Order 升序排序)。
operationId: rules
produces:
- application/json
responses:
"200":
description: 本站实例的所有规则组成的数组。
schema:
items:
$ref: '#/definitions/instanceRule'
type: array
"400":
description: bad request 无效请求
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
summary: 查看实例规则(公开)
tags:
- instance
/api/v1/interaction_policies/defaults:
get:
operationId: policiesDefaultsGet
produces:
- application/json
responses:
"200":
description: 一个默认的策略对象,包含每种贴文可见性的互动规则。
schema:
$ref: '#/definitions/defaultPolicies'
"401":
description: unauthorized 未授权
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:accounts
summary: 获取默认互动规则
description: 获取你创建的新贴文的默认互动规则。
tags:
- interaction_policies
patch:
consumes:
- multipart/form-data
- application/x-www-form-urlencoded
- application/json
description: |-
为你创建的不同可见性级别的新贴文更新默认互动策略。
如果使用表单数据提交,请使用以下范式:
`VISIBILITY[INTERACTION_TYPE][CONDITION][INDEX]=Value`
例如:`public[can_reply][always][0]=author`
使用 `curl` 调用时可以为如下形式:
`curl -F 'public[can_reply][always][0]=author' -F 'public[can_reply][always][1]=followers'`
其 JSON 等效形式为:
`curl -H 'Content-Type: application/json' -d '{"public":{"can_reply":{"always":["author","followers"]}}}'`
请求体中未指定的任何可见性级别将被重置为默认值。
例如,在上面的示例中,“public” 将被更新,但“unlisted”、“private” 和“direct” 将被重置为默认值。
服务器将对提交的策略执行一些规范化,以免您提交完全无效的策略。
operationId: policiesDefaultsUpdate
parameters:
- description: public.can_favourite.always 的第 N 个条目。
in: formData
name: public[can_favourite][always][0]
type: string
- description: public.can_favourite.with_approval 的第 N 个条目。
in: formData
name: public[can_favourite][with_approval][0]
type: string
- description: public.can_reply.always 的第 N 个条目。
in: formData
name: public[can_reply][always][0]
type: string
- description: public.can_reply.with_approval 的第 N 个条目。
in: formData
name: public[can_reply][with_approval][0]
type: string
- description: public.can_reblog.always 的第 N 个条目。
in: formData
name: public[can_reblog][always][0]
type: string
- description: public.can_reblog.with_approval 的第 N 个条目。
in: formData
name: public[can_reblog][with_approval][0]
type: string
- description: unlisted.can_favourite.always 的第 N 个条目。
in: formData
name: unlisted[can_favourite][always][0]
type: string
- description: unlisted.can_favourite.with_approval 的第 N 个条目。
in: formData
name: unlisted[can_favourite][with_approval][0]
type: string
- description: unlisted.can_reply.always 的第 N 个条目。
in: formData
name: unlisted[can_reply][always][0]
type: string
- description: unlisted.can_reply.with_approval 的第 N 个条目。
in: formData
name: unlisted[can_reply][with_approval][0]
type: string
- description: unlisted.can_reblog.always 的第 N 个条目。
in: formData
name: unlisted[can_reblog][always][0]
type: string
- description: unlisted.can_reblog.with_approval 的第 N 个条目。
in: formData
name: unlisted[can_reblog][with_approval][0]
type: string
- description: private.can_favourite.always 的第 N 个条目。
in: formData
name: private[can_favourite][always][0]
type: string
- description: private.can_favourite.with_approval 的第 N 个条目。
in: formData
name: private[can_favourite][with_approval][0]
type: string
- description: private.can_reply.always 的第 N 个条目。
in: formData
name: private[can_reply][always][0]
type: string
- description: private.can_reply.with_approval 的第 N 个条目。
in: formData
name: private[can_reply][with_approval][0]
type: string
- description: private.can_reblog.always 的第 N 个条目。
in: formData
name: private[can_reblog][always][0]
type: string
- description: private.can_reblog.with_approval 的第 N 个条目。
in: formData
name: private[can_reblog][with_approval][0]
type: string
- description: direct.can_favourite.always 的第 N 个条目。
in: formData
name: direct[can_favourite][always][0]
type: string
- description: direct.can_favourite.with_approval 的第 N 个条目。
in: formData
name: direct[can_favourite][with_approval][0]
type: string
- description: direct.can_reply.always 的第 N 个条目。
in: formData
name: direct[can_reply][always][0]
type: string
- description: direct.can_reply.with_approval 的第 N 个条目。
in: formData
name: direct[can_reply][with_approval][0]
type: string
- description: direct.can_reblog.always 的第 N 个条目。
in: formData
name: direct[can_reblog][always][0]
type: string
- description: direct.can_reblog.with_approval 的第 N 个条目。
in: formData
name: direct[can_reblog][with_approval][0]
type: string
produces:
- application/json
responses:
"200":
description: 更新后的默认策略对象,包含每种贴文可见性的互动规则。
schema:
$ref: '#/definitions/defaultPolicies'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"406":
description: not acceptable 不可接受
"422":
description: unprocessable 无法处理
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:accounts
summary: 更新默认互动规则
tags:
- interaction_policies
/api/v1/interaction_requests:
get:
description: |-
获取其他账户对你的贴文发起的,等待你批准的互动请求的数组。
```
<https://example.org/api/v1/interaction_requests?limit=80&max_id=01FC0SKA48HNSVR6YKZCQGS2V8>; rel="next", <https://example.org/api/v1/interaction_requests?limit=80&min_id=01FC0SKW5JK2Q4EVAV2B462YY0>; rel="prev"
````
operationId: getInteractionRequests
parameters:
- description: 若设置,则只有针对给定 status_id 的互动请求将包含在结果中。
in: query
name: status_id
type: string
- default: true
description: 如果为 true 或未设置,则将在结果中包含待批准的点赞。favourites, replies 和 reblogs 中至少有一个必须为 true。
in: query
name: favourites
type: boolean
- default: true
description: 如果为 true 或未设置,则将在结果中包含待批准的回复。favourites, replies 和 reblogs 中至少有一个必须为 true。
in: query
name: replies
type: boolean
- default: true
description: 如果为 true 或未设置,则将在结果中包含待批准的转发。favourites, replies 和 reblogs 中至少有一个必须为 true。
in: query
name: reblogs
type: boolean
- description: 仅返回比给定的 max ID *旧* 的互动请求。具有指定 ID 的互动请求不会包含在响应中。
in: query
name: max_id
type: string
- description: 仅返回比给定的 since ID *新* 的互动请求。具有指定 ID 的互动请求不会包含在响应中。
in: query
name: since_id
type: string
- description: 仅返回比给定的 min ID *相邻且更新* 的互动请求。具有指定 ID 的互动请求不会包含在响应中。
in: query
name: min_id
type: string
- default: 40
description: 要返回的互动请求数量。
in: query
maximum: 80
minimum: 1
name: limit
type: integer
produces:
- application/json
responses:
"200":
description: ""
headers:
Link:
description: 下一/上一查询的链接。
type: string
schema:
items:
$ref: '#/definitions/interactionRequest'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:notifications
summary: 获取互动请求列表
tags:
- interaction_requests
/api/v1/interaction_requests/{id}:
get:
operationId: getInteractionRequest
parameters:
- description: 对你发出的互动请求的 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 互动请求。
schema:
$ref: '#/definitions/interactionRequest'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:notifications
summary: 获取单个互动请求
description: 获取具有给定 ID 的互动请求。
tags:
- interaction_requests
/api/v1/interaction_requests/{id}/authorize:
post:
operationId: authorizeInteractionRequest
parameters:
- description: 对你发出的互动请求的 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 被批准后的互动请求。
schema:
$ref: '#/definitions/interactionRequest'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:statuses
summary: 接受互动请求
description: 接受/授权/批准具有给定 ID 的互动请求。
tags:
- interaction_requests
/api/v1/interaction_requests/{id}/reject:
post:
operationId: rejectInteractionRequest
parameters:
- description: 对你发出的互动请求的 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 被拒绝的互动请求。
schema:
$ref: '#/definitions/interactionRequest'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:statuses
summary: 拒绝互动请求
description: 拒绝具有给定 ID 的互动请求。
tags:
- interaction_requests
/api/v1/lists:
get:
operationId: lists
produces:
- application/json
responses:
"200":
description: 发起请求的用户拥有的所有列表的数组。
schema:
items:
$ref: '#/definitions/list'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:lists
summary: 获取所有列表
description: 获取授权用户拥有的所有列表。
tags:
- lists
post:
consumes:
- application/json
- application/xml
- application/x-www-form-urlencoded
operationId: listCreate
parameters:
- description: |-
列表的标题。
示例: 大佬
in: formData
name: title
required: true
type: string
x-go-name: Title
- default: list
description: |-
此列表的回复策略。
followed = 显示对任何关注的用户的回复
list = 显示对列表成员的回复
none = 不显示回复
示例: list
enum:
- followed
- list
- none
in: formData
name: replies_policy
type: string
x-go-name: RepliesPolicy
- default: false
description: 将此列表的成员的贴文从你的主页时间线中隐藏。
in: formData
name: exclusive
type: boolean
x-go-name: Exclusive
produces:
- application/json
responses:
"200":
description: 新创建的列表。
schema:
$ref: '#/definitions/list'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:lists
summary: 创建列表
tags:
- lists
/api/v1/lists/{id}:
delete:
operationId: listDelete
parameters:
- description: 列表的 ID
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 列表已删除
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:lists
summary: 删除列表
description: 删除具有给定 ID 的列表。
tags:
- lists
get:
operationId: list
parameters:
- description: 列表的 ID
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 请求的列表。
schema:
$ref: '#/definitions/list'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:lists
summary: 获取列表
description: 获取具有给定 ID 的列表。
tags:
- lists
put:
consumes:
- application/json
- application/xml
- application/x-www-form-urlencoded
operationId: listUpdate
parameters:
- description: 列表的 ID
in: path
name: id
required: true
type: string
- description: |-
列表的标题。
示例: 大佬
in: formData
name: title
type: string
- description: |-
列表的回复展示规则。
followed = 显示对任何关注的用户的回复
list = 显示对列表成员的回复
none = 不显示回复
示例: list
enum:
- followed
- list
- none
in: formData
name: replies_policy
type: string
- description: 将此列表的成员的贴文从你的主页时间线中隐藏。
in: formData
name: exclusive
type: boolean
produces:
- application/json
responses:
"200":
description: 更新后的列表。
schema:
$ref: '#/definitions/list'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:lists
summary: 更新列表
tags:
- lists
/api/v1/lists/{id}/accounts:
delete:
consumes:
- application/json
- application/xml
- application/x-www-form-urlencoded
operationId: removeListAccounts
parameters:
- description: 列表的 ID
in: path
name: id
required: true
type: string
- collectionFormat: multi
description: 要编辑的账户 ID 数组。每个账户 ID 必须对应于一个发起请求的账户关注的账户。
in: formData
items:
type: string
name: account_ids[]
required: true
type: array
produces:
- application/json
responses:
"200":
description: 列表账户已更新
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:lists
summary: 从列表删除账户
description: 从给定列表中删除一个或多个账户。
tags:
- lists
get:
description: |-
分页浏览给定列表中的账户。
返回的 Link 标头可用于在时间线向上或向下滚动时生成上一个和下一个查询。
示例:
```
<https://example.org/api/v1/list/01H0W619198FX7J54NF7EH1NG2/accounts?limit=20&max_id=01FC3GSQ8A3MMJ43BPZSGEG29M>; rel="next", <https://example.org/api/v1/list/01H0W619198FX7J54NF7EH1NG2/accounts?limit=20&min_id=01FC3KJW2GYXSDDRA6RWNDM46M>; rel="prev"
````
operationId: listAccounts
parameters:
- description: 列表的 ID
in: path
name: id
required: true
type: string
- description: 仅返回比给定的 max ID *旧* 的列表条目。具有指定 ID 的列表条目对应的账户不会包含在响应中。
in: query
name: max_id
type: string
- description: 仅返回比给定的 since ID *新* 的列表条目。具有指定 ID 的列表条目对应的账户不会包含在响应中。
in: query
name: since_id
type: string
- description: 仅返回比给定的 min ID *相邻且更新* 的列表条目。具有指定 ID 的列表条目对应的账户不会包含在响应中。
in: query
name: min_id
type: string
- default: 40
description: '要返回的账户数量。如果显式设置为 0,则列表中的所有账户将被返回,并且不会使用分页标头。这是针对 Mastodon API 的一个特殊情况的解决方法:https://docs.joinmastodon.org/methods/lists/#query-parameters。'
in: query
maximum: 80
minimum: 0
name: limit
type: integer
produces:
- application/json
responses:
"200":
description: 账户数组。
headers:
Link:
description: 下一/上一查询的链接。
type: string
schema:
items:
$ref: '#/definitions/account'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:lists
summary: 查看列表中的账户
tags:
- lists
post:
consumes:
- application/json
- application/xml
- application/x-www-form-urlencoded
operationId: addListAccounts
parameters:
- description: 列表的 ID
in: path
name: id
required: true
type: string
- collectionFormat: multi
description: 要编辑的账户 ID 数组。每个账户 ID 必须对应于一个发起请求的账户关注的账户。
in: formData
items:
type: string
name: account_ids[]
required: true
type: array
produces:
- application/json
responses:
"200":
description: 列表账户已更新
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:lists
summary: 向列表添加账户
description: 向给定列表中添加一个或多个账户。
tags:
- lists
/api/v1/markers:
get:
description: 根据名称获取时间线标记
operationId: markersGet
parameters:
- description: 要检索的时间线。
in: query
items:
enum:
- home
- notifications
type: string
name: timeline
type: array
produces:
- application/json
responses:
"200":
description: 请求的标记
schema:
$ref: '#/definitions/markers'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:statuses
tags:
- markers
post:
consumes:
- multipart/form-data
description: 根据名称更新时间线标记
operationId: markersPost
parameters:
- description: 在主页时间线上最后阅读的贴文 ID。
in: formData
name: home[last_read_id]
type: string
- description: 在通知时间线上最后阅读的通知 ID。
in: formData
name: notifications[last_read_id]
type: string
produces:
- application/json
responses:
"200":
description: 请求的标记
schema:
$ref: '#/definitions/markers'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"409":
description: 冲突(当两个客户端尝试同时更新同一时间线时)
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:statuses
tags:
- markers
/api/v1/media/{id}:
get:
operationId: mediaGet
parameters:
- description: 附件的 ID
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 请求的媒体附件。
schema:
$ref: '#/definitions/attachment'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:media
summary: 获取单个媒体附件
description: 获取一个你拥有的媒体附件。
tags:
- media
put:
consumes:
- application/json
- application/xml
- application/x-www-form-urlencoded
description: |-
你必须拥有这个媒体附件,并且这个附件还没有被附加到任何贴文上。
若 Content-Type 为 'application/json',则参数也可以在请求体中以 JSON 形式给出。
若 Content-Type 为 'application/xml',则参数也可以在请求体中以 XML 形式给出。
operationId: mediaUpdate
parameters:
- description: 要更新的附件的 ID
in: path
name: id
required: true
type: string
- allowEmptyValue: true
description: 图片或媒体描述,用作附件的 alt 文本。这对于使用屏幕阅读器的用户非常有用!根据实例设置,可能必填,也可能选填。
in: formData
name: description
type: string
- allowEmptyValue: true
default: 0,0
description: '媒体文件的焦点。如果存在,它应该是两个介于 -1 和 1 之间的逗号分隔的浮点数。例如:`-0.5,0.25`。'
in: formData
name: focus
type: string
produces:
- application/json
responses:
"200":
description: 更新后的媒体附件。
schema:
$ref: '#/definitions/attachment'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:media
summary: 更新单个媒体附件
tags:
- media
/api/v1/mutes:
get:
description: |-
获取发起请求的账户静音的账户列表。
下一个和上一个查询可以从返回的Link标头中解析。
示例:
```
<https://example.org/api/v1/mutes?limit=80&max_id=01FC0SKA48HNSVR6YKZCQGS2V8>; rel="next", <https://example.org/api/v1/mutes?limit=80&min_id=01FC0SKW5JK2Q4EVAV2B462YY0>; rel="prev"
````
operationId: mutesGet
parameters:
- description: '仅返回比给定的 max ID *旧* 的被静音账户。具有指定 ID 的被静音账户不会包含在响应中。'
in: query
name: max_id
type: string
- description: '仅返回比给定的 since ID *新* 的被静音账户。具有指定 ID 的被静音账户不会包含在响应中。'
in: query
name: since_id
type: string
- description: '仅返回比给定的 min ID *相邻且更新* 的被静音账户。具有指定 ID 的被静音账户不会包含在响应中。'
in: query
name: min_id
type: string
- default: 40
description: 要返回的被静音账户数量。
in: query
maximum: 80
minimum: 1
name: limit
type: integer
produces:
- application/json
responses:
"200":
description: 被静音账户的列表,包括他们的静音到期时间(如果适用)。
headers:
Link:
description: 下一/上一查询的链接。
type: string
schema:
items:
$ref: '#/definitions/mutedAccount'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:mutes
summary: 获取静音账户列表
tags:
- mutes
/api/v1/notification/{id}:
get:
operationId: notification
parameters:
- description: 通知的 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 请求的通知。
schema:
$ref: '#/definitions/notification'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:notifications
summary: 获取单个通知
description: 获取单个具有给定 ID 的通知。
tags:
- notifications
/api/v1/notifications:
get:
description: |-
获取当前授权用户的通知。
通知将按照时间顺序(最新的在前)返回,具有连续的 ID(更大 = 更新)。
下一个和上一个查询可以从返回的Link标头中解析。
示例:
```
<https://example.org/api/v1/notifications?limit=80&max_id=01FC0SKA48HNSVR6YKZCQGS2V8>; rel="next", <https://example.org/api/v1/notifications?limit=80&since_id=01FC0SKW5JK2Q4EVAV2B462YY0>; rel="prev"
````
operationId: notifications
parameters:
- description: 仅返回比给定的 max ID *旧* 的通知。具有指定 ID 的通知不会包含在响应中。
in: query
name: max_id
type: string
- description: 仅返回比给定的 since ID *新* 的通知。具有指定 ID 的通知不会包含在响应中。
in: query
name: since_id
type: string
- description: 仅返回比给定的 since ID *相邻且更新* 的通知。具有指定 ID 的通知不会包含在响应中。
in: query
name: min_id
type: string
- default: 20
description: 要返回的通知数量。
in: query
name: limit
type: integer
- description: 要包含的通知类型。如果未提供,则将包含所有通知类型。
in: query
items:
enum:
- follow
- follow_request
- mention
- reblog
- favourite
- poll
- status
- admin.sign_up
type: string
name: types[]
type: array
- description: 要排除的通知类型。
in: query
items:
enum:
- follow
- follow_request
- mention
- reblog
- favourite
- poll
- status
- admin.sign_up
type: string
name: exclude_types[]
type: array
produces:
- application/json
responses:
"200":
description: 通知数组。
headers:
Link:
description: 下一/上一查询的链接。
type: string
schema:
items:
$ref: '#/definitions/notification'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:notifications
summary: 获取通知列表
tags:
- notifications
/api/v1/notifications/clear:
post:
description: 清空/删除当前授权用户的所有通知。如果成功,将返回一个空对象 `{}`。
operationId: clearNotifications
produces:
- application/json
responses:
"200":
description: ""
schema:
type: object
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:notifications
summary: 清空通知
tags:
- notifications
/api/v1/polls/{id}:
get:
operationId: poll
parameters:
- description: 目标投票 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 请求的投票。
schema:
$ref: '#/definitions/poll'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:statuses
summary: 获取投票
description: 获取具有给定 ID 的投票。
tags:
- polls
/api/v1/polls/{id}/votes:
post:
operationId: pollVote
parameters:
- description: 目标投票 ID。
in: path
name: id
required: true
type: string
- description: 用户选择的投票项索引。
in: formData
items:
type: integer
name: choices
required: true
type: array
produces:
- application/json
responses:
"200":
description: 更新后的投票和用户投票选择。
schema:
$ref: '#/definitions/poll'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"422":
description: unprocessable 无法处理 entity
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:statuses
summary: 参与投票
description: 对给定投票进行投票。
tags:
- polls
/api/v1/preferences:
get:
description: |-
返回包含用户偏好设置的对象。
示例:
```
{
"posting:default:visibility": "public",
"posting:default:sensitive": false,
"posting:default:language": "en",
"reading:expand:media": "default",
"reading:expand:spoilers": false,
"reading:autoplay:gifs": false
}
````
operationId: preferencesGet
produces:
- application/json
responses:
"200":
description: ""
schema:
type: object
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:accounts
summary: 获取用户偏好设置
tags:
- preferences
/api/v1/profile/avatar:
delete:
description: 删除当前认证账户的头像。如果账户没有头像,调用也会成功。
operationId: accountAvatarDelete
produces:
- application/json
responses:
"200":
description: 更新后的账户,包括个人资料源信息。
schema:
$ref: '#/definitions/account'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin
summary: 删除头像
tags:
- accounts
/api/v1/profile/header:
delete:
description: 删除当前认证账户的横幅背景头图。如果账户没有横幅背景头图,调用也会成功。
operationId: accountHeaderDelete
produces:
- application/json
responses:
"200":
description: 更新后的账户,包括个人资料源信息。
schema:
$ref: '#/definitions/account'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin
summary: 删除横幅背景
tags:
- accounts
/api/v1/push/subscription:
delete:
operationId: pushSubscriptionDelete
responses:
"200":
description: 被删除的通知订阅,或不存在。
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- push
summary: 删除 Web 推送订阅
description: 删除当前访问令牌关联的网页推送订阅。即使没有订阅,也会返回成功。
tags:
- push
get:
operationId: pushSubscriptionGet
produces:
- application/json
responses:
"200":
description: 当前访问令牌的 Web 推送订阅。
schema:
$ref: '#/definitions/webPushSubscription'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: 当前访问令牌没有已关联的订阅。
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- push
summary: 获取 Web 推送订阅
description: 获取当前访问令牌关联的 Web 推送订阅。
tags:
- push
post:
consumes:
- application/json
- application/x-www-form-urlencoded
operationId: pushSubscriptionPost
parameters:
- description: Web 推送订阅将要发往的端点。
in: formData
minLength: 1
name: subscription[endpoint]
required: true
type: string
- description: 身份验证密钥,一个Base64编码的16字节随机数据字符串。
in: formData
minLength: 1
name: subscription[keys][auth]
required: true
type: string
- description: 用户代理公钥,一个使用 prime256v1 曲线生成的 ECDH 密钥对的公钥的Base64编码字符串。
in: formData
minLength: 1
name: subscription[keys][p256dh]
required: true
type: string
- default: false
description: 是否在有人关注你时接收推送通知?
in: formData
name: data[alerts][follow]
type: boolean
- default: false
description: 是否在有人向你发送关注请求时接收推送通知?
in: formData
name: data[alerts][follow_request]
type: boolean
- default: false
description: 是否在有人点赞你创建的贴文时接收推送通知?
in: formData
name: data[alerts][favourite]
type: boolean
- default: false
description: 是否在有人在贴文中提及你时接收推送通知?
in: formData
name: data[alerts][mention]
type: boolean
- default: false
description: 是否在有人转发你创建的贴文时接收推送通知?
in: formData
name: data[alerts][reblog]
type: boolean
- default: false
description: 是否在你参与或创建的投票结束时接收通知?
in: formData
name: data[alerts][poll]
type: boolean
- default: false
description: 是否在你订阅的某个账户发帖时接收推送通知?
in: formData
name: data[alerts][status]
type: boolean
- default: false
description: 是否在你互动过的贴文被编辑时接收推送通知?
in: formData
name: data[alerts][update]
type: boolean
- default: false
description: 是否在有新用户注册时接收推送通知?
in: formData
name: data[alerts][admin.sign_up]
type: boolean
- default: false
description: 是否在有人提交新的举报时接收推送通知?
in: formData
name: data[alerts][admin.report]
type: boolean
- default: false
description: 是否在有新的点赞待处理时接收推送通知?
in: formData
name: data[alerts][pending.favourite]
type: boolean
- default: false
description: 是否在有新的回复待处理时接收推送通知?
in: formData
name: data[alerts][pending.reply]
type: boolean
- default: false
description: 是否在有新的转发待处理时接收推送通知?
in: formData
name: data[alerts][pending.reblog]
type: boolean
- default: all
description: 接收推送通知的账号范围。
enum:
- all
- followed
- follower
- none
in: formData
name: data[policy]
type: string
produces:
- application/json
responses:
"200":
description: 当前访问令牌关联的 Web 推送订阅。
schema:
$ref: '#/definitions/webPushSubscription'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- push
summary: 创建 Web 推送订阅
description: 使用当前访问令牌创建新的 Web 推送订阅,或替换现有订阅。
tags:
- push
put:
consumes:
- application/json
- application/x-www-form-urlencoded
operationId: pushSubscriptionPut
parameters:
- default: false
description: 是否在有人关注你时接收推送通知?
in: formData
name: data[alerts][follow]
type: boolean
- default: false
description: 是否在有人请求关注你时接收推送通知?
in: formData
name: data[alerts][follow_request]
type: boolean
- default: false
description: 是否在有人点赞你创建的贴文时接收推送通知?
in: formData
name: data[alerts][favourite]
type: boolean
- default: false
description: 是否在有人在贴文中提及你时接收推送通知?
in: formData
name: data[alerts][mention]
type: boolean
- default: false
description: 是否在有人转发你创建的贴文时接收推送通知?
in: formData
name: data[alerts][reblog]
type: boolean
- default: false
description: 是否在你参与或发起的投票结束时接收推送通知?
in: formData
name: data[alerts][poll]
type: boolean
- default: false
description: 是否在你订阅的账号发帖时接收推送通知?
in: formData
name: data[alerts][status]
type: boolean
- default: false
description: 是否在你互动过的贴文被编辑时接收推送通知?
in: formData
name: data[alerts][update]
type: boolean
- default: false
description: 是否在有新用户注册时接收推送通知?
in: formData
name: data[alerts][admin.sign_up]
type: boolean
- default: false
description: 是否在有新举报被提交时接收推送通知?
in: formData
name: data[alerts][admin.report]
type: boolean
- default: false
description: 是否在有新点赞待处理时接收推送通知?
in: formData
name: data[alerts][pending.favourite]
type: boolean
- default: false
description: 是否在有新回复待处理时接收推送通知?
in: formData
name: data[alerts][pending.reply]
type: boolean
- default: false
description: 是否在有新转发待处理时接收推送通知?
in: formData
name: data[alerts][pending.reblog]
type: boolean
- default: all
description: 接收推送通知的账号范围。
enum:
- all
- followed
- follower
- none
in: formData
name: data[policy]
type: string
produces:
- application/json
responses:
"200":
description: 当前访问令牌关联的 Web 推送订阅。
schema:
$ref: '#/definitions/webPushSubscription'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- push
summary: 更新 Web 推送订阅
description: 更新当前访问令牌关联的 Web 推送订阅。仅更新要接收的通知范围。
tags:
- push
/api/v1/reports:
get:
description: |-
查看发起请求的账户创建的举报。
举报将按时间顺序(最新的在前)返回,具有连续的 ID(更大 = 更新)。
下一个和上一个查询可以从返回的Link标头中解析。
示例:
```
<https://example.org/api/v1/reports?limit=20&max_id=01FC0SKA48HNSVR6YKZCQGS2V8>; rel="next", <https://example.org/api/v1/reports?limit=20&min_id=01FC0SKW5JK2Q4EVAV2B462YY0>; rel="prev"
````
operationId: reports
parameters:
- description: 如果设置为 true,只返回已解决的举报。如果设置为 false,只返回未解决的举报。如果未设置,举报将不会根据其解决状态进行过滤。
in: query
name: resolved
type: boolean
- description: 仅返回针对目标账户 ID 的举报。
in: query
name: target_account_id
type: string
- description: 仅返回比给定的 max ID *旧* 的举报。具有指定 ID 的举报不会包含在响应中。
in: query
name: max_id
type: string
- description: 仅返回比给定的 since ID *新* 的举报。具有指定 ID 的举报不会包含在响应中。
in: query
name: since_id
type: string
- description: 仅返回比给定的 min ID *相邻且更新* 的举报。具有指定 ID 的举报不会包含在响应中。
in: query
name: min_id
type: string
- default: 20
description: 要返回的举报数量。
in: query
maximum: 100
minimum: 1
name: limit
type: integer
produces:
- application/json
responses:
"200":
description: 举报的数组。
headers:
Link:
description: 下一/上一查询的链接。
type: string
schema:
items:
$ref: '#/definitions/report'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:accounts
summary: 获取举报列表
tags:
- reports
post:
consumes:
- application/json
- application/xml
- application/x-www-form-urlencoded
operationId: reportCreate
parameters:
- description: |-
要举报的账户 ID。
示例: 01GPE75FXSH2EGFBF85NXPH3KP
in: formData
name: account_id
required: true
type: string
x-go-name: AccountID
- description: |-
要附加到举报中以提供额外上下文的贴文的 ID。
示例: ["01GPE76N4SBVRZ8K24TW51ZZQ4","01GPE76WN9JZE62EPT3Q9FRRD4"]
in: formData
items:
type: string
name: status_ids
type: array
x-go-name: StatusIDs
- description: |-
举报的原因。默认最大 1000 个字符。
示例: 未经允许公开他人隐私信息
in: formData
name: comment
type: string
x-go-name: Comment
- default: false
description: |-
如果账户为外站账户,是否应将举报转发给外站管理员?
示例: true
in: formData
name: forward
type: boolean
x-go-name: Forward
- default: other
description: |-
指定举报属于骚扰、违反特定实例规则还是其他原因。
目前仅支持 'other'。
示例: other
in: formData
name: category
type: string
x-go-name: Category
- description: |-
举报人提供的被违反的实例规则的 ID。
示例: ["01GPBN5YDY6JKBWE44H7YQBDCQ","01GPBN65PDWSBPWVDD0SQCFFY3"]
in: formData
items:
type: string
name: rule_ids
type: array
x-go-name: RuleIDs
produces:
- application/json
responses:
"200":
description: 创建的举报。
schema:
$ref: '#/definitions/report'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:reports
summary: 创建举报
description: 根据给定参数创建一个新的用户举报。
tags:
- reports
/api/v1/reports/{id}:
get:
operationId: reportGet
parameters:
- description: 举报的 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 请求的举报。
schema:
$ref: '#/definitions/report'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:accounts
summary: 获取单条举报
description: 获取具有给定 ID 的举报。
tags:
- reports
/api/v1/statuses:
post:
consumes:
- application/json
- application/x-www-form-urlencoded
description: |-
按给定的表单字段参数创建一个新的贴文。
若 Content-Type 为 'application/json',则参数也可以在请求体中以 JSON 形式给出。
`interaction_policy` 字段可用于为此贴文设置交互策略。
如果使用表单数据提交,请使用以下模式设置交互策略:
`interaction_policy[INTERACTION_TYPE][CONDITION][INDEX]=Value`
例如:`interaction_policy[can_reply][always][0]=author`
使用 `curl` 可以按如下所示:
`curl -F 'interaction_policy[can_reply][always][0]=author' -F 'interaction_policy[can_reply][always][1]=followers' [... other form fields ...]`
JSON 等效形式为:
`curl -H 'Content-Type: application/json' -d '{"interaction_policy":{"can_reply":{"always":["author","followers"]}} [... other json fields ...]}'`
服务器将对提交的策略执行一些规范化处理,以确保您无法提交完全无效的内容。
operationId: statusCreate
parameters:
- description: |-
贴文的文字内容。
如果提供了 media_ids,此项变为可选。
当提供贴文时,附加投票将变为可选。
in: formData
name: status
type: string
x-go-name: Status
- collectionFormat: multi
description: |-
要附加的媒体附件 ID 数组。
如果提供了 media_ids,status 将变为可选,poll 不能使用。
如果贴文以表单形式提交,应使用的键为 'media_ids[]',但如果是 JSON 或 XML,则键为 'media_ids'。
in: formData
items:
type: string
name: media_ids[]
type: array
uniqueItems: true
x-go-name: MediaIDs
- collectionFormat: multi
description: |-
投票选项的数组。
如果提供了投票选项,media_ids 将不能使用,poll[expires_in] 必须提供。
in: formData
items:
type: string
name: poll[options][]
type: array
uniqueItems: true
x-go-name: PollOptions
- description: |-
投票的开放时长,单位为秒。
如果提供了此项,media_ids 不能使用,poll[options] 必须提供。
format: int64
in: formData
name: poll[expires_in]
type: integer
x-go-name: PollExpiresIn
- default: false
description: 在此投票上允许多选。
in: formData
name: poll[multiple]
type: boolean
x-go-name: PollMultiple
- default: true
description: 在投票结束前隐藏投票计数。
in: formData
name: poll[hide_totals]
type: boolean
x-go-name: PollHideTotals
- description: 被回复的贴文 ID(如果要发送的贴文是回复)。
in: formData
name: in_reply_to_id
type: string
x-go-name: InReplyToID
- description: 贴文和附加媒体应标记为敏感。
in: formData
name: sensitive
type: boolean
x-go-name: Sensitive
- description: |-
在贴文内容之前显示的警告或主题文本。
贴文通常被折叠在此字段身后。
in: formData
name: spoiler_text
type: string
x-go-name: SpoilerText
- description: 贴文的可见性。
enum:
- public
- unlisted
- private
- mutuals_only
- direct
in: formData
name: visibility
type: string
x-go-name: Visibility
- default: false
description: 如果设置为 true,此状态将仅在本站可见,不会传播到本站以外的时间线。如果设置为 false(默认),此状态将传播到您的所有关注者,以及本站时间线外的时间线。
in: formData
name: local_only
type: boolean
x-go-name: LocalOnly
- description: '***已弃用***。仅用于后向兼容。仅在 local_only 尚未设置且此字段被明确设置时使用。如果设置为 true,此贴文将在本站时间线之外传播。如果设置为 false,此贴文将不会在本站时间线之外传播。'
in: formData
name: federated
type: boolean
x-go-name: Federated
- description: |-
此贴文的计划发布时间,格式为 ISO 8601 Datetime。
如果使用 *未来* 的时间设置该参数,将返回 ScheduledStatus 而不是 Status。
且时间必须至少在当前时间之后 5 分钟。
此功能尚未实现。
如果使用 *过去* 的时间设置该参数,则对应的帖文将被标记为历史帖文,
且不会推送给用户的关注者。这主要用于导入旧帖文。
format: date-time
in: formData
name: scheduled_at
type: string
x-go-name: ScheduledAt
- description: 此贴文的 ISO 639 语言代码。
in: formData
name: language
type: string
x-go-name: Language
- description: 解析此贴文时使用的内容格式。
enum:
- text/plain
- text/markdown
in: formData
name: content_type
type: string
x-go-name: ContentType
- description: interaction_policy.can_favourite.always 的第 N 个条目。
in: formData
name: interaction_policy[can_favourite][always][0]
type: string
- description: interaction_policy.can_favourite.with_approval 的第 N 个条目。
in: formData
name: interaction_policy[can_favourite][with_approval][0]
type: string
- description: interaction_policy.can_reply.always 的第 N 个条目。
in: formData
name: interaction_policy[can_reply][always][0]
type: string
- description: interaction_policy.can_reply.with_approval 的第 N 个条目。
in: formData
name: interaction_policy[can_reply][with_approval][0]
type: string
- description: interaction_policy.can_reblog.always 的第 N 个条目。
in: formData
name: interaction_policy[can_reblog][always][0]
type: string
- description: interaction_policy.can_reblog.with_approval 的第 N 个条目。
in: formData
name: interaction_policy[can_reblog][with_approval][0]
type: string
produces:
- application/json
responses:
"200":
description: 新创建的贴文。
schema:
$ref: '#/definitions/status'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
"501":
description: scheduled_at 被设置,但此功能尚未实现
security:
- OAuth2 Bearer:
- write:statuses
summary: 创建新贴文
tags:
- statuses
put:
consumes:
- application/json
- application/x-www-form-urlencoded
operationId: statusEdit
parameters:
- description: 要编辑的贴文 ID。
in: path
name: id
required: true
type: string
- description: |-
贴文的文本内容。
如果提供了 media_ids,此项变为可选。
如果提供了文本内容,则投票(poll)也变为可选。
in: formData
name: status
type: string
x-go-name: Status
- description: |-
要附加的媒体附件 ID 数组。
如果提供了 media_ids,status 将变为可选,poll 不能使用。
如果贴文以表单形式提交,应使用的键为 'media_ids[]',但如果是 JSON 或 XML,则键为 'media_ids'。
in: formData
items:
type: string
name: media_ids
type: array
x-go-name: MediaIDs
- description: |-
投票选项的数组。
如果提供了投票选项,media_ids 将不能使用,poll[expires_in] 必须提供。
in: formData
items:
type: string
name: poll[options][]
type: array
x-go-name: PollOptions
- description: |-
投票的开放时长,单位为秒。
如果提供了此项,media_ids 不能使用,poll[options] 必须提供。
format: int64
in: formData
name: poll[expires_in]
type: integer
x-go-name: PollExpiresIn
- default: false
description: 在此投票上允许多选。
in: formData
name: poll[multiple]
type: boolean
x-go-name: PollMultiple
- default: true
description: 在投票结束前隐藏投票计数。
in: formData
name: poll[hide_totals]
type: boolean
x-go-name: PollHideTotals
- description: 贴文和媒体附件应被标记为敏感。
in: formData
name: sensitive
type: boolean
x-go-name: Sensitive
- description: |-
在贴文内容之前显示的警告或主题文本。
贴文通常被折叠在此字段后。
in: formData
name: spoiler_text
type: string
x-go-name: SpoilerText
- description: 此贴文的 ISO 639 语言代码。
in: formData
name: language
type: string
x-go-name: Language
- description: 解析此贴文时使用的内容格式。
enum:
- text/plain
- text/markdown
in: formData
name: content_type
type: string
x-go-name: ContentType
produces:
- application/json
responses:
"200":
description: 此贴文的最新版本。
schema:
$ref: '#/definitions/status'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:statuses
summary: 编辑贴文
description: 按给定的表单参数编辑某条现有贴文。如果 content-type 为 'application/json',则参数也可以在请求体中以 JSON 形式给出。
tags:
- statuses
/api/v1/statuses/{id}:
delete:
description: |-
删除给定 ID 的贴文。贴文必须属于调用API的用户。
删除的贴文将在响应中返回。`text` 字段将包含贴文的原始文本,就像它被提交时一样。这在执行“删除并重新撰写”类型操作时很有用。
operationId: statusDelete
parameters:
- description: 目标贴文 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 刚刚被删除的贴文。
schema:
$ref: '#/definitions/status'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:statuses
summary: 删除贴文
tags:
- statuses
get:
operationId: statusGet
parameters:
- description: 目标贴文 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 请求的贴文。
schema:
$ref: '#/definitions/status'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:statuses
summary: 查看贴文
description: 查看具有给定 ID 的贴文。
tags:
- statuses
/api/v1/statuses/{id}/bookmark:
post:
operationId: statusBookmark
parameters:
- description: 目标贴文 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 对应的贴文。
schema:
$ref: '#/definitions/status'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:bookmarks
summary: 收藏贴文
description: 收藏具有给定 ID 的贴文。
tags:
- statuses
/api/v1/statuses/{id}/context:
get:
description: 返回给定贴文的祖先和后代。返回的贴文将按贴文串结构排序,因此它们适合按返回顺序显示。
operationId: threadContext
parameters:
- description: 目标贴文 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 贴文串上下文对象。
schema:
$ref: '#/definitions/threadContext'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:statuses
summary: 查看贴文串上下文
tags:
- statuses
/api/v1/statuses/{id}/favourite:
post:
operationId: statusFave
parameters:
- description: 目标贴文 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 被点赞的贴文。
schema:
$ref: '#/definitions/status'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:statuses
summary: 点赞贴文
description: 点赞给定 ID 的贴文(如果允许)。
tags:
- statuses
/api/v1/statuses/{id}/favourited_by:
get:
operationId: statusFavedBy
parameters:
- description: 目标贴文 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: ""
schema:
items:
$ref: '#/definitions/account'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:accounts
summary: 查看贴文点赞列表
description: 查看点赞给定 ID 的贴文的账户。
tags:
- statuses
/api/v1/statuses/{id}/history:
get:
description: '查看给定 ID 的贴文的编辑历史。'
operationId: statusHistoryGet
parameters:
- description: 目标贴文 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: ""
schema:
items:
$ref: '#/definitions/statusEdit'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:statuses
summary: 查看贴文编辑历史
tags:
- statuses
/api/v1/statuses/{id}/mute:
post:
description: |-
静音某条贴文的贴文串,防止未来串中的回复、点赞、转发等行为产生通知。
目标贴文必须属于您或提及了您。
贴文串静音和取消静音是幂等的。如果您已经静音了一个串,再次静音它只是意味着它保持静音,您将得到 200 OK 返回。
operationId: statusMute
parameters:
- description: 目标贴文 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 被静音的贴文。
schema:
$ref: '#/definitions/status'
"400":
description: bad request 无效请求; 你不是目标贴文串的参与者
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:mutes
summary: 静音贴文串
tags:
- statuses
/api/v1/statuses/{id}/pin:
post:
description: |-
将贴文在个人资料页置顶,并将其添加到你的特色 ActivityPub 集合中。
你只能将原创贴文(非转发)固定到自己的个人资料上。
支持的固定贴文的隐私级别有 public、unlisted 和 private/followers-only,
但只有公开贴文会出现在您个人资料的网页版本上。
operationId: statusPin
parameters:
- description: 目标贴文 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 被固定的贴文。
schema:
$ref: '#/definitions/status'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:accounts
summary: 置顶贴文
tags:
- statuses
/api/v1/statuses/{id}/reblog:
post:
description: |-
转发给定 ID 的贴文。
如果目标贴文是可转发的,它将被分享给您的粉丝。
这相当于一个 ActivityPub 'Announce' 活动。
operationId: statusReblog
parameters:
- description: 目标贴文 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 被转发的贴文。
schema:
$ref: '#/definitions/status'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:statuses
summary: 转发贴文
tags:
- statuses
/api/v1/statuses/{id}/reblogged_by:
get:
operationId: statusBoostedBy
parameters:
- description: 目标贴文 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: ""
schema:
items:
$ref: '#/definitions/account'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
security:
- OAuth2 Bearer:
- read:accounts
summary: 查看贴文转发列表
description: 查看转发给定 ID 的贴文的账户。
tags:
- statuses
/api/v1/statuses/{id}/source:
get:
operationId: statusSourceGet
parameters:
- description: 目标贴文 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: ""
schema:
items:
$ref: '#/definitions/statusSource'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:statuses
summary: 查看贴文源文本
description: 查看给定 ID 的贴文的源文本。请求者必须拥有该贴文。
tags:
- statuses
/api/v1/statuses/{id}/unbookmark:
post:
operationId: statusUnbookmark
parameters:
- description: 目标贴文 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 对应的贴文。
schema:
$ref: '#/definitions/status'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:bookmarks
summary: 取消收藏贴文
description: 取消收藏给定 ID 的贴文。
tags:
- statuses
/api/v1/statuses/{id}/unfavourite:
post:
operationId: statusUnfave
parameters:
- description: 目标贴文 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 被取消点赞的贴文。
schema:
$ref: '#/definitions/status'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:favourites
summary: 取消点赞贴文
description: 取消点赞给定 ID 的贴文。
tags:
- statuses
/api/v1/statuses/{id}/unmute:
post:
description: |-
取消静音某条贴文的贴文串。这将重新启用串中未来回复、点赞、转发等行为的通知。
目标贴文必须属于您或提及了您。
贴文串静音和取消静音是幂等的。如果您已经取消静音了一个串,再次取消静音它只是意味着它保持取消静音,您将得到 200 OK 的返回状态。
operationId: statusUnmute
parameters:
- description: 目标贴文 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 被取消静音的贴文。
schema:
$ref: '#/definitions/status'
"400":
description: bad request 无效请求; 你不是目标贴文串的参与者
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:mutes
summary: 取消静音贴文串
tags:
- statuses
/api/v1/statuses/{id}/unpin:
post:
operationId: statusUnpin
parameters:
- description: 目标贴文 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 贴文。
schema:
$ref: '#/definitions/status'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:accounts
summary: 取消置顶贴文
description: 取消置顶某条已经置顶的贴文。
tags:
- statuses
/api/v1/statuses/{id}/unreblog:
post:
operationId: statusUnreblog
parameters:
- description: 目标贴文 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 被取消转发的贴文。
schema:
$ref: '#/definitions/status'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:statuses
summary: 取消转发贴文
description: 取消转发给定 ID 的贴文。
tags:
- statuses
/api/v1/streaming:
get:
description: |-
发起一个用于实时流式传输贴文和通知的 websocket 连接。
使用的协议应始终为 `wss`。流式传输根路径可以在 `/api/v1/instance` 查看。
在成功连接时,将返回代码 `101`,表示正在将连接升级为安全的 websocket 连接。
只要连接保持打开状态,就会将各种消息类型流式传输到其中。
GoToSocial 将每 30 秒对连接进行 ping,以检查客户端是否仍在接收。
如果 ping 失败,或者在传输过程中发生其他问题,则连接将被断开,并且客户端将被要求重新启动。
operationId: streamGet
parameters:
- description: 发起请求的账户的访问令牌。
in: query
name: access_token
required: true
type: string
- description: |-
请求的流类型。
可用选项有:
`user`: 接收账户的主页时间线更新。
`public`: 接收公共时间线更新。
`public:local`: 接收本站时间线更新。
`hashtag`: 接收给定话题标签的更新。
`hashtag:local`: 接收给定话题标签的本站更新。
`list`: 接收一个列表中的账户的更新。
`direct`: 接收私信的更新。
in: query
name: stream
required: true
type: string
- description: |-
要订阅的列表的 ID。
仅在流类型为 'list' 时使用。
in: query
name: list
type: string
- description: |-
要订阅的话题标签的名称。
仅在流类型为 'hashtag' 或 'hashtag:local' 时使用。
in: query
name: tag
type: string
produces:
- application/json
responses:
"101":
description: ""
schema:
properties:
event:
description: |-
要接收的事件类型。
`update`:收到新贴文。
`notification`:收到新通知。
`delete`:贴文已被删除。
`filters_changed`:过滤规则(包括关键字和贴文)已更改。
enum:
- update
- notification
- delete
- filters_changed
type: string
payload:
description: |-
流式传输消息的有效负载。
根据 `event` 类型不同而不同。
如果存在,应解析为字符串。
如果 `event` = `update`,则负载将是一个贴文的 JSON 字符串。
如果 `event` = `notification`,则负载将是一个通知的 JSON 字符串。
如果 `event` = `delete`,则负载将是一个贴文 ID。
如果 `event` = `filters_changed`,则没有负载。
example: '{"id":"01FC3TZ5CFG6H65GCKCJRKA669","created_at":"2021-08-02T16:25:52Z","sensitive":false,"spoiler_text":"","visibility":"public","language":"en","uri":"https://gts.superseriousbusiness.org/users/dumpsterqueer/statuses/01FC3TZ5CFG6H65GCKCJRKA669","url":"https://gts.superseriousbusiness.org/@dumpsterqueer/statuses/01FC3TZ5CFG6H65GCKCJRKA669","replies_count":0,"reblogs_count":0,"favourites_count":0,"favourited":false,"reblogged":false,"muted":false,"bookmarked":fals…//gts.superseriousbusiness.org/fileserver/01JNN207W98SGG3CBJ76R5MVDN/header/original/019036W043D8FXPJKSKCX7G965.png","header_static":"https://gts.superseriousbusiness.org/fileserver/01JNN207W98SGG3CBJ76R5MVDN/header/small/019036W043D8FXPJKSKCX7G965.png","followers_count":33,"following_count":28,"statuses_count":126,"last_status_at":"2021-08-02T16:25:52Z","emojis":[],"fields":[]},"media_attachments":[],"mentions":[],"tags":[],"emojis":[],"card":null,"poll":null,"text":"a"}'
type: string
stream:
items:
enum:
- user
- public
- public:local
- hashtag
- hashtag:local
- list
- direct
type: string
type: array
type: object
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
schemes:
- wss
security:
- OAuth2 Bearer:
- read:streaming
summary: 流式传输
tags:
- streaming
/api/v1/tags/{tag_name}:
get:
description: 获取话题标签详情,包括您当前是否关注它。如果话题不存在,此方法不会在数据库中创建它。
operationId: getTag
parameters:
- description: 话题标签的名称(不包含 `#`)。
in: path
name: tag_name
required: true
type: string
produces:
- application/json
responses:
"200":
description: 话题标签详情。
schema:
$ref: '#/definitions/tag'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer: []
summary: 获取话题标签
tags:
- tags
/api/v1/tags/{tag_name}/follow:
post:
description: '此端点是幂等的:如果您已经关注了话题标签,此调用仍将成功。'
operationId: followTag
parameters:
- description: 话题标签的名称(不包含 `#`)。
in: path
name: tag_name
required: true
type: string
produces:
- application/json
responses:
"200":
description: 话题标签详情。
schema:
$ref: '#/definitions/tag'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:follows
summary: 关注话题标签
tags:
- tags
/api/v1/tags/{tag_name}/unfollow:
post:
description: '此端点是幂等的:如果您没有关注话题标签,此调用仍将成功。'
operationId: unfollowTag
parameters:
- description: 话题标签的名称(不包含 `#`)。
in: path
name: tag_name
required: true
type: string
produces:
- application/json
responses:
"200":
description: 话题标签详情。
schema:
$ref: '#/definitions/tag'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: unauthorized 未授权
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:follows
summary: 取消关注话题标签
tags:
- tags
/api/v1/timelines/home:
get:
description: |-
查看你关注的账户发布的贴文。
贴文将按时间顺序(最新的在前)返回,带有连续的 ID(较大 = 较新)。
返回的 Link 标头可用于在时间线向上或向下滚动时生成上一个和下一个查询。
示例:
```
<https://example.org/api/v1/timelines/home?limit=20&max_id=01FC3GSQ8A3MMJ43BPZSGEG29M>; rel="next", <https://example.org/api/v1/timelines/home?limit=20&min_id=01FC3KJW2GYXSDDRA6RWNDM46M>; rel="prev"
````
operationId: homeTimeline
parameters:
- description: 只返回早于给定的最大贴文 ID 的贴文。具有指定 ID 的贴文不会包含在响应中。
in: query
name: max_id
type: string
- description: 只返回新于给定的最小贴文 ID 的贴文。具有指定 ID 的贴文不会包含在响应中。
in: query
name: since_id
type: string
- description: 只返回比给定的最小贴文 ID **相邻且更新** 的贴文。具有指定 ID 的贴文不会包含在响应中。
in: query
name: min_id
type: string
- default: 20
description: 要返回的贴文数量。
in: query
name: limit
type: integer
- default: false
description: 仅显示本站账户发布的贴文。
in: query
name: local
type: boolean
produces:
- application/json
responses:
"200":
description: 贴文数组。
headers:
Link:
description: 下一/上一查询的链接。
type: string
schema:
items:
$ref: '#/definitions/status'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
security:
- OAuth2 Bearer:
- read:statuses
summary: 查看主页时间线
tags:
- timelines
/api/v1/timelines/list/{id}:
get:
description: |-
查看给定列表的时间线贴文。
贴文将按时间顺序(最新的在前)返回,带有连续的 ID(较大 = 较新)。
返回的 Link 标头可用于在时间线向上或向下滚动时生成上一个和下一个查询。
示例:
```
<https://example.org/api/v1/timelines/list/01H0W619198FX7J54NF7EH1NG2?limit=20&max_id=01FC3GSQ8A3MMJ43BPZSGEG29M>; rel="next", <https://example.org/api/v1/timelines/list/01H0W619198FX7J54NF7EH1NG2?limit=20&min_id=01FC3KJW2GYXSDDRA6RWNDM46M>; rel="prev"
````
operationId: listTimeline
parameters:
- description: 列表的 ID
in: path
name: id
required: true
type: string
- description: 只返回早于给定的最大贴文 ID 的贴文。具有指定 ID 的贴文不会包含在响应中。
in: query
name: max_id
type: string
- description: 只返回新于给定的最小贴文 ID 的贴文。具有指定 ID 的贴文不会包含在响应中。
in: query
name: since_id
type: string
- description: 只返回比给定的最小贴文 ID **相邻且更新** 的贴文。具有指定 ID 的贴文不会包含在响应中。
in: query
name: min_id
type: string
- default: 20
description: 要返回的贴文数量。
in: query
name: limit
type: integer
produces:
- application/json
responses:
"200":
description: 贴文数组。
headers:
Link:
description: 下一/上一查询的链接。
type: string
schema:
items:
$ref: '#/definitions/status'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
security:
- OAuth2 Bearer:
- read:lists
summary: 查看列表时间线
tags:
- timelines
/api/v1/timelines/public:
get:
description: |-
查看你所在的实例已知的公开贴文。
贴文将按时间顺序(最新的在前)返回,带有连续的 ID(较大 = 较新)。
返回的 Link 标头可用于在时间线向上或向下滚动时生成上一个和下一个查询。
示例:
```
<https://example.org/api/v1/timelines/public?limit=20&max_id=01FC3GSQ8A3MMJ43BPZSGEG29M>; rel="next", <https://example.org/api/v1/timelines/public?limit=20&min_id=01FC3KJW2GYXSDDRA6RWNDM46M>; rel="prev"
````
operationId: publicTimeline
parameters:
- description: 只返回早于给定的最大贴文 ID 的贴文。具有指定 ID 的贴文不会包含在响应中。
in: query
name: max_id
type: string
- description: 只返回新于给定的最小贴文 ID 的贴文。具有指定 ID 的贴文不会包含在响应中。
in: query
name: since_id
type: string
- description: 只返回比给定的最小贴文 ID **相邻且更新** 的贴文。具有指定 ID 的贴文不会包含在响应中。
in: query
name: min_id
type: string
- default: 20
description: 要返回的贴文数量。
in: query
name: limit
type: integer
- default: false
description: 仅显示本站账户发布的贴文。
in: query
name: local
type: boolean
produces:
- application/json
responses:
"200":
description: 贴文数组。
headers:
Link:
description: 下一/上一查询的链接。
type: string
schema:
items:
$ref: '#/definitions/status'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
security:
- OAuth2 Bearer:
- read:statuses
summary: 查看跨站时间线
tags:
- timelines
/api/v1/timelines/tag/{tag_name}:
get:
description: |-
查看给定话题标签的公开贴文 (不区分大小写)
贴文将按时间顺序(最新的在前)返回,带有连续的 ID(较大 = 较新)。
返回的 Link 标头可用于在时间线向上或向下滚动时生成上一个和下一个查询。
示例:
```
<https://example.org/api/v1/timelines/tag/example?limit=20&max_id=01FC3GSQ8A3MMJ43BPZSGEG29M>; rel="next", <https://example.org/api/v1/timelines/tag/example?limit=20&min_id=01FC3KJW2GYXSDDRA6RWNDM46M>; rel="prev"
````
operationId: tagTimeline
parameters:
- description: Name of the tag
in: path
name: tag_name
required: true
type: string
- description: 只返回早于给定的最大贴文 ID 的贴文。具有指定 ID 的贴文不会包含在响应中。
in: query
name: max_id
type: string
- description: 只返回新于给定的最小贴文 ID 的贴文。具有指定 ID 的贴文不会包含在响应中。
in: query
name: since_id
type: string
- description: 只返回比给定的最小贴文 ID **相邻且更新** 的贴文。具有指定 ID 的贴文不会包含在响应中。
in: query
name: min_id
type: string
- default: 20
description: 要返回的贴文数量。
in: query
maximum: 40
minimum: 1
name: limit
type: integer
produces:
- application/json
responses:
"200":
description: 贴文数组。
headers:
Link:
description: 下一/上一查询的链接。
type: string
schema:
items:
$ref: '#/definitions/status'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
security:
- OAuth2 Bearer:
- read:statuses
summary: 查看话题标签时间线
tags:
- timelines
/api/v1/tokens:
get:
description: |-
查看由/为你的账户创建的令牌的相关信息。
条目将按时间降序返回(最新的在前),并带有顺序 ID(数值越大表示越新)。
返回的 Link 标头可用于在向上或向下翻页时生成上一页和下一页的查询。
例如:
```
<https://example.org/api/v1/tokens?limit=20&max_id=01FC3GSQ8A3MMJ43BPZSGEG29M>; rel="next", <https://example.org/api/v1/tokens?limit=20&min_id=01FC3KJW2GYXSDDRA6RWNDM46M>; rel="prev"
````
operationId: tokensInfoGet
parameters:
- description: 只返回早于给定的最大令牌 ID 的令牌。具有给定 ID 的令牌不会包含在响应中。
in: query
name: max_id
type: string
- description: 只返回新于给定的最小令牌 ID 的令牌。具有给定 ID 的令牌不会包含在响应中。
in: query
name: since_id
type: string
- description: 只返回比给定的最小令牌 ID **相邻且更新** 的令牌。具有指定 ID 的令牌不会包含在响应中。
in: query
name: min_id
type: string
- default: 20
description: 要返回的令牌数量。
in: query
name: limit
type: integer
produces:
- application/json
responses:
"200":
description: 令牌详情数组。
headers:
Link:
description: 下一/上一查询的链接。
type: string
schema:
items:
$ref: '#/definitions/tokenInfo'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
security:
- OAuth2 Bearer:
- read:accounts
summary: 查看令牌列表
tags:
- tokens
/api/v1/tokens/{id}:
get:
operationId: tokenInfoGet
parameters:
- description: 要查询的令牌 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 要查询的令牌。
schema:
$ref: '#/definitions/tokenInfo'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务端内部错误
security:
- OAuth2 Bearer:
- read:accounts
summary: 获取单个令牌的信息
tags:
- tokens
/api/v1/tokens/{id}/invalidate:
post:
operationId: tokenInvalidatePost
parameters:
- description: 要禁用的令牌 ID。
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 被禁用的令牌信息。
schema:
$ref: '#/definitions/tokenInfo'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务端内部错误
security:
- OAuth2 Bearer:
- write:accounts
summary: 禁用单个令牌
description: 禁用单个令牌,从数据库中删除并使其无法使用。
tags:
- tokens
/api/v1/user:
get:
operationId: getUser
produces:
- application/json
responses:
"200":
description: 请求的用户。
schema:
$ref: '#/definitions/user'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"406":
description: not acceptable 不可接受
"500":
description: internal error
security:
- OAuth2 Bearer:
- read:accounts
summary: 获取当前用户
description: 获取自己的用户模型。
tags:
- user
/api/v1/user/2fa/disable:
post:
consumes:
- application/json
- application/x-www-form-urlencoded
description: |-
如果双因素验证已被禁用,将返回 409 Conflict。
如果实例正在运行 OIDC,那么将无法在 GtS 中启用或禁用双因素验证,必须在 OIDC 提供商处启用或禁用。所有对双因素验证 API 端点的调用在 OIDC 启用时将返回 422 Unprocessable Entity。
operationId: TwoFactorDisablePost
parameters:
- description: 用户的当前密码,用于验证。
in: formData
name: password
type: string
responses:
"200":
description: 二维码
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"406":
description: not acceptable 不可接受
"409":
description: conflict 冲突
"422":
description: unprocessable entity 无法处理
"500":
description: internal error 内部错误
security:
- OAuth2 Bearer:
- write:accounts
summary: 禁用双因素验证
description: 为当前用户禁用双因素验证,必须提供用户当前密码用于验证。
tags:
- user
/api/v1/user/2fa/enable:
post:
consumes:
- application/json
- application/x-www-form-urlencoded
description: |-
如果双因素验证已被启用,将返回 409 Conflict。
如果实例正在运行 OIDC,那么将无法在 GtS 中启用或禁用双因素验证,必须在 OIDC 提供商处启用或禁用。所有对双因素验证 API 端点的调用在 OIDC 启用时将返回 422 Unprocessable Entity。
operationId: TwoFactorEnablePost
parameters:
- description: |-
用户的双因素验证代码。
示例:123456
in: formData
name: code
type: string
produces:
- application/json
responses:
"200":
description: 二维码
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"406":
description: not acceptable 不可接受
"409":
description: conflict 冲突
"422":
description: unprocessable entity 无法处理
"500":
description: internal error 内部错误
security:
- OAuth2 Bearer:
- write:accounts
summary: 启用双因素验证
description: 为当前用户启用双因素验证,使用验证器应用提供的代码,返回一个一次性恢复代码数组,以允许绕过双因素验证。
tags:
- user
/api/v1/user/2fa/qr.png:
get:
description: |-
若希望获取二维码 URI 的明文版本,请调用 /api/v1/user/2fa/qruri 接口。
若用户已经启用了双因素认证,将不会再次分享二维码(及其密钥)。反之,会返回 409 Conflict 错误。要获取新的密钥,请先使用 POST /api/v1/user/2fa/disable 接口禁用双因素认证,然后再调用此接口。
若实例启用了 OIDC,则无法在 GtS 中开启或关闭双因素认证,必须使用 OIDC 提供商进行启用或禁用。在启用 OIDC 期间,所有对 2fa API 接口的调用都将返回 422 Unprocessable Entity 错误。
operationId: TwoFactorQRCodePngGet
produces:
- image/png
responses:
"200":
description: 二维码 PNG 图片
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"406":
description: not acceptable 不可接受
"409":
description: conflict 冲突
"422":
description: unprocessable entity 无法处理
"500":
description: internal error 内部错误
security:
- OAuth2 Bearer:
- read:accounts
summary: 查看用于启用双因素认证的二维码
description: 返回一个二维码 PNG 图片,允许对应用户启用双因素认证。
tags:
- user
/api/v1/user/2fa/qruri:
get:
description: |-
若需要 PNG 格式的二维码,请调用 /api/v1/user/2fa/qr.png 接口。
若用户已经启用了双因素验证,将不会再次分享二维码(及其密钥)。反之,会返回 409 Conflict 错误。要获取新的密钥,请先使用 POST /api/v1/user/2fa/disable 接口禁用双因素验证,然后再调用此接口。
若实例启用了 OIDC,则无法在 GtS 中开启或关闭双因素验证,必须使用 OIDC 提供商进行启用或禁用。在启用 OIDC 期间,所有对双因素验证 API 接口的调用都将返回 422 Unprocessable Entity 错误。
operationId: TwoFactorQRCodeURIGet
produces:
- text/plain
responses:
"200":
description: 二维码 URI
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"406":
description: not acceptable 不可接受
"409":
description: conflict 冲突
"422":
description: unprocessable entity 无法处理
"500":
description: internal error 内部错误
security:
- OAuth2 Bearer:
- read:accounts
summary: 查看用于启用双因素验证的二维码 URI
description: 返回一个二维码 URI,允许对应用户启用双因素验证。
tags:
- user
/api/v1/user/email_change:
post:
consumes:
- application/json
- application/xml
- application/x-www-form-urlencoded
operationId: userEmailChange
parameters:
- description: 用户当前密码,用于验证。
in: formData
name: password
required: true
type: string
x-go-name: Password
- description: 新邮箱地址。
in: formData
name: new_email
required: true
type: string
x-go-name: NewEmail
produces:
- application/json
responses:
"202":
description: '已接受:正在处理邮箱更改;请检查您的收件箱以确认新地址。'
schema:
$ref: '#/definitions/user'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"406":
description: not acceptable 不可接受
"409":
description: '冲突: 提供的邮箱地址已被使用'
"500":
description: internal error 服务端内部错误
security:
- OAuth2 Bearer:
- write:accounts
summary: 更改邮箱地址
description: 请求更改当前用户的邮箱地址。
tags:
- user
/api/v1/user/password_change:
post:
consumes:
- application/json
- application/xml
- application/x-www-form-urlencoded
description: |-
修改当前用户的密码。
若 Content-Type 为 'application/json',则参数也可以在请求体中以 JSON 形式给出。
若 Content-Type 为 'application/xml',则参数也可以在请求体中以 XML 形式给出。
operationId: userPasswordChange
parameters:
- description: 用户的旧密码。
in: formData
name: old_password
required: true
type: string
x-go-name: OldPassword
- description: |-
用户提供的新密码。
如果密码的熵不够高,将被拒绝。
参见 https://github.com/wagslane/go-password-validator
in: formData
name: new_password
required: true
type: string
x-go-name: NewPassword
produces:
- application/json
responses:
"200":
description: 密码更改成功
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"406":
description: not acceptable 不可接受
"422":
description: 无法处理请求,因为实例正在使用 OIDC 后端
"500":
description: internal error 服务端内部错误
security:
- OAuth2 Bearer:
- write:accounts
summary: 更改密码
tags:
- user
/api/v2/admin/accounts:
get:
description: |-
按给定过滤规则查看并按页浏览已知账户。
返回的账户将按域名 + 用户名的字母顺序(a-z)排序。
下一个和上一个查询可以从返回的Link标头中解析。
示例:
```
<https://example.org/api/v2/admin/accounts?limit=80&max_id=example.org%2F%40someone>; rel="next", <https://example.org/api/v2/admin/accounts?limit=80&min_id=example.org%2F%40someone_else>; rel="prev"
````
operationId: adminAccountsGetV2
parameters:
- description: 针对 `local` 或 `remote` 类型的账户进行过滤。
in: query
name: origin
type: string
- description: 针对 `active`, `pending`, `disabled`, `silenced`, 或 `suspended` 类型的账户进行过滤。
in: query
name: status
type: string
- description: 针对具有站务权限(可以管理举报)的账户进行过滤。
in: query
name: permissions
type: string
- description: 针对具有对应身份组的账户进行过滤。
in: query
items:
type: string
name: role_ids[]
type: array
- description: 查找被对应 ID 的账户邀请的用户。
in: query
name: invited_by
type: string
- description: 搜索给定用户名。
in: query
name: username
type: string
- description: 搜索给定昵称。
in: query
name: display_name
type: string
- description: 针对给定实例域名进行过滤。
in: query
name: by_domain
type: string
- description: 查找具有给定电子邮箱的用户。
in: query
name: email
type: string
- description: 查找具有此 IP 地址的用户。
in: query
name: ip
type: string
- description: "`[domain]/@[username]` 形式的 max_id。返回的所有结果都将在 `[domain]/@[username]` 之后的字母顺序中。例如,如果 max_id = `example.org/@someone`,则返回的条目可能包含 `example.org/@someone_else`,`later.example.org/@someone` 等。本站账户 ID 使用空字符串作为 `[domain]` 部分,例如具有用户名 `someone` 的本站账户将是 `/@someone`。"
in: query
name: max_id
type: string
- description: "`[domain]/@[username]` 形式的 min_id。返回的所有结果都将在 `[domain]/@[username]` 之前的字母顺序中。例如,如果 min_id = `example.org/@someone`,则返回的条目可能包含 `example.org/@earlier_account`,`earlier.example.org/@someone` 等。本站账户 ID 使用空字符串作为 `[domain]` 部分,例如具有用户名 `someone` 的本站账户将是 `/@someone`。"
in: query
name: min_id
type: string
- default: 50
description: 返回的最大结果数量。
in: query
maximum: 200
minimum: 1
name: limit
type: integer
produces:
- application/json
responses:
"200":
description: ""
headers:
Link:
description: 下一/上一查询的链接。
type: string
schema:
items:
$ref: '#/definitions/adminAccountInfo'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- admin:read:accounts
summary: 查看账户列表
tags:
- admin
/api/v2/filters:
get:
operationId: filtersV2Get
produces:
- application/json
responses:
"200":
description: 请求的过滤规则。
schema:
items:
$ref: '#/definitions/filterV2'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:filters
summary: 获取V2过滤规则
description: 获取当前账户的所有V2过滤规则。
tags:
- filters
post:
consumes:
- application/json
- application/xml
- application/x-www-form-urlencoded
operationId: filterV2Post
parameters:
- description: |-
过滤规则的名称。
示例: 挂人
in: formData
maxLength: 200
minLength: 1
name: title
required: true
type: string
- collectionFormat: multi
description: |-
此过滤规则要应用的上下文。
示例: home, public
in: formData
items:
enum:
- home
- notifications
- public
- thread
- account
type: string
minItems: 1
name: context[]
required: true
type: array
uniqueItems: true
- description: |-
此过滤规则的持续时间(以秒为单位)。若省略,则过滤规则永不过期。
示例:86400
in: formData
name: expires_in
type: number
- default: warn
description: |-
贴文命中过滤规则时的操作。
示例: warn
enum:
- warn
- hide
in: formData
name: filter_action
type: string
- collectionFormat: multi
description: 要添加 (如果不使用 id 参数) 或更新 (如果使用 id 参数) 的关键词。
in: formData
items:
type: string
name: keywords_attributes[][keyword]
type: array
- collectionFormat: multi
description: 匹配关键词时是否考虑单词边界 (整词匹配)?
in: formData
items:
type: boolean
name: keywords_attributes[][whole_word]
type: array
- collectionFormat: multi
description: 要添加到过滤规则的贴文(status)。
in: formData
items:
type: string
name: statuses_attributes[][status_id]
type: array
produces:
- application/json
responses:
"200":
description: 新过滤规则。
schema:
$ref: '#/definitions/filterV2'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: 禁止对已迁移的账户执行此操作
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"409":
description: conflict 冲突(重复的标题、关键词或贴文)
"422":
description: 无法处理的内容
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:filters
summary: 创建V2过滤规则
tags:
- filters
/api/v2/filters/{id}:
delete:
operationId: filterV2Delete
parameters:
- description: 过滤规则的 ID
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 过滤规则已删除
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:filters
summary: 删除V2过滤规则
description: 删除给定 ID 的单个V2过滤规则。
tags:
- filters
get:
operationId: filterV2Get
parameters:
- description: 过滤规则的 ID
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 请求的过滤规则。
schema:
$ref: '#/definitions/filterV2'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:filters
summary: 获取单个V2过滤规则
description: 获取给定 ID 的单个V2过滤规则。
tags:
- filters
put:
consumes:
- application/json
- application/xml
- application/x-www-form-urlencoded
description: |-
更新具有给定 ID 的单个V2过滤规则。
注意,这实际上更接近于 PATCH 操作:只有提供的字段将被更新,而省略的字段将保持为以前的值。
operationId: filterV2Put
parameters:
- description: 过滤规则的 ID.
in: path
name: id
required: true
type: string
- description: |-
过滤规则的标题。
示例: 挂人
in: formData
maxLength: 200
minLength: 1
name: title
required: true
type: string
- collectionFormat: multi
description: 要添加到此过滤规则的关键词。
in: formData
items:
type: string
name: keywords_attributes[][keyword]
type: array
- collectionFormat: multi
description: 匹配关键词时是否考虑单词边界 (整词匹配)?
in: formData
items:
type: boolean
name: keywords_attributes[][whole_word]
type: array
- collectionFormat: multi
description: 要添加到过滤规则的贴文。
in: formData
items:
type: string
name: statuses_attributes[][status_id]
type: array
- collectionFormat: multi
description: |-
此过滤规则要应用的上下文。
示例: home, public
in: formData
items:
enum:
- home
- notifications
- public
- thread
- account
type: string
minItems: 1
name: context[]
required: true
type: array
uniqueItems: true
- description: |-
此过滤规则的持续时间(以秒为单位)。若省略,则过滤规则永不过期。
示例: 86400
in: formData
name: expires_in
type: number
- description: |-
贴文命中过滤规则时的操作。
示例: warn
enum:
- warn
- hide
in: formData
name: filter_action
type: string
produces:
- application/json
responses:
"200":
description: 更新后的过滤规则。
schema:
$ref: '#/definitions/filterV2'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: 禁止对已迁移的账户执行此操作
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"409":
description: conflict 冲突(重复的标题、关键词或贴文)
"422":
description: unprocessable 无法处理的内容
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:filters
summary: 更新V2过滤规则
tags:
- filters
/api/v2/filters/{id}/keywords:
get:
operationId: filterKeywordsGet
parameters:
- description: 过滤规则的 ID
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 请求的过滤规则关键词
schema:
items:
$ref: '#/definitions/filterKeyword'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:filters
summary: 获取过滤规则关键词
description: 获取给定 ID 的过滤规则的所有关键词。
tags:
- filters
post:
consumes:
- application/json
- application/xml
- application/x-www-form-urlencoded
operationId: filterKeywordPost
parameters:
- description: 要将贴文添加到的过滤规则的 ID。
in: path
name: id
required: true
type: string
- description: |-
要被过滤的文本
示例:挂人
in: formData
maxLength: 40
minLength: 1
name: keyword
required: true
type: string
- default: false
description: |-
此过滤规则是否应考虑单词边界(整词匹配)?
示例:true
in: formData
name: whole_word
type: boolean
produces:
- application/json
responses:
"200":
description: 新的过滤规则关键词。
schema:
$ref: '#/definitions/filterKeyword'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: 禁止对已迁移的账户执行此操作
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"409":
description: conflict 冲突(重复的关键词)
"422":
description: unprocessable 无法处理的内容
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:filters
summary: 添加关键词
description: 向给定 ID 的过滤规则添加关键词。
tags:
- filters
/api/v2/filters/{id}/statuses:
get:
operationId: filterStatusesGet
parameters:
- description: 过滤规则的 ID
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 请求的过滤规则贴文。
schema:
items:
$ref: '#/definitions/filterStatus'
type: array
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:filters
summary: 获取过滤规则贴文
description: 获取给定过滤规则下的所有贴文。
tags:
- filters
post:
consumes:
- application/json
- application/xml
- application/x-www-form-urlencoded
operationId: filterStatusPost
parameters:
- description: 要将贴文添加到的过滤规则的 ID。
in: path
name: id
required: true
type: string
- description: |-
要过滤的贴文的 ID。
示例:01HXA2NE0K8T1C70K90E74GYD0
in: formData
name: status_id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 新的过滤规则贴文。
schema:
$ref: '#/definitions/filterStatus'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: 禁止对已迁移的账户执行此操作
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"409":
description: conflict 冲突(重复的贴文)
"422":
description: unprocessable 无法处理的内容
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:filters
summary: 添加贴文
description: 向已有过滤规则添加一条贴文。
tags:
- filters
/api/v2/filters/keywords/{id}:
delete:
operationId: filterKeywordDelete
parameters:
- description: 过滤规则关键词的 ID
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 过滤规则关键词已删除
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:filters
summary: 删除过滤规则关键词
description: 通过指定 ID 删除某个过滤规则关键词。
tags:
- filters
get:
operationId: filterKeywordGet
parameters:
- description: 过滤规则关键词的 ID
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 请求的过滤规则关键词。
schema:
$ref: '#/definitions/filterKeyword'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:filters
summary: 获取过滤规则关键词
description: 获取具有给定 ID 的单个过滤规则关键词。
tags:
- filters
/api/v2/filters/keywords{id}:
put:
consumes:
- application/json
- application/xml
- application/x-www-form-urlencoded
operationId: filterKeywordPut
parameters:
- description: 要更新的过滤规则关键词的 ID。
in: path
name: id
required: true
type: string
- description: |-
要过滤的文本
示例:挂人
in: formData
maxLength: 40
minLength: 1
name: keyword
required: true
type: string
- description: |-
过滤时是否考虑单词边界(整词匹配)?
示例:true
in: formData
name: whole_word
type: boolean
produces:
- application/json
responses:
"200":
description: 更新后的过滤关键词。
schema:
$ref: '#/definitions/filterKeyword'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: 禁止对已迁移的账户执行此操作
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"409":
description: conflict 冲突(重复的关键词)
"422":
description: unprocessable 无法处理 content
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:filters
summary: 更新过滤规则关键词
description: 更新具有给定 ID 的单个过滤规则关键词。
tags:
- filters
/api/v2/filters/statuses/{id}:
delete:
operationId: filterStatusDelete
parameters:
- description: 过滤规则贴文的 ID
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 过滤规则贴文已删除
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- write:filters
summary: 删除过滤规则贴文
description: 删除具有给定 ID 的单个过滤规则贴文。
tags:
- filters
get:
operationId: filterStatusGet
parameters:
- description: 过滤规则贴文的 ID
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: 请求的过滤规则贴文。
schema:
$ref: '#/definitions/filterStatus'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"404":
description: not found 未找到
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
security:
- OAuth2 Bearer:
- read:filters
summary: 获取过滤规则贴文
description: 获取具有给定 ID 的单个过滤规则贴文。
tags:
- filters
/api/v2/instance:
get:
operationId: instanceGetV2
produces:
- application/json
responses:
"200":
description: 实例信息。
schema:
$ref: '#/definitions/instanceV2'
"406":
description: not acceptable 不可接受
"500":
description: internal error
summary: 查看实例信息
tags:
- instance
/livez:
get:
operationId: liveGet
responses:
"200":
description: OK
summary: 服务在线检测
description: 若 GoToSocial 服务“在线” (即能够响应HTTP请求),则返回无响应体的 200 状态码。
tags:
- health
head:
operationId: liveHead
responses:
"200":
description: OK
summary: 服务在线检测
description: 若 GoToSocial 服务“在线” (即能够响应HTTP请求),则返回 200 状态码。
tags:
- health
/nodeinfo/{schema_version}:
get:
description: '对 nodeinfo 查询返回符合规范的 nodeinfo 响应。参见: https://nodeinfo.diaspora.software/schema.html'
operationId: nodeInfoGet
parameters:
- description: 请求的 nodeinfo 规范版本。目前支持 2.0 和 2.1。
in: path
name: schema_version
required: true
type: string
produces:
- application/json; profile="http://nodeinfo.diaspora.software/ns/schema/2.0#"
- application/json; profile="http://nodeinfo.diaspora.software/ns/schema/2.1#"
responses:
"200":
description: ""
schema:
$ref: '#/definitions/nodeinfo'
summary: NodeInfo 2.0
tags:
- nodeinfo
/oauth/revoke:
post:
consumes:
- multipart/form-data
operationId: oauthTokenRevoke
parameters:
- description: 客户端 ID,在注册应用时获取。
in: formData
name: client_id
required: true
type: string
- description: 客户端密钥,在注册应用时获取。
in: formData
name: client_secret
required: true
type: string
- description: 已获取的令牌,令牌将作废。
in: formData
name: token
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK - 如果你拥有你所提供的令牌,API 调用将返回 OK 和一个空响应 `{}`。此操作是幂等的,因此多次调用此 API 将仍然返回 OK。
"400":
description: bad request 无效请求
"403":
description: forbidden - 如果你提供了一个你并不拥有的令牌,API 调用将返回 403 错误。
"406":
description: not acceptable 不可接受
"500":
description: internal server error 服务器内部错误
summary: 撤销访问令牌
description: 撤销访问令牌,使其不再可用。
tags:
- oauth
/readyz:
get:
description: 若 GoToSocial 服务“就绪” (即能够连接到数据库后端并执行简单的 SELECT),则返回无响应体的 200 状态码。若 GtS 尚未准备就绪,则在日志中记录错误(但不返回给调用方,以避免泄露内部信息)。
operationId: readyGet
responses:
"200":
description: OK
"500":
description: 尚未就绪。查看日志以获取错误信息。
summary: 服务就绪检测
tags:
- health
head:
description: 若 GoToSocial 服务“就绪” (即能够连接到数据库后端并执行简单的 SELECT),则返回无响应体的 200 状态码。若 GtS 尚未准备就绪,则在日志中记录错误(但不返回给调用方,以避免泄露内部信息)。
operationId: readyHead
responses:
"200":
description: OK
summary: 服务就绪检测
tags:
- health
/users/{username}/collections/featured:
get:
description: |-
获取某个用户的精选集合(置顶贴文)。
响应将包含 `items` 属性中的 Note URI 的有序集合。
由调用方决定是否解析提供的 Note URIs(如果它们已经缓存,则不解析)。
请求需要 HTTP 签名。
operationId: s2sFeaturedCollectionGet
parameters:
- description: 用户的账户名
in: path
name: username
required: true
type: string
produces:
- application/activity+json
responses:
"200":
description: ""
schema:
$ref: '#/definitions/swaggerFeaturedCollection'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
summary: 获取用户精选集合
tags:
- s2s/federation
/users/{username}/outbox:
get:
description: |-
获取用户的公开发件箱集合。
注意,如果 `page` 为 `false`,则响应将是一个带有 `first` 页的 Collection,如下所示。
如果 `page` 为 `true`,则响应将是一个不带 `Collection` 包装的单个 `CollectionPage`。
请求需要 HTTP 签名。
operationId: s2sOutboxGet
parameters:
- description: 账户的用户名。
in: path
name: username
required: true
type: string
- default: false
description: 按 CollectionPage 返回响应。
in: query
name: page
type: boolean
- description: 下一贴文的最小 ID,用于分页。
in: query
name: min_id
type: string
- description: 下一贴文的最大 ID,用于分页。
in: query
name: max_id
type: string
produces:
- application/activity+json
responses:
"200":
description: ""
schema:
$ref: '#/definitions/swaggerCollection'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
summary: 获取用户发件箱
tags:
- s2s/federation
/users/{username}/statuses/{status}/replies:
get:
description: |-
获取贴文的回复集合。
注意,如果 `page` 为 `false`,则响应将是一个带有 `first` 页的 Collection,如下所示。
如果 `page` 为 `true`,则响应将是一个不带 `Collection` 包装的单个 `CollectionPage`。
请求需要 HTTP 签名。
operationId: s2sRepliesGet
parameters:
- description: 账户的用户名。
in: path
name: username
required: true
type: string
- description: 贴文的 ID。
in: path
name: status
required: true
type: string
- default: false
description: 按 CollectionPage 返回响应。
in: query
name: page
type: boolean
- default: false
description: 返回仅来自贴文所有者以外的账户的回复。
in: query
name: only_other_accounts
type: boolean
- description: 下一贴文的最小 ID,用于分页。
in: query
name: min_id
type: string
produces:
- application/activity+json
responses:
"200":
description: ""
schema:
$ref: '#/definitions/swaggerCollection'
"400":
description: bad request 无效请求
"401":
description: unauthorized 未授权
"403":
description: forbidden 禁止
"404":
description: not found 未找到
summary: 获取贴文回复
tags:
- s2s/federation
schemes:
- https
- http
securityDefinitions:
OAuth2 Application:
flow: application
scopes:
write:accounts: grants write access to accounts 授予对账户的写入权限
tokenUrl: https://example.org/oauth/token
type: oauth2
OAuth2 Bearer:
authorizationUrl: https://example.org/oauth/authorize
flow: accessCode
scopes:
admin: 授予对所有内容的管理权限
admin:read: 授予对所有内容的读取权限
admin:read:accounts: 授予对账户的读取权限
admin:read:domain_allows: 授予对域名白名单的读取权限
admin:read:domain_blocks: 授予对域名黑名单的读取权限
admin:read:reports: 授予对举报的读取权限
admin:write: 授予对所有内容的写入权限
admin:write:accounts: 授予对账户的写入权限
admin:write:domain_allows: 授予对域名白名单的写入权限
admin:write:domain_blocks: 授予对域名黑名单的写入权限
admin:write:reports: 授予对举报的写入权限
profile: 授予对凭据验证端点的读取权限
push: 授予对推送的读取和写入权限
read: 授予对所有内容的读取权限
read:accounts: 授予对账户的读取权限
read:applications: 授予对用户管理的应用的读取权限
read:blocks: 授予对屏蔽状态的读取权限
read:bookmarks: 授予对收藏的读取权限
read:favourites: 授予对点赞的读取权限
read:filters: 授予对过滤规则的读取权限
read:follows: 授予对关注的读取权限
read:lists: 授予对列表的读取权限
read:mutes: 授予对隐藏状态的读取权限
read:notifications: 授予对通知的读取权限
read:search: 授予对搜索的读取权限
read:statuses: 授予对贴文的读取权限
write: 授予对所有内容的写入权限
write:accounts: 授予对账户的写入权限
write:applications: 授予对用户管理的应用的写入权限
write:blocks: 授予对屏蔽状态的写入权限
write:bookmarks: 授予对收藏的写入权限
write:conversations: 授予对对话的写入权限
write:favourites: 授予对点赞的写入权限
write:filters: 授予对过滤规则的写入权限
write:follows: 授予对关注的写入权限
write:lists: 授予对列表的写入权限
write:media: 授予对媒体的写入权限
write:mutes: 授予对隐藏状态的写入权限
write:notifications: 授予对通知的写入权限
write:reports: 授予对举报的写入权限
write:statuses: 授予对贴文的写入权限
tokenUrl: https://example.org/oauth/token
type: oauth2
swagger: "2.0"
|