{"openapi":"3.0.0","info":{"description":"API to manage CoorpAcademy content","version":"2.276.0","title":"Content API"},"servers":[{"url":"/api/v2"},{"url":"http://localhost:3700/api/v2"},{"url":"https://content-staging.coorpacademy.com/api/v2"},{"url":"https://content.coorpacademy.com/api/v2"}],"components":{"securitySchemes":{"token":{"type":"apiKey","name":"authorization","in":"header"}},"schemas":{"Meta":{"type":"object","required":["createdAt","updatedAt"],"properties":{"createdAt":{"type":"string","format":"date-time","example":"2021-10-11T14:54:52.368Z"},"updatedAt":{"type":"string","format":"date-time","example":"2021-10-11T14:54:52.368Z"}}},"BulkExternalContentMeta":{"type":"object","required":["modifiedBy"],"properties":{"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"disableLocalesFallback":{"type":"boolean"},"taggedNewUntil":{"type":"string"}}},"MetaVersion":{"type":"object","required":["createdBy","modifiedBy"],"properties":{"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"taggedNewUntil":{"type":"string","format":"date-time"},"isoCore":{"type":"boolean"},"coreBranch":{"type":"string","description":"External Course's reference that belongs the current external content"}}},"ExternalContent":{"type":"object","properties":{"parent":{"type":"string","description":"External Course's reference that belongs the current external content"},"structure":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaVersion"},"ref":{"type":"string","description":"identifier"},"universalRef":{"type":"string","description":"identifier"},"externalRef":{"type":"string","description":"identifier on external partner"},"app_token":{"type":"string","description":"app token (for 7shape courses)"},"hideCompleteButton":{"type":"boolean"},"type":{"type":"string"},"order":{"type":"number"},"stars":{"type":"number"},"duration":{"type":"number"},"src":{"type":"object","properties":{"mimeType":{"type":"string"},"url":{"type":"string"}}}}},"version":{"type":"string"},"locales":{"type":"object"}},"example":{"structure":{"meta":{"createdAt":"2016-02-09T10:31:57.702Z","updatedAt":"2019-12-13T10:50:42.668Z","isoCore":false,"modifiedBy":"silouone","createdBy":"LaurenceMD","externalCourses":["ext_dis_41LQRYbi"]},"hideCompleteButton":false,"app_token":"86fb63f94a2615b40c8fa0a7bc1c40c2","ref":"ext_cont_41-G-7RtWo","universalRef":"ext_cont_41-G-7RtWo","type":"scorm","order":1,"stars":10,"duration":20,"src":{"mimeType":"application/zip","url":"url"},"version":"1"},"locales":{"en":{"url":"https://s3-eu-west-1.amazonaws.com/scorm/solar_system_en.zip"},"fr":{"url":"https://s3-eu-west-1.amazonaws.com/scorm/solar_system_fr.zip"}}}},"RepositoryExternalContents":{"type":"object","example":{"ext_dis_41LQRYbi":[{"structure":{"meta":{"createdAt":"2016-02-09T10:31:57.702Z","updatedAt":"2019-12-13T10:50:42.668Z","isoCore":false,"coreBranch":null,"modifiedBy":"silouone","createdBy":"LaurenceMD","externalCourses":["ext_dis_41LQRYbi"]},"ref":"ext_cont_41-G-7RtWo","universalRef":"ext_cont_41-G-7RtWo","type":"scorm","order":1,"src":{"mimeType":"application/zip","url":"url"},"version":"1"},"locales":{"en":{"url":"https://s3-eu-west-1.amazonaws.com/scorm/solar_system_en.zip"},"fr":{"url":"https://s3-eu-west-1.amazonaws.com/scorm/solar_system_fr.zip"}}}]}},"ExternalCourse":{"type":"object","properties":{"_deleted":{"type":"boolean"},"structure":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaVersion"},"ref":{"type":"string","description":"course identifier"},"universalRef":{"type":"string","description":"identifier"},"hidden":{"type":"boolean"},"name":{"type":"string"},"position":{"type":"number"},"partners":{"type":"array","items":{"type":"string"}},"skills":{"type":"array","items":{"type":"string"}},"thematiques":{"type":"array","items":{"type":"string"}},"version":{"type":"string"},"cover":{"type":"object","properties":{"description":{"type":"string","description":"Course desription"},"poster":{"type":["string","null"]},"resource":{"type":["string","null"],"description":"Course video"},"media":{"type":["object","null"],"properties":{"mediaUrl":{"type":"string","description":"Media url"},"mimeType":{"type":"string","description":"Media mimeType"},"type":{"type":"string","description":"Media type"}}}}},"disableLocalesFallback":{"type":"boolean"}}},"locales":{"type":"object"}},"example":{"structure":{"ref":"ext_dis_41LQRYbi","universalRef":"ext_dis_41LQRYbi","hidden":false,"name":"name","position":0,"partners":[],"acquiredSkills":["skill_VyP8vXl5We","skill_Ey6Iw7lqZg","skill_4JePwQgcbe"],"skills":["skill_Ekp8mtR3H"],"thematiques":[],"partnershipType":"custom","disableLocalesFallback":false,"states":{"fr":{"edition":"draft"},"en":{"edition":"validate"}},"meta":{"createdAt":"2016-02-09T10:31:57.702Z","updatedAt":"2019-12-13T10:50:42.668Z","isoCore":false,"coreBranch":null,"modifiedBy":"silouone","createdBy":"LaurenceMD"},"version":"1","cover":{"description":"description","poster":"med_413YKSsqQ","resource":"med_413YKSsqQ "}},"locales":{"en":{"name":"Solar System","description":"Course description","skill_4JePwQgcbe":"Explain what are the key missions of data scientists and data engineers","skill_Ey6Iw7lqZg":"Describe how data science empowers businesses","skill_VyP8vXl5We":"List the differences between data scientists and data engineers"},"fr":{"name":"Système solaire","description":"Description de cours","skill_4JePwQgcbe":"Expliquer quelles sont les missions clés des data scientists et des data engineers","skill_Ey6Iw7lqZg":"Saisir l'importance de la science des données pour les entreprises","skill_VyP8vXl5We":"Citer les différences entre les data scientists et les data engineers"}}}},"SkillStructure":{"type":"object","required":["ref","name"],"properties":{"ref":{"type":"string","description":"Object structure"},"type":{"type":"string","description":"Type object. In this case is skill"},"name":{"type":"string","description":"Translation key for name"},"meta":{"$ref":"#/components/schemas/Meta"}}},"SkillResponse":{"type":"object","required":["structure","locales"],"properties":{"structure":{"$ref":"#/components/schemas/SkillStructure"},"type":{"type":"string"},"locales":{"type":"object"}},"example":{"structure":{"ref":"skill_001","type":"skill","name":"name"},"type":"skill","locales":{"en":{"name":"Communication"},"es":{"name":"Communicación"},"fr":{"name":"Communication"}}}},"SkillLocales":{"type":"object"},"SkillBodyRequest":{"type":"object","properties":{"structure":{"$ref":"#/components/schemas/SkillStructure"},"locales":{"$ref":"#/components/schemas/SkillLocales"}},"example":{"structure":{"ref":"skill_001","name":"name"},"locales":{"fr":{"name":"Communication"},"en":{"name":"Communication"},"es":{"name":"Comunicación"}}}},"ScriptStructure":{"type":"object","properties":{"ref":{"type":"string","description":"subtitleRef"},"states":{"type":"object","description":"States of publication, transcription, progression transcription and edition by lang","additionalProperties":{"type":"object","properties":{"published":{"type":"boolean","description":"States of the publication : true or false"},"original":{"type":"boolean","description":"Authenticity criteria of the script (original if created by uploading a file on cockpit): true or false"},"edition":{"type":"string","description":"States of the edition value : draft or validate"},"state":{"type":"string","description":"state of the generation of subtitle : Success, Error, Pending"},"progression":{"type":"number","description":"% of progression of the generation of the subtitle"}}}},"meta":{"$ref":"#/components/schemas/Meta"}}},"ScriptBodyRequest":{"type":"object","properties":{"structure":{"$ref":"#/components/schemas/ScriptStructure"},"locales":{"$ref":"#/components/schemas/ScriptLocales"},"videoId":{"type":"string","description":"id of the video"},"repository":{"type":"string","description":"repository of the script"}},"example":{"structure":{"ref":"ref_subtitle_01","states":{"fr":{"published":false,"edition":"validate","original":true,"authot":{"state":"success","progression":100}},"en":{"published":true,"edition":"validate","original":true,"authot":{"state":"success","progression":100}},"es":{"published":false,"edition":"validate","original":true,"authot":{"state":"success","progression":100}}}},"videoId":"videoId","repository":"repo-core","locales":{"fr":{"scriptUrl":"url1","srtUrl":"srtUrl","jwTrackId":"id_track_fr"},"en":{"scriptUrl":"url2","srtUrl":"srtUrl","jwTrackId":"id_track_en"},"es":{"scriptUrl":"url3","srtUrl":"srtUrl","jwTrackId":"id_track_es"}}}},"ScriptBodyRequestPut":{"type":"object","properties":{"structure":{"$ref":"#/components/schemas/ScriptStructure"},"locales":{"$ref":"#/components/schemas/ScriptLocales"},"videoId":{"type":"string","description":"id of the video"},"repository":{"type":"string","description":"repository of the video"}},"example":{"locales":{"en":{"scriptUrl":"string","srtUrl":"string","jwTrackId":"id_track_en"}},"structure":{"states":{"en":{"edition":"validate","published":true,"orignal":true,"authot":{"state":"success","progression":100}}}}}},"ScriptLocales":{"type":"object","properties":{"scriptUrl":{"type":"string","description":"Script url on aws s3"},"srtUrl":{"type":"string","description":"Srt url on aws s3"},"jwTrackId":{"type":"string","description":"Track key on jw player"}}},"ScriptResponse":{"type":"object","required":["structure","locales","videoId","repository"],"properties":{"structure":{"$ref":"#/components/schemas/ScriptStructure"},"locales":{"$ref":"#/components/schemas/ScriptLocales"},"videoId":{"type":"string","description":"id of the video"},"repository":{"type":"string","description":"repository of the video"}},"example":{"structure":{"ref":"sub_123","states":{"en":{"edition":"validate","published":true,"original":true,"authot":{"state":"success","progression":100}},"fr":{"edition":"validate","published":true,"original":true,"authot":{"state":"success","progression":100}}}},"videoId":"videoId","repository":"repo-core","locales":{"en":{"scriptUrl":"srtUrl","srtUrl":"strUrl","jwTrackId":"id_track_en"},"es":{"scriptUrl":"srtUrl","srtUrl":"strUrl","jwTrackId":"id_track_es"},"fr":{"scriptUrl":"srtUrl","srtUrl":"strUrl","jwTrackId":"id_track_fr"}}}},"NotificationBodyRequest":{"type":"object","properties":{"name":{"type":"string","description":"name of the notifications. This name will be used as cookie name"},"type":{"type":"string","description":"type of notification"},"active":{"type":"boolean","description":"whether the notification is active or not"},"message":{"type":"string","description":"message of notification"},"link":{"type":"string","description":"link to be used as CTA of the notification"}},"example":{"name":"new_feature_subtitles","type":"feature","active":true,"message":"New feature subtitles online. Click on button to see the demo!","link":"https://video.com/feature/new"}},"NotificationBodyRequestPut":{"type":"object","properties":{"type":{"type":"string","description":"type of notification"},"active":{"type":"boolean","description":"whether the notification is active or not"},"message":{"type":"string","description":"message of notification"},"link":{"type":"string","description":"link to be used as CTA of the notification"}},"example":{"type":"feature","active":true,"message":"New feature subtitles online. Click on button to see the demo!","link":"https://video.com/feature/new"}},"Notification":{"type":"object","required":["name","type","active","message"],"properties":{"name":{"type":"string","description":"name (id) of the notifications. This name will be used as cookie name"},"type":{"type":"string","description":"type of notification"},"active":{"type":"boolean","description":"whether the notification is active or not"},"message":{"type":"string","description":"message of notification"},"link":{"type":"string","description":"link to be used as CTA of the notification"}},"example":{"name":"new_feature_subtitles","type":"feature","active":true,"message":"New feature subtitles online. Click on button to see the demo!","link":"https://video.com/feature/new"}},"AddLocaleBody":{"type":"object","required":["from","to","username"],"properties":{"from":{"type":"string","description":"source locale"},"to":{"type":"string","description":"destination locale"},"username":{"type":"string","description":"github user"}},"example":{"from":"en","to":"pt_BR","username":"jomaora"}},"CertificationConditionItemsDecoder":{"type":"object","properties":{"type":{"type":"string"},"engine":{"type":"string"},"ref":{"type":"string"}}},"CertificationCondition":{"type":"object","properties":{"type":{"type":"string"},"items":{"type":"object","properties":{"ref":{"$ref":"#/components/schemas/CertificationConditionItemsDecoder"}}},"nbDone":{"type":"number"},"badge":{"type":"string"},"level":{"type":"string"}}},"DiplomaRewards":{"type":["null","object"],"properties":{"logo_url":{"type":["string","null"]},"signature_url":{"type":["string","null"]}}},"ResourceRewards":{"type":["null","object"],"required":["label","file_uri"],"properties":{"label":{"type":"string"},"file_uri":{"type":"string"}}},"StarsRewards":{"type":["null","object"],"required":["value","groups"],"properties":{"value":{"type":"number"},"groups":{"type":"array","items":{"type":"string"}}}},"CertificationRewards":{"type":"object","properties":{"diploma":{"$ref":"#/components/schemas/DiplomaRewards"},"resource":{"$ref":"#/components/schemas/ResourceRewards"},"stars":{"$ref":"#/components/schemas/StarsRewards"}}},"CertificationLocales":{"type":"object","properties":{"title":{"type":["string","null"]},"description":{"type":["string","null"]},"rewards":{"type":"object","properties":{"diploma":{"type":"object","properties":{"signature_url":{"type":"string"},"logo_url":{"type":"string"}}},"resource":{"type":"object","properties":{"label":{"type":"string"},"file_uri":{"type":"string"}}},"stars":{"type":"object","properties":{"value":{"type":"number"},"groups":{"type":"array","items":{"type":"string"}}}}}}}},"CertificationMeta":{"type":"object","required":["modifiedBy"],"properties":{"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"}}},"CertificationStructureDiff":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"},"condition":{"$ref":"#/components/schemas/CertificationCondition"},"rewards":{"$ref":"#/components/schemas/CertificationRewards"},"groups":{"type":"array","items":{"type":"string"}},"populations":{"type":"array","items":{"type":"string"}},"svg":{"type":["string","null"]},"updated":{"type":"boolean"}}},"CertificationStructureSnapshot":{"type":"object","required":["title"],"properties":{"title":{"type":"string"},"description":{"type":"string"},"defaultLocale":{"type":"string"},"condition":{"$ref":"#/components/schemas/CertificationCondition"},"rewards":{"$ref":"#/components/schemas/CertificationRewards"},"groups":{"type":"array","items":{"type":"string"}},"populations":{"type":"array","items":{"type":"string"}},"svg":{"type":"string"},"updated":{"type":"boolean"}}},"CertificationDiff":{"type":"object","required":["ref","repository","version","meta"],"properties":{"repository":{"type":"string"},"ref":{"type":"string"},"version":{"type":"number"},"locales":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CertificationLocales"}},"meta":{"$ref":"#/components/schemas/CertificationMeta"},"state":{"type":"string"},"structure":{"$ref":"#/components/schemas/CertificationStructureDiff"}}},"CertificationSnapshot":{"type":"object","required":["ref","repository","version","meta","state","structure"],"properties":{"repository":{"type":"string"},"ref":{"type":"string"},"version":{"type":"number"},"locales":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CertificationLocales"}},"meta":{"$ref":"#/components/schemas/CertificationMeta"},"state":{"type":"string"},"structure":{"$ref":"#/components/schemas/CertificationStructureSnapshot"}}},"CertificationStructureEdition":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"},"condition":{"$ref":"#/components/schemas/CertificationCondition"},"rewards":{"$ref":"#/components/schemas/CertificationRewards"},"defaultLocale":{"type":"string"},"groups":{"type":"array","items":{"type":"string"}},"populations":{"type":"array","items":{"type":"string"}},"svg":{"type":"string"},"updated":{"type":"boolean"}}},"CertificationEdition":{"type":"object","required":["ref","repository","version","meta"],"properties":{"repository":{"type":"string"},"ref":{"type":"string"},"version":{"type":"number"},"locales":{"additionalProperties":{"$ref":"#/components/schemas/CertificationLocales"}},"meta":{"$ref":"#/components/schemas/CertificationMeta"},"state":{"type":"string"},"structure":{"$ref":"#/components/schemas/CertificationStructureEdition"}},"example":{"ref":"cert_kIIm6bPa00","repository":"content-core@cockpitRecette-core","version":1,"meta":{"createdAt":"2016-02-09T10:31:57.702Z","updatedAt":"2019-12-13T10:50:42.668Z","modifiedBy":"silouone","createdBy":"stefano"},"structure":{"title":"title","description":"description","populations":["pop1","pop2"],"defaultLocale":"en"},"locales":{"en":{"title":"title","description":"description"},"fr":{"title":"title","description":"description"},"es":{"title":"title","description":"description"}}}},"CertificationConsommationPayload":{"type":"object","properties":{"structure":{"$ref":"#/components/schemas/CertificationStructureSnapshot"},"locales":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CertificationLocales"}}}},"CertificationConsommationOrderMap":{"type":"number"},"CertificationConsommation":{"type":"object","properties":{"ongoing":{"type":"boolean"},"ref":{"type":"string"},"repository":{"type":"string"},"version":{"type":"number"},"payload":{"$ref":"#/components/schemas/CertificationConsommationPayload"},"order_":{"type":"object","properties":{"ref":{"$ref":"#/components/schemas/CertificationConsommationOrderMap"}}}}},"CustomPlaylistLocales":{"type":"object","properties":{"title":{"type":["string","null"]},"description":{"type":["string","null"]}}},"CustomPlaylistMeta":{"type":"object","required":["modifiedBy"],"properties":{"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"}}},"CustomPlaylistItemMap":{"type":"object","properties":{"type":{"type":"string"},"engine":{"type":"string"},"ref":{"type":"string"}}},"CustomPlaylistStructureEdition":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"},"defaultLocale":{"type":"string"},"items":{"type":"object","properties":{"ref":{"$ref":"#/components/schemas/CustomPlaylistItemMap"}}},"populations":{"type":"array","items":{"type":"string"}}}},"CustomPlaylistEdition":{"type":"object","required":["ref","repository","version","meta"],"properties":{"repository":{"type":"string"},"ref":{"type":"string"},"version":{"type":"number"},"locales":{"additionalProperties":{"$ref":"#/components/schemas/CustomPlaylistLocales"}},"meta":{"$ref":"#/components/schemas/CustomPlaylistMeta"},"state":{"type":"string"},"structure":{"$ref":"#/components/schemas/CustomPlaylistStructureEdition"}},"example":{"ref":"cplaylist_kIIm6bPa00","repository":"content-core@cockpitRecette-core","version":1,"meta":{"createdAt":"2016-02-09T10:31:57.702Z","updatedAt":"2019-12-13T10:50:42.668Z","modifiedBy":"silouone","createdBy":"stefano"},"structure":{"title":"title","description":"description","populations":["pop1","pop2"],"defaultLocale":"en","items":{"dis_N12Qn2u8I":{"engine":"learner","ref":"dis_N12Qn2u8I","type":"level","position":1}}},"locales":{"en":{"title":"title","description":"description"},"fr":{"title":"title","description":"description"},"es":{"title":"title","description":"description"}}}},"CustomPlaylistConsommationPayload":{"type":"object","properties":{"structure":{"$ref":"#/components/schemas/CustomPlaylistStructureEdition"},"locales":{"additionalProperties":{"$ref":"#/components/schemas/CustomPlaylistLocales"}}}},"CustomPlaylistConsommation":{"type":"object","properties":{"ongoing":{"type":"boolean"},"ref":{"type":"string"},"repository":{"type":"string"},"version":{"type":"number"},"payload":{"$ref":"#/components/schemas/CustomPlaylistConsommationPayload"}},"example":{"ref":"cplaylist_kIIm6bPa00","repository":"content-core@cockpitRecette-core","version":1,"state":"draft","meta":{"createdAt":"2016-02-09T10:31:57.702Z","updatedAt":"2019-12-13T10:50:42.668Z","modifiedBy":"silouone","createdBy":"stefano"},"defaultLocale":"en","payload":{"populations":["pop1","pop2"],"title":"title","description":"description","items":{"dis_N12Qn2u8I":{"engine":"learner","ref":"dis_N12Qn2u8I","type":"level"}},"locales":{"en":{"title":"title","description":"description"},"fr":{"title":"title","description":"description"},"es":{"title":"title","description":"description"}}}}},"Error":{"type":"object","properties":{"id":{"type":"string"},"code":{"type":"string"},"errors":{"type":"array","items":{"type":"object"}},"success":{"type":"boolean"},"status":{"type":"integer","format":"int32"},"message":{"type":"string"}}},"ErrorCSV":{"type":"object","properties":{"column":{"type":"string","description":"column of the errorCSV"},"errorCode":{"type":"string","description":"errorCode of the errorCSV"},"description":{"type":"string","description":"description of the errorCSV"}}},"ErrorResource":{"type":"object","properties":{"type":{"type":"string","description":"type of the error resource"},"fileName":{"type":"string","description":"name of the error resource"}}},"ExternalContentForBulk":{"type":"object","properties":{"duration":{"type":"number","description":"duration of the external content"},"cover":{"type":"object","properties":{"mimeType":{"type":"string","description":"mimeType of the cover"},"type":{"type":"string","description":"type of the cover"},"url":{"type":"string","description":"url of the cover"}}},"skills":{"type":"array","items":{"type":"string"},"description":"skills of the external content"},"partners":{"type":"array","items":{"type":"string"},"description":"partners of the external content"},"thematiques":{"type":"array","items":{"type":"string"},"description":"thematiques of the external content"},"disableLocalesFallback":{"type":"boolean","description":"disableLocalesFallback of the external content"},"lang":{"type":"string","description":"language of the external content"},"state":{"type":"string","description":"state of the external content"},"url":{"type":"string","description":"url of the external content"},"externalRef":{"type":"string","description":"external ref of the external content"},"mode":{"type":"string","description":"mode of the external content"},"title":{"type":"string","description":"title of the external content"},"fileName":{"type":"string","description":"file name of the external content"},"description":{"type":"string","description":"description of the external content"},"errorResource":{"$ref":"#/components/schemas/ErrorResource"},"errorCSV":{"$ref":"#/components/schemas/ErrorCSV"}}},"BulkExternalContent":{"type":"object","properties":{"ref":{"type":"string","description":"ref of the bulk external content"},"repository":{"type":"string","description":"repository of the bulk external content"},"states":{"type":"string","description":"state of the bulk external content"},"progress":{"type":"number","description":"progress of the bulk external content"},"metadata":{"$ref":"#/components/schemas/BulkExternalContentMeta"},"externalContentList":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ExternalContentForBulk"}},"resourceUrl":{"type":"string","description":"resourceUrl of the bulk external content"},"metadataUrl":{"type":"string","description":"metadataUrl of the bulk external content"}},"example":{"ref":"ref","repository":"content-core@cockpitRecette-core","states":"pending","progress":50,"metadata":{"createdAt":"2021-10-11T14:54:52.368Z","updatedAt":"2021-10-11T14:54:52.368Z","modifiedBy":"ouiza","createdBy":"ouiza","disableLocalesFallback":true},"externalContentList":{"key1":{"duration":"10","cover":{"mimeType":"image/jpeg","type":"img","url":"url"},"skills":["skill0","skill1"],"partners":["partner0","partner1"],"mode":"mode","title":"title","fileName":"fileName","description":"description","errorResource":{"key1":{"type":"error1","fileName":"fileName"}},"errorCSV":{"key1":{"column":"column","errorCode":"errorCode","description":"description"}}}},"resourceUrl":"","metadataUrl":""}},"BulkExternalContentInitialUpsert":{"type":"object","properties":{"ref":{"type":"string","description":"ref of the bulk external content"},"repository":{"type":"string","description":"repository of the bulk external content"},"state":{"type":"string","enum":["pending"],"description":"state of the bulk external content"},"totalExpectedItems":{"type":"number","description":"number of bulk items"},"bulkTitle":{"type":"string","description":"title of the bulk"},"metadata":{"$ref":"#/components/schemas/BulkExternalContentMeta"}},"required":["ref","repository","state","totalExpectedItems"],"example":{"ref":"extBulk_zIaDGjAXDA","repository":"content-core@cockpitRecette-core","state":"pending","totalExpectedItems":15,"bulkTitle":"bulk title","metadata":{"createdAt":"2021-10-11T14:54:52.368Z","updatedAt":"2021-10-11T14:54:52.368Z","modifiedBy":"ouiza","createdBy":"ouiza","disableLocalesFallback":true}}},"BulkExternalContentUpsert":{"type":"object","properties":{"ref":{"type":"string","description":"ref of the bulk external content"},"repository":{"type":"string","description":"repository of the bulk external content"},"metadata":{"$ref":"#/components/schemas/BulkExternalContentMeta"},"externalContentList":{"$ref":"#/components/schemas/ExternalContentForBulk"},"resourceUrl":{"type":"string","description":"resourceUrl of the bulk external content"},"metadataUrl":{"type":"string","description":"metadataUrl of the bulk external content"}},"required":["ref","repository","externalContentList"],"example":{"ref":"extBulk_zIaDGjAXDA","repository":"content-core@cockpitRecette-core","metadata":{"createdAt":"2021-10-11T14:54:52.368Z","updatedAt":"2021-10-11T14:54:52.368Z","modifiedBy":"ouiza","createdBy":"ouiza","disableLocalesFallback":true},"externalContentList":{"key1":{"duration":10,"cover":{"mimeType":"image/jpeg","type":"img","url":"url"},"skills":["skill0","skill1"],"partners":["partner0","partner1"],"thematiques":["thematique0","thematique1"],"acquiredSkills":[],"disableLocalesFallback":false,"modifiedBy":"ouiza","createdBy":"ouiza","lang":"fr","state":"state","url":"url","mode":"mode","title":"title","fileName":"fileName","partnershipType":"partnershipType","description":"description","externalRef":"externalRef","version":"version","errorResource":{"key1":{"type":"error1","fileName":"fileName"}},"errorCSV":{"key1":{"column":"column","errorCode":"errorCode","description":"description"}}}},"resourceUrl":"","metadataUrl":""}},"BulkExternalContentStateUpsert":{"type":"object","properties":{"ref":{"type":"string","description":"ref of the bulk external content"},"repository":{"type":"string","description":"repository of the bulk external content"},"state":{"type":"string","enum":["saved","deleted"],"description":"state of the bulk external content"},"metadata":{"$ref":"#/components/schemas/BulkExternalContentMeta"}},"required":["ref","repository","state"],"example":{"ref":"extBulk_zIaDGjAXDA","repository":"content-core@cockpitRecette-core","states":"saved","metadata":{"modifiedBy":"ouiza"}}},"BulkExternalContentUpsertResponse":{"type":"object","properties":{"ref":{"type":"string","description":"ref of the bulk external content"},"repository":{"type":"string","description":"repository of the bulk external content"},"state":{"type":"string","description":"state of the bulk external content"},"totalExpectedItems":{"type":"number","description":"number of bulk items"},"totalProcessedItems":{"type":"number","description":"number of bulk items processed"},"bulkTitle":{"type":"string","description":"title of the bulk"},"progress":{"type":"number","description":"progress of the bulk external content"},"metadata":{"$ref":"#/components/schemas/BulkExternalContentMeta"},"externalContentList":{"$ref":"#/components/schemas/ExternalContentForBulk"},"resourceUrl":{"type":"string","description":"resourceUrl of the bulk external content"},"metadataUrl":{"type":"string","description":"metadataUrl of the bulk external content"}},"example":{"ref":"extBulk_zIaDGjAXDA","repository":"content-core@cockpitRecette-core","states":"pending","progress":50,"metadata":{"createdAt":"2021-10-11T14:54:52.368Z","updatedAt":"2021-10-11T14:54:52.368Z","modifiedBy":"ouiza","createdBy":"ouiza","disableLocalesFallback":true},"externalContentList":{"key1":{"duration":10,"cover":{"mimeType":"image/jpeg","type":"img","url":"url"},"skills":["skill0","skill1"],"partners":["partner0","partner1"],"thematiques":["thematique0","thematique1"],"disableLocalesFallback":false,"modifiedBy":"ouiza","createdBy":"ouiza","lang":"fr","state":"state","url":"url","mode":"mode","title":"title","fileName":"fileName","partnershipType":"partnershipType","description":"description","externalRef":"externalRef","version":"version","errorResource":{"key1":{"type":"error1","fileName":"fileName"}},"errorCSV":{"key1":{"column":"column","errorCode":"errorCode","description":"description"}}}},"resourceUrl":"","metadataUrl":""}},"CustomSkillConsommation":{"type":"object","required":["ref","repository","version","meta","state","defaultLocale","payload"],"properties":{"repository":{"type":"string"},"ref":{"type":"string"},"version":{"type":"number"},"state":{"enum":["published","deleted","archived","draft"]},"defaultLocale":{"type":"string","example":"en"},"meta":{"$ref":"#/components/schemas/CustomSkillMeta"},"payload":{"$ref":"#/components/schemas/CustomSkillConsommationPayload"}}},"CustomSkillConsommationBodyUpsert":{"type":"object","required":["ref","repository","meta","state"],"properties":{"repository":{"type":"string"},"ref":{"type":"string"},"version":{"type":"number"},"state":{"enum":["published","deleted","archived","draft"]},"defaultLocale":{"type":"string","example":"en"},"meta":{"$ref":"#/components/schemas/CustomSkillMeta"},"payload":{"$ref":"#/components/schemas/CustomSkillConsommationPayload"}}},"CustomSkillConsommationPayload":{"type":"object","required":["title","description"],"properties":{"title":{"type":"string"},"description":{"type":"string"},"items":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CustomSkillItems"}},"icon":{"type":"object","properties":{"color":{"type":"string"},"name":{"type":"string"}}},"locales":{"type":"object","additionalProperties":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"}}}}}},"CustomSkillItems":{"type":"object","properties":{"type":{"type":"string"},"ref":{"type":"string"}}},"CustomSkillMeta":{"type":"object","required":["modifiedBy"],"properties":{"modifiedBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"}}},"CustomSkillEdition":{"type":"object","required":["repository","version"],"properties":{"repository":{"type":"string"},"ref":{"type":"string"},"version":{"type":"number"},"locales":{"type":"object","properties":{"lang":{"$ref":"#/components/schemas/CustomSkillLocalesMap"}}},"meta":{"$ref":"#/components/schemas/CustomSkillMeta"},"state":{"type":"string"},"structure":{"$ref":"#/components/schemas/CustomSkillStructureEdition"}}},"CustomSkillStructureEdition":{"type":"object","properties":{"title":{"type":"string","example":"title"},"description":{"type":"string","example":"description"},"defaultLocale":{"type":"string","example":"en"},"icon":{"type":"object","$ref":"#/components/schemas/CustomSkillIcon"},"items":{"type":"object","properties":{"ref":{"$ref":"#/components/schemas/CustomSkillItemMap"}}}}},"CustomSkillIcon":{"type":"object","properties":{"color":{"type":"string","example":"#FFFFFF"},"name":{"type":"string","example":"white"}}},"CustomSkillItemMap":{"type":"object","properties":{"type":{"type":"string","example":"type"},"ref":{"type":"string","example":"ref"}}},"CustomSkillLocalesMap":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"}}},"ConsommationContentCount":{"type":"object","properties":{"_id":{"type":"string","enum":["published","archived","draft"]},"count":{"type":"number"}}}}},"paths":{"/repository/{repository}/jobs/add-locale":{"post":{"tags":["jobs"],"summary":"Add a new locale to repository resources","description":"Add a new locale to repository resources","operationId":"addLocale","security":[{"token":[]}],"x-exegesis-controller":"jobs","requestBody":{"description":"parameters to copy the locales","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddLocaleBody"}}}},"parameters":[{"name":"repository","in":"path","description":"Ref of the repository","required":true,"schema":{"type":"string"},"example":"content-core@cockpitRecette-core"}],"responses":{"200":{"description":"Repository resources were updated."}}}},"/repository/{repository}/external-courses":{"get":{"tags":["externalCourses"],"summary":"Get a list of external course","description":"Get a list of external course","operationId":"findExternalCourses","security":[{"token":[]}],"x-exegesis-controller":"external-course","parameters":[{"name":"repository","in":"path","description":"Ref of the repository","required":true,"schema":{"type":"string"},"example":"content-core@cockpitRecette-core"},{"name":"refs","in":"query","schema":{"type":"string"},"description":"list of external course references, separated by comma"},{"name":"includeDeleted","in":"query","schema":{"type":"boolean"},"description":"Include deleted external courses on the list"}],"responses":{"200":{"description":"External courses found","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExternalCourse"}}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"tags":["externalCourses"],"summary":"Create a external course","description":"Create a external course","operationId":"createExternalCourse","security":[{"token":[]}],"x-exegesis-controller":"external-course","requestBody":{"description":"External course in cockpit github format","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalCourse"}}}},"parameters":[{"name":"repository","in":"path","description":"Ref of the repository","required":true,"schema":{"type":"string"},"example":"content-core@cockpitRecette-core"}],"responses":{"201":{"description":"Created external course","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalCourse"}}}},"400":{"description":"Given data on body request does not match with model definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"The given document with the attributes repository, ref and version already exists in the database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/repository/{repository}/external-courses/{ref}":{"get":{"tags":["externalCourses"],"operationId":"findOneExternalCourses","security":[{"token":[]}],"x-exegesis-controller":"external-course","parameters":[{"name":"repository","in":"path","description":"Ref of the repository","required":true,"schema":{"type":"string"},"example":"content-core@cockpitRecette-core"},{"name":"ref","in":"path","description":"Reference of the external course","required":true,"schema":{"type":"string"},"example":"ext_dis_003"}],"responses":{"200":{"description":"Requested external course","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalCourse"}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"External course not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalCourse"}}}},"409":{"description":"The given document with the attributes repository, ref and version already exists in the database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"put":{"tags":["externalCourses"],"operationId":"updateExternalCourse","security":[{"token":[]}],"x-exegesis-controller":"external-course","requestBody":{"description":"Modifications to be applied to the external courses","required":true,"content":{"application/json":{"schema":{"type":"object"}}}},"parameters":[{"name":"repository","in":"path","description":"Ref of the repository","required":true,"schema":{"type":"string"},"example":"content-core@cockpitRecette-core"},{"name":"ref","in":"path","description":"Reference of the external course","required":true,"schema":{"type":"string"},"example":"ext_dis_003"}],"responses":{"201":{"description":"External course new version","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalCourse"}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"tags":["externalCourses"],"operationId":"removeExternalCourses","security":[{"token":[]}],"x-exegesis-controller":"external-course","parameters":[{"name":"repository","in":"path","description":"Ref of the repository","required":true,"schema":{"type":"string"},"example":"content-core@cockpitRecette-core"},{"name":"ref","in":"path","description":"Reference of the external course","required":true,"schema":{"type":"string"},"example":"ext_dis_003"}],"responses":{"204":{"description":"External course deleted"},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/repository/{repository}/external-courses/external-contents":{"get":{"tags":["externalCourses"],"summary":"Get a list of external content for the given external course","description":"Get a list of external content for the given external course","operationId":"findExternalContentsByRefs","security":[{"token":[]}],"x-exegesis-controller":"external-content","parameters":[{"name":"repository","in":"path","description":"Ref of the repository","required":true,"schema":{"type":"string"},"example":"content-core@cockpitRecette-core"},{"name":"externalCoursesRefs","in":"query","schema":{"type":"string"},"description":"list of external course references, separated by comma"},{"name":"includeDeleted","in":"query","schema":{"type":"boolean"},"description":"Include deleted external courses on the list"}],"responses":{"200":{"description":"External content found","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExternalContent"}}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/repository/{repository}/external-courses/{ref}/external-contents":{"get":{"tags":["externalCourses"],"summary":"Get a list of external content for the given external course","description":"Get a list of external content for the given external course","operationId":"findExternalContents","security":[{"token":[]}],"x-exegesis-controller":"external-content","parameters":[{"name":"repository","in":"path","description":"Ref of the repository","required":true,"schema":{"type":"string"},"example":"content-core@cockpitRecette-core"},{"name":"ref","in":"path","description":"Reference of the external course","required":true,"schema":{"type":"string"},"example":"ext_dis_003"}],"responses":{"200":{"description":"External content found","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExternalContent"}}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"tags":["externalCourses"],"summary":"Create a external content related to an external course","description":"Create a external content related to an external course","operationId":"createExternalContent","security":[{"token":[]}],"x-exegesis-controller":"external-content","requestBody":{"description":"given notification","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalContent"}}}},"parameters":[{"name":"repository","in":"path","description":"Ref of the repository","required":true,"schema":{"type":"string"},"example":"content-core@cockpitRecette-core"},{"name":"ref","in":"path","description":"Reference of the external course","required":true,"schema":{"type":"string"},"example":"ext_dis_003"}],"responses":{"201":{"description":"Created external content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalContent"}}}},"400":{"description":"Given data on body request does not match with model definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"The given document with the attributes repository, ref and version already exists in the database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/repository/{repository}/external-courses/{ref}/external-contents/{externalContentRef}":{"put":{"tags":["externalCourses"],"summary":"Updates an exitsing external content related to an external course","description":"Updates an exitsing external content related to an external course","operationId":"updateExternalContent","security":[{"token":[]}],"x-exegesis-controller":"external-content","requestBody":{"description":"Modifications to be applied to the external content","required":true,"content":{"application/json":{"schema":{"type":"object"}}}},"parameters":[{"name":"repository","in":"path","description":"Ref of the repository","required":true,"schema":{"type":"string"},"example":"content-core@cockpitRecette-core"},{"name":"ref","in":"path","description":"Reference of the external course","required":true,"schema":{"type":"string"},"example":"ext_dis_003"},{"name":"externalContentRef","in":"path","description":"Reference of the external content","required":true,"schema":{"type":"string"},"example":"ext_cont_003"}],"responses":{"201":{"description":"External content updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalContent"}}}},"400":{"description":"Given data on body request does not match with model definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"The given document with the attributes repository, ref and version already exists in the database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"tags":["externalCourses"],"summary":"Deletes an exitsing external content related to an external course","description":"Deletes an exitsing external content related to an external course","operationId":"removeExternalContent","security":[{"token":[]}],"x-exegesis-controller":"external-content","parameters":[{"name":"repository","in":"path","description":"Ref of the repository","required":true,"schema":{"type":"string"},"example":"content-core@cockpitRecette-core"},{"name":"ref","in":"path","description":"Reference of the external course","required":true,"schema":{"type":"string"},"example":"ext_dis_003"},{"name":"externalContentRef","in":"path","description":"Reference of the external content","required":true,"schema":{"type":"string"},"example":"ext_cont_003"}],"responses":{"204":{"description":"External content deleted"},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/repository/{repository}/skills":{"get":{"tags":["skills"],"summary":"Get some skills","description":"Get some skills","operationId":"skillsGET","security":[{"token":[]}],"x-exegesis-controller":"skills","parameters":[{"name":"repository","in":"path","description":"Ref of the repository","required":true,"schema":{"type":"string"},"example":"content-core@cockpitRecette-core"},{"name":"filter","in":"query","schema":{"type":"string"},"description":"name to match skills"},{"name":"refs","in":"query","schema":{"type":"string"},"description":"list of skill references"}],"responses":{"200":{"description":"List of skills","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SkillResponse"}}}}}}},"post":{"tags":["skills"],"summary":"Create a new skills","description":"Create a new skill","operationId":"skillsPOST","security":[{"token":[]}],"x-exegesis-controller":"skills","parameters":[{"name":"repository","in":"path","description":"Ref of the repository","required":true,"schema":{"type":"string"},"example":"content-core@cockpitRecette-core"}],"requestBody":{"description":"given skill","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SkillBodyRequest"}}}},"responses":{"201":{"description":"Created skill","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SkillResponse"}}}},"400":{"description":"Skill on request is does not match with model definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Logged in user is not allowed to create skill on the given repository.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Probably one or several of the skill names already exists in the database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/repository/{repository}/skills/{ref}":{"put":{"tags":["skills"],"summary":"Update a skill","description":"Update a skill","operationId":"skillsPUT","security":[{"token":[]}],"x-exegesis-controller":"skills","parameters":[{"name":"repository","in":"path","description":"Ref of the repository","required":true,"schema":{"type":"string"},"example":"content-core@cockpitRecette-core"},{"name":"ref","in":"path","description":"Ref of the skill","required":true,"schema":{"type":"string"},"example":"skill_001"}],"requestBody":{"description":"given skill","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SkillLocales"}}}},"responses":{"200":{"description":"Updated skill","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SkillResponse"}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Logged in user is not allowed to modify to the given repository skill.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Requested skill does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Probably one or several of the skill names already exists in the database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"tags":["skills"],"summary":"Delete a skill","description":"Delete a skill","operationId":"skillsDELETE","security":[{"token":[]}],"x-exegesis-controller":"skills","parameters":[{"name":"repository","in":"path","description":"Ref of the repository","required":true,"schema":{"type":"string"},"example":"content-core@cockpitRecette-core"},{"name":"ref","in":"path","description":"Ref of the skill","required":true,"schema":{"type":"string"},"example":"skill_001"}],"responses":{"200":{"description":"Deleted skill"},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Logged in user is not allowed to delete the given repository's skill.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/scripts":{"get":{"tags":["scripts"],"summary":"get all script","description":"get all script","operationId":"scriptsGETAll","security":[{"token":[]}],"x-exegesis-controller":"scripts","parameters":[{"name":"videoId","in":"query","required":false,"description":"id of the video","schema":{"type":"string"},"example":"videoId"},{"name":"ref","in":"query","required":false,"description":"Ref of the script","schema":{"type":"string"},"example":"ref_subtitle_01"},{"name":"count","in":"query","schema":{"type":"boolean"}},{"name":"repository","in":"query","description":"search script based on repository","schema":{"type":"string"},"example":"repo@core"},{"name":"skip","in":"query","schema":{"type":"integer"}},{"name":"limit","in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"get a script","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScriptResponse"}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/scripts/video":{"post":{"tags":["scripts"],"summary":"post a script","description":"post a script","operationId":"scriptsPOST","security":[{"token":[]}],"x-exegesis-controller":"scripts","requestBody":{"description":"given script object","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScriptBodyRequest"}}}},"responses":{"201":{"description":"post a script","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScriptResponse"}}}},"400":{"description":"Script on request is not well formatted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Probably one or several of the script names already exists in the database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/scripts/video/{videoId}":{"get":{"tags":["scripts"],"summary":"get a script","description":"get a script","operationId":"scriptsGET","security":[{"token":[]}],"x-exegesis-controller":"scripts","parameters":[{"name":"videoId","in":"path","description":"id of the video","required":true,"schema":{"type":"string"},"example":"videoId"}],"responses":{"200":{"description":"get a script","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScriptResponse"}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Requested script does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"tags":["scripts"],"summary":"Delete a script object","description":"Delete a script","operationId":"scriptsCLEAN","security":[{"token":[]}],"x-exegesis-controller":"scripts","parameters":[{"name":"videoId","in":"path","description":"id of the video","required":true,"schema":{"type":"string"},"example":"videoId"}],"responses":{"200":{"description":"The script for the given videoId was deleted"},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/scripts/video/{videoId}/lang/{lang}":{"put":{"tags":["scripts"],"summary":"update a script","description":"update a script","operationId":"scriptsPUT","security":[{"token":[]}],"x-exegesis-controller":"scripts","parameters":[{"name":"videoId","in":"path","description":"Ref of the media","required":true,"schema":{"type":"string"},"example":"rfnl6OCB"},{"name":"lang","in":"path","required":true,"description":"lang of the scriptUrl","schema":{"type":"string"},"example":"en"}],"requestBody":{"description":"given script url","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScriptBodyRequestPut"}}}},"responses":{"200":{"description":"update a script","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScriptResponse"}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Requested script does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"tags":["scripts"],"summary":"Delete the script information for the given language","description":"Delete the script information for the given language","operationId":"scriptsLangDELETE","security":[{"token":[]}],"x-exegesis-controller":"scripts","parameters":[{"name":"videoId","in":"path","description":"id of the video","required":true,"schema":{"type":"string"},"example":"videoId"},{"name":"lang","in":"path","description":"lang of the locales to delete","required":true,"schema":{"type":"string"},"example":"en"}],"responses":{"200":{"description":"The script updated after cleaning.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScriptResponse"}}}},"204":{"description":"Nothing when no script left for any language after clean."},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Requested script does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/scripts/video/{videoId}/lang/{lang}/upsert":{"post":{"tags":["scripts"],"summary":"Creates a script or updates it if it exists already.","description":"Creates a script or updates it if it exists already.","operationId":"scriptsUPSERT","security":[{"token":[]}],"x-exegesis-controller":"scripts","parameters":[{"name":"videoId","in":"path","description":"jwplayer id of the media","required":true,"schema":{"type":"string"},"example":"rfnl6OCB"},{"name":"lang","in":"path","required":true,"description":"lang of the scriptUrl","schema":{"type":"string"},"example":"en"}],"requestBody":{"description":"given script object","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScriptBodyRequest"}}}},"responses":{"200":{"description":"When the script was already in the database and was updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScriptResponse"}}}},"201":{"description":"When the script is new and was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScriptResponse"}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Requested script does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Probably one or several of the script names already exists in the database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/notifications":{"get":{"tags":["notifications"],"summary":"get all notifications","description":"get all notifications","operationId":"getNotifications","security":[{"token":[]}],"x-exegesis-controller":"notifications","parameters":[{"name":"name","in":"query","required":false,"description":"name of the notification","schema":{"type":"string"},"example":"new_feature"},{"name":"type","in":"query","required":false,"description":"Ref of the notification","schema":{"type":"string","enum":["feature","maintenance","survey"]},"example":"feature"},{"name":"active","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"List of Notifications matching the given conditions","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Notification"}}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"tags":["notifications"],"summary":"Create a new notification","description":"Create a new notification","operationId":"createNotification","security":[{"token":[]}],"x-exegesis-controller":"notifications","requestBody":{"description":"given notification","required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/NotificationBodyRequest"}},"application/json":{"schema":{"$ref":"#/components/schemas/NotificationBodyRequest"}}}},"responses":{"201":{"description":"Created notifications","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Notification"}}}},"400":{"description":"Notification on request is does not match with model definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Probably one or several of the notification names already exists in the database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/notifications/{name}":{"get":{"tags":["notifications"],"summary":"get one notifications","description":"get one notifications by its name","operationId":"getOneNotification","security":[{"token":[]}],"x-exegesis-controller":"notifications","parameters":[{"name":"name","in":"path","required":true,"description":"name of the notification","schema":{"type":"string"},"example":"new_feature"}],"responses":{"200":{"description":"Notification matching with the given conditions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Notification"}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Requested notification does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"tags":["notifications"],"summary":"delete one notifications","description":"delete one notifications by its name","operationId":"deleteNotification","security":[{"token":[]}],"x-exegesis-controller":"notifications","parameters":[{"name":"name","in":"path","required":true,"description":"name of the notification","schema":{"type":"string"},"example":"new_feature"}],"responses":{"200":{"description":"List of Notifications matching the given conditions","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Notification"}}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Requested notification does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"put":{"tags":["notifications"],"summary":"update one notification","description":"update one notification by its name","operationId":"updateNotification","security":[{"token":[]}],"x-exegesis-controller":"notifications","parameters":[{"name":"name","in":"path","required":true,"description":"name of the notification","schema":{"type":"string"},"example":"new_feature"}],"requestBody":{"description":"given notification","required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/NotificationBodyRequestPut"}},"application/json":{"schema":{"$ref":"#/components/schemas/NotificationBodyRequestPut"}}}},"responses":{"200":{"description":"The updated notification","content":{"application/json":{"schema":{"type":"object","items":{"$ref":"#/components/schemas/Notification"}}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Requested notification does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"The notification name already exists in the database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/repository/{repository}/certifications/{ref}":{"get":{"tags":["certifications"],"summary":"find one certification snapshot","description":"get one certification snapshot by its ref & repository","operationId":"findOneCertification","security":[{"token":[]}],"x-exegesis-controller":"certifications","parameters":[{"name":"repository","in":"path","description":"Ref of the repository","required":true,"schema":{"type":"string"},"example":"content-core@cockpitRecette-core"},{"name":"ref","in":"path","description":"Reference of the certification","required":true,"schema":{"type":"string"},"example":"certif_01"}],"responses":{"200":{"description":"Certification matching the given conditions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificationSnapshot"}}}},"400":{"description":"Given data on body request does not match with model definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Requested certification does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/repository/{repository}/certifications/upsert":{"post":{"tags":["certifications"],"summary":"create a certification diff and upsert a snapshot","description":"create a certification diff and upsert a snapshot","operationId":"upsertCertification","security":[{"token":[]}],"x-exegesis-controller":"certifications","requestBody":{"description":"partial certification","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificationDiff"}}}},"parameters":[{"name":"repository","in":"path","description":"Ref of the repository","required":true,"schema":{"type":"string"},"example":"content-core@cockpitRecette-core"}],"responses":{"201":{"description":"certification snapshot","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificationDiff"}}}},"400":{"description":"Given data on body request does not match with model definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/repository/{repository}/certifications":{"get":{"tags":["certifications"],"summary":"Get a list of certifications snapshot","description":"Get a list of certifications snapshot","operationId":"findCertifications","security":[{"token":[]}],"x-exegesis-controller":"certifications","parameters":[{"name":"repository","in":"path","description":"Ref of the repository","required":true,"schema":{"type":"string"},"example":"content-core@cockpitRecette-core"},{"name":"refs","in":"query","schema":{"type":"string"},"description":"list of certifications references, separated by comma"}],"responses":{"200":{"description":"Certifications found","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CertificationSnapshot"}}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/repository/{repository}/certifications/{ref}/undo":{"put":{"tags":["certifications"],"summary":"Revert modification since the last publish","description":"Revert modification since the last publish","operationId":"undoCertificationChange","security":[{"token":[]}],"x-exegesis-controller":"certifications","requestBody":{"description":"partial certification","required":true,"content":{"application/json":{"schema":{"type":"object","example":{"meta":{"modifiedBy":"userId"}}}}}},"parameters":[{"name":"repository","in":"path","description":"Ref of the repository","required":true,"schema":{"type":"string"},"example":"content-core@cockpitRecette-core"},{"name":"ref","in":"path","description":"Reference of the certification","required":true,"schema":{"type":"string"},"example":"cert_kIIm6bPa00"}],"responses":{"200":{"description":"certification matching the given conditions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificationEdition"}}}},"400":{"description":"Given data on body request does not match with model definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Requested certification does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/consommation/repository/{repository}/certifications":{"get":{"tags":["certificationsConsommation"],"summary":"Get a list of certifications","description":"Get a list of certifications","operationId":"findCertificationsConsommation","security":[{"token":[]}],"x-exegesis-controller":"certifications-consommation","parameters":[{"name":"repository","in":"path","description":"Ref of the repository","required":true,"schema":{"type":"string"},"example":"content-digital@cockpitRecette-digital"},{"name":"refs","in":"query","schema":{"type":"string"},"description":"list of certification references, separated by comma"},{"name":"state","in":"query","description":"state of the content","schema":{"type":"string","enum":["published","deleted","archived","draft"]},"example":"published"},{"name":"states","in":"query","description":"list of state of the content","schema":{"type":"string"},"example":"published,archived,deleted"},{"name":"populations","in":"query","schema":{"type":"string"},"description":"list of certification populations, separated by comma","example":"ALL"},{"name":"contentRefs","in":"query","schema":{"type":"string"},"description":"list of certification contentRef (moduleRef, ExternalContentRef, chapter Ref), separated by comma","example":"ALL"},{"name":"count","in":"query","description":"return count of certifications","schema":{"type":"boolean"},"example":"true,false"},{"name":"from","in":"query","description":"first updated date","schema":{"type":"string"},"example":"2023-02-17T10:43:46.538Z"},{"name":"to","in":"query","description":"last updated date","schema":{"type":"string"},"example":"2023-02-17T11:43:46.538Z"},{"name":"sendSvg","in":"query","description":"Boolean to send the svg","schema":{"type":"boolean"},"example":true}],"responses":{"200":{"description":"Certifications found","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CertificationConsommation"}}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/consommation/repository/{repository}/certifications/upsert":{"post":{"tags":["certificationsConsommation"],"summary":"upsert a certification","description":"upsert a certification","operationId":"upsertCertificationConsommation","parameters":[{"name":"repository","in":"path","description":"Ref of the repository","required":true,"schema":{"type":"string"},"example":"content-core@cockpitRecette-core"},{"name":"updateOrder","in":"query","schema":{"type":"boolean"},"description":"boolean indicating that it is a drag and drop upsert"}],"security":[{"token":[]}],"x-exegesis-controller":"certifications-consommation","requestBody":{"description":"Certification","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificationConsommation"}}}},"responses":{"200":{"description":"Updated certification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificationConsommation"}}}},"201":{"description":"Created certification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificationConsommation"}}}},"400":{"description":"Given data on body request does not match with model definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Requested certification does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"The given document with the attributes repository, ref and version already exists in the database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/consommation/repository/{repository}/certifications/count":{"get":{"tags":["certificationsConsommation"],"summary":"Get a count of certifications","description":"Get a count of certifications consommation by state published, archived and draft","operationId":"countCertificationConsommation","security":[{"token":[]}],"x-exegesis-controller":"certifications-consommation","parameters":[{"name":"repository","in":"path","description":"Ref of the repository","required":true,"schema":{"type":"string"},"example":"content-digital@cockpitRecette-digital"}],"responses":{"200":{"description":"Certifications consommation count resumed by state","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ConsommationContentCount"}}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/repository/{repository}/custom-playlists/{ref}":{"get":{"tags":["custom playlists"],"summary":"find one custom playlist snapshot","description":"get one custom playlist snapshot by its ref & repository","operationId":"findOneCustomPlaylist","security":[{"token":[]}],"x-exegesis-controller":"custom-playlists","parameters":[{"name":"repository","in":"path","description":"Ref of the repository","required":true,"schema":{"type":"string"},"example":"content-core@cockpitRecette-core"},{"name":"ref","in":"path","description":"Reference of the custom playlist","required":true,"schema":{"type":"string"},"example":"cplaylist_kIIm6bPa00"}],"responses":{"200":{"description":"custom playlist matching the given conditions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomPlaylistEdition"}}}},"400":{"description":"Given data on body request does not match with model definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Requested custom playlist does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/repository/{repository}/custom-playlists":{"get":{"tags":["custom playlists"],"summary":"Get a list of custom playlists snapshot","description":"Get a list of custom playlists snapshot","operationId":"findCustomPlaylists","security":[{"token":[]}],"x-exegesis-controller":"custom-playlists","parameters":[{"name":"repository","in":"path","description":"Ref of the repository","required":true,"schema":{"type":"string"},"example":"content-core@cockpitRecette-core"},{"name":"refs","in":"query","schema":{"type":"string"},"description":"list of custom playlists references, separated by comma"}],"responses":{"200":{"description":"CustomPlaylists found","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CustomPlaylistEdition"}}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/repository/{repository}/custom-playlists/{ref}/undo":{"put":{"tags":["custom playlists"],"summary":"Revert modification since the last publish","description":"Revert modification since the last publish","operationId":"undoCustomPlaylistChange","security":[{"token":[]}],"x-exegesis-controller":"custom-playlists","requestBody":{"description":"partial custom playlist","required":true,"content":{"application/json":{"schema":{"type":"object","example":{"meta":{"modifiedBy":"userId"}}}}}},"parameters":[{"name":"repository","in":"path","description":"Ref of the repository","required":true,"schema":{"type":"string"},"example":"content-core@cockpitRecette-core"},{"name":"ref","in":"path","description":"Reference of the custom playlist","required":true,"schema":{"type":"string"},"example":"cplaylist_kIIm6bPa00"}],"responses":{"200":{"description":"custom playlist matching the given conditions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomPlaylistEdition"}}}},"400":{"description":"Given data on body request does not match with model definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Requested custom playlist does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/repository/{repository}/custom-playlists/upsert":{"post":{"tags":["custom playlists"],"summary":"create a custom playlist diff and upsert a snapshot","description":"create a custom playlist diff and upsert a snapshot","operationId":"upsertCustomPlaylist","security":[{"token":[]}],"x-exegesis-controller":"custom-playlists","requestBody":{"description":"partial custom playlist","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomPlaylistEdition"}}}},"parameters":[{"name":"repository","in":"path","description":"Ref of the repository","required":true,"schema":{"type":"string"},"example":"content-core@cockpitRecette-core"}],"responses":{"201":{"description":"custom playlist snapshot","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomPlaylistConsommation"}}}},"400":{"description":"Given data on body request does not match with model definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/consommation/repository/{repository}/custom-playlists":{"get":{"tags":["customPlaylistsConsommation"],"summary":"Get a list of custom playlists","description":"Get a list of custom playlists","operationId":"findCustomPlaylistsConsommation","security":[{"token":[]}],"x-exegesis-controller":"custom-playlists-consommation","parameters":[{"name":"repository","in":"path","description":"Ref of the repository","required":true,"schema":{"type":"string"},"example":"content-core@cockpitRecette-core"},{"name":"refs","in":"query","schema":{"type":"string"},"description":"list of custom playlist references, separated by comma"},{"name":"contentRefs","in":"query","schema":{"type":"string"},"description":"customPlaylist should contains almost one of the contentRefs, separated by comma","example":"dis_N12Qn2u8AA"},{"name":"populations","in":"query","schema":{"type":"string"},"description":"list of custom playlist populations, separated by comma","example":"ALL"},{"name":"state","in":"query","description":"state of the content","schema":{"type":"string","enum":["published","deleted","archived","draft"]},"example":"published"},{"name":"states","in":"query","description":"list of state of the content","schema":{"type":"string"},"example":"published,archived,deleted"},{"name":"source","in":"query","description":"source of the request (MOOC or CM)","schema":{"type":"string","enum":["mooc","cm"]}}],"responses":{"200":{"description":"CustomPlaylists found","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CustomPlaylistConsommation"}}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/consommation/repository/{repository}/custom-playlists/upsert":{"post":{"tags":["customPlaylistsConsommation"],"summary":"upsert a custom playlist","description":"upsert a custom playlist","operationId":"upsertCustomPlaylistConsommation","parameters":[{"name":"repository","in":"path","description":"Ref of the repository","required":true,"schema":{"type":"string"},"example":"content-core@cockpitRecette-core"}],"security":[{"token":[]}],"x-exegesis-controller":"custom-playlists-consommation","requestBody":{"description":"Playlist","required":true,"content":{"application/json":{"schema":{"example":{"ref":"cplaylist_kIIm6bPa00","repository":"content-core@cockpitRecette-core","meta":{"updatedAt":"2019-12-13T10:50:42.668Z","modifiedBy":"silouone"},"state":"published"}}}}},"responses":{"200":{"description":"Updated custom playlist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomPlaylistConsommation"}}}},"201":{"description":"Created custom playlist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomPlaylistConsommation"}}}},"400":{"description":"Given data on body request does not match with model definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Requested custom playlist does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"The given document with the attributes repository, ref and version already exists in the database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/consommation/repository/{repository}/custom-playlists/count":{"get":{"tags":["customPlaylistsConsommation"],"summary":"Get count of custom playlists consommation by state","description":"Get count of custom playlists consommation by state published, archived and draft","operationId":"countCustomPlaylistConsommation","security":[{"token":[]}],"x-exegesis-controller":"custom-playlists-consommation","parameters":[{"name":"repository","in":"path","description":"Ref of the repository","required":true,"schema":{"type":"string"},"example":"content-digital@cockpitRecette-digital"}],"responses":{"200":{"description":"Custom playlists consommation count resumed by state","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ConsommationContentCount"}}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/repository/{repository}/bulk-external-contents":{"get":{"tags":["bulkExternalContents"],"summary":"get all bulk external contents","description":"get all bulk external contents","operationId":"bulkExternalContentsGETAll","security":[{"token":[]}],"x-exegesis-controller":"bulk-external-content","parameters":[{"name":"repository","in":"path","required":true,"description":"repository of the bulk external content","schema":{"type":"string"},"example":"content-core@cockpitRecette-core"},{"name":"states","in":"query","required":true,"description":"states of the the bulk external content","schema":{"type":"string"},"example":"pending"},{"name":"withExternalContent","in":"query","required":false,"description":"return external content in the response","schema":{"type":"boolean"}},{"name":"withTotalFailedItems","in":"query","required":false,"description":"return number of failed items in the response","schema":{"type":"boolean"}}],"responses":{"200":{"description":"get all bulk external contents","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkExternalContent"}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/repository/{repository}/bulk-external-contents/{ref}":{"get":{"tags":["bulkExternalContents"],"summary":"get one bulk external content","description":"get one bulk external content","operationId":"bulkExternalContentGET","security":[{"token":[]}],"x-exegesis-controller":"bulk-external-content","parameters":[{"name":"repository","in":"path","required":true,"description":"repository of the bulk external content","schema":{"type":"string"},"example":"content-core@cockpitRecette-core"},{"name":"ref","in":"path","required":true,"description":"ref of the bulk external content","schema":{"type":"string"},"example":"ref1"},{"name":"withExternalContent","in":"query","required":false,"description":"remove external content from the response","schema":{"type":"boolean"}}],"responses":{"200":{"description":"get one bulk external content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkExternalContent"}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"tags":["bulkExternalContents"],"summary":"delete one bulk external content","description":"delete one bulk external content","operationId":"bulkExternalContentDELETE","security":[{"token":[]}],"x-exegesis-controller":"bulk-external-content","parameters":[{"name":"repository","in":"path","required":true,"description":"repository of the bulk external content","schema":{"type":"string"},"example":"content-core@cockpitRecette-core"},{"name":"ref","in":"path","required":true,"description":"ref of the the bulk external content","schema":{"type":"string"},"example":"ref1"}],"responses":{"200":{"description":"delete one bulk external content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkExternalContent"}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/repository/{repository}/bulk-external-contents/{ref}/metadata-report":{"get":{"tags":["bulkExternalContents"],"summary":"Generate metadata report for a bulk external content","description":"Generates a metadata report CSV file for the given bulk external content","operationId":"generateMetadataReport","security":[{"token":[]}],"x-exegesis-controller":"bulk-external-content","parameters":[{"name":"repository","in":"path","required":true,"description":"The repository of the bulk external content","schema":{"type":"string"},"example":"content-core@cockpitRecette-core"},{"name":"ref","in":"path","required":true,"description":"The reference of the bulk external content","schema":{"type":"string"},"example":"ref1"}],"responses":{"200":{"description":"Metadata report generated successfully","content":{"text/csv":{"schema":{"type":"string"}}}},"401":{"description":"User not identified by the server","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/repository/{repository}/bulk-external-contents/upsert":{"post":{"tags":["bulkExternalContents"],"summary":"upsert a bulk external content","description":"upsert a bulk external content","operationId":"bulkExternalContentUPSERT","security":[{"token":[]}],"x-exegesis-controller":"bulk-external-content","parameters":[{"name":"repository","in":"path","required":true,"description":"repository of the bulk external content","schema":{"type":"string"},"example":"content-core@cockpitRecette-core"}],"requestBody":{"description":"bulk external content to be upserted","required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/BulkExternalContentInitialUpsert"},{"$ref":"#/components/schemas/BulkExternalContentUpsert"},{"$ref":"#/components/schemas/BulkExternalContentStateUpsert"}]}}}},"responses":{"200":{"description":"upsert a bulk external content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkExternalContentUpsertResponse"}}}},"400":{"description":"Data sent on body request does not match with model definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/repository/{repository}/custom-skills":{"get":{"tags":["customSkills"],"summary":"Get a list of custom skills snapshot","description":"Get a list of custom skills snapshot","operationId":"findCustomSkillSnapshots","security":[{"token":[]}],"x-exegesis-controller":"custom-skills","parameters":[{"name":"repository","in":"path","description":"Ref of the repository","required":true,"schema":{"type":"string"},"example":"content-core@cockpitRecette-core"},{"name":"state","in":"query","description":"state of the custom skill","schema":{"type":"string"}},{"name":"states","in":"query","description":"list of state of the custom skill","schema":{"type":"string"}},{"name":"ref","in":"query","schema":{"type":"string"},"description":"ref of the custom skill"},{"name":"refs","in":"query","schema":{"type":"string"},"description":"list of custom skills ref, separated by comma"},{"name":"contentRefs","in":"query","schema":{"type":"string"},"description":"refs of the items in the custom skill"}],"responses":{"200":{"description":"CustomSkills found","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CustomSkillEdition"}}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"tags":["customSkills"],"summary":"Upsert a custom skill snapshot","description":"Upsert a custom skill snapshot","operationId":"upsertCustomSkillSnapshot","security":[{"token":[]}],"x-exegesis-controller":"custom-skills","parameters":[{"name":"repository","in":"path","description":"Ref of the repository","required":true,"schema":{"type":"string"},"example":"content-core@cockpitRecette-core"}],"requestBody":{"description":"Custom skill","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomSkillEdition"}}}},"responses":{"200":{"description":"Custom skill snapshot updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomSkillEdition"}}}},"201":{"description":"Custom skill snapshot created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomSkillEdition"}}}},"400":{"description":"Given data on body request does not match with model definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"The given document with the attributes repository, ref and version already exists in the database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/repository/{repository}/custom-skills/{ref}":{"get":{"tags":["customSkills"],"summary":"Get a single custom skill snapshot by ref","description":"Get a single custom skill snapshot by ref","operationId":"findOneCustomSkillSnapshot","security":[{"token":[]}],"x-exegesis-controller":"custom-skills","parameters":[{"name":"repository","in":"path","description":"Ref of the repository","required":true,"schema":{"type":"string"},"example":"content-core@cockpitRecette-core"},{"name":"ref","in":"path","required":true,"schema":{"type":"string"},"description":"ref of the custom skill"}],"responses":{"200":{"description":"CustomSkills found","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CustomSkillEdition"}}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Custom skill snapshot not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomSkillEdition"}}}}}}},"/repository/{repository}/custom-skills/{ref}/undo":{"put":{"tags":["customSkills"],"summary":"Revert modification since the last publish","description":"Revert modification since the last publish","operationId":"undoCustomSkillsChange","security":[{"token":[]}],"x-exegesis-controller":"custom-skills","requestBody":{"description":"partial custom skill","required":true,"content":{"application/json":{"schema":{"type":"object","example":{"meta":{"modifiedBy":"userId"}}}}}},"parameters":[{"name":"repository","in":"path","description":"Ref of the repository","required":true,"schema":{"type":"string"},"example":"content-core@cockpitRecette-core"},{"name":"ref","in":"path","description":"Reference of the custom skill","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"custom skill matching the given conditions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomSkillEdition"}}}},"400":{"description":"Given data on body request does not match with model definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Logged in user is not allowed to modify to the given repository skill.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Requested custom skill does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/consommation/repository/{repository}/custom-skills":{"get":{"tags":["customSkillsConsommation"],"summary":"Get a list of custom skills consommation","description":"Get a list of custom skills consommation","operationId":"findCustomSkillConsommation","security":[{"token":[]}],"x-exegesis-controller":"custom-skills-consommation","parameters":[{"name":"repository","in":"path","description":"Ref of the repository","required":true,"schema":{"type":"string"},"example":"content-core@cockpitRecette-core"},{"name":"state","in":"query","description":"state of the custom skill","schema":{"type":"string"}},{"name":"states","in":"query","description":"states of the custom skills","schema":{"type":"string"}},{"name":"ref","in":"query","schema":{"type":"string"},"description":"ref of the custom skill"},{"name":"refs","in":"query","schema":{"type":"string"},"description":"list of custom skills ref, separated by comma"},{"name":"contentRefs","in":"query","schema":{"type":"string"},"description":"refs of contents in the custom skill"},{"name":"source","in":"query","description":"source of the request (MOOC or CM)","schema":{"type":"string","enum":["mooc","cm"]}},{"name":"custom","in":"query","description":"is the skill coorpacademy or not","schema":{"type":"boolean"}}],"responses":{"200":{"description":"CustomSkills found","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CustomSkillConsommation"}}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Logged in user is not allowed to modify to the given repository skill.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/consommation/repository/{repository}/custom-skills/update":{"post":{"tags":["customSkillsConsommation"],"summary":"Upsert a custom skill consommation","description":"Upsert a custom skill consommation","operationId":"updateCustomSkillConsommation","security":[{"token":[]}],"x-exegesis-controller":"custom-skills-consommation","parameters":[{"name":"repository","in":"path","description":"Ref of the repository","required":true,"schema":{"type":"string"},"example":"content-core@cockpitRecette-core"}],"requestBody":{"description":"Custom skill request Body","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomSkillConsommationBodyUpsert"}}}},"responses":{"200":{"description":"Custom skill consommation updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomSkillConsommation"}}}},"400":{"description":"Given data on body request does not match with model definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Requested custom skill not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomSkillConsommation"}}}}}}},"/consommation/repository/{repository}/custom-skills/count":{"get":{"tags":["customSkillsConsommation"],"summary":"Get a count of custom skills consommation","description":"Get a count of custom skills consommation by state published, archived and draft","operationId":"countCustomSkillConsommation","security":[{"token":[]}],"x-exegesis-controller":"custom-skills-consommation","parameters":[{"name":"repository","in":"path","description":"Ref of the repository","required":true,"schema":{"type":"string"},"example":"content-digital@cockpitRecette-digital"}],"responses":{"200":{"description":"Custom skills consommation count resumed by state","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ConsommationContentCount"}}}}},"401":{"description":"User not identified by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"host":"content.coorpacademy.com"}