@jpmorganchase/elemental 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- package/.storybook/main.js +1 -0
- package/.storybook/manager.js +1 -0
- package/.storybook/preview.jsx +3 -0
- package/LICENSE +190 -0
- package/README.md +19 -0
- package/jest.config.js +7 -0
- package/package.json +111 -0
- package/src/__fixtures__/api-descriptions/Instagram.ts +1859 -0
- package/src/__fixtures__/api-descriptions/badgesForSchema.ts +36 -0
- package/src/__fixtures__/api-descriptions/simpleApiWithInternalOperations.ts +253 -0
- package/src/__fixtures__/api-descriptions/simpleApiWithoutDescription.ts +243 -0
- package/src/__fixtures__/api-descriptions/todosApiBundled.ts +430 -0
- package/src/__fixtures__/api-descriptions/zoomApiYaml.ts +6083 -0
- package/src/components/API/APIWithSidebarLayout.tsx +111 -0
- package/src/components/API/APIWithStackedLayout.tsx +220 -0
- package/src/components/API/__tests__/utils.test.ts +848 -0
- package/src/components/API/utils.ts +174 -0
- package/src/containers/API.spec.tsx +131 -0
- package/src/containers/API.stories.tsx +99 -0
- package/src/containers/API.tsx +200 -0
- package/src/hooks/useExportDocumentProps.spec.tsx +68 -0
- package/src/hooks/useExportDocumentProps.tsx +48 -0
- package/src/index.ts +2 -0
- package/src/styles.css +1 -0
- package/src/utils/oas/__tests__/oas.spec.ts +272 -0
- package/src/utils/oas/index.ts +150 -0
- package/src/utils/oas/oas2.ts +31 -0
- package/src/utils/oas/oas3.ts +37 -0
- package/src/utils/oas/types.ts +31 -0
- package/src/web-components/__stories__/Api.stories.tsx +63 -0
- package/src/web-components/components.ts +20 -0
- package/src/web-components/index.ts +3 -0
- package/tsconfig.build.json +18 -0
- package/tsconfig.json +7 -0
- package/web-components.config.js +1 -0
@@ -0,0 +1,1859 @@
|
|
1
|
+
export const InstagramAPI = {
|
2
|
+
swagger: '2.0',
|
3
|
+
schemes: ['https'],
|
4
|
+
host: 'api.instagram.com',
|
5
|
+
basePath: '/v1',
|
6
|
+
info: {
|
7
|
+
contact: {
|
8
|
+
name: 'Instagram',
|
9
|
+
url: 'https://instagram.com/developer/support',
|
10
|
+
'x-twitter': 'instagram',
|
11
|
+
},
|
12
|
+
description:
|
13
|
+
'Description of Instagram RESTful API.\n\nCurrent limitations:\n * Instagram service does not support [cross origin headers](https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS)\n for security reasons, therefore it is not possible to use Swagger UI and make API calls directly from browser.\n * Modification API requests (`POST`, `DELETE`) require additional security [scopes](https://instagram.com/developer/authorization/)\n that are available for Apps [created on or after Nov 17, 2015](http://instagram.com/developer/review/) and\n started in [Sandbox Mode](http://instagram.com/developer/sandbox/).\n * Consider the [Instagram limitations](https://instagram.com/developer/limits/) for API calls that depends on App Mode.\n\n**Warning:** For Apps [created on or after Nov 17, 2015](http://instagram.com/developer/changelog/) API responses\ncontaining media objects no longer return the `data` field in `comments` and `likes` nodes.\n\nLast update: 2015-11-28\n',
|
14
|
+
termsOfService: 'https://instagram.com/about/legal/terms/api/',
|
15
|
+
title: 'Instagram API',
|
16
|
+
version: '1.0.0',
|
17
|
+
'x-apisguru-categories': ['social', 'media'],
|
18
|
+
'x-logo': {
|
19
|
+
url: 'https://api.apis.guru/v2/cache/logo/https_twitter.com_instagram_profile_image.png',
|
20
|
+
},
|
21
|
+
'x-origin': [
|
22
|
+
{
|
23
|
+
format: 'swagger',
|
24
|
+
url: 'https://raw.githubusercontent.com/darklynx/swagger-api-collection/master/api/yaml/instagram.yaml',
|
25
|
+
version: '2.0',
|
26
|
+
},
|
27
|
+
],
|
28
|
+
'x-preferred': true,
|
29
|
+
'x-providerName': 'instagram.com',
|
30
|
+
'x-unofficialSpec': true,
|
31
|
+
},
|
32
|
+
externalDocs: {
|
33
|
+
description: 'Instagram Developer Documentation',
|
34
|
+
url: 'https://instagram.com/developer',
|
35
|
+
},
|
36
|
+
produces: ['application/json'],
|
37
|
+
securityDefinitions: {
|
38
|
+
api_key: {
|
39
|
+
in: 'query',
|
40
|
+
name: 'access_token',
|
41
|
+
type: 'apiKey',
|
42
|
+
},
|
43
|
+
instagram_auth: {
|
44
|
+
authorizationUrl: 'https://instagram.com/oauth/authorize/',
|
45
|
+
flow: 'implicit',
|
46
|
+
scopes: {
|
47
|
+
basic: "to read a user's profile info and media (granted by default)",
|
48
|
+
comments: "to post and delete comments on a user's behalf",
|
49
|
+
follower_list: 'to read the list of followers and followed-by users',
|
50
|
+
likes: "to like and unlike media on a user's behalf",
|
51
|
+
public_content: 'to read any public profile info and media on a user’s behalf',
|
52
|
+
relationships: "to follow and unfollow accounts on a user's behalf",
|
53
|
+
},
|
54
|
+
type: 'oauth2',
|
55
|
+
},
|
56
|
+
},
|
57
|
+
tags: [
|
58
|
+
{
|
59
|
+
description: 'Get information about users',
|
60
|
+
name: 'users',
|
61
|
+
},
|
62
|
+
{
|
63
|
+
description: 'Relationships to other users outgoing and incoming',
|
64
|
+
name: 'relationships',
|
65
|
+
},
|
66
|
+
{
|
67
|
+
description: 'Get information about media',
|
68
|
+
name: 'media',
|
69
|
+
},
|
70
|
+
{
|
71
|
+
description: 'Manage comments',
|
72
|
+
name: 'comments',
|
73
|
+
},
|
74
|
+
{
|
75
|
+
description: 'Manage likes',
|
76
|
+
name: 'likes',
|
77
|
+
},
|
78
|
+
{
|
79
|
+
description: 'Get information about tags',
|
80
|
+
name: 'tags',
|
81
|
+
},
|
82
|
+
{
|
83
|
+
description: 'Get information about locations',
|
84
|
+
name: 'locations',
|
85
|
+
},
|
86
|
+
{
|
87
|
+
description: 'Get geographies',
|
88
|
+
name: 'geographies',
|
89
|
+
},
|
90
|
+
],
|
91
|
+
paths: {
|
92
|
+
'/geographies/{geo-id}/media/recent': {
|
93
|
+
get: {
|
94
|
+
deprecated: true,
|
95
|
+
description:
|
96
|
+
'Get recent media from a geography subscription that you created.\n\n**Note:** You can only access Geographies that were explicitly created by your OAuth client. Check the\nGeography Subscriptions section of the [real-time updates page](https://instagram.com/developer/realtime/).\nWhen you create a subscription to some geography that you define, you will be returned a unique `geo-id` that\ncan be used in this query. To backfill photos from the location covered by this geography, use the\n[media search endpoint](https://instagram.com/developer/endpoints/media/).\n\n**Warning:** [Deprecated](http://instagram.com/developer/changelog/) for Apps created **on or after** Nov 17, 2015\n',
|
97
|
+
parameters: [
|
98
|
+
{
|
99
|
+
description: 'The geography ID.',
|
100
|
+
in: 'path',
|
101
|
+
name: 'geo-id',
|
102
|
+
required: true,
|
103
|
+
type: 'string',
|
104
|
+
},
|
105
|
+
{
|
106
|
+
description: 'Max number of media to return.',
|
107
|
+
format: 'int32',
|
108
|
+
in: 'query',
|
109
|
+
name: 'count',
|
110
|
+
required: false,
|
111
|
+
type: 'integer',
|
112
|
+
},
|
113
|
+
{
|
114
|
+
description: 'Return media before this `min_id`.',
|
115
|
+
in: 'query',
|
116
|
+
name: 'min_id',
|
117
|
+
required: false,
|
118
|
+
type: 'string',
|
119
|
+
},
|
120
|
+
],
|
121
|
+
responses: {
|
122
|
+
'200': {
|
123
|
+
description: 'List of recent media entries from a geography subscription.',
|
124
|
+
schema: {
|
125
|
+
$ref: '#/definitions/MediaListResponse',
|
126
|
+
},
|
127
|
+
},
|
128
|
+
},
|
129
|
+
security: [
|
130
|
+
{
|
131
|
+
api_key: [],
|
132
|
+
},
|
133
|
+
{
|
134
|
+
instagram_auth: ['basic'],
|
135
|
+
},
|
136
|
+
],
|
137
|
+
summary: 'Get recent media from a custom geo-id.',
|
138
|
+
tags: ['geographies'],
|
139
|
+
},
|
140
|
+
},
|
141
|
+
'/locations/search': {
|
142
|
+
get: {
|
143
|
+
description: 'Search for a location by geographic coordinate.',
|
144
|
+
parameters: [
|
145
|
+
{
|
146
|
+
description: 'Default is 1000m (distance=1000), max distance is 5000.',
|
147
|
+
format: 'int32',
|
148
|
+
in: 'query',
|
149
|
+
name: 'distance',
|
150
|
+
required: false,
|
151
|
+
type: 'integer',
|
152
|
+
},
|
153
|
+
{
|
154
|
+
description:
|
155
|
+
'Returns a location mapped off of a Facebook places id. If used, a Foursquare id and `lat`, `lng` are not required.',
|
156
|
+
in: 'query',
|
157
|
+
name: 'facebook_places_id',
|
158
|
+
required: false,
|
159
|
+
type: 'string',
|
160
|
+
},
|
161
|
+
{
|
162
|
+
description:
|
163
|
+
'Returns a location mapped off of a foursquare v1 api location id. If used, you are not required to use\n`lat` and `lng`. Note that this method is deprecated; you should use the new foursquare IDs with V2 of their API.\n',
|
164
|
+
in: 'query',
|
165
|
+
name: 'foursquare_id',
|
166
|
+
required: false,
|
167
|
+
type: 'string',
|
168
|
+
},
|
169
|
+
{
|
170
|
+
description: 'Latitude of the center search coordinate. If used, `lng` is required.',
|
171
|
+
format: 'double',
|
172
|
+
in: 'query',
|
173
|
+
name: 'lat',
|
174
|
+
required: false,
|
175
|
+
type: 'number',
|
176
|
+
},
|
177
|
+
{
|
178
|
+
description: 'Longitude of the center search coordinate. If used, `lat` is required.',
|
179
|
+
format: 'double',
|
180
|
+
in: 'query',
|
181
|
+
name: 'lng',
|
182
|
+
required: false,
|
183
|
+
type: 'number',
|
184
|
+
},
|
185
|
+
{
|
186
|
+
description:
|
187
|
+
'Returns a location mapped off of a foursquare v2 api location id. If used, you are not required to use\n`lat` and `lng`.\n',
|
188
|
+
in: 'query',
|
189
|
+
name: 'foursquare_v2_id',
|
190
|
+
required: false,
|
191
|
+
type: 'string',
|
192
|
+
},
|
193
|
+
],
|
194
|
+
responses: {
|
195
|
+
'200': {
|
196
|
+
description: 'List of found locations.',
|
197
|
+
schema: {
|
198
|
+
$ref: '#/definitions/LocationSearchResponse',
|
199
|
+
},
|
200
|
+
},
|
201
|
+
},
|
202
|
+
security: [
|
203
|
+
{
|
204
|
+
api_key: [],
|
205
|
+
},
|
206
|
+
{
|
207
|
+
instagram_auth: ['public_content'],
|
208
|
+
},
|
209
|
+
],
|
210
|
+
summary: 'Search for a location by geographic coordinate.',
|
211
|
+
tags: ['locations'],
|
212
|
+
},
|
213
|
+
},
|
214
|
+
'/locations/{location-id}': {
|
215
|
+
get: {
|
216
|
+
description: 'Get information about a location.',
|
217
|
+
parameters: [
|
218
|
+
{
|
219
|
+
description: 'The location ID.',
|
220
|
+
in: 'path',
|
221
|
+
name: 'location-id',
|
222
|
+
required: true,
|
223
|
+
type: 'string',
|
224
|
+
},
|
225
|
+
],
|
226
|
+
responses: {
|
227
|
+
'200': {
|
228
|
+
description: 'Location information response.',
|
229
|
+
schema: {
|
230
|
+
$ref: '#/definitions/LocationInfoResponse',
|
231
|
+
},
|
232
|
+
},
|
233
|
+
},
|
234
|
+
security: [
|
235
|
+
{
|
236
|
+
api_key: [],
|
237
|
+
},
|
238
|
+
{
|
239
|
+
instagram_auth: ['public_content'],
|
240
|
+
},
|
241
|
+
],
|
242
|
+
summary: 'Get information about a location.',
|
243
|
+
tags: ['locations'],
|
244
|
+
},
|
245
|
+
},
|
246
|
+
'/locations/{location-id}/media/recent': {
|
247
|
+
get: {
|
248
|
+
description: 'Get a list of recent media objects from a given location.',
|
249
|
+
parameters: [
|
250
|
+
{
|
251
|
+
description: 'The location ID.',
|
252
|
+
in: 'path',
|
253
|
+
name: 'location-id',
|
254
|
+
required: true,
|
255
|
+
type: 'string',
|
256
|
+
},
|
257
|
+
{
|
258
|
+
description: 'Return media after this UNIX timestamp.',
|
259
|
+
format: 'int64',
|
260
|
+
in: 'query',
|
261
|
+
name: 'min_timestamp',
|
262
|
+
required: false,
|
263
|
+
type: 'integer',
|
264
|
+
},
|
265
|
+
{
|
266
|
+
description: 'Return media before this UNIX timestamp.',
|
267
|
+
format: 'int64',
|
268
|
+
in: 'query',
|
269
|
+
name: 'max_timestamp',
|
270
|
+
required: false,
|
271
|
+
type: 'integer',
|
272
|
+
},
|
273
|
+
{
|
274
|
+
description: 'Return media before this `min_id`.',
|
275
|
+
in: 'query',
|
276
|
+
name: 'min_id',
|
277
|
+
required: false,
|
278
|
+
type: 'string',
|
279
|
+
},
|
280
|
+
{
|
281
|
+
description: 'Return media after this `max_id`.',
|
282
|
+
in: 'query',
|
283
|
+
name: 'max_id',
|
284
|
+
required: false,
|
285
|
+
type: 'string',
|
286
|
+
},
|
287
|
+
],
|
288
|
+
responses: {
|
289
|
+
'200': {
|
290
|
+
description: 'List of media entries from this location.',
|
291
|
+
schema: {
|
292
|
+
$ref: '#/definitions/MediaListResponse',
|
293
|
+
},
|
294
|
+
},
|
295
|
+
},
|
296
|
+
security: [
|
297
|
+
{
|
298
|
+
api_key: [],
|
299
|
+
},
|
300
|
+
{
|
301
|
+
instagram_auth: ['public_content'],
|
302
|
+
},
|
303
|
+
],
|
304
|
+
summary: 'Get a list of recent media objects from a given location.',
|
305
|
+
tags: ['locations'],
|
306
|
+
},
|
307
|
+
},
|
308
|
+
'/media/popular': {
|
309
|
+
get: {
|
310
|
+
deprecated: true,
|
311
|
+
description:
|
312
|
+
'Get a list of what media is most popular at the moment. Can return mix of `image` and `video` types.\n\n**Warning:** [Deprecated](http://instagram.com/developer/changelog/) for Apps created **on or after** Nov 17, 2015\n',
|
313
|
+
responses: {
|
314
|
+
'200': {
|
315
|
+
description: 'Found media resources (without likes information).',
|
316
|
+
schema: {
|
317
|
+
$ref: '#/definitions/MediaSearchResponse',
|
318
|
+
},
|
319
|
+
},
|
320
|
+
},
|
321
|
+
security: [
|
322
|
+
{
|
323
|
+
api_key: [],
|
324
|
+
},
|
325
|
+
{
|
326
|
+
instagram_auth: ['basic'],
|
327
|
+
},
|
328
|
+
],
|
329
|
+
summary: 'Get a list of currently popular media.',
|
330
|
+
tags: ['media'],
|
331
|
+
},
|
332
|
+
},
|
333
|
+
'/media/search': {
|
334
|
+
get: {
|
335
|
+
description:
|
336
|
+
'Search for media in a given area. The default time span is set to 5 days. The time span must not exceed 7 days.\nDefaults time stamps cover the last 5 days. Can return mix of `image` and `video` types.\n',
|
337
|
+
parameters: [
|
338
|
+
{
|
339
|
+
description: 'Latitude of the center search coordinate. If used, `lng` is required.',
|
340
|
+
format: 'double',
|
341
|
+
in: 'query',
|
342
|
+
name: 'lat',
|
343
|
+
required: true,
|
344
|
+
type: 'number',
|
345
|
+
},
|
346
|
+
{
|
347
|
+
description: 'Longitude of the center search coordinate. If used, `lat` is required.',
|
348
|
+
format: 'double',
|
349
|
+
in: 'query',
|
350
|
+
name: 'lng',
|
351
|
+
required: true,
|
352
|
+
type: 'number',
|
353
|
+
},
|
354
|
+
{
|
355
|
+
description: 'A unix timestamp. All media returned will be taken later than this timestamp.',
|
356
|
+
format: 'int64',
|
357
|
+
in: 'query',
|
358
|
+
name: 'min_timestamp',
|
359
|
+
required: false,
|
360
|
+
type: 'integer',
|
361
|
+
},
|
362
|
+
{
|
363
|
+
description: 'A unix timestamp. All media returned will be taken earlier than this timestamp.',
|
364
|
+
format: 'int64',
|
365
|
+
in: 'query',
|
366
|
+
name: 'max_timestamp',
|
367
|
+
required: false,
|
368
|
+
type: 'integer',
|
369
|
+
},
|
370
|
+
{
|
371
|
+
description: 'Default is 1km (distance=1000), max distance is 5km.',
|
372
|
+
format: 'int32',
|
373
|
+
in: 'query',
|
374
|
+
name: 'distance',
|
375
|
+
required: false,
|
376
|
+
type: 'integer',
|
377
|
+
},
|
378
|
+
],
|
379
|
+
responses: {
|
380
|
+
'200': {
|
381
|
+
description: 'Found media resources (without likes information) in a given area.',
|
382
|
+
schema: {
|
383
|
+
$ref: '#/definitions/MediaSearchResponse',
|
384
|
+
},
|
385
|
+
},
|
386
|
+
},
|
387
|
+
security: [
|
388
|
+
{
|
389
|
+
api_key: [],
|
390
|
+
},
|
391
|
+
{
|
392
|
+
instagram_auth: ['public_content'],
|
393
|
+
},
|
394
|
+
],
|
395
|
+
summary: 'Search for media in a given area.',
|
396
|
+
tags: ['media'],
|
397
|
+
},
|
398
|
+
},
|
399
|
+
'/media/shortcode/{shortcode}': {
|
400
|
+
get: {
|
401
|
+
description:
|
402
|
+
"This endpoint returns the same response as `GET /media/{media-id}`.\n\nA media object's shortcode can be found in its shortlink URL. An example shortlink is\n`http://instagram.com/p/D/`, its corresponding shortcode is `D`.\n",
|
403
|
+
parameters: [
|
404
|
+
{
|
405
|
+
description: 'The short code of the media resource.',
|
406
|
+
in: 'path',
|
407
|
+
name: 'shortcode',
|
408
|
+
required: true,
|
409
|
+
type: 'string',
|
410
|
+
},
|
411
|
+
],
|
412
|
+
responses: {
|
413
|
+
'200': {
|
414
|
+
description: 'Media resource information.',
|
415
|
+
schema: {
|
416
|
+
$ref: '#/definitions/MediaEntryResponse',
|
417
|
+
},
|
418
|
+
},
|
419
|
+
},
|
420
|
+
security: [
|
421
|
+
{
|
422
|
+
api_key: [],
|
423
|
+
},
|
424
|
+
{
|
425
|
+
instagram_auth: ['basic', 'public_content'],
|
426
|
+
},
|
427
|
+
],
|
428
|
+
summary: 'Get information about a media object.',
|
429
|
+
tags: ['media'],
|
430
|
+
},
|
431
|
+
},
|
432
|
+
'/media/{media-id}': {
|
433
|
+
get: {
|
434
|
+
description:
|
435
|
+
'Get information about a media object. The returned type key will allow you to differentiate between image and\nvideo media.\n\n**Note:** if you authenticate with an OAuth Token, you will receive the user_has_liked key which quickly tells\nyou whether the current user has liked this media item.\n',
|
436
|
+
parameters: [
|
437
|
+
{
|
438
|
+
description: 'The ID of the media resource.',
|
439
|
+
in: 'path',
|
440
|
+
name: 'media-id',
|
441
|
+
required: true,
|
442
|
+
type: 'string',
|
443
|
+
},
|
444
|
+
],
|
445
|
+
responses: {
|
446
|
+
'200': {
|
447
|
+
description: 'Media resource information.',
|
448
|
+
schema: {
|
449
|
+
$ref: '#/definitions/MediaEntryResponse',
|
450
|
+
},
|
451
|
+
},
|
452
|
+
},
|
453
|
+
security: [
|
454
|
+
{
|
455
|
+
api_key: [],
|
456
|
+
},
|
457
|
+
{
|
458
|
+
instagram_auth: ['basic', 'public_content'],
|
459
|
+
},
|
460
|
+
],
|
461
|
+
summary: 'Get information about a media object.',
|
462
|
+
tags: ['media'],
|
463
|
+
},
|
464
|
+
},
|
465
|
+
'/media/{media-id}/comments': {
|
466
|
+
get: {
|
467
|
+
description: 'Get a list of recent comments on a media object.',
|
468
|
+
parameters: [
|
469
|
+
{
|
470
|
+
description: 'The ID of the media resource.',
|
471
|
+
in: 'path',
|
472
|
+
name: 'media-id',
|
473
|
+
required: true,
|
474
|
+
type: 'string',
|
475
|
+
},
|
476
|
+
],
|
477
|
+
responses: {
|
478
|
+
'200': {
|
479
|
+
description: 'List of comments of the media resource.',
|
480
|
+
schema: {
|
481
|
+
$ref: '#/definitions/CommentsResponse',
|
482
|
+
},
|
483
|
+
},
|
484
|
+
},
|
485
|
+
security: [
|
486
|
+
{
|
487
|
+
api_key: [],
|
488
|
+
},
|
489
|
+
{
|
490
|
+
instagram_auth: ['basic', 'public_content'],
|
491
|
+
},
|
492
|
+
],
|
493
|
+
summary: 'Get a list of recent comments on a media object.',
|
494
|
+
tags: ['comments'],
|
495
|
+
},
|
496
|
+
post: {
|
497
|
+
description:
|
498
|
+
'Create a comment on a media object with the following rules:\n\n * The total length of the comment cannot exceed 300 characters.\n * The comment cannot contain more than 4 hashtags.\n * The comment cannot contain more than 1 URL.\n * The comment cannot consist of all capital letters.\n',
|
499
|
+
parameters: [
|
500
|
+
{
|
501
|
+
description: 'The ID of the media resource.',
|
502
|
+
in: 'path',
|
503
|
+
name: 'media-id',
|
504
|
+
required: true,
|
505
|
+
type: 'string',
|
506
|
+
},
|
507
|
+
{
|
508
|
+
description: 'Text to post as a comment on the media object as specified in `media-id`.',
|
509
|
+
in: 'query',
|
510
|
+
name: 'text',
|
511
|
+
required: true,
|
512
|
+
type: 'string',
|
513
|
+
},
|
514
|
+
],
|
515
|
+
responses: {
|
516
|
+
'200': {
|
517
|
+
description: 'Result of posting a comment.',
|
518
|
+
schema: {
|
519
|
+
$ref: '#/definitions/StatusResponse',
|
520
|
+
},
|
521
|
+
},
|
522
|
+
},
|
523
|
+
security: [
|
524
|
+
{
|
525
|
+
api_key: [],
|
526
|
+
},
|
527
|
+
{
|
528
|
+
instagram_auth: ['comments'],
|
529
|
+
},
|
530
|
+
],
|
531
|
+
summary: 'Create a comment on a media object.',
|
532
|
+
tags: ['comments'],
|
533
|
+
},
|
534
|
+
},
|
535
|
+
'/media/{media-id}/comments/{comment-id}': {
|
536
|
+
delete: {
|
537
|
+
description:
|
538
|
+
"Remove a comment either on the authenticated user's media object or authored by the authenticated user.\n",
|
539
|
+
parameters: [
|
540
|
+
{
|
541
|
+
description: 'The ID of the media resource.',
|
542
|
+
in: 'path',
|
543
|
+
name: 'media-id',
|
544
|
+
required: true,
|
545
|
+
type: 'string',
|
546
|
+
},
|
547
|
+
{
|
548
|
+
description: 'The ID of the comment entry.',
|
549
|
+
in: 'path',
|
550
|
+
name: 'comment-id',
|
551
|
+
required: true,
|
552
|
+
type: 'string',
|
553
|
+
},
|
554
|
+
],
|
555
|
+
responses: {
|
556
|
+
'200': {
|
557
|
+
description: 'Result of deleting a comment.',
|
558
|
+
schema: {
|
559
|
+
$ref: '#/definitions/StatusResponse',
|
560
|
+
},
|
561
|
+
},
|
562
|
+
},
|
563
|
+
security: [
|
564
|
+
{
|
565
|
+
api_key: [],
|
566
|
+
},
|
567
|
+
{
|
568
|
+
instagram_auth: ['comments'],
|
569
|
+
},
|
570
|
+
],
|
571
|
+
summary: 'Remove a comment.',
|
572
|
+
tags: ['comments'],
|
573
|
+
},
|
574
|
+
},
|
575
|
+
'/media/{media-id}/likes': {
|
576
|
+
delete: {
|
577
|
+
description: 'Remove a like on this media by the currently authenticated user.',
|
578
|
+
parameters: [
|
579
|
+
{
|
580
|
+
description: 'The ID of the media resource.',
|
581
|
+
in: 'path',
|
582
|
+
name: 'media-id',
|
583
|
+
required: true,
|
584
|
+
type: 'string',
|
585
|
+
},
|
586
|
+
],
|
587
|
+
responses: {
|
588
|
+
'200': {
|
589
|
+
description: 'Result of removing a like.',
|
590
|
+
schema: {
|
591
|
+
$ref: '#/definitions/StatusResponse',
|
592
|
+
},
|
593
|
+
},
|
594
|
+
},
|
595
|
+
security: [
|
596
|
+
{
|
597
|
+
api_key: [],
|
598
|
+
},
|
599
|
+
{
|
600
|
+
instagram_auth: ['likes'],
|
601
|
+
},
|
602
|
+
],
|
603
|
+
summary: 'Remove a like on this media by the current user.',
|
604
|
+
tags: ['likes'],
|
605
|
+
},
|
606
|
+
get: {
|
607
|
+
description: 'Get a list of users who have liked this media.',
|
608
|
+
parameters: [
|
609
|
+
{
|
610
|
+
description: 'The ID of the media resource.',
|
611
|
+
in: 'path',
|
612
|
+
name: 'media-id',
|
613
|
+
required: true,
|
614
|
+
type: 'string',
|
615
|
+
},
|
616
|
+
],
|
617
|
+
responses: {
|
618
|
+
'200': {
|
619
|
+
description: 'List of users who liked the media resource.',
|
620
|
+
schema: {
|
621
|
+
$ref: '#/definitions/UsersInfoResponse',
|
622
|
+
},
|
623
|
+
},
|
624
|
+
},
|
625
|
+
security: [
|
626
|
+
{
|
627
|
+
api_key: [],
|
628
|
+
},
|
629
|
+
{
|
630
|
+
instagram_auth: ['basic', 'public_content'],
|
631
|
+
},
|
632
|
+
],
|
633
|
+
summary: 'Get a list of users who have liked this media.',
|
634
|
+
tags: ['likes'],
|
635
|
+
},
|
636
|
+
post: {
|
637
|
+
description: 'Set a like on this media by the currently authenticated user.',
|
638
|
+
parameters: [
|
639
|
+
{
|
640
|
+
description: 'The ID of the media resource.',
|
641
|
+
in: 'path',
|
642
|
+
name: 'media-id',
|
643
|
+
required: true,
|
644
|
+
type: 'string',
|
645
|
+
},
|
646
|
+
],
|
647
|
+
responses: {
|
648
|
+
'200': {
|
649
|
+
description: 'Result of setting a like.',
|
650
|
+
schema: {
|
651
|
+
$ref: '#/definitions/StatusResponse',
|
652
|
+
},
|
653
|
+
},
|
654
|
+
},
|
655
|
+
security: [
|
656
|
+
{
|
657
|
+
api_key: [],
|
658
|
+
},
|
659
|
+
{
|
660
|
+
instagram_auth: ['likes'],
|
661
|
+
},
|
662
|
+
],
|
663
|
+
summary: 'Set a like on this media by the current user.',
|
664
|
+
tags: ['likes'],
|
665
|
+
},
|
666
|
+
},
|
667
|
+
'/tags/search': {
|
668
|
+
get: {
|
669
|
+
description: 'Search for tags by name.',
|
670
|
+
parameters: [
|
671
|
+
{
|
672
|
+
description: 'A valid tag name without a leading \\#. (eg. snowy, nofilter)',
|
673
|
+
in: 'query',
|
674
|
+
name: 'q',
|
675
|
+
required: true,
|
676
|
+
type: 'string',
|
677
|
+
},
|
678
|
+
],
|
679
|
+
responses: {
|
680
|
+
'200': {
|
681
|
+
description: 'List of found tags and their statistics.',
|
682
|
+
schema: {
|
683
|
+
$ref: '#/definitions/TagSearchResponse',
|
684
|
+
},
|
685
|
+
},
|
686
|
+
},
|
687
|
+
security: [
|
688
|
+
{
|
689
|
+
api_key: [],
|
690
|
+
},
|
691
|
+
{
|
692
|
+
instagram_auth: ['public_content'],
|
693
|
+
},
|
694
|
+
],
|
695
|
+
summary: 'Search for tags by name.',
|
696
|
+
tags: ['tags'],
|
697
|
+
},
|
698
|
+
},
|
699
|
+
'/tags/{tag-name}': {
|
700
|
+
get: {
|
701
|
+
description: 'Get information about a tag object.',
|
702
|
+
parameters: [
|
703
|
+
{
|
704
|
+
description: 'The tag name.',
|
705
|
+
in: 'path',
|
706
|
+
name: 'tag-name',
|
707
|
+
required: true,
|
708
|
+
type: 'string',
|
709
|
+
},
|
710
|
+
],
|
711
|
+
responses: {
|
712
|
+
'200': {
|
713
|
+
description: 'Tag information response.',
|
714
|
+
schema: {
|
715
|
+
$ref: '#/definitions/TagInfoResponse',
|
716
|
+
},
|
717
|
+
},
|
718
|
+
},
|
719
|
+
security: [
|
720
|
+
{
|
721
|
+
api_key: [],
|
722
|
+
},
|
723
|
+
{
|
724
|
+
instagram_auth: ['public_content'],
|
725
|
+
},
|
726
|
+
],
|
727
|
+
summary: 'Get information about a tag object.',
|
728
|
+
tags: ['tags'],
|
729
|
+
},
|
730
|
+
},
|
731
|
+
'/tags/{tag-name}/media/recent': {
|
732
|
+
get: {
|
733
|
+
description:
|
734
|
+
'Get a list of recently tagged media. Use the `max_tag_id` and `min_tag_id` parameters in the pagination\nresponse to paginate through these objects.\n',
|
735
|
+
parameters: [
|
736
|
+
{
|
737
|
+
description: 'The tag name.',
|
738
|
+
in: 'path',
|
739
|
+
name: 'tag-name',
|
740
|
+
required: true,
|
741
|
+
type: 'string',
|
742
|
+
},
|
743
|
+
{
|
744
|
+
description: 'Count of tagged media to return.',
|
745
|
+
in: 'query',
|
746
|
+
name: 'count',
|
747
|
+
required: false,
|
748
|
+
type: 'integer',
|
749
|
+
},
|
750
|
+
{
|
751
|
+
description: 'Return media before this `min_tag_id`.',
|
752
|
+
in: 'query',
|
753
|
+
name: 'min_tag_id',
|
754
|
+
required: false,
|
755
|
+
type: 'string',
|
756
|
+
},
|
757
|
+
{
|
758
|
+
description: 'Return media after this `max_tag_id`.',
|
759
|
+
in: 'query',
|
760
|
+
name: 'max_tag_id',
|
761
|
+
required: false,
|
762
|
+
type: 'string',
|
763
|
+
},
|
764
|
+
],
|
765
|
+
responses: {
|
766
|
+
'200': {
|
767
|
+
description: 'List of media entries with this tag.',
|
768
|
+
schema: {
|
769
|
+
$ref: '#/definitions/TagMediaListResponse',
|
770
|
+
},
|
771
|
+
},
|
772
|
+
},
|
773
|
+
security: [
|
774
|
+
{
|
775
|
+
api_key: [],
|
776
|
+
},
|
777
|
+
{
|
778
|
+
instagram_auth: ['public_content'],
|
779
|
+
},
|
780
|
+
],
|
781
|
+
summary: 'Get a list of recently tagged media.',
|
782
|
+
tags: ['tags'],
|
783
|
+
},
|
784
|
+
},
|
785
|
+
'/users/search': {
|
786
|
+
get: {
|
787
|
+
description: 'Search for a user by name.',
|
788
|
+
parameters: [
|
789
|
+
{
|
790
|
+
description: 'A query string.',
|
791
|
+
in: 'query',
|
792
|
+
name: 'q',
|
793
|
+
required: true,
|
794
|
+
type: 'string',
|
795
|
+
},
|
796
|
+
{
|
797
|
+
description: 'Number of users to return.',
|
798
|
+
in: 'query',
|
799
|
+
name: 'count',
|
800
|
+
required: false,
|
801
|
+
type: 'integer',
|
802
|
+
},
|
803
|
+
],
|
804
|
+
responses: {
|
805
|
+
'200': {
|
806
|
+
description: 'List of found users.',
|
807
|
+
schema: {
|
808
|
+
$ref: '#/definitions/UsersInfoResponse',
|
809
|
+
},
|
810
|
+
},
|
811
|
+
},
|
812
|
+
security: [
|
813
|
+
{
|
814
|
+
api_key: [],
|
815
|
+
},
|
816
|
+
{
|
817
|
+
instagram_auth: ['basic'],
|
818
|
+
},
|
819
|
+
],
|
820
|
+
summary: 'Search for a user by name.',
|
821
|
+
tags: ['users'],
|
822
|
+
},
|
823
|
+
},
|
824
|
+
'/users/self/feed': {
|
825
|
+
get: {
|
826
|
+
deprecated: true,
|
827
|
+
description:
|
828
|
+
"See the authenticated user's feed.\n\n**Warning:** [Deprecated](http://instagram.com/developer/changelog/) for Apps created **on or after** Nov 17, 2015\n",
|
829
|
+
parameters: [
|
830
|
+
{
|
831
|
+
description: 'Count of media to return.',
|
832
|
+
in: 'query',
|
833
|
+
name: 'count',
|
834
|
+
required: false,
|
835
|
+
type: 'integer',
|
836
|
+
},
|
837
|
+
{
|
838
|
+
description: 'Return media later than this `min_id`.',
|
839
|
+
in: 'query',
|
840
|
+
name: 'min_id',
|
841
|
+
required: false,
|
842
|
+
type: 'string',
|
843
|
+
},
|
844
|
+
{
|
845
|
+
description: 'Return media earlier than this `max_id`.',
|
846
|
+
in: 'query',
|
847
|
+
name: 'max_id',
|
848
|
+
required: false,
|
849
|
+
type: 'string',
|
850
|
+
},
|
851
|
+
],
|
852
|
+
responses: {
|
853
|
+
'200': {
|
854
|
+
description: 'Users feed entries.',
|
855
|
+
schema: {
|
856
|
+
$ref: '#/definitions/MediaListResponse',
|
857
|
+
},
|
858
|
+
},
|
859
|
+
},
|
860
|
+
security: [
|
861
|
+
{
|
862
|
+
api_key: [],
|
863
|
+
},
|
864
|
+
{
|
865
|
+
instagram_auth: ['basic'],
|
866
|
+
},
|
867
|
+
],
|
868
|
+
summary: "See the authenticated user's feed.",
|
869
|
+
tags: ['users'],
|
870
|
+
},
|
871
|
+
},
|
872
|
+
'/users/self/media/liked': {
|
873
|
+
get: {
|
874
|
+
description:
|
875
|
+
'See the list of media liked by the authenticated user. Private media is returned as long as the authenticated\nuser has permission to view that media. Liked media lists are only available for the currently authenticated\nuser.\n',
|
876
|
+
parameters: [
|
877
|
+
{
|
878
|
+
description: 'Count of media to return.',
|
879
|
+
in: 'query',
|
880
|
+
name: 'count',
|
881
|
+
required: false,
|
882
|
+
type: 'integer',
|
883
|
+
},
|
884
|
+
{
|
885
|
+
description: 'Return media liked before this id.',
|
886
|
+
in: 'query',
|
887
|
+
name: 'max_like_id',
|
888
|
+
required: false,
|
889
|
+
type: 'string',
|
890
|
+
},
|
891
|
+
],
|
892
|
+
responses: {
|
893
|
+
'200': {
|
894
|
+
description: 'Users media entries.',
|
895
|
+
schema: {
|
896
|
+
$ref: '#/definitions/MediaListResponse',
|
897
|
+
},
|
898
|
+
},
|
899
|
+
},
|
900
|
+
security: [
|
901
|
+
{
|
902
|
+
api_key: [],
|
903
|
+
},
|
904
|
+
{
|
905
|
+
instagram_auth: ['basic'],
|
906
|
+
},
|
907
|
+
],
|
908
|
+
summary: 'See the list of media liked by the authenticated user.',
|
909
|
+
tags: ['users'],
|
910
|
+
},
|
911
|
+
},
|
912
|
+
'/users/self/requested-by': {
|
913
|
+
get: {
|
914
|
+
description: "List the users who have requested this user's permission to follow.",
|
915
|
+
responses: {
|
916
|
+
'200': {
|
917
|
+
description: "List of users who have requested this user's permission to follow.",
|
918
|
+
schema: {
|
919
|
+
$ref: '#/definitions/UsersInfoResponse',
|
920
|
+
},
|
921
|
+
},
|
922
|
+
},
|
923
|
+
security: [
|
924
|
+
{
|
925
|
+
api_key: [],
|
926
|
+
},
|
927
|
+
{
|
928
|
+
instagram_auth: ['follower_list'],
|
929
|
+
},
|
930
|
+
],
|
931
|
+
summary: "List the users who have requested this user's permission to follow.",
|
932
|
+
tags: ['relationships'],
|
933
|
+
},
|
934
|
+
},
|
935
|
+
'/users/{user-id}': {
|
936
|
+
get: {
|
937
|
+
description:
|
938
|
+
'Get basic information about a user. To get information about the owner of the access token, you can use\n**self** instead of the `user-id`.\n\nSecurity scope `public_content` is required to read information about other users.\n',
|
939
|
+
parameters: [
|
940
|
+
{
|
941
|
+
description:
|
942
|
+
'The ID of a user to get information about, or **self** to retrieve information about authenticated user.',
|
943
|
+
in: 'path',
|
944
|
+
name: 'user-id',
|
945
|
+
required: true,
|
946
|
+
type: 'string',
|
947
|
+
},
|
948
|
+
],
|
949
|
+
responses: {
|
950
|
+
'200': {
|
951
|
+
description: 'User basic information.',
|
952
|
+
schema: {
|
953
|
+
$ref: '#/definitions/UserResponse',
|
954
|
+
},
|
955
|
+
},
|
956
|
+
'404': {
|
957
|
+
description: 'Not Found, user with such ID does not exist.',
|
958
|
+
},
|
959
|
+
},
|
960
|
+
security: [
|
961
|
+
{
|
962
|
+
api_key: [],
|
963
|
+
},
|
964
|
+
{
|
965
|
+
instagram_auth: ['basic', 'public_content'],
|
966
|
+
},
|
967
|
+
],
|
968
|
+
summary: 'Get basic information about a user.',
|
969
|
+
tags: ['users'],
|
970
|
+
},
|
971
|
+
},
|
972
|
+
'/users/{user-id}/followed-by': {
|
973
|
+
get: {
|
974
|
+
description:
|
975
|
+
'Get the list of users this user is followed by. To get users followed by the owner of the access token, you\ncan use **self** instead of the `user-id`.\n',
|
976
|
+
parameters: [
|
977
|
+
{
|
978
|
+
description: 'The ID of a user, or **self** to retrieve information about authenticated user.',
|
979
|
+
in: 'path',
|
980
|
+
name: 'user-id',
|
981
|
+
required: true,
|
982
|
+
type: 'string',
|
983
|
+
},
|
984
|
+
],
|
985
|
+
responses: {
|
986
|
+
'200': {
|
987
|
+
description: 'List of users this user is followed by.',
|
988
|
+
schema: {
|
989
|
+
$ref: '#/definitions/UsersPagingResponse',
|
990
|
+
},
|
991
|
+
},
|
992
|
+
},
|
993
|
+
security: [
|
994
|
+
{
|
995
|
+
api_key: [],
|
996
|
+
},
|
997
|
+
{
|
998
|
+
instagram_auth: ['follower_list'],
|
999
|
+
},
|
1000
|
+
],
|
1001
|
+
summary: 'Get the list of users this user is followed by.',
|
1002
|
+
tags: ['relationships'],
|
1003
|
+
},
|
1004
|
+
},
|
1005
|
+
'/users/{user-id}/follows': {
|
1006
|
+
get: {
|
1007
|
+
description:
|
1008
|
+
'Get the list of users this user follows. To get follows of the owner of the access token, you can use **self**\ninstead of the `user-id`.\n',
|
1009
|
+
parameters: [
|
1010
|
+
{
|
1011
|
+
description: 'The ID of a user, or **self** to retrieve information about authenticated user.',
|
1012
|
+
in: 'path',
|
1013
|
+
name: 'user-id',
|
1014
|
+
required: true,
|
1015
|
+
type: 'string',
|
1016
|
+
},
|
1017
|
+
],
|
1018
|
+
responses: {
|
1019
|
+
'200': {
|
1020
|
+
description: 'List of users this user follows.',
|
1021
|
+
schema: {
|
1022
|
+
$ref: '#/definitions/UsersPagingResponse',
|
1023
|
+
},
|
1024
|
+
},
|
1025
|
+
},
|
1026
|
+
security: [
|
1027
|
+
{
|
1028
|
+
api_key: [],
|
1029
|
+
},
|
1030
|
+
{
|
1031
|
+
instagram_auth: ['follower_list'],
|
1032
|
+
},
|
1033
|
+
],
|
1034
|
+
summary: 'Get the list of users this user follows.',
|
1035
|
+
tags: ['relationships'],
|
1036
|
+
},
|
1037
|
+
},
|
1038
|
+
'/users/{user-id}/media/recent': {
|
1039
|
+
get: {
|
1040
|
+
description:
|
1041
|
+
'Get the most recent media published by a user. To get the most recent media published by the owner of the\naccess token, you can use **self** instead of the `user-id`.\n\nSecurity scope `public_content` is required to read information about other users.\n',
|
1042
|
+
parameters: [
|
1043
|
+
{
|
1044
|
+
description:
|
1045
|
+
'The ID of a user to get recent media of, or **self** to retrieve media of authenticated user.',
|
1046
|
+
in: 'path',
|
1047
|
+
name: 'user-id',
|
1048
|
+
required: true,
|
1049
|
+
type: 'string',
|
1050
|
+
},
|
1051
|
+
{
|
1052
|
+
description: 'Count of media to return.',
|
1053
|
+
in: 'query',
|
1054
|
+
name: 'count',
|
1055
|
+
required: false,
|
1056
|
+
type: 'integer',
|
1057
|
+
},
|
1058
|
+
{
|
1059
|
+
description: 'Return media before this UNIX timestamp.',
|
1060
|
+
format: 'int64',
|
1061
|
+
in: 'query',
|
1062
|
+
name: 'max_timestamp',
|
1063
|
+
required: false,
|
1064
|
+
type: 'integer',
|
1065
|
+
},
|
1066
|
+
{
|
1067
|
+
description: 'Return media after this UNIX timestamp.',
|
1068
|
+
format: 'int64',
|
1069
|
+
in: 'query',
|
1070
|
+
name: 'min_timestamp',
|
1071
|
+
required: false,
|
1072
|
+
type: 'integer',
|
1073
|
+
},
|
1074
|
+
{
|
1075
|
+
description: 'Return media later than this `min_id`.',
|
1076
|
+
in: 'query',
|
1077
|
+
name: 'min_id',
|
1078
|
+
required: false,
|
1079
|
+
type: 'string',
|
1080
|
+
},
|
1081
|
+
{
|
1082
|
+
description: 'Return media earlier than this `max_id`.',
|
1083
|
+
in: 'query',
|
1084
|
+
name: 'max_id',
|
1085
|
+
required: false,
|
1086
|
+
type: 'string',
|
1087
|
+
},
|
1088
|
+
],
|
1089
|
+
responses: {
|
1090
|
+
'200': {
|
1091
|
+
description: 'Users media entries.',
|
1092
|
+
schema: {
|
1093
|
+
$ref: '#/definitions/MediaListResponse',
|
1094
|
+
},
|
1095
|
+
},
|
1096
|
+
},
|
1097
|
+
security: [
|
1098
|
+
{
|
1099
|
+
api_key: [],
|
1100
|
+
},
|
1101
|
+
{
|
1102
|
+
instagram_auth: ['basic', 'public_content'],
|
1103
|
+
},
|
1104
|
+
],
|
1105
|
+
summary: 'Get the most recent media published by a user.',
|
1106
|
+
tags: ['users'],
|
1107
|
+
},
|
1108
|
+
},
|
1109
|
+
'/internal/operation': {
|
1110
|
+
get: {
|
1111
|
+
description: 'If you see this, something went wrong',
|
1112
|
+
'x-internal': true,
|
1113
|
+
},
|
1114
|
+
},
|
1115
|
+
'/users/{user-id}/relationship': {
|
1116
|
+
get: {
|
1117
|
+
description: 'Get information about a relationship to another user.',
|
1118
|
+
parameters: [
|
1119
|
+
{
|
1120
|
+
description: 'The ID of a user to get information about.',
|
1121
|
+
in: 'path',
|
1122
|
+
name: 'user-id',
|
1123
|
+
required: true,
|
1124
|
+
type: 'string',
|
1125
|
+
},
|
1126
|
+
],
|
1127
|
+
responses: {
|
1128
|
+
'200': {
|
1129
|
+
description: 'Relationship information.',
|
1130
|
+
schema: {
|
1131
|
+
$ref: '#/definitions/RelationshipResponse',
|
1132
|
+
},
|
1133
|
+
},
|
1134
|
+
},
|
1135
|
+
security: [
|
1136
|
+
{
|
1137
|
+
api_key: [],
|
1138
|
+
},
|
1139
|
+
{
|
1140
|
+
instagram_auth: ['follower_list'],
|
1141
|
+
},
|
1142
|
+
],
|
1143
|
+
summary: 'Get information about a relationship to another user.',
|
1144
|
+
tags: ['relationships'],
|
1145
|
+
},
|
1146
|
+
post: {
|
1147
|
+
description: 'Modify the relationship between the current user and the target user.',
|
1148
|
+
parameters: [
|
1149
|
+
{
|
1150
|
+
description: 'The ID of the target user.',
|
1151
|
+
in: 'path',
|
1152
|
+
name: 'user-id',
|
1153
|
+
required: true,
|
1154
|
+
type: 'string',
|
1155
|
+
},
|
1156
|
+
{
|
1157
|
+
description: 'Type of action to apply for relationship with the user.',
|
1158
|
+
enum: ['follow', 'unfollow', 'block', 'unblock', 'approve', 'ignore'],
|
1159
|
+
in: 'query',
|
1160
|
+
name: 'action',
|
1161
|
+
required: true,
|
1162
|
+
type: 'string',
|
1163
|
+
},
|
1164
|
+
],
|
1165
|
+
responses: {
|
1166
|
+
'200': {
|
1167
|
+
description: 'Relationship information.',
|
1168
|
+
schema: {
|
1169
|
+
$ref: '#/definitions/RelationshipPostResponse',
|
1170
|
+
},
|
1171
|
+
},
|
1172
|
+
},
|
1173
|
+
security: [
|
1174
|
+
{
|
1175
|
+
api_key: [],
|
1176
|
+
},
|
1177
|
+
{
|
1178
|
+
instagram_auth: ['relationships'],
|
1179
|
+
},
|
1180
|
+
],
|
1181
|
+
summary: 'Modify the relationship between the current user and the target user.',
|
1182
|
+
tags: ['relationships'],
|
1183
|
+
},
|
1184
|
+
},
|
1185
|
+
},
|
1186
|
+
definitions: {
|
1187
|
+
CaptionData: {
|
1188
|
+
properties: {
|
1189
|
+
created_time: {
|
1190
|
+
description: 'Caption creation UNIX timestamp',
|
1191
|
+
type: 'string',
|
1192
|
+
},
|
1193
|
+
from: {
|
1194
|
+
$ref: '#/definitions/UserShortInfo',
|
1195
|
+
description: 'User who created this caption',
|
1196
|
+
},
|
1197
|
+
id: {
|
1198
|
+
description: 'ID of this caption',
|
1199
|
+
type: 'string',
|
1200
|
+
},
|
1201
|
+
text: {
|
1202
|
+
description: 'Caption text',
|
1203
|
+
type: 'string',
|
1204
|
+
},
|
1205
|
+
},
|
1206
|
+
type: 'object',
|
1207
|
+
},
|
1208
|
+
CommentEntry: {
|
1209
|
+
properties: {
|
1210
|
+
created_time: {
|
1211
|
+
description: 'Comment creation UNIX timestamp',
|
1212
|
+
type: 'string',
|
1213
|
+
},
|
1214
|
+
from: {
|
1215
|
+
$ref: '#/definitions/UserShortInfo',
|
1216
|
+
description: 'User who posted this comment',
|
1217
|
+
},
|
1218
|
+
id: {
|
1219
|
+
description: 'ID of this comment',
|
1220
|
+
type: 'string',
|
1221
|
+
},
|
1222
|
+
text: {
|
1223
|
+
description: 'Text of the comment',
|
1224
|
+
type: 'string',
|
1225
|
+
},
|
1226
|
+
},
|
1227
|
+
type: 'object',
|
1228
|
+
},
|
1229
|
+
CommentsCollection: {
|
1230
|
+
properties: {
|
1231
|
+
count: {
|
1232
|
+
description: 'Nember of comments available, data does not necessary contain all comments',
|
1233
|
+
type: 'integer',
|
1234
|
+
},
|
1235
|
+
data: {
|
1236
|
+
description:
|
1237
|
+
'Collection of comment entries; **warning:** deprecated for Apps [created on or after Nov 17, 2015](http://instagram.com/developer/changelog/)',
|
1238
|
+
items: {
|
1239
|
+
$ref: '#/definitions/CommentEntry',
|
1240
|
+
},
|
1241
|
+
type: 'array',
|
1242
|
+
},
|
1243
|
+
},
|
1244
|
+
type: 'object',
|
1245
|
+
},
|
1246
|
+
CommentsResponse: {
|
1247
|
+
properties: {
|
1248
|
+
data: {
|
1249
|
+
description: 'Collection of comments',
|
1250
|
+
items: {
|
1251
|
+
$ref: '#/definitions/CommentEntry',
|
1252
|
+
},
|
1253
|
+
type: 'array',
|
1254
|
+
},
|
1255
|
+
meta: {
|
1256
|
+
$ref: '#/definitions/MetaData',
|
1257
|
+
description: 'Response meta-data',
|
1258
|
+
},
|
1259
|
+
},
|
1260
|
+
type: 'object',
|
1261
|
+
},
|
1262
|
+
CursorPaginationInfo: {
|
1263
|
+
properties: {
|
1264
|
+
next_cursor: {
|
1265
|
+
description: 'The cursor ID of the next page',
|
1266
|
+
type: 'string',
|
1267
|
+
},
|
1268
|
+
next_url: {
|
1269
|
+
description: 'URL to retrieve next page of entries',
|
1270
|
+
type: 'string',
|
1271
|
+
},
|
1272
|
+
},
|
1273
|
+
type: 'object',
|
1274
|
+
},
|
1275
|
+
IdPaginationInfo: {
|
1276
|
+
properties: {
|
1277
|
+
next_max_id: {
|
1278
|
+
description: 'The max ID of the next page',
|
1279
|
+
type: 'string',
|
1280
|
+
},
|
1281
|
+
next_url: {
|
1282
|
+
description: 'URL to retrieve next page of entries',
|
1283
|
+
type: 'string',
|
1284
|
+
},
|
1285
|
+
},
|
1286
|
+
type: 'object',
|
1287
|
+
},
|
1288
|
+
ImageInfo: {
|
1289
|
+
properties: {
|
1290
|
+
height: {
|
1291
|
+
description: 'Image/video height in pixels',
|
1292
|
+
type: 'integer',
|
1293
|
+
},
|
1294
|
+
url: {
|
1295
|
+
description: 'URL of the image/video resource',
|
1296
|
+
type: 'string',
|
1297
|
+
},
|
1298
|
+
width: {
|
1299
|
+
description: 'Image/video width in pixels',
|
1300
|
+
type: 'integer',
|
1301
|
+
},
|
1302
|
+
},
|
1303
|
+
type: 'object',
|
1304
|
+
},
|
1305
|
+
ImagesData: {
|
1306
|
+
properties: {
|
1307
|
+
low_resolution: {
|
1308
|
+
$ref: '#/definitions/ImageInfo',
|
1309
|
+
description: 'Image in low resolution',
|
1310
|
+
},
|
1311
|
+
standard_resolution: {
|
1312
|
+
$ref: '#/definitions/ImageInfo',
|
1313
|
+
description: 'Image in standard resolution',
|
1314
|
+
},
|
1315
|
+
thumbnail: {
|
1316
|
+
$ref: '#/definitions/ImageInfo',
|
1317
|
+
description: 'Thumbnail of the image',
|
1318
|
+
},
|
1319
|
+
},
|
1320
|
+
type: 'object',
|
1321
|
+
},
|
1322
|
+
LikesCollection: {
|
1323
|
+
properties: {
|
1324
|
+
count: {
|
1325
|
+
description: 'Nember of likes available, data does not necessary contain all comments',
|
1326
|
+
type: 'integer',
|
1327
|
+
},
|
1328
|
+
data: {
|
1329
|
+
description:
|
1330
|
+
'Collection of users who liked; **warning:** deprecated for Apps [created on or after Nov 17, 2015](http://instagram.com/developer/changelog/)',
|
1331
|
+
items: {
|
1332
|
+
$ref: '#/definitions/UserShortInfo',
|
1333
|
+
},
|
1334
|
+
type: 'array',
|
1335
|
+
},
|
1336
|
+
},
|
1337
|
+
type: 'object',
|
1338
|
+
},
|
1339
|
+
LocationInfo: {
|
1340
|
+
properties: {
|
1341
|
+
id: {
|
1342
|
+
description: "ID of this location (in some responses it has a type of 'integer')",
|
1343
|
+
type: 'string',
|
1344
|
+
},
|
1345
|
+
latitude: {
|
1346
|
+
description: 'Location latitude',
|
1347
|
+
format: 'double',
|
1348
|
+
type: 'number',
|
1349
|
+
},
|
1350
|
+
longitude: {
|
1351
|
+
description: 'Location longitude',
|
1352
|
+
format: 'double',
|
1353
|
+
type: 'number',
|
1354
|
+
},
|
1355
|
+
name: {
|
1356
|
+
description: 'Location name',
|
1357
|
+
type: 'string',
|
1358
|
+
},
|
1359
|
+
},
|
1360
|
+
type: 'object',
|
1361
|
+
},
|
1362
|
+
LocationInfoResponse: {
|
1363
|
+
properties: {
|
1364
|
+
data: {
|
1365
|
+
$ref: '#/definitions/LocationInfo',
|
1366
|
+
description: 'Location brief information',
|
1367
|
+
},
|
1368
|
+
meta: {
|
1369
|
+
$ref: '#/definitions/MetaData',
|
1370
|
+
description: 'Response meta-data',
|
1371
|
+
},
|
1372
|
+
},
|
1373
|
+
type: 'object',
|
1374
|
+
},
|
1375
|
+
LocationSearchResponse: {
|
1376
|
+
properties: {
|
1377
|
+
data: {
|
1378
|
+
description: 'List of found locations',
|
1379
|
+
items: {
|
1380
|
+
$ref: '#/definitions/LocationInfo',
|
1381
|
+
},
|
1382
|
+
type: 'array',
|
1383
|
+
},
|
1384
|
+
meta: {
|
1385
|
+
$ref: '#/definitions/MetaData',
|
1386
|
+
description: 'Response meta-data',
|
1387
|
+
},
|
1388
|
+
},
|
1389
|
+
type: 'object',
|
1390
|
+
},
|
1391
|
+
MediaEntry: {
|
1392
|
+
properties: {
|
1393
|
+
attribution: {
|
1394
|
+
description: '??? Unknown ???',
|
1395
|
+
type: 'string',
|
1396
|
+
},
|
1397
|
+
caption: {
|
1398
|
+
$ref: '#/definitions/CaptionData',
|
1399
|
+
description: 'Describes caption of this media',
|
1400
|
+
},
|
1401
|
+
comments: {
|
1402
|
+
$ref: '#/definitions/CommentsCollection',
|
1403
|
+
description: 'Comments of this media entry',
|
1404
|
+
},
|
1405
|
+
created_time: {
|
1406
|
+
description: 'Media creation UNIX timestamp',
|
1407
|
+
type: 'string',
|
1408
|
+
},
|
1409
|
+
filter: {
|
1410
|
+
description: 'Filter of this media entry',
|
1411
|
+
type: 'string',
|
1412
|
+
},
|
1413
|
+
id: {
|
1414
|
+
description: 'ID of a media entry',
|
1415
|
+
type: 'string',
|
1416
|
+
},
|
1417
|
+
images: {
|
1418
|
+
$ref: '#/definitions/ImagesData',
|
1419
|
+
description: 'Images data in different resolutions',
|
1420
|
+
},
|
1421
|
+
likes: {
|
1422
|
+
$ref: '#/definitions/LikesCollection',
|
1423
|
+
description: 'Likes of this media entry',
|
1424
|
+
},
|
1425
|
+
link: {
|
1426
|
+
description: 'Fixed URL of this media entry',
|
1427
|
+
type: 'string',
|
1428
|
+
},
|
1429
|
+
location: {
|
1430
|
+
$ref: '#/definitions/LocationInfo',
|
1431
|
+
description: 'Location data for this media if available',
|
1432
|
+
},
|
1433
|
+
tags: {
|
1434
|
+
description: 'List of tags assigned to this media',
|
1435
|
+
items: {
|
1436
|
+
type: 'string',
|
1437
|
+
},
|
1438
|
+
type: 'array',
|
1439
|
+
},
|
1440
|
+
type: {
|
1441
|
+
description: 'Type of this media entry',
|
1442
|
+
enum: ['image', 'video'],
|
1443
|
+
type: 'string',
|
1444
|
+
},
|
1445
|
+
user: {
|
1446
|
+
$ref: '#/definitions/UserShortInfo',
|
1447
|
+
description: 'User who posted this media',
|
1448
|
+
},
|
1449
|
+
user_has_liked: {
|
1450
|
+
description: 'Indicates whether authenticated user has liked this media or not',
|
1451
|
+
type: 'boolean',
|
1452
|
+
},
|
1453
|
+
users_in_photo: {
|
1454
|
+
description: 'Users located on this media entry',
|
1455
|
+
items: {
|
1456
|
+
$ref: '#/definitions/UserInPhoto',
|
1457
|
+
},
|
1458
|
+
type: 'array',
|
1459
|
+
},
|
1460
|
+
videos: {
|
1461
|
+
$ref: '#/definitions/VideosData',
|
1462
|
+
description: "Videos data in different resolutions, applied for 'video' type",
|
1463
|
+
},
|
1464
|
+
},
|
1465
|
+
type: 'object',
|
1466
|
+
},
|
1467
|
+
MediaEntryResponse: {
|
1468
|
+
properties: {
|
1469
|
+
data: {
|
1470
|
+
$ref: '#/definitions/MediaEntry',
|
1471
|
+
description: 'Media resource information',
|
1472
|
+
},
|
1473
|
+
meta: {
|
1474
|
+
$ref: '#/definitions/MetaData',
|
1475
|
+
description: 'Response meta-data',
|
1476
|
+
},
|
1477
|
+
},
|
1478
|
+
type: 'object',
|
1479
|
+
},
|
1480
|
+
MediaListResponse: {
|
1481
|
+
properties: {
|
1482
|
+
data: {
|
1483
|
+
description: 'List of media entries',
|
1484
|
+
items: {
|
1485
|
+
$ref: '#/definitions/MediaEntry',
|
1486
|
+
},
|
1487
|
+
type: 'array',
|
1488
|
+
},
|
1489
|
+
meta: {
|
1490
|
+
$ref: '#/definitions/MetaData',
|
1491
|
+
description: 'Response meta-data',
|
1492
|
+
},
|
1493
|
+
pagination: {
|
1494
|
+
$ref: '#/definitions/IdPaginationInfo',
|
1495
|
+
description: 'Information for pagination',
|
1496
|
+
},
|
1497
|
+
},
|
1498
|
+
type: 'object',
|
1499
|
+
},
|
1500
|
+
MediaSearchResponse: {
|
1501
|
+
properties: {
|
1502
|
+
data: {
|
1503
|
+
description: 'Found media entries; some end-points do not return likes informtaion',
|
1504
|
+
items: {
|
1505
|
+
$ref: '#/definitions/MediaEntry',
|
1506
|
+
},
|
1507
|
+
type: 'array',
|
1508
|
+
},
|
1509
|
+
meta: {
|
1510
|
+
$ref: '#/definitions/MetaData',
|
1511
|
+
description: 'Response meta-data',
|
1512
|
+
},
|
1513
|
+
},
|
1514
|
+
type: 'object',
|
1515
|
+
},
|
1516
|
+
MetaData: {
|
1517
|
+
properties: {
|
1518
|
+
code: {
|
1519
|
+
description: 'HTTP result code',
|
1520
|
+
format: 'int32',
|
1521
|
+
type: 'integer',
|
1522
|
+
},
|
1523
|
+
},
|
1524
|
+
type: 'object',
|
1525
|
+
},
|
1526
|
+
Position: {
|
1527
|
+
properties: {
|
1528
|
+
x: {
|
1529
|
+
description: 'X position (horizontal)',
|
1530
|
+
format: 'float',
|
1531
|
+
type: 'number',
|
1532
|
+
},
|
1533
|
+
y: {
|
1534
|
+
description: 'Y position (vertical)',
|
1535
|
+
format: 'float',
|
1536
|
+
type: 'number',
|
1537
|
+
},
|
1538
|
+
},
|
1539
|
+
type: 'object',
|
1540
|
+
},
|
1541
|
+
RelationshipInfo: {
|
1542
|
+
properties: {
|
1543
|
+
incoming_status: {
|
1544
|
+
description: 'Status of incoming relationship',
|
1545
|
+
enum: ['none', 'followed_by', 'requested_by'],
|
1546
|
+
type: 'string',
|
1547
|
+
},
|
1548
|
+
outgoing_status: {
|
1549
|
+
description: 'Status of outgoing relationship',
|
1550
|
+
enum: ['none', 'follows', 'requested'],
|
1551
|
+
type: 'string',
|
1552
|
+
},
|
1553
|
+
target_user_is_private: {
|
1554
|
+
description: 'Indicates whether target user is private or not',
|
1555
|
+
type: 'boolean',
|
1556
|
+
},
|
1557
|
+
},
|
1558
|
+
type: 'object',
|
1559
|
+
},
|
1560
|
+
RelationshipPostResponse: {
|
1561
|
+
properties: {
|
1562
|
+
data: {
|
1563
|
+
$ref: '#/definitions/RelationshipStatus',
|
1564
|
+
description: 'Current relationship status',
|
1565
|
+
},
|
1566
|
+
meta: {
|
1567
|
+
$ref: '#/definitions/MetaData',
|
1568
|
+
description: 'Response meta-data',
|
1569
|
+
},
|
1570
|
+
},
|
1571
|
+
type: 'object',
|
1572
|
+
},
|
1573
|
+
RelationshipResponse: {
|
1574
|
+
properties: {
|
1575
|
+
data: {
|
1576
|
+
$ref: '#/definitions/RelationshipInfo',
|
1577
|
+
description: 'Relationship information',
|
1578
|
+
},
|
1579
|
+
meta: {
|
1580
|
+
$ref: '#/definitions/MetaData',
|
1581
|
+
description: 'Response meta-data',
|
1582
|
+
},
|
1583
|
+
},
|
1584
|
+
type: 'object',
|
1585
|
+
},
|
1586
|
+
RelationshipStatus: {
|
1587
|
+
properties: {
|
1588
|
+
outgoing_status: {
|
1589
|
+
description: 'Status of outgoing relationship',
|
1590
|
+
enum: ['none', 'follows', 'requested'],
|
1591
|
+
type: 'string',
|
1592
|
+
},
|
1593
|
+
},
|
1594
|
+
type: 'object',
|
1595
|
+
},
|
1596
|
+
StatusResponse: {
|
1597
|
+
properties: {
|
1598
|
+
data: {
|
1599
|
+
description: "No data - 'null'",
|
1600
|
+
type: 'string',
|
1601
|
+
},
|
1602
|
+
meta: {
|
1603
|
+
$ref: '#/definitions/MetaData',
|
1604
|
+
description: 'Response meta-data',
|
1605
|
+
},
|
1606
|
+
},
|
1607
|
+
type: 'object',
|
1608
|
+
},
|
1609
|
+
TagInfo: {
|
1610
|
+
properties: {
|
1611
|
+
media_count: {
|
1612
|
+
description: 'Overall number of media entries taged with this name',
|
1613
|
+
format: 'int64',
|
1614
|
+
type: 'integer',
|
1615
|
+
},
|
1616
|
+
name: {
|
1617
|
+
description: 'Tag name',
|
1618
|
+
type: 'string',
|
1619
|
+
},
|
1620
|
+
},
|
1621
|
+
type: 'object',
|
1622
|
+
},
|
1623
|
+
TagInfoResponse: {
|
1624
|
+
properties: {
|
1625
|
+
data: {
|
1626
|
+
$ref: '#/definitions/TagInfo',
|
1627
|
+
description: 'Tag brief information',
|
1628
|
+
},
|
1629
|
+
meta: {
|
1630
|
+
$ref: '#/definitions/MetaData',
|
1631
|
+
description: 'Response meta-data',
|
1632
|
+
},
|
1633
|
+
},
|
1634
|
+
type: 'object',
|
1635
|
+
},
|
1636
|
+
TagMediaListResponse: {
|
1637
|
+
properties: {
|
1638
|
+
data: {
|
1639
|
+
description: 'List of media entries with this tag',
|
1640
|
+
items: {
|
1641
|
+
$ref: '#/definitions/MediaEntry',
|
1642
|
+
},
|
1643
|
+
type: 'array',
|
1644
|
+
},
|
1645
|
+
meta: {
|
1646
|
+
$ref: '#/definitions/MetaData',
|
1647
|
+
description: 'Response meta-data',
|
1648
|
+
},
|
1649
|
+
pagination: {
|
1650
|
+
$ref: '#/definitions/TagPaginationInfo',
|
1651
|
+
description: 'Information for pagination',
|
1652
|
+
},
|
1653
|
+
},
|
1654
|
+
type: 'object',
|
1655
|
+
},
|
1656
|
+
TagPaginationInfo: {
|
1657
|
+
properties: {
|
1658
|
+
deprecation_warning: {
|
1659
|
+
description: 'The deprication warning, if information is available',
|
1660
|
+
type: 'string',
|
1661
|
+
},
|
1662
|
+
min_tag_id: {
|
1663
|
+
description: 'The min ID of a tag for the next page',
|
1664
|
+
type: 'string',
|
1665
|
+
},
|
1666
|
+
next_max_id: {
|
1667
|
+
description: 'Depricated. Use min_tag_id instead',
|
1668
|
+
type: 'string',
|
1669
|
+
},
|
1670
|
+
next_max_tag_id: {
|
1671
|
+
description: 'The max ID of a tag for the next page',
|
1672
|
+
type: 'string',
|
1673
|
+
},
|
1674
|
+
next_min_id: {
|
1675
|
+
description: 'Depricated. Use max_tag_id instead',
|
1676
|
+
type: 'string',
|
1677
|
+
},
|
1678
|
+
next_url: {
|
1679
|
+
description: 'URL to retrieve next page of entries',
|
1680
|
+
type: 'string',
|
1681
|
+
},
|
1682
|
+
},
|
1683
|
+
type: 'object',
|
1684
|
+
},
|
1685
|
+
TagSearchResponse: {
|
1686
|
+
properties: {
|
1687
|
+
data: {
|
1688
|
+
description: 'List of found tags with brief statistics',
|
1689
|
+
items: {
|
1690
|
+
$ref: '#/definitions/TagInfo',
|
1691
|
+
},
|
1692
|
+
type: 'array',
|
1693
|
+
},
|
1694
|
+
meta: {
|
1695
|
+
$ref: '#/definitions/MetaData',
|
1696
|
+
description: 'Response meta-data',
|
1697
|
+
},
|
1698
|
+
},
|
1699
|
+
type: 'object',
|
1700
|
+
},
|
1701
|
+
UserCounts: {
|
1702
|
+
properties: {
|
1703
|
+
followed_by: {
|
1704
|
+
description: 'Number of followers of this user',
|
1705
|
+
format: 'int32',
|
1706
|
+
type: 'integer',
|
1707
|
+
},
|
1708
|
+
follows: {
|
1709
|
+
description: 'Number of users followed by this user',
|
1710
|
+
format: 'int32',
|
1711
|
+
type: 'integer',
|
1712
|
+
},
|
1713
|
+
media: {
|
1714
|
+
description: 'Number of user media',
|
1715
|
+
format: 'int32',
|
1716
|
+
type: 'integer',
|
1717
|
+
},
|
1718
|
+
},
|
1719
|
+
type: 'object',
|
1720
|
+
},
|
1721
|
+
UserInPhoto: {
|
1722
|
+
properties: {
|
1723
|
+
position: {
|
1724
|
+
$ref: '#/definitions/Position',
|
1725
|
+
description: 'Position in photo',
|
1726
|
+
},
|
1727
|
+
user: {
|
1728
|
+
$ref: '#/definitions/UserShortInfo',
|
1729
|
+
description: 'User who is indicated on the photo',
|
1730
|
+
},
|
1731
|
+
},
|
1732
|
+
type: 'object',
|
1733
|
+
},
|
1734
|
+
UserInfo: {
|
1735
|
+
properties: {
|
1736
|
+
bio: {
|
1737
|
+
description: 'User biography',
|
1738
|
+
type: 'string',
|
1739
|
+
},
|
1740
|
+
counts: {
|
1741
|
+
$ref: '#/definitions/UserCounts',
|
1742
|
+
description: 'User statistics (counters)',
|
1743
|
+
},
|
1744
|
+
full_name: {
|
1745
|
+
description: 'User full name',
|
1746
|
+
type: 'string',
|
1747
|
+
},
|
1748
|
+
id: {
|
1749
|
+
description: 'User ID',
|
1750
|
+
type: 'string',
|
1751
|
+
},
|
1752
|
+
profile_picture: {
|
1753
|
+
description: 'URL to user profile picture',
|
1754
|
+
type: 'string',
|
1755
|
+
},
|
1756
|
+
username: {
|
1757
|
+
description: 'User name, nickname',
|
1758
|
+
type: 'string',
|
1759
|
+
},
|
1760
|
+
website: {
|
1761
|
+
description: 'URL to user web-site',
|
1762
|
+
type: 'string',
|
1763
|
+
},
|
1764
|
+
},
|
1765
|
+
type: 'object',
|
1766
|
+
},
|
1767
|
+
UserResponse: {
|
1768
|
+
properties: {
|
1769
|
+
data: {
|
1770
|
+
$ref: '#/definitions/UserInfo',
|
1771
|
+
description: 'User basic information',
|
1772
|
+
},
|
1773
|
+
meta: {
|
1774
|
+
$ref: '#/definitions/MetaData',
|
1775
|
+
description: 'Response meta-data',
|
1776
|
+
},
|
1777
|
+
},
|
1778
|
+
type: 'object',
|
1779
|
+
},
|
1780
|
+
UserShortInfo: {
|
1781
|
+
properties: {
|
1782
|
+
full_name: {
|
1783
|
+
description: 'User full name',
|
1784
|
+
type: 'string',
|
1785
|
+
},
|
1786
|
+
id: {
|
1787
|
+
description: 'User ID',
|
1788
|
+
type: 'string',
|
1789
|
+
},
|
1790
|
+
profile_picture: {
|
1791
|
+
description: 'URL to user profile picture',
|
1792
|
+
type: 'string',
|
1793
|
+
},
|
1794
|
+
username: {
|
1795
|
+
description: 'User name, nickname',
|
1796
|
+
type: 'string',
|
1797
|
+
},
|
1798
|
+
},
|
1799
|
+
type: 'object',
|
1800
|
+
},
|
1801
|
+
UsersInfoResponse: {
|
1802
|
+
properties: {
|
1803
|
+
data: {
|
1804
|
+
description: 'User short information entries',
|
1805
|
+
items: {
|
1806
|
+
$ref: '#/definitions/UserShortInfo',
|
1807
|
+
},
|
1808
|
+
type: 'array',
|
1809
|
+
},
|
1810
|
+
meta: {
|
1811
|
+
$ref: '#/definitions/MetaData',
|
1812
|
+
description: 'Response meta-data',
|
1813
|
+
},
|
1814
|
+
},
|
1815
|
+
type: 'object',
|
1816
|
+
},
|
1817
|
+
UsersPagingResponse: {
|
1818
|
+
properties: {
|
1819
|
+
data: {
|
1820
|
+
description: 'List of user short information entries',
|
1821
|
+
items: {
|
1822
|
+
$ref: '#/definitions/UserShortInfo',
|
1823
|
+
},
|
1824
|
+
type: 'array',
|
1825
|
+
},
|
1826
|
+
meta: {
|
1827
|
+
$ref: '#/definitions/MetaData',
|
1828
|
+
description: 'Response meta-data',
|
1829
|
+
},
|
1830
|
+
pagination: {
|
1831
|
+
$ref: '#/definitions/CursorPaginationInfo',
|
1832
|
+
description: 'Information for pagination',
|
1833
|
+
},
|
1834
|
+
},
|
1835
|
+
type: 'object',
|
1836
|
+
},
|
1837
|
+
VideosData: {
|
1838
|
+
properties: {
|
1839
|
+
low_resolution: {
|
1840
|
+
$ref: '#/definitions/ImageInfo',
|
1841
|
+
description: 'Video in low resolution',
|
1842
|
+
},
|
1843
|
+
standard_resolution: {
|
1844
|
+
$ref: '#/definitions/ImageInfo',
|
1845
|
+
description: 'Video in standard resolution',
|
1846
|
+
},
|
1847
|
+
},
|
1848
|
+
type: 'object',
|
1849
|
+
},
|
1850
|
+
InternalObject: {
|
1851
|
+
description: 'Cool object, but internal.',
|
1852
|
+
type: 'object',
|
1853
|
+
properties: {
|
1854
|
+
a: { type: 'string' },
|
1855
|
+
},
|
1856
|
+
'x-internal': true,
|
1857
|
+
},
|
1858
|
+
},
|
1859
|
+
};
|