{"openapi":"3.1.0","info":{"title":"Recommendation service","version":"1.0.0"},"servers":[{"url":"/service/lw/recommendation/api"},{"url":"https://recommend.wmcloud.org/","description":"Staging environment"},{"url":"https://api.wikimedia.org","description":"Production environment"}],"paths":{"/v1/translation":{"get":{"tags":["translation"],"summary":"Get Translation Recommendations","description":"Retrieves translation recommendations based on the provided recommendation model.","operationId":"get_translation_recommendations_v1_translation_get","parameters":[{"name":"source","in":"query","required":true,"schema":{"type":"string","title":"Source"}},{"name":"target","in":"query","required":true,"schema":{"type":"string","title":"Target"}},{"name":"count","in":"query","required":false,"schema":{"type":"integer","default":12,"title":"Count"}},{"name":"seed","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Seed"}},{"name":"topic","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Topic"}},{"name":"country","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country"}},{"name":"featured_collection","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Featured Collection"}},{"name":"collections","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Collections"}},{"name":"lead_section","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Lead Section"}},{"name":"include_pageviews","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Include Pageviews"}},{"name":"search_algorithm","in":"query","required":false,"schema":{"$ref":"#/components/schemas/RecommendationAlgorithmEnum","default":"morelike"}},{"name":"rank_method","in":"query","required":false,"schema":{"$ref":"#/components/schemas/RankMethodEnum","default":"default"}},{"name":"min_size","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Min Size"}},{"name":"max_size","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Size"}},{"name":"continue_offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Continue Offset"}},{"name":"continue_seed","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Continue Seed"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranslationRecommendationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/translation/sections":{"get":{"tags":["translation"],"summary":"Get Section Translation Recommendations","description":"Retrieves section translation recommendations based on the provided recommendation model.","operationId":"get_section_translation_recommendations_v1_translation_sections_get","parameters":[{"name":"source","in":"query","required":true,"schema":{"type":"string","title":"Source"}},{"name":"target","in":"query","required":true,"schema":{"type":"string","title":"Target"}},{"name":"count","in":"query","required":false,"schema":{"type":"integer","default":12,"title":"Count"}},{"name":"seed","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Seed"}},{"name":"topic","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Topic"}},{"name":"country","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country"}},{"name":"featured_collection","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Featured Collection"}},{"name":"collections","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Collections"}},{"name":"lead_section","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Lead Section"}},{"name":"include_pageviews","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Include Pageviews"}},{"name":"search_algorithm","in":"query","required":false,"schema":{"$ref":"#/components/schemas/RecommendationAlgorithmEnum","default":"morelike"}},{"name":"rank_method","in":"query","required":false,"schema":{"$ref":"#/components/schemas/RankMethodEnum","default":"default"}},{"name":"min_size","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Min Size"}},{"name":"max_size","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Size"}},{"name":"continue_offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Continue Offset"}},{"name":"continue_seed","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Continue Seed"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SectionTranslationRecommendationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/translation/page-collections":{"get":{"tags":["translation"],"summary":"Get Page Collections","description":"Retrieves page collections from cache and returns them, including only their metadata","operationId":"get_page_collections_v1_translation_page_collections_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PageCollectionResponse"},"type":"array","title":"Response Get Page Collections V1 Translation Page Collections Get"}}}}}}},"/v1/translation/page-collection-groups":{"get":{"tags":["translation"],"summary":"Get Page Collection Groups","description":"Retrieves page collections from cache, groups them based on their name and returns the groups","operationId":"get_page_collection_groups_v1_translation_page_collection_groups_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PageCollectionResponse"},"type":"array"},"type":"object","title":"Response Get Page Collection Groups V1 Translation Page Collection Groups Get"}}}}}}},"/v1/translation/page-collection-membership":{"get":{"tags":["translation"],"summary":"Check Page Collection Membership","description":"Checks which article titles or Wikidata QIDs are contained in a specific page collection.\n\nSupports two modes:\n1. Check by language + titles: Returns mapping of titles to boolean\n2. Check by QIDs: Returns mapping of QIDs to boolean\n\nReturns a dictionary mapping each provided identifier to a boolean indicating\nwhether it exists in the specified collection.","operationId":"check_page_collection_membership_v1_translation_page_collection_membership_get","parameters":[{"name":"collection","in":"query","required":true,"schema":{"type":"string","title":"Collection"}},{"name":"language","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Language"}},{"name":"titles","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Titles"}},{"name":"qids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Qids"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"boolean"},"title":"Response Check Page Collection Membership V1 Translation Page Collection Membership Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/":{"get":{"summary":"Homepage Redirect","operationId":"homepage_redirect__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"PageCollectionMetadata":{"properties":{"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"end_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End Date"},"articles_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Articles Count"},"articles_by_language_count":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Articles By Language Count"}},"type":"object","required":["name"],"title":"PageCollectionMetadata"},"PageCollectionResponse":{"properties":{"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"end_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End Date"},"articles_count":{"type":"integer","title":"Articles Count"}},"type":"object","required":["name","articles_count"],"title":"PageCollectionResponse"},"RankMethodEnum":{"type":"string","enum":["default","sitelinks"],"title":"RankMethodEnum"},"RecommendationAlgorithmEnum":{"type":"string","enum":["morelike","mostpopular"],"title":"RecommendationAlgorithmEnum"},"SectionTranslationRecommendation":{"properties":{"source_title":{"type":"string","title":"Source Title","description":"Source title of the section translation recommendation"},"target_title":{"type":"string","title":"Target Title","description":"Target title of the section translation recommendation"},"source_sections":{"items":{"type":"string"},"type":"array","title":"Source Sections","description":"List of section titles of the source article of the section translation recommendation"},"target_sections":{"items":{"type":"string"},"type":"array","title":"Target Sections","description":"List of section titles of the target article of the section translation recommendation"},"present":{"additionalProperties":{"type":"string"},"type":"object","title":"Present","description":"Dict that maps the source section titles that are also present in the target article,\n                    to the corresponding target section titles of the section translation recommendation"},"missing":{"additionalProperties":{"type":"string"},"type":"object","title":"Missing","description":"Dict that maps the source section titles that are missing from the target article,\n                    to the corresponding proposed target section titles of the section translation recommendation"},"source_section_sizes":{"anyOf":[{"additionalProperties":{"type":"integer"},"type":"object"},{"type":"null"}],"title":"Source Section Sizes","description":"Map of section titles to their sizes in bytes"},"collection":{"anyOf":[{"$ref":"#/components/schemas/PageCollectionMetadata"},{"type":"null"}],"description":"An optional PageCollectionMetadata DTO, used for section translation recommendations\n                    from page collections"}},"type":"object","required":["source_title","target_title","source_sections","target_sections","present","missing"],"title":"SectionTranslationRecommendation"},"SectionTranslationRecommendationResponse":{"properties":{"recommendations":{"items":{"$ref":"#/components/schemas/SectionTranslationRecommendation"},"type":"array","title":"Recommendations"},"continue_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Continue Offset"},"continue_seed":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Continue Seed"}},"type":"object","required":["recommendations"],"title":"SectionTranslationRecommendationResponse"},"TranslationRecommendation":{"properties":{"title":{"type":"string","title":"Title"},"pageviews":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Pageviews","default":0},"wikidata_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Wikidata Id"},"rank":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Rank","default":0},"langlinks_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Langlinks Count","default":0},"size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Size","description":"Article size in bytes"},"lead_section_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Lead Section Size","description":"Lead section size in bytes"},"collection":{"anyOf":[{"$ref":"#/components/schemas/PageCollectionMetadata"},{"type":"null"}]}},"type":"object","required":["title"],"title":"TranslationRecommendation"},"TranslationRecommendationResponse":{"properties":{"recommendations":{"items":{"$ref":"#/components/schemas/TranslationRecommendation"},"type":"array","title":"Recommendations"},"continue_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Continue Offset"},"continue_seed":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Continue Seed"}},"type":"object","required":["recommendations"],"title":"TranslationRecommendationResponse"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}