forked from programmable-web-project-unioulu/PWP
-
Notifications
You must be signed in to change notification settings - Fork 0
/
apiary.apib
1406 lines (1076 loc) · 43 KB
/
apiary.apib
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
FORMAT: 1A
HOST: https://polls.apiblueprint.org/
# Florida Man Generator
This API allows users to find Florida Man news articles. The API serves JSON data extended by the Mason hypermedia format. Users can find articles and also add new articles. They can also list articles added by other users to see what they have come up with.
# Group Link Relations
This section described custom link relations defined in this API. These are not resources. The API also uses
[IANA link relations](http://www.iana.org/assignments/link-relations/link-relations.xhtml) where applicable. Custom link relations are CURIEs that use the floman prefix.
## add-article
This is a control that is used to add an article to the associated collection resource. The control includes a JSON schema and must be accessed with POST.
## articles-all
Leads to the root level articles collection which is a list of all articles known to the API.
## article-by-date
Leads to an article item resource associated with the date provided.
## add-user
This is a control that is used to add a user to the associated collection resource. The control includes a JSON schema and must be accessed with POST.
## users-all
Leads to the root level users collection which is a list of all users known to the API.
## owned-articles
Leads to an added article item resource associated with the user provided.
## user-by-name
Leads to an user item resource associated with the username provided.
## add-addedarticle
This is a control that is used to add an added article to the associated collection resource. The control includes a JSON schema and must be accessed with POST.
## addedarticles-all
Leads to the root level users collection which is a list of all added articles known to the API.
## addedarticle-by-owner
Leads to an added article item resource associated with the owner provided.
# Group Profiles
This section includes resource profiles which provide semantic descriptions for the attributes of each resource, as well as the list of controls (by link relation) available from that resource.
## Article Profile
Profile definition for all article related resources.
### Link Relations
This section lists all possible link relations associated with articles; not all of them are necessarily present on each resource type. The following link relations from the floman namespace are used:
* [add-article](reference/link-relations/add-article)
* [articles-all](reference/link-relations/articles-add)
* [article-by-date](reference/link-relations/article-by-date)
The following [IANA RFC5988](http://www.iana.org/assignments/link-relations/link-relations.xhtml) link relations are also used:
* profile
* items
* self
* edit
* delete
### Semantic Descriptors
#### Data Type Article
* `date`: Date of the article. Mandatory and unique.
* `link`: Link to the article. Optional.
* `headline`: Headline of the article. Mandatory
## User Profile
Profile definition for all user related resources.
### Link Relations
This section lists all possible link relations associated with users; not all of them are necessarily present on each resource type. The following link relations from the floman namespace are used:
* [add-user](reference/link-relations/add-user)
* [users-all](reference/link-relations/users-all)
* [user-by-name](reference/link-relations/user-by-name)
* [owned-articles](reference/link-relations/owned-articles)
The following [IANA RFC5988](http://www.iana.org/assignments/link-relations/link-relations.xhtml) link relations are also used:
* profile
* items
* self
* edit
* delete
### Semantic Descriptors
#### Data Type Track
* `username`: Name of the user. Mandatory and unique.
## Added article Profile
Profile definition for all added article related resources.
### Link Relations
This section lists all possible link relations associated with added articles; not all of them are necessarily present on each resource type. The following link relations from the floman namespace are used:
* [add-addedarticle](reference/link-relations/add-addedarticle)
* [addedarticles-all](reference/link-relations/addedarticles-all)
* [addedarticle-by-owner](reference/link-relations/addedarticle-by-owner)
The following [IANA RFC5988](http://www.iana.org/assignments/link-relations/link-relations.xhtml) link relations are also used:
* profile
* items
* self
* edit
* delete
* owner
### Semantic Descriptors
#### Data Type Track
* `id`: ID of the article. Generated automatically.
* `date`: Date of the article. Optional.
* `link`: Link to the article. Optional.
* `headline`: headline of the article. Mandatory.
* `owner_username`: Username of the owner of the article. Mandatory. Points to some user.
## Error Profile
Profile definition for all errors returned by the API. See [Mason error control](https://github.com/JornWildt/Mason/blob/master/Documentation/Mason-draft-2.md#property-name-error) for more information about errors.
+ Attributes
+ resource_url (string, required) - URI of the resource the error was generated from.
# Group Entry
This group contains the entry point of the API
## Entry Point [/api/]
### Get entry point [GET]
Get the API entry point
+ Request
+ Headers
Accept: application/vnd.mason+json
+ Response 200 (application/vnd.mason+json)
+ Body
{
"@namespaces": {
"floman": {
"name": "/floridaman/link-relations#"
}
},
"@controls": {
"floman:articles-all": {
"href": "/api/articles/"
},
"floman:users-all": {
"href": "/api/users/"
},
"floman:addedarticles-all": {
"href": "/api/addedarticles/"
}
}
}
# Group Articles
All of these resources use the [Article Profile](reference/profiles/article-profile). In error scenarios [Error Profile](reference/profiles/error-profile) is used.
## Article Collection [/api/articles/]
A list of all articles known to the API. You can also add new articles with POST, edit articles using PUT and delete articles using DELETE.
### List all articles [GET]
Get a list of all articles known to the API.
+ Relation: articles-all
+ Request
+ Headers
Accept: application/vnd.mason+json
+ Response 200 (application/vnd.mason+json)
+ Body
{
"@namespaces": {
"floman": {
"name": "/floridaman/link-relations#"
}
},
"@controls": {
"profile": {
"href": "/profiles/article/"
},
"floman:add-article": {
"href": "/api/articles/",
"title": "Add a new article",
"encoding": "json",
"method": "POST",
"schema": {
"type": "object",
"properties": {
"date": {
"description": "Date of the article",
"type": "string",
"pattern": "^[0-3][0-9]\.[0-1][0-9]\.[0-9][0-9][0-9][0-9]$"
},
"link": {
"description": "Link to the article",
"type": "string"
},
"headline": {
"description": "Headline of the article",
"type": "string"
}
},
"required": ["date"]
}
},
"floman:article-by-date": {
"href": "/api/articles/{date}/",
"title": "Article by date",
"isHrefTemplate": true,
"schema": {
"type": "object",
"properties": {
"date": {
"description": "Date of the article you want to find",
"type": "string",
"pattern": "^[0-3][0-9]\.[0-1][0-9]\.[0-9][0-9][0-9][0-9]$"
}
},
"required": ["date"]
}
}
},
"items": [
{
"date": "02.01.2019",
"link": "https://www.wcjb.com/content/news/Florida-man-doesnt-get-straw-attacks-McDonalds-employee-503812581.html",
"headline": "Florida man doesn't get straw, attacks McDonald's employee",
"modtime": "Some modificationg date"
}
]
}
### Add article [POST]
Adds a new article. The article representation must be valid against the article schema.
+ Relation: add-article
+ Request (application/json)
+ Headers
Accept: application/vnd.mason+json
+ Body
{
"date": "05.05.2015",
"link": "http://google.com",
"headline": "Some Headline"
}
+ Response 201
+ Headers
Location: /api/articles/05.05.2015/
+ Response 400 (application/vnd.mason+json)
The client is trying to send a JSON document that doesn't validate against the schema.
+ Body
{
"resource_url": "/api/articles/05.05.2015/",
"@error": {
"@message": "Invalid JSON document",
"@messages": ["'date' and 'headline' are required properties"]
},
"@controls": {
"profile": {
"href": "/profiles/error/"
}
}
}
+ Response 409 (application/vnd.mason+json)
The client is trying to add an article with a date that's already used by another article.
+ Body
{
"resource_url": "/api/articles/05.05.2015/",
"@error": {
"@message": "Already exists",
"@messages": [
"An article with date '05.05.2015' already exists."
]
},
"@controls": {
"profile": {
"href": "/profiles/error/"
}
}
}
+ Response 415 (application/vnd.mason+json)
The client did not use the proper content type, or the request body was not valid JSON.
+ Body
{
"resource_url": "/api/articles/05.05.2015/",
"@error": {
"@message": "Unsupported media type",
"@messages": [
"Use JSON"
]
},
"@controls": {
"profile": {
"href": "/profiles/error-profile/"
}
}
}
## Article item [/api/articles/{date}/]
A single article known to the API. The article is fetched using the date of the article. You can only get the article from associated collection using GET.
+ Parameters
+ date (string, required) - Date of the article
### Get Article [GET]
Gets the article from collection.
+ Relation: article-by-date
+ Request
+ Headers
Accept: application/vnd.mason+json
+ Response 200 (application/vnd.mason+json)
+ Body
{
"@namespaces": {
"floman": {
"name": "/floridaman/link-relations#"
}
},
"date": "02.01.2019",
"link": "https://www.wcjb.com/content/news/Florida-man-doesnt-get-straw-attacks-McDonalds-employee-503812581.html",
"headline": "Florida man doesn't get straw, attacks McDonald's employee"
"@controls": {
"floman:articles-all": {
"href": "/api/articles/"
},
"profile": {
"href": "/profiles/article/"
},
"self": {
"href": "/api/articles/02.01.2019/"
},
"edit": {
"href": "/api/articles/02.01.2019/",
"title": "Edit this article",
"encoding": "json",
"method": "PUT",
"schema": {
"type": "object",
"properties": {
"date": {
"description": "Date of the article",
"type": "string",
"pattern": "^[0-3][0-9]\.[0-1][0-9]\.[0-9][0-9][0-9][0-9]$"
},
"link": {
"description": "Link to the article",
"type": "string"
},
"headline": {
"description": "Headline of the article",
"type": "string"
}
}
},
"required": []
},
"floman:delete": {
"href": "/api/articles/02.01.2019/",
"title": "Delete this article",
"method": "DELETE"
}
}
}
+ Response 404 (application/vnd.mason+json)
The client is trying to edit an article that doesn't exist.
+ Body
{
"resource_url": "/api/articles/date/",
"@error": {
"@message": "Article not found",
"@messages": [null]
},
"@controls": {
"profile": {
"href": "/profiles/error/"
}
}
}
### Edit article [PUT]
Replace the article's representation with a new one. Missing optinal fields will be set to null. Must validate against the article schema.
+ Relation: edit
+ Request (application/json)
+ Headers
Accept: application/vnd.mason+json
+ Body
{
"date": "05.05.2015",
"link": "http://google.com",
"headline": "Some Headline"
}
+ Response 204
+ Response 400 (application/vnd.mason+json)
The client is trying to send a JSON document that doesn't validate against the schema.
+ Body
{
"resource_url": "/api/articles/05.05.2015/",
"@error": {
"@message": "Invalid JSON document",
"@messages": ["'date' and 'headline' are required properties"]
},
"@controls": {
"profile": {
"href": "/profiles/error/"
}
}
}
+ Response 404 (application/vnd.mason+json)
The client is trying to edit an article that doesn't exist.
+ Body
{
"resource_url": "/api/articles/05.05.2015/",
"@error": {
"@message": "Article not found",
"@messages": [null]
},
"@controls": {
"profile": {
"href": "/profiles/error/"
}
}
}
+ Response 409 (application/vnd.mason+json)
The client is trying to change the date of the article to a one that is already in use.
+ Body
{
"resource_url": "/api/articles/05.05.2015/",
"@error": {
"@message": "Provided date is already in use.",
"@messages": ["Date '05.05.2015' is already used by other article"]
},
"@controls": {
"profile": {
"href": "/profiles/error/"
}
}
}
+ Response 415 (application/vnd.mason+json)
The client sent a request with the wrong content type or the request body was not valid JSON.
+ Body
{
"resource_url": "/api/articles/05.05.2015/",
"@error": {
"@message": "Unsupported media type",
"@messages": [
"Use JSON"
]
},
"@controls": {
"profile": {
"href": "/profiles/error-profile/"
}
}
}
### Delete article [DELETE]
Deletes the article.
+ Relation: delete
+ Request
+ Headers
Accept: application/vnd.mason+json
+ Response 204
+ Response 404 (application/vnd.mason+json)
The client is trying to delete an article that doesn't exist.
+ Body
{
"resource_url": "/api/articles/05.05.2015/",
"@error": {
"@message": "Article not found",
"@messages": [null]
},
"@controls": {
"profile": {
"href": "/profiles/error/"
}
}
}
# Group Users
All of these resources use the [User Profile](reference/profiles/user-profile). In error scenarios [Error Profile](reference/profiles/error-profile) is used.
## User Collection [/api/users/]
A list of all users known to the API. You can also add new user with POST, edit existing user using PUT and delete existing user using DELETE.
### Get Users [GET]
Gets all users from collection.
+ Relation: users-all
+ Request
+ Headers
Accept: application/vnd.mason+json
+ Response 200 (application/vnd.mason+json)
+ Body
{
"@namespaces": {
"floman": {
"name": "/floridaman/link-relations#"
}
},
"@controls": {
"profile": {
"href": "/profiles/user/"
},
"floman:user-by-name": {
"href": "/api/users/{username}/",
"title": "Get a user by name",
"isHrefTemplate": true,
"schema": {
"type": "object",
"properties": {
"username": {
"description": "Username of the user",
"type": "string"
}
},
"required": ["username"]
}
},
"floman:add-user": {
"href": "/api/users/",
"title": "Add a new user",
"encoding": "json",
"method": "POST",
"schema": {
"type": "object",
"properties": {
"username": {
"description": "Username of the user",
"type": "string"
}
},
"required": ["username"]
}
}
},
"items": [
{
"username": "sample1"
}
]
}
### Add user [POST]
Adds a new user. The user representation must be valid against the user schema.
+ Relation: add-user
+ Request (application/json)
+ Headers
Accept: application/vnd.mason+json
+ Body
{
"username": "svenskapojkarna"
}
+ Response 201
+ Headers
Location: /api/users/svenskapojkarna/
+ Response 400 (application/vnd.mason+json)
The client is trying to send a JSON document that doesn't validate against the schema.
+ Body
{
"resource_url": "/api/users/svenskapojkarna/",
"@error": {
"@message": "Invalid JSON document",
"@messages": ["'username' is a required property"]
},
"@controls": {
"profile": {
"href": "/profiles/error/"
}
}
}
+ Response 409 (application/vnd.mason+json)
The client is trying to add a user with a username that's already used by another user.
+ Body
{
"resource_url": "/api/users/svenskapojkarna/",
"@error": {
"@message": "Already exists",
"@messages": [
"The username is already used by another user."
]
},
"@controls": {
"profile": {
"href": "/profiles/error/"
}
}
}
+ Response 415 (application/vnd.mason+json)
The client did not use the proper content type, or the request body was not valid JSON.
+ Body
{
"resource_url": "/api/users/svenskapojkarna/",
"@error": {
"@message": "Unsupported media type",
"@messages": [
"Use JSON"
]
},
"@controls": {
"profile": {
"href": "/profiles/error-profile/"
}
}
}
## User item [/api/users/{username}/]
A single user known to the API. The user is fetched using the username. You can only get the user from associated collection using GET.
+ Parameters
+ username (string, required) - Name of the user to be fetched.
### Get User [GET]
Gets the user from collection.
+ Relation: user-by-name
+ Request
+ Headers
Accept: application/vnd.mason+json
+ Response 200 (application/vnd.mason+json)
+ Body
{
"@namespaces": {
"floman": {
"name": "/floridaman/link-relations#"
}
},
"username": "sample1",
"@controls": {
"floman:users-all": {
"href": "/api/users/"
},
"profile": {
"href": "/profiles/user/"
},
"self": {
"href": "/api/users/sample1/"
},
"edit": {
"href": "/api/users/sample1/",
"title": "Edit this user",
"encoding": "json",
"method": "PUT",
"schema": {
"type": "object",
"properties": {
"username": {
"description": "Username of the user",
"type": "string"
}
}
},
"required": ["username"]
},
"floman:delete": {
"href": "/api/users/sample1/",
"title": "Delete this user",
"method": "DELETE"
},
"floman:owned-articles": {
"href": "/api/addedarticles/?owner={someOwner}",
"title": "Get articles owned by this user",
"isHrefTemplate": true,
"schema": {
"type": "object",
"properties": {
"someOwner": {
"description": "Username of the owner of the article",
"type": "String"
}
}
},
"required": ["someOwner"]
}
}
}
### Edit user [PUT]
Replace the user's name with a new one. Must validate against the article schema.
+ Relation: edit
+ Request (application/json)
+ Headers
Accept: application/vnd.mason+json
+ Body
{
"username": "svenskapojkarna"
}
+ Response 204
+ Response 400 (application/vnd.mason+json)
The client is trying to send a JSON document that doesn't validate against the schema.
+ Body
{
"resource_url": "/api/users/svenskapojkarna/",
"@error": {
"@message": "Invalid JSON document",
"@messages": ["'username' is a required property"]
},
"@controls": {
"profile": {
"href": "/profiles/error/"
}
}
}
+ Response 404 (application/vnd.mason+json)
The client is trying to edit a user that doesn't exist.
+ Body
{
"resource_url": "/api/users/svenskapojkarna/",
"@error": {
"@message": "User not found",
"@messages": [null]
},
"@controls": {
"profile": {
"href": "/profiles/error/"
}
}
}
+ Response 409 (application/vnd.mason+json)
The client is trying to change the name of the user to a one that is already in use.
+ Body
{
"resource_url": "/api/users/svenskapojkarna/",
"@error": {
"@message": "Provided name is already in use.",
"@messages": ["'svenskapojkarna' is already used by other user"]
},
"@controls": {
"profile": {
"href": "/profiles/error/"
}
}
}
+ Response 415 (application/vnd.mason+json)
The client sent a request with the wrong content type or the request body was not valid JSON.
+ Body
{
"resource_url": "/api/users/svenskapojkarna/",
"@error": {
"@message": "Unsupported media type",
"@messages": [
"Use JSON"
]
},
"@controls": {
"profile": {
"href": "/profiles/error-profile/"
}
}
}
### Delete user [DELETE]
Deletes the user.
+ Relation: delete
+ Request
+ Headers
Accept: application/vnd.mason+json
+ Response 204
+ Response 404 (application/vnd.mason+json)
The client is trying to delete a user that doesn't exist.
+ Body
{
"resource_url": "/api/users/svenskapojkarna/",
"@error": {
"@message": "User not found",
"@messages": [null]
},
"@controls": {
"profile": {
"href": "/profiles/error/"
}
}
}
# Group Added Articles
All of these resources use the [Added Article Profile](reference/profiles/addedarticle-profile). In error scenarios [Error Profile](reference/profiles/error-profile) is used.
## Added article collection [/api/addedarticles/]
A list of all added articles known to the API. You can also add new articles with POST, edit existing article using PUT and delete existing article using DELETE.
### Get added articles [GET]
Gets all added articles from collection.
+ Relation: addedarticles-all
+ Request
+ Headers
Accept: application/vnd.mason+json
+ Response 200 (application/vnd.mason+json)
+ Body
{
"@namespaces": {
"floman": {
"name": "/floridaman/link-relations#"
}
},
"@controls": {
"floman:add-addedarticle": {
"href": "/api/addedarticles/",
"title": "Add a new addedarticle",
"encoding": "json",
"method": "POST",
"schema": {
"type": "object",
"properties": {
"date": {
"description": "Date of the addedarticle",
"type": "string",
"pattern": "^[0-3][0-9]\.[0-1][0-9]\.[0-9][0-9][0-9][0-9]$"
},
"link": {
"description": "Link to the addedarticle",
"type": "string"