-
Notifications
You must be signed in to change notification settings - Fork 3
/
openapi.yaml
2021 lines (1818 loc) · 69.4 KB
/
openapi.yaml
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
openapi: 3.1.0
info:
title: Streaming Availability API
description: Streaming Availability API allows getting streaming availability information of movies and series; and querying the list of available shows on streaming services such as Netflix, Disney+, Apple TV, Max and Hulu across 60 countries!
version: 4.1.0
termsOfService: https://github.com/movieofthenight/streaming-availability-api/blob/main/TERMS.md
servers:
- url: https://streaming-availability.p.rapidapi.com
description: Official API Server
tags:
- name: shows
x-schema: show
externalDocs:
url: https://docs.movieofthenight.com/resource/shows
description: Official Documentation
- name: countries
x-schema: country
externalDocs:
url: https://docs.movieofthenight.com/resource/countries
description: Official Documentation
- name: genres
x-schema: genre
externalDocs:
url: https://docs.movieofthenight.com/resource/genres
description: Official Documentation
- name: changes
x-schema: change
externalDocs:
url: https://docs.movieofthenight.com/resource/changes
description: Official Documentation
components:
securitySchemes:
X-Rapid-API-Key:
description: "Rapid API Key can be retrieved from [Rapid API](https://rapidapi.com/movie-of-the-night-movie-of-the-night-default/api/streaming-availability/pricing)."
type: apiKey
name: X-RapidAPI-Key
in: header
schemas:
addon:
title: addon
type: object
description: Details of an addon.
required:
- id
- name
- homePage
- themeColorCode
- imageSet
properties:
id:
type: string
description: Id of the addon.
name:
type: string
description: Name of the addon.
homePage:
type: string
description: Link to the homepage of the addon.
themeColorCode:
type: string
description: Associated theme color hex code of the addon.
imageSet:
$ref: "#/components/schemas/serviceImageSet"
description: Image set of the addon.
streamingOptionTypes:
title: streamingOptionTypes
type: object
description: Availability of the streaming option types in the service.
required:
- addon
- buy
- rent
- free
- subscription
properties:
addon:
type: boolean
description: Whether there are shows available via an addon/channel subscription.
buy:
type: boolean
description: Whether there are shows available to buy.
rent:
type: boolean
description: Whether there are shows available for rental.
free:
type: boolean
description: Whether there are free shows to watch.
subscription:
type: boolean
description: Whether there are shows available via a paid subscription plan.
serviceImageSet:
title: serviceImageSet
type: object
description: Image set of a service or an addon.
required:
- lightThemeImage
- darkThemeImage
- whiteImage
properties:
lightThemeImage:
type: string
description: Link to the logo suitable for light themed background.
darkThemeImage:
type: string
description: Link to the logo suitable for dark themed background.
whiteImage:
type: string
description: Link to the logo that is all white.
serviceInfo:
title: serviceInfo
type: object
description: Details of the streaming service localized according to the parent country.
required:
- id
- name
- homePage
- themeColorCode
- imageSet
properties:
id:
type: string
description: Id of the service.
name:
type: string
description: Name of the service.
homePage:
type: string
description: Link to the homepage of the service.
themeColorCode:
type: string
description: Associated theme color hex code of the service.
imageSet:
$ref: "#/components/schemas/serviceImageSet"
description: Image set of the service.
service:
title: service
description: Details of a streaming service localized according to the parent country.
allOf:
- $ref: "#/components/schemas/serviceInfo"
- type: object
required:
- streamingOptionTypes
- addons
properties:
streamingOptionTypes:
$ref: "#/components/schemas/streamingOptionTypes"
addons:
type: array
description: Array of the supported addons in the service.
items:
$ref: "#/components/schemas/addon"
streamingOptionsMap:
type: object
description: Map of the streaming options by the country code.
additionalProperties:
type: array
description: Array of the streaming options found in a country.
items:
$ref: "#/components/schemas/streamingOption"
country:
title: country
type: object
examples:
- summary: United States
externalValue: https://www.movieofthenight.com/v4/examples/countries/us
- summary: Canada
externalValue: https://www.movieofthenight.com/v4/examples/countries/ca
- summary: United Kingdom
externalValue: https://www.movieofthenight.com/v4/examples/countries/gb
- summary: Germany
externalValue: https://www.movieofthenight.com/v4/examples/countries/de
- summary: India
externalValue: https://www.movieofthenight.com/v4/examples/countries/in
description: |
Countries are the primary way to get the supported streaming services and addons
(such as list of available Apple TV and Prime Video channels) in a region.
Each country object contains the country code, name and the list of supported streaming services.
Details of the streaming services include localized
logos, homepages, theme colors, and available streaming options and addons.
required:
- countryCode
- name
- services
properties:
countryCode:
type: string
description: |
[ISO 3166-1 alpha-2 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the country.
name:
type: string
description: Name of the country.
services:
type: array
description: Array of the supported services in the country, ordered by popularity.
items:
$ref: "#/components/schemas/service"
show:
title: show
description: |
A show object represents a movie or a series. Type of the show is determined by the showType property,
which is either movie or series. Based on this type, some properties are omitted,
for example a movie does not have seasonCount and episodeCount properties.
Show object contains the details such as the title, overview, genres, cast, rating and images.
You can find the streaming availability information under streamingOptions property.
Each streaming option contains the service info, deep link, video quality, available audios and subtitles
and more. It also includes the price if the show is available to buy or rent;
and addon info if the show is available via an addon (such as Apple TV Channels, Prime Video Channels etc.).
You can also find the seasons of the series under the seasons property,
and the episodes of a season under the episodes property of the season object.
Via the streamingOptions property of seasons and episodes,
you can get the individual streaming options of them.
These streaming options include the same set of properties as the show streaming options,
so you can use them to get deep links to episodes and seasons, and to see available audios and subtitles.
Note that seasons and episodes are not included in the search results
unless you set the series_granularity parameter to seasons or episodes.
For more info, check out the series_granularity parameter of the search endpoints.
There are multiple ways to retrieve shows.
You can retrieve a show by its IMDb or TMDB id via [/shows/{id}](#get-a-show) endpoint;
you can search shows by their title via [/shows/search/title](#search-shows-by-title) endpoint;
and you can search shows by filters such as genres, release year, rating etc.
via [/shows/search/filters](#search-shows-by-filters) endpoint. This endpoint also supports pagination
and offers advanced ordering options such as ordering by popularity, rating, release year etc.
type: object
examples:
- summary: The Godfather
externalValue: https://www.movieofthenight.com/v4/examples/shows/god-father
- summary: The Dark Knight
externalValue: https://www.movieofthenight.com/v4/examples/shows/the-dark-knight
- summary: The Queen's Gambit
externalValue: https://www.movieofthenight.com/v4/examples/shows/the-queens-gambit
- summary: Chernobyl
externalValue: https://www.movieofthenight.com/v4/examples/shows/chernobyl
properties:
itemType:
type: string
description: Type of the item. Always show.
const: show
showType:
$ref: "#/components/schemas/showType"
description: Type of the show. Based on the type, some properties might be omitted.
id:
description: Id of the show.
type: string
imdbId:
description: "[IMDb](https://www.imdb.com/) id of the show."
type: string
tmdbId:
description: "[TMDB](https://www.themoviedb.org/) id of the show."
type: string
title:
description: Title of the show.
type: string
overview:
description: A brief overview of the overall plot of the show.
type: string
releaseYear:
description: The year that the movie was released.
type: integer
firstAirYear:
description: The first year that the series aired.
type: integer
lastAirYear:
description: The last year that the series aired.
type: integer
originalTitle:
description: Original title of the show.
type: string
genres:
description: Array of the genres of the show.
type: array
items:
$ref: "#/components/schemas/genre"
directors:
description: Array of the directors of the movie.
type: array
items:
type: string
creators:
description: Array of the creators of the series.
type: array
items:
type: string
cast:
description: Array of the cast of the show.
type: array
items:
type: string
rating:
description: Rating of the show. This is calculated by taking the average of ratings found online from multiple sources.
type: integer
minimum: 0
maximum: 100
seasonCount:
type: integer
description: Number of seasons that are either aired or announced for a series.
episodeCount:
type: integer
description: Number of episodes that are either aired or announced for a series.
runtime:
type: integer
description: Runtime of the movie in minutes.
imageSet:
$ref: "#/components/schemas/showImageSet"
description: Image set of the show.
streamingOptions:
$ref: "#/components/schemas/streamingOptionsMap"
seasons:
description: Array of the seasons belong to the series.
type: array
items:
$ref: "#/components/schemas/season"
required:
- itemType
- showType
- title
- streamingOptions
- id
- imdbId
- tmdbId
- originalTitle
- genres
- cast
- overview
- rating
- imageSet
showImageSet:
title: showImageSet
type: object
description: Image set of a show.
required:
- verticalPoster
- horizontalPoster
properties:
verticalPoster:
$ref: "#/components/schemas/verticalImage"
description: Vertical poster of the show.
horizontalPoster:
$ref: "#/components/schemas/horizontalImage"
description: Horizontal poster of the show.
verticalBackdrop:
$ref: "#/components/schemas/verticalImage"
description: Vertical backdrop of the show.
horizontalBackdrop:
$ref: "#/components/schemas/horizontalImage"
description: Horizontal backdrop of the show.
horizontalImage:
title: horizontalImage
type: object
description: Horizontal image of a show.
required:
- w360
- w480
- w720
- w1080
- w1440
properties:
w360:
type: string
description: Link to the 360px wide version of the image.
w480:
type: string
description: Link to the 480px wide version of the image.
w720:
type: string
description: Link to the 720px wide version of the image.
w1080:
type: string
description: Link to the 1080px wide version of the image.
w1440:
type: string
description: Link to the 1440px wide version of the image.
verticalImage:
title: verticalImage
type: object
description: Horizontal image of a show.
required:
- w240
- w360
- w480
- w600
- w720
properties:
w240:
type: string
description: Link to the 240px wide version of the image.
w360:
type: string
description: Link to the 360px wide version of the image.
w480:
type: string
description: Link to the 480px wide version of the image.
w600:
type: string
description: Link to the 600px wide version of the image.
w720:
type: string
description: Link to the 720px wide version of the image.
season:
title: season
type: object
description: Details of a season.
properties:
itemType:
type: string
description: Type of the item. Always season.
const: season
title:
description: Title of the season.
type: string
firstAirYear:
description: The first year that the season aired.
type: integer
lastAirYear:
description: The last year that the season aired.
type: integer
streamingOptions:
$ref: "#/components/schemas/streamingOptionsMap"
episodes:
type: array
description: Array of the episodes belong to the season.
items:
$ref: "#/components/schemas/episode"
required:
- itemType
- title
- firstAirYear
- lastAirYear
- streamingOptions
episode:
title: episode
type: object
description: Details of an episode.
properties:
itemType:
type: string
description: Type of the item. Always episode.
const: episode
title:
description: Title of the episode.
type: string
overview:
description: A brief overview of the plot of the episode.
type: string
airYear:
description: The year that the episode aired.
type: integer
streamingOptions:
$ref: "#/components/schemas/streamingOptionsMap"
required:
- itemType
- title
- streamingOptions
- airYear
streamingOptionType:
description: Type of the streaming option.
type: string
x-enumDescriptions:
free: Free to watch.
subscription: Available with a subscription.
buy: Available to buy.
rent: Available for rental.
addon: Available via an addon.
enum:
- free
- subscription
- buy
- rent
- addon
streamingOption:
title: streamingOption
type: object
description: A streaming option.
properties:
service:
$ref: "#/components/schemas/serviceInfo"
type:
$ref: "#/components/schemas/streamingOptionType"
addon:
$ref: "#/components/schemas/addon"
description: |
Addon that the streaming option is available through.
Omitted if the streaming option is not available through an addon.
link:
type: string
description: |
Deep link to the streaming option's page in the web app of the streaming service.
Unlike videoLink, this field is guaranteed to be populated.
videoLink:
type: string
description: |
Deep link to the video associated with the streaming option.
Omitted if there's no direct link to the video.
Might have the same value as link.
quality:
description: Maximum supported video quality of the streaming option.
type: string
x-enumDescriptions:
sd: Standard Definition
hd: High Definition
qhd: Quad High Definition
uhd: Ultra High Definition
enum:
- sd
- hd
- qhd
- uhd
audios:
type: array
description: Array of the available audios.
items:
$ref: "#/components/schemas/locale"
subtitles:
type: array
description: Array of the available subtitles.
items:
$ref: "#/components/schemas/subtitle"
price:
$ref: "#/components/schemas/price"
expiresSoon:
description: Whether the streaming option expires within a month.
type: boolean
expiresOn:
description: |
[Unix Time Stamp](https://www.unixtimestamp.com/) of the date that the streaming option is expiring.
In other words, last day to watch.
type: integer
format: int64
availableSince:
type: integer
format: int64
description: |
[Unix Time Stamp](https://www.unixtimestamp.com/) of the date that this streaming option was detected.
required:
- service
- audios
- subtitles
- type
- link
- availableSince
- expiresSoon
price:
title: price
description: |
Price of the renting or buying the item.
A movie and an episode that is available to buy or rent will always have a price.
A series or a season that is available to buy or rent may have a price or not.
If the price is available, that means the entire series or the season can be bought or rented as a whole
for the given price.
If the price is null, that means sub-items of the series or the season are available to buy or rent,
but it is not possible to buy or rent the entire series or the season as a whole at once.
In this case, the price of the sub-items can be found in the episodes or seasons array.
type: object
properties:
amount:
description: Numerical amount of the price.
type: string
currency:
description: "[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) alphabetic code of the currency."
type: string
formatted:
description: Formatted price, including both the amount and the currency.
type: string
required:
- amount
- currency
- formatted
subtitle:
title: subtitle
type: object
properties:
closedCaptions:
description: Whether closed captions are available for the subtitle.
type: boolean
locale:
$ref: "#/components/schemas/locale"
required:
- closedCaptions
- locale
locale:
title: locale
type: object
description: A language and optionally an associated region.
properties:
language:
description: "[ISO 639-2](https://en.wikipedia.org/wiki/ISO_639-2) code of the associated language with the locale."
type: string
region:
description: |
[ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) code of the country,
or [UN M49](https://en.wikipedia.org/wiki/UN_M49) code of the area associated with the locale.
type: string
required:
- language
genre:
title: genre
type: object
examples:
- summary: Action
externalValue: https://www.movieofthenight.com/v4/examples/genres/action
- summary: Science Fiction
externalValue: https://www.movieofthenight.com/v4/examples/genres/scifi
description: |
Genres are used to categorize shows.
Each genre object contains the id and name of the genre.
When fetching genres via [/genres](#get-all-genres) endpoint, you can pass the output_language parameter
to get the genre names in one of the supported languages.
You can use genre ids to filter shows in the search endpoints.
properties:
id:
$ref: "#/components/schemas/genreId"
description: Id of the genre
name:
description: Name of the genre
type: string
required:
- id
- name
genreId:
type: string
description: Id of a genre.
enums:
- action
- adventure
- animation
- comedy
- crime
- documentary
- drama
- family
- fantasy
- history
- horror
- music
- mystery
- news
- reality
- romance
- scifi
- talk
- thriller
- war
- western
change:
title: change
type: object
examples:
- summary: New Movie
externalValue: https://www.movieofthenight.com/v4/examples/changes/movie/new
- summary: Updated Episode
externalValue: https://www.movieofthenight.com/v4/examples/changes/episode/updated
- summary: Expiring Season
externalValue: https://www.movieofthenight.com/v4/examples/changes/season/expiring
- summary: Upcoming Series
externalValue: https://www.movieofthenight.com/v4/examples/changes/series/upcoming
description: |
A change object represents a future or past change in a streaming catalog.
It contains the details such as the type of the change
(could be past change such as like new, updated, removed;
or a future change such as expiring, upcoming),
the affected item type (show, season or episode), timestamp of the change and more.
Via change endpoints, you can get the most recent updates in the streaming catalogs.
On top of the changes, you can also get the details of the affected shows. Every change object
has a showId field.
You can find the list of shows affected by the changes in the shows field of the response, and match
the show ids with the showId field of the change objects.
properties:
changeType:
$ref: "#/components/schemas/changeType"
description: Type of the change.
itemType:
$ref: "#/components/schemas/itemType"
description: Type of the item affected from the change.
showId:
type: string
description: Id of the show affected from the change.
showType:
$ref: "#/components/schemas/showType"
description: Type of the show affected from the change.
season:
type: integer
description: Number of the season affected from the change. Omitted if item_type is not seasonor episode.
episode:
type: integer
description: Number of the episode affected from the change. Omitted if item_type is not episode.
service:
$ref: "#/components/schemas/serviceInfo"
description: Service affected from the change.
streamingOptionType:
$ref: "#/components/schemas/streamingOptionType"
addon:
$ref: "#/components/schemas/addon"
description: Addon info, if the streamingOptionType is addon. Otherwise omitted.
timestamp:
format: int64
type: integer
description: |
[Unix Time Stamp](https://www.unixtimestamp.com/) of the change.
Past changes (new, updated, removed) will always have a timestamp.
Future changes (expiring, upcoming) will have a timestamp if the exact date is known.
If not, timestamp will be omitted, e.g. a show is known to be expiring soon, but the exact date is not known.
link:
type: string
description: |
Deep link to the affected streaming option's page in the web app of the streaming service.
This field is guaranteed to be populated when changeType is new, updated, expiring or removed.
When changeType is upcoming, this field might be populated or null depending on if the link of the future streaming option is known.
required:
- showId
- changeType
- itemType
- showType
- service
- streamingOptionType
itemType:
type: string
description: Type of an item.
x-enumDescriptions:
show: Show, either a movie or a series
season: Season
episode: Episode
enum:
- show
- season
- episode
showType:
type: string
description: Type of a show.
x-enumDescriptions:
movie: A show that is intended to be watched in a single sitting.
series: A show that has seasons and episodes.
enum:
- movie
- series
changeType:
type: string
description: Type of the change.
x-enumDescriptions:
new: Added recently to the catalog.
removed: Removed recently from the catalog.
updated: |
Recently updated.
This includes recent additions and removals, plus the streaming options with updated links, subtitles or video qualities etc.
expiring: Expiring from the catalog soon.
upcoming: Will be added to the catalog soon.
enum:
- new
- removed
- updated
- expiring
- upcoming
error:
title: error
type: object
required:
- message
properties:
message:
type: string
searchResult:
type: object
properties:
shows:
description: Array of shows.
type: array
items:
$ref: "#/components/schemas/show"
hasMore:
description: Whether there are more shows available.
type: boolean
nextCursor:
description: Cursor value to pass to get the next set of shows.
type: string
required:
- shows
- hasMore
changesResult:
type: object
properties:
changes:
description: Array of the changes.
type: array
items:
$ref: "#/components/schemas/change"
shows:
$ref: "#/components/schemas/showMap"
description: Map of the shows affected by the changes.
hasMore:
description: Whether there are more changes available.
type: boolean
nextCursor:
description: Cursor value to pass to get the next set of changes.
type: string
required:
- changes
- shows
- hasMore
showMap:
type: object
description: Map of the shows by their ids.
additionalProperties:
$ref: "#/components/schemas/show"
countryMap:
type: object
description: Map of supported countries by their [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) codes
additionalProperties:
$ref: "#/components/schemas/country"
orderDirection:
type: string
x-enumDescriptions:
asc: Use ascending order.
desc: Use descending order.
enum:
- asc
- desc
responses:
countriesResponse:
description: Details of the supported countries.
content:
application/json:
schema:
$ref: "#/components/schemas/countryMap"
examples:
Countries:
summary: Countries
externalValue: https://www.movieofthenight.com/v4/examples/countries
countryResponse:
description: Details of a country.
content:
application/json:
schema:
$ref: "#/components/schemas/country"
examples:
United States:
summary: United States
externalValue: https://www.movieofthenight.com/v4/examples/countries/us
x-parameters:
country-code: us
Canada:
summary: Canada
externalValue: https://www.movieofthenight.com/v4/examples/countries/ca
x-parameters:
country-code: ca
United Kingdom:
summary: United Kingdom
externalValue: https://www.movieofthenight.com/v4/examples/countries/gb
x-parameters:
country-code: gb
Germany:
summary: Germany
externalValue: https://www.movieofthenight.com/v4/examples/countries/de
x-parameters:
country-code: de
India:
summary: India
externalValue: https://www.movieofthenight.com/v4/examples/countries/in
x-parameters:
country-code: in
genresResponse:
description: Details of the supported genres.
content:
application/json:
schema:
description: Array of the supported genres.
type: array
items:
$ref: "#/components/schemas/genre"
examples:
Genres in English:
summary: Genres in English
externalValue: https://www.movieofthenight.com/v4/examples/genres/en
x-parameters:
output_language: en
Genres in French:
summary: Genres in French
externalValue: https://www.movieofthenight.com/v4/examples/genres/fr
x-parameters:
output_language: fr
errorResponse:
description: An error occurred.
content:
application/json:
schema:
$ref: "#/components/schemas/error"
examples:
Error:
x-statusCode: 400
summary: Error
value:
message: An error occurred.
notFoundResponse:
description: The show is not found.
content:
application/json:
schema:
$ref: "#/components/schemas/error"
examples:
Not Found:
x-statusCode: 404
summary: Not Found
value:
message: Not Found
showResponse:
description: Details of the show.
content:
application/json:
schema:
$ref: "#/components/schemas/show"
examples:
The Godfather via IMDb Id: