Skip to content

Commit de1f7d2

Browse files
IvanGoncharovIvanGoncharov
committed
Upsteam API specs
1 parent 9ac62e7 commit de1f7d2

File tree

1 file changed

+46
-28
lines changed

1 file changed

+46
-28
lines changed

‎APIs/instagram.com/1.0.0/swagger.yaml‎

Lines changed: 46 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,15 @@ info:
1313
Current limitations:
1414
* Instagram service does not support [cross origin headers](https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS)
1515
for security reasons, therefore it is not possible to use Swagger UI and make API calls directly from browser.
16-
* Modification API requests (`POST`, `DELETE`) require additional security [scopes](https://instagram.com/developer/authentication/#scope)
17-
that are [not available](http://stackoverflow.com/questions/20580535/instagram-api-do-scopes-work-with-oauth2-implicit-authentication-flow/30834127#30834127)
18-
for new clients.
19-
* Consider the [Instagram limitations](https://instagram.com/developer/limits/) for API calls.
16+
* Modification API requests (`POST`, `DELETE`) require additional security [scopes](https://instagram.com/developer/authorization/)
17+
that are available for Apps [created on or after Nov 17, 2015](http://instagram.com/developer/review/) and
18+
started in [Sandbox Mode](http://instagram.com/developer/sandbox/).
19+
* Consider the [Instagram limitations](https://instagram.com/developer/limits/) for API calls that depends on App Mode.
2020
21-
Last update: 2015-06-19
21+
**Warning:** For Apps [created on or after Nov 17, 2015](http://instagram.com/developer/changelog/) API responses
22+
containing media objects no longer return the `data` field in `comments` and `likes` nodes.
23+
24+
Last update: 2015-11-28
2225
termsOfService: 'https://instagram.com/about/legal/terms/api/'
2326
title: Instagram
2427
version: 1.0.0
@@ -43,9 +46,11 @@ securityDefinitions:
4346
authorizationUrl: 'https://instagram.com/oauth/authorize/'
4447
flow: implicit
4548
scopes:
46-
basic: "to read data on a user's behalf, e.g. recent media, following lists (granted by default)"
47-
comments: "to create or delete comments on a user's behalf"
49+
basic: "to read a user's profile info and media (granted by default)"
50+
comments: "to post and delete comments on a user's behalf"
51+
follower_list: to read the list of followers and followed-by users
4852
likes: "to like and unlike media on a user's behalf"
53+
public_content: to read any public profile info and media on a user’s behalf
4954
relationships: "to follow and unfollow accounts on a user's behalf"
5055
type: oauth2
5156
tags:
@@ -68,6 +73,7 @@ tags:
6873
paths:
6974
'/geographies/{geo-id}/media/recent':
7075
get:
76+
deprecated: true
7177
description: |
7278
Get recent media from a geography subscription that you created.
7379
@@ -77,7 +83,7 @@ paths:
7783
can be used in this query. To backfill photos from the location covered by this geography, use the
7884
[media search endpoint](https://instagram.com/developer/endpoints/media/).
7985
80-
**Warrning:** Actual response of this end-point is [not documented](https://instagram.com/developer/endpoints/geographies/).
86+
**Warning:** [Deprecated](http://instagram.com/developer/changelog/) for Apps created **on or after** Nov 17, 2015
8187
parameters:
8288
- description: The geography ID.
8389
in: path
@@ -156,7 +162,7 @@ paths:
156162
security:
157163
- api_key: []
158164
- instagram_auth:
159-
- basic
165+
- public_content
160166
summary: Search for a location by geographic coordinate.
161167
tags:
162168
- locations
@@ -177,7 +183,7 @@ paths:
177183
security:
178184
- api_key: []
179185
- instagram_auth:
180-
- basic
186+
- public_content
181187
summary: Get information about a location.
182188
tags:
183189
- locations
@@ -220,14 +226,17 @@ paths:
220226
security:
221227
- api_key: []
222228
- instagram_auth:
223-
- basic
229+
- public_content
224230
summary: Get a list of recent media objects from a given location.
225231
tags:
226232
- locations
227233
/media/popular:
228234
get:
235+
deprecated: true
229236
description: |
230237
Get a list of what media is most popular at the moment. Can return mix of `image` and `video` types.
238+
239+
**Warning:** [Deprecated](http://instagram.com/developer/changelog/) for Apps created **on or after** Nov 17, 2015
231240
responses:
232241
'200':
233242
description: Found media resources (without likes information).
@@ -284,7 +293,7 @@ paths:
284293
security:
285294
- api_key: []
286295
- instagram_auth:
287-
- basic
296+
- public_content
288297
summary: Search for media in a given area.
289298
tags:
290299
- media
@@ -310,6 +319,7 @@ paths:
310319
- api_key: []
311320
- instagram_auth:
312321
- basic
322+
- public_content
313323
summary: Get information about a media object.
314324
tags:
315325
- media
@@ -336,6 +346,7 @@ paths:
336346
- api_key: []
337347
- instagram_auth:
338348
- basic
349+
- public_content
339350
summary: Get information about a media object.
340351
tags:
341352
- media
@@ -357,6 +368,7 @@ paths:
357368
- api_key: []
358369
- instagram_auth:
359370
- basic
371+
- public_content
360372
summary: Get a list of recent comments on a media object.
361373
tags:
362374
- comments
@@ -387,7 +399,6 @@ paths:
387399
security:
388400
- api_key: []
389401
- instagram_auth:
390-
- basic
391402
- comments
392403
summary: Create a comment on a media object.
393404
tags:
@@ -415,7 +426,6 @@ paths:
415426
security:
416427
- api_key: []
417428
- instagram_auth:
418-
- basic
419429
- comments
420430
summary: Remove a comment.
421431
tags:
@@ -437,7 +447,6 @@ paths:
437447
security:
438448
- api_key: []
439449
- instagram_auth:
440-
- basic
441450
- likes
442451
summary: Remove a like on this media by the current user.
443452
tags:
@@ -459,6 +468,7 @@ paths:
459468
- api_key: []
460469
- instagram_auth:
461470
- basic
471+
- public_content
462472
summary: Get a list of users who have liked this media.
463473
tags:
464474
- likes
@@ -478,7 +488,6 @@ paths:
478488
security:
479489
- api_key: []
480490
- instagram_auth:
481-
- basic
482491
- likes
483492
summary: Set a like on this media by the current user.
484493
tags:
@@ -500,7 +509,7 @@ paths:
500509
security:
501510
- api_key: []
502511
- instagram_auth:
503-
- basic
512+
- public_content
504513
summary: Search for tags by name.
505514
tags:
506515
- tags
@@ -521,7 +530,7 @@ paths:
521530
security:
522531
- api_key: []
523532
- instagram_auth:
524-
- basic
533+
- public_content
525534
summary: Get information about a tag object.
526535
tags:
527536
- tags
@@ -559,7 +568,7 @@ paths:
559568
security:
560569
- api_key: []
561570
- instagram_auth:
562-
- basic
571+
- public_content
563572
summary: Get a list of recently tagged media.
564573
tags:
565574
- tags
@@ -591,7 +600,11 @@ paths:
591600
- users
592601
/users/self/feed:
593602
get:
594-
description: "See the authenticated user's feed."
603+
deprecated: true
604+
description: |
605+
See the authenticated user's feed.
606+
607+
**Warning:** [Deprecated](http://instagram.com/developer/changelog/) for Apps created **on or after** Nov 17, 2015
595608
parameters:
596609
- description: Count of media to return.
597610
in: query
@@ -660,7 +673,7 @@ paths:
660673
security:
661674
- api_key: []
662675
- instagram_auth:
663-
- basic
676+
- follower_list
664677
summary: "List the users who have requested this user's permission to follow."
665678
tags:
666679
- relationships
@@ -669,6 +682,8 @@ paths:
669682
description: |
670683
Get basic information about a user. To get information about the owner of the access token, you can use
671684
**self** instead of the `user-id`.
685+
686+
Security scope `public_content` is required to read information about other users.
672687
parameters:
673688
- description: 'The ID of a user to get information about, or **self** to retrieve information about authenticated user.'
674689
in: path
@@ -686,6 +701,7 @@ paths:
686701
- api_key: []
687702
- instagram_auth:
688703
- basic
704+
- public_content
689705
summary: Get basic information about a user.
690706
tags:
691707
- users
@@ -708,7 +724,7 @@ paths:
708724
security:
709725
- api_key: []
710726
- instagram_auth:
711-
- basic
727+
- follower_list
712728
summary: Get the list of users this user is followed by.
713729
tags:
714730
- relationships
@@ -731,7 +747,7 @@ paths:
731747
security:
732748
- api_key: []
733749
- instagram_auth:
734-
- basic
750+
- follower_list
735751
summary: Get the list of users this user follows.
736752
tags:
737753
- relationships
@@ -740,6 +756,8 @@ paths:
740756
description: |
741757
Get the most recent media published by a user. To get the most recent media published by the owner of the
742758
access token, you can use **self** instead of the `user-id`.
759+
760+
Security scope `public_content` is required to read information about other users.
743761
parameters:
744762
- description: 'The ID of a user to get recent media of, or **self** to retrieve media of authenticated user.'
745763
in: path
@@ -782,6 +800,7 @@ paths:
782800
- api_key: []
783801
- instagram_auth:
784802
- basic
803+
- public_content
785804
summary: Get the most recent media published by a user.
786805
tags:
787806
- users
@@ -802,7 +821,7 @@ paths:
802821
security:
803822
- api_key: []
804823
- instagram_auth:
805-
- basic
824+
- follower_list
806825
summary: Get information about a relationship to another user.
807826
tags:
808827
- relationships
@@ -834,7 +853,6 @@ paths:
834853
security:
835854
- api_key: []
836855
- instagram_auth:
837-
- basic
838856
- relationships
839857
summary: Modify the relationship between the current user and the target user.
840858
tags:
@@ -874,7 +892,7 @@ definitions:
874892
description: 'Nember of comments available, data does not necessary contain all comments'
875893
type: integer
876894
data:
877-
description: Collection of comment entries
895+
description: 'Collection of comment entries; **warning:** deprecated for Apps [created on or after Nov 17, 2015](http://instagram.com/developer/changelog/)'
878896
items:
879897
$ref: '#/definitions/CommentEntry'
880898
type: array
@@ -932,7 +950,7 @@ definitions:
932950
description: 'Nember of likes available, data does not necessary contain all comments'
933951
type: integer
934952
data:
935-
description: Collection of users who liked
953+
description: 'Collection of users who liked; **warning:** deprecated for Apps [created on or after Nov 17, 2015](http://instagram.com/developer/changelog/)'
936954
items:
937955
$ref: '#/definitions/UserShortInfo'
938956
type: array
@@ -1159,7 +1177,7 @@ definitions:
11591177
TagPaginationInfo:
11601178
properties:
11611179
deprecation_warning:
1162-
description: 'The deprication warrning, if information is available'
1180+
description: 'The deprication warning, if information is available'
11631181
type: string
11641182
min_tag_id:
11651183
description: The min ID of a tag for the next page

0 commit comments

Comments
 (0)