Skip to content

Commit b71f62f

Browse files
author
ramz
committed
complete object documentation - v3 notes.
1 parent 64771ba commit b71f62f

File tree

97 files changed

+1580
-3448
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

97 files changed

+1580
-3448
lines changed

Diff for: endpoints/albums.md

+13-62
Original file line numberDiff line numberDiff line change
@@ -8,72 +8,23 @@ These are the API calls that you can use to retrieve albums, the photos in those
88
##Available endpoints
99
***
1010

11-
* `/albums`, [GET](albums/GET_albums.md#files), POST (not available yet)
12-
* `/albums/recommended`, [GET](https://github.com/eyeem/API/blob/master/endpoints/albums/GET_albums_recommended.md#files)
13-
* `/albums/#{id}`, [GET](https://github.com/eyeem/API/blob/master/endpoints/albums/GET_albums_id.md#files)
14-
* `/albums/#{id}/photos`, [GET](https://github.com/eyeem/API/blob/master/endpoints/albums/GET_albums_id_photos.md#files)
11+
* `/albums`, [GET](albums/GET_albums.md#files)
1512
* `/albums/recommended`, [GET](albums/GET_albums_recommended.md#files)
1613
* `/albums/#{id}`, [GET](albums/GET_albums_id.md#files)
17-
* `/albums/#{id}/photos`, [GET](albums/GET_albums_id_photos.md#files)
18-
* `/albums/#{id}/hide`, GET, POST, DELETE << will it stay HIDE or change to a different name?
19-
* `/albums/#{id}/photos/#{photo_id}`, [PUT](albums/PUT_albums_id_photos_id.md#files),[DELETE](albums/DELETE_albums_id_photos_id.md#files) (see relevant endpoint in [photos](https://github.com/eyeem/API/blob/master/endpoints/photos.md#files))
20-
* `/albums/#{id}/likers` [GET](albums/GET_albums_id_likers.md#files)
21-
* `/albums/#{id}/likers/#{user_id}`, [GET](albums/GET_albums_id_likers_id.md#files), [PUT](albums/PUT_albums_id_likers_id.md#files), [DELETE](albums/DELETE_albums_id_likers_id.md#files)
14+
* `/albums/{album_id}/acceptInvites`, [POST](albums/POST_albums_id_accept_invites.md#files)
15+
* `/albums/#{id}/favoriters` [GET](albums/GET_albums_id_likers.md#files), [POST](albums/POST_albums_id_likers.md#files)
16+
* `/albums/#{id}/favoriters/#{user_id}`, [GET](albums/GET_albums_id_favoriters_id.md#files), [PUT](albums/PUT_albums_id_favoriters_id.md#files), [DELETE](albums/DELETE_albums_id_favoriters_id.md#files)
2217
* `/albums/#{id}/contributors`, [GET](albums/GET_albums_id_contributors.md#files)
2318
* `/albums/#{id}/contributors/#{user_id}`, [GET](albums/GET_albums_id_contributors_id.md#files)
19+
* `/albums/#{id}/view`, [POST](albums/POST_albums_id_view.md#files)
20+
* `/albums/#{id}/photos`, [GET](albums/GET_albums_id_photos.md#files)
21+
* `/albums/#{id}/photos/#{photo_id}`, [GET](albums/GET_albums_id_photos_id.md#files),[PUT](albums/PUT_albums_id_photos_id.md#files),[DELETE](albums/DELETE_albums_id_photos_id.md#files)
22+
* `/collections`, [GET](albums/GET_albums_id_collections.md#files)
23+
* `/albums/#{id}/relatedAlbums`, [GET](albums/GET_albums_id_related_albums.md#files)
24+
* `/albums/#{id}/weather`, [GET](albums/GET_albums_id_weather.md#files)
25+
* `/albums/#{id}/venueCategories`, [GET](albums/GET_albums_id_venue_categories.md#files)
2426
* `/albums/#{id}/share`, [POST](albums/POST_albums_id_share.md#files)
25-
* `/albums/#{id}/discover`, POST
26-
* `/albums/#{id}/view`, POST
27-
28-
Special endpoints (will be deprecated soon)
29-
30-
* popular album: `/albums/dynamic:10`
31-
* radius album: `/albums/radius:#{latitude}:#{longitude}`
32-
33-
34-
##Representation
35-
***
36-
37-
The various possible representations of an album (simple,detailed) are presented and described in the [model](../resources/model.md#files) page.
38-
39-
40-
41-
##GET
42-
***
43-
44-
* [`/albums`](albums/GET_albums.md#files)
45-
* [`/albums/recommended`](albums/GET_albums_recommended.md#files)
46-
* [`/albums/#{id}`](albums/GET_albums_id.md#files)
47-
* [`/albums/#{id}/photos`](albums/GET_albums_id_photos.md#files)
48-
* `/albums/#{id}/hide`
49-
* [`/albums/#{id}/likers`](albums/GET_albums_id_likers.md#files)
50-
* [`/albums/#{id}/likers/#{user_id}`](albums/GET_albums_id_likers_id.md#files)
51-
* [`/albums/#{id}/contributors`](albums/GET_albums_id_contributors.md#files)
52-
* [`/albums/#{id}/contributors/#{user_id}`](albums/GET_albums_id_contributors_id.md#files)
53-
* [`/albums/#{id}/relatedAlbums`](albums/GET_albums_id_related_albums.md#files)
54-
* [`/albums/#{id}/venueCategories`](albums/GET_albums_id_venue_categories.md#files)
55-
56-
57-
##PUT
58-
***
59-
60-
* [`/albums/#{id}/photos/#{photo_id}`](albums/PUT_albums_id_photos_id.md#files)
61-
* [`/albums/#{id}/likers/#{user_id}`](albums/PUT_albums_id_photos_id.md#files)
62-
63-
64-
65-
##POST
66-
***
67-
68-
* `/albums/#{id}/hide`
69-
* [`/albums/#{id}/share`](albums/POST_albums_id_share.md#files)
70-
* `/albums/#{id}/discover`
71-
* `/albums/#{id}/view`
72-
73-
##DELETE
74-
***
27+
* `/albums/{id}/hide`, [POST](albums/POST_albums_id_hide.md#files)
28+
* `/albums/{id}/mute`, [GET](albums/GET_albums_id_mute.md#files),[POST](albums/POST_albums_id_mute.md#files), [DELETE](albums/DELETE_albums_id_mute.md#files)
7529

7630

77-
* `/albums/#{id}/hide`
78-
* [`/albums/#{id}/photos/#{photo_id}`](albums/DELETE_albums_id_photos_id.md#files)
79-
* [`/albums/#{id}/likers/#{user_id}`](albums/DELETE_albums_id_photos_id.md#files)
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# DELETE /albums/#{id}/likers/#{user_id}
1+
# DELETE /albums/#{id}/favoriters/#{user_id}
22
***
3-
`/albums/#{id}/likers/#{user_id}`
3+
`/albums/#{id}/favoriters/#{user_id}`
44

55
### Description
66
***
7-
Unlike an album.
7+
unfavorite an album.
88

99
### Parameters
1010
***
@@ -19,17 +19,3 @@ Unlike an album.
1919

2020

2121
200 if success
22-
23-
[Errors](../../resources/errors.md#files)
24-
25-
### Examples
26-
***
27-
28-
`https://api.eyeem.com/v2/albums/1234/likers/1013`
29-
30-
31-
32-
33-
34-
35-

Diff for: endpoints/albums/DELETE_albums_id_mute.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# DELETE /albums/#{id}/mute
2+
***
3+
`/albums/#{id}/mute`
4+
5+
### Description
6+
***
7+
Unmute an album from a specific user's discovery.
8+
9+
10+
### Parameters
11+
***
12+
13+
|header| description| type |required? |default|
14+
|:---------|:--------------|:----------:|:------------:|:------------:|
15+
|**id**| the id of the album to share|integer|x||
16+
|**parameter**| **description**| **type** |**required?** |**default**|
17+
18+
19+
### Response
20+
***
21+
200 if success

0 commit comments

Comments
 (0)