File tree Expand file tree Collapse file tree
swagger-spec/collection_providers Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1+ type : object
2+ description : A moderator for a collection provider.
3+ required :
4+ - id
5+ - type
6+ - attributes
7+ - relationships
8+ - links
9+ properties :
10+ id :
11+ type : string
12+ description : The unique identifier of the moderator.
13+ example : moderator_1
14+ type :
15+ type : string
16+ enum :
17+ - moderators
18+ description : Must be 'moderators'.
19+ example : moderators
20+ attributes :
21+ type : object
22+ required :
23+ - full_name
24+ - email
25+ - permission_group
26+ - date_added
27+ properties :
28+ full_name :
29+ type : string
30+ description : Full name of the moderator.
31+ example : Ada Lovelace
32+ email :
33+ type : string
34+ format : email
35+ description : Email address of the moderator.
36+ example : ada.lovelace@example.com
37+ permission_group :
38+ type : string
39+ enum :
40+ - moderator
41+ - admin
42+ description : |
43+ The permission group for the moderator.
44+ - `moderator`: Can review and moderate collection submissions.
45+ - `admin`: Can manage submissions and other moderators.
46+ example : admin
47+ date_added :
48+ type : string
49+ format : date-time
50+ description : The date the moderator was added to the provider.
51+ example : ' 2024-01-15T12:34:56Z'
52+ relationships :
53+ type : object
54+ properties :
55+ collection_provider :
56+ type : object
57+ required :
58+ - data
59+ properties :
60+ data :
61+ type : object
62+ required :
63+ - type
64+ - id
65+ properties :
66+ type :
67+ type : string
68+ enum :
69+ - collection_providers
70+ description : Must be 'collection_providers'.
71+ example : collection_providers
72+ id :
73+ type : string
74+ description : The unique identifier of the collection provider.
75+ example : provider_1
76+ links :
77+ type : object
78+ properties :
79+ self :
80+ type : string
81+ format : uri
82+ description : A link to this moderator resource.
83+ example : https://api.test.osf.io/v2/providers/collections/provider_1/moderators/moderator_1/
84+ example :
85+ id : moderator_1
86+ type : moderators
87+ attributes :
88+ full_name : Ada Lovelace
89+ email : ada.lovelace@example.com
90+ permission_group : admin
91+ date_added : ' 2024-01-15T12:34:56Z'
92+ relationships :
93+ collection_provider :
94+ data :
95+ type : collection_providers
96+ id : provider_1
97+ links :
98+ self : https://api.test.osf.io/v2/providers/collections/provider_1/moderators/moderator_1/
You can’t perform that action at this time.
0 commit comments