-
Notifications
You must be signed in to change notification settings - Fork 0
/
assets.swgg.swagger.json
479 lines (479 loc) · 21.1 KB
/
assets.swgg.swagger.json
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
{
"basePath": "/",
"externalDocs": {
"description": "find out more about itunes-search's web-apis",
"url": "https://developer.apple.com/library/content/documentation/AudioVideo/Conceptual/iTuneSearchAPI/Searching.html"
},
"info": {
"description": "this zero-dependency package will provide a swagger-client for itunes-search's web-apis, with a working web-demo",
"title": "swgg-itunes-search",
"version": "2018.1.15",
"x-swgg-downloadStandaloneApp": "https://kaizhu256.github.io/node-swgg-itunes-search/build..beta..travis-ci.org/app/assets.app.js",
"x-swgg-homepage": "https://github.com/kaizhu256/node-swgg-itunes-search"
},
"parameters": {
"itunes-search.callback": {
"default": "wsSearchCB",
"description": "The name of the Javascript callback function you want to use when returning search results to your website.",
"in": "query",
"name": "callback",
"type": "string"
},
"itunes-search.entity": {
"description": "The type of results you want returned, relative to the specified media type. For example: movieArtist for a movie media type search. The default is the track entity associated with the specified media type.\n\nhttps://developer.apple.com/library/content/documentation/AudioVideo/Conceptual/iTuneSearchAPI/Searching.html#//apple_ref/doc/uid/TP40017632-CH5-SW2",
"enum": [
"album",
"all",
"allArtist",
"allTrack",
"audiobook",
"audiobookAuthor",
"ebook",
"iPadSoftware",
"macSoftware",
"mix",
"movie",
"movieArtist",
"music",
"musicArtist",
"musicTrack",
"musicVideo",
"podcast",
"podcastAuthor",
"shortFilm",
"shortFilmArtist",
"software",
"song",
"tvEpisode",
"tvSeason",
"tvShow"
],
"in": "query",
"name": "entity",
"type": "string"
},
"itunes-search.limit": {
"description": "entity limit per id/isbn/upc/amgAlbumId/amgArtistId/amgVideoId",
"in": "query",
"name": "limit",
"type": "integer"
},
"itunes-search.sort": {
"description": "sort parameter",
"enum": [
"recent"
],
"in": "query",
"name": "sort",
"type": "string"
}
},
"paths": {
"/lookup#amgAlbumId.required": {
"get": {
"description": "Lookup API.\n\nYou can also create a lookup request to search for content in the stores based on iTunes IDs, UPCs/ EANs, and All Music Guide (AMG) IDs. ID-based lookups are faster and contain fewer false-positive results.\n\nhttps://developer.apple.com/library/content/documentation/AudioVideo/Conceptual/iTuneSearchAPI/LookupExamples.html",
"operationId": "_2Flookup_23amgAlbumId.required_20GET",
"parameters": [
{
"default": [
"15175",
"15176",
"15177",
"15178",
"15183",
"15184",
"15187",
"1519",
"15191",
"15195",
"15197",
"15198"
],
"description": "AMG Album ID",
"in": "query",
"items": {
"type": "string"
},
"name": "amgAlbumId",
"required": true,
"type": "array"
},
{
"$ref": "#/parameters/itunes-search.entity"
},
{
"$ref": "#/parameters/itunes-search.callback"
},
{
"$ref": "#/parameters/itunes-search.limit"
},
{
"$ref": "#/parameters/itunes-search.sort"
}
],
"responses": {
"default": {
"description": "default response"
}
},
"tags": [
"itunes-search"
],
"x-swgg-host": "itunes.apple.com",
"x-swgg-tags0": "itunes-search"
}
},
"/lookup#amgArtistId.required": {
"get": {
"description": "Lookup API.\n\nYou can also create a lookup request to search for content in the stores based on iTunes IDs, UPCs/ EANs, and All Music Guide (AMG) IDs. ID-based lookups are faster and contain fewer false-positive results.\n\nhttps://developer.apple.com/library/content/documentation/AudioVideo/Conceptual/iTuneSearchAPI/LookupExamples.html",
"operationId": "_2Flookup_23amgArtistId.required_20GET",
"parameters": [
{
"default": [
"468749",
"5723"
],
"description": "AMG artist ID",
"in": "query",
"items": {
"type": "string"
},
"name": "amgArtistId",
"required": true,
"type": "array"
},
{
"$ref": "#/parameters/itunes-search.entity"
},
{
"$ref": "#/parameters/itunes-search.callback"
},
{
"$ref": "#/parameters/itunes-search.limit"
},
{
"$ref": "#/parameters/itunes-search.sort"
}
],
"responses": {
"default": {
"description": "default response"
}
},
"tags": [
"itunes-search"
],
"x-swgg-host": "itunes.apple.com",
"x-swgg-tags0": "itunes-search"
}
},
"/lookup#amgVideoId.required": {
"get": {
"description": "Lookup API.\n\nYou can also create a lookup request to search for content in the stores based on iTunes IDs, UPCs/ EANs, and All Music Guide (AMG) IDs. ID-based lookups are faster and contain fewer false-positive results.\n\nhttps://developer.apple.com/library/content/documentation/AudioVideo/Conceptual/iTuneSearchAPI/LookupExamples.html",
"operationId": "_2Flookup_23amgVideoId.required_20GET",
"parameters": [
{
"default": [
"17120"
],
"description": "AMG Video ID",
"in": "query",
"items": {
"type": "string"
},
"name": "amgVideoId",
"required": true,
"type": "array"
},
{
"$ref": "#/parameters/itunes-search.entity"
},
{
"$ref": "#/parameters/itunes-search.callback"
},
{
"$ref": "#/parameters/itunes-search.limit"
},
{
"$ref": "#/parameters/itunes-search.sort"
}
],
"responses": {
"default": {
"description": "default response"
}
},
"tags": [
"itunes-search"
],
"x-swgg-host": "itunes.apple.com",
"x-swgg-tags0": "itunes-search"
}
},
"/lookup#id.required": {
"get": {
"description": "Lookup API.\n\nYou can also create a lookup request to search for content in the stores based on iTunes IDs, UPCs/ EANs, and All Music Guide (AMG) IDs. ID-based lookups are faster and contain fewer false-positive results.\n\nhttps://developer.apple.com/library/content/documentation/AudioVideo/Conceptual/iTuneSearchAPI/LookupExamples.html",
"operationId": "_2Flookup_23id.required_20GET",
"parameters": [
{
"default": [
"909253",
"284910350"
],
"description": "iTunes ID",
"in": "query",
"items": {
"type": "string"
},
"name": "id",
"required": true,
"type": "array"
},
{
"$ref": "#/parameters/itunes-search.entity"
},
{
"$ref": "#/parameters/itunes-search.callback"
},
{
"$ref": "#/parameters/itunes-search.limit"
},
{
"$ref": "#/parameters/itunes-search.sort"
}
],
"responses": {
"default": {
"description": "default response"
}
},
"tags": [
"itunes-search"
],
"x-swgg-host": "itunes.apple.com",
"x-swgg-tags0": "itunes-search"
}
},
"/lookup#isbn.required": {
"get": {
"description": "Lookup API.\n\nYou can also create a lookup request to search for content in the stores based on iTunes IDs, UPCs/ EANs, and All Music Guide (AMG) IDs. ID-based lookups are faster and contain fewer false-positive results.\n\nhttps://developer.apple.com/library/content/documentation/AudioVideo/Conceptual/iTuneSearchAPI/LookupExamples.html",
"operationId": "_2Flookup_23isbn.required_20GET",
"parameters": [
{
"default": [
"9780316069359"
],
"description": "13 digit ISBN",
"in": "query",
"items": {
"type": "string"
},
"name": "isbn",
"required": true,
"type": "array"
},
{
"$ref": "#/parameters/itunes-search.entity"
},
{
"$ref": "#/parameters/itunes-search.callback"
},
{
"$ref": "#/parameters/itunes-search.limit"
},
{
"$ref": "#/parameters/itunes-search.sort"
}
],
"responses": {
"default": {
"description": "default response"
}
},
"tags": [
"itunes-search"
],
"x-swgg-host": "itunes.apple.com",
"x-swgg-tags0": "itunes-search"
}
},
"/lookup#upc.required": {
"get": {
"description": "Lookup API.\n\nYou can also create a lookup request to search for content in the stores based on iTunes IDs, UPCs/ EANs, and All Music Guide (AMG) IDs. ID-based lookups are faster and contain fewer false-positive results.\n\nhttps://developer.apple.com/library/content/documentation/AudioVideo/Conceptual/iTuneSearchAPI/LookupExamples.html",
"operationId": "_2Flookup_23upc.required_20GET",
"parameters": [
{
"default": [
"720642462928"
],
"description": "UPC/EAN barcode",
"in": "query",
"items": {
"type": "string"
},
"name": "upc",
"required": true,
"type": "array"
},
{
"$ref": "#/parameters/itunes-search.entity"
},
{
"$ref": "#/parameters/itunes-search.callback"
},
{
"$ref": "#/parameters/itunes-search.limit"
},
{
"$ref": "#/parameters/itunes-search.sort"
}
],
"responses": {
"default": {
"description": "default response"
}
},
"tags": [
"itunes-search"
],
"x-swgg-host": "itunes.apple.com",
"x-swgg-tags0": "itunes-search"
}
},
"/search": {
"get": {
"description": "Search API.\n\nTo search for content from a field in your website and display the results in your website, you must create a search field that passes a fully-qualified URL content request to the iTunes Store, parse the JavaScript Object Notation (JSON) format returned from the search, and display the results in your website.\n\nThe fully-qualified URL must have the following format: https://itunes.apple.com/search?parameterkeyvalue. Where parameterkeyvalue can be one or more parameter key and value pairs indicating the details of your query.\n\nTo construct a parameter key and value pair, you must concatenate each parameter key with an equal sign (=) and a value string. For example: key1=value1. To create a string of parameter key and value pairs, you must concatenate each pair using an ampersand (&). For example: key1=value1&key2=value2&key3=value3.\n\nhttps://developer.apple.com/library/content/documentation/AudioVideo/Conceptual/iTuneSearchAPI/Searching.html",
"operationId": "_2Fsearch_20GET",
"parameters": [
{
"default": "jack+johnson",
"description": "The URL-encoded text string you want to search for. For example: jack+johnson.",
"in": "query",
"name": "term",
"required": true,
"type": "string"
},
{
"default": "US",
"description": "The two-letter country code for the store you want to search. The search uses the default store front for the specified country. For example: US. The default is US.\n\nhttps://en.wikipedia.org/wiki/ISO_3166-1_alpha-2",
"in": "query",
"name": "country",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/itunes-search.entity"
},
{
"description": "The attribute you want to search for in the stores, relative to the specified media type. For example, if you want to search for an artist by name specify entity=allArtist&attribute=allArtistTerm. In this example, if you search for term=maroon, iTunes returns “Maroon 5” in the search results, instead of all artists who have ever recorded a song with the word “maroon” in the title. The default is all attributes associated with the specified media type.\n\nhttps://developer.apple.com/library/content/documentation/AudioVideo/Conceptual/iTuneSearchAPI/Searching.html#//apple_ref/doc/uid/TP40017632-CH5-SW3",
"enum": [
"actorTerm",
"albumTerm",
"all",
"allArtistTerm",
"allTrackTerm",
"artistTerm",
"audiobook",
"authorTerm",
"composerTerm",
"descriptionTerm",
"directorTerm",
"featureFilmTerm",
"genreIndex",
"keywordsTerm",
"languageTerm",
"mixTerm",
"movie",
"movieArtistTerm",
"movieTerm",
"music",
"musicVideo",
"podcast",
"producerTerm",
"ratingIndex",
"ratingTerm",
"releaseYearTerm",
"shortFilm",
"shortFilmTerm",
"showTerm",
"software",
"softwareDeveloper",
"songTerm",
"titleTerm",
"tvEpisodeTerm",
"tvSeasonTerm",
"tvShow"
],
"in": "query",
"name": "attribute",
"type": "string"
},
{
"$ref": "#/parameters/itunes-search.callback"
},
{
"description": "The number of search results you want the iTunes Store to return. For example: 25. The default is 50.",
"in": "query",
"name": "limit",
"type": "integer"
},
{
"default": "en_us",
"description": "The language, English or Japanese, you want to use when returning search results. Specify the language using the five-letter codename. For example: en_us. The default is en_us (English).",
"enum": [
"en_us",
"ja_jp"
],
"in": "query",
"name": "lang",
"type": "string"
},
{
"default": 2,
"description": "The search result key version you want to receive back from your search. The default is 2.",
"enum": [
1,
2
],
"in": "query",
"name": "version",
"type": "integer"
},
{
"default": "Yes",
"description": "A flag indicating whether or not you want to include explicit content in your search results. The default is Yes.",
"enum": [
"Yes",
"No"
],
"in": "query",
"name": "explicit",
"type": "string"
}
],
"responses": {
"default": {
"description": "default response"
}
},
"tags": [
"itunes-search"
],
"x-swgg-host": "itunes.apple.com",
"x-swgg-tags0": "itunes-search"
}
}
},
"schemes": [
"https"
],
"swagger": "2.0",
"tags": [
{
"description": "iTunes Search API\n\nhttps://developer.apple.com/library/content/documentation/AudioVideo/Conceptual/iTuneSearchAPI/Searching.html",
"name": "itunes-search",
"x-swgg-tags0": "itunes-search"
}
],
"x-swgg-operationIdFromPath": true
}