swagger-spec.json

{"info":{"title":"Edge API","description":"The edge API","version":"1.0"},"tags":[],"servers":[],"openapi":"3.0.3","components":{"schemas":{"Config":{"type":["object"],"properties":{"id":{"type":["string"]},"settings":{"type":["object"],"properties":{"analyticsEnabled":{"type":["boolean"]},"platformSource":{"type":["string"],"format":"uri"}},"required":["analyticsEnabled"]},"image":{"type":["object"],"properties":{"banner":{"type":["string"],"format":"uri"},"poster":{"type":["string"],"format":"uri"},"loading":{"type":["string"],"format":"uri"},"error":{"type":["string"],"format":"uri"},"info":{"type":["string"],"format":"uri"},"default":{"type":["string"],"format":"uri"}},"required":["banner","poster","loading","error","info","default"]},"navigation":{"default":[],"type":["array"],"items":{"type":["object"],"properties":{"criteria":{"type":["string"]},"destination":{"type":["string"]},"i18n":{"type":["string"]},"icon":{"type":["string"]},"group":{"type":["object"],"properties":{"authenticated":{"type":["boolean"]},"i18n":{"type":["string"]}},"required":["authenticated","i18n"]}},"required":["criteria","destination","i18n","icon","group"]}},"genres":{"default":[],"type":["array"],"items":{"type":["object"],"properties":{"name":{"type":["string"]},"mediaId":{"type":["number"],"minimum":1}},"required":["name","mediaId"]}}},"required":["id","settings","image"],"title":"Config","description":"Client configuration"},"undefined":{"type":["object"],"properties":{"malId":{"type":["integer"],"exclusiveMinimum":0},"name":{"type":["string"],"minLength":1}}},"News":{"type":["object"],"properties":{"id":{"type":["string"]},"title":{"type":["string"]},"link":{"type":["string"],"format":"uri"},"description":{"type":["string"]},"content":{"type":["string"]},"category":{"type":["string","null"]},"genre":{"type":["string","null"]},"area":{"type":["string","null"]},"lang":{"type":["string","null"]},"publishedOn":{"type":["number"]},"image":{"type":["string","null"],"format":"uri"}},"required":["id","title","link","description","content","publishedOn"],"title":"News","description":"Schema representing a news document."},"NewsPaging":{"type":["object"],"properties":{"first":{"type":["string"]},"last":{"type":["string"]},"count":{"type":["number"],"minimum":0},"data":{"type":["array"],"items":{"type":["object"],"properties":{"id":{"type":["string"]},"title":{"type":["string"]},"link":{"type":["string"],"format":"uri"},"description":{"type":["string"]},"content":{"type":["string"]},"category":{"type":["string","null"]},"genre":{"type":["string","null"]},"area":{"type":["string","null"]},"lang":{"type":["string","null"]},"publishedOn":{"type":["number"]},"image":{"type":["string","null"],"format":"uri"}},"required":["id","title","link","description","content","publishedOn"]}}},"required":["count","data"],"title":"NewsPaging","description":"Paged response for news documents."},"Episodes":{"type":["object"],"properties":{"data":{"type":["array"],"items":{"type":["object"],"properties":{"id":{"type":["number"]},"number":{"type":["number","null"]},"title":{"type":["object","null"],"properties":{"english":{"type":["string","null"]},"romanji":{"type":["string","null"]},"native":{"type":["string","null"]}}},"synopsis":{"type":["string","null"]},"aired":{"type":["number","null"]},"score":{"type":["number","null"]},"kind":{"type":["string","null"],"enum":["main","ova","ona","recap","filler","special"]},"duration":{"type":["number","null"]},"url":{"type":["string","null"]},"tvdbShowId":{"type":["number","null"]},"tvdbId":{"type":["number","null"]},"tmdbId":{"type":["number","null"]},"seasonNumber":{"type":["number","null"]},"episodeNumber":{"type":["number","null"]},"absoluteEpisodeNumber":{"type":["number","null"]},"airedBeforeSeasonNumber":{"type":["number","null"]},"airedBeforeEpisodeNumber":{"type":["number","null"]},"airedAfterSeasonNumber":{"type":["number","null"]},"airedAfterEpisodeNumber":{"type":["number","null"]},"image":{"type":["string","null"]},"poster":{"type":["string","null"]},"themes":{"default":{"openings":[],"endings":[]},"type":["object"],"properties":{"openings":{"default":[],"type":["array"],"items":{"type":["string"]}},"endings":{"default":[],"type":["array"],"items":{"type":["string"]}}}}},"required":["id"]}},"first":{"type":["string","null"]},"last":{"type":["string","null"]},"count":{"type":["number"]},"total":{"type":["number"]}},"required":["data","count","total"],"title":"Episodes","description":"Paginated episode listing with cursor navigation"},"Series":{"type":["object"],"properties":{"kind":{"type":["string"],"enum":["ANIME","MANGA"]},"classification":{"type":["null"]},"mediaId":{"type":["object"],"properties":{"anidb":{"type":["number","null"]},"anilist":{"type":["number","null"]},"animePlanet":{"type":["string","null"]},"anisearch":{"type":["number","null"]},"imdb":{"type":["string","null"]},"kitsu":{"type":["number","null"]},"livechart":{"type":["number","null"]},"notify":{"type":["string","null"]},"themoviedb":{"type":["number","null"]},"tvdb":{"type":["number","null"]},"myanimelist":{"type":["number","null"]},"tvMazeId":{"type":["number","null"]},"tvrage":{"type":["string","null"]},"slug":{"type":["string","null"]},"shoboi":{"type":["number","null"]},"trakt":{"type":["number","null"]}}},"cover":{"type":["object"],"properties":{"extraLarge":{"type":["string"]},"large":{"type":["string"]},"medium":{"type":["string"]},"color":{"type":["string"]}}},"banner":{"type":["string","null"]},"fanart":{"type":["string","null"]},"format":{"type":["null"]},"status":{"type":["null"]},"source":{"type":["null"]},"title":{"type":["object"],"properties":{"english":{"type":["string","null"]},"canonical":{"type":["string","null"]},"harigana":{"type":["string","null"]},"japanese":{"type":["string","null"]},"romaji":{"type":["string","null"]},"synonyms":{"type":["array","null"],"items":{"type":["string"]}}}},"ageRating":{"type":["string","null"]},"images":{"type":["array"],"items":{"type":["object"],"properties":{"locale":{"type":["string","null"]},"height":{"type":["number"]},"width":{"type":["number"]},"url":{"type":["string"]},"type":{"type":["string"],"enum":["BACKDROP","POSTER","LOGO"]}},"required":["height","width","url","type"]}},"description":{"type":["string","null"]},"updatedAt":{"type":["number"]},"moreInfo":{"type":["string","null"]},"themeSongs":{"type":["array"],"items":{}},"schedule":{"type":["object","null"],"properties":{"firstAirDate":{"type":["number","null"]},"lastAirDate":{"type":["number","null"]},"lastAiredEpisode":{"type":["object","null"],"properties":{"id":{"type":["number"]},"name":{"type":["string"]},"overview":{"type":["string","null"]},"airDate":{"type":["number","null"]},"episodeNumber":{"type":["number","null"]},"productionCode":{"type":["string","null"]},"runtime":{"type":["number","null"]},"seasonNumber":{"type":["number","null"]},"tmdbId":{"type":["number","null"]},"image":{"type":["string","null"]}},"required":["id","name"]},"nextEpisodeToAir":{"type":["object","null"],"properties":{"id":{"type":["number"]},"name":{"type":["string"]},"overview":{"type":["string","null"]},"airDate":{"type":["number","null"]},"episodeNumber":{"type":["number","null"]},"productionCode":{"type":["string","null"]},"runtime":{"type":["number","null"]},"seasonNumber":{"type":["number","null"]},"tmdbId":{"type":["number","null"]},"image":{"type":["string","null"]}},"required":["id","name"]}}},"trailers":{"type":["array"],"items":{"type":["object"],"properties":{"id":{"type":["string"]},"site":{"type":["string"]},"thumbnail":{"type":["string"]}},"required":["id","site"]}},"networks":{"type":["array"],"items":{"type":["object"],"properties":{"id":{"type":["number"]},"logoPath":{"type":["string","null"]},"isPrimary":{"type":["boolean"]},"name":{"type":["string"]},"originCountry":{"type":["string"]},"category":{"type":["string"],"enum":["DISTRIBUTION","PRODUCTION"]}},"required":["id","isPrimary","name","originCountry","category"]}},"airedEpisodes":{"type":["number","null"]},"broadcast":{"type":["string","null"]},"isAdult":{"type":["boolean","null"]},"homepage":{"type":["string","null"]},"duration":{"type":["number","null"]},"chapters":{"type":["number","null"]},"volumes":{"type":["number","null"]},"publishedFrom":{"type":["number","null"]},"publishedTo":{"type":["number","null"]}},"required":["kind","mediaId","cover","title","images","updatedAt","themeSongs","trailers","networks"],"title":"Series","description":"Aggregated of media entities from multiple sources"},"Studio":{"type":["object"],"properties":{"malId":{"type":["integer"],"exclusiveMinimum":0},"titles":{"default":[],"type":["array"],"items":{"type":["object"],"properties":{"type":{"type":["string","null"]},"title":{"type":["string","null"]}}}},"name":{"type":["string"]},"about":{"type":["string","null"]},"established":{"type":["number","null"]},"imageUrl":{"type":["string","null"]},"favorites":{"default":0,"type":["number"]},"animeCount":{"default":0,"type":["number"]},"fetchedAt":{"type":["number"]},"expiresAt":{"type":["number"]}},"required":["malId","name","fetchedAt","expiresAt"],"title":"Studio","description":"Animation studio metadata resolved from Jikan (MAL)"},"Person":{"type":["object"],"properties":{"malId":{"type":["integer"],"exclusiveMinimum":0},"name":{"type":["string"]},"givenName":{"type":["string","null"]},"familyName":{"type":["string","null"]},"alternateNames":{"default":[],"type":["array"],"items":{"type":["string"]}},"birthday":{"type":["number","null"]},"favorites":{"default":0,"type":["number"]},"about":{"type":["string","null"]},"imageUrl":{"type":["string","null"]},"websiteUrl":{"type":["string","null"]},"fetchedAt":{"type":["number"]},"expiresAt":{"type":["number"]}},"required":["malId","name","fetchedAt","expiresAt"],"title":"Person","description":"Anime staff or voice actor metadata resolved from Jikan (MAL)"},"Character":{"type":["object"],"properties":{"malId":{"type":["integer"],"exclusiveMinimum":0},"name":{"type":["string"]},"nameKanji":{"type":["string","null"]},"nicknames":{"default":[],"type":["array"],"items":{"type":["string"]}},"favorites":{"default":0,"type":["number"]},"about":{"type":["string","null"]},"imageUrl":{"type":["string","null"]},"anime":{"default":[],"type":["array"],"items":{"type":["object"],"properties":{"malId":{"type":["integer"],"exclusiveMinimum":0},"role":{"type":["string","null"]},"title":{"type":["string"]},"url":{"type":["string"]},"imageUrl":{"type":["string","null"]}},"required":["malId","title","url"]}},"manga":{"default":[],"type":["array"],"items":{"type":["object"],"properties":{"malId":{"type":["integer"],"exclusiveMinimum":0},"role":{"type":["string","null"]},"title":{"type":["string"]},"url":{"type":["string"]},"imageUrl":{"type":["string","null"]}},"required":["malId","title","url"]}},"voices":{"default":[],"type":["array"],"items":{"type":["object"],"properties":{"malId":{"type":["integer"],"exclusiveMinimum":0},"name":{"type":["string"]},"language":{"type":["string","null"]},"url":{"type":["string"]},"imageUrl":{"type":["string","null"]}},"required":["malId","name","url"]}},"fetchedAt":{"type":["number"]},"expiresAt":{"type":["number"]}},"required":["malId","name","fetchedAt","expiresAt"],"title":"Character","description":"Fictional character metadata resolved from Jikan (MAL), including media and voice-actor relations"}}},"paths":{"/v1/config":{"get":{"operationId":"config","responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Config"}}}}}}},"/v1/news/feed":{"get":{"operationId":"newsFeed","responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/News"}}}}}},"parameters":[{"name":"locale","in":"query","description":"","schema":{"default":"en-US","type":["string"],"minLength":5,"maxLength":5,"description":"Locale for the news feed, e.g., en-GB, de-DE, fr-FR."}}]}},"/v1/news":{"get":{"operationId":"news","responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewsPaging"}}}}},"parameters":[{"name":"before","in":"query","description":"","schema":{"type":["string"]}},{"name":"after","in":"query","description":"","schema":{"type":["string"]}},{"name":"limit","in":"query","description":"","schema":{"default":15,"type":["number"],"minimum":1}}]}},"/v1/episodes":{"get":{"operationId":"episodes","responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Episodes"}}}}},"parameters":[{"name":"malId","in":"query","description":"","required":true,"schema":{"type":["integer"],"exclusiveMinimum":0}},{"name":"limit","in":"query","description":"","required":false,"schema":{"default":25,"type":["integer"],"minimum":1,"maximum":100}},{"name":"after","in":"query","description":"","required":false,"schema":{"type":["string"]}},{"name":"before","in":"query","description":"","required":false,"schema":{"type":["string"]}},{"name":"kind","in":"query","description":"","required":false,"schema":{"type":["string"],"enum":["main","ova","ona","recap","filler","special"]}},{"name":"specialsOnly","in":"query","description":"","required":false,"schema":{"type":["boolean"]}},{"name":"start","in":"query","description":"","required":false,"schema":{"type":["integer"],"exclusiveMinimum":0}},{"name":"end","in":"query","description":"","required":false,"schema":{"type":["integer"],"exclusiveMinimum":0}},{"name":"includeOrphans","in":"query","description":"","required":false,"schema":{"type":["boolean"]}}]}},"/v1/series":{"get":{"operationId":"series","responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Series"}}}}},"parameters":[{"name":"trakt","in":"query","description":"","schema":{"type":["integer"],"exclusiveMinimum":0}},{"name":"slug","in":"query","description":"","schema":{"type":["string"],"minLength":1}},{"name":"tvdb","in":"query","description":"","schema":{"type":["integer"],"exclusiveMinimum":0}},{"name":"tmdb","in":"query","description":"","schema":{"type":["integer"],"exclusiveMinimum":0}},{"name":"notify","in":"query","description":"","schema":{"type":["string"],"minLength":1}},{"name":"anilist","in":"query","description":"","schema":{"type":["integer"],"exclusiveMinimum":0}},{"name":"mal","in":"query","description":"","schema":{"type":["integer"],"exclusiveMinimum":0}}]}},"/v1/studios":{"get":{"operationId":"studio","responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Studio"}}}}},"parameters":[{"name":"malId","in":"query","description":"","schema":{"type":["integer"],"exclusiveMinimum":0}},{"name":"name","in":"query","description":"","schema":{"type":["string"],"minLength":1}}]}},"/v1/people":{"get":{"operationId":"person","responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Person"}}}}},"parameters":[{"name":"malId","in":"query","description":"","schema":{"type":["integer"],"exclusiveMinimum":0}},{"name":"name","in":"query","description":"","schema":{"type":["string"],"minLength":1}}]}},"/v1/characters":{"get":{"operationId":"character","responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Character"}}}}},"parameters":[{"name":"malId","in":"query","description":"","schema":{"type":["integer"],"exclusiveMinimum":0}},{"name":"name","in":"query","description":"","schema":{"type":["string"],"minLength":1}}]}},"/v1":{"get":{"operationId":"index","responses":{"200":{"description":""}}}}}}