/
pinboard_swagger.json
487 lines (487 loc) · 18.7 KB
/
pinboard_swagger.json
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
{
"swagger": "2.0",
"info": {
"version": "",
"title": "Pinboard",
"description": "Store, manage and share bookmarks on Pinboard",
"license": {
"name": "MIT",
"url": "http://github.com/gruntjs/grunt/blob/master/LICENSE-MIT"
}
},
"host": "api.pinboard.in",
"basePath": "/v1/",
"securityDefinitions": {},
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/posts/update": {
"get": {
"description": "Returns the most recent time a bookmark was added, updated or deleted. Use this before calling posts/all to see if the data has changed since the last fetch.",
"operationId": "Get_postUpdate_",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": "Store, manage and share bookmarks on Pinboard",
"schema": {
"type": "object"
}
}
}
}
},
"/posts/add": {
"get": {
"description": "Add a new bookmark.",
"operationId": "Get_postAdd_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "url",
"in": "query",
"required": true,
"x-is-map": false,
"type": "string",
"description": "The URL of the item."
},
{
"name": "description",
"in": "query",
"required": true,
"x-is-map": false,
"type": "string",
"description": "Title of the item. This field is unfortunately named 'description' for backwards compatibility with the delicious API."
},
{
"name": "extended",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "Description of the item. Called 'extended' for backwards compatibility with delicious API."
},
{
"name": "tags",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "List of up to 100 tags."
},
{
"name": "dt",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "Creation time for this bookmark. Defaults to current time. Datestamps more than 10 minutes ahead of server time will be reset to current server time."
},
{
"name": "replace",
"in": "query",
"required": false,
"x-is-map": false,
"default": "yes",
"type": "string",
"description": "Replace any existing bookmark with this URL. Default is yes. If set to no, will throw an error if bookmark exists."
},
{
"name": "shared",
"in": "query",
"required": false,
"x-is-map": false,
"default": "yes",
"type": "string",
"description": "Make bookmark public. Default is \"yes\" unless user has enabled the \"save all bookmarks as private\" user setting, in which case default is \"no\"."
},
{
"name": "toread",
"in": "query",
"required": false,
"x-is-map": false,
"default": "no",
"type": "string",
"description": "Marks the bookmark as unread. Default is \"no\"."
}
],
"responses": {
"200": {
"description": "Store, manage and share bookmarks on Pinboard",
"schema": {
"type": "object"
}
}
}
}
},
"/posts/delete": {
"get": {
"description": "Delete a bookmark.",
"operationId": "Get_postsDelete_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "url",
"in": "query",
"required": true,
"x-is-map": false,
"type": "string",
"description": "The URL of the item."
}
],
"responses": {
"200": {
"description": "Store, manage and share bookmarks on Pinboard",
"schema": {
"type": "object"
}
}
}
}
},
"/posts/get": {
"get": {
"description": "Returns one or more posts on a single day matching the arguments. If no date or url is given, date of most recent bookmark will be used.",
"operationId": "Get_postGet_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "tag",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "Filter by up to three tags."
},
{
"name": "dt",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "Return results bookmarked on this day."
},
{
"name": "url",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "Return bookmark for this URL."
},
{
"name": "meta",
"in": "query",
"required": false,
"x-is-map": false,
"default": "yes",
"type": "string",
"description": "Include a change detection signature in a meta attribute (yes/no)."
},
{
"name": "format",
"in": "query",
"required": false,
"x-is-map": false,
"default": "xml",
"type": "string",
"description": "Default is xml."
}
],
"responses": {
"200": {
"description": "Store, manage and share bookmarks on Pinboard",
"schema": {
"type": "object"
}
}
}
}
},
"/posts/dates": {
"get": {
"description": "Returns a list of dates with the number of posts at each date.",
"operationId": "Get_postDates_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "tag",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "Filter by up to three tags."
}
],
"responses": {
"200": {
"description": "Store, manage and share bookmarks on Pinboard",
"schema": {
"type": "object"
}
}
}
}
},
"/posts/recent": {
"get": {
"description": "Returns a list of the user's most recent posts, filtered by tag.",
"operationId": "Get_postRecent_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "tag",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "Filter by up to three tags."
},
{
"name": "count",
"in": "query",
"required": false,
"x-is-map": false,
"default": 15.0,
"type": "integer",
"format": "int32",
"description": "Number of results to return. Default is 15, max is 100."
}
],
"responses": {
"200": {
"description": "Store, manage and share bookmarks on Pinboard",
"schema": {
"type": "object"
}
}
}
}
},
"/posts/all": {
"get": {
"description": "Returns all bookmarks in the user's account.",
"operationId": "Get_postAll_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "tag",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "Filter by up to three tags."
},
{
"name": "start",
"in": "query",
"required": false,
"x-is-map": false,
"default": 0.0,
"type": "integer",
"format": "int32",
"description": "Offset value (default is 0)."
},
{
"name": "results",
"in": "query",
"required": false,
"x-is-map": false,
"type": "integer",
"format": "int32",
"description": "Number of results to return. Default is all."
},
{
"name": "fromdt",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "Return only bookmarks created after this time."
},
{
"name": "todt",
"in": "query",
"required": false,
"x-is-map": false,
"type": "string",
"description": "Return only bookmarks created before this time."
},
{
"name": "meta",
"in": "query",
"required": false,
"x-is-map": false,
"type": "integer",
"format": "int32",
"description": "Include a change detection signature for each bookmark."
},
{
"name": "format",
"in": "query",
"required": false,
"x-is-map": false,
"default": "xml",
"type": "string",
"description": "Default is xml."
}
],
"responses": {
"200": {
"description": "Store, manage and share bookmarks on Pinboard",
"schema": {
"type": "object"
}
}
}
}
},
"/posts/suggest": {
"get": {
"description": "Returns a list of popular tags and recommended tags for a given URL. Popular tags are tags used site-wide for the url; recommended tags are drawn from the user's own tags.",
"operationId": "Get_postSuggest_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "url",
"in": "query",
"required": true,
"x-is-map": false,
"type": "string",
"description": "The URL of the item."
}
],
"responses": {
"200": {
"description": "Store, manage and share bookmarks on Pinboard",
"schema": {
"type": "object"
}
}
}
}
},
"/tags/get": {
"get": {
"description": "Returns a full list of the user's tags along with the number of times they were used.",
"operationId": "getTags_",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": "Store, manage and share bookmarks on Pinboard",
"schema": {
"type": "object"
}
}
}
}
},
"/tags/delete": {
"get": {
"description": "Delete an existing tag.",
"operationId": "Get_deleteTags_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "tag",
"in": "query",
"required": true,
"x-is-map": false,
"type": "string",
"description": "The tag to delete."
}
],
"responses": {
"200": {
"description": "Store, manage and share bookmarks on Pinboard",
"schema": {
"type": "object"
}
}
}
}
},
"/tags/rename": {
"get": {
"description": "Rename an tag, or fold it in to an existing tag.",
"operationId": "Get_renameTag_",
"produces": [
"application/json"
],
"parameters": [
{
"name": "old",
"in": "query",
"required": true,
"x-is-map": false,
"type": "string",
"description": "The tag to rename. Note: match is not case sensitive."
},
{
"name": "new",
"in": "query",
"required": true,
"x-is-map": false,
"type": "string",
"description": "The new name. If empty, nothing will happen."
}
],
"responses": {
"200": {
"description": "Store, manage and share bookmarks on Pinboard",
"schema": {
"type": "object"
}
}
}
}
},
"/user/secret": {
"get": {
"description": "Get the secret RSS token (allows viewing user's private RSS feeds).",
"operationId": "Get_userSecret_",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": "Store, manage and share bookmarks on Pinboard",
"schema": {
"type": "object"
}
}
}
}
}
}
}