-
Notifications
You must be signed in to change notification settings - Fork 10
/
eyeem-wadl.xml
2445 lines (2019 loc) · 109 KB
/
eyeem-wadl.xml
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
<application xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:apigee="http://api.apigee.com/wadl/2010/07/"
xmlns="http://wadl.dev.java.net/2009/02"
xsi:schemaLocation="http://wadl.dev.java.net/2009/02 http://apigee.com/schemas/wadl-schema.xsd http://api.apigee.com/wadl/2010/07/ http://apigee.com/schemas/apigee-wadl-extensions.xsd">
<!-- Base defines the domain and base path of the endpoint -->
<resources base="https://api.eyeem.com/v2">
<!-- A simple resource with a GET method -->
<resource path="/albums">
<!-- Resources that are the same but have multiple verbs can have multiple method items in the WADL. -->
<!-- Methods should each have a unique id. -->
<!-- The attribute displayName can be used to control the name that appears in the list in the Console. -->
<param name="ids" required="false" type="xsd:string" style="query">
<doc>
a comma-separated list of album ids to retrieve
</doc>
</param>
<param name="q" required="false" type="xsd:string" style="query">
<doc>
the string to search albums by (renders the ids parameter invalid)
</doc>
</param>
<param name="trending" required="false" type="xsd:boolean" style="query">
<doc>
returns 30 new and growing topical albums
</doc>
</param>
<param name="geoSearch" required="false" type="xsd:string" style="query">
<doc>
city and nearbyVenues requires latitude and longitude
foursquareVenue requires foursquareId
</doc>
<option value="city" />
<option value="nearbyVenues" />
<option value="foursquareVenue" />
</param>
<param name="lat" required="false" type="xsd:integer" style="query">
<doc>
latitude (required for "city" and "nearbyVenues" geoSearch)
</doc>
</param>
<param name="lng" required="false" type="xsd:integer" style="query">
<doc>
longitude (required for "city" and "nearbyVenues" geoSearch)
</doc>
</param>
<param name="foursquareId" required="false" type="xsd:string" style="query">
<doc>
required for "foursquareVenue" geoSearch
</doc>
</param>
<param name="limit" required="false" type="xsd:integer" style="query" default="30">
<doc>
number of search results to return
</doc>
</param>
<param name="minPhotos" required="false" type="xsd:integer" style="query">
<doc>
return albums only with at least the specified number of photos (works when "q" is specified)
</doc>
</param>
<param name="type" required="false" type="xsd:string" style="query">
<doc>
only returns albums of a specific type (city,country,event,venue,tag) (works when "q" is specified)
</doc>
<option value="city" />
<option value="country" />
<option value="event" />
<option value="venue" />
<option value="tag" />
</param>
<param name="offset" required="false" type="xsd:integer" style="query" default="0">
<doc>
offset of search results to start at
</doc>
</param>
<method id="albums" name="GET" apigee:displayName="/albums">
<!-- Tags are used to organize the list of methods. Primary tag will list the default placement. -->
<apigee:tags>
<apigee:tag primary="true">Albums</apigee:tag>
</apigee:tags>
<!-- Is authentication required for this method? -->
<apigee:authentication required="true"/>
<!-- Example element is used to specify the sample URL to display in the Console's request URL field. -->
<!-- Note: This is not used by the new Console -->
<apigee:example url="/albums"/>
<!-- The content of the doc element is shown as a tooltip in the Console's method list. -->
<doc apigee:url="https://github.com/eyeem/Public-API/blob/master/endpoints/albums/GET_albums.md#files">
Retrieves albums specified in the id URL query parameter, or searches for albums based on their names
</doc>
</method>
</resource>
<resource path="/albums/recommended">
<!-- Resources that are the same but have multiple verbs can have multiple method items in the WADL. -->
<!-- Methods should each have a unique id. -->
<!-- The attribute displayName can be used to control the name that appears in the list in the Console. -->
<param name="limit" required="false" type="xsd:integer" style="query" default="60">
<doc>
number of search results to return
</doc>
</param>
<method id="albumsRecommended" name="GET" apigee:displayName="/albums/recommended">
<!-- Tags are used to organize the list of methods. Primary tag will list the default placement. -->
<apigee:tags>
<apigee:tag primary="true">Albums</apigee:tag>
</apigee:tags>
<!-- Is authentication required for this method? -->
<apigee:authentication required="true"/>
<!-- Example element is used to specify the sample URL to display in the Console's request URL field. -->
<!-- Note: This is not used by the new Console -->
<apigee:example url="/albums"/>
<!-- The content of the doc element is shown as a tooltip in the Console's method list. -->
<doc apigee:url="https://github.com/eyeem/Public-API/blob/master/endpoints/albums/GET_albums_recommended.md#files">
Retrieves albums recommended by the eyeem community team
</doc>
</method>
</resource>
<resource path="/albums/{id}">
<!-- Resources that are the same but have multiple verbs can have multiple method items in the WADL. -->
<!-- Methods should each have a unique id. -->
<!-- The attribute displayName can be used to control the name that appears in the list in the Console. -->
<param name="id" required="true" type="xsd:integer" style="header" default="17">
<doc>
Represents the ID of the album.
</doc>
</param>
<param name="detailed" required="false" type="xsd:boolean" style="query" default="1">
<doc>
returns a simple or detailed album object
</doc>
</param>
<param name="includePhotos" required="false" type="xsd:boolean" style="query" default="0">
<doc>
if true it returns some of the album's photos
</doc>
</param>
<param name="numPhotos" required="false" type="xsd:integer" style="query" default="10">
<doc>
the number of album photos to return
</doc>
</param>
<param name="photoDetails" required="false" type="xsd:boolean" style="query" default="0">
<doc>
whether to return the photo details (comments, likes, albums)
</doc>
</param>
<param name="includeContributors" required="false" type="xsd:boolean" style="query" default="0">
<doc>
if true, returns the album contributors
</doc>
</param>
<param name="includeLikers" required="false" type="xsd:boolean" style="query" default ="0">
<doc>
if true, returns the album likers
</doc>
</param>
<method id="albumsId" name="GET" apigee:displayName="/albums/{id}">
<!-- Tags are used to organize the list of methods. Primary tag will list the default placement. -->
<apigee:tags>
<apigee:tag primary="true">Albums</apigee:tag>
</apigee:tags>
<!-- Is authentication required for this method? -->
<apigee:authentication required="true"/>
<!-- Example element is used to specify the sample URL to display in the Console's request URL field. -->
<!-- Note: This is not used by the new Console -->
<apigee:example url="/albums"/>
<!-- The content of the doc element is shown as a tooltip in the Console's method list. -->
<doc apigee:url="https://github.com/eyeem/Public-API/blob/master/endpoints/albums/GET_albums_id.md#files">
Retrieves album specified in the id URL query parameter
</doc>
</method>
</resource>
<resource path="/albums/{id}/photos">
<!-- Resources that are the same but have multiple verbs can have multiple method items in the WADL. -->
<!-- Methods should each have a unique id. -->
<!-- The attribute displayName can be used to control the name that appears in the list in the Console. -->
<param name="id" required="true" type="xsd:integer" style="header" default="17">
<doc>
Represents the ID of the album.
</doc>
</param>
<param name="limit" required="false" type="xsd:integer" style="query" default="20">
<doc>
</doc>
</param>
<param name="offset" required="false" type="xsd:integer" style="query" default="0">
<doc>
</doc>
</param>
<param name="onlyId" required="false" type="xsd:integer" style="query">
<doc>
if true, returns only the photo ids
</doc>
</param>
<param name="detailed" required="false" type="xsd:integer" style="query">
<doc>
returns a simple or detailed photo object
</doc>
</param>
<param name="includeComments" required="false" type="xsd:boolean" style="query" default="0">
<doc>
If true, returns the latest two comments of a photo inline
</doc>
</param>
<param name="numComments" required="false" type="xsd:integer" style="query" default="2">
<doc>
the number of comments to include in the response
</doc>
</param>
<param name="includeLikers" required="false" type="xsd:boolean" style="query" default ="0">
<doc>
If true, returns the latest two likers of a photo
</doc>
</param>
<param name="numLikers" required="false" type="xsd:integer" style="query" default="">
<doc>
the number of likers to include in the response
</doc>
</param>
<param name="includeAlbums" required="false" type="xsd:boolean" style="query" default="0">
<doc>
If true, includes the albums this photo is part of
</doc>
</param>
<method id="albumsPhotos" name="GET" apigee:displayName="/albums/{id}/photos">
<!-- Tags are used to organize the list of methods. Primary tag will list the default placement. -->
<apigee:tags>
<apigee:tag primary="true">Albums</apigee:tag>
</apigee:tags>
<!-- Is authentication required for this method? -->
<apigee:authentication required="true"/>
<!-- Example element is used to specify the sample URL to display in the Console's request URL field. -->
<!-- Note: This is not used by the new Console -->
<apigee:example url="/albums"/>
<!-- The content of the doc element is shown as a tooltip in the Console's method list. -->
<doc apigee:url="https://github.com/eyeem/Public-API/blob/master/endpoints/albums/GET_albums_id_photos.md#files">
Retrieves photos of an album specified in the id URL query parameter
</doc>
</method>
</resource>
<resource path="/album/{id}/photos/{photo_id}">
<param name="id" required="true" type="xsd:integer" style="header">
<doc>
the album id to interact with
</doc>
</param>
<param name="photo_id" required="true" type="xsd:integer" style="header">
<doc>
the photo id to interact with
</doc>
</param>
<method id="albumIdPhotosPhotoIdPut" name="PUT" apigee:displayName="/album/{id}/photos/{photo_id}">
<apigee:tags>
<apigee:tag primary="true">Albums</apigee:tag>
</apigee:tags>
<apigee:authentication required="true"/>
<apigee:example url="/album/{id}/photos/{photo_id}"/>
<doc apigee:url="https://github.com/eyeem/Public-API/blob/master/endpoints/albums/PUT_albums_id_photos_id.md#files">
add an existing photo to an album
</doc>
</method>
<method id="albumIdPhotosPhotoIdDelete" name="DELETE" apigee:displayName="/album/{id}/photos/{photo_id}">
<apigee:tags>
<apigee:tag primary="true">Albums</apigee:tag>
</apigee:tags>
<apigee:authentication required="true"/>
<apigee:example url="/album/{id}/photos/{photo_id}"/>
<doc apigee:url="https://github.com/eyeem/Public-API/blob/master/endpoints/albums/DELETE_albums_id_photos_id.md#files">
remove an existing photo from an album
</doc>
</method>
</resource>
<!--
<resource path="/album/{id}/likers/{user_id}">
<param name="id" required="true" type="xsd:integer" style="header">
<doc>
the album id to interact with
</doc>
</param>
<param name="user_id" required="true" type="xsd:integer" style="header">
<doc>
the user id to interact with
</doc>
</param>
<method id="albumIdPhotosLikersIdPut" name="PUT" apigee:displayName="/album/{id}/likers/{photo_id}">
<apigee:tags>
<apigee:tag primary="true">Albums</apigee:tag>
</apigee:tags>
<apigee:authentication required="true"/>
<apigee:example url="/album/{id}/photos/{photo_id}"/>
<doc apigee:url="http://api.mydomain.com/doc/resource5/method1">
Like an album
</doc>
</method>
<method id="albumIdPhotosLikersIdDelete" name="DELETE" apigee:displayName="/album/{id}/likers/{photo_id}">
<apigee:tags>
<apigee:tag primary="true">Albums</apigee:tag>
</apigee:tags>
<apigee:authentication required="true"/>
<apigee:example url="/album/{id}/photos/{photo_id}"/>
<doc apigee:url="http://api.mydomain.com/doc/resource5/method1">
Unlike an album
</doc>
</method>
</resource>
-->
<resource path="/albums/{id}/contributors">
<param name="id" required="true" type="xsd:integer" style="header" default="17">
<doc>
Represents the ID of the album.
</doc>
</param>
<param name="limit" required="false" type="xsd:integer" style="query" default="20">
<doc>
</doc>
</param>
<param name="offset" required="false" type="xsd:integer" style="query" default="0">
<doc>
</doc>
</param>
<param name="onlyId" required="false" type="xsd:integer" style="query">
<doc>
if true, returns only the users ids
</doc>
</param>
<method id="albumsContributors" name="GET" apigee:displayName="/albums/{id}/contributors">
<!-- Tags are used to organize the list of methods. Primary tag will list the default placement. -->
<apigee:tags>
<apigee:tag primary="true">Albums</apigee:tag>
</apigee:tags>
<!-- Is authentication required for this method? -->
<apigee:authentication required="true"/>
<!-- Example element is used to specify the sample URL to display in the Console's request URL field. -->
<!-- Note: This is not used by the new Console -->
<apigee:example url="/albums"/>
<doc apigee:url="https://github.com/eyeem/Public-API/blob/master/endpoints/albums/GET_albums_id_contributors.md#files">
Retrieves an array of the users who have added photos to the album
</doc>
</method>
</resource>
<resource path="/albums/{id}/contributors/{user_id}">
<!-- Resources that are the same but have multiple verbs can have multiple method items in the WADL. -->
<!-- Methods should each have a unique id. -->
<!-- The attribute displayName can be used to control the name that appears in the list in the Console. -->
<param name="id" required="true" type="xsd:integer" style="header" default="17">
<doc>
Represents the ID of the album.
</doc>
</param>
<param name="user_id" required="true" type="xsd:integer" style="header" default="1013">
<doc>
Represents the ID of the user.
</doc>
</param>
<method id="albumsContributorsCheck" name="GET" apigee:displayName="/albums/{id}/contributors/{user_id}">
<!-- Tags are used to organize the list of methods. Primary tag will list the default placement. -->
<apigee:tags>
<apigee:tag primary="true">Albums</apigee:tag>
</apigee:tags>
<!-- Is authentication required for this method? -->
<apigee:authentication required="true"/>
<!-- Example element is used to specify the sample URL to display in the Console's request URL field. -->
<!-- Note: This is not used by the new Console -->
<apigee:example url="/albums"/>
<!-- The content of the doc element is shown as a tooltip in the Console's method list. -->
<doc apigee:url="https://github.com/eyeem/Public-API/blob/master/endpoints/albums/GET_albums_id_contributors_id.md#files">
Checks whether a user has contributed a photo to the album
</doc>
</method>
</resource>
<resource path="/album/{id}/share">
<param name="id" required="true" type="xsd:integer" style="header">
<doc>
the album id you want to share
</doc>
</param>
<param name="services" required="true" type="xsd:string" style="query">
<doc>
comma-separated list of services (twitter,facebook,tumblr)
</doc>
</param>
<param name="message" required="false" type="xsd:string" style="query">
<doc>
user-entered message to be shared with the album
</doc>
</param>
<method id="albumIdShare" name="POST" apigee:displayName="/album/{id}/share">
<apigee:tags>
<apigee:tag primary="true">Albums</apigee:tag>
</apigee:tags>
<apigee:authentication required="true"/>
<apigee:example url="/album/{id}/photos/{photo_id}"/>
<doc apigee:url="https://github.com/eyeem/Public-API/blob/master/endpoints/albums/POST_albums_id_share.md#files">
Share an album to the user's connected social media services
</doc>
</method>
</resource>
<resource path="/photos">
<!-- Resources that are the same but have multiple verbs can have multiple method items in the WADL. -->
<!-- Methods should each have a unique id. -->
<!-- The attribute displayName can be used to control the name that appears in the list in the Console. -->
<param name="type" required="false" type="xsd:string" style="query" default="user">
<doc>
popular (optional, returns popular photos, else defaults to the user's photos)
</doc>
</param>
<param name="ids" required="false" type="xsd:string" style="query">
<doc>
comma-separated list of ids to return (if type not specified)
</doc>
</param>
<param name="limit" required="false" type="xsd:integer" style="query" default="30">
<doc>
number of search results to return
</doc>
</param>
<param name="offset" required="false" type="xsd:integer" style="query" default="0">
<doc>
offset of search results to start at
</doc>
</param>
<param name="includeComments" required="false" type="xsd:boolean" style="query" default="0">
<doc>
If true, returns the latest two comments of a photo inline
</doc>
</param>
<param name="includeLikers" required="false" type="xsd:boolean" style="query" default ="0">
<doc>
If true, returns the latest two likers of a photo
</doc>
</param>
<method id="photos" name="GET" apigee:displayName="/photos">
<!-- Tags are used to organize the list of methods. Primary tag will list the default placement. -->
<apigee:tags>
<apigee:tag primary="true">Photos</apigee:tag>
</apigee:tags>
<!-- Is authentication required for this method? -->
<apigee:authentication required="true"/>
<!-- Example element is used to specify the sample URL to display in the Console's request URL field. -->
<!-- Note: This is not used by the new Console -->
<apigee:example url="/albums"/>
<!-- The content of the doc element is shown as a tooltip in the Console's method list. -->
<doc apigee:url="https://github.com/eyeem/Public-API/blob/master/endpoints/photos/GET_photo.md#files">
Retrieves the authenticated user's latest twenty photos or popular photos (collection)
</doc>
</method>
</resource>
<resource path="/photos/">
<param name="filename" required="false" type="xsd:string" style="query">
<doc>
required if no photo is sent with the request
</doc>
</param>
<param name="caption" required="false" type="xsd:string" style="query">
<doc>
a string created, client-side, from "topic" at "venue" or "topic" in "city"
</doc>
</param>
<param name="topic" required="false" type="xsd:string" style="query">
<doc>
the user's chosen topic(s), comma-separated
</doc>
</param>
<param name="city" required="false" type="xsd:string" style="query">
<doc>
the city name where the photo was taken
</doc>
</param>
<param name="country" required="false" type="xsd:string" style="query">
<doc>
the country name where the photo was taken
</doc>
</param>
<param name="filter" required="false" type="xsd:string" style="query">
<doc>
the eyeem filter that the user chose to use
</doc>
</param>
<param name="venueId" required="false" type="xsd:integer" style="query">
<doc>
the foursquare venue ID that the user selected
</doc>
</param>
<param name="venueServiceName" required="false" type="xsd:string" style="query">
<doc>
required if venueId provided, "foursquare"
</doc>
</param>
<param name="albumIds" required="false" type="xsd:string" style="query">
<doc>
the IDs of albums we want to automatically add the photo to, comma-separated
</doc>
</param>
<param name="noLocation" required="false" type="xsd:boolean" style="query">
<doc>
tells the server not to save the photo's geodata.
</doc>
</param>
<method id="photosPost" name="POST" apigee:displayName="/photos">
<apigee:tags>
<apigee:tag primary="true">Photos</apigee:tag>
</apigee:tags>
<apigee:authentication required="true"/>
<apigee:example url="/photos"/>
<doc apigee:url="https://github.com/eyeem/Public-API/blob/master/endpoints/photos/POST_photo.md#files">
Create a photo object, either by uploading a file or passing a filename (the result of a POST on /photos/upload)
</doc>
<request>
<!-- This section contains the body representation, e.g. form-encoded parameters, an XML/JSON payload, an attachment etc. -->
<representation>
<!-- This section describes the attachments for a method. Currently, the Console only supports one attachment. -->
<apigee:attachments>
<!-- The name attribute, which is mandatory, determines the name populated in the Console and also the MIME part name. -->
<!-- The required attribute, which is optional, is set to true to indicate the attachment as mandatory in the Console. -->
<!-- The contentDisposition attribute, which is optional, sets the Content-Disposition header in the generated MIME request.
Some MIME request processors expect the Content-Disposition to be "attachment", while some expect it to be "form-data". -->
<apigee:attachment name="photo" required="false" contentDisposition="form-data">
<doc>required if no filename is sent with the request</doc>
</apigee:attachment>
</apigee:attachments>
</representation>
</request>
</method>
</resource>
<resource path="/photos/upload">
<method id="photosUploadPost" name="POST" apigee:displayName="/photos/upload">
<apigee:tags>
<apigee:tag primary="true">Photos</apigee:tag>
</apigee:tags>
<apigee:authentication required="true"/>
<apigee:example url="/photos"/>
<doc apigee:url="https://github.com/eyeem/Public-API/blob/master/endpoints/photos/POST_photo_upload.md#files">
Upload a photo file and send back a filename that can then be use to call POST /photos and create a photo object.
</doc>
<request>
<!-- This section contains the body representation, e.g. form-encoded parameters, an XML/JSON payload, an attachment etc. -->
<representation>
<!-- This section describes the attachments for a method. Currently, the Console only supports one attachment. -->
<apigee:attachments>
<!-- The name attribute, which is mandatory, determines the name populated in the Console and also the MIME part name. -->
<!-- The required attribute, which is optional, is set to true to indicate the attachment as mandatory in the Console. -->
<!-- The contentDisposition attribute, which is optional, sets the Content-Disposition header in the generated MIME request.
Some MIME request processors expect the Content-Disposition to be "attachment", while some expect it to be "form-data". -->
<apigee:attachment name="photo" required="true" contentDisposition="form-data">
<doc>The photo you want to upload</doc>
</apigee:attachment>
</apigee:attachments>
</representation>
</request>
</method>
</resource>
<resource path="/photos/{id}">
<!-- Resources that are the same but have multiple verbs can have multiple method items in the WADL. -->
<!-- Methods should each have a unique id. -->
<!-- The attribute displayName can be used to control the name that appears in the list in the Console. -->
<param name="id" required="true" type="xsd:integer" style="header" default="939584">
<doc>
The id of the photo we want to retrieve information about.
</doc>
</param>
<param name="detailed" required="false" type="xsd:boolean" style="query" default="1">
<doc>
returns a simple or detailed album object
</doc>
</param>
<param name="includeComments" required="false" type="xsd:boolean" style="query" default="0">
<doc>
If true, returns the latest two comments of a photo inline
</doc>
</param>
<param name="numComments" required="false" type="xsd:integer" style="query" default="2">
<doc>
the number of comments to include in the response
</doc>
</param>
<param name="includeLikers" required="false" type="xsd:boolean" style="query" default ="2">
<doc>
if true, returns the album likers
</doc>
</param>
<param name="numLikers" required="false" type="xsd:integer" style="query" default="2">
<doc>
the number of likers to include in the response
</doc>
</param>
<param name="includeAlbums" required="false" type="xsd:boolean" style="query" default="0">
<doc>
If true, includes the albums this photo is part of
</doc>
</param>
<method id="photosId" name="GET" apigee:displayName="/photos/{id}">
<!-- Tags are used to organize the list of methods. Primary tag will list the default placement. -->
<apigee:tags>
<apigee:tag primary="true">Photos</apigee:tag>
</apigee:tags>
<!-- Is authentication required for this method? -->
<apigee:authentication required="true"/>
<!-- Example element is used to specify the sample URL to display in the Console's request URL field. -->
<!-- Note: This is not used by the new Console -->
<apigee:example url="/albums"/>
<!-- The content of the doc element is shown as a tooltip in the Console's method list. -->
<doc apigee:url="https://github.com/eyeem/Public-API/blob/master/endpoints/photos/GET_photos_id.md#files">
Retrieves a photo by id
</doc>
</method>
</resource>
<resource path="/photos/{id}">
<param name="id" required="true" type="xsd:integer" style="header">
<doc>
The photo id
</doc>
</param>
<method id="photosIdPost" name="DELETE" apigee:displayName="/photos/{id}">
<apigee:tags>
<apigee:tag primary="true">Photos</apigee:tag>
</apigee:tags>
<apigee:authentication required="true"/>
<apigee:example url="/photos"/>
<doc apigee:url="https://github.com/eyeem/Public-API/blob/master/endpoints/photos/DELETE_photos_id.md#files">
Deletes a photo by id (has to be a photo belonging to the authenticated user)
</doc>
</method>
<method id="photosIdPut" name="PUT" apigee:displayName="/photos/{id}">
<apigee:tags>
<apigee:tag primary="true">Photos</apigee:tag>
</apigee:tags>
<apigee:authentication required="true"/>
<apigee:example url="/photos"/>
<doc apigee:url="https://github.com/eyeem/Public-API/blob/master/endpoints/photos/PUT_photos_id.md#files">
Edits a photo by id (has to be a photo belonging to the authenticated user or admin)
</doc>
<request>
<param name="caption" required="false" type="xsd:string" style="query">
<doc>
The new caption of the photo.
</doc>
</param>
<param name="title" required="false" type="xsd:string" style="query">
<doc>
The new title of the photo.
</doc>
</param>
<param name="hide" required="false" type="xsd:boolean" style="query">
<doc>
Removes photo from popular album.
</doc>
</param>
</request>
</method>
</resource>
<resource path="/photos/{id}/likers">
<!-- Resources that are the same but have multiple verbs can have multiple method items in the WADL. -->
<!-- Methods should each have a unique id. -->
<!-- The attribute displayName can be used to control the name that appears in the list in the Console. -->
<param name="id" required="true" type="xsd:integer" style="header" default="939584">
<doc>
The id of the photo we want to retrieve information about.
</doc>
</param>
<param name="limit" required="false" type="xsd:integer" style="query" default="20">
<doc>
</doc>
</param>
<param name="offset" required="false" type="xsd:integer" style="query" default="0">
<doc>
</doc>
</param>
<param name="onlyId" required="false" type="xsd:boolean" style="query">
<doc>
if true, returns only the likers ids
</doc>
</param>
<method id="photosIdLikers" name="GET" apigee:displayName="/photos/{id}/likers">
<!-- Tags are used to organize the list of methods. Primary tag will list the default placement. -->
<apigee:tags>
<apigee:tag primary="true">Photos</apigee:tag>
</apigee:tags>
<!-- Is authentication required for this method? -->
<apigee:authentication required="true"/>
<!-- Example element is used to specify the sample URL to display in the Console's request URL field. -->
<!-- Note: This is not used by the new Console -->
<apigee:example url="/albums"/>
<!-- The content of the doc element is shown as a tooltip in the Console's method list. -->
<doc apigee:url="https://github.com/eyeem/Public-API/blob/master/endpoints/photos/GET_photos_id_likers.md#files">
Retrieves an array of the users who like the photo
</doc>
</method>
</resource>
<resource path="/photos/{id}/likers/{user_id}">
<!-- Resources that are the same but have multiple verbs can have multiple method items in the WADL. -->
<!-- Methods should each have a unique id. -->
<!-- The attribute displayName can be used to control the name that appears in the list in the Console. -->
<param name="id" required="true" type="xsd:integer" style="header" default="939584">
<doc>
The id of the photo we want to retrieve information about.
</doc>
</param>
<param name="user_id" required="true" type="xsd:integer" style="header" default="3346">
<doc>
Represents the ID of the user.
</doc>
</param>
<method id="photosIdLikersCheck" name="GET" apigee:displayName="/photos/{id}/likers/{user_id}">
<!-- Tags are used to organize the list of methods. Primary tag will list the default placement. -->
<apigee:tags>
<apigee:tag primary="true">Photos</apigee:tag>
</apigee:tags>
<!-- Is authentication required for this method? -->
<apigee:authentication required="true"/>
<!-- Example element is used to specify the sample URL to display in the Console's request URL field. -->
<!-- Note: This is not used by the new Console -->
<apigee:example url="/albums"/>
<!-- The content of the doc element is shown as a tooltip in the Console's method list. -->
<doc apigee:url="https://github.com/eyeem/Public-API/blob/master/endpoints/photos/GET_photos_id_likers.md#files">
Checks whether a user likes a photo
</doc>
</method>
<method id="photosIdLikersCheckPut" name="PUT" apigee:displayName="/photos/{id}/likers/{user_id}">
<!-- Tags are used to organize the list of methods. Primary tag will list the default placement. -->
<apigee:tags>
<apigee:tag primary="true">Photos</apigee:tag>
</apigee:tags>
<!-- Is authentication required for this method? -->
<apigee:authentication required="true"/>
<!-- Example element is used to specify the sample URL to display in the Console's request URL field. -->
<!-- Note: This is not used by the new Console -->
<apigee:example url="/albums"/>
<!-- The content of the doc element is shown as a tooltip in the Console's method list. -->
<doc apigee:url="https://github.com/eyeem/Public-API/blob/master/endpoints/photos.md#PUTphotosIdLikersId">
Like a photo
</doc>
<request>
<param name="albumId" required="false" type="xsd:integer" style="header">
<doc>
the ID of the album that the user was in when liking
</doc>
</param>
</request>
</method>
<method id="photosIdLikersCheckDelete" name="DELETE" apigee:displayName="/photos/{id}/likers/{user_id}">
<!-- Tags are used to organize the list of methods. Primary tag will list the default placement. -->
<apigee:tags>
<apigee:tag primary="true">Photos</apigee:tag>
</apigee:tags>
<!-- Is authentication required for this method? -->
<apigee:authentication required="true"/>
<!-- Example element is used to specify the sample URL to display in the Console's request URL field. -->
<!-- Note: This is not used by the new Console -->
<apigee:example url="/albums"/>
<!-- The content of the doc element is shown as a tooltip in the Console's method list. -->
<doc apigee:url="https://github.com/eyeem/Public-API/blob/master/endpoints/photos/PUT_photos_id_likers_id.md#files">
Unlike a photo
</doc>
</method>
</resource>
<resource path="/photos/{id}/comments">
<!-- Resources that are the same but have multiple verbs can have multiple method items in the WADL. -->
<!-- Methods should each have a unique id. -->
<!-- The attribute displayName can be used to control the name that appears in the list in the Console. -->
<param name="id" required="true" type="xsd:integer" style="header" default="939584">
<doc>
The id of the photo we want to retrieve information about.
</doc>
</param>
<param name="limit" required="false" type="xsd:integer" style="query" default="20">
<doc>
</doc>
</param>
<param name="offset" required="false" type="xsd:integer" style="query" default="0">
<doc>
</doc>
</param>
<param name="onlyId" required="false" type="xsd:boolean" style="query" >
<doc>
if true, returns a comma separated list of comment ids
</doc>
</param>
<method id="photosIdComments" name="GET" apigee:displayName="/photos/{id}/comments">
<!-- Tags are used to organize the list of methods. Primary tag will list the default placement. -->
<apigee:tags>
<apigee:tag primary="true">Photos</apigee:tag>
</apigee:tags>
<!-- Is authentication required for this method? -->
<apigee:authentication required="true"/>
<!-- Example element is used to specify the sample URL to display in the Console's request URL field. -->
<!-- Note: This is not used by the new Console -->
<apigee:example url="/albums"/>
<!-- The content of the doc element is shown as a tooltip in the Console's method list. -->
<doc apigee:url="https://github.com/eyeem/Public-API/blob/master/endpoints/photos/GET_photos_id_comments.md#files">
Retrieves an array of a photo's comments
</doc>
</method>
</resource>
<resource path="/photos/{id}/comments">
<param name="id" required="true" type="xsd:integer" style="header">
<doc>
The photo id
</doc>
</param>
<param name="message" required="true" type="xsd:string" style="query">
<doc>
the body of the comment (the message can optionally contain @mentioned users in the form @{nickname}[user:{id}])
</doc>
</param>
<param name="albumId" required="false" type="xsd:integer" style="query">
<doc>
tthe ID of the album that the user was in when commenting (optional)
</doc>
</param>
<method id="photosIdCommentsPost" name="POST" apigee:displayName="/photos/{id}/comments">
<apigee:tags>
<apigee:tag primary="true">Photos</apigee:tag>
</apigee:tags>
<apigee:authentication required="true"/>
<apigee:example url="/photos"/>
<doc apigee:url="https://github.com/eyeem/Public-API/blob/master/endpoints/photos/POST_photos_id_comments.md#files">
Adds a new comment to a photo
</doc>
</method>
</resource>
<resource path="/photos/{id}/comments/{comment_id}">
<!-- Resources that are the same but have multiple verbs can have multiple method items in the WADL. -->
<!-- Methods should each have a unique id. -->
<!-- The attribute displayName can be used to control the name that appears in the list in the Console. -->
<param name="id" required="true" type="xsd:integer" style="header" default="939584">
<doc>
The id of the photo we want to retrieve information about.
</doc>
</param>
<param name="comment_id" required="true" type="xsd:integer" style="header" default="939584">
<doc>
The id of the comment we want to retrieve.
</doc>
</param>
<method id="photosIdCommentsIdGet" name="GET" apigee:displayName="/photos/{id}/comments/{comment_id}">
<!-- Tags are used to organize the list of methods. Primary tag will list the default placement. -->
<apigee:tags>
<apigee:tag primary="true">Photos</apigee:tag>
</apigee:tags>
<!-- Is authentication required for this method? -->
<apigee:authentication required="true"/>
<!-- Example element is used to specify the sample URL to display in the Console's request URL field. -->
<!-- Note: This is not used by the new Console -->
<apigee:example url="/albums"/>
<!-- The content of the doc element is shown as a tooltip in the Console's method list. -->
<doc apigee:url="https://github.com/eyeem/Public-API/blob/master/endpoints/photos/GET_photos_id_comments_id.md#files">
Retrieves a specific comment on a photo
</doc>
</method>
<method id="photosIdCommentsIdDelete" name="DELETE" apigee:displayName="/photos/{id}/comments/{comment_id}">