This repository has been archived by the owner on Apr 17, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
2005 lines (2003 loc) · 60.5 KB
/
openapi.yaml
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
openapi: 3.0.1
info:
title: Mitra API
description: Mitra API spec
version: 1.0.0
paths:
/oauth/token:
post:
summary: Returns an access token, to be used during API calls that are not public.
description: EIP-4361 auth doesn't require blockchain integration.
requestBody:
content:
application/json:
schema:
type: object
properties:
grant_type:
type: string
enum:
- authorization_code
- password
- eip4361
example: eip4361
code:
description: A user authorization code, obtained via GET /oauth/authorize (required if grant type is "authorization_code").
type: string
nullable: true
example: null
username:
description: User name (required if grant type is "password").
type: string
message:
description: EIP-4361 message (required if grant type is "eip4361").
type: string
example: "example.com wants you to sign in with your Ethereum account:"
signature:
description: EIP-4361 signature (required if grant type is "eip4361").
type: string
example: 0x905...
password:
description: Password (required if grant type is "password").
type: string
example: null
required:
- grant_type
responses:
200:
description: Successful operation
content:
application/json:
schema:
type: object
properties:
access_token:
type: string
token_type:
type: string
example: Bearer
scope:
type: string
example: read write follow
created_at:
type: integer
example: 1639747526
400:
description: Invalid token request
/oauth/revoke:
post:
summary: Revoke an access token to make it no longer valid for use.
security:
- tokenAuth: []
requestBody:
content:
application/json:
schema:
type: object
properties:
token:
description: The previously obtained token, to be invalidated.
type: string
responses:
200:
description: Successful operation
403:
description: Token doesn't belong to user.
/api/v1/accounts:
post:
summary: Creates a user and profile records.
requestBody:
content:
application/json:
schema:
type: object
properties:
username:
description: The desired username for the account.
type: string
password:
description: The password to be used for login. Either password or EIP-4361 message must be provided.
type: string
example: null
message:
description: EIP-4361 message
type: string
example: "example.com wants you to sign in with your Ethereum account:"
signature:
description: EIP-4361 signature (required if message is present)
type: string
example: 0x905...
invite_code:
description: Invite code
type: string
example: 9b288bfa7dc75fff53e98aa4d76e77d5
required:
- username
responses:
201:
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/CredentialAccount'
400:
description: Invalid user data
/api/v1/accounts/verify_credentials:
get:
summary: Test to make sure that the user token works.
security:
- tokenAuth: []
responses:
200:
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/CredentialAccount'
/api/v1/accounts/update_credentials:
patch:
summary: Update the user's display and preferences.
security:
- tokenAuth: []
requestBody:
content:
application/json:
schema:
type: object
properties:
display_name:
description: The display name to use for the profile.
type: string
nullable: true
note:
description: The account bio (markdown).
type: string
nullable: true
avatar:
description: Avatar image encoded as base64.
type: string
nullable: true
avatar_media_type:
description: The media type of avatar image.
type: string
nullable: true
header:
description: Header image encoded as base64.
type: string
nullable: true
header_media_type:
description: The media type of header image.
type: string
nullable: true
fields_attributes:
description: The profile fields to be set.
type: array
nullable: true
items:
type: object
properties:
name:
description: Name of the field.
type: string
value:
description: Value of the field (markdown).
type: string
responses:
200:
description: Successful operation.
content:
application/json:
schema:
$ref: '#/components/schemas/CredentialAccount'
400:
description: Invalid user data.
/api/v1/accounts/signed_update:
get:
summary: Build Update(Person) activity for signing (experimental).
responses:
200:
description: Successful operation
content:
application/json:
schema:
type: object
properties:
params:
description: Activity parameters
$ref: '#/components/schemas/ActivityParameters'
message:
description: Canonical representation of activity.
type: string
example: '{"type":"Update"}'
/api/v1/accounts/send_activity:
post:
summary: Send signed activity (experimental).
requestBody:
content:
application/json:
schema:
type: object
properties:
params:
description: Activity parameters
$ref: '#/components/schemas/ActivityParameters'
signer:
description: Signer's identifier (DID)
type: string
example: 'did:pkh:eip155:1:0xb9c5714089478a327f09197987f16f9e5d936e8a'
signature:
description: Signature value.
type: string
example: '3312dacd...'
responses:
200:
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Account'
400:
description: Invalid signature data.
/api/v1/accounts/identity_proof:
get:
summary: Get unsigned data for identity proof.
parameters:
- name: proof_type
in: query
description: Type of identity proof.
required: true
schema:
type: string
enum:
- ethereum
- minisign
- name: signer
in: query
description: Information about the signer.
required: true
schema:
type: string
example: '0xb9c5714089478a327f09197987f16f9e5d936e8a'
responses:
200:
description: Successful operation
content:
application/json:
schema:
type: object
properties:
did:
description: Signer ID (DID).
type: string
example: did:pkh:eip155:1:0xb9c5714089478a327f09197987f16f9e5d936e8a
claim:
description: Identity claim serialized as compact JSON.
type: string
example: '{"id":"https://example.com/users/1","ownerOf":"did:pkh:eip155:1:0xb9c5714089478a327f09197987f16f9e5d936e8a"}'
400:
description: Invalid request parameters
post:
summary: Submit identity proof.
requestBody:
content:
application/json:
schema:
type: object
properties:
did:
description: Signer (DID).
type: string
example: 'did:pkh:eip155:1:0xb9c5714089478a327f09197987f16f9e5d936e8a'
signature:
description: Signature value.
type: string
example: '3312dacd...'
responses:
200:
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Account'
400:
description: Invalid proof data.
/api/v1/accounts/relationships:
get:
summary: Find out whether a given actor is followed, blocked, muted, etc.
parameters:
- name: 'id[]'
in: query
description: Actor IDs to check
required: true
schema:
type: string
format: uuid
responses:
200:
description: Successful operation
content:
application/json:
schema:
description: Relationship list
type: array
items:
$ref: '#/components/schemas/Relationship'
/api/v1/accounts/lookup:
get:
summary: Lookup webfinger address.
parameters:
- name: acct
in: query
description: The username or Webfinger address to lookup.
required: true
schema:
type: string
responses:
200:
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Account'
404:
description: Profile not found
/api/v1/accounts/search:
get:
summary: Search for matching profiles by username.
parameters:
- name: q
in: query
description: What to search for
required: true
schema:
type: string
- name: resolve
in: query
description: Attempt WebFinger lookup.
required: false
schema:
type: boolean
- name: limit
in: query
description: Maximum number of results. Defaults to 40.
required: false
schema:
type: number
responses:
200:
description: Successful operation
content:
application/json:
schema:
description: Profile list
type: array
items:
$ref: '#/components/schemas/Account'
/api/v1/accounts/search_did:
get:
summary: Search profile by DID
parameters:
- name: did
in: query
description: Decentralized identifier (DID)
required: true
schema:
type: string
responses:
200:
description: Successful operation
content:
application/json:
schema:
description: Profile list
type: array
items:
$ref: '#/components/schemas/Account'
400:
description: Invalid DID
/api/v1/accounts/{account_id}:
get:
summary: View information about a profile.
parameters:
- $ref: '#/components/parameters/account_id'
responses:
200:
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Account'
404:
description: Profile not found
/api/v1/accounts/{account_id}/statuses:
get:
summary: Posts created by the given actor.
parameters:
- $ref: '#/components/parameters/account_id'
- name: exclude_replies
in: query
description: Exclude replies from results.
required: false
schema:
type: boolean
default: true
- name: max_id
in: query
description: Return results older than this ID.
required: false
schema:
type: string
format: uuid
- name: limit
in: query
description: Maximum number of results to return.
required: false
schema:
type: integer
default: 20
responses:
200:
description: Successful operation
content:
application/json:
schema:
description: Post list
type: array
items:
$ref: '#/components/schemas/Status'
404:
description: Profile not found
/api/v1/accounts/{account_id}/followers:
get:
summary: Actors which follow the given actor.
parameters:
- $ref: '#/components/parameters/account_id'
- name: max_id
in: query
description: Return results with relationship ID older than this value.
required: false
schema:
type: integer
- name: limit
in: query
description: Maximum number of results to return.
required: false
schema:
type: integer
default: 40
responses:
200:
description: Successful operation
content:
application/json:
schema:
description: Profile list
type: array
items:
$ref: '#/components/schemas/Account'
headers:
Link:
description: Link to the next page
schema:
type: string
example: '<https://example.org/api/v1/accounts/1/followers?limit=40&max_id=7628164>; rel="next"'
404:
description: Profile not found
/api/v1/accounts/{account_id}/following:
get:
summary: Actors which the given actor is following.
parameters:
- $ref: '#/components/parameters/account_id'
- name: max_id
in: query
description: Return results with relationship ID older than this value.
required: false
schema:
type: integer
- name: limit
in: query
description: Maximum number of results to return.
required: false
schema:
type: integer
default: 40
responses:
200:
description: Successful operation
content:
application/json:
schema:
description: Profile list
type: array
items:
$ref: '#/components/schemas/Account'
headers:
Link:
description: Link to the next page
schema:
type: string
example: '<https://example.org/api/v1/accounts/1/following?limit=40&max_id=7628164>; rel="next"'
404:
description: Profile not found
/api/v1/accounts/{account_id}/subscribers:
get:
summary: Subscriptions to the given actor.
parameters:
- $ref: '#/components/parameters/account_id'
- name: max_id
in: query
description: Return results with subscription ID older than this value.
required: false
schema:
type: integer
- name: limit
in: query
description: Maximum number of results to return.
required: false
schema:
type: integer
default: 40
responses:
200:
description: Successful operation
content:
application/json:
schema:
description: Subscription list
type: array
items:
$ref: '#/components/schemas/Subscription'
404:
description: Profile not found
/api/v1/accounts/{account_id}/follow:
post:
summary: Follow the given actor.
security:
- tokenAuth: []
parameters:
- $ref: '#/components/parameters/account_id'
requestBody:
content:
application/json:
schema:
type: object
properties:
reblogs:
description: Receive this actor's reposts in home timeline?
type: boolean
default: true
replies:
description: Receive this actor's replies in home timeline?
type: boolean
default: true
responses:
200:
description: Successfully followed, or actor was already followed
content:
application/json:
schema:
$ref: '#/components/schemas/Relationship'
404:
description: Profile not found
/api/v1/accounts/{account_id}/unfollow:
post:
summary: Unfollow the given actor.
security:
- tokenAuth: []
parameters:
- $ref: '#/components/parameters/account_id'
responses:
200:
description: Successfully unfollowed, or actor was already not followed
content:
application/json:
schema:
$ref: '#/components/schemas/Relationship'
404:
description: Profile not found
/api/v1/accounts/{account_id}/aliases:
get:
summary: Get actor's verified aliases.
parameters:
- $ref: '#/components/parameters/account_id'
responses:
200:
description: Successful operation
content:
application/json:
schema:
description: Profile list
type: array
items:
$ref: '#/components/schemas/Account'
404:
description: Profile not found
/api/v1/accounts/{account_id}/aliases/all:
get:
summary: Get actor's aliases.
parameters:
- $ref: '#/components/parameters/account_id'
responses:
200:
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Aliases'
404:
description: Profile not found
/api/v1/apps:
post:
summary: Create a new application to obtain OAuth2 credentials.
requestBody:
content:
application/json:
schema:
type: object
properties:
client_name:
description: A name for your application.
type: string
redirect_uris:
description: Where the user should be redirected after authorization.
type: string
scopes:
description: Space separated list of scopes.
type: string
example: 'read write'
website:
description: An URL to the homepage of your app.
type: string
nullable: true
responses:
200:
description: Successful operation
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Application'
- type: object
properties:
client_id:
description: Client ID key, to be used for obtaining OAuth tokens.
type: string
client_secret:
description: Client secret key, to be used for obtaining OAuth tokens.
type: string
400:
description: Invalid request data.
/api/v1/custom_emojis:
get:
summary: Returns custom emojis that are available on the server.
responses:
200:
description: Successful operation
content:
application/json:
schema:
description: Emoji list
type: array
items:
$ref: '#/components/schemas/CustomEmoji'
/api/v1/directory:
get:
summary: List profiles visible in the directory.
parameters:
- name: offset
in: query
description: How many profiles to skip before returning results.
required: false
schema:
type: integer
default: 0
- name: limit
in: query
description: How many profiles to load.
required: false
schema:
type: integer
default: 40
- name: local
in: query
description: Only return local profiles.
required: false
schema:
type: boolean
default: true
responses:
200:
description: Successful operation
content:
application/json:
schema:
description: Profile list
type: array
items:
$ref: '#/components/schemas/Account'
/api/v1/instance:
get:
summary: Information about the instance.
security: []
responses:
200:
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Instance'
/api/v1/media:
post:
summary: Create an attachment to be used with a new post.
security:
- tokenAuth: []
requestBody:
content:
application/json:
schema:
type: object
properties:
file:
description: File encoded as base64.
type: string
media_type:
description: Media type.
type: string
nullable: true
example: image/jpeg
responses:
200:
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Attachment'
/api/v1/notifications:
get:
summary: Notifications concerning the user.
parameters:
- name: max_id
in: query
description: Return results older than this ID.
required: false
schema:
type: integer
- name: limit
in: query
description: Maximum number of results to return.
required: false
schema:
type: integer
default: 20
responses:
200:
description: Successful operation
content:
application/json:
schema:
description: Notification list
type: array
items:
$ref: '#/components/schemas/Notification'
/api/v1/settings/client_config:
post:
summary: Update client configuration.
security:
- tokenAuth: []
requestBody:
content:
application/json:
schema:
description: |
Client configuration.
Should contain a single key identifying type of client.
type: object
example: {"mitra-web":{"theme":"dark"}}
responses:
200:
description: Successful operation.
content:
application/json:
schema:
$ref: '#/components/schemas/CredentialAccount'
400:
description: Invalid request data.
/api/v1/settings/change_password:
post:
summary: Set or change user's password.
security:
- tokenAuth: []
requestBody:
content:
application/json:
schema:
type: object
properties:
new_password:
description: New password.
type: string
responses:
200:
description: Successful operation.
content:
application/json:
schema:
$ref: '#/components/schemas/CredentialAccount'
400:
description: Invalid request data.
/api/v1/settings/aliases:
post:
summary: Add alias (not verified).
requestBody:
content:
application/json:
schema:
type: object
properties:
acct:
description: Actor address.
type: string
example: [email protected]
responses:
200:
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Aliases'
404:
description: Profile not found.
/api/v1/settings/export_followers:
get:
summary: Export followers to CSV file
security:
- tokenAuth: []
responses:
200:
description: Successful operation
content:
text/csv:
schema:
type: string
example: |
/api/v1/settings/export_follows:
get:
summary: Export follows to CSV file
security:
- tokenAuth: []
responses:
200:
description: Successful operation
content:
text/csv:
schema:
type: string
example: |
/api/v1/settings/import_follows:
post:
summary: Import follows from CSV file.
security:
- tokenAuth: []
requestBody:
content:
application/json:
schema:
type: object
properties:
follows_csv:
description: The list of followers in CSV format.
type: string
responses:
204:
description: Successful operation
400:
description: Invalid data.
/api/v1/settings/move_followers:
post:
summary: Move followers from remote alias.
requestBody:
content:
application/json:
schema:
type: object
properties:
from_actor_id:
description: The actor ID to move from.
type: string
example: 'https://xyz.com/users/test'
followers_csv:
description: The list of followers in CSV format.
type: string
example: |
responses:
200:
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/CredentialAccount'
400:
description: Invalid data.
/api/v1/statuses:
post:
summary: Create new post.
security:
- tokenAuth: []
requestBody:
content:
application/json:
schema:
type: object
properties:
status:
description: Text content of the post.
type: string
content_type:
description: Media type of the post content.
type: string
default: text/html
enum:
- text/html
- text/markdown
'media_ids[]':
description: Array of Attachment ids to be attached as media.
type: array
items:
type: string
format: uuid
in_reply_to_id:
description: ID of the post being replied to, if post is a reply.
type: string
format: uuid
visibility:
description: Visibility of the post.
$ref: '#/components/schemas/Visibility'
sensitiive:
description: Mark post and attached media as sensitive?
type: boolean
default: false
mentions:
description: Array of profile IDs to be mentioned
type: array
items:
type: string
format: uuid
required:
- status
responses:
200:
description: Post created
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
400:
description: Invalid post data
/api/v1/statuses/preview:
post:
summary: Preview new post.
security:
- tokenAuth: []
requestBody:
content:
application/json:
schema:
type: object
properties:
status:
description: Text content of the post.
type: string
content_type:
description: Media type of the post content.
type: string
default: text/html