openapi.json 350 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164
  1. {
  2. "openapi": "3.0.3",
  3. "info": {
  4. "title": "core",
  5. "version": "0.0.1",
  6. "description": "Core functionality of Nextcloud",
  7. "license": {
  8. "name": "agpl"
  9. }
  10. },
  11. "components": {
  12. "securitySchemes": {
  13. "basic_auth": {
  14. "type": "http",
  15. "scheme": "basic"
  16. },
  17. "bearer_auth": {
  18. "type": "http",
  19. "scheme": "bearer"
  20. }
  21. },
  22. "schemas": {
  23. "AutocompleteResult": {
  24. "type": "object",
  25. "required": [
  26. "id",
  27. "label",
  28. "icon",
  29. "source",
  30. "status",
  31. "subline",
  32. "shareWithDisplayNameUnique"
  33. ],
  34. "properties": {
  35. "id": {
  36. "type": "string"
  37. },
  38. "label": {
  39. "type": "string"
  40. },
  41. "icon": {
  42. "type": "string"
  43. },
  44. "source": {
  45. "type": "string"
  46. },
  47. "status": {
  48. "oneOf": [
  49. {
  50. "type": "object",
  51. "required": [
  52. "status",
  53. "message",
  54. "icon",
  55. "clearAt"
  56. ],
  57. "properties": {
  58. "status": {
  59. "type": "string"
  60. },
  61. "message": {
  62. "type": "string",
  63. "nullable": true
  64. },
  65. "icon": {
  66. "type": "string",
  67. "nullable": true
  68. },
  69. "clearAt": {
  70. "type": "integer",
  71. "format": "int64",
  72. "nullable": true
  73. }
  74. }
  75. },
  76. {
  77. "type": "string"
  78. }
  79. ]
  80. },
  81. "subline": {
  82. "type": "string"
  83. },
  84. "shareWithDisplayNameUnique": {
  85. "type": "string"
  86. }
  87. }
  88. },
  89. "Capabilities": {
  90. "type": "object",
  91. "required": [
  92. "core"
  93. ],
  94. "properties": {
  95. "core": {
  96. "type": "object",
  97. "required": [
  98. "pollinterval",
  99. "webdav-root",
  100. "reference-api",
  101. "reference-regex",
  102. "mod-rewrite-working"
  103. ],
  104. "properties": {
  105. "pollinterval": {
  106. "type": "integer",
  107. "format": "int64"
  108. },
  109. "webdav-root": {
  110. "type": "string"
  111. },
  112. "reference-api": {
  113. "type": "boolean"
  114. },
  115. "reference-regex": {
  116. "type": "string"
  117. },
  118. "mod-rewrite-working": {
  119. "type": "boolean"
  120. }
  121. }
  122. }
  123. }
  124. },
  125. "Collection": {
  126. "type": "object",
  127. "required": [
  128. "id",
  129. "name",
  130. "resources"
  131. ],
  132. "properties": {
  133. "id": {
  134. "type": "integer",
  135. "format": "int64"
  136. },
  137. "name": {
  138. "type": "string"
  139. },
  140. "resources": {
  141. "type": "array",
  142. "items": {
  143. "$ref": "#/components/schemas/Resource"
  144. }
  145. }
  146. }
  147. },
  148. "ContactsAction": {
  149. "type": "object",
  150. "required": [
  151. "title",
  152. "icon",
  153. "hyperlink",
  154. "appId"
  155. ],
  156. "properties": {
  157. "title": {
  158. "type": "string"
  159. },
  160. "icon": {
  161. "type": "string"
  162. },
  163. "hyperlink": {
  164. "type": "string"
  165. },
  166. "appId": {
  167. "type": "string"
  168. }
  169. }
  170. },
  171. "LoginFlowV2": {
  172. "type": "object",
  173. "required": [
  174. "poll",
  175. "login"
  176. ],
  177. "properties": {
  178. "poll": {
  179. "type": "object",
  180. "required": [
  181. "token",
  182. "endpoint"
  183. ],
  184. "properties": {
  185. "token": {
  186. "type": "string"
  187. },
  188. "endpoint": {
  189. "type": "string"
  190. }
  191. }
  192. },
  193. "login": {
  194. "type": "string"
  195. }
  196. }
  197. },
  198. "LoginFlowV2Credentials": {
  199. "type": "object",
  200. "required": [
  201. "server",
  202. "loginName",
  203. "appPassword"
  204. ],
  205. "properties": {
  206. "server": {
  207. "type": "string"
  208. },
  209. "loginName": {
  210. "type": "string"
  211. },
  212. "appPassword": {
  213. "type": "string"
  214. }
  215. }
  216. },
  217. "NavigationEntry": {
  218. "type": "object",
  219. "required": [
  220. "id",
  221. "href",
  222. "icon",
  223. "type",
  224. "name",
  225. "active",
  226. "classes",
  227. "unread"
  228. ],
  229. "properties": {
  230. "id": {
  231. "type": "string"
  232. },
  233. "order": {
  234. "type": "integer",
  235. "format": "int64"
  236. },
  237. "href": {
  238. "type": "string"
  239. },
  240. "icon": {
  241. "type": "string"
  242. },
  243. "type": {
  244. "type": "string"
  245. },
  246. "name": {
  247. "type": "string"
  248. },
  249. "app": {
  250. "type": "string"
  251. },
  252. "default": {
  253. "type": "boolean"
  254. },
  255. "active": {
  256. "type": "boolean"
  257. },
  258. "classes": {
  259. "type": "string"
  260. },
  261. "unread": {
  262. "type": "integer",
  263. "format": "int64"
  264. }
  265. }
  266. },
  267. "OCSMeta": {
  268. "type": "object",
  269. "required": [
  270. "status",
  271. "statuscode"
  272. ],
  273. "properties": {
  274. "status": {
  275. "type": "string"
  276. },
  277. "statuscode": {
  278. "type": "integer"
  279. },
  280. "message": {
  281. "type": "string"
  282. },
  283. "totalitems": {
  284. "type": "string"
  285. },
  286. "itemsperpage": {
  287. "type": "string"
  288. }
  289. }
  290. },
  291. "OpenGraphObject": {
  292. "type": "object",
  293. "required": [
  294. "id",
  295. "name",
  296. "description",
  297. "thumb",
  298. "link"
  299. ],
  300. "properties": {
  301. "id": {
  302. "type": "string"
  303. },
  304. "name": {
  305. "type": "string"
  306. },
  307. "description": {
  308. "type": "string",
  309. "nullable": true
  310. },
  311. "thumb": {
  312. "type": "string",
  313. "nullable": true
  314. },
  315. "link": {
  316. "type": "string"
  317. }
  318. }
  319. },
  320. "PublicCapabilities": {
  321. "type": "object",
  322. "required": [
  323. "bruteforce"
  324. ],
  325. "properties": {
  326. "bruteforce": {
  327. "type": "object",
  328. "required": [
  329. "delay",
  330. "allow-listed"
  331. ],
  332. "properties": {
  333. "delay": {
  334. "type": "integer",
  335. "format": "int64"
  336. },
  337. "allow-listed": {
  338. "type": "boolean"
  339. }
  340. }
  341. }
  342. }
  343. },
  344. "Reference": {
  345. "type": "object",
  346. "required": [
  347. "richObjectType",
  348. "richObject",
  349. "openGraphObject",
  350. "accessible"
  351. ],
  352. "properties": {
  353. "richObjectType": {
  354. "type": "string"
  355. },
  356. "richObject": {
  357. "type": "object",
  358. "additionalProperties": {
  359. "type": "object",
  360. "nullable": true
  361. }
  362. },
  363. "openGraphObject": {
  364. "$ref": "#/components/schemas/OpenGraphObject"
  365. },
  366. "accessible": {
  367. "type": "boolean"
  368. }
  369. }
  370. },
  371. "ReferenceProvider": {
  372. "type": "object",
  373. "required": [
  374. "id",
  375. "title",
  376. "icon_url",
  377. "order",
  378. "search_providers_ids"
  379. ],
  380. "properties": {
  381. "id": {
  382. "type": "string"
  383. },
  384. "title": {
  385. "type": "string"
  386. },
  387. "icon_url": {
  388. "type": "string"
  389. },
  390. "order": {
  391. "type": "integer",
  392. "format": "int64"
  393. },
  394. "search_providers_ids": {
  395. "type": "array",
  396. "nullable": true,
  397. "items": {
  398. "type": "string"
  399. }
  400. }
  401. }
  402. },
  403. "Resource": {
  404. "type": "object",
  405. "required": [
  406. "richObjectType",
  407. "richObject",
  408. "openGraphObject",
  409. "accessible"
  410. ],
  411. "properties": {
  412. "richObjectType": {
  413. "type": "string"
  414. },
  415. "richObject": {
  416. "type": "object",
  417. "additionalProperties": {
  418. "type": "object",
  419. "nullable": true
  420. }
  421. },
  422. "openGraphObject": {
  423. "$ref": "#/components/schemas/OpenGraphObject"
  424. },
  425. "accessible": {
  426. "type": "boolean"
  427. }
  428. }
  429. },
  430. "Status": {
  431. "type": "object",
  432. "required": [
  433. "installed",
  434. "maintenance",
  435. "needsDbUpgrade",
  436. "version",
  437. "versionstring",
  438. "edition",
  439. "productname",
  440. "extendedSupport"
  441. ],
  442. "properties": {
  443. "installed": {
  444. "type": "boolean"
  445. },
  446. "maintenance": {
  447. "type": "boolean"
  448. },
  449. "needsDbUpgrade": {
  450. "type": "boolean"
  451. },
  452. "version": {
  453. "type": "string"
  454. },
  455. "versionstring": {
  456. "type": "string"
  457. },
  458. "edition": {
  459. "type": "string"
  460. },
  461. "productname": {
  462. "type": "string"
  463. },
  464. "extendedSupport": {
  465. "type": "boolean"
  466. }
  467. }
  468. },
  469. "TaskProcessingIO": {
  470. "type": "object",
  471. "additionalProperties": {
  472. "anyOf": [
  473. {
  474. "type": "number"
  475. },
  476. {
  477. "type": "array",
  478. "items": {
  479. "type": "number"
  480. }
  481. },
  482. {
  483. "type": "string"
  484. },
  485. {
  486. "type": "array",
  487. "items": {
  488. "type": "string"
  489. }
  490. }
  491. ]
  492. }
  493. },
  494. "TaskProcessingShape": {
  495. "type": "object",
  496. "required": [
  497. "name",
  498. "description",
  499. "type",
  500. "mandatory"
  501. ],
  502. "properties": {
  503. "name": {
  504. "type": "string"
  505. },
  506. "description": {
  507. "type": "string"
  508. },
  509. "type": {
  510. "type": "string",
  511. "enum": [
  512. "Number",
  513. "Text",
  514. "Audio",
  515. "Image",
  516. "Video",
  517. "File",
  518. "ListOfNumbers",
  519. "ListOfTexts",
  520. "ListOfImages",
  521. "ListOfAudios",
  522. "ListOfVideos",
  523. "ListOfFiles"
  524. ]
  525. },
  526. "mandatory": {
  527. "type": "boolean"
  528. }
  529. }
  530. },
  531. "TaskProcessingTask": {
  532. "type": "object",
  533. "required": [
  534. "id",
  535. "lastUpdated",
  536. "type",
  537. "status",
  538. "userId",
  539. "appId",
  540. "input",
  541. "output",
  542. "customId",
  543. "completionExpectedAt",
  544. "progress"
  545. ],
  546. "properties": {
  547. "id": {
  548. "type": "integer",
  549. "format": "int64"
  550. },
  551. "lastUpdated": {
  552. "type": "integer",
  553. "format": "int64"
  554. },
  555. "type": {
  556. "type": "string"
  557. },
  558. "status": {
  559. "type": "string",
  560. "enum": [
  561. "STATUS_CANCELLED",
  562. "STATUS_FAILED",
  563. "STATUS_SUCCESSFUL",
  564. "STATUS_RUNNING",
  565. "STATUS_SCHEDULED",
  566. "STATUS_UNKNOWN"
  567. ]
  568. },
  569. "userId": {
  570. "type": "string",
  571. "nullable": true
  572. },
  573. "appId": {
  574. "type": "string"
  575. },
  576. "input": {
  577. "$ref": "#/components/schemas/TaskProcessingIO"
  578. },
  579. "output": {
  580. "$ref": "#/components/schemas/TaskProcessingIO",
  581. "nullable": true
  582. },
  583. "customId": {
  584. "type": "string",
  585. "nullable": true
  586. },
  587. "completionExpectedAt": {
  588. "type": "integer",
  589. "format": "int64",
  590. "nullable": true
  591. },
  592. "progress": {
  593. "type": "number",
  594. "format": "double",
  595. "nullable": true
  596. }
  597. }
  598. },
  599. "TaskProcessingTaskType": {
  600. "type": "object",
  601. "required": [
  602. "name",
  603. "description",
  604. "inputShape",
  605. "outputShape"
  606. ],
  607. "properties": {
  608. "name": {
  609. "type": "string"
  610. },
  611. "description": {
  612. "type": "string"
  613. },
  614. "inputShape": {
  615. "type": "array",
  616. "items": {
  617. "$ref": "#/components/schemas/TaskProcessingShape"
  618. }
  619. },
  620. "outputShape": {
  621. "type": "array",
  622. "items": {
  623. "$ref": "#/components/schemas/TaskProcessingShape"
  624. }
  625. }
  626. }
  627. },
  628. "Team": {
  629. "type": "object",
  630. "required": [
  631. "id",
  632. "name",
  633. "icon"
  634. ],
  635. "properties": {
  636. "id": {
  637. "type": "string"
  638. },
  639. "name": {
  640. "type": "string"
  641. },
  642. "icon": {
  643. "type": "string"
  644. }
  645. }
  646. },
  647. "TeamResource": {
  648. "type": "object",
  649. "required": [
  650. "id",
  651. "label",
  652. "url",
  653. "iconSvg",
  654. "iconURL",
  655. "iconEmoji"
  656. ],
  657. "properties": {
  658. "id": {
  659. "type": "integer",
  660. "format": "int64"
  661. },
  662. "label": {
  663. "type": "string"
  664. },
  665. "url": {
  666. "type": "string"
  667. },
  668. "iconSvg": {
  669. "type": "string",
  670. "nullable": true
  671. },
  672. "iconURL": {
  673. "type": "string",
  674. "nullable": true
  675. },
  676. "iconEmoji": {
  677. "type": "string",
  678. "nullable": true
  679. }
  680. }
  681. },
  682. "TextProcessingTask": {
  683. "type": "object",
  684. "required": [
  685. "id",
  686. "type",
  687. "status",
  688. "userId",
  689. "appId",
  690. "input",
  691. "output",
  692. "identifier",
  693. "completionExpectedAt"
  694. ],
  695. "properties": {
  696. "id": {
  697. "type": "integer",
  698. "format": "int64",
  699. "nullable": true
  700. },
  701. "type": {
  702. "type": "string"
  703. },
  704. "status": {
  705. "type": "integer",
  706. "format": "int64",
  707. "enum": [
  708. 0,
  709. 1,
  710. 2,
  711. 3,
  712. 4
  713. ]
  714. },
  715. "userId": {
  716. "type": "string",
  717. "nullable": true
  718. },
  719. "appId": {
  720. "type": "string"
  721. },
  722. "input": {
  723. "type": "string"
  724. },
  725. "output": {
  726. "type": "string",
  727. "nullable": true
  728. },
  729. "identifier": {
  730. "type": "string"
  731. },
  732. "completionExpectedAt": {
  733. "type": "integer",
  734. "format": "int64",
  735. "nullable": true
  736. }
  737. }
  738. },
  739. "TextToImageTask": {
  740. "type": "object",
  741. "required": [
  742. "id",
  743. "status",
  744. "userId",
  745. "appId",
  746. "input",
  747. "identifier",
  748. "numberOfImages",
  749. "completionExpectedAt"
  750. ],
  751. "properties": {
  752. "id": {
  753. "type": "integer",
  754. "format": "int64",
  755. "nullable": true
  756. },
  757. "status": {
  758. "type": "integer",
  759. "format": "int64",
  760. "enum": [
  761. 0,
  762. 1,
  763. 2,
  764. 3,
  765. 4
  766. ]
  767. },
  768. "userId": {
  769. "type": "string",
  770. "nullable": true
  771. },
  772. "appId": {
  773. "type": "string"
  774. },
  775. "input": {
  776. "type": "string"
  777. },
  778. "identifier": {
  779. "type": "string",
  780. "nullable": true
  781. },
  782. "numberOfImages": {
  783. "type": "integer",
  784. "format": "int64"
  785. },
  786. "completionExpectedAt": {
  787. "type": "integer",
  788. "format": "int64",
  789. "nullable": true
  790. }
  791. }
  792. },
  793. "UnifiedSearchProvider": {
  794. "type": "object",
  795. "required": [
  796. "id",
  797. "appId",
  798. "name",
  799. "icon",
  800. "order",
  801. "triggers",
  802. "filters",
  803. "inAppSearch"
  804. ],
  805. "properties": {
  806. "id": {
  807. "type": "string"
  808. },
  809. "appId": {
  810. "type": "string"
  811. },
  812. "name": {
  813. "type": "string"
  814. },
  815. "icon": {
  816. "type": "string"
  817. },
  818. "order": {
  819. "type": "integer",
  820. "format": "int64"
  821. },
  822. "triggers": {
  823. "type": "array",
  824. "items": {
  825. "type": "string"
  826. }
  827. },
  828. "filters": {
  829. "type": "object",
  830. "additionalProperties": {
  831. "type": "string"
  832. }
  833. },
  834. "inAppSearch": {
  835. "type": "boolean"
  836. }
  837. }
  838. },
  839. "UnifiedSearchResult": {
  840. "type": "object",
  841. "required": [
  842. "name",
  843. "isPaginated",
  844. "entries",
  845. "cursor"
  846. ],
  847. "properties": {
  848. "name": {
  849. "type": "string"
  850. },
  851. "isPaginated": {
  852. "type": "boolean"
  853. },
  854. "entries": {
  855. "type": "array",
  856. "items": {
  857. "$ref": "#/components/schemas/UnifiedSearchResultEntry"
  858. }
  859. },
  860. "cursor": {
  861. "nullable": true,
  862. "oneOf": [
  863. {
  864. "type": "integer",
  865. "format": "int64"
  866. },
  867. {
  868. "type": "string"
  869. }
  870. ]
  871. }
  872. }
  873. },
  874. "UnifiedSearchResultEntry": {
  875. "type": "object",
  876. "required": [
  877. "thumbnailUrl",
  878. "title",
  879. "subline",
  880. "resourceUrl",
  881. "icon",
  882. "rounded",
  883. "attributes"
  884. ],
  885. "properties": {
  886. "thumbnailUrl": {
  887. "type": "string"
  888. },
  889. "title": {
  890. "type": "string"
  891. },
  892. "subline": {
  893. "type": "string"
  894. },
  895. "resourceUrl": {
  896. "type": "string"
  897. },
  898. "icon": {
  899. "type": "string"
  900. },
  901. "rounded": {
  902. "type": "boolean"
  903. },
  904. "attributes": {
  905. "type": "array",
  906. "items": {
  907. "type": "string"
  908. }
  909. }
  910. }
  911. }
  912. }
  913. },
  914. "paths": {
  915. "/ocs/v2.php/core/getapppassword": {
  916. "get": {
  917. "operationId": "app_password-get-app-password",
  918. "summary": "Create app password",
  919. "description": "This endpoint requires password confirmation",
  920. "tags": [
  921. "app_password"
  922. ],
  923. "security": [
  924. {
  925. "bearer_auth": []
  926. },
  927. {
  928. "basic_auth": []
  929. }
  930. ],
  931. "parameters": [
  932. {
  933. "name": "OCS-APIRequest",
  934. "in": "header",
  935. "description": "Required to be true for the API request to pass",
  936. "required": true,
  937. "schema": {
  938. "type": "boolean",
  939. "default": true
  940. }
  941. }
  942. ],
  943. "responses": {
  944. "200": {
  945. "description": "App password returned",
  946. "content": {
  947. "application/json": {
  948. "schema": {
  949. "type": "object",
  950. "required": [
  951. "ocs"
  952. ],
  953. "properties": {
  954. "ocs": {
  955. "type": "object",
  956. "required": [
  957. "meta",
  958. "data"
  959. ],
  960. "properties": {
  961. "meta": {
  962. "$ref": "#/components/schemas/OCSMeta"
  963. },
  964. "data": {
  965. "type": "object",
  966. "required": [
  967. "apppassword"
  968. ],
  969. "properties": {
  970. "apppassword": {
  971. "type": "string"
  972. }
  973. }
  974. }
  975. }
  976. }
  977. }
  978. }
  979. }
  980. }
  981. },
  982. "403": {
  983. "description": "Creating app password is not allowed",
  984. "content": {
  985. "application/json": {
  986. "schema": {
  987. "type": "object",
  988. "required": [
  989. "ocs"
  990. ],
  991. "properties": {
  992. "ocs": {
  993. "type": "object",
  994. "required": [
  995. "meta",
  996. "data"
  997. ],
  998. "properties": {
  999. "meta": {
  1000. "$ref": "#/components/schemas/OCSMeta"
  1001. },
  1002. "data": {}
  1003. }
  1004. }
  1005. }
  1006. }
  1007. }
  1008. }
  1009. }
  1010. }
  1011. }
  1012. },
  1013. "/ocs/v2.php/core/apppassword": {
  1014. "delete": {
  1015. "operationId": "app_password-delete-app-password",
  1016. "summary": "Delete app password",
  1017. "tags": [
  1018. "app_password"
  1019. ],
  1020. "security": [
  1021. {
  1022. "bearer_auth": []
  1023. },
  1024. {
  1025. "basic_auth": []
  1026. }
  1027. ],
  1028. "parameters": [
  1029. {
  1030. "name": "OCS-APIRequest",
  1031. "in": "header",
  1032. "description": "Required to be true for the API request to pass",
  1033. "required": true,
  1034. "schema": {
  1035. "type": "boolean",
  1036. "default": true
  1037. }
  1038. }
  1039. ],
  1040. "responses": {
  1041. "200": {
  1042. "description": "App password deleted successfully",
  1043. "content": {
  1044. "application/json": {
  1045. "schema": {
  1046. "type": "object",
  1047. "required": [
  1048. "ocs"
  1049. ],
  1050. "properties": {
  1051. "ocs": {
  1052. "type": "object",
  1053. "required": [
  1054. "meta",
  1055. "data"
  1056. ],
  1057. "properties": {
  1058. "meta": {
  1059. "$ref": "#/components/schemas/OCSMeta"
  1060. },
  1061. "data": {}
  1062. }
  1063. }
  1064. }
  1065. }
  1066. }
  1067. }
  1068. },
  1069. "403": {
  1070. "description": "Deleting app password is not allowed",
  1071. "content": {
  1072. "application/json": {
  1073. "schema": {
  1074. "type": "object",
  1075. "required": [
  1076. "ocs"
  1077. ],
  1078. "properties": {
  1079. "ocs": {
  1080. "type": "object",
  1081. "required": [
  1082. "meta",
  1083. "data"
  1084. ],
  1085. "properties": {
  1086. "meta": {
  1087. "$ref": "#/components/schemas/OCSMeta"
  1088. },
  1089. "data": {}
  1090. }
  1091. }
  1092. }
  1093. }
  1094. }
  1095. }
  1096. }
  1097. }
  1098. }
  1099. },
  1100. "/ocs/v2.php/core/apppassword/rotate": {
  1101. "post": {
  1102. "operationId": "app_password-rotate-app-password",
  1103. "summary": "Rotate app password",
  1104. "tags": [
  1105. "app_password"
  1106. ],
  1107. "security": [
  1108. {
  1109. "bearer_auth": []
  1110. },
  1111. {
  1112. "basic_auth": []
  1113. }
  1114. ],
  1115. "parameters": [
  1116. {
  1117. "name": "OCS-APIRequest",
  1118. "in": "header",
  1119. "description": "Required to be true for the API request to pass",
  1120. "required": true,
  1121. "schema": {
  1122. "type": "boolean",
  1123. "default": true
  1124. }
  1125. }
  1126. ],
  1127. "responses": {
  1128. "200": {
  1129. "description": "App password returned",
  1130. "content": {
  1131. "application/json": {
  1132. "schema": {
  1133. "type": "object",
  1134. "required": [
  1135. "ocs"
  1136. ],
  1137. "properties": {
  1138. "ocs": {
  1139. "type": "object",
  1140. "required": [
  1141. "meta",
  1142. "data"
  1143. ],
  1144. "properties": {
  1145. "meta": {
  1146. "$ref": "#/components/schemas/OCSMeta"
  1147. },
  1148. "data": {
  1149. "type": "object",
  1150. "required": [
  1151. "apppassword"
  1152. ],
  1153. "properties": {
  1154. "apppassword": {
  1155. "type": "string"
  1156. }
  1157. }
  1158. }
  1159. }
  1160. }
  1161. }
  1162. }
  1163. }
  1164. }
  1165. },
  1166. "403": {
  1167. "description": "Rotating app password is not allowed",
  1168. "content": {
  1169. "application/json": {
  1170. "schema": {
  1171. "type": "object",
  1172. "required": [
  1173. "ocs"
  1174. ],
  1175. "properties": {
  1176. "ocs": {
  1177. "type": "object",
  1178. "required": [
  1179. "meta",
  1180. "data"
  1181. ],
  1182. "properties": {
  1183. "meta": {
  1184. "$ref": "#/components/schemas/OCSMeta"
  1185. },
  1186. "data": {}
  1187. }
  1188. }
  1189. }
  1190. }
  1191. }
  1192. }
  1193. }
  1194. }
  1195. }
  1196. },
  1197. "/ocs/v2.php/core/apppassword/confirm": {
  1198. "put": {
  1199. "operationId": "app_password-confirm-user-password",
  1200. "summary": "Confirm the user password",
  1201. "tags": [
  1202. "app_password"
  1203. ],
  1204. "security": [
  1205. {
  1206. "bearer_auth": []
  1207. },
  1208. {
  1209. "basic_auth": []
  1210. }
  1211. ],
  1212. "requestBody": {
  1213. "required": true,
  1214. "content": {
  1215. "application/json": {
  1216. "schema": {
  1217. "type": "object",
  1218. "required": [
  1219. "password"
  1220. ],
  1221. "properties": {
  1222. "password": {
  1223. "type": "string",
  1224. "description": "The password of the user"
  1225. }
  1226. }
  1227. }
  1228. }
  1229. }
  1230. },
  1231. "parameters": [
  1232. {
  1233. "name": "OCS-APIRequest",
  1234. "in": "header",
  1235. "description": "Required to be true for the API request to pass",
  1236. "required": true,
  1237. "schema": {
  1238. "type": "boolean",
  1239. "default": true
  1240. }
  1241. }
  1242. ],
  1243. "responses": {
  1244. "200": {
  1245. "description": "Password confirmation succeeded",
  1246. "content": {
  1247. "application/json": {
  1248. "schema": {
  1249. "type": "object",
  1250. "required": [
  1251. "ocs"
  1252. ],
  1253. "properties": {
  1254. "ocs": {
  1255. "type": "object",
  1256. "required": [
  1257. "meta",
  1258. "data"
  1259. ],
  1260. "properties": {
  1261. "meta": {
  1262. "$ref": "#/components/schemas/OCSMeta"
  1263. },
  1264. "data": {
  1265. "type": "object",
  1266. "required": [
  1267. "lastLogin"
  1268. ],
  1269. "properties": {
  1270. "lastLogin": {
  1271. "type": "integer",
  1272. "format": "int64"
  1273. }
  1274. }
  1275. }
  1276. }
  1277. }
  1278. }
  1279. }
  1280. }
  1281. }
  1282. },
  1283. "403": {
  1284. "description": "Password confirmation failed",
  1285. "content": {
  1286. "application/json": {
  1287. "schema": {
  1288. "type": "object",
  1289. "required": [
  1290. "ocs"
  1291. ],
  1292. "properties": {
  1293. "ocs": {
  1294. "type": "object",
  1295. "required": [
  1296. "meta",
  1297. "data"
  1298. ],
  1299. "properties": {
  1300. "meta": {
  1301. "$ref": "#/components/schemas/OCSMeta"
  1302. },
  1303. "data": {}
  1304. }
  1305. }
  1306. }
  1307. }
  1308. }
  1309. }
  1310. }
  1311. }
  1312. }
  1313. },
  1314. "/ocs/v2.php/core/autocomplete/get": {
  1315. "get": {
  1316. "operationId": "auto_complete-get",
  1317. "summary": "Autocomplete a query",
  1318. "tags": [
  1319. "auto_complete"
  1320. ],
  1321. "security": [
  1322. {
  1323. "bearer_auth": []
  1324. },
  1325. {
  1326. "basic_auth": []
  1327. }
  1328. ],
  1329. "requestBody": {
  1330. "required": true,
  1331. "content": {
  1332. "application/json": {
  1333. "schema": {
  1334. "type": "object",
  1335. "required": [
  1336. "search"
  1337. ],
  1338. "properties": {
  1339. "search": {
  1340. "type": "string",
  1341. "description": "Text to search for"
  1342. },
  1343. "itemType": {
  1344. "type": "string",
  1345. "nullable": true,
  1346. "description": "Type of the items to search for"
  1347. },
  1348. "itemId": {
  1349. "type": "string",
  1350. "nullable": true,
  1351. "description": "ID of the items to search for"
  1352. },
  1353. "sorter": {
  1354. "type": "string",
  1355. "nullable": true,
  1356. "description": "can be piped, top prio first, e.g.: \"commenters|share-recipients\""
  1357. },
  1358. "shareTypes": {
  1359. "type": "array",
  1360. "default": [],
  1361. "description": "Types of shares to search for",
  1362. "items": {
  1363. "type": "integer",
  1364. "format": "int64"
  1365. }
  1366. },
  1367. "limit": {
  1368. "type": "integer",
  1369. "format": "int64",
  1370. "default": 10,
  1371. "description": "Maximum number of results to return"
  1372. }
  1373. }
  1374. }
  1375. }
  1376. }
  1377. },
  1378. "parameters": [
  1379. {
  1380. "name": "OCS-APIRequest",
  1381. "in": "header",
  1382. "description": "Required to be true for the API request to pass",
  1383. "required": true,
  1384. "schema": {
  1385. "type": "boolean",
  1386. "default": true
  1387. }
  1388. }
  1389. ],
  1390. "responses": {
  1391. "200": {
  1392. "description": "Autocomplete results returned",
  1393. "content": {
  1394. "application/json": {
  1395. "schema": {
  1396. "type": "object",
  1397. "required": [
  1398. "ocs"
  1399. ],
  1400. "properties": {
  1401. "ocs": {
  1402. "type": "object",
  1403. "required": [
  1404. "meta",
  1405. "data"
  1406. ],
  1407. "properties": {
  1408. "meta": {
  1409. "$ref": "#/components/schemas/OCSMeta"
  1410. },
  1411. "data": {
  1412. "type": "array",
  1413. "items": {
  1414. "$ref": "#/components/schemas/AutocompleteResult"
  1415. }
  1416. }
  1417. }
  1418. }
  1419. }
  1420. }
  1421. }
  1422. }
  1423. }
  1424. }
  1425. }
  1426. },
  1427. "/ocs/v2.php/collaboration/resources/collections/{collectionId}": {
  1428. "get": {
  1429. "operationId": "collaboration_resources-list-collection",
  1430. "summary": "Get a collection",
  1431. "tags": [
  1432. "collaboration_resources"
  1433. ],
  1434. "security": [
  1435. {
  1436. "bearer_auth": []
  1437. },
  1438. {
  1439. "basic_auth": []
  1440. }
  1441. ],
  1442. "parameters": [
  1443. {
  1444. "name": "collectionId",
  1445. "in": "path",
  1446. "description": "ID of the collection",
  1447. "required": true,
  1448. "schema": {
  1449. "type": "integer",
  1450. "format": "int64"
  1451. }
  1452. },
  1453. {
  1454. "name": "OCS-APIRequest",
  1455. "in": "header",
  1456. "description": "Required to be true for the API request to pass",
  1457. "required": true,
  1458. "schema": {
  1459. "type": "boolean",
  1460. "default": true
  1461. }
  1462. }
  1463. ],
  1464. "responses": {
  1465. "200": {
  1466. "description": "Collection returned",
  1467. "content": {
  1468. "application/json": {
  1469. "schema": {
  1470. "type": "object",
  1471. "required": [
  1472. "ocs"
  1473. ],
  1474. "properties": {
  1475. "ocs": {
  1476. "type": "object",
  1477. "required": [
  1478. "meta",
  1479. "data"
  1480. ],
  1481. "properties": {
  1482. "meta": {
  1483. "$ref": "#/components/schemas/OCSMeta"
  1484. },
  1485. "data": {
  1486. "$ref": "#/components/schemas/Collection"
  1487. }
  1488. }
  1489. }
  1490. }
  1491. }
  1492. }
  1493. }
  1494. },
  1495. "404": {
  1496. "description": "Collection not found",
  1497. "content": {
  1498. "application/json": {
  1499. "schema": {
  1500. "type": "object",
  1501. "required": [
  1502. "ocs"
  1503. ],
  1504. "properties": {
  1505. "ocs": {
  1506. "type": "object",
  1507. "required": [
  1508. "meta",
  1509. "data"
  1510. ],
  1511. "properties": {
  1512. "meta": {
  1513. "$ref": "#/components/schemas/OCSMeta"
  1514. },
  1515. "data": {}
  1516. }
  1517. }
  1518. }
  1519. }
  1520. }
  1521. }
  1522. },
  1523. "500": {
  1524. "description": "",
  1525. "content": {
  1526. "application/json": {
  1527. "schema": {
  1528. "type": "object",
  1529. "required": [
  1530. "ocs"
  1531. ],
  1532. "properties": {
  1533. "ocs": {
  1534. "type": "object",
  1535. "required": [
  1536. "meta",
  1537. "data"
  1538. ],
  1539. "properties": {
  1540. "meta": {
  1541. "$ref": "#/components/schemas/OCSMeta"
  1542. },
  1543. "data": {}
  1544. }
  1545. }
  1546. }
  1547. }
  1548. }
  1549. }
  1550. }
  1551. }
  1552. },
  1553. "post": {
  1554. "operationId": "collaboration_resources-add-resource",
  1555. "summary": "Add a resource to a collection",
  1556. "tags": [
  1557. "collaboration_resources"
  1558. ],
  1559. "security": [
  1560. {
  1561. "bearer_auth": []
  1562. },
  1563. {
  1564. "basic_auth": []
  1565. }
  1566. ],
  1567. "requestBody": {
  1568. "required": true,
  1569. "content": {
  1570. "application/json": {
  1571. "schema": {
  1572. "type": "object",
  1573. "required": [
  1574. "resourceType",
  1575. "resourceId"
  1576. ],
  1577. "properties": {
  1578. "resourceType": {
  1579. "type": "string",
  1580. "description": "Name of the resource"
  1581. },
  1582. "resourceId": {
  1583. "type": "string",
  1584. "description": "ID of the resource"
  1585. }
  1586. }
  1587. }
  1588. }
  1589. }
  1590. },
  1591. "parameters": [
  1592. {
  1593. "name": "collectionId",
  1594. "in": "path",
  1595. "description": "ID of the collection",
  1596. "required": true,
  1597. "schema": {
  1598. "type": "integer",
  1599. "format": "int64"
  1600. }
  1601. },
  1602. {
  1603. "name": "OCS-APIRequest",
  1604. "in": "header",
  1605. "description": "Required to be true for the API request to pass",
  1606. "required": true,
  1607. "schema": {
  1608. "type": "boolean",
  1609. "default": true
  1610. }
  1611. }
  1612. ],
  1613. "responses": {
  1614. "200": {
  1615. "description": "Collection returned",
  1616. "content": {
  1617. "application/json": {
  1618. "schema": {
  1619. "type": "object",
  1620. "required": [
  1621. "ocs"
  1622. ],
  1623. "properties": {
  1624. "ocs": {
  1625. "type": "object",
  1626. "required": [
  1627. "meta",
  1628. "data"
  1629. ],
  1630. "properties": {
  1631. "meta": {
  1632. "$ref": "#/components/schemas/OCSMeta"
  1633. },
  1634. "data": {
  1635. "$ref": "#/components/schemas/Collection"
  1636. }
  1637. }
  1638. }
  1639. }
  1640. }
  1641. }
  1642. }
  1643. },
  1644. "404": {
  1645. "description": "Collection not found or resource inaccessible",
  1646. "content": {
  1647. "application/json": {
  1648. "schema": {
  1649. "type": "object",
  1650. "required": [
  1651. "ocs"
  1652. ],
  1653. "properties": {
  1654. "ocs": {
  1655. "type": "object",
  1656. "required": [
  1657. "meta",
  1658. "data"
  1659. ],
  1660. "properties": {
  1661. "meta": {
  1662. "$ref": "#/components/schemas/OCSMeta"
  1663. },
  1664. "data": {}
  1665. }
  1666. }
  1667. }
  1668. }
  1669. }
  1670. }
  1671. },
  1672. "500": {
  1673. "description": "",
  1674. "content": {
  1675. "application/json": {
  1676. "schema": {
  1677. "type": "object",
  1678. "required": [
  1679. "ocs"
  1680. ],
  1681. "properties": {
  1682. "ocs": {
  1683. "type": "object",
  1684. "required": [
  1685. "meta",
  1686. "data"
  1687. ],
  1688. "properties": {
  1689. "meta": {
  1690. "$ref": "#/components/schemas/OCSMeta"
  1691. },
  1692. "data": {}
  1693. }
  1694. }
  1695. }
  1696. }
  1697. }
  1698. }
  1699. }
  1700. }
  1701. },
  1702. "delete": {
  1703. "operationId": "collaboration_resources-remove-resource",
  1704. "summary": "Remove a resource from a collection",
  1705. "tags": [
  1706. "collaboration_resources"
  1707. ],
  1708. "security": [
  1709. {
  1710. "bearer_auth": []
  1711. },
  1712. {
  1713. "basic_auth": []
  1714. }
  1715. ],
  1716. "requestBody": {
  1717. "required": true,
  1718. "content": {
  1719. "application/json": {
  1720. "schema": {
  1721. "type": "object",
  1722. "required": [
  1723. "resourceType",
  1724. "resourceId"
  1725. ],
  1726. "properties": {
  1727. "resourceType": {
  1728. "type": "string",
  1729. "description": "Name of the resource"
  1730. },
  1731. "resourceId": {
  1732. "type": "string",
  1733. "description": "ID of the resource"
  1734. }
  1735. }
  1736. }
  1737. }
  1738. }
  1739. },
  1740. "parameters": [
  1741. {
  1742. "name": "collectionId",
  1743. "in": "path",
  1744. "description": "ID of the collection",
  1745. "required": true,
  1746. "schema": {
  1747. "type": "integer",
  1748. "format": "int64"
  1749. }
  1750. },
  1751. {
  1752. "name": "OCS-APIRequest",
  1753. "in": "header",
  1754. "description": "Required to be true for the API request to pass",
  1755. "required": true,
  1756. "schema": {
  1757. "type": "boolean",
  1758. "default": true
  1759. }
  1760. }
  1761. ],
  1762. "responses": {
  1763. "200": {
  1764. "description": "Collection returned",
  1765. "content": {
  1766. "application/json": {
  1767. "schema": {
  1768. "type": "object",
  1769. "required": [
  1770. "ocs"
  1771. ],
  1772. "properties": {
  1773. "ocs": {
  1774. "type": "object",
  1775. "required": [
  1776. "meta",
  1777. "data"
  1778. ],
  1779. "properties": {
  1780. "meta": {
  1781. "$ref": "#/components/schemas/OCSMeta"
  1782. },
  1783. "data": {
  1784. "$ref": "#/components/schemas/Collection"
  1785. }
  1786. }
  1787. }
  1788. }
  1789. }
  1790. }
  1791. }
  1792. },
  1793. "404": {
  1794. "description": "Collection or resource not found",
  1795. "content": {
  1796. "application/json": {
  1797. "schema": {
  1798. "type": "object",
  1799. "required": [
  1800. "ocs"
  1801. ],
  1802. "properties": {
  1803. "ocs": {
  1804. "type": "object",
  1805. "required": [
  1806. "meta",
  1807. "data"
  1808. ],
  1809. "properties": {
  1810. "meta": {
  1811. "$ref": "#/components/schemas/OCSMeta"
  1812. },
  1813. "data": {}
  1814. }
  1815. }
  1816. }
  1817. }
  1818. }
  1819. }
  1820. },
  1821. "500": {
  1822. "description": "",
  1823. "content": {
  1824. "application/json": {
  1825. "schema": {
  1826. "type": "object",
  1827. "required": [
  1828. "ocs"
  1829. ],
  1830. "properties": {
  1831. "ocs": {
  1832. "type": "object",
  1833. "required": [
  1834. "meta",
  1835. "data"
  1836. ],
  1837. "properties": {
  1838. "meta": {
  1839. "$ref": "#/components/schemas/OCSMeta"
  1840. },
  1841. "data": {}
  1842. }
  1843. }
  1844. }
  1845. }
  1846. }
  1847. }
  1848. }
  1849. }
  1850. },
  1851. "put": {
  1852. "operationId": "collaboration_resources-rename-collection",
  1853. "summary": "Rename a collection",
  1854. "tags": [
  1855. "collaboration_resources"
  1856. ],
  1857. "security": [
  1858. {
  1859. "bearer_auth": []
  1860. },
  1861. {
  1862. "basic_auth": []
  1863. }
  1864. ],
  1865. "requestBody": {
  1866. "required": true,
  1867. "content": {
  1868. "application/json": {
  1869. "schema": {
  1870. "type": "object",
  1871. "required": [
  1872. "collectionName"
  1873. ],
  1874. "properties": {
  1875. "collectionName": {
  1876. "type": "string",
  1877. "description": "New name"
  1878. }
  1879. }
  1880. }
  1881. }
  1882. }
  1883. },
  1884. "parameters": [
  1885. {
  1886. "name": "collectionId",
  1887. "in": "path",
  1888. "description": "ID of the collection",
  1889. "required": true,
  1890. "schema": {
  1891. "type": "integer",
  1892. "format": "int64"
  1893. }
  1894. },
  1895. {
  1896. "name": "OCS-APIRequest",
  1897. "in": "header",
  1898. "description": "Required to be true for the API request to pass",
  1899. "required": true,
  1900. "schema": {
  1901. "type": "boolean",
  1902. "default": true
  1903. }
  1904. }
  1905. ],
  1906. "responses": {
  1907. "200": {
  1908. "description": "Collection returned",
  1909. "content": {
  1910. "application/json": {
  1911. "schema": {
  1912. "type": "object",
  1913. "required": [
  1914. "ocs"
  1915. ],
  1916. "properties": {
  1917. "ocs": {
  1918. "type": "object",
  1919. "required": [
  1920. "meta",
  1921. "data"
  1922. ],
  1923. "properties": {
  1924. "meta": {
  1925. "$ref": "#/components/schemas/OCSMeta"
  1926. },
  1927. "data": {
  1928. "$ref": "#/components/schemas/Collection"
  1929. }
  1930. }
  1931. }
  1932. }
  1933. }
  1934. }
  1935. }
  1936. },
  1937. "404": {
  1938. "description": "Collection not found",
  1939. "content": {
  1940. "application/json": {
  1941. "schema": {
  1942. "type": "object",
  1943. "required": [
  1944. "ocs"
  1945. ],
  1946. "properties": {
  1947. "ocs": {
  1948. "type": "object",
  1949. "required": [
  1950. "meta",
  1951. "data"
  1952. ],
  1953. "properties": {
  1954. "meta": {
  1955. "$ref": "#/components/schemas/OCSMeta"
  1956. },
  1957. "data": {}
  1958. }
  1959. }
  1960. }
  1961. }
  1962. }
  1963. }
  1964. },
  1965. "500": {
  1966. "description": "",
  1967. "content": {
  1968. "application/json": {
  1969. "schema": {
  1970. "type": "object",
  1971. "required": [
  1972. "ocs"
  1973. ],
  1974. "properties": {
  1975. "ocs": {
  1976. "type": "object",
  1977. "required": [
  1978. "meta",
  1979. "data"
  1980. ],
  1981. "properties": {
  1982. "meta": {
  1983. "$ref": "#/components/schemas/OCSMeta"
  1984. },
  1985. "data": {}
  1986. }
  1987. }
  1988. }
  1989. }
  1990. }
  1991. }
  1992. }
  1993. }
  1994. }
  1995. },
  1996. "/ocs/v2.php/collaboration/resources/collections/search/{filter}": {
  1997. "get": {
  1998. "operationId": "collaboration_resources-search-collections",
  1999. "summary": "Search for collections",
  2000. "tags": [
  2001. "collaboration_resources"
  2002. ],
  2003. "security": [
  2004. {
  2005. "bearer_auth": []
  2006. },
  2007. {
  2008. "basic_auth": []
  2009. }
  2010. ],
  2011. "parameters": [
  2012. {
  2013. "name": "filter",
  2014. "in": "path",
  2015. "description": "Filter collections",
  2016. "required": true,
  2017. "schema": {
  2018. "type": "string"
  2019. }
  2020. },
  2021. {
  2022. "name": "OCS-APIRequest",
  2023. "in": "header",
  2024. "description": "Required to be true for the API request to pass",
  2025. "required": true,
  2026. "schema": {
  2027. "type": "boolean",
  2028. "default": true
  2029. }
  2030. }
  2031. ],
  2032. "responses": {
  2033. "200": {
  2034. "description": "Collections returned",
  2035. "content": {
  2036. "application/json": {
  2037. "schema": {
  2038. "type": "object",
  2039. "required": [
  2040. "ocs"
  2041. ],
  2042. "properties": {
  2043. "ocs": {
  2044. "type": "object",
  2045. "required": [
  2046. "meta",
  2047. "data"
  2048. ],
  2049. "properties": {
  2050. "meta": {
  2051. "$ref": "#/components/schemas/OCSMeta"
  2052. },
  2053. "data": {
  2054. "type": "array",
  2055. "items": {
  2056. "$ref": "#/components/schemas/Collection"
  2057. }
  2058. }
  2059. }
  2060. }
  2061. }
  2062. }
  2063. }
  2064. }
  2065. },
  2066. "404": {
  2067. "description": "Collection not found",
  2068. "content": {
  2069. "application/json": {
  2070. "schema": {
  2071. "type": "object",
  2072. "required": [
  2073. "ocs"
  2074. ],
  2075. "properties": {
  2076. "ocs": {
  2077. "type": "object",
  2078. "required": [
  2079. "meta",
  2080. "data"
  2081. ],
  2082. "properties": {
  2083. "meta": {
  2084. "$ref": "#/components/schemas/OCSMeta"
  2085. },
  2086. "data": {}
  2087. }
  2088. }
  2089. }
  2090. }
  2091. }
  2092. }
  2093. }
  2094. }
  2095. }
  2096. },
  2097. "/ocs/v2.php/collaboration/resources/{resourceType}/{resourceId}": {
  2098. "get": {
  2099. "operationId": "collaboration_resources-get-collections-by-resource",
  2100. "summary": "Get collections by resource",
  2101. "tags": [
  2102. "collaboration_resources"
  2103. ],
  2104. "security": [
  2105. {
  2106. "bearer_auth": []
  2107. },
  2108. {
  2109. "basic_auth": []
  2110. }
  2111. ],
  2112. "parameters": [
  2113. {
  2114. "name": "resourceType",
  2115. "in": "path",
  2116. "description": "Type of the resource",
  2117. "required": true,
  2118. "schema": {
  2119. "type": "string"
  2120. }
  2121. },
  2122. {
  2123. "name": "resourceId",
  2124. "in": "path",
  2125. "description": "ID of the resource",
  2126. "required": true,
  2127. "schema": {
  2128. "type": "string"
  2129. }
  2130. },
  2131. {
  2132. "name": "OCS-APIRequest",
  2133. "in": "header",
  2134. "description": "Required to be true for the API request to pass",
  2135. "required": true,
  2136. "schema": {
  2137. "type": "boolean",
  2138. "default": true
  2139. }
  2140. }
  2141. ],
  2142. "responses": {
  2143. "200": {
  2144. "description": "Collections returned",
  2145. "content": {
  2146. "application/json": {
  2147. "schema": {
  2148. "type": "object",
  2149. "required": [
  2150. "ocs"
  2151. ],
  2152. "properties": {
  2153. "ocs": {
  2154. "type": "object",
  2155. "required": [
  2156. "meta",
  2157. "data"
  2158. ],
  2159. "properties": {
  2160. "meta": {
  2161. "$ref": "#/components/schemas/OCSMeta"
  2162. },
  2163. "data": {
  2164. "type": "array",
  2165. "items": {
  2166. "$ref": "#/components/schemas/Collection"
  2167. }
  2168. }
  2169. }
  2170. }
  2171. }
  2172. }
  2173. }
  2174. }
  2175. },
  2176. "404": {
  2177. "description": "Resource not accessible",
  2178. "content": {
  2179. "application/json": {
  2180. "schema": {
  2181. "type": "object",
  2182. "required": [
  2183. "ocs"
  2184. ],
  2185. "properties": {
  2186. "ocs": {
  2187. "type": "object",
  2188. "required": [
  2189. "meta",
  2190. "data"
  2191. ],
  2192. "properties": {
  2193. "meta": {
  2194. "$ref": "#/components/schemas/OCSMeta"
  2195. },
  2196. "data": {}
  2197. }
  2198. }
  2199. }
  2200. }
  2201. }
  2202. }
  2203. }
  2204. }
  2205. }
  2206. },
  2207. "/ocs/v2.php/collaboration/resources/{baseResourceType}/{baseResourceId}": {
  2208. "post": {
  2209. "operationId": "collaboration_resources-create-collection-on-resource",
  2210. "summary": "Create a collection for a resource",
  2211. "tags": [
  2212. "collaboration_resources"
  2213. ],
  2214. "security": [
  2215. {
  2216. "bearer_auth": []
  2217. },
  2218. {
  2219. "basic_auth": []
  2220. }
  2221. ],
  2222. "requestBody": {
  2223. "required": true,
  2224. "content": {
  2225. "application/json": {
  2226. "schema": {
  2227. "type": "object",
  2228. "required": [
  2229. "name"
  2230. ],
  2231. "properties": {
  2232. "name": {
  2233. "type": "string",
  2234. "description": "Name of the collection"
  2235. }
  2236. }
  2237. }
  2238. }
  2239. }
  2240. },
  2241. "parameters": [
  2242. {
  2243. "name": "baseResourceType",
  2244. "in": "path",
  2245. "description": "Type of the base resource",
  2246. "required": true,
  2247. "schema": {
  2248. "type": "string"
  2249. }
  2250. },
  2251. {
  2252. "name": "baseResourceId",
  2253. "in": "path",
  2254. "description": "ID of the base resource",
  2255. "required": true,
  2256. "schema": {
  2257. "type": "string"
  2258. }
  2259. },
  2260. {
  2261. "name": "OCS-APIRequest",
  2262. "in": "header",
  2263. "description": "Required to be true for the API request to pass",
  2264. "required": true,
  2265. "schema": {
  2266. "type": "boolean",
  2267. "default": true
  2268. }
  2269. }
  2270. ],
  2271. "responses": {
  2272. "200": {
  2273. "description": "Collection returned",
  2274. "content": {
  2275. "application/json": {
  2276. "schema": {
  2277. "type": "object",
  2278. "required": [
  2279. "ocs"
  2280. ],
  2281. "properties": {
  2282. "ocs": {
  2283. "type": "object",
  2284. "required": [
  2285. "meta",
  2286. "data"
  2287. ],
  2288. "properties": {
  2289. "meta": {
  2290. "$ref": "#/components/schemas/OCSMeta"
  2291. },
  2292. "data": {
  2293. "$ref": "#/components/schemas/Collection"
  2294. }
  2295. }
  2296. }
  2297. }
  2298. }
  2299. }
  2300. }
  2301. },
  2302. "400": {
  2303. "description": "Creating collection is not possible",
  2304. "content": {
  2305. "application/json": {
  2306. "schema": {
  2307. "type": "object",
  2308. "required": [
  2309. "ocs"
  2310. ],
  2311. "properties": {
  2312. "ocs": {
  2313. "type": "object",
  2314. "required": [
  2315. "meta",
  2316. "data"
  2317. ],
  2318. "properties": {
  2319. "meta": {
  2320. "$ref": "#/components/schemas/OCSMeta"
  2321. },
  2322. "data": {}
  2323. }
  2324. }
  2325. }
  2326. }
  2327. }
  2328. }
  2329. },
  2330. "404": {
  2331. "description": "Resource inaccessible",
  2332. "content": {
  2333. "application/json": {
  2334. "schema": {
  2335. "type": "object",
  2336. "required": [
  2337. "ocs"
  2338. ],
  2339. "properties": {
  2340. "ocs": {
  2341. "type": "object",
  2342. "required": [
  2343. "meta",
  2344. "data"
  2345. ],
  2346. "properties": {
  2347. "meta": {
  2348. "$ref": "#/components/schemas/OCSMeta"
  2349. },
  2350. "data": {}
  2351. }
  2352. }
  2353. }
  2354. }
  2355. }
  2356. }
  2357. },
  2358. "500": {
  2359. "description": "",
  2360. "content": {
  2361. "application/json": {
  2362. "schema": {
  2363. "type": "object",
  2364. "required": [
  2365. "ocs"
  2366. ],
  2367. "properties": {
  2368. "ocs": {
  2369. "type": "object",
  2370. "required": [
  2371. "meta",
  2372. "data"
  2373. ],
  2374. "properties": {
  2375. "meta": {
  2376. "$ref": "#/components/schemas/OCSMeta"
  2377. },
  2378. "data": {}
  2379. }
  2380. }
  2381. }
  2382. }
  2383. }
  2384. }
  2385. }
  2386. }
  2387. }
  2388. },
  2389. "/ocs/v2.php/hovercard/v1/{userId}": {
  2390. "get": {
  2391. "operationId": "hover_card-get-user",
  2392. "summary": "Get the account details for a hovercard",
  2393. "tags": [
  2394. "hover_card"
  2395. ],
  2396. "security": [
  2397. {
  2398. "bearer_auth": []
  2399. },
  2400. {
  2401. "basic_auth": []
  2402. }
  2403. ],
  2404. "parameters": [
  2405. {
  2406. "name": "userId",
  2407. "in": "path",
  2408. "description": "ID of the user",
  2409. "required": true,
  2410. "schema": {
  2411. "type": "string"
  2412. }
  2413. },
  2414. {
  2415. "name": "OCS-APIRequest",
  2416. "in": "header",
  2417. "description": "Required to be true for the API request to pass",
  2418. "required": true,
  2419. "schema": {
  2420. "type": "boolean",
  2421. "default": true
  2422. }
  2423. }
  2424. ],
  2425. "responses": {
  2426. "200": {
  2427. "description": "Account details returned",
  2428. "content": {
  2429. "application/json": {
  2430. "schema": {
  2431. "type": "object",
  2432. "required": [
  2433. "ocs"
  2434. ],
  2435. "properties": {
  2436. "ocs": {
  2437. "type": "object",
  2438. "required": [
  2439. "meta",
  2440. "data"
  2441. ],
  2442. "properties": {
  2443. "meta": {
  2444. "$ref": "#/components/schemas/OCSMeta"
  2445. },
  2446. "data": {
  2447. "type": "object",
  2448. "required": [
  2449. "userId",
  2450. "displayName",
  2451. "actions"
  2452. ],
  2453. "properties": {
  2454. "userId": {
  2455. "type": "string"
  2456. },
  2457. "displayName": {
  2458. "type": "string"
  2459. },
  2460. "actions": {
  2461. "type": "array",
  2462. "items": {
  2463. "$ref": "#/components/schemas/ContactsAction"
  2464. }
  2465. }
  2466. }
  2467. }
  2468. }
  2469. }
  2470. }
  2471. }
  2472. }
  2473. }
  2474. },
  2475. "404": {
  2476. "description": "Account not found",
  2477. "content": {
  2478. "application/json": {
  2479. "schema": {
  2480. "type": "object",
  2481. "required": [
  2482. "ocs"
  2483. ],
  2484. "properties": {
  2485. "ocs": {
  2486. "type": "object",
  2487. "required": [
  2488. "meta",
  2489. "data"
  2490. ],
  2491. "properties": {
  2492. "meta": {
  2493. "$ref": "#/components/schemas/OCSMeta"
  2494. },
  2495. "data": {}
  2496. }
  2497. }
  2498. }
  2499. }
  2500. }
  2501. }
  2502. }
  2503. }
  2504. }
  2505. },
  2506. "/ocs/v2.php/core/navigation/apps": {
  2507. "get": {
  2508. "operationId": "navigation-get-apps-navigation",
  2509. "summary": "Get the apps navigation",
  2510. "tags": [
  2511. "navigation"
  2512. ],
  2513. "security": [
  2514. {
  2515. "bearer_auth": []
  2516. },
  2517. {
  2518. "basic_auth": []
  2519. }
  2520. ],
  2521. "requestBody": {
  2522. "required": false,
  2523. "content": {
  2524. "application/json": {
  2525. "schema": {
  2526. "type": "object",
  2527. "properties": {
  2528. "absolute": {
  2529. "type": "boolean",
  2530. "default": false,
  2531. "description": "Rewrite URLs to absolute ones"
  2532. }
  2533. }
  2534. }
  2535. }
  2536. }
  2537. },
  2538. "parameters": [
  2539. {
  2540. "name": "OCS-APIRequest",
  2541. "in": "header",
  2542. "description": "Required to be true for the API request to pass",
  2543. "required": true,
  2544. "schema": {
  2545. "type": "boolean",
  2546. "default": true
  2547. }
  2548. }
  2549. ],
  2550. "responses": {
  2551. "200": {
  2552. "description": "Apps navigation returned",
  2553. "content": {
  2554. "application/json": {
  2555. "schema": {
  2556. "type": "object",
  2557. "required": [
  2558. "ocs"
  2559. ],
  2560. "properties": {
  2561. "ocs": {
  2562. "type": "object",
  2563. "required": [
  2564. "meta",
  2565. "data"
  2566. ],
  2567. "properties": {
  2568. "meta": {
  2569. "$ref": "#/components/schemas/OCSMeta"
  2570. },
  2571. "data": {
  2572. "type": "array",
  2573. "items": {
  2574. "$ref": "#/components/schemas/NavigationEntry"
  2575. }
  2576. }
  2577. }
  2578. }
  2579. }
  2580. }
  2581. }
  2582. }
  2583. },
  2584. "304": {
  2585. "description": "No apps navigation changed"
  2586. }
  2587. }
  2588. }
  2589. },
  2590. "/ocs/v2.php/core/navigation/settings": {
  2591. "get": {
  2592. "operationId": "navigation-get-settings-navigation",
  2593. "summary": "Get the settings navigation",
  2594. "tags": [
  2595. "navigation"
  2596. ],
  2597. "security": [
  2598. {
  2599. "bearer_auth": []
  2600. },
  2601. {
  2602. "basic_auth": []
  2603. }
  2604. ],
  2605. "requestBody": {
  2606. "required": false,
  2607. "content": {
  2608. "application/json": {
  2609. "schema": {
  2610. "type": "object",
  2611. "properties": {
  2612. "absolute": {
  2613. "type": "boolean",
  2614. "default": false,
  2615. "description": "Rewrite URLs to absolute ones"
  2616. }
  2617. }
  2618. }
  2619. }
  2620. }
  2621. },
  2622. "parameters": [
  2623. {
  2624. "name": "OCS-APIRequest",
  2625. "in": "header",
  2626. "description": "Required to be true for the API request to pass",
  2627. "required": true,
  2628. "schema": {
  2629. "type": "boolean",
  2630. "default": true
  2631. }
  2632. }
  2633. ],
  2634. "responses": {
  2635. "200": {
  2636. "description": "Apps navigation returned",
  2637. "content": {
  2638. "application/json": {
  2639. "schema": {
  2640. "type": "object",
  2641. "required": [
  2642. "ocs"
  2643. ],
  2644. "properties": {
  2645. "ocs": {
  2646. "type": "object",
  2647. "required": [
  2648. "meta",
  2649. "data"
  2650. ],
  2651. "properties": {
  2652. "meta": {
  2653. "$ref": "#/components/schemas/OCSMeta"
  2654. },
  2655. "data": {
  2656. "type": "array",
  2657. "items": {
  2658. "$ref": "#/components/schemas/NavigationEntry"
  2659. }
  2660. }
  2661. }
  2662. }
  2663. }
  2664. }
  2665. }
  2666. }
  2667. },
  2668. "304": {
  2669. "description": "No apps navigation changed"
  2670. }
  2671. }
  2672. }
  2673. },
  2674. "/ocs/v2.php/cloud/capabilities": {
  2675. "get": {
  2676. "operationId": "ocs-get-capabilities",
  2677. "summary": "Get the capabilities",
  2678. "tags": [
  2679. "ocs"
  2680. ],
  2681. "security": [
  2682. {},
  2683. {
  2684. "bearer_auth": []
  2685. },
  2686. {
  2687. "basic_auth": []
  2688. }
  2689. ],
  2690. "parameters": [
  2691. {
  2692. "name": "OCS-APIRequest",
  2693. "in": "header",
  2694. "description": "Required to be true for the API request to pass",
  2695. "required": true,
  2696. "schema": {
  2697. "type": "boolean",
  2698. "default": true
  2699. }
  2700. }
  2701. ],
  2702. "responses": {
  2703. "200": {
  2704. "description": "Capabilities returned",
  2705. "content": {
  2706. "application/json": {
  2707. "schema": {
  2708. "type": "object",
  2709. "required": [
  2710. "ocs"
  2711. ],
  2712. "properties": {
  2713. "ocs": {
  2714. "type": "object",
  2715. "required": [
  2716. "meta",
  2717. "data"
  2718. ],
  2719. "properties": {
  2720. "meta": {
  2721. "$ref": "#/components/schemas/OCSMeta"
  2722. },
  2723. "data": {
  2724. "type": "object",
  2725. "required": [
  2726. "version",
  2727. "capabilities"
  2728. ],
  2729. "properties": {
  2730. "version": {
  2731. "type": "object",
  2732. "required": [
  2733. "major",
  2734. "minor",
  2735. "micro",
  2736. "string",
  2737. "edition",
  2738. "extendedSupport"
  2739. ],
  2740. "properties": {
  2741. "major": {
  2742. "type": "integer",
  2743. "format": "int64"
  2744. },
  2745. "minor": {
  2746. "type": "integer",
  2747. "format": "int64"
  2748. },
  2749. "micro": {
  2750. "type": "integer",
  2751. "format": "int64"
  2752. },
  2753. "string": {
  2754. "type": "string"
  2755. },
  2756. "edition": {
  2757. "type": "string"
  2758. },
  2759. "extendedSupport": {
  2760. "type": "boolean"
  2761. }
  2762. }
  2763. },
  2764. "capabilities": {
  2765. "type": "object",
  2766. "additionalProperties": {
  2767. "type": "object"
  2768. }
  2769. }
  2770. }
  2771. }
  2772. }
  2773. }
  2774. }
  2775. }
  2776. }
  2777. }
  2778. }
  2779. }
  2780. }
  2781. },
  2782. "/ocs/v2.php/profile/{targetUserId}": {
  2783. "put": {
  2784. "operationId": "profile_api-set-visibility",
  2785. "summary": "Update the visibility of a parameter",
  2786. "description": "This endpoint requires password confirmation",
  2787. "tags": [
  2788. "profile_api"
  2789. ],
  2790. "security": [
  2791. {
  2792. "bearer_auth": []
  2793. },
  2794. {
  2795. "basic_auth": []
  2796. }
  2797. ],
  2798. "requestBody": {
  2799. "required": true,
  2800. "content": {
  2801. "application/json": {
  2802. "schema": {
  2803. "type": "object",
  2804. "required": [
  2805. "paramId",
  2806. "visibility"
  2807. ],
  2808. "properties": {
  2809. "paramId": {
  2810. "type": "string",
  2811. "description": "ID of the parameter"
  2812. },
  2813. "visibility": {
  2814. "type": "string",
  2815. "description": "New visibility"
  2816. }
  2817. }
  2818. }
  2819. }
  2820. }
  2821. },
  2822. "parameters": [
  2823. {
  2824. "name": "targetUserId",
  2825. "in": "path",
  2826. "description": "ID of the user",
  2827. "required": true,
  2828. "schema": {
  2829. "type": "string"
  2830. }
  2831. },
  2832. {
  2833. "name": "OCS-APIRequest",
  2834. "in": "header",
  2835. "description": "Required to be true for the API request to pass",
  2836. "required": true,
  2837. "schema": {
  2838. "type": "boolean",
  2839. "default": true
  2840. }
  2841. }
  2842. ],
  2843. "responses": {
  2844. "200": {
  2845. "description": "Visibility updated successfully",
  2846. "content": {
  2847. "application/json": {
  2848. "schema": {
  2849. "type": "object",
  2850. "required": [
  2851. "ocs"
  2852. ],
  2853. "properties": {
  2854. "ocs": {
  2855. "type": "object",
  2856. "required": [
  2857. "meta",
  2858. "data"
  2859. ],
  2860. "properties": {
  2861. "meta": {
  2862. "$ref": "#/components/schemas/OCSMeta"
  2863. },
  2864. "data": {}
  2865. }
  2866. }
  2867. }
  2868. }
  2869. }
  2870. }
  2871. },
  2872. "400": {
  2873. "description": "Updating visibility is not possible",
  2874. "content": {
  2875. "application/json": {
  2876. "schema": {
  2877. "type": "object",
  2878. "required": [
  2879. "ocs"
  2880. ],
  2881. "properties": {
  2882. "ocs": {
  2883. "type": "object",
  2884. "required": [
  2885. "meta",
  2886. "data"
  2887. ],
  2888. "properties": {
  2889. "meta": {
  2890. "$ref": "#/components/schemas/OCSMeta"
  2891. },
  2892. "data": {}
  2893. }
  2894. }
  2895. }
  2896. }
  2897. }
  2898. }
  2899. },
  2900. "403": {
  2901. "description": "Not allowed to edit other users visibility",
  2902. "content": {
  2903. "application/json": {
  2904. "schema": {
  2905. "type": "object",
  2906. "required": [
  2907. "ocs"
  2908. ],
  2909. "properties": {
  2910. "ocs": {
  2911. "type": "object",
  2912. "required": [
  2913. "meta",
  2914. "data"
  2915. ],
  2916. "properties": {
  2917. "meta": {
  2918. "$ref": "#/components/schemas/OCSMeta"
  2919. },
  2920. "data": {}
  2921. }
  2922. }
  2923. }
  2924. }
  2925. }
  2926. }
  2927. },
  2928. "404": {
  2929. "description": "Account not found",
  2930. "content": {
  2931. "application/json": {
  2932. "schema": {
  2933. "type": "object",
  2934. "required": [
  2935. "ocs"
  2936. ],
  2937. "properties": {
  2938. "ocs": {
  2939. "type": "object",
  2940. "required": [
  2941. "meta",
  2942. "data"
  2943. ],
  2944. "properties": {
  2945. "meta": {
  2946. "$ref": "#/components/schemas/OCSMeta"
  2947. },
  2948. "data": {}
  2949. }
  2950. }
  2951. }
  2952. }
  2953. }
  2954. }
  2955. }
  2956. }
  2957. }
  2958. },
  2959. "/ocs/v2.php/references/extract": {
  2960. "post": {
  2961. "operationId": "reference_api-extract",
  2962. "summary": "Extract references from a text",
  2963. "tags": [
  2964. "reference_api"
  2965. ],
  2966. "security": [
  2967. {
  2968. "bearer_auth": []
  2969. },
  2970. {
  2971. "basic_auth": []
  2972. }
  2973. ],
  2974. "requestBody": {
  2975. "required": true,
  2976. "content": {
  2977. "application/json": {
  2978. "schema": {
  2979. "type": "object",
  2980. "required": [
  2981. "text"
  2982. ],
  2983. "properties": {
  2984. "text": {
  2985. "type": "string",
  2986. "description": "Text to extract from"
  2987. },
  2988. "resolve": {
  2989. "type": "boolean",
  2990. "default": false,
  2991. "description": "Resolve the references"
  2992. },
  2993. "limit": {
  2994. "type": "integer",
  2995. "format": "int64",
  2996. "default": 1,
  2997. "description": "Maximum amount of references to extract"
  2998. }
  2999. }
  3000. }
  3001. }
  3002. }
  3003. },
  3004. "parameters": [
  3005. {
  3006. "name": "OCS-APIRequest",
  3007. "in": "header",
  3008. "description": "Required to be true for the API request to pass",
  3009. "required": true,
  3010. "schema": {
  3011. "type": "boolean",
  3012. "default": true
  3013. }
  3014. }
  3015. ],
  3016. "responses": {
  3017. "200": {
  3018. "description": "References returned",
  3019. "content": {
  3020. "application/json": {
  3021. "schema": {
  3022. "type": "object",
  3023. "required": [
  3024. "ocs"
  3025. ],
  3026. "properties": {
  3027. "ocs": {
  3028. "type": "object",
  3029. "required": [
  3030. "meta",
  3031. "data"
  3032. ],
  3033. "properties": {
  3034. "meta": {
  3035. "$ref": "#/components/schemas/OCSMeta"
  3036. },
  3037. "data": {
  3038. "type": "object",
  3039. "required": [
  3040. "references"
  3041. ],
  3042. "properties": {
  3043. "references": {
  3044. "type": "object",
  3045. "additionalProperties": {
  3046. "$ref": "#/components/schemas/Reference",
  3047. "nullable": true
  3048. }
  3049. }
  3050. }
  3051. }
  3052. }
  3053. }
  3054. }
  3055. }
  3056. }
  3057. }
  3058. }
  3059. }
  3060. }
  3061. },
  3062. "/ocs/v2.php/references/resolve": {
  3063. "get": {
  3064. "operationId": "reference_api-resolve-one",
  3065. "summary": "Resolve a reference",
  3066. "tags": [
  3067. "reference_api"
  3068. ],
  3069. "security": [
  3070. {
  3071. "bearer_auth": []
  3072. },
  3073. {
  3074. "basic_auth": []
  3075. }
  3076. ],
  3077. "requestBody": {
  3078. "required": true,
  3079. "content": {
  3080. "application/json": {
  3081. "schema": {
  3082. "type": "object",
  3083. "required": [
  3084. "reference"
  3085. ],
  3086. "properties": {
  3087. "reference": {
  3088. "type": "string",
  3089. "description": "Reference to resolve"
  3090. }
  3091. }
  3092. }
  3093. }
  3094. }
  3095. },
  3096. "parameters": [
  3097. {
  3098. "name": "OCS-APIRequest",
  3099. "in": "header",
  3100. "description": "Required to be true for the API request to pass",
  3101. "required": true,
  3102. "schema": {
  3103. "type": "boolean",
  3104. "default": true
  3105. }
  3106. }
  3107. ],
  3108. "responses": {
  3109. "200": {
  3110. "description": "Reference returned",
  3111. "content": {
  3112. "application/json": {
  3113. "schema": {
  3114. "type": "object",
  3115. "required": [
  3116. "ocs"
  3117. ],
  3118. "properties": {
  3119. "ocs": {
  3120. "type": "object",
  3121. "required": [
  3122. "meta",
  3123. "data"
  3124. ],
  3125. "properties": {
  3126. "meta": {
  3127. "$ref": "#/components/schemas/OCSMeta"
  3128. },
  3129. "data": {
  3130. "type": "object",
  3131. "required": [
  3132. "references"
  3133. ],
  3134. "properties": {
  3135. "references": {
  3136. "type": "object",
  3137. "additionalProperties": {
  3138. "$ref": "#/components/schemas/Reference",
  3139. "nullable": true
  3140. }
  3141. }
  3142. }
  3143. }
  3144. }
  3145. }
  3146. }
  3147. }
  3148. }
  3149. }
  3150. }
  3151. }
  3152. },
  3153. "post": {
  3154. "operationId": "reference_api-resolve",
  3155. "summary": "Resolve multiple references",
  3156. "tags": [
  3157. "reference_api"
  3158. ],
  3159. "security": [
  3160. {
  3161. "bearer_auth": []
  3162. },
  3163. {
  3164. "basic_auth": []
  3165. }
  3166. ],
  3167. "requestBody": {
  3168. "required": true,
  3169. "content": {
  3170. "application/json": {
  3171. "schema": {
  3172. "type": "object",
  3173. "required": [
  3174. "references"
  3175. ],
  3176. "properties": {
  3177. "references": {
  3178. "type": "array",
  3179. "description": "References to resolve",
  3180. "items": {
  3181. "type": "string"
  3182. }
  3183. },
  3184. "limit": {
  3185. "type": "integer",
  3186. "format": "int64",
  3187. "default": 1,
  3188. "description": "Maximum amount of references to resolve"
  3189. }
  3190. }
  3191. }
  3192. }
  3193. }
  3194. },
  3195. "parameters": [
  3196. {
  3197. "name": "OCS-APIRequest",
  3198. "in": "header",
  3199. "description": "Required to be true for the API request to pass",
  3200. "required": true,
  3201. "schema": {
  3202. "type": "boolean",
  3203. "default": true
  3204. }
  3205. }
  3206. ],
  3207. "responses": {
  3208. "200": {
  3209. "description": "References returned",
  3210. "content": {
  3211. "application/json": {
  3212. "schema": {
  3213. "type": "object",
  3214. "required": [
  3215. "ocs"
  3216. ],
  3217. "properties": {
  3218. "ocs": {
  3219. "type": "object",
  3220. "required": [
  3221. "meta",
  3222. "data"
  3223. ],
  3224. "properties": {
  3225. "meta": {
  3226. "$ref": "#/components/schemas/OCSMeta"
  3227. },
  3228. "data": {
  3229. "type": "object",
  3230. "required": [
  3231. "references"
  3232. ],
  3233. "properties": {
  3234. "references": {
  3235. "type": "object",
  3236. "additionalProperties": {
  3237. "$ref": "#/components/schemas/Reference",
  3238. "nullable": true
  3239. }
  3240. }
  3241. }
  3242. }
  3243. }
  3244. }
  3245. }
  3246. }
  3247. }
  3248. }
  3249. }
  3250. }
  3251. }
  3252. },
  3253. "/ocs/v2.php/references/providers": {
  3254. "get": {
  3255. "operationId": "reference_api-get-providers-info",
  3256. "summary": "Get the providers",
  3257. "tags": [
  3258. "reference_api"
  3259. ],
  3260. "security": [
  3261. {
  3262. "bearer_auth": []
  3263. },
  3264. {
  3265. "basic_auth": []
  3266. }
  3267. ],
  3268. "parameters": [
  3269. {
  3270. "name": "OCS-APIRequest",
  3271. "in": "header",
  3272. "description": "Required to be true for the API request to pass",
  3273. "required": true,
  3274. "schema": {
  3275. "type": "boolean",
  3276. "default": true
  3277. }
  3278. }
  3279. ],
  3280. "responses": {
  3281. "200": {
  3282. "description": "Providers returned",
  3283. "content": {
  3284. "application/json": {
  3285. "schema": {
  3286. "type": "object",
  3287. "required": [
  3288. "ocs"
  3289. ],
  3290. "properties": {
  3291. "ocs": {
  3292. "type": "object",
  3293. "required": [
  3294. "meta",
  3295. "data"
  3296. ],
  3297. "properties": {
  3298. "meta": {
  3299. "$ref": "#/components/schemas/OCSMeta"
  3300. },
  3301. "data": {
  3302. "type": "array",
  3303. "items": {
  3304. "$ref": "#/components/schemas/ReferenceProvider"
  3305. }
  3306. }
  3307. }
  3308. }
  3309. }
  3310. }
  3311. }
  3312. }
  3313. }
  3314. }
  3315. }
  3316. },
  3317. "/ocs/v2.php/references/provider/{providerId}": {
  3318. "put": {
  3319. "operationId": "reference_api-touch-provider",
  3320. "summary": "Touch a provider",
  3321. "tags": [
  3322. "reference_api"
  3323. ],
  3324. "security": [
  3325. {
  3326. "bearer_auth": []
  3327. },
  3328. {
  3329. "basic_auth": []
  3330. }
  3331. ],
  3332. "requestBody": {
  3333. "required": false,
  3334. "content": {
  3335. "application/json": {
  3336. "schema": {
  3337. "type": "object",
  3338. "properties": {
  3339. "timestamp": {
  3340. "type": "integer",
  3341. "format": "int64",
  3342. "nullable": true,
  3343. "description": "Timestamp of the last usage"
  3344. }
  3345. }
  3346. }
  3347. }
  3348. }
  3349. },
  3350. "parameters": [
  3351. {
  3352. "name": "providerId",
  3353. "in": "path",
  3354. "description": "ID of the provider",
  3355. "required": true,
  3356. "schema": {
  3357. "type": "string"
  3358. }
  3359. },
  3360. {
  3361. "name": "OCS-APIRequest",
  3362. "in": "header",
  3363. "description": "Required to be true for the API request to pass",
  3364. "required": true,
  3365. "schema": {
  3366. "type": "boolean",
  3367. "default": true
  3368. }
  3369. }
  3370. ],
  3371. "responses": {
  3372. "200": {
  3373. "description": "Provider touched",
  3374. "content": {
  3375. "application/json": {
  3376. "schema": {
  3377. "type": "object",
  3378. "required": [
  3379. "ocs"
  3380. ],
  3381. "properties": {
  3382. "ocs": {
  3383. "type": "object",
  3384. "required": [
  3385. "meta",
  3386. "data"
  3387. ],
  3388. "properties": {
  3389. "meta": {
  3390. "$ref": "#/components/schemas/OCSMeta"
  3391. },
  3392. "data": {
  3393. "type": "object",
  3394. "required": [
  3395. "success"
  3396. ],
  3397. "properties": {
  3398. "success": {
  3399. "type": "boolean"
  3400. }
  3401. }
  3402. }
  3403. }
  3404. }
  3405. }
  3406. }
  3407. }
  3408. }
  3409. }
  3410. }
  3411. }
  3412. },
  3413. "/ocs/v2.php/taskprocessing/tasktypes": {
  3414. "get": {
  3415. "operationId": "task_processing_api-task-types",
  3416. "summary": "Returns all available TaskProcessing task types",
  3417. "tags": [
  3418. "task_processing_api"
  3419. ],
  3420. "security": [
  3421. {},
  3422. {
  3423. "bearer_auth": []
  3424. },
  3425. {
  3426. "basic_auth": []
  3427. }
  3428. ],
  3429. "parameters": [
  3430. {
  3431. "name": "OCS-APIRequest",
  3432. "in": "header",
  3433. "description": "Required to be true for the API request to pass",
  3434. "required": true,
  3435. "schema": {
  3436. "type": "boolean",
  3437. "default": true
  3438. }
  3439. }
  3440. ],
  3441. "responses": {
  3442. "200": {
  3443. "description": "Task types returned",
  3444. "content": {
  3445. "application/json": {
  3446. "schema": {
  3447. "type": "object",
  3448. "required": [
  3449. "ocs"
  3450. ],
  3451. "properties": {
  3452. "ocs": {
  3453. "type": "object",
  3454. "required": [
  3455. "meta",
  3456. "data"
  3457. ],
  3458. "properties": {
  3459. "meta": {
  3460. "$ref": "#/components/schemas/OCSMeta"
  3461. },
  3462. "data": {
  3463. "type": "object",
  3464. "required": [
  3465. "types"
  3466. ],
  3467. "properties": {
  3468. "types": {
  3469. "type": "object",
  3470. "additionalProperties": {
  3471. "$ref": "#/components/schemas/TaskProcessingTaskType"
  3472. }
  3473. }
  3474. }
  3475. }
  3476. }
  3477. }
  3478. }
  3479. }
  3480. }
  3481. }
  3482. }
  3483. }
  3484. }
  3485. },
  3486. "/ocs/v2.php/taskprocessing/schedule": {
  3487. "post": {
  3488. "operationId": "task_processing_api-schedule",
  3489. "summary": "Schedules a task",
  3490. "tags": [
  3491. "task_processing_api"
  3492. ],
  3493. "security": [
  3494. {},
  3495. {
  3496. "bearer_auth": []
  3497. },
  3498. {
  3499. "basic_auth": []
  3500. }
  3501. ],
  3502. "requestBody": {
  3503. "required": true,
  3504. "content": {
  3505. "application/json": {
  3506. "schema": {
  3507. "type": "object",
  3508. "required": [
  3509. "input",
  3510. "type",
  3511. "appId"
  3512. ],
  3513. "properties": {
  3514. "input": {
  3515. "type": "object",
  3516. "description": "Task's input parameters",
  3517. "additionalProperties": {
  3518. "type": "object"
  3519. }
  3520. },
  3521. "type": {
  3522. "type": "string",
  3523. "description": "Type of the task"
  3524. },
  3525. "appId": {
  3526. "type": "string",
  3527. "description": "ID of the app that will execute the task"
  3528. },
  3529. "customId": {
  3530. "type": "string",
  3531. "default": "",
  3532. "description": "An arbitrary identifier for the task"
  3533. }
  3534. }
  3535. }
  3536. }
  3537. }
  3538. },
  3539. "parameters": [
  3540. {
  3541. "name": "OCS-APIRequest",
  3542. "in": "header",
  3543. "description": "Required to be true for the API request to pass",
  3544. "required": true,
  3545. "schema": {
  3546. "type": "boolean",
  3547. "default": true
  3548. }
  3549. }
  3550. ],
  3551. "responses": {
  3552. "200": {
  3553. "description": "Task scheduled successfully",
  3554. "content": {
  3555. "application/json": {
  3556. "schema": {
  3557. "type": "object",
  3558. "required": [
  3559. "ocs"
  3560. ],
  3561. "properties": {
  3562. "ocs": {
  3563. "type": "object",
  3564. "required": [
  3565. "meta",
  3566. "data"
  3567. ],
  3568. "properties": {
  3569. "meta": {
  3570. "$ref": "#/components/schemas/OCSMeta"
  3571. },
  3572. "data": {
  3573. "type": "object",
  3574. "required": [
  3575. "task"
  3576. ],
  3577. "properties": {
  3578. "task": {
  3579. "$ref": "#/components/schemas/TaskProcessingTask"
  3580. }
  3581. }
  3582. }
  3583. }
  3584. }
  3585. }
  3586. }
  3587. }
  3588. }
  3589. },
  3590. "500": {
  3591. "description": "",
  3592. "content": {
  3593. "application/json": {
  3594. "schema": {
  3595. "type": "object",
  3596. "required": [
  3597. "ocs"
  3598. ],
  3599. "properties": {
  3600. "ocs": {
  3601. "type": "object",
  3602. "required": [
  3603. "meta",
  3604. "data"
  3605. ],
  3606. "properties": {
  3607. "meta": {
  3608. "$ref": "#/components/schemas/OCSMeta"
  3609. },
  3610. "data": {
  3611. "type": "object",
  3612. "required": [
  3613. "message"
  3614. ],
  3615. "properties": {
  3616. "message": {
  3617. "type": "string"
  3618. }
  3619. }
  3620. }
  3621. }
  3622. }
  3623. }
  3624. }
  3625. }
  3626. }
  3627. },
  3628. "400": {
  3629. "description": "Scheduling task is not possible",
  3630. "content": {
  3631. "application/json": {
  3632. "schema": {
  3633. "type": "object",
  3634. "required": [
  3635. "ocs"
  3636. ],
  3637. "properties": {
  3638. "ocs": {
  3639. "type": "object",
  3640. "required": [
  3641. "meta",
  3642. "data"
  3643. ],
  3644. "properties": {
  3645. "meta": {
  3646. "$ref": "#/components/schemas/OCSMeta"
  3647. },
  3648. "data": {
  3649. "type": "object",
  3650. "required": [
  3651. "message"
  3652. ],
  3653. "properties": {
  3654. "message": {
  3655. "type": "string"
  3656. }
  3657. }
  3658. }
  3659. }
  3660. }
  3661. }
  3662. }
  3663. }
  3664. }
  3665. },
  3666. "412": {
  3667. "description": "Scheduling task is not possible",
  3668. "content": {
  3669. "application/json": {
  3670. "schema": {
  3671. "type": "object",
  3672. "required": [
  3673. "ocs"
  3674. ],
  3675. "properties": {
  3676. "ocs": {
  3677. "type": "object",
  3678. "required": [
  3679. "meta",
  3680. "data"
  3681. ],
  3682. "properties": {
  3683. "meta": {
  3684. "$ref": "#/components/schemas/OCSMeta"
  3685. },
  3686. "data": {
  3687. "type": "object",
  3688. "required": [
  3689. "message"
  3690. ],
  3691. "properties": {
  3692. "message": {
  3693. "type": "string"
  3694. }
  3695. }
  3696. }
  3697. }
  3698. }
  3699. }
  3700. }
  3701. }
  3702. }
  3703. },
  3704. "401": {
  3705. "description": "Cannot schedule task because it references files in its input that the user doesn't have access to",
  3706. "content": {
  3707. "application/json": {
  3708. "schema": {
  3709. "type": "object",
  3710. "required": [
  3711. "ocs"
  3712. ],
  3713. "properties": {
  3714. "ocs": {
  3715. "type": "object",
  3716. "required": [
  3717. "meta",
  3718. "data"
  3719. ],
  3720. "properties": {
  3721. "meta": {
  3722. "$ref": "#/components/schemas/OCSMeta"
  3723. },
  3724. "data": {
  3725. "type": "object",
  3726. "required": [
  3727. "message"
  3728. ],
  3729. "properties": {
  3730. "message": {
  3731. "type": "string"
  3732. }
  3733. }
  3734. }
  3735. }
  3736. }
  3737. }
  3738. }
  3739. }
  3740. }
  3741. }
  3742. }
  3743. }
  3744. },
  3745. "/ocs/v2.php/taskprocessing/task/{id}": {
  3746. "get": {
  3747. "operationId": "task_processing_api-get-task",
  3748. "summary": "Gets a task including status and result",
  3749. "description": "Tasks are removed 1 week after receiving their last update",
  3750. "tags": [
  3751. "task_processing_api"
  3752. ],
  3753. "security": [
  3754. {},
  3755. {
  3756. "bearer_auth": []
  3757. },
  3758. {
  3759. "basic_auth": []
  3760. }
  3761. ],
  3762. "parameters": [
  3763. {
  3764. "name": "id",
  3765. "in": "path",
  3766. "description": "The id of the task",
  3767. "required": true,
  3768. "schema": {
  3769. "type": "integer",
  3770. "format": "int64"
  3771. }
  3772. },
  3773. {
  3774. "name": "OCS-APIRequest",
  3775. "in": "header",
  3776. "description": "Required to be true for the API request to pass",
  3777. "required": true,
  3778. "schema": {
  3779. "type": "boolean",
  3780. "default": true
  3781. }
  3782. }
  3783. ],
  3784. "responses": {
  3785. "200": {
  3786. "description": "Task returned",
  3787. "content": {
  3788. "application/json": {
  3789. "schema": {
  3790. "type": "object",
  3791. "required": [
  3792. "ocs"
  3793. ],
  3794. "properties": {
  3795. "ocs": {
  3796. "type": "object",
  3797. "required": [
  3798. "meta",
  3799. "data"
  3800. ],
  3801. "properties": {
  3802. "meta": {
  3803. "$ref": "#/components/schemas/OCSMeta"
  3804. },
  3805. "data": {
  3806. "type": "object",
  3807. "required": [
  3808. "task"
  3809. ],
  3810. "properties": {
  3811. "task": {
  3812. "$ref": "#/components/schemas/TaskProcessingTask"
  3813. }
  3814. }
  3815. }
  3816. }
  3817. }
  3818. }
  3819. }
  3820. }
  3821. }
  3822. },
  3823. "404": {
  3824. "description": "Task not found",
  3825. "content": {
  3826. "application/json": {
  3827. "schema": {
  3828. "type": "object",
  3829. "required": [
  3830. "ocs"
  3831. ],
  3832. "properties": {
  3833. "ocs": {
  3834. "type": "object",
  3835. "required": [
  3836. "meta",
  3837. "data"
  3838. ],
  3839. "properties": {
  3840. "meta": {
  3841. "$ref": "#/components/schemas/OCSMeta"
  3842. },
  3843. "data": {
  3844. "type": "object",
  3845. "required": [
  3846. "message"
  3847. ],
  3848. "properties": {
  3849. "message": {
  3850. "type": "string"
  3851. }
  3852. }
  3853. }
  3854. }
  3855. }
  3856. }
  3857. }
  3858. }
  3859. }
  3860. },
  3861. "500": {
  3862. "description": "",
  3863. "content": {
  3864. "application/json": {
  3865. "schema": {
  3866. "type": "object",
  3867. "required": [
  3868. "ocs"
  3869. ],
  3870. "properties": {
  3871. "ocs": {
  3872. "type": "object",
  3873. "required": [
  3874. "meta",
  3875. "data"
  3876. ],
  3877. "properties": {
  3878. "meta": {
  3879. "$ref": "#/components/schemas/OCSMeta"
  3880. },
  3881. "data": {
  3882. "type": "object",
  3883. "required": [
  3884. "message"
  3885. ],
  3886. "properties": {
  3887. "message": {
  3888. "type": "string"
  3889. }
  3890. }
  3891. }
  3892. }
  3893. }
  3894. }
  3895. }
  3896. }
  3897. }
  3898. }
  3899. }
  3900. },
  3901. "delete": {
  3902. "operationId": "task_processing_api-delete-task",
  3903. "summary": "Deletes a task",
  3904. "tags": [
  3905. "task_processing_api"
  3906. ],
  3907. "security": [
  3908. {
  3909. "bearer_auth": []
  3910. },
  3911. {
  3912. "basic_auth": []
  3913. }
  3914. ],
  3915. "parameters": [
  3916. {
  3917. "name": "id",
  3918. "in": "path",
  3919. "description": "The id of the task",
  3920. "required": true,
  3921. "schema": {
  3922. "type": "integer",
  3923. "format": "int64"
  3924. }
  3925. },
  3926. {
  3927. "name": "OCS-APIRequest",
  3928. "in": "header",
  3929. "description": "Required to be true for the API request to pass",
  3930. "required": true,
  3931. "schema": {
  3932. "type": "boolean",
  3933. "default": true
  3934. }
  3935. }
  3936. ],
  3937. "responses": {
  3938. "200": {
  3939. "description": "Task deleted",
  3940. "content": {
  3941. "application/json": {
  3942. "schema": {
  3943. "type": "object",
  3944. "required": [
  3945. "ocs"
  3946. ],
  3947. "properties": {
  3948. "ocs": {
  3949. "type": "object",
  3950. "required": [
  3951. "meta",
  3952. "data"
  3953. ],
  3954. "properties": {
  3955. "meta": {
  3956. "$ref": "#/components/schemas/OCSMeta"
  3957. },
  3958. "data": {
  3959. "nullable": true
  3960. }
  3961. }
  3962. }
  3963. }
  3964. }
  3965. }
  3966. }
  3967. },
  3968. "500": {
  3969. "description": "",
  3970. "content": {
  3971. "application/json": {
  3972. "schema": {
  3973. "type": "object",
  3974. "required": [
  3975. "ocs"
  3976. ],
  3977. "properties": {
  3978. "ocs": {
  3979. "type": "object",
  3980. "required": [
  3981. "meta",
  3982. "data"
  3983. ],
  3984. "properties": {
  3985. "meta": {
  3986. "$ref": "#/components/schemas/OCSMeta"
  3987. },
  3988. "data": {
  3989. "type": "object",
  3990. "required": [
  3991. "message"
  3992. ],
  3993. "properties": {
  3994. "message": {
  3995. "type": "string"
  3996. }
  3997. }
  3998. }
  3999. }
  4000. }
  4001. }
  4002. }
  4003. }
  4004. }
  4005. }
  4006. }
  4007. }
  4008. },
  4009. "/ocs/v2.php/taskprocessing/tasks/app/{appId}": {
  4010. "get": {
  4011. "operationId": "task_processing_api-list-tasks-by-app",
  4012. "summary": "Returns tasks for the current user filtered by the appId and optional customId",
  4013. "tags": [
  4014. "task_processing_api"
  4015. ],
  4016. "security": [
  4017. {
  4018. "bearer_auth": []
  4019. },
  4020. {
  4021. "basic_auth": []
  4022. }
  4023. ],
  4024. "requestBody": {
  4025. "required": false,
  4026. "content": {
  4027. "application/json": {
  4028. "schema": {
  4029. "type": "object",
  4030. "properties": {
  4031. "customId": {
  4032. "type": "string",
  4033. "nullable": true,
  4034. "description": "An arbitrary identifier for the task"
  4035. }
  4036. }
  4037. }
  4038. }
  4039. }
  4040. },
  4041. "parameters": [
  4042. {
  4043. "name": "appId",
  4044. "in": "path",
  4045. "description": "ID of the app",
  4046. "required": true,
  4047. "schema": {
  4048. "type": "string"
  4049. }
  4050. },
  4051. {
  4052. "name": "OCS-APIRequest",
  4053. "in": "header",
  4054. "description": "Required to be true for the API request to pass",
  4055. "required": true,
  4056. "schema": {
  4057. "type": "boolean",
  4058. "default": true
  4059. }
  4060. }
  4061. ],
  4062. "responses": {
  4063. "200": {
  4064. "description": "Tasks returned",
  4065. "content": {
  4066. "application/json": {
  4067. "schema": {
  4068. "type": "object",
  4069. "required": [
  4070. "ocs"
  4071. ],
  4072. "properties": {
  4073. "ocs": {
  4074. "type": "object",
  4075. "required": [
  4076. "meta",
  4077. "data"
  4078. ],
  4079. "properties": {
  4080. "meta": {
  4081. "$ref": "#/components/schemas/OCSMeta"
  4082. },
  4083. "data": {
  4084. "type": "object",
  4085. "required": [
  4086. "tasks"
  4087. ],
  4088. "properties": {
  4089. "tasks": {
  4090. "type": "array",
  4091. "items": {
  4092. "$ref": "#/components/schemas/TaskProcessingTask"
  4093. }
  4094. }
  4095. }
  4096. }
  4097. }
  4098. }
  4099. }
  4100. }
  4101. }
  4102. }
  4103. },
  4104. "500": {
  4105. "description": "",
  4106. "content": {
  4107. "application/json": {
  4108. "schema": {
  4109. "type": "object",
  4110. "required": [
  4111. "ocs"
  4112. ],
  4113. "properties": {
  4114. "ocs": {
  4115. "type": "object",
  4116. "required": [
  4117. "meta",
  4118. "data"
  4119. ],
  4120. "properties": {
  4121. "meta": {
  4122. "$ref": "#/components/schemas/OCSMeta"
  4123. },
  4124. "data": {
  4125. "type": "object",
  4126. "required": [
  4127. "message"
  4128. ],
  4129. "properties": {
  4130. "message": {
  4131. "type": "string"
  4132. }
  4133. }
  4134. }
  4135. }
  4136. }
  4137. }
  4138. }
  4139. }
  4140. }
  4141. }
  4142. }
  4143. }
  4144. },
  4145. "/ocs/v2.php/taskprocessing/tasks": {
  4146. "get": {
  4147. "operationId": "task_processing_api-list-tasks",
  4148. "summary": "Returns tasks for the current user filtered by the optional taskType and optional customId",
  4149. "tags": [
  4150. "task_processing_api"
  4151. ],
  4152. "security": [
  4153. {
  4154. "bearer_auth": []
  4155. },
  4156. {
  4157. "basic_auth": []
  4158. }
  4159. ],
  4160. "requestBody": {
  4161. "required": false,
  4162. "content": {
  4163. "application/json": {
  4164. "schema": {
  4165. "type": "object",
  4166. "properties": {
  4167. "taskType": {
  4168. "type": "string",
  4169. "nullable": true,
  4170. "description": "The task type to filter by"
  4171. },
  4172. "customId": {
  4173. "type": "string",
  4174. "nullable": true,
  4175. "description": "An arbitrary identifier for the task"
  4176. }
  4177. }
  4178. }
  4179. }
  4180. }
  4181. },
  4182. "parameters": [
  4183. {
  4184. "name": "OCS-APIRequest",
  4185. "in": "header",
  4186. "description": "Required to be true for the API request to pass",
  4187. "required": true,
  4188. "schema": {
  4189. "type": "boolean",
  4190. "default": true
  4191. }
  4192. }
  4193. ],
  4194. "responses": {
  4195. "200": {
  4196. "description": "Tasks returned",
  4197. "content": {
  4198. "application/json": {
  4199. "schema": {
  4200. "type": "object",
  4201. "required": [
  4202. "ocs"
  4203. ],
  4204. "properties": {
  4205. "ocs": {
  4206. "type": "object",
  4207. "required": [
  4208. "meta",
  4209. "data"
  4210. ],
  4211. "properties": {
  4212. "meta": {
  4213. "$ref": "#/components/schemas/OCSMeta"
  4214. },
  4215. "data": {
  4216. "type": "object",
  4217. "required": [
  4218. "tasks"
  4219. ],
  4220. "properties": {
  4221. "tasks": {
  4222. "type": "array",
  4223. "items": {
  4224. "$ref": "#/components/schemas/TaskProcessingTask"
  4225. }
  4226. }
  4227. }
  4228. }
  4229. }
  4230. }
  4231. }
  4232. }
  4233. }
  4234. }
  4235. },
  4236. "500": {
  4237. "description": "",
  4238. "content": {
  4239. "application/json": {
  4240. "schema": {
  4241. "type": "object",
  4242. "required": [
  4243. "ocs"
  4244. ],
  4245. "properties": {
  4246. "ocs": {
  4247. "type": "object",
  4248. "required": [
  4249. "meta",
  4250. "data"
  4251. ],
  4252. "properties": {
  4253. "meta": {
  4254. "$ref": "#/components/schemas/OCSMeta"
  4255. },
  4256. "data": {
  4257. "type": "object",
  4258. "required": [
  4259. "message"
  4260. ],
  4261. "properties": {
  4262. "message": {
  4263. "type": "string"
  4264. }
  4265. }
  4266. }
  4267. }
  4268. }
  4269. }
  4270. }
  4271. }
  4272. }
  4273. }
  4274. }
  4275. }
  4276. },
  4277. "/ocs/v2.php/taskprocessing/tasks/{taskId}/file/{fileId}": {
  4278. "get": {
  4279. "operationId": "task_processing_api-get-file-contents",
  4280. "summary": "Returns the contents of a file referenced in a task",
  4281. "tags": [
  4282. "task_processing_api"
  4283. ],
  4284. "security": [
  4285. {
  4286. "bearer_auth": []
  4287. },
  4288. {
  4289. "basic_auth": []
  4290. }
  4291. ],
  4292. "parameters": [
  4293. {
  4294. "name": "taskId",
  4295. "in": "path",
  4296. "description": "The id of the task",
  4297. "required": true,
  4298. "schema": {
  4299. "type": "integer",
  4300. "format": "int64"
  4301. }
  4302. },
  4303. {
  4304. "name": "fileId",
  4305. "in": "path",
  4306. "description": "The file id of the file to retrieve",
  4307. "required": true,
  4308. "schema": {
  4309. "type": "integer",
  4310. "format": "int64"
  4311. }
  4312. },
  4313. {
  4314. "name": "OCS-APIRequest",
  4315. "in": "header",
  4316. "description": "Required to be true for the API request to pass",
  4317. "required": true,
  4318. "schema": {
  4319. "type": "boolean",
  4320. "default": true
  4321. }
  4322. }
  4323. ],
  4324. "responses": {
  4325. "200": {
  4326. "description": "File content returned",
  4327. "content": {
  4328. "*/*": {
  4329. "schema": {
  4330. "type": "string",
  4331. "format": "binary"
  4332. }
  4333. }
  4334. }
  4335. },
  4336. "500": {
  4337. "description": "",
  4338. "content": {
  4339. "application/json": {
  4340. "schema": {
  4341. "type": "object",
  4342. "required": [
  4343. "ocs"
  4344. ],
  4345. "properties": {
  4346. "ocs": {
  4347. "type": "object",
  4348. "required": [
  4349. "meta",
  4350. "data"
  4351. ],
  4352. "properties": {
  4353. "meta": {
  4354. "$ref": "#/components/schemas/OCSMeta"
  4355. },
  4356. "data": {
  4357. "type": "object",
  4358. "required": [
  4359. "message"
  4360. ],
  4361. "properties": {
  4362. "message": {
  4363. "type": "string"
  4364. }
  4365. }
  4366. }
  4367. }
  4368. }
  4369. }
  4370. }
  4371. }
  4372. }
  4373. },
  4374. "404": {
  4375. "description": "Task or file not found",
  4376. "content": {
  4377. "application/json": {
  4378. "schema": {
  4379. "type": "object",
  4380. "required": [
  4381. "ocs"
  4382. ],
  4383. "properties": {
  4384. "ocs": {
  4385. "type": "object",
  4386. "required": [
  4387. "meta",
  4388. "data"
  4389. ],
  4390. "properties": {
  4391. "meta": {
  4392. "$ref": "#/components/schemas/OCSMeta"
  4393. },
  4394. "data": {
  4395. "type": "object",
  4396. "required": [
  4397. "message"
  4398. ],
  4399. "properties": {
  4400. "message": {
  4401. "type": "string"
  4402. }
  4403. }
  4404. }
  4405. }
  4406. }
  4407. }
  4408. }
  4409. }
  4410. }
  4411. }
  4412. }
  4413. }
  4414. },
  4415. "/ocs/v2.php/taskprocessing/tasks/{taskId}/cancel": {
  4416. "post": {
  4417. "operationId": "task_processing_api-cancel-task",
  4418. "summary": "Cancels a task",
  4419. "tags": [
  4420. "task_processing_api"
  4421. ],
  4422. "security": [
  4423. {
  4424. "bearer_auth": []
  4425. },
  4426. {
  4427. "basic_auth": []
  4428. }
  4429. ],
  4430. "parameters": [
  4431. {
  4432. "name": "taskId",
  4433. "in": "path",
  4434. "description": "The id of the task",
  4435. "required": true,
  4436. "schema": {
  4437. "type": "integer",
  4438. "format": "int64"
  4439. }
  4440. },
  4441. {
  4442. "name": "OCS-APIRequest",
  4443. "in": "header",
  4444. "description": "Required to be true for the API request to pass",
  4445. "required": true,
  4446. "schema": {
  4447. "type": "boolean",
  4448. "default": true
  4449. }
  4450. }
  4451. ],
  4452. "responses": {
  4453. "200": {
  4454. "description": "Task canceled successfully",
  4455. "content": {
  4456. "application/json": {
  4457. "schema": {
  4458. "type": "object",
  4459. "required": [
  4460. "ocs"
  4461. ],
  4462. "properties": {
  4463. "ocs": {
  4464. "type": "object",
  4465. "required": [
  4466. "meta",
  4467. "data"
  4468. ],
  4469. "properties": {
  4470. "meta": {
  4471. "$ref": "#/components/schemas/OCSMeta"
  4472. },
  4473. "data": {
  4474. "type": "object",
  4475. "required": [
  4476. "task"
  4477. ],
  4478. "properties": {
  4479. "task": {
  4480. "$ref": "#/components/schemas/TaskProcessingTask"
  4481. }
  4482. }
  4483. }
  4484. }
  4485. }
  4486. }
  4487. }
  4488. }
  4489. }
  4490. },
  4491. "500": {
  4492. "description": "",
  4493. "content": {
  4494. "application/json": {
  4495. "schema": {
  4496. "type": "object",
  4497. "required": [
  4498. "ocs"
  4499. ],
  4500. "properties": {
  4501. "ocs": {
  4502. "type": "object",
  4503. "required": [
  4504. "meta",
  4505. "data"
  4506. ],
  4507. "properties": {
  4508. "meta": {
  4509. "$ref": "#/components/schemas/OCSMeta"
  4510. },
  4511. "data": {
  4512. "type": "object",
  4513. "required": [
  4514. "message"
  4515. ],
  4516. "properties": {
  4517. "message": {
  4518. "type": "string"
  4519. }
  4520. }
  4521. }
  4522. }
  4523. }
  4524. }
  4525. }
  4526. }
  4527. }
  4528. },
  4529. "404": {
  4530. "description": "Task not found",
  4531. "content": {
  4532. "application/json": {
  4533. "schema": {
  4534. "type": "object",
  4535. "required": [
  4536. "ocs"
  4537. ],
  4538. "properties": {
  4539. "ocs": {
  4540. "type": "object",
  4541. "required": [
  4542. "meta",
  4543. "data"
  4544. ],
  4545. "properties": {
  4546. "meta": {
  4547. "$ref": "#/components/schemas/OCSMeta"
  4548. },
  4549. "data": {
  4550. "type": "object",
  4551. "required": [
  4552. "message"
  4553. ],
  4554. "properties": {
  4555. "message": {
  4556. "type": "string"
  4557. }
  4558. }
  4559. }
  4560. }
  4561. }
  4562. }
  4563. }
  4564. }
  4565. }
  4566. }
  4567. }
  4568. }
  4569. },
  4570. "/ocs/v2.php/teams/{teamId}/resources": {
  4571. "get": {
  4572. "operationId": "teams_api-resolve-one",
  4573. "summary": "Get all resources of a team",
  4574. "tags": [
  4575. "teams_api"
  4576. ],
  4577. "security": [
  4578. {
  4579. "bearer_auth": []
  4580. },
  4581. {
  4582. "basic_auth": []
  4583. }
  4584. ],
  4585. "parameters": [
  4586. {
  4587. "name": "teamId",
  4588. "in": "path",
  4589. "description": "Unique id of the team",
  4590. "required": true,
  4591. "schema": {
  4592. "type": "string"
  4593. }
  4594. },
  4595. {
  4596. "name": "OCS-APIRequest",
  4597. "in": "header",
  4598. "description": "Required to be true for the API request to pass",
  4599. "required": true,
  4600. "schema": {
  4601. "type": "boolean",
  4602. "default": true
  4603. }
  4604. }
  4605. ],
  4606. "responses": {
  4607. "200": {
  4608. "description": "Resources returned",
  4609. "content": {
  4610. "application/json": {
  4611. "schema": {
  4612. "type": "object",
  4613. "required": [
  4614. "ocs"
  4615. ],
  4616. "properties": {
  4617. "ocs": {
  4618. "type": "object",
  4619. "required": [
  4620. "meta",
  4621. "data"
  4622. ],
  4623. "properties": {
  4624. "meta": {
  4625. "$ref": "#/components/schemas/OCSMeta"
  4626. },
  4627. "data": {
  4628. "type": "object",
  4629. "required": [
  4630. "resources"
  4631. ],
  4632. "properties": {
  4633. "resources": {
  4634. "type": "array",
  4635. "items": {
  4636. "$ref": "#/components/schemas/TeamResource"
  4637. }
  4638. }
  4639. }
  4640. }
  4641. }
  4642. }
  4643. }
  4644. }
  4645. }
  4646. }
  4647. }
  4648. }
  4649. }
  4650. },
  4651. "/ocs/v2.php/teams/resources/{providerId}/{resourceId}": {
  4652. "get": {
  4653. "operationId": "teams_api-list-teams",
  4654. "summary": "Get all teams of a resource",
  4655. "tags": [
  4656. "teams_api"
  4657. ],
  4658. "security": [
  4659. {
  4660. "bearer_auth": []
  4661. },
  4662. {
  4663. "basic_auth": []
  4664. }
  4665. ],
  4666. "parameters": [
  4667. {
  4668. "name": "providerId",
  4669. "in": "path",
  4670. "description": "Identifier of the provider (e.g. deck, talk, collectives)",
  4671. "required": true,
  4672. "schema": {
  4673. "type": "string"
  4674. }
  4675. },
  4676. {
  4677. "name": "resourceId",
  4678. "in": "path",
  4679. "description": "Unique id of the resource to list teams for (e.g. deck board id)",
  4680. "required": true,
  4681. "schema": {
  4682. "type": "string"
  4683. }
  4684. },
  4685. {
  4686. "name": "OCS-APIRequest",
  4687. "in": "header",
  4688. "description": "Required to be true for the API request to pass",
  4689. "required": true,
  4690. "schema": {
  4691. "type": "boolean",
  4692. "default": true
  4693. }
  4694. }
  4695. ],
  4696. "responses": {
  4697. "200": {
  4698. "description": "Teams returned",
  4699. "content": {
  4700. "application/json": {
  4701. "schema": {
  4702. "type": "object",
  4703. "required": [
  4704. "ocs"
  4705. ],
  4706. "properties": {
  4707. "ocs": {
  4708. "type": "object",
  4709. "required": [
  4710. "meta",
  4711. "data"
  4712. ],
  4713. "properties": {
  4714. "meta": {
  4715. "$ref": "#/components/schemas/OCSMeta"
  4716. },
  4717. "data": {
  4718. "type": "object",
  4719. "required": [
  4720. "teams"
  4721. ],
  4722. "properties": {
  4723. "teams": {
  4724. "type": "array",
  4725. "items": {
  4726. "$ref": "#/components/schemas/Team"
  4727. }
  4728. }
  4729. }
  4730. }
  4731. }
  4732. }
  4733. }
  4734. }
  4735. }
  4736. }
  4737. }
  4738. }
  4739. }
  4740. },
  4741. "/ocs/v2.php/textprocessing/tasktypes": {
  4742. "get": {
  4743. "operationId": "text_processing_api-task-types",
  4744. "summary": "This endpoint returns all available LanguageModel task types",
  4745. "tags": [
  4746. "text_processing_api"
  4747. ],
  4748. "security": [
  4749. {},
  4750. {
  4751. "bearer_auth": []
  4752. },
  4753. {
  4754. "basic_auth": []
  4755. }
  4756. ],
  4757. "parameters": [
  4758. {
  4759. "name": "OCS-APIRequest",
  4760. "in": "header",
  4761. "description": "Required to be true for the API request to pass",
  4762. "required": true,
  4763. "schema": {
  4764. "type": "boolean",
  4765. "default": true
  4766. }
  4767. }
  4768. ],
  4769. "responses": {
  4770. "200": {
  4771. "description": "Task types returned",
  4772. "content": {
  4773. "application/json": {
  4774. "schema": {
  4775. "type": "object",
  4776. "required": [
  4777. "ocs"
  4778. ],
  4779. "properties": {
  4780. "ocs": {
  4781. "type": "object",
  4782. "required": [
  4783. "meta",
  4784. "data"
  4785. ],
  4786. "properties": {
  4787. "meta": {
  4788. "$ref": "#/components/schemas/OCSMeta"
  4789. },
  4790. "data": {
  4791. "type": "object",
  4792. "required": [
  4793. "types"
  4794. ],
  4795. "properties": {
  4796. "types": {
  4797. "type": "array",
  4798. "items": {
  4799. "type": "object",
  4800. "required": [
  4801. "id",
  4802. "name",
  4803. "description"
  4804. ],
  4805. "properties": {
  4806. "id": {
  4807. "type": "string"
  4808. },
  4809. "name": {
  4810. "type": "string"
  4811. },
  4812. "description": {
  4813. "type": "string"
  4814. }
  4815. }
  4816. }
  4817. }
  4818. }
  4819. }
  4820. }
  4821. }
  4822. }
  4823. }
  4824. }
  4825. }
  4826. }
  4827. }
  4828. }
  4829. },
  4830. "/ocs/v2.php/textprocessing/schedule": {
  4831. "post": {
  4832. "operationId": "text_processing_api-schedule",
  4833. "summary": "This endpoint allows scheduling a language model task",
  4834. "tags": [
  4835. "text_processing_api"
  4836. ],
  4837. "security": [
  4838. {},
  4839. {
  4840. "bearer_auth": []
  4841. },
  4842. {
  4843. "basic_auth": []
  4844. }
  4845. ],
  4846. "requestBody": {
  4847. "required": true,
  4848. "content": {
  4849. "application/json": {
  4850. "schema": {
  4851. "type": "object",
  4852. "required": [
  4853. "input",
  4854. "type",
  4855. "appId"
  4856. ],
  4857. "properties": {
  4858. "input": {
  4859. "type": "string",
  4860. "description": "Input text"
  4861. },
  4862. "type": {
  4863. "type": "string",
  4864. "description": "Type of the task"
  4865. },
  4866. "appId": {
  4867. "type": "string",
  4868. "description": "ID of the app that will execute the task"
  4869. },
  4870. "identifier": {
  4871. "type": "string",
  4872. "default": "",
  4873. "description": "An arbitrary identifier for the task"
  4874. }
  4875. }
  4876. }
  4877. }
  4878. }
  4879. },
  4880. "parameters": [
  4881. {
  4882. "name": "OCS-APIRequest",
  4883. "in": "header",
  4884. "description": "Required to be true for the API request to pass",
  4885. "required": true,
  4886. "schema": {
  4887. "type": "boolean",
  4888. "default": true
  4889. }
  4890. }
  4891. ],
  4892. "responses": {
  4893. "200": {
  4894. "description": "Task scheduled successfully",
  4895. "content": {
  4896. "application/json": {
  4897. "schema": {
  4898. "type": "object",
  4899. "required": [
  4900. "ocs"
  4901. ],
  4902. "properties": {
  4903. "ocs": {
  4904. "type": "object",
  4905. "required": [
  4906. "meta",
  4907. "data"
  4908. ],
  4909. "properties": {
  4910. "meta": {
  4911. "$ref": "#/components/schemas/OCSMeta"
  4912. },
  4913. "data": {
  4914. "type": "object",
  4915. "required": [
  4916. "task"
  4917. ],
  4918. "properties": {
  4919. "task": {
  4920. "$ref": "#/components/schemas/TextProcessingTask"
  4921. }
  4922. }
  4923. }
  4924. }
  4925. }
  4926. }
  4927. }
  4928. }
  4929. }
  4930. },
  4931. "500": {
  4932. "description": "",
  4933. "content": {
  4934. "application/json": {
  4935. "schema": {
  4936. "type": "object",
  4937. "required": [
  4938. "ocs"
  4939. ],
  4940. "properties": {
  4941. "ocs": {
  4942. "type": "object",
  4943. "required": [
  4944. "meta",
  4945. "data"
  4946. ],
  4947. "properties": {
  4948. "meta": {
  4949. "$ref": "#/components/schemas/OCSMeta"
  4950. },
  4951. "data": {
  4952. "type": "object",
  4953. "required": [
  4954. "message"
  4955. ],
  4956. "properties": {
  4957. "message": {
  4958. "type": "string"
  4959. }
  4960. }
  4961. }
  4962. }
  4963. }
  4964. }
  4965. }
  4966. }
  4967. }
  4968. },
  4969. "400": {
  4970. "description": "Scheduling task is not possible",
  4971. "content": {
  4972. "application/json": {
  4973. "schema": {
  4974. "type": "object",
  4975. "required": [
  4976. "ocs"
  4977. ],
  4978. "properties": {
  4979. "ocs": {
  4980. "type": "object",
  4981. "required": [
  4982. "meta",
  4983. "data"
  4984. ],
  4985. "properties": {
  4986. "meta": {
  4987. "$ref": "#/components/schemas/OCSMeta"
  4988. },
  4989. "data": {
  4990. "type": "object",
  4991. "required": [
  4992. "message"
  4993. ],
  4994. "properties": {
  4995. "message": {
  4996. "type": "string"
  4997. }
  4998. }
  4999. }
  5000. }
  5001. }
  5002. }
  5003. }
  5004. }
  5005. }
  5006. },
  5007. "412": {
  5008. "description": "Scheduling task is not possible",
  5009. "content": {
  5010. "application/json": {
  5011. "schema": {
  5012. "type": "object",
  5013. "required": [
  5014. "ocs"
  5015. ],
  5016. "properties": {
  5017. "ocs": {
  5018. "type": "object",
  5019. "required": [
  5020. "meta",
  5021. "data"
  5022. ],
  5023. "properties": {
  5024. "meta": {
  5025. "$ref": "#/components/schemas/OCSMeta"
  5026. },
  5027. "data": {
  5028. "type": "object",
  5029. "required": [
  5030. "message"
  5031. ],
  5032. "properties": {
  5033. "message": {
  5034. "type": "string"
  5035. }
  5036. }
  5037. }
  5038. }
  5039. }
  5040. }
  5041. }
  5042. }
  5043. }
  5044. }
  5045. }
  5046. }
  5047. },
  5048. "/ocs/v2.php/textprocessing/task/{id}": {
  5049. "get": {
  5050. "operationId": "text_processing_api-get-task",
  5051. "summary": "This endpoint allows checking the status and results of a task. Tasks are removed 1 week after receiving their last update.",
  5052. "tags": [
  5053. "text_processing_api"
  5054. ],
  5055. "security": [
  5056. {},
  5057. {
  5058. "bearer_auth": []
  5059. },
  5060. {
  5061. "basic_auth": []
  5062. }
  5063. ],
  5064. "parameters": [
  5065. {
  5066. "name": "id",
  5067. "in": "path",
  5068. "description": "The id of the task",
  5069. "required": true,
  5070. "schema": {
  5071. "type": "integer",
  5072. "format": "int64"
  5073. }
  5074. },
  5075. {
  5076. "name": "OCS-APIRequest",
  5077. "in": "header",
  5078. "description": "Required to be true for the API request to pass",
  5079. "required": true,
  5080. "schema": {
  5081. "type": "boolean",
  5082. "default": true
  5083. }
  5084. }
  5085. ],
  5086. "responses": {
  5087. "200": {
  5088. "description": "Task returned",
  5089. "content": {
  5090. "application/json": {
  5091. "schema": {
  5092. "type": "object",
  5093. "required": [
  5094. "ocs"
  5095. ],
  5096. "properties": {
  5097. "ocs": {
  5098. "type": "object",
  5099. "required": [
  5100. "meta",
  5101. "data"
  5102. ],
  5103. "properties": {
  5104. "meta": {
  5105. "$ref": "#/components/schemas/OCSMeta"
  5106. },
  5107. "data": {
  5108. "type": "object",
  5109. "required": [
  5110. "task"
  5111. ],
  5112. "properties": {
  5113. "task": {
  5114. "$ref": "#/components/schemas/TextProcessingTask"
  5115. }
  5116. }
  5117. }
  5118. }
  5119. }
  5120. }
  5121. }
  5122. }
  5123. }
  5124. },
  5125. "404": {
  5126. "description": "Task not found",
  5127. "content": {
  5128. "application/json": {
  5129. "schema": {
  5130. "type": "object",
  5131. "required": [
  5132. "ocs"
  5133. ],
  5134. "properties": {
  5135. "ocs": {
  5136. "type": "object",
  5137. "required": [
  5138. "meta",
  5139. "data"
  5140. ],
  5141. "properties": {
  5142. "meta": {
  5143. "$ref": "#/components/schemas/OCSMeta"
  5144. },
  5145. "data": {
  5146. "type": "object",
  5147. "required": [
  5148. "message"
  5149. ],
  5150. "properties": {
  5151. "message": {
  5152. "type": "string"
  5153. }
  5154. }
  5155. }
  5156. }
  5157. }
  5158. }
  5159. }
  5160. }
  5161. }
  5162. },
  5163. "500": {
  5164. "description": "",
  5165. "content": {
  5166. "application/json": {
  5167. "schema": {
  5168. "type": "object",
  5169. "required": [
  5170. "ocs"
  5171. ],
  5172. "properties": {
  5173. "ocs": {
  5174. "type": "object",
  5175. "required": [
  5176. "meta",
  5177. "data"
  5178. ],
  5179. "properties": {
  5180. "meta": {
  5181. "$ref": "#/components/schemas/OCSMeta"
  5182. },
  5183. "data": {
  5184. "type": "object",
  5185. "required": [
  5186. "message"
  5187. ],
  5188. "properties": {
  5189. "message": {
  5190. "type": "string"
  5191. }
  5192. }
  5193. }
  5194. }
  5195. }
  5196. }
  5197. }
  5198. }
  5199. }
  5200. }
  5201. }
  5202. },
  5203. "delete": {
  5204. "operationId": "text_processing_api-delete-task",
  5205. "summary": "This endpoint allows to delete a scheduled task for a user",
  5206. "tags": [
  5207. "text_processing_api"
  5208. ],
  5209. "security": [
  5210. {
  5211. "bearer_auth": []
  5212. },
  5213. {
  5214. "basic_auth": []
  5215. }
  5216. ],
  5217. "parameters": [
  5218. {
  5219. "name": "id",
  5220. "in": "path",
  5221. "description": "The id of the task",
  5222. "required": true,
  5223. "schema": {
  5224. "type": "integer",
  5225. "format": "int64"
  5226. }
  5227. },
  5228. {
  5229. "name": "OCS-APIRequest",
  5230. "in": "header",
  5231. "description": "Required to be true for the API request to pass",
  5232. "required": true,
  5233. "schema": {
  5234. "type": "boolean",
  5235. "default": true
  5236. }
  5237. }
  5238. ],
  5239. "responses": {
  5240. "200": {
  5241. "description": "Task returned",
  5242. "content": {
  5243. "application/json": {
  5244. "schema": {
  5245. "type": "object",
  5246. "required": [
  5247. "ocs"
  5248. ],
  5249. "properties": {
  5250. "ocs": {
  5251. "type": "object",
  5252. "required": [
  5253. "meta",
  5254. "data"
  5255. ],
  5256. "properties": {
  5257. "meta": {
  5258. "$ref": "#/components/schemas/OCSMeta"
  5259. },
  5260. "data": {
  5261. "type": "object",
  5262. "required": [
  5263. "task"
  5264. ],
  5265. "properties": {
  5266. "task": {
  5267. "$ref": "#/components/schemas/TextProcessingTask"
  5268. }
  5269. }
  5270. }
  5271. }
  5272. }
  5273. }
  5274. }
  5275. }
  5276. }
  5277. },
  5278. "404": {
  5279. "description": "Task not found",
  5280. "content": {
  5281. "application/json": {
  5282. "schema": {
  5283. "type": "object",
  5284. "required": [
  5285. "ocs"
  5286. ],
  5287. "properties": {
  5288. "ocs": {
  5289. "type": "object",
  5290. "required": [
  5291. "meta",
  5292. "data"
  5293. ],
  5294. "properties": {
  5295. "meta": {
  5296. "$ref": "#/components/schemas/OCSMeta"
  5297. },
  5298. "data": {
  5299. "type": "object",
  5300. "required": [
  5301. "message"
  5302. ],
  5303. "properties": {
  5304. "message": {
  5305. "type": "string"
  5306. }
  5307. }
  5308. }
  5309. }
  5310. }
  5311. }
  5312. }
  5313. }
  5314. }
  5315. },
  5316. "500": {
  5317. "description": "",
  5318. "content": {
  5319. "application/json": {
  5320. "schema": {
  5321. "type": "object",
  5322. "required": [
  5323. "ocs"
  5324. ],
  5325. "properties": {
  5326. "ocs": {
  5327. "type": "object",
  5328. "required": [
  5329. "meta",
  5330. "data"
  5331. ],
  5332. "properties": {
  5333. "meta": {
  5334. "$ref": "#/components/schemas/OCSMeta"
  5335. },
  5336. "data": {
  5337. "type": "object",
  5338. "required": [
  5339. "message"
  5340. ],
  5341. "properties": {
  5342. "message": {
  5343. "type": "string"
  5344. }
  5345. }
  5346. }
  5347. }
  5348. }
  5349. }
  5350. }
  5351. }
  5352. }
  5353. }
  5354. }
  5355. }
  5356. },
  5357. "/ocs/v2.php/textprocessing/tasks/app/{appId}": {
  5358. "get": {
  5359. "operationId": "text_processing_api-list-tasks-by-app",
  5360. "summary": "This endpoint returns a list of tasks of a user that are related with a specific appId and optionally with an identifier",
  5361. "tags": [
  5362. "text_processing_api"
  5363. ],
  5364. "security": [
  5365. {
  5366. "bearer_auth": []
  5367. },
  5368. {
  5369. "basic_auth": []
  5370. }
  5371. ],
  5372. "requestBody": {
  5373. "required": false,
  5374. "content": {
  5375. "application/json": {
  5376. "schema": {
  5377. "type": "object",
  5378. "properties": {
  5379. "identifier": {
  5380. "type": "string",
  5381. "nullable": true,
  5382. "description": "An arbitrary identifier for the task"
  5383. }
  5384. }
  5385. }
  5386. }
  5387. }
  5388. },
  5389. "parameters": [
  5390. {
  5391. "name": "appId",
  5392. "in": "path",
  5393. "description": "ID of the app",
  5394. "required": true,
  5395. "schema": {
  5396. "type": "string"
  5397. }
  5398. },
  5399. {
  5400. "name": "OCS-APIRequest",
  5401. "in": "header",
  5402. "description": "Required to be true for the API request to pass",
  5403. "required": true,
  5404. "schema": {
  5405. "type": "boolean",
  5406. "default": true
  5407. }
  5408. }
  5409. ],
  5410. "responses": {
  5411. "200": {
  5412. "description": "Task list returned",
  5413. "content": {
  5414. "application/json": {
  5415. "schema": {
  5416. "type": "object",
  5417. "required": [
  5418. "ocs"
  5419. ],
  5420. "properties": {
  5421. "ocs": {
  5422. "type": "object",
  5423. "required": [
  5424. "meta",
  5425. "data"
  5426. ],
  5427. "properties": {
  5428. "meta": {
  5429. "$ref": "#/components/schemas/OCSMeta"
  5430. },
  5431. "data": {
  5432. "type": "object",
  5433. "required": [
  5434. "tasks"
  5435. ],
  5436. "properties": {
  5437. "tasks": {
  5438. "type": "array",
  5439. "items": {
  5440. "$ref": "#/components/schemas/TextProcessingTask"
  5441. }
  5442. }
  5443. }
  5444. }
  5445. }
  5446. }
  5447. }
  5448. }
  5449. }
  5450. }
  5451. },
  5452. "500": {
  5453. "description": "",
  5454. "content": {
  5455. "application/json": {
  5456. "schema": {
  5457. "type": "object",
  5458. "required": [
  5459. "ocs"
  5460. ],
  5461. "properties": {
  5462. "ocs": {
  5463. "type": "object",
  5464. "required": [
  5465. "meta",
  5466. "data"
  5467. ],
  5468. "properties": {
  5469. "meta": {
  5470. "$ref": "#/components/schemas/OCSMeta"
  5471. },
  5472. "data": {
  5473. "type": "object",
  5474. "required": [
  5475. "message"
  5476. ],
  5477. "properties": {
  5478. "message": {
  5479. "type": "string"
  5480. }
  5481. }
  5482. }
  5483. }
  5484. }
  5485. }
  5486. }
  5487. }
  5488. }
  5489. }
  5490. }
  5491. }
  5492. },
  5493. "/ocs/v2.php/text2image/is_available": {
  5494. "get": {
  5495. "operationId": "text_to_image_api-is-available",
  5496. "summary": "Check whether this feature is available",
  5497. "tags": [
  5498. "text_to_image_api"
  5499. ],
  5500. "security": [
  5501. {},
  5502. {
  5503. "bearer_auth": []
  5504. },
  5505. {
  5506. "basic_auth": []
  5507. }
  5508. ],
  5509. "parameters": [
  5510. {
  5511. "name": "OCS-APIRequest",
  5512. "in": "header",
  5513. "description": "Required to be true for the API request to pass",
  5514. "required": true,
  5515. "schema": {
  5516. "type": "boolean",
  5517. "default": true
  5518. }
  5519. }
  5520. ],
  5521. "responses": {
  5522. "200": {
  5523. "description": "Returns availability status",
  5524. "content": {
  5525. "application/json": {
  5526. "schema": {
  5527. "type": "object",
  5528. "required": [
  5529. "ocs"
  5530. ],
  5531. "properties": {
  5532. "ocs": {
  5533. "type": "object",
  5534. "required": [
  5535. "meta",
  5536. "data"
  5537. ],
  5538. "properties": {
  5539. "meta": {
  5540. "$ref": "#/components/schemas/OCSMeta"
  5541. },
  5542. "data": {
  5543. "type": "object",
  5544. "required": [
  5545. "isAvailable"
  5546. ],
  5547. "properties": {
  5548. "isAvailable": {
  5549. "type": "boolean"
  5550. }
  5551. }
  5552. }
  5553. }
  5554. }
  5555. }
  5556. }
  5557. }
  5558. }
  5559. }
  5560. }
  5561. }
  5562. },
  5563. "/ocs/v2.php/text2image/schedule": {
  5564. "post": {
  5565. "operationId": "text_to_image_api-schedule",
  5566. "summary": "This endpoint allows scheduling a text to image task",
  5567. "tags": [
  5568. "text_to_image_api"
  5569. ],
  5570. "security": [
  5571. {},
  5572. {
  5573. "bearer_auth": []
  5574. },
  5575. {
  5576. "basic_auth": []
  5577. }
  5578. ],
  5579. "requestBody": {
  5580. "required": true,
  5581. "content": {
  5582. "application/json": {
  5583. "schema": {
  5584. "type": "object",
  5585. "required": [
  5586. "input",
  5587. "appId"
  5588. ],
  5589. "properties": {
  5590. "input": {
  5591. "type": "string",
  5592. "description": "Input text"
  5593. },
  5594. "appId": {
  5595. "type": "string",
  5596. "description": "ID of the app that will execute the task"
  5597. },
  5598. "identifier": {
  5599. "type": "string",
  5600. "default": "",
  5601. "description": "An arbitrary identifier for the task"
  5602. },
  5603. "numberOfImages": {
  5604. "type": "integer",
  5605. "format": "int64",
  5606. "default": 8,
  5607. "description": "The number of images to generate"
  5608. }
  5609. }
  5610. }
  5611. }
  5612. }
  5613. },
  5614. "parameters": [
  5615. {
  5616. "name": "OCS-APIRequest",
  5617. "in": "header",
  5618. "description": "Required to be true for the API request to pass",
  5619. "required": true,
  5620. "schema": {
  5621. "type": "boolean",
  5622. "default": true
  5623. }
  5624. }
  5625. ],
  5626. "responses": {
  5627. "200": {
  5628. "description": "Task scheduled successfully",
  5629. "content": {
  5630. "application/json": {
  5631. "schema": {
  5632. "type": "object",
  5633. "required": [
  5634. "ocs"
  5635. ],
  5636. "properties": {
  5637. "ocs": {
  5638. "type": "object",
  5639. "required": [
  5640. "meta",
  5641. "data"
  5642. ],
  5643. "properties": {
  5644. "meta": {
  5645. "$ref": "#/components/schemas/OCSMeta"
  5646. },
  5647. "data": {
  5648. "type": "object",
  5649. "required": [
  5650. "task"
  5651. ],
  5652. "properties": {
  5653. "task": {
  5654. "$ref": "#/components/schemas/TextToImageTask"
  5655. }
  5656. }
  5657. }
  5658. }
  5659. }
  5660. }
  5661. }
  5662. }
  5663. }
  5664. },
  5665. "412": {
  5666. "description": "Scheduling task is not possible",
  5667. "content": {
  5668. "application/json": {
  5669. "schema": {
  5670. "type": "object",
  5671. "required": [
  5672. "ocs"
  5673. ],
  5674. "properties": {
  5675. "ocs": {
  5676. "type": "object",
  5677. "required": [
  5678. "meta",
  5679. "data"
  5680. ],
  5681. "properties": {
  5682. "meta": {
  5683. "$ref": "#/components/schemas/OCSMeta"
  5684. },
  5685. "data": {
  5686. "type": "object",
  5687. "required": [
  5688. "message"
  5689. ],
  5690. "properties": {
  5691. "message": {
  5692. "type": "string"
  5693. }
  5694. }
  5695. }
  5696. }
  5697. }
  5698. }
  5699. }
  5700. }
  5701. }
  5702. },
  5703. "500": {
  5704. "description": "",
  5705. "content": {
  5706. "application/json": {
  5707. "schema": {
  5708. "type": "object",
  5709. "required": [
  5710. "ocs"
  5711. ],
  5712. "properties": {
  5713. "ocs": {
  5714. "type": "object",
  5715. "required": [
  5716. "meta",
  5717. "data"
  5718. ],
  5719. "properties": {
  5720. "meta": {
  5721. "$ref": "#/components/schemas/OCSMeta"
  5722. },
  5723. "data": {
  5724. "type": "object",
  5725. "required": [
  5726. "message"
  5727. ],
  5728. "properties": {
  5729. "message": {
  5730. "type": "string"
  5731. }
  5732. }
  5733. }
  5734. }
  5735. }
  5736. }
  5737. }
  5738. }
  5739. }
  5740. }
  5741. }
  5742. }
  5743. },
  5744. "/ocs/v2.php/text2image/task/{id}": {
  5745. "get": {
  5746. "operationId": "text_to_image_api-get-task",
  5747. "summary": "This endpoint allows checking the status and results of a task. Tasks are removed 1 week after receiving their last update.",
  5748. "tags": [
  5749. "text_to_image_api"
  5750. ],
  5751. "security": [
  5752. {},
  5753. {
  5754. "bearer_auth": []
  5755. },
  5756. {
  5757. "basic_auth": []
  5758. }
  5759. ],
  5760. "parameters": [
  5761. {
  5762. "name": "id",
  5763. "in": "path",
  5764. "description": "The id of the task",
  5765. "required": true,
  5766. "schema": {
  5767. "type": "integer",
  5768. "format": "int64"
  5769. }
  5770. },
  5771. {
  5772. "name": "OCS-APIRequest",
  5773. "in": "header",
  5774. "description": "Required to be true for the API request to pass",
  5775. "required": true,
  5776. "schema": {
  5777. "type": "boolean",
  5778. "default": true
  5779. }
  5780. }
  5781. ],
  5782. "responses": {
  5783. "200": {
  5784. "description": "Task returned",
  5785. "content": {
  5786. "application/json": {
  5787. "schema": {
  5788. "type": "object",
  5789. "required": [
  5790. "ocs"
  5791. ],
  5792. "properties": {
  5793. "ocs": {
  5794. "type": "object",
  5795. "required": [
  5796. "meta",
  5797. "data"
  5798. ],
  5799. "properties": {
  5800. "meta": {
  5801. "$ref": "#/components/schemas/OCSMeta"
  5802. },
  5803. "data": {
  5804. "type": "object",
  5805. "required": [
  5806. "task"
  5807. ],
  5808. "properties": {
  5809. "task": {
  5810. "$ref": "#/components/schemas/TextToImageTask"
  5811. }
  5812. }
  5813. }
  5814. }
  5815. }
  5816. }
  5817. }
  5818. }
  5819. }
  5820. },
  5821. "404": {
  5822. "description": "Task not found",
  5823. "content": {
  5824. "application/json": {
  5825. "schema": {
  5826. "type": "object",
  5827. "required": [
  5828. "ocs"
  5829. ],
  5830. "properties": {
  5831. "ocs": {
  5832. "type": "object",
  5833. "required": [
  5834. "meta",
  5835. "data"
  5836. ],
  5837. "properties": {
  5838. "meta": {
  5839. "$ref": "#/components/schemas/OCSMeta"
  5840. },
  5841. "data": {
  5842. "type": "object",
  5843. "required": [
  5844. "message"
  5845. ],
  5846. "properties": {
  5847. "message": {
  5848. "type": "string"
  5849. }
  5850. }
  5851. }
  5852. }
  5853. }
  5854. }
  5855. }
  5856. }
  5857. }
  5858. },
  5859. "500": {
  5860. "description": "",
  5861. "content": {
  5862. "application/json": {
  5863. "schema": {
  5864. "type": "object",
  5865. "required": [
  5866. "ocs"
  5867. ],
  5868. "properties": {
  5869. "ocs": {
  5870. "type": "object",
  5871. "required": [
  5872. "meta",
  5873. "data"
  5874. ],
  5875. "properties": {
  5876. "meta": {
  5877. "$ref": "#/components/schemas/OCSMeta"
  5878. },
  5879. "data": {
  5880. "type": "object",
  5881. "required": [
  5882. "message"
  5883. ],
  5884. "properties": {
  5885. "message": {
  5886. "type": "string"
  5887. }
  5888. }
  5889. }
  5890. }
  5891. }
  5892. }
  5893. }
  5894. }
  5895. }
  5896. }
  5897. }
  5898. },
  5899. "delete": {
  5900. "operationId": "text_to_image_api-delete-task",
  5901. "summary": "This endpoint allows to delete a scheduled task for a user",
  5902. "tags": [
  5903. "text_to_image_api"
  5904. ],
  5905. "security": [
  5906. {
  5907. "bearer_auth": []
  5908. },
  5909. {
  5910. "basic_auth": []
  5911. }
  5912. ],
  5913. "parameters": [
  5914. {
  5915. "name": "id",
  5916. "in": "path",
  5917. "description": "The id of the task",
  5918. "required": true,
  5919. "schema": {
  5920. "type": "integer",
  5921. "format": "int64"
  5922. }
  5923. },
  5924. {
  5925. "name": "OCS-APIRequest",
  5926. "in": "header",
  5927. "description": "Required to be true for the API request to pass",
  5928. "required": true,
  5929. "schema": {
  5930. "type": "boolean",
  5931. "default": true
  5932. }
  5933. }
  5934. ],
  5935. "responses": {
  5936. "200": {
  5937. "description": "Task returned",
  5938. "content": {
  5939. "application/json": {
  5940. "schema": {
  5941. "type": "object",
  5942. "required": [
  5943. "ocs"
  5944. ],
  5945. "properties": {
  5946. "ocs": {
  5947. "type": "object",
  5948. "required": [
  5949. "meta",
  5950. "data"
  5951. ],
  5952. "properties": {
  5953. "meta": {
  5954. "$ref": "#/components/schemas/OCSMeta"
  5955. },
  5956. "data": {
  5957. "type": "object",
  5958. "required": [
  5959. "task"
  5960. ],
  5961. "properties": {
  5962. "task": {
  5963. "$ref": "#/components/schemas/TextToImageTask"
  5964. }
  5965. }
  5966. }
  5967. }
  5968. }
  5969. }
  5970. }
  5971. }
  5972. }
  5973. },
  5974. "404": {
  5975. "description": "Task not found",
  5976. "content": {
  5977. "application/json": {
  5978. "schema": {
  5979. "type": "object",
  5980. "required": [
  5981. "ocs"
  5982. ],
  5983. "properties": {
  5984. "ocs": {
  5985. "type": "object",
  5986. "required": [
  5987. "meta",
  5988. "data"
  5989. ],
  5990. "properties": {
  5991. "meta": {
  5992. "$ref": "#/components/schemas/OCSMeta"
  5993. },
  5994. "data": {
  5995. "type": "object",
  5996. "required": [
  5997. "message"
  5998. ],
  5999. "properties": {
  6000. "message": {
  6001. "type": "string"
  6002. }
  6003. }
  6004. }
  6005. }
  6006. }
  6007. }
  6008. }
  6009. }
  6010. }
  6011. },
  6012. "500": {
  6013. "description": "",
  6014. "content": {
  6015. "application/json": {
  6016. "schema": {
  6017. "type": "object",
  6018. "required": [
  6019. "ocs"
  6020. ],
  6021. "properties": {
  6022. "ocs": {
  6023. "type": "object",
  6024. "required": [
  6025. "meta",
  6026. "data"
  6027. ],
  6028. "properties": {
  6029. "meta": {
  6030. "$ref": "#/components/schemas/OCSMeta"
  6031. },
  6032. "data": {
  6033. "type": "object",
  6034. "required": [
  6035. "message"
  6036. ],
  6037. "properties": {
  6038. "message": {
  6039. "type": "string"
  6040. }
  6041. }
  6042. }
  6043. }
  6044. }
  6045. }
  6046. }
  6047. }
  6048. }
  6049. }
  6050. }
  6051. }
  6052. },
  6053. "/ocs/v2.php/text2image/task/{id}/image/{index}": {
  6054. "get": {
  6055. "operationId": "text_to_image_api-get-image",
  6056. "summary": "This endpoint allows downloading the resulting image of a task",
  6057. "tags": [
  6058. "text_to_image_api"
  6059. ],
  6060. "security": [
  6061. {},
  6062. {
  6063. "bearer_auth": []
  6064. },
  6065. {
  6066. "basic_auth": []
  6067. }
  6068. ],
  6069. "parameters": [
  6070. {
  6071. "name": "id",
  6072. "in": "path",
  6073. "description": "The id of the task",
  6074. "required": true,
  6075. "schema": {
  6076. "type": "integer",
  6077. "format": "int64"
  6078. }
  6079. },
  6080. {
  6081. "name": "index",
  6082. "in": "path",
  6083. "description": "The index of the image to retrieve",
  6084. "required": true,
  6085. "schema": {
  6086. "type": "integer",
  6087. "format": "int64"
  6088. }
  6089. },
  6090. {
  6091. "name": "OCS-APIRequest",
  6092. "in": "header",
  6093. "description": "Required to be true for the API request to pass",
  6094. "required": true,
  6095. "schema": {
  6096. "type": "boolean",
  6097. "default": true
  6098. }
  6099. }
  6100. ],
  6101. "responses": {
  6102. "200": {
  6103. "description": "Image returned",
  6104. "content": {
  6105. "*/*": {
  6106. "schema": {
  6107. "type": "string",
  6108. "format": "binary"
  6109. }
  6110. }
  6111. }
  6112. },
  6113. "404": {
  6114. "description": "Task or image not found",
  6115. "content": {
  6116. "application/json": {
  6117. "schema": {
  6118. "type": "object",
  6119. "required": [
  6120. "ocs"
  6121. ],
  6122. "properties": {
  6123. "ocs": {
  6124. "type": "object",
  6125. "required": [
  6126. "meta",
  6127. "data"
  6128. ],
  6129. "properties": {
  6130. "meta": {
  6131. "$ref": "#/components/schemas/OCSMeta"
  6132. },
  6133. "data": {
  6134. "type": "object",
  6135. "required": [
  6136. "message"
  6137. ],
  6138. "properties": {
  6139. "message": {
  6140. "type": "string"
  6141. }
  6142. }
  6143. }
  6144. }
  6145. }
  6146. }
  6147. }
  6148. }
  6149. }
  6150. },
  6151. "500": {
  6152. "description": "",
  6153. "content": {
  6154. "application/json": {
  6155. "schema": {
  6156. "type": "object",
  6157. "required": [
  6158. "ocs"
  6159. ],
  6160. "properties": {
  6161. "ocs": {
  6162. "type": "object",
  6163. "required": [
  6164. "meta",
  6165. "data"
  6166. ],
  6167. "properties": {
  6168. "meta": {
  6169. "$ref": "#/components/schemas/OCSMeta"
  6170. },
  6171. "data": {
  6172. "type": "object",
  6173. "required": [
  6174. "message"
  6175. ],
  6176. "properties": {
  6177. "message": {
  6178. "type": "string"
  6179. }
  6180. }
  6181. }
  6182. }
  6183. }
  6184. }
  6185. }
  6186. }
  6187. }
  6188. }
  6189. }
  6190. }
  6191. },
  6192. "/ocs/v2.php/text2image/tasks/app/{appId}": {
  6193. "get": {
  6194. "operationId": "text_to_image_api-list-tasks-by-app",
  6195. "summary": "This endpoint returns a list of tasks of a user that are related with a specific appId and optionally with an identifier",
  6196. "tags": [
  6197. "text_to_image_api"
  6198. ],
  6199. "security": [
  6200. {
  6201. "bearer_auth": []
  6202. },
  6203. {
  6204. "basic_auth": []
  6205. }
  6206. ],
  6207. "requestBody": {
  6208. "required": false,
  6209. "content": {
  6210. "application/json": {
  6211. "schema": {
  6212. "type": "object",
  6213. "properties": {
  6214. "identifier": {
  6215. "type": "string",
  6216. "nullable": true,
  6217. "description": "An arbitrary identifier for the task"
  6218. }
  6219. }
  6220. }
  6221. }
  6222. }
  6223. },
  6224. "parameters": [
  6225. {
  6226. "name": "appId",
  6227. "in": "path",
  6228. "description": "ID of the app",
  6229. "required": true,
  6230. "schema": {
  6231. "type": "string"
  6232. }
  6233. },
  6234. {
  6235. "name": "OCS-APIRequest",
  6236. "in": "header",
  6237. "description": "Required to be true for the API request to pass",
  6238. "required": true,
  6239. "schema": {
  6240. "type": "boolean",
  6241. "default": true
  6242. }
  6243. }
  6244. ],
  6245. "responses": {
  6246. "200": {
  6247. "description": "Task list returned",
  6248. "content": {
  6249. "application/json": {
  6250. "schema": {
  6251. "type": "object",
  6252. "required": [
  6253. "ocs"
  6254. ],
  6255. "properties": {
  6256. "ocs": {
  6257. "type": "object",
  6258. "required": [
  6259. "meta",
  6260. "data"
  6261. ],
  6262. "properties": {
  6263. "meta": {
  6264. "$ref": "#/components/schemas/OCSMeta"
  6265. },
  6266. "data": {
  6267. "type": "object",
  6268. "required": [
  6269. "tasks"
  6270. ],
  6271. "properties": {
  6272. "tasks": {
  6273. "type": "array",
  6274. "items": {
  6275. "$ref": "#/components/schemas/TextToImageTask"
  6276. }
  6277. }
  6278. }
  6279. }
  6280. }
  6281. }
  6282. }
  6283. }
  6284. }
  6285. }
  6286. },
  6287. "500": {
  6288. "description": "",
  6289. "content": {
  6290. "application/json": {
  6291. "schema": {
  6292. "type": "object",
  6293. "required": [
  6294. "ocs"
  6295. ],
  6296. "properties": {
  6297. "ocs": {
  6298. "type": "object",
  6299. "required": [
  6300. "meta",
  6301. "data"
  6302. ],
  6303. "properties": {
  6304. "meta": {
  6305. "$ref": "#/components/schemas/OCSMeta"
  6306. },
  6307. "data": {
  6308. "type": "object",
  6309. "required": [
  6310. "message"
  6311. ],
  6312. "properties": {
  6313. "message": {
  6314. "type": "string"
  6315. }
  6316. }
  6317. }
  6318. }
  6319. }
  6320. }
  6321. }
  6322. }
  6323. }
  6324. }
  6325. }
  6326. }
  6327. },
  6328. "/ocs/v2.php/translation/languages": {
  6329. "get": {
  6330. "operationId": "translation_api-languages",
  6331. "summary": "Get the list of supported languages",
  6332. "tags": [
  6333. "translation_api"
  6334. ],
  6335. "security": [
  6336. {},
  6337. {
  6338. "bearer_auth": []
  6339. },
  6340. {
  6341. "basic_auth": []
  6342. }
  6343. ],
  6344. "parameters": [
  6345. {
  6346. "name": "OCS-APIRequest",
  6347. "in": "header",
  6348. "description": "Required to be true for the API request to pass",
  6349. "required": true,
  6350. "schema": {
  6351. "type": "boolean",
  6352. "default": true
  6353. }
  6354. }
  6355. ],
  6356. "responses": {
  6357. "200": {
  6358. "description": "Supported languages returned",
  6359. "content": {
  6360. "application/json": {
  6361. "schema": {
  6362. "type": "object",
  6363. "required": [
  6364. "ocs"
  6365. ],
  6366. "properties": {
  6367. "ocs": {
  6368. "type": "object",
  6369. "required": [
  6370. "meta",
  6371. "data"
  6372. ],
  6373. "properties": {
  6374. "meta": {
  6375. "$ref": "#/components/schemas/OCSMeta"
  6376. },
  6377. "data": {
  6378. "type": "object",
  6379. "required": [
  6380. "languages",
  6381. "languageDetection"
  6382. ],
  6383. "properties": {
  6384. "languages": {
  6385. "type": "array",
  6386. "items": {
  6387. "type": "object",
  6388. "required": [
  6389. "from",
  6390. "fromLabel",
  6391. "to",
  6392. "toLabel"
  6393. ],
  6394. "properties": {
  6395. "from": {
  6396. "type": "string"
  6397. },
  6398. "fromLabel": {
  6399. "type": "string"
  6400. },
  6401. "to": {
  6402. "type": "string"
  6403. },
  6404. "toLabel": {
  6405. "type": "string"
  6406. }
  6407. }
  6408. }
  6409. },
  6410. "languageDetection": {
  6411. "type": "boolean"
  6412. }
  6413. }
  6414. }
  6415. }
  6416. }
  6417. }
  6418. }
  6419. }
  6420. }
  6421. }
  6422. }
  6423. }
  6424. },
  6425. "/ocs/v2.php/translation/translate": {
  6426. "post": {
  6427. "operationId": "translation_api-translate",
  6428. "summary": "Translate a text",
  6429. "tags": [
  6430. "translation_api"
  6431. ],
  6432. "security": [
  6433. {},
  6434. {
  6435. "bearer_auth": []
  6436. },
  6437. {
  6438. "basic_auth": []
  6439. }
  6440. ],
  6441. "requestBody": {
  6442. "required": true,
  6443. "content": {
  6444. "application/json": {
  6445. "schema": {
  6446. "type": "object",
  6447. "required": [
  6448. "text",
  6449. "toLanguage"
  6450. ],
  6451. "properties": {
  6452. "text": {
  6453. "type": "string",
  6454. "description": "Text to be translated"
  6455. },
  6456. "fromLanguage": {
  6457. "type": "string",
  6458. "nullable": true,
  6459. "description": "Language to translate from"
  6460. },
  6461. "toLanguage": {
  6462. "type": "string",
  6463. "description": "Language to translate to"
  6464. }
  6465. }
  6466. }
  6467. }
  6468. }
  6469. },
  6470. "parameters": [
  6471. {
  6472. "name": "OCS-APIRequest",
  6473. "in": "header",
  6474. "description": "Required to be true for the API request to pass",
  6475. "required": true,
  6476. "schema": {
  6477. "type": "boolean",
  6478. "default": true
  6479. }
  6480. }
  6481. ],
  6482. "responses": {
  6483. "200": {
  6484. "description": "Translated text returned",
  6485. "content": {
  6486. "application/json": {
  6487. "schema": {
  6488. "type": "object",
  6489. "required": [
  6490. "ocs"
  6491. ],
  6492. "properties": {
  6493. "ocs": {
  6494. "type": "object",
  6495. "required": [
  6496. "meta",
  6497. "data"
  6498. ],
  6499. "properties": {
  6500. "meta": {
  6501. "$ref": "#/components/schemas/OCSMeta"
  6502. },
  6503. "data": {
  6504. "type": "object",
  6505. "required": [
  6506. "text",
  6507. "from"
  6508. ],
  6509. "properties": {
  6510. "text": {
  6511. "type": "string"
  6512. },
  6513. "from": {
  6514. "type": "string",
  6515. "nullable": true
  6516. }
  6517. }
  6518. }
  6519. }
  6520. }
  6521. }
  6522. }
  6523. }
  6524. }
  6525. },
  6526. "400": {
  6527. "description": "Language not detected or unable to translate",
  6528. "content": {
  6529. "application/json": {
  6530. "schema": {
  6531. "type": "object",
  6532. "required": [
  6533. "ocs"
  6534. ],
  6535. "properties": {
  6536. "ocs": {
  6537. "type": "object",
  6538. "required": [
  6539. "meta",
  6540. "data"
  6541. ],
  6542. "properties": {
  6543. "meta": {
  6544. "$ref": "#/components/schemas/OCSMeta"
  6545. },
  6546. "data": {
  6547. "type": "object",
  6548. "required": [
  6549. "message"
  6550. ],
  6551. "properties": {
  6552. "message": {
  6553. "type": "string"
  6554. },
  6555. "from": {
  6556. "type": "string",
  6557. "nullable": true
  6558. }
  6559. }
  6560. }
  6561. }
  6562. }
  6563. }
  6564. }
  6565. }
  6566. }
  6567. },
  6568. "412": {
  6569. "description": "Translating is not possible",
  6570. "content": {
  6571. "application/json": {
  6572. "schema": {
  6573. "type": "object",
  6574. "required": [
  6575. "ocs"
  6576. ],
  6577. "properties": {
  6578. "ocs": {
  6579. "type": "object",
  6580. "required": [
  6581. "meta",
  6582. "data"
  6583. ],
  6584. "properties": {
  6585. "meta": {
  6586. "$ref": "#/components/schemas/OCSMeta"
  6587. },
  6588. "data": {
  6589. "type": "object",
  6590. "required": [
  6591. "message"
  6592. ],
  6593. "properties": {
  6594. "message": {
  6595. "type": "string"
  6596. },
  6597. "from": {
  6598. "type": "string",
  6599. "nullable": true
  6600. }
  6601. }
  6602. }
  6603. }
  6604. }
  6605. }
  6606. }
  6607. }
  6608. }
  6609. },
  6610. "500": {
  6611. "description": "",
  6612. "content": {
  6613. "application/json": {
  6614. "schema": {
  6615. "type": "object",
  6616. "required": [
  6617. "ocs"
  6618. ],
  6619. "properties": {
  6620. "ocs": {
  6621. "type": "object",
  6622. "required": [
  6623. "meta",
  6624. "data"
  6625. ],
  6626. "properties": {
  6627. "meta": {
  6628. "$ref": "#/components/schemas/OCSMeta"
  6629. },
  6630. "data": {
  6631. "type": "object",
  6632. "required": [
  6633. "message"
  6634. ],
  6635. "properties": {
  6636. "message": {
  6637. "type": "string"
  6638. },
  6639. "from": {
  6640. "type": "string",
  6641. "nullable": true
  6642. }
  6643. }
  6644. }
  6645. }
  6646. }
  6647. }
  6648. }
  6649. }
  6650. }
  6651. }
  6652. }
  6653. }
  6654. },
  6655. "/ocs/v2.php/search/providers": {
  6656. "get": {
  6657. "operationId": "unified_search-get-providers",
  6658. "summary": "Get the providers for unified search",
  6659. "tags": [
  6660. "unified_search"
  6661. ],
  6662. "security": [
  6663. {
  6664. "bearer_auth": []
  6665. },
  6666. {
  6667. "basic_auth": []
  6668. }
  6669. ],
  6670. "requestBody": {
  6671. "required": false,
  6672. "content": {
  6673. "application/json": {
  6674. "schema": {
  6675. "type": "object",
  6676. "properties": {
  6677. "from": {
  6678. "type": "string",
  6679. "default": "",
  6680. "description": "the url the user is currently at"
  6681. }
  6682. }
  6683. }
  6684. }
  6685. }
  6686. },
  6687. "parameters": [
  6688. {
  6689. "name": "OCS-APIRequest",
  6690. "in": "header",
  6691. "description": "Required to be true for the API request to pass",
  6692. "required": true,
  6693. "schema": {
  6694. "type": "boolean",
  6695. "default": true
  6696. }
  6697. }
  6698. ],
  6699. "responses": {
  6700. "200": {
  6701. "description": "Providers returned",
  6702. "content": {
  6703. "application/json": {
  6704. "schema": {
  6705. "type": "object",
  6706. "required": [
  6707. "ocs"
  6708. ],
  6709. "properties": {
  6710. "ocs": {
  6711. "type": "object",
  6712. "required": [
  6713. "meta",
  6714. "data"
  6715. ],
  6716. "properties": {
  6717. "meta": {
  6718. "$ref": "#/components/schemas/OCSMeta"
  6719. },
  6720. "data": {
  6721. "type": "array",
  6722. "items": {
  6723. "$ref": "#/components/schemas/UnifiedSearchProvider"
  6724. }
  6725. }
  6726. }
  6727. }
  6728. }
  6729. }
  6730. }
  6731. }
  6732. }
  6733. }
  6734. }
  6735. },
  6736. "/ocs/v2.php/search/providers/{providerId}/search": {
  6737. "get": {
  6738. "operationId": "unified_search-search",
  6739. "summary": "Launch a search for a specific search provider.",
  6740. "description": "Additional filters are available for each provider. Send a request to /providers endpoint to list providers with their available filters.",
  6741. "tags": [
  6742. "unified_search"
  6743. ],
  6744. "security": [
  6745. {
  6746. "bearer_auth": []
  6747. },
  6748. {
  6749. "basic_auth": []
  6750. }
  6751. ],
  6752. "requestBody": {
  6753. "required": false,
  6754. "content": {
  6755. "application/json": {
  6756. "schema": {
  6757. "type": "object",
  6758. "properties": {
  6759. "term": {
  6760. "type": "string",
  6761. "default": "",
  6762. "description": "Term to search"
  6763. },
  6764. "sortOrder": {
  6765. "type": "integer",
  6766. "format": "int64",
  6767. "nullable": true,
  6768. "description": "Order of entries"
  6769. },
  6770. "limit": {
  6771. "type": "integer",
  6772. "format": "int64",
  6773. "nullable": true,
  6774. "description": "Maximum amount of entries, limited to 25"
  6775. },
  6776. "cursor": {
  6777. "nullable": true,
  6778. "description": "Offset for searching",
  6779. "oneOf": [
  6780. {
  6781. "type": "integer",
  6782. "format": "int64"
  6783. },
  6784. {
  6785. "type": "string"
  6786. }
  6787. ]
  6788. },
  6789. "from": {
  6790. "type": "string",
  6791. "default": "",
  6792. "description": "The current user URL"
  6793. }
  6794. }
  6795. }
  6796. }
  6797. }
  6798. },
  6799. "parameters": [
  6800. {
  6801. "name": "providerId",
  6802. "in": "path",
  6803. "description": "ID of the provider",
  6804. "required": true,
  6805. "schema": {
  6806. "type": "string"
  6807. }
  6808. },
  6809. {
  6810. "name": "OCS-APIRequest",
  6811. "in": "header",
  6812. "description": "Required to be true for the API request to pass",
  6813. "required": true,
  6814. "schema": {
  6815. "type": "boolean",
  6816. "default": true
  6817. }
  6818. }
  6819. ],
  6820. "responses": {
  6821. "200": {
  6822. "description": "Search entries returned",
  6823. "content": {
  6824. "application/json": {
  6825. "schema": {
  6826. "type": "object",
  6827. "required": [
  6828. "ocs"
  6829. ],
  6830. "properties": {
  6831. "ocs": {
  6832. "type": "object",
  6833. "required": [
  6834. "meta",
  6835. "data"
  6836. ],
  6837. "properties": {
  6838. "meta": {
  6839. "$ref": "#/components/schemas/OCSMeta"
  6840. },
  6841. "data": {
  6842. "$ref": "#/components/schemas/UnifiedSearchResult"
  6843. }
  6844. }
  6845. }
  6846. }
  6847. }
  6848. }
  6849. }
  6850. },
  6851. "400": {
  6852. "description": "Searching is not possible",
  6853. "content": {
  6854. "application/json": {
  6855. "schema": {
  6856. "type": "object",
  6857. "required": [
  6858. "ocs"
  6859. ],
  6860. "properties": {
  6861. "ocs": {
  6862. "type": "object",
  6863. "required": [
  6864. "meta",
  6865. "data"
  6866. ],
  6867. "properties": {
  6868. "meta": {
  6869. "$ref": "#/components/schemas/OCSMeta"
  6870. },
  6871. "data": {
  6872. "type": "string"
  6873. }
  6874. }
  6875. }
  6876. }
  6877. }
  6878. }
  6879. }
  6880. }
  6881. }
  6882. }
  6883. },
  6884. "/ocs/v2.php/core/whatsnew": {
  6885. "get": {
  6886. "operationId": "whats_new-get",
  6887. "summary": "Get the changes",
  6888. "tags": [
  6889. "whats_new"
  6890. ],
  6891. "security": [
  6892. {
  6893. "bearer_auth": []
  6894. },
  6895. {
  6896. "basic_auth": []
  6897. }
  6898. ],
  6899. "parameters": [
  6900. {
  6901. "name": "OCS-APIRequest",
  6902. "in": "header",
  6903. "description": "Required to be true for the API request to pass",
  6904. "required": true,
  6905. "schema": {
  6906. "type": "boolean",
  6907. "default": true
  6908. }
  6909. }
  6910. ],
  6911. "responses": {
  6912. "200": {
  6913. "description": "Changes returned",
  6914. "content": {
  6915. "application/json": {
  6916. "schema": {
  6917. "type": "object",
  6918. "required": [
  6919. "ocs"
  6920. ],
  6921. "properties": {
  6922. "ocs": {
  6923. "type": "object",
  6924. "required": [
  6925. "meta",
  6926. "data"
  6927. ],
  6928. "properties": {
  6929. "meta": {
  6930. "$ref": "#/components/schemas/OCSMeta"
  6931. },
  6932. "data": {
  6933. "type": "object",
  6934. "required": [
  6935. "changelogURL",
  6936. "product",
  6937. "version"
  6938. ],
  6939. "properties": {
  6940. "changelogURL": {
  6941. "type": "string"
  6942. },
  6943. "product": {
  6944. "type": "string"
  6945. },
  6946. "version": {
  6947. "type": "string"
  6948. },
  6949. "whatsNew": {
  6950. "type": "object",
  6951. "required": [
  6952. "regular",
  6953. "admin"
  6954. ],
  6955. "properties": {
  6956. "regular": {
  6957. "type": "array",
  6958. "items": {
  6959. "type": "string"
  6960. }
  6961. },
  6962. "admin": {
  6963. "type": "array",
  6964. "items": {
  6965. "type": "string"
  6966. }
  6967. }
  6968. }
  6969. }
  6970. }
  6971. }
  6972. }
  6973. }
  6974. }
  6975. }
  6976. }
  6977. }
  6978. },
  6979. "204": {
  6980. "description": "No changes"
  6981. }
  6982. }
  6983. },
  6984. "post": {
  6985. "operationId": "whats_new-dismiss",
  6986. "summary": "Dismiss the changes",
  6987. "tags": [
  6988. "whats_new"
  6989. ],
  6990. "security": [
  6991. {
  6992. "bearer_auth": []
  6993. },
  6994. {
  6995. "basic_auth": []
  6996. }
  6997. ],
  6998. "requestBody": {
  6999. "required": true,
  7000. "content": {
  7001. "application/json": {
  7002. "schema": {
  7003. "type": "object",
  7004. "required": [
  7005. "version"
  7006. ],
  7007. "properties": {
  7008. "version": {
  7009. "type": "string",
  7010. "description": "Version to dismiss the changes for"
  7011. }
  7012. }
  7013. }
  7014. }
  7015. }
  7016. },
  7017. "parameters": [
  7018. {
  7019. "name": "OCS-APIRequest",
  7020. "in": "header",
  7021. "description": "Required to be true for the API request to pass",
  7022. "required": true,
  7023. "schema": {
  7024. "type": "boolean",
  7025. "default": true
  7026. }
  7027. }
  7028. ],
  7029. "responses": {
  7030. "200": {
  7031. "description": "Changes dismissed",
  7032. "content": {
  7033. "application/json": {
  7034. "schema": {
  7035. "type": "object",
  7036. "required": [
  7037. "ocs"
  7038. ],
  7039. "properties": {
  7040. "ocs": {
  7041. "type": "object",
  7042. "required": [
  7043. "meta",
  7044. "data"
  7045. ],
  7046. "properties": {
  7047. "meta": {
  7048. "$ref": "#/components/schemas/OCSMeta"
  7049. },
  7050. "data": {}
  7051. }
  7052. }
  7053. }
  7054. }
  7055. }
  7056. }
  7057. },
  7058. "500": {
  7059. "description": "",
  7060. "content": {
  7061. "text/plain": {
  7062. "schema": {
  7063. "type": "string"
  7064. }
  7065. }
  7066. }
  7067. }
  7068. }
  7069. }
  7070. },
  7071. "/index.php/avatar/{userId}/{size}/dark": {
  7072. "get": {
  7073. "operationId": "avatar-get-avatar-dark",
  7074. "summary": "Get the dark avatar",
  7075. "tags": [
  7076. "avatar"
  7077. ],
  7078. "security": [
  7079. {},
  7080. {
  7081. "bearer_auth": []
  7082. },
  7083. {
  7084. "basic_auth": []
  7085. }
  7086. ],
  7087. "requestBody": {
  7088. "required": false,
  7089. "content": {
  7090. "application/json": {
  7091. "schema": {
  7092. "type": "object",
  7093. "properties": {
  7094. "guestFallback": {
  7095. "type": "boolean",
  7096. "default": false,
  7097. "description": "Fallback to guest avatar if not found"
  7098. }
  7099. }
  7100. }
  7101. }
  7102. }
  7103. },
  7104. "parameters": [
  7105. {
  7106. "name": "userId",
  7107. "in": "path",
  7108. "description": "ID of the user",
  7109. "required": true,
  7110. "schema": {
  7111. "type": "string"
  7112. }
  7113. },
  7114. {
  7115. "name": "size",
  7116. "in": "path",
  7117. "description": "Size of the avatar",
  7118. "required": true,
  7119. "schema": {
  7120. "type": "integer",
  7121. "format": "int64"
  7122. }
  7123. }
  7124. ],
  7125. "responses": {
  7126. "200": {
  7127. "description": "Avatar returned",
  7128. "headers": {
  7129. "X-NC-IsCustomAvatar": {
  7130. "schema": {
  7131. "type": "integer",
  7132. "format": "int64"
  7133. }
  7134. }
  7135. },
  7136. "content": {
  7137. "*/*": {
  7138. "schema": {
  7139. "type": "string",
  7140. "format": "binary"
  7141. }
  7142. }
  7143. }
  7144. },
  7145. "201": {
  7146. "description": "Avatar returned",
  7147. "headers": {
  7148. "X-NC-IsCustomAvatar": {
  7149. "schema": {
  7150. "type": "integer",
  7151. "format": "int64"
  7152. }
  7153. }
  7154. },
  7155. "content": {
  7156. "*/*": {
  7157. "schema": {
  7158. "type": "string",
  7159. "format": "binary"
  7160. }
  7161. }
  7162. }
  7163. },
  7164. "404": {
  7165. "description": "Avatar not found",
  7166. "content": {
  7167. "application/json": {
  7168. "schema": {}
  7169. }
  7170. }
  7171. },
  7172. "500": {
  7173. "description": ""
  7174. }
  7175. }
  7176. }
  7177. },
  7178. "/index.php/avatar/{userId}/{size}": {
  7179. "get": {
  7180. "operationId": "avatar-get-avatar",
  7181. "summary": "Get the avatar",
  7182. "tags": [
  7183. "avatar"
  7184. ],
  7185. "security": [
  7186. {},
  7187. {
  7188. "bearer_auth": []
  7189. },
  7190. {
  7191. "basic_auth": []
  7192. }
  7193. ],
  7194. "requestBody": {
  7195. "required": false,
  7196. "content": {
  7197. "application/json": {
  7198. "schema": {
  7199. "type": "object",
  7200. "properties": {
  7201. "guestFallback": {
  7202. "type": "boolean",
  7203. "default": false,
  7204. "description": "Fallback to guest avatar if not found"
  7205. }
  7206. }
  7207. }
  7208. }
  7209. }
  7210. },
  7211. "parameters": [
  7212. {
  7213. "name": "userId",
  7214. "in": "path",
  7215. "description": "ID of the user",
  7216. "required": true,
  7217. "schema": {
  7218. "type": "string"
  7219. }
  7220. },
  7221. {
  7222. "name": "size",
  7223. "in": "path",
  7224. "description": "Size of the avatar",
  7225. "required": true,
  7226. "schema": {
  7227. "type": "integer",
  7228. "format": "int64"
  7229. }
  7230. }
  7231. ],
  7232. "responses": {
  7233. "200": {
  7234. "description": "Avatar returned",
  7235. "headers": {
  7236. "X-NC-IsCustomAvatar": {
  7237. "schema": {
  7238. "type": "integer",
  7239. "format": "int64"
  7240. }
  7241. }
  7242. },
  7243. "content": {
  7244. "*/*": {
  7245. "schema": {
  7246. "type": "string",
  7247. "format": "binary"
  7248. }
  7249. }
  7250. }
  7251. },
  7252. "201": {
  7253. "description": "Avatar returned",
  7254. "headers": {
  7255. "X-NC-IsCustomAvatar": {
  7256. "schema": {
  7257. "type": "integer",
  7258. "format": "int64"
  7259. }
  7260. }
  7261. },
  7262. "content": {
  7263. "*/*": {
  7264. "schema": {
  7265. "type": "string",
  7266. "format": "binary"
  7267. }
  7268. }
  7269. }
  7270. },
  7271. "404": {
  7272. "description": "Avatar not found",
  7273. "content": {
  7274. "application/json": {
  7275. "schema": {}
  7276. }
  7277. }
  7278. },
  7279. "500": {
  7280. "description": ""
  7281. }
  7282. }
  7283. }
  7284. },
  7285. "/index.php/login/v2/poll": {
  7286. "post": {
  7287. "operationId": "client_flow_login_v2-poll",
  7288. "summary": "Poll the login flow credentials",
  7289. "tags": [
  7290. "client_flow_login_v2"
  7291. ],
  7292. "security": [
  7293. {},
  7294. {
  7295. "bearer_auth": []
  7296. },
  7297. {
  7298. "basic_auth": []
  7299. }
  7300. ],
  7301. "requestBody": {
  7302. "required": true,
  7303. "content": {
  7304. "application/json": {
  7305. "schema": {
  7306. "type": "object",
  7307. "required": [
  7308. "token"
  7309. ],
  7310. "properties": {
  7311. "token": {
  7312. "type": "string",
  7313. "description": "Token of the flow"
  7314. }
  7315. }
  7316. }
  7317. }
  7318. }
  7319. },
  7320. "responses": {
  7321. "200": {
  7322. "description": "Login flow credentials returned",
  7323. "content": {
  7324. "application/json": {
  7325. "schema": {
  7326. "$ref": "#/components/schemas/LoginFlowV2Credentials"
  7327. }
  7328. }
  7329. }
  7330. },
  7331. "404": {
  7332. "description": "Login flow not found or completed",
  7333. "content": {
  7334. "application/json": {
  7335. "schema": {}
  7336. }
  7337. }
  7338. }
  7339. }
  7340. }
  7341. },
  7342. "/index.php/login/v2": {
  7343. "post": {
  7344. "operationId": "client_flow_login_v2-init",
  7345. "summary": "Init a login flow",
  7346. "tags": [
  7347. "client_flow_login_v2"
  7348. ],
  7349. "security": [
  7350. {},
  7351. {
  7352. "bearer_auth": []
  7353. },
  7354. {
  7355. "basic_auth": []
  7356. }
  7357. ],
  7358. "responses": {
  7359. "200": {
  7360. "description": "Login flow init returned",
  7361. "content": {
  7362. "application/json": {
  7363. "schema": {
  7364. "$ref": "#/components/schemas/LoginFlowV2"
  7365. }
  7366. }
  7367. }
  7368. }
  7369. }
  7370. }
  7371. },
  7372. "/index.php/avatar/guest/{guestName}/{size}": {
  7373. "get": {
  7374. "operationId": "guest_avatar-get-avatar",
  7375. "summary": "Returns a guest avatar image response",
  7376. "tags": [
  7377. "guest_avatar"
  7378. ],
  7379. "security": [
  7380. {},
  7381. {
  7382. "bearer_auth": []
  7383. },
  7384. {
  7385. "basic_auth": []
  7386. }
  7387. ],
  7388. "requestBody": {
  7389. "required": false,
  7390. "content": {
  7391. "application/json": {
  7392. "schema": {
  7393. "type": "object",
  7394. "properties": {
  7395. "darkTheme": {
  7396. "type": "boolean",
  7397. "nullable": true,
  7398. "default": false,
  7399. "description": "Return dark avatar"
  7400. }
  7401. }
  7402. }
  7403. }
  7404. }
  7405. },
  7406. "parameters": [
  7407. {
  7408. "name": "guestName",
  7409. "in": "path",
  7410. "description": "The guest name, e.g. \"Albert\"",
  7411. "required": true,
  7412. "schema": {
  7413. "type": "string"
  7414. }
  7415. },
  7416. {
  7417. "name": "size",
  7418. "in": "path",
  7419. "description": "The desired avatar size, e.g. 64 for 64x64px",
  7420. "required": true,
  7421. "schema": {
  7422. "type": "string"
  7423. }
  7424. }
  7425. ],
  7426. "responses": {
  7427. "200": {
  7428. "description": "Custom avatar returned",
  7429. "headers": {
  7430. "X-NC-IsCustomAvatar": {
  7431. "schema": {
  7432. "type": "integer",
  7433. "format": "int64"
  7434. }
  7435. }
  7436. },
  7437. "content": {
  7438. "*/*": {
  7439. "schema": {
  7440. "type": "string",
  7441. "format": "binary"
  7442. }
  7443. }
  7444. }
  7445. },
  7446. "201": {
  7447. "description": "Avatar returned",
  7448. "headers": {
  7449. "X-NC-IsCustomAvatar": {
  7450. "schema": {
  7451. "type": "integer",
  7452. "format": "int64"
  7453. }
  7454. }
  7455. },
  7456. "content": {
  7457. "*/*": {
  7458. "schema": {
  7459. "type": "string",
  7460. "format": "binary"
  7461. }
  7462. }
  7463. }
  7464. },
  7465. "500": {
  7466. "description": ""
  7467. }
  7468. }
  7469. }
  7470. },
  7471. "/index.php/avatar/guest/{guestName}/{size}/dark": {
  7472. "get": {
  7473. "operationId": "guest_avatar-get-avatar-dark",
  7474. "summary": "Returns a dark guest avatar image response",
  7475. "tags": [
  7476. "guest_avatar"
  7477. ],
  7478. "security": [
  7479. {},
  7480. {
  7481. "bearer_auth": []
  7482. },
  7483. {
  7484. "basic_auth": []
  7485. }
  7486. ],
  7487. "parameters": [
  7488. {
  7489. "name": "guestName",
  7490. "in": "path",
  7491. "description": "The guest name, e.g. \"Albert\"",
  7492. "required": true,
  7493. "schema": {
  7494. "type": "string"
  7495. }
  7496. },
  7497. {
  7498. "name": "size",
  7499. "in": "path",
  7500. "description": "The desired avatar size, e.g. 64 for 64x64px",
  7501. "required": true,
  7502. "schema": {
  7503. "type": "string"
  7504. }
  7505. }
  7506. ],
  7507. "responses": {
  7508. "200": {
  7509. "description": "Custom avatar returned",
  7510. "headers": {
  7511. "X-NC-IsCustomAvatar": {
  7512. "schema": {
  7513. "type": "integer",
  7514. "format": "int64"
  7515. }
  7516. }
  7517. },
  7518. "content": {
  7519. "*/*": {
  7520. "schema": {
  7521. "type": "string",
  7522. "format": "binary"
  7523. }
  7524. }
  7525. }
  7526. },
  7527. "201": {
  7528. "description": "Avatar returned",
  7529. "headers": {
  7530. "X-NC-IsCustomAvatar": {
  7531. "schema": {
  7532. "type": "integer",
  7533. "format": "int64"
  7534. }
  7535. }
  7536. },
  7537. "content": {
  7538. "*/*": {
  7539. "schema": {
  7540. "type": "string",
  7541. "format": "binary"
  7542. }
  7543. }
  7544. }
  7545. },
  7546. "500": {
  7547. "description": ""
  7548. }
  7549. }
  7550. }
  7551. },
  7552. "/index.php/login/confirm": {
  7553. "post": {
  7554. "operationId": "login-confirm-password",
  7555. "summary": "Confirm the user password",
  7556. "tags": [
  7557. "login"
  7558. ],
  7559. "security": [
  7560. {
  7561. "bearer_auth": []
  7562. },
  7563. {
  7564. "basic_auth": []
  7565. }
  7566. ],
  7567. "requestBody": {
  7568. "required": true,
  7569. "content": {
  7570. "application/json": {
  7571. "schema": {
  7572. "type": "object",
  7573. "required": [
  7574. "password"
  7575. ],
  7576. "properties": {
  7577. "password": {
  7578. "type": "string",
  7579. "description": "The password of the user"
  7580. }
  7581. }
  7582. }
  7583. }
  7584. }
  7585. },
  7586. "responses": {
  7587. "200": {
  7588. "description": "Password confirmation succeeded",
  7589. "content": {
  7590. "application/json": {
  7591. "schema": {
  7592. "type": "object",
  7593. "required": [
  7594. "lastLogin"
  7595. ],
  7596. "properties": {
  7597. "lastLogin": {
  7598. "type": "integer",
  7599. "format": "int64"
  7600. }
  7601. }
  7602. }
  7603. }
  7604. }
  7605. },
  7606. "403": {
  7607. "description": "Password confirmation failed",
  7608. "content": {
  7609. "application/json": {
  7610. "schema": {}
  7611. }
  7612. }
  7613. }
  7614. }
  7615. }
  7616. },
  7617. "/index.php/ocm-provider": {
  7618. "get": {
  7619. "operationId": "ocm-discovery",
  7620. "summary": "generate a OCMProvider with local data and send it as DataResponse. This replaces the old PHP file ocm-provider/index.php",
  7621. "tags": [
  7622. "ocm"
  7623. ],
  7624. "security": [
  7625. {},
  7626. {
  7627. "bearer_auth": []
  7628. },
  7629. {
  7630. "basic_auth": []
  7631. }
  7632. ],
  7633. "responses": {
  7634. "200": {
  7635. "description": "OCM Provider details returned",
  7636. "headers": {
  7637. "X-NEXTCLOUD-OCM-PROVIDERS": {
  7638. "schema": {
  7639. "type": "boolean",
  7640. "enum": [
  7641. true
  7642. ]
  7643. }
  7644. }
  7645. },
  7646. "content": {
  7647. "application/json": {
  7648. "schema": {
  7649. "type": "object",
  7650. "required": [
  7651. "enabled",
  7652. "apiVersion",
  7653. "endPoint",
  7654. "resourceTypes"
  7655. ],
  7656. "properties": {
  7657. "enabled": {
  7658. "type": "boolean"
  7659. },
  7660. "apiVersion": {
  7661. "type": "string"
  7662. },
  7663. "endPoint": {
  7664. "type": "string"
  7665. },
  7666. "resourceTypes": {
  7667. "type": "array",
  7668. "items": {
  7669. "type": "object",
  7670. "required": [
  7671. "name",
  7672. "shareTypes",
  7673. "protocols"
  7674. ],
  7675. "properties": {
  7676. "name": {
  7677. "type": "string"
  7678. },
  7679. "shareTypes": {
  7680. "type": "array",
  7681. "items": {
  7682. "type": "string"
  7683. }
  7684. },
  7685. "protocols": {
  7686. "type": "object",
  7687. "required": [
  7688. "webdav"
  7689. ],
  7690. "properties": {
  7691. "webdav": {
  7692. "type": "string"
  7693. }
  7694. }
  7695. }
  7696. }
  7697. }
  7698. }
  7699. }
  7700. }
  7701. }
  7702. }
  7703. },
  7704. "500": {
  7705. "description": "OCM not supported",
  7706. "content": {
  7707. "application/json": {
  7708. "schema": {
  7709. "type": "object",
  7710. "required": [
  7711. "message"
  7712. ],
  7713. "properties": {
  7714. "message": {
  7715. "type": "string"
  7716. }
  7717. }
  7718. }
  7719. }
  7720. }
  7721. }
  7722. }
  7723. }
  7724. },
  7725. "/index.php/core/preview.png": {
  7726. "get": {
  7727. "operationId": "preview-get-preview",
  7728. "summary": "Get a preview by file path",
  7729. "tags": [
  7730. "preview"
  7731. ],
  7732. "security": [
  7733. {
  7734. "bearer_auth": []
  7735. },
  7736. {
  7737. "basic_auth": []
  7738. }
  7739. ],
  7740. "requestBody": {
  7741. "required": false,
  7742. "content": {
  7743. "application/json": {
  7744. "schema": {
  7745. "type": "object",
  7746. "properties": {
  7747. "file": {
  7748. "type": "string",
  7749. "default": "",
  7750. "description": "Path of the file"
  7751. },
  7752. "x": {
  7753. "type": "integer",
  7754. "format": "int64",
  7755. "default": 32,
  7756. "description": "Width of the preview. A width of -1 will use the original image width."
  7757. },
  7758. "y": {
  7759. "type": "integer",
  7760. "format": "int64",
  7761. "default": 32,
  7762. "description": "Height of the preview. A height of -1 will use the original image height."
  7763. },
  7764. "a": {
  7765. "type": "boolean",
  7766. "default": false,
  7767. "description": "Preserve the aspect ratio"
  7768. },
  7769. "forceIcon": {
  7770. "type": "boolean",
  7771. "default": true,
  7772. "description": "Force returning an icon"
  7773. },
  7774. "mode": {
  7775. "type": "string",
  7776. "default": "fill",
  7777. "enum": [
  7778. "fill",
  7779. "cover"
  7780. ],
  7781. "description": "How to crop the image"
  7782. },
  7783. "mimeFallback": {
  7784. "type": "boolean",
  7785. "default": false,
  7786. "description": "Whether to fallback to the mime icon if no preview is available"
  7787. }
  7788. }
  7789. }
  7790. }
  7791. }
  7792. },
  7793. "responses": {
  7794. "200": {
  7795. "description": "Preview returned",
  7796. "content": {
  7797. "*/*": {
  7798. "schema": {
  7799. "type": "string",
  7800. "format": "binary"
  7801. }
  7802. }
  7803. }
  7804. },
  7805. "400": {
  7806. "description": "Getting preview is not possible",
  7807. "content": {
  7808. "application/json": {
  7809. "schema": {}
  7810. }
  7811. }
  7812. },
  7813. "403": {
  7814. "description": "Getting preview is not allowed",
  7815. "content": {
  7816. "application/json": {
  7817. "schema": {}
  7818. }
  7819. }
  7820. },
  7821. "404": {
  7822. "description": "Preview not found",
  7823. "content": {
  7824. "application/json": {
  7825. "schema": {}
  7826. }
  7827. }
  7828. },
  7829. "303": {
  7830. "description": "Redirect to the mime icon url if mimeFallback is true",
  7831. "headers": {
  7832. "Location": {
  7833. "schema": {
  7834. "type": "string"
  7835. }
  7836. }
  7837. }
  7838. }
  7839. }
  7840. }
  7841. },
  7842. "/index.php/core/preview": {
  7843. "get": {
  7844. "operationId": "preview-get-preview-by-file-id",
  7845. "summary": "Get a preview by file ID",
  7846. "tags": [
  7847. "preview"
  7848. ],
  7849. "security": [
  7850. {
  7851. "bearer_auth": []
  7852. },
  7853. {
  7854. "basic_auth": []
  7855. }
  7856. ],
  7857. "requestBody": {
  7858. "required": false,
  7859. "content": {
  7860. "application/json": {
  7861. "schema": {
  7862. "type": "object",
  7863. "properties": {
  7864. "fileId": {
  7865. "type": "integer",
  7866. "format": "int64",
  7867. "default": -1,
  7868. "description": "ID of the file"
  7869. },
  7870. "x": {
  7871. "type": "integer",
  7872. "format": "int64",
  7873. "default": 32,
  7874. "description": "Width of the preview. A width of -1 will use the original image width."
  7875. },
  7876. "y": {
  7877. "type": "integer",
  7878. "format": "int64",
  7879. "default": 32,
  7880. "description": "Height of the preview. A height of -1 will use the original image height."
  7881. },
  7882. "a": {
  7883. "type": "boolean",
  7884. "default": false,
  7885. "description": "Preserve the aspect ratio"
  7886. },
  7887. "forceIcon": {
  7888. "type": "boolean",
  7889. "default": true,
  7890. "description": "Force returning an icon"
  7891. },
  7892. "mode": {
  7893. "type": "string",
  7894. "default": "fill",
  7895. "enum": [
  7896. "fill",
  7897. "cover"
  7898. ],
  7899. "description": "How to crop the image"
  7900. },
  7901. "mimeFallback": {
  7902. "type": "boolean",
  7903. "default": false,
  7904. "description": "Whether to fallback to the mime icon if no preview is available"
  7905. }
  7906. }
  7907. }
  7908. }
  7909. }
  7910. },
  7911. "responses": {
  7912. "200": {
  7913. "description": "Preview returned",
  7914. "content": {
  7915. "*/*": {
  7916. "schema": {
  7917. "type": "string",
  7918. "format": "binary"
  7919. }
  7920. }
  7921. }
  7922. },
  7923. "400": {
  7924. "description": "Getting preview is not possible",
  7925. "content": {
  7926. "application/json": {
  7927. "schema": {}
  7928. }
  7929. }
  7930. },
  7931. "403": {
  7932. "description": "Getting preview is not allowed",
  7933. "content": {
  7934. "application/json": {
  7935. "schema": {}
  7936. }
  7937. }
  7938. },
  7939. "404": {
  7940. "description": "Preview not found",
  7941. "content": {
  7942. "application/json": {
  7943. "schema": {}
  7944. }
  7945. }
  7946. },
  7947. "303": {
  7948. "description": "Redirect to the mime icon url if mimeFallback is true",
  7949. "headers": {
  7950. "Location": {
  7951. "schema": {
  7952. "type": "string"
  7953. }
  7954. }
  7955. }
  7956. }
  7957. }
  7958. }
  7959. },
  7960. "/index.php/core/references/preview/{referenceId}": {
  7961. "get": {
  7962. "operationId": "reference-preview",
  7963. "summary": "Get a preview for a reference",
  7964. "tags": [
  7965. "reference"
  7966. ],
  7967. "security": [
  7968. {},
  7969. {
  7970. "bearer_auth": []
  7971. },
  7972. {
  7973. "basic_auth": []
  7974. }
  7975. ],
  7976. "parameters": [
  7977. {
  7978. "name": "referenceId",
  7979. "in": "path",
  7980. "description": "the reference cache key",
  7981. "required": true,
  7982. "schema": {
  7983. "type": "string"
  7984. }
  7985. }
  7986. ],
  7987. "responses": {
  7988. "200": {
  7989. "description": "Preview returned",
  7990. "content": {
  7991. "*/*": {
  7992. "schema": {
  7993. "type": "string",
  7994. "format": "binary"
  7995. }
  7996. }
  7997. }
  7998. },
  7999. "404": {
  8000. "description": "Reference not found",
  8001. "content": {
  8002. "application/json": {
  8003. "schema": {
  8004. "type": "string"
  8005. }
  8006. }
  8007. }
  8008. }
  8009. }
  8010. }
  8011. },
  8012. "/index.php/core/wipe/check": {
  8013. "post": {
  8014. "operationId": "wipe-check-wipe",
  8015. "summary": "Check if the device should be wiped",
  8016. "tags": [
  8017. "wipe"
  8018. ],
  8019. "security": [
  8020. {},
  8021. {
  8022. "bearer_auth": []
  8023. },
  8024. {
  8025. "basic_auth": []
  8026. }
  8027. ],
  8028. "requestBody": {
  8029. "required": true,
  8030. "content": {
  8031. "application/json": {
  8032. "schema": {
  8033. "type": "object",
  8034. "required": [
  8035. "token"
  8036. ],
  8037. "properties": {
  8038. "token": {
  8039. "type": "string",
  8040. "description": "App password"
  8041. }
  8042. }
  8043. }
  8044. }
  8045. }
  8046. },
  8047. "responses": {
  8048. "200": {
  8049. "description": "Device should be wiped",
  8050. "content": {
  8051. "application/json": {
  8052. "schema": {
  8053. "type": "object",
  8054. "required": [
  8055. "wipe"
  8056. ],
  8057. "properties": {
  8058. "wipe": {
  8059. "type": "boolean"
  8060. }
  8061. }
  8062. }
  8063. }
  8064. }
  8065. },
  8066. "404": {
  8067. "description": "Device should not be wiped",
  8068. "content": {
  8069. "application/json": {
  8070. "schema": {}
  8071. }
  8072. }
  8073. }
  8074. }
  8075. }
  8076. },
  8077. "/index.php/core/wipe/success": {
  8078. "post": {
  8079. "operationId": "wipe-wipe-done",
  8080. "summary": "Finish the wipe",
  8081. "tags": [
  8082. "wipe"
  8083. ],
  8084. "security": [
  8085. {},
  8086. {
  8087. "bearer_auth": []
  8088. },
  8089. {
  8090. "basic_auth": []
  8091. }
  8092. ],
  8093. "requestBody": {
  8094. "required": true,
  8095. "content": {
  8096. "application/json": {
  8097. "schema": {
  8098. "type": "object",
  8099. "required": [
  8100. "token"
  8101. ],
  8102. "properties": {
  8103. "token": {
  8104. "type": "string",
  8105. "description": "App password"
  8106. }
  8107. }
  8108. }
  8109. }
  8110. }
  8111. },
  8112. "responses": {
  8113. "200": {
  8114. "description": "Wipe finished successfully",
  8115. "content": {
  8116. "application/json": {
  8117. "schema": {}
  8118. }
  8119. }
  8120. },
  8121. "404": {
  8122. "description": "Device should not be wiped",
  8123. "content": {
  8124. "application/json": {
  8125. "schema": {}
  8126. }
  8127. }
  8128. }
  8129. }
  8130. }
  8131. },
  8132. "/status.php": {
  8133. "get": {
  8134. "operationId": "get-status",
  8135. "responses": {
  8136. "200": {
  8137. "description": "Status returned",
  8138. "content": {
  8139. "application/json": {
  8140. "schema": {
  8141. "$ref": "#/components/schemas/Status"
  8142. }
  8143. }
  8144. }
  8145. }
  8146. }
  8147. }
  8148. }
  8149. },
  8150. "tags": [
  8151. {
  8152. "name": "avatar",
  8153. "description": "Class AvatarController"
  8154. },
  8155. {
  8156. "name": "guest_avatar",
  8157. "description": "This controller handles guest avatar requests."
  8158. },
  8159. {
  8160. "name": "ocm",
  8161. "description": "Controller about the endpoint /ocm-provider/"
  8162. }
  8163. ]
  8164. }