blob: a00780f01d962fe97c75a777ac6d7feb28c39501 (
plain)
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
|
---
swagger: "2.0"
info:
title: fatcat
description: A scalable, versioned, API-oriented catalog of bibliographic entities
and file metadata
version: 0.1.0
schemes: [http]
basePath: /v0
host: api.fatcat.wiki
consumes:
- application/json
produces:
- application/json
# TODO: try to make this work:
#x-entity-props: &ENTITYPROPS
#<<: *ENTITYPROPS
definitions:
error:
type: object
required:
- message
properties:
message:
type: string
success:
type: object
required:
- message
properties:
message:
type: string
creator_entity:
type: object
required:
- ident
- state
- name
properties:
state:
type: string
enum: ["wip", "active", "redirect", "deleted"]
ident:
type: string
#format: uuid
revision:
type: integer
redirect:
type: string
# format: uuid
name:
type: string
orcid:
type: string
# format: custom
editor:
type: object
required:
- username
properties:
username:
type: string
editgroup:
type: object
required:
- id
- editor_id
properties:
id:
type: integer
editor_id:
type: integer
changelogentry:
type: object
required:
- index
properties:
index:
type: integer
editgroup_id:
type: integer
timestamp:
type: string
format: date-time
paths:
/creator:
post:
parameters:
- name: body
in: body
schema:
$ref: "#/definitions/creator_entity"
responses:
201:
description: created
schema:
$ref: "#/definitions/creator_entity"
400:
description: bad request
schema:
$ref: "#/definitions/error"
default:
description: generic error response
schema:
$ref: "#/definitions/error"
/creator/{id}:
parameters:
- name: id
in: path
type: string
required: true
get:
responses:
200:
description: fetch a single creator by id
schema:
$ref: "#/definitions/creator_entity"
404:
description: no such creator
schema:
$ref: "#/definitions/error"
default:
description: generic error response
schema:
$ref: "#/definitions/error"
/creator/lookup:
get:
parameters:
- name: orcid
in: query
type: string
required: true
responses:
200:
description: find a single creator by external identifer
schema:
$ref: "#/definitions/creator_entity"
404:
description: no such creator
schema:
$ref: "#/definitions/error"
default:
description: generic error response
schema:
$ref: "#/definitions/error"
/editor/{username}:
parameters:
- name: username
in: path
type: string
required: true
get:
responses:
200:
description: fetch generic information about an editor
schema:
$ref: "#/definitions/editor"
404:
description: username not found
schema:
$ref: "#/definitions/error"
default:
description: generic error response
schema:
$ref: "#/definitions/error"
/editor/{username}/changelog:
parameters:
- name: username
in: path
type: string
required: true
get:
responses:
200:
description: find changes (editgroups) by this editor which have been merged
schema:
$ref: "#/definitions/changelogentry"
404:
description: username not found
schema:
$ref: "#/definitions/error"
default:
description: generic error response
schema:
$ref: "#/definitions/error"
/editgroup:
post:
responses:
201:
description: successfully created
schema:
$ref: "#/definitions/editgroup"
400:
description: invalid request parameters
schema:
$ref: "#/definitions/error"
default:
description: generic error response
schema:
$ref: "#/definitions/error"
/editgroup/{id}:
parameters:
- name: id
in: path
type: integer
required: true
get:
responses:
200:
description: fetch editgroup by identifier
schema:
$ref: "#/definitions/editgroup"
404:
description: no such editgroup
schema:
$ref: "#/definitions/error"
default:
description: generic error response
schema:
$ref: "#/definitions/error"
/editgroup/{id}/accept:
parameters:
- name: id
in: path
type: integer
required: true
post:
responses:
200:
description: merged editgroup successfully ("live")
schema:
$ref: "#/definitions/success"
400:
description: editgroup is in an unmergable state
schema:
$ref: "#/definitions/error"
404:
description: no such editgroup
schema:
$ref: "#/definitions/error"
default:
description: generic error response
schema:
$ref: "#/definitions/error"
|
