You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

openapi.json 266KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342
  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. "Collection": {
  90. "type": "object",
  91. "required": [
  92. "id",
  93. "name",
  94. "resources"
  95. ],
  96. "properties": {
  97. "id": {
  98. "type": "integer",
  99. "format": "int64"
  100. },
  101. "name": {
  102. "type": "string"
  103. },
  104. "resources": {
  105. "type": "array",
  106. "items": {
  107. "$ref": "#/components/schemas/Resource"
  108. }
  109. }
  110. }
  111. },
  112. "ContactsAction": {
  113. "type": "object",
  114. "required": [
  115. "title",
  116. "icon",
  117. "hyperlink",
  118. "appId"
  119. ],
  120. "properties": {
  121. "title": {
  122. "type": "string"
  123. },
  124. "icon": {
  125. "type": "string"
  126. },
  127. "hyperlink": {
  128. "type": "string"
  129. },
  130. "appId": {
  131. "type": "string"
  132. }
  133. }
  134. },
  135. "LoginFlowV2": {
  136. "type": "object",
  137. "required": [
  138. "poll",
  139. "login"
  140. ],
  141. "properties": {
  142. "poll": {
  143. "type": "object",
  144. "required": [
  145. "token",
  146. "endpoint"
  147. ],
  148. "properties": {
  149. "token": {
  150. "type": "string"
  151. },
  152. "endpoint": {
  153. "type": "string"
  154. }
  155. }
  156. },
  157. "login": {
  158. "type": "string"
  159. }
  160. }
  161. },
  162. "LoginFlowV2Credentials": {
  163. "type": "object",
  164. "required": [
  165. "server",
  166. "loginName",
  167. "appPassword"
  168. ],
  169. "properties": {
  170. "server": {
  171. "type": "string"
  172. },
  173. "loginName": {
  174. "type": "string"
  175. },
  176. "appPassword": {
  177. "type": "string"
  178. }
  179. }
  180. },
  181. "NavigationEntry": {
  182. "type": "object",
  183. "required": [
  184. "id",
  185. "order",
  186. "href",
  187. "icon",
  188. "type",
  189. "name",
  190. "active",
  191. "classes",
  192. "unread"
  193. ],
  194. "properties": {
  195. "id": {
  196. "type": "string"
  197. },
  198. "order": {
  199. "oneOf": [
  200. {
  201. "type": "integer",
  202. "format": "int64"
  203. },
  204. {
  205. "type": "string"
  206. }
  207. ]
  208. },
  209. "href": {
  210. "type": "string"
  211. },
  212. "icon": {
  213. "type": "string"
  214. },
  215. "type": {
  216. "type": "string"
  217. },
  218. "name": {
  219. "type": "string"
  220. },
  221. "active": {
  222. "type": "boolean"
  223. },
  224. "classes": {
  225. "type": "string"
  226. },
  227. "unread": {
  228. "type": "integer",
  229. "format": "int64"
  230. }
  231. }
  232. },
  233. "OCSMeta": {
  234. "type": "object",
  235. "required": [
  236. "status",
  237. "statuscode"
  238. ],
  239. "properties": {
  240. "status": {
  241. "type": "string"
  242. },
  243. "statuscode": {
  244. "type": "integer"
  245. },
  246. "message": {
  247. "type": "string"
  248. },
  249. "totalitems": {
  250. "type": "string"
  251. },
  252. "itemsperpage": {
  253. "type": "string"
  254. }
  255. }
  256. },
  257. "OpenGraphObject": {
  258. "type": "object",
  259. "required": [
  260. "id",
  261. "name",
  262. "description",
  263. "thumb",
  264. "link"
  265. ],
  266. "properties": {
  267. "id": {
  268. "type": "string"
  269. },
  270. "name": {
  271. "type": "string"
  272. },
  273. "description": {
  274. "type": "string",
  275. "nullable": true
  276. },
  277. "thumb": {
  278. "type": "string",
  279. "nullable": true
  280. },
  281. "link": {
  282. "type": "string"
  283. }
  284. }
  285. },
  286. "Reference": {
  287. "type": "object",
  288. "required": [
  289. "richObjectType",
  290. "richObject",
  291. "openGraphObject",
  292. "accessible"
  293. ],
  294. "properties": {
  295. "richObjectType": {
  296. "type": "string"
  297. },
  298. "richObject": {
  299. "type": "object",
  300. "additionalProperties": {
  301. "type": "object"
  302. }
  303. },
  304. "openGraphObject": {
  305. "$ref": "#/components/schemas/OpenGraphObject"
  306. },
  307. "accessible": {
  308. "type": "boolean"
  309. }
  310. }
  311. },
  312. "ReferenceProvider": {
  313. "type": "object",
  314. "required": [
  315. "id",
  316. "title",
  317. "icon_url",
  318. "order",
  319. "search_providers_ids"
  320. ],
  321. "properties": {
  322. "id": {
  323. "type": "string"
  324. },
  325. "title": {
  326. "type": "string"
  327. },
  328. "icon_url": {
  329. "type": "string"
  330. },
  331. "order": {
  332. "type": "integer",
  333. "format": "int64"
  334. },
  335. "search_providers_ids": {
  336. "type": "array",
  337. "nullable": true,
  338. "items": {
  339. "type": "string"
  340. }
  341. }
  342. }
  343. },
  344. "Resource": {
  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. }
  361. },
  362. "openGraphObject": {
  363. "$ref": "#/components/schemas/OpenGraphObject"
  364. },
  365. "accessible": {
  366. "type": "boolean"
  367. }
  368. }
  369. },
  370. "Status": {
  371. "type": "object",
  372. "required": [
  373. "installed",
  374. "maintenance",
  375. "needsDbUpgrade",
  376. "version",
  377. "versionstring",
  378. "edition",
  379. "productname",
  380. "extendedSupport"
  381. ],
  382. "properties": {
  383. "installed": {
  384. "type": "boolean"
  385. },
  386. "maintenance": {
  387. "type": "boolean"
  388. },
  389. "needsDbUpgrade": {
  390. "type": "boolean"
  391. },
  392. "version": {
  393. "type": "string"
  394. },
  395. "versionstring": {
  396. "type": "string"
  397. },
  398. "edition": {
  399. "type": "string"
  400. },
  401. "productname": {
  402. "type": "string"
  403. },
  404. "extendedSupport": {
  405. "type": "boolean"
  406. }
  407. }
  408. },
  409. "TextProcessingTask": {
  410. "type": "object",
  411. "required": [
  412. "id",
  413. "type",
  414. "status",
  415. "userId",
  416. "appId",
  417. "input",
  418. "output",
  419. "identifier",
  420. "completionExpectedAt"
  421. ],
  422. "properties": {
  423. "id": {
  424. "type": "integer",
  425. "format": "int64",
  426. "nullable": true
  427. },
  428. "type": {
  429. "type": "string"
  430. },
  431. "status": {
  432. "type": "integer",
  433. "format": "int64",
  434. "enum": [
  435. 0,
  436. 1,
  437. 2,
  438. 3,
  439. 4
  440. ]
  441. },
  442. "userId": {
  443. "type": "string",
  444. "nullable": true
  445. },
  446. "appId": {
  447. "type": "string"
  448. },
  449. "input": {
  450. "type": "string"
  451. },
  452. "output": {
  453. "type": "string",
  454. "nullable": true
  455. },
  456. "identifier": {
  457. "type": "string"
  458. },
  459. "completionExpectedAt": {
  460. "type": "integer",
  461. "format": "int64",
  462. "nullable": true
  463. }
  464. }
  465. },
  466. "TextToImageTask": {
  467. "type": "object",
  468. "required": [
  469. "id",
  470. "status",
  471. "userId",
  472. "appId",
  473. "input",
  474. "identifier",
  475. "numberOfImages",
  476. "completionExpectedAt"
  477. ],
  478. "properties": {
  479. "id": {
  480. "type": "integer",
  481. "format": "int64",
  482. "nullable": true
  483. },
  484. "status": {
  485. "type": "integer",
  486. "format": "int64",
  487. "enum": [
  488. 0,
  489. 1,
  490. 2,
  491. 3,
  492. 4
  493. ]
  494. },
  495. "userId": {
  496. "type": "string",
  497. "nullable": true
  498. },
  499. "appId": {
  500. "type": "string"
  501. },
  502. "input": {
  503. "type": "string"
  504. },
  505. "identifier": {
  506. "type": "string",
  507. "nullable": true
  508. },
  509. "numberOfImages": {
  510. "type": "integer",
  511. "format": "int64"
  512. },
  513. "completionExpectedAt": {
  514. "type": "integer",
  515. "format": "int64",
  516. "nullable": true
  517. }
  518. }
  519. },
  520. "UnifiedSearchProvider": {
  521. "type": "object",
  522. "required": [
  523. "id",
  524. "appId",
  525. "name",
  526. "icon",
  527. "order",
  528. "triggers",
  529. "filters",
  530. "inAppSearch"
  531. ],
  532. "properties": {
  533. "id": {
  534. "type": "string"
  535. },
  536. "appId": {
  537. "type": "string"
  538. },
  539. "name": {
  540. "type": "string"
  541. },
  542. "icon": {
  543. "type": "string"
  544. },
  545. "order": {
  546. "type": "integer",
  547. "format": "int64"
  548. },
  549. "triggers": {
  550. "type": "array",
  551. "items": {
  552. "type": "string"
  553. }
  554. },
  555. "filters": {
  556. "type": "object",
  557. "additionalProperties": {
  558. "type": "string"
  559. }
  560. },
  561. "inAppSearch": {
  562. "type": "boolean"
  563. }
  564. }
  565. },
  566. "UnifiedSearchResult": {
  567. "type": "object",
  568. "required": [
  569. "name",
  570. "isPaginated",
  571. "entries",
  572. "cursor"
  573. ],
  574. "properties": {
  575. "name": {
  576. "type": "string"
  577. },
  578. "isPaginated": {
  579. "type": "boolean"
  580. },
  581. "entries": {
  582. "type": "array",
  583. "items": {
  584. "$ref": "#/components/schemas/UnifiedSearchResultEntry"
  585. }
  586. },
  587. "cursor": {
  588. "nullable": true,
  589. "oneOf": [
  590. {
  591. "type": "integer",
  592. "format": "int64"
  593. },
  594. {
  595. "type": "string"
  596. }
  597. ]
  598. }
  599. }
  600. },
  601. "UnifiedSearchResultEntry": {
  602. "type": "object",
  603. "required": [
  604. "thumbnailUrl",
  605. "title",
  606. "subline",
  607. "resourceUrl",
  608. "icon",
  609. "rounded",
  610. "attributes"
  611. ],
  612. "properties": {
  613. "thumbnailUrl": {
  614. "type": "string"
  615. },
  616. "title": {
  617. "type": "string"
  618. },
  619. "subline": {
  620. "type": "string"
  621. },
  622. "resourceUrl": {
  623. "type": "string"
  624. },
  625. "icon": {
  626. "type": "string"
  627. },
  628. "rounded": {
  629. "type": "boolean"
  630. },
  631. "attributes": {
  632. "type": "array",
  633. "items": {
  634. "type": "string"
  635. }
  636. }
  637. }
  638. }
  639. }
  640. },
  641. "paths": {
  642. "/index.php/avatar/{userId}/{size}/dark": {
  643. "get": {
  644. "operationId": "avatar-get-avatar-dark",
  645. "summary": "Get the dark avatar",
  646. "tags": [
  647. "avatar"
  648. ],
  649. "security": [
  650. {},
  651. {
  652. "bearer_auth": []
  653. },
  654. {
  655. "basic_auth": []
  656. }
  657. ],
  658. "parameters": [
  659. {
  660. "name": "userId",
  661. "in": "path",
  662. "description": "ID of the user",
  663. "required": true,
  664. "schema": {
  665. "type": "string"
  666. }
  667. },
  668. {
  669. "name": "size",
  670. "in": "path",
  671. "description": "Size of the avatar",
  672. "required": true,
  673. "schema": {
  674. "type": "integer",
  675. "format": "int64"
  676. }
  677. }
  678. ],
  679. "responses": {
  680. "200": {
  681. "description": "Avatar returned",
  682. "headers": {
  683. "X-NC-IsCustomAvatar": {
  684. "schema": {
  685. "type": "integer",
  686. "format": "int64"
  687. }
  688. }
  689. },
  690. "content": {
  691. "*/*": {
  692. "schema": {
  693. "type": "string",
  694. "format": "binary"
  695. }
  696. }
  697. }
  698. },
  699. "404": {
  700. "description": "Avatar not found",
  701. "content": {
  702. "application/json": {
  703. "schema": {}
  704. }
  705. }
  706. }
  707. }
  708. }
  709. },
  710. "/index.php/avatar/{userId}/{size}": {
  711. "get": {
  712. "operationId": "avatar-get-avatar",
  713. "summary": "Get the avatar",
  714. "tags": [
  715. "avatar"
  716. ],
  717. "security": [
  718. {},
  719. {
  720. "bearer_auth": []
  721. },
  722. {
  723. "basic_auth": []
  724. }
  725. ],
  726. "parameters": [
  727. {
  728. "name": "userId",
  729. "in": "path",
  730. "description": "ID of the user",
  731. "required": true,
  732. "schema": {
  733. "type": "string"
  734. }
  735. },
  736. {
  737. "name": "size",
  738. "in": "path",
  739. "description": "Size of the avatar",
  740. "required": true,
  741. "schema": {
  742. "type": "integer",
  743. "format": "int64"
  744. }
  745. }
  746. ],
  747. "responses": {
  748. "200": {
  749. "description": "Avatar returned",
  750. "headers": {
  751. "X-NC-IsCustomAvatar": {
  752. "schema": {
  753. "type": "integer",
  754. "format": "int64"
  755. }
  756. }
  757. },
  758. "content": {
  759. "*/*": {
  760. "schema": {
  761. "type": "string",
  762. "format": "binary"
  763. }
  764. }
  765. }
  766. },
  767. "404": {
  768. "description": "Avatar not found",
  769. "content": {
  770. "application/json": {
  771. "schema": {}
  772. }
  773. }
  774. }
  775. }
  776. }
  777. },
  778. "/index.php/avatar/guest/{guestName}/{size}/dark": {
  779. "get": {
  780. "operationId": "guest_avatar-get-avatar-dark",
  781. "summary": "Returns a dark guest avatar image response",
  782. "tags": [
  783. "guest_avatar"
  784. ],
  785. "security": [
  786. {},
  787. {
  788. "bearer_auth": []
  789. },
  790. {
  791. "basic_auth": []
  792. }
  793. ],
  794. "parameters": [
  795. {
  796. "name": "guestName",
  797. "in": "path",
  798. "description": "The guest name, e.g. \"Albert\"",
  799. "required": true,
  800. "schema": {
  801. "type": "string"
  802. }
  803. },
  804. {
  805. "name": "size",
  806. "in": "path",
  807. "description": "The desired avatar size, e.g. 64 for 64x64px",
  808. "required": true,
  809. "schema": {
  810. "type": "string"
  811. }
  812. }
  813. ],
  814. "responses": {
  815. "200": {
  816. "description": "Custom avatar returned",
  817. "content": {
  818. "*/*": {
  819. "schema": {
  820. "type": "string",
  821. "format": "binary"
  822. }
  823. }
  824. }
  825. },
  826. "201": {
  827. "description": "Avatar returned",
  828. "content": {
  829. "*/*": {
  830. "schema": {
  831. "type": "string",
  832. "format": "binary"
  833. }
  834. }
  835. }
  836. },
  837. "500": {
  838. "description": ""
  839. }
  840. }
  841. }
  842. },
  843. "/index.php/avatar/guest/{guestName}/{size}": {
  844. "get": {
  845. "operationId": "guest_avatar-get-avatar",
  846. "summary": "Returns a guest avatar image response",
  847. "tags": [
  848. "guest_avatar"
  849. ],
  850. "security": [
  851. {},
  852. {
  853. "bearer_auth": []
  854. },
  855. {
  856. "basic_auth": []
  857. }
  858. ],
  859. "parameters": [
  860. {
  861. "name": "darkTheme",
  862. "in": "query",
  863. "description": "Return dark avatar",
  864. "schema": {
  865. "type": "integer",
  866. "nullable": true,
  867. "default": 0,
  868. "enum": [
  869. 0,
  870. 1
  871. ]
  872. }
  873. },
  874. {
  875. "name": "guestName",
  876. "in": "path",
  877. "description": "The guest name, e.g. \"Albert\"",
  878. "required": true,
  879. "schema": {
  880. "type": "string"
  881. }
  882. },
  883. {
  884. "name": "size",
  885. "in": "path",
  886. "description": "The desired avatar size, e.g. 64 for 64x64px",
  887. "required": true,
  888. "schema": {
  889. "type": "string"
  890. }
  891. }
  892. ],
  893. "responses": {
  894. "200": {
  895. "description": "Custom avatar returned",
  896. "content": {
  897. "*/*": {
  898. "schema": {
  899. "type": "string",
  900. "format": "binary"
  901. }
  902. }
  903. }
  904. },
  905. "201": {
  906. "description": "Avatar returned",
  907. "content": {
  908. "*/*": {
  909. "schema": {
  910. "type": "string",
  911. "format": "binary"
  912. }
  913. }
  914. }
  915. },
  916. "500": {
  917. "description": ""
  918. }
  919. }
  920. }
  921. },
  922. "/index.php/login/confirm": {
  923. "post": {
  924. "operationId": "login-confirm-password",
  925. "summary": "Confirm the user password",
  926. "tags": [
  927. "login"
  928. ],
  929. "security": [
  930. {
  931. "bearer_auth": []
  932. },
  933. {
  934. "basic_auth": []
  935. }
  936. ],
  937. "parameters": [
  938. {
  939. "name": "password",
  940. "in": "query",
  941. "description": "The password of the user",
  942. "required": true,
  943. "schema": {
  944. "type": "string"
  945. }
  946. }
  947. ],
  948. "responses": {
  949. "200": {
  950. "description": "Password confirmation succeeded",
  951. "content": {
  952. "application/json": {
  953. "schema": {
  954. "type": "object",
  955. "required": [
  956. "lastLogin"
  957. ],
  958. "properties": {
  959. "lastLogin": {
  960. "type": "integer",
  961. "format": "int64"
  962. }
  963. }
  964. }
  965. }
  966. }
  967. },
  968. "403": {
  969. "description": "Password confirmation failed",
  970. "content": {
  971. "application/json": {
  972. "schema": {}
  973. }
  974. }
  975. }
  976. }
  977. }
  978. },
  979. "/index.php/login/v2/poll": {
  980. "post": {
  981. "operationId": "client_flow_login_v2-poll",
  982. "summary": "Poll the login flow credentials",
  983. "tags": [
  984. "client_flow_login_v2"
  985. ],
  986. "security": [
  987. {},
  988. {
  989. "bearer_auth": []
  990. },
  991. {
  992. "basic_auth": []
  993. }
  994. ],
  995. "parameters": [
  996. {
  997. "name": "token",
  998. "in": "query",
  999. "description": "Token of the flow",
  1000. "required": true,
  1001. "schema": {
  1002. "type": "string"
  1003. }
  1004. }
  1005. ],
  1006. "responses": {
  1007. "200": {
  1008. "description": "Login flow credentials returned",
  1009. "content": {
  1010. "application/json": {
  1011. "schema": {
  1012. "$ref": "#/components/schemas/LoginFlowV2Credentials"
  1013. }
  1014. }
  1015. }
  1016. },
  1017. "404": {
  1018. "description": "Login flow not found or completed",
  1019. "content": {
  1020. "application/json": {
  1021. "schema": {}
  1022. }
  1023. }
  1024. }
  1025. }
  1026. }
  1027. },
  1028. "/index.php/login/v2": {
  1029. "post": {
  1030. "operationId": "client_flow_login_v2-init",
  1031. "summary": "Init a login flow",
  1032. "tags": [
  1033. "client_flow_login_v2"
  1034. ],
  1035. "security": [
  1036. {},
  1037. {
  1038. "bearer_auth": []
  1039. },
  1040. {
  1041. "basic_auth": []
  1042. }
  1043. ],
  1044. "responses": {
  1045. "200": {
  1046. "description": "Login flow init returned",
  1047. "content": {
  1048. "application/json": {
  1049. "schema": {
  1050. "$ref": "#/components/schemas/LoginFlowV2"
  1051. }
  1052. }
  1053. }
  1054. }
  1055. }
  1056. }
  1057. },
  1058. "/index.php/core/preview": {
  1059. "get": {
  1060. "operationId": "preview-get-preview-by-file-id",
  1061. "summary": "Get a preview by file ID",
  1062. "tags": [
  1063. "preview"
  1064. ],
  1065. "security": [
  1066. {
  1067. "bearer_auth": []
  1068. },
  1069. {
  1070. "basic_auth": []
  1071. }
  1072. ],
  1073. "parameters": [
  1074. {
  1075. "name": "fileId",
  1076. "in": "query",
  1077. "description": "ID of the file",
  1078. "schema": {
  1079. "type": "integer",
  1080. "format": "int64",
  1081. "default": -1
  1082. }
  1083. },
  1084. {
  1085. "name": "x",
  1086. "in": "query",
  1087. "description": "Width of the preview",
  1088. "schema": {
  1089. "type": "integer",
  1090. "format": "int64",
  1091. "default": 32
  1092. }
  1093. },
  1094. {
  1095. "name": "y",
  1096. "in": "query",
  1097. "description": "Height of the preview",
  1098. "schema": {
  1099. "type": "integer",
  1100. "format": "int64",
  1101. "default": 32
  1102. }
  1103. },
  1104. {
  1105. "name": "a",
  1106. "in": "query",
  1107. "description": "Whether to not crop the preview",
  1108. "schema": {
  1109. "type": "integer",
  1110. "default": 0,
  1111. "enum": [
  1112. 0,
  1113. 1
  1114. ]
  1115. }
  1116. },
  1117. {
  1118. "name": "forceIcon",
  1119. "in": "query",
  1120. "description": "Force returning an icon",
  1121. "schema": {
  1122. "type": "integer",
  1123. "default": 1,
  1124. "enum": [
  1125. 0,
  1126. 1
  1127. ]
  1128. }
  1129. },
  1130. {
  1131. "name": "mode",
  1132. "in": "query",
  1133. "description": "How to crop the image",
  1134. "schema": {
  1135. "type": "string",
  1136. "default": "fill"
  1137. }
  1138. },
  1139. {
  1140. "name": "mimeFallback",
  1141. "in": "query",
  1142. "description": "Whether to fallback to the mime icon if no preview is available",
  1143. "schema": {
  1144. "type": "integer",
  1145. "default": 0,
  1146. "enum": [
  1147. 0,
  1148. 1
  1149. ]
  1150. }
  1151. }
  1152. ],
  1153. "responses": {
  1154. "200": {
  1155. "description": "Preview returned",
  1156. "content": {
  1157. "*/*": {
  1158. "schema": {
  1159. "type": "string",
  1160. "format": "binary"
  1161. }
  1162. }
  1163. }
  1164. },
  1165. "400": {
  1166. "description": "Getting preview is not possible",
  1167. "content": {
  1168. "application/json": {
  1169. "schema": {}
  1170. }
  1171. }
  1172. },
  1173. "403": {
  1174. "description": "Getting preview is not allowed",
  1175. "content": {
  1176. "application/json": {
  1177. "schema": {}
  1178. }
  1179. }
  1180. },
  1181. "404": {
  1182. "description": "Preview not found",
  1183. "content": {
  1184. "application/json": {
  1185. "schema": {}
  1186. }
  1187. }
  1188. },
  1189. "303": {
  1190. "description": "Redirect to the mime icon url if mimeFallback is true",
  1191. "headers": {
  1192. "Location": {
  1193. "schema": {
  1194. "type": "string"
  1195. }
  1196. }
  1197. }
  1198. }
  1199. }
  1200. }
  1201. },
  1202. "/index.php/core/preview.png": {
  1203. "get": {
  1204. "operationId": "preview-get-preview",
  1205. "summary": "Get a preview by file path",
  1206. "tags": [
  1207. "preview"
  1208. ],
  1209. "security": [
  1210. {
  1211. "bearer_auth": []
  1212. },
  1213. {
  1214. "basic_auth": []
  1215. }
  1216. ],
  1217. "parameters": [
  1218. {
  1219. "name": "file",
  1220. "in": "query",
  1221. "description": "Path of the file",
  1222. "schema": {
  1223. "type": "string",
  1224. "default": ""
  1225. }
  1226. },
  1227. {
  1228. "name": "x",
  1229. "in": "query",
  1230. "description": "Width of the preview",
  1231. "schema": {
  1232. "type": "integer",
  1233. "format": "int64",
  1234. "default": 32
  1235. }
  1236. },
  1237. {
  1238. "name": "y",
  1239. "in": "query",
  1240. "description": "Height of the preview",
  1241. "schema": {
  1242. "type": "integer",
  1243. "format": "int64",
  1244. "default": 32
  1245. }
  1246. },
  1247. {
  1248. "name": "a",
  1249. "in": "query",
  1250. "description": "Whether to not crop the preview",
  1251. "schema": {
  1252. "type": "integer",
  1253. "default": 0,
  1254. "enum": [
  1255. 0,
  1256. 1
  1257. ]
  1258. }
  1259. },
  1260. {
  1261. "name": "forceIcon",
  1262. "in": "query",
  1263. "description": "Force returning an icon",
  1264. "schema": {
  1265. "type": "integer",
  1266. "default": 1,
  1267. "enum": [
  1268. 0,
  1269. 1
  1270. ]
  1271. }
  1272. },
  1273. {
  1274. "name": "mode",
  1275. "in": "query",
  1276. "description": "How to crop the image",
  1277. "schema": {
  1278. "type": "string",
  1279. "default": "fill"
  1280. }
  1281. },
  1282. {
  1283. "name": "mimeFallback",
  1284. "in": "query",
  1285. "description": "Whether to fallback to the mime icon if no preview is available",
  1286. "schema": {
  1287. "type": "integer",
  1288. "default": 0,
  1289. "enum": [
  1290. 0,
  1291. 1
  1292. ]
  1293. }
  1294. }
  1295. ],
  1296. "responses": {
  1297. "200": {
  1298. "description": "Preview returned",
  1299. "content": {
  1300. "*/*": {
  1301. "schema": {
  1302. "type": "string",
  1303. "format": "binary"
  1304. }
  1305. }
  1306. }
  1307. },
  1308. "400": {
  1309. "description": "Getting preview is not possible",
  1310. "content": {
  1311. "application/json": {
  1312. "schema": {}
  1313. }
  1314. }
  1315. },
  1316. "403": {
  1317. "description": "Getting preview is not allowed",
  1318. "content": {
  1319. "application/json": {
  1320. "schema": {}
  1321. }
  1322. }
  1323. },
  1324. "404": {
  1325. "description": "Preview not found",
  1326. "content": {
  1327. "application/json": {
  1328. "schema": {}
  1329. }
  1330. }
  1331. },
  1332. "303": {
  1333. "description": "Redirect to the mime icon url if mimeFallback is true",
  1334. "headers": {
  1335. "Location": {
  1336. "schema": {
  1337. "type": "string"
  1338. }
  1339. }
  1340. }
  1341. }
  1342. }
  1343. }
  1344. },
  1345. "/index.php/core/references/preview/{referenceId}": {
  1346. "get": {
  1347. "operationId": "reference-preview",
  1348. "summary": "Get a preview for a reference",
  1349. "tags": [
  1350. "reference"
  1351. ],
  1352. "security": [
  1353. {},
  1354. {
  1355. "bearer_auth": []
  1356. },
  1357. {
  1358. "basic_auth": []
  1359. }
  1360. ],
  1361. "parameters": [
  1362. {
  1363. "name": "referenceId",
  1364. "in": "path",
  1365. "description": "the reference cache key",
  1366. "required": true,
  1367. "schema": {
  1368. "type": "string"
  1369. }
  1370. }
  1371. ],
  1372. "responses": {
  1373. "200": {
  1374. "description": "Preview returned",
  1375. "content": {
  1376. "*/*": {
  1377. "schema": {
  1378. "type": "string",
  1379. "format": "binary"
  1380. }
  1381. }
  1382. }
  1383. },
  1384. "404": {
  1385. "description": "Reference not found",
  1386. "content": {
  1387. "application/json": {
  1388. "schema": {
  1389. "type": "string"
  1390. }
  1391. }
  1392. }
  1393. }
  1394. }
  1395. }
  1396. },
  1397. "/index.php/core/wipe/check": {
  1398. "post": {
  1399. "operationId": "wipe-check-wipe",
  1400. "summary": "Check if the device should be wiped",
  1401. "tags": [
  1402. "wipe"
  1403. ],
  1404. "security": [
  1405. {},
  1406. {
  1407. "bearer_auth": []
  1408. },
  1409. {
  1410. "basic_auth": []
  1411. }
  1412. ],
  1413. "parameters": [
  1414. {
  1415. "name": "token",
  1416. "in": "query",
  1417. "description": "App password",
  1418. "required": true,
  1419. "schema": {
  1420. "type": "string"
  1421. }
  1422. }
  1423. ],
  1424. "responses": {
  1425. "200": {
  1426. "description": "Device should be wiped",
  1427. "content": {
  1428. "application/json": {
  1429. "schema": {
  1430. "type": "object",
  1431. "required": [
  1432. "wipe"
  1433. ],
  1434. "properties": {
  1435. "wipe": {
  1436. "type": "boolean"
  1437. }
  1438. }
  1439. }
  1440. }
  1441. }
  1442. },
  1443. "404": {
  1444. "description": "Device should not be wiped",
  1445. "content": {
  1446. "application/json": {
  1447. "schema": {}
  1448. }
  1449. }
  1450. }
  1451. }
  1452. }
  1453. },
  1454. "/index.php/core/wipe/success": {
  1455. "post": {
  1456. "operationId": "wipe-wipe-done",
  1457. "summary": "Finish the wipe",
  1458. "tags": [
  1459. "wipe"
  1460. ],
  1461. "security": [
  1462. {},
  1463. {
  1464. "bearer_auth": []
  1465. },
  1466. {
  1467. "basic_auth": []
  1468. }
  1469. ],
  1470. "parameters": [
  1471. {
  1472. "name": "token",
  1473. "in": "query",
  1474. "description": "App password",
  1475. "required": true,
  1476. "schema": {
  1477. "type": "string"
  1478. }
  1479. }
  1480. ],
  1481. "responses": {
  1482. "200": {
  1483. "description": "Wipe finished successfully",
  1484. "content": {
  1485. "application/json": {
  1486. "schema": {}
  1487. }
  1488. }
  1489. },
  1490. "404": {
  1491. "description": "Device should not be wiped",
  1492. "content": {
  1493. "application/json": {
  1494. "schema": {}
  1495. }
  1496. }
  1497. }
  1498. }
  1499. }
  1500. },
  1501. "/index.php/ocm-provider": {
  1502. "get": {
  1503. "operationId": "ocm-discovery",
  1504. "summary": "generate a OCMProvider with local data and send it as DataResponse. This replaces the old PHP file ocm-provider/index.php",
  1505. "tags": [
  1506. "ocm"
  1507. ],
  1508. "security": [
  1509. {},
  1510. {
  1511. "bearer_auth": []
  1512. },
  1513. {
  1514. "basic_auth": []
  1515. }
  1516. ],
  1517. "responses": {
  1518. "200": {
  1519. "description": "OCM Provider details returned",
  1520. "headers": {
  1521. "X-NEXTCLOUD-OCM-PROVIDERS": {
  1522. "schema": {
  1523. "type": "boolean",
  1524. "enum": [
  1525. true
  1526. ]
  1527. }
  1528. }
  1529. },
  1530. "content": {
  1531. "application/json": {
  1532. "schema": {
  1533. "type": "object",
  1534. "required": [
  1535. "enabled",
  1536. "apiVersion",
  1537. "endPoint",
  1538. "resourceTypes"
  1539. ],
  1540. "properties": {
  1541. "enabled": {
  1542. "type": "boolean"
  1543. },
  1544. "apiVersion": {
  1545. "type": "string"
  1546. },
  1547. "endPoint": {
  1548. "type": "string"
  1549. },
  1550. "resourceTypes": {
  1551. "type": "array",
  1552. "items": {
  1553. "type": "object",
  1554. "required": [
  1555. "name",
  1556. "shareTypes",
  1557. "protocols"
  1558. ],
  1559. "properties": {
  1560. "name": {
  1561. "type": "string"
  1562. },
  1563. "shareTypes": {
  1564. "type": "array",
  1565. "items": {
  1566. "type": "string"
  1567. }
  1568. },
  1569. "protocols": {
  1570. "type": "object",
  1571. "required": [
  1572. "webdav"
  1573. ],
  1574. "properties": {
  1575. "webdav": {
  1576. "type": "string"
  1577. }
  1578. }
  1579. }
  1580. }
  1581. }
  1582. }
  1583. }
  1584. }
  1585. }
  1586. }
  1587. },
  1588. "500": {
  1589. "description": "OCM not supported",
  1590. "content": {
  1591. "application/json": {
  1592. "schema": {
  1593. "type": "object",
  1594. "required": [
  1595. "message"
  1596. ],
  1597. "properties": {
  1598. "message": {
  1599. "type": "string"
  1600. }
  1601. }
  1602. }
  1603. }
  1604. }
  1605. }
  1606. }
  1607. }
  1608. },
  1609. "/ocs/v2.php/cloud/capabilities": {
  1610. "get": {
  1611. "operationId": "ocs-get-capabilities",
  1612. "summary": "Get the capabilities",
  1613. "tags": [
  1614. "ocs"
  1615. ],
  1616. "security": [
  1617. {},
  1618. {
  1619. "bearer_auth": []
  1620. },
  1621. {
  1622. "basic_auth": []
  1623. }
  1624. ],
  1625. "parameters": [
  1626. {
  1627. "name": "OCS-APIRequest",
  1628. "in": "header",
  1629. "description": "Required to be true for the API request to pass",
  1630. "required": true,
  1631. "schema": {
  1632. "type": "boolean",
  1633. "default": true
  1634. }
  1635. }
  1636. ],
  1637. "responses": {
  1638. "200": {
  1639. "description": "Capabilities returned",
  1640. "content": {
  1641. "application/json": {
  1642. "schema": {
  1643. "type": "object",
  1644. "required": [
  1645. "ocs"
  1646. ],
  1647. "properties": {
  1648. "ocs": {
  1649. "type": "object",
  1650. "required": [
  1651. "meta",
  1652. "data"
  1653. ],
  1654. "properties": {
  1655. "meta": {
  1656. "$ref": "#/components/schemas/OCSMeta"
  1657. },
  1658. "data": {
  1659. "type": "object",
  1660. "required": [
  1661. "version",
  1662. "capabilities"
  1663. ],
  1664. "properties": {
  1665. "version": {
  1666. "type": "object",
  1667. "required": [
  1668. "major",
  1669. "minor",
  1670. "micro",
  1671. "string",
  1672. "edition",
  1673. "extendedSupport"
  1674. ],
  1675. "properties": {
  1676. "major": {
  1677. "type": "integer",
  1678. "format": "int64"
  1679. },
  1680. "minor": {
  1681. "type": "integer",
  1682. "format": "int64"
  1683. },
  1684. "micro": {
  1685. "type": "integer",
  1686. "format": "int64"
  1687. },
  1688. "string": {
  1689. "type": "string"
  1690. },
  1691. "edition": {
  1692. "type": "string"
  1693. },
  1694. "extendedSupport": {
  1695. "type": "boolean"
  1696. }
  1697. }
  1698. },
  1699. "capabilities": {
  1700. "type": "object",
  1701. "additionalProperties": {
  1702. "type": "object"
  1703. }
  1704. }
  1705. }
  1706. }
  1707. }
  1708. }
  1709. }
  1710. }
  1711. }
  1712. }
  1713. }
  1714. }
  1715. }
  1716. },
  1717. "/ocs/v2.php/core/navigation/apps": {
  1718. "get": {
  1719. "operationId": "navigation-get-apps-navigation",
  1720. "summary": "Get the apps navigation",
  1721. "tags": [
  1722. "navigation"
  1723. ],
  1724. "security": [
  1725. {
  1726. "bearer_auth": []
  1727. },
  1728. {
  1729. "basic_auth": []
  1730. }
  1731. ],
  1732. "parameters": [
  1733. {
  1734. "name": "absolute",
  1735. "in": "query",
  1736. "description": "Rewrite URLs to absolute ones",
  1737. "schema": {
  1738. "type": "integer",
  1739. "default": 0,
  1740. "enum": [
  1741. 0,
  1742. 1
  1743. ]
  1744. }
  1745. },
  1746. {
  1747. "name": "OCS-APIRequest",
  1748. "in": "header",
  1749. "description": "Required to be true for the API request to pass",
  1750. "required": true,
  1751. "schema": {
  1752. "type": "boolean",
  1753. "default": true
  1754. }
  1755. }
  1756. ],
  1757. "responses": {
  1758. "200": {
  1759. "description": "Apps navigation returned",
  1760. "content": {
  1761. "application/json": {
  1762. "schema": {
  1763. "type": "object",
  1764. "required": [
  1765. "ocs"
  1766. ],
  1767. "properties": {
  1768. "ocs": {
  1769. "type": "object",
  1770. "required": [
  1771. "meta",
  1772. "data"
  1773. ],
  1774. "properties": {
  1775. "meta": {
  1776. "$ref": "#/components/schemas/OCSMeta"
  1777. },
  1778. "data": {
  1779. "type": "array",
  1780. "items": {
  1781. "$ref": "#/components/schemas/NavigationEntry"
  1782. }
  1783. }
  1784. }
  1785. }
  1786. }
  1787. }
  1788. }
  1789. }
  1790. },
  1791. "304": {
  1792. "description": "No apps navigation changed",
  1793. "content": {
  1794. "application/json": {
  1795. "schema": {
  1796. "type": "object",
  1797. "required": [
  1798. "ocs"
  1799. ],
  1800. "properties": {
  1801. "ocs": {
  1802. "type": "object",
  1803. "required": [
  1804. "meta",
  1805. "data"
  1806. ],
  1807. "properties": {
  1808. "meta": {
  1809. "$ref": "#/components/schemas/OCSMeta"
  1810. },
  1811. "data": {}
  1812. }
  1813. }
  1814. }
  1815. }
  1816. }
  1817. }
  1818. }
  1819. }
  1820. }
  1821. },
  1822. "/ocs/v2.php/core/navigation/settings": {
  1823. "get": {
  1824. "operationId": "navigation-get-settings-navigation",
  1825. "summary": "Get the settings navigation",
  1826. "tags": [
  1827. "navigation"
  1828. ],
  1829. "security": [
  1830. {
  1831. "bearer_auth": []
  1832. },
  1833. {
  1834. "basic_auth": []
  1835. }
  1836. ],
  1837. "parameters": [
  1838. {
  1839. "name": "absolute",
  1840. "in": "query",
  1841. "description": "Rewrite URLs to absolute ones",
  1842. "schema": {
  1843. "type": "integer",
  1844. "default": 0,
  1845. "enum": [
  1846. 0,
  1847. 1
  1848. ]
  1849. }
  1850. },
  1851. {
  1852. "name": "OCS-APIRequest",
  1853. "in": "header",
  1854. "description": "Required to be true for the API request to pass",
  1855. "required": true,
  1856. "schema": {
  1857. "type": "boolean",
  1858. "default": true
  1859. }
  1860. }
  1861. ],
  1862. "responses": {
  1863. "200": {
  1864. "description": "Apps navigation returned",
  1865. "content": {
  1866. "application/json": {
  1867. "schema": {
  1868. "type": "object",
  1869. "required": [
  1870. "ocs"
  1871. ],
  1872. "properties": {
  1873. "ocs": {
  1874. "type": "object",
  1875. "required": [
  1876. "meta",
  1877. "data"
  1878. ],
  1879. "properties": {
  1880. "meta": {
  1881. "$ref": "#/components/schemas/OCSMeta"
  1882. },
  1883. "data": {
  1884. "type": "array",
  1885. "items": {
  1886. "$ref": "#/components/schemas/NavigationEntry"
  1887. }
  1888. }
  1889. }
  1890. }
  1891. }
  1892. }
  1893. }
  1894. }
  1895. },
  1896. "304": {
  1897. "description": "No apps navigation changed",
  1898. "content": {
  1899. "application/json": {
  1900. "schema": {
  1901. "type": "object",
  1902. "required": [
  1903. "ocs"
  1904. ],
  1905. "properties": {
  1906. "ocs": {
  1907. "type": "object",
  1908. "required": [
  1909. "meta",
  1910. "data"
  1911. ],
  1912. "properties": {
  1913. "meta": {
  1914. "$ref": "#/components/schemas/OCSMeta"
  1915. },
  1916. "data": {}
  1917. }
  1918. }
  1919. }
  1920. }
  1921. }
  1922. }
  1923. }
  1924. }
  1925. }
  1926. },
  1927. "/ocs/v2.php/core/autocomplete/get": {
  1928. "get": {
  1929. "operationId": "auto_complete-get",
  1930. "summary": "Autocomplete a query",
  1931. "tags": [
  1932. "auto_complete"
  1933. ],
  1934. "security": [
  1935. {
  1936. "bearer_auth": []
  1937. },
  1938. {
  1939. "basic_auth": []
  1940. }
  1941. ],
  1942. "parameters": [
  1943. {
  1944. "name": "search",
  1945. "in": "query",
  1946. "description": "Text to search for",
  1947. "required": true,
  1948. "schema": {
  1949. "type": "string"
  1950. }
  1951. },
  1952. {
  1953. "name": "itemType",
  1954. "in": "query",
  1955. "description": "Type of the items to search for",
  1956. "schema": {
  1957. "type": "string",
  1958. "nullable": true
  1959. }
  1960. },
  1961. {
  1962. "name": "itemId",
  1963. "in": "query",
  1964. "description": "ID of the items to search for",
  1965. "schema": {
  1966. "type": "string",
  1967. "nullable": true
  1968. }
  1969. },
  1970. {
  1971. "name": "sorter",
  1972. "in": "query",
  1973. "description": "can be piped, top prio first, e.g.: \"commenters|share-recipients\"",
  1974. "schema": {
  1975. "type": "string",
  1976. "nullable": true
  1977. }
  1978. },
  1979. {
  1980. "name": "shareTypes[]",
  1981. "in": "query",
  1982. "description": "Types of shares to search for",
  1983. "schema": {
  1984. "type": "array",
  1985. "default": [],
  1986. "items": {
  1987. "type": "integer",
  1988. "format": "int64"
  1989. }
  1990. }
  1991. },
  1992. {
  1993. "name": "limit",
  1994. "in": "query",
  1995. "description": "Maximum number of results to return",
  1996. "schema": {
  1997. "type": "integer",
  1998. "format": "int64",
  1999. "default": 10
  2000. }
  2001. },
  2002. {
  2003. "name": "OCS-APIRequest",
  2004. "in": "header",
  2005. "description": "Required to be true for the API request to pass",
  2006. "required": true,
  2007. "schema": {
  2008. "type": "boolean",
  2009. "default": true
  2010. }
  2011. }
  2012. ],
  2013. "responses": {
  2014. "200": {
  2015. "description": "Autocomplete results returned",
  2016. "content": {
  2017. "application/json": {
  2018. "schema": {
  2019. "type": "object",
  2020. "required": [
  2021. "ocs"
  2022. ],
  2023. "properties": {
  2024. "ocs": {
  2025. "type": "object",
  2026. "required": [
  2027. "meta",
  2028. "data"
  2029. ],
  2030. "properties": {
  2031. "meta": {
  2032. "$ref": "#/components/schemas/OCSMeta"
  2033. },
  2034. "data": {
  2035. "type": "array",
  2036. "items": {
  2037. "$ref": "#/components/schemas/AutocompleteResult"
  2038. }
  2039. }
  2040. }
  2041. }
  2042. }
  2043. }
  2044. }
  2045. }
  2046. }
  2047. }
  2048. }
  2049. },
  2050. "/ocs/v2.php/core/whatsnew": {
  2051. "get": {
  2052. "operationId": "whats_new-get",
  2053. "summary": "Get the changes",
  2054. "tags": [
  2055. "whats_new"
  2056. ],
  2057. "security": [
  2058. {
  2059. "bearer_auth": []
  2060. },
  2061. {
  2062. "basic_auth": []
  2063. }
  2064. ],
  2065. "parameters": [
  2066. {
  2067. "name": "OCS-APIRequest",
  2068. "in": "header",
  2069. "description": "Required to be true for the API request to pass",
  2070. "required": true,
  2071. "schema": {
  2072. "type": "boolean",
  2073. "default": true
  2074. }
  2075. }
  2076. ],
  2077. "responses": {
  2078. "200": {
  2079. "description": "Changes returned",
  2080. "content": {
  2081. "application/json": {
  2082. "schema": {
  2083. "type": "object",
  2084. "required": [
  2085. "ocs"
  2086. ],
  2087. "properties": {
  2088. "ocs": {
  2089. "type": "object",
  2090. "required": [
  2091. "meta",
  2092. "data"
  2093. ],
  2094. "properties": {
  2095. "meta": {
  2096. "$ref": "#/components/schemas/OCSMeta"
  2097. },
  2098. "data": {
  2099. "type": "object",
  2100. "required": [
  2101. "changelogURL",
  2102. "product",
  2103. "version"
  2104. ],
  2105. "properties": {
  2106. "changelogURL": {
  2107. "type": "string"
  2108. },
  2109. "product": {
  2110. "type": "string"
  2111. },
  2112. "version": {
  2113. "type": "string"
  2114. },
  2115. "whatsNew": {
  2116. "type": "object",
  2117. "required": [
  2118. "regular",
  2119. "admin"
  2120. ],
  2121. "properties": {
  2122. "regular": {
  2123. "type": "array",
  2124. "items": {
  2125. "type": "string"
  2126. }
  2127. },
  2128. "admin": {
  2129. "type": "array",
  2130. "items": {
  2131. "type": "string"
  2132. }
  2133. }
  2134. }
  2135. }
  2136. }
  2137. }
  2138. }
  2139. }
  2140. }
  2141. }
  2142. }
  2143. }
  2144. },
  2145. "204": {
  2146. "description": "No changes",
  2147. "content": {
  2148. "application/json": {
  2149. "schema": {
  2150. "type": "object",
  2151. "required": [
  2152. "ocs"
  2153. ],
  2154. "properties": {
  2155. "ocs": {
  2156. "type": "object",
  2157. "required": [
  2158. "meta",
  2159. "data"
  2160. ],
  2161. "properties": {
  2162. "meta": {
  2163. "$ref": "#/components/schemas/OCSMeta"
  2164. },
  2165. "data": {}
  2166. }
  2167. }
  2168. }
  2169. }
  2170. }
  2171. }
  2172. }
  2173. }
  2174. },
  2175. "post": {
  2176. "operationId": "whats_new-dismiss",
  2177. "summary": "Dismiss the changes",
  2178. "tags": [
  2179. "whats_new"
  2180. ],
  2181. "security": [
  2182. {
  2183. "bearer_auth": []
  2184. },
  2185. {
  2186. "basic_auth": []
  2187. }
  2188. ],
  2189. "parameters": [
  2190. {
  2191. "name": "version",
  2192. "in": "query",
  2193. "description": "Version to dismiss the changes for",
  2194. "required": true,
  2195. "schema": {
  2196. "type": "string"
  2197. }
  2198. },
  2199. {
  2200. "name": "OCS-APIRequest",
  2201. "in": "header",
  2202. "description": "Required to be true for the API request to pass",
  2203. "required": true,
  2204. "schema": {
  2205. "type": "boolean",
  2206. "default": true
  2207. }
  2208. }
  2209. ],
  2210. "responses": {
  2211. "200": {
  2212. "description": "Changes dismissed",
  2213. "content": {
  2214. "application/json": {
  2215. "schema": {
  2216. "type": "object",
  2217. "required": [
  2218. "ocs"
  2219. ],
  2220. "properties": {
  2221. "ocs": {
  2222. "type": "object",
  2223. "required": [
  2224. "meta",
  2225. "data"
  2226. ],
  2227. "properties": {
  2228. "meta": {
  2229. "$ref": "#/components/schemas/OCSMeta"
  2230. },
  2231. "data": {}
  2232. }
  2233. }
  2234. }
  2235. }
  2236. }
  2237. }
  2238. },
  2239. "500": {
  2240. "description": "",
  2241. "content": {
  2242. "text/plain": {
  2243. "schema": {
  2244. "type": "string"
  2245. }
  2246. }
  2247. }
  2248. }
  2249. }
  2250. }
  2251. },
  2252. "/ocs/v2.php/core/getapppassword": {
  2253. "get": {
  2254. "operationId": "app_password-get-app-password",
  2255. "summary": "Create app password",
  2256. "tags": [
  2257. "app_password"
  2258. ],
  2259. "security": [
  2260. {
  2261. "bearer_auth": []
  2262. },
  2263. {
  2264. "basic_auth": []
  2265. }
  2266. ],
  2267. "parameters": [
  2268. {
  2269. "name": "OCS-APIRequest",
  2270. "in": "header",
  2271. "description": "Required to be true for the API request to pass",
  2272. "required": true,
  2273. "schema": {
  2274. "type": "boolean",
  2275. "default": true
  2276. }
  2277. }
  2278. ],
  2279. "responses": {
  2280. "200": {
  2281. "description": "App password returned",
  2282. "content": {
  2283. "application/json": {
  2284. "schema": {
  2285. "type": "object",
  2286. "required": [
  2287. "ocs"
  2288. ],
  2289. "properties": {
  2290. "ocs": {
  2291. "type": "object",
  2292. "required": [
  2293. "meta",
  2294. "data"
  2295. ],
  2296. "properties": {
  2297. "meta": {
  2298. "$ref": "#/components/schemas/OCSMeta"
  2299. },
  2300. "data": {
  2301. "type": "object",
  2302. "required": [
  2303. "apppassword"
  2304. ],
  2305. "properties": {
  2306. "apppassword": {
  2307. "type": "string"
  2308. }
  2309. }
  2310. }
  2311. }
  2312. }
  2313. }
  2314. }
  2315. }
  2316. }
  2317. },
  2318. "403": {
  2319. "description": "Creating app password is not allowed",
  2320. "content": {
  2321. "text/plain": {
  2322. "schema": {
  2323. "type": "string"
  2324. }
  2325. }
  2326. }
  2327. }
  2328. }
  2329. }
  2330. },
  2331. "/ocs/v2.php/core/apppassword/rotate": {
  2332. "post": {
  2333. "operationId": "app_password-rotate-app-password",
  2334. "summary": "Rotate app password",
  2335. "tags": [
  2336. "app_password"
  2337. ],
  2338. "security": [
  2339. {
  2340. "bearer_auth": []
  2341. },
  2342. {
  2343. "basic_auth": []
  2344. }
  2345. ],
  2346. "parameters": [
  2347. {
  2348. "name": "OCS-APIRequest",
  2349. "in": "header",
  2350. "description": "Required to be true for the API request to pass",
  2351. "required": true,
  2352. "schema": {
  2353. "type": "boolean",
  2354. "default": true
  2355. }
  2356. }
  2357. ],
  2358. "responses": {
  2359. "200": {
  2360. "description": "App password returned",
  2361. "content": {
  2362. "application/json": {
  2363. "schema": {
  2364. "type": "object",
  2365. "required": [
  2366. "ocs"
  2367. ],
  2368. "properties": {
  2369. "ocs": {
  2370. "type": "object",
  2371. "required": [
  2372. "meta",
  2373. "data"
  2374. ],
  2375. "properties": {
  2376. "meta": {
  2377. "$ref": "#/components/schemas/OCSMeta"
  2378. },
  2379. "data": {
  2380. "type": "object",
  2381. "required": [
  2382. "apppassword"
  2383. ],
  2384. "properties": {
  2385. "apppassword": {
  2386. "type": "string"
  2387. }
  2388. }
  2389. }
  2390. }
  2391. }
  2392. }
  2393. }
  2394. }
  2395. }
  2396. },
  2397. "403": {
  2398. "description": "Rotating app password is not allowed",
  2399. "content": {
  2400. "text/plain": {
  2401. "schema": {
  2402. "type": "string"
  2403. }
  2404. }
  2405. }
  2406. }
  2407. }
  2408. }
  2409. },
  2410. "/ocs/v2.php/core/apppassword": {
  2411. "delete": {
  2412. "operationId": "app_password-delete-app-password",
  2413. "summary": "Delete app password",
  2414. "tags": [
  2415. "app_password"
  2416. ],
  2417. "security": [
  2418. {
  2419. "bearer_auth": []
  2420. },
  2421. {
  2422. "basic_auth": []
  2423. }
  2424. ],
  2425. "parameters": [
  2426. {
  2427. "name": "OCS-APIRequest",
  2428. "in": "header",
  2429. "description": "Required to be true for the API request to pass",
  2430. "required": true,
  2431. "schema": {
  2432. "type": "boolean",
  2433. "default": true
  2434. }
  2435. }
  2436. ],
  2437. "responses": {
  2438. "200": {
  2439. "description": "App password deleted successfully",
  2440. "content": {
  2441. "application/json": {
  2442. "schema": {
  2443. "type": "object",
  2444. "required": [
  2445. "ocs"
  2446. ],
  2447. "properties": {
  2448. "ocs": {
  2449. "type": "object",
  2450. "required": [
  2451. "meta",
  2452. "data"
  2453. ],
  2454. "properties": {
  2455. "meta": {
  2456. "$ref": "#/components/schemas/OCSMeta"
  2457. },
  2458. "data": {}
  2459. }
  2460. }
  2461. }
  2462. }
  2463. }
  2464. }
  2465. },
  2466. "403": {
  2467. "description": "Deleting app password is not allowed",
  2468. "content": {
  2469. "text/plain": {
  2470. "schema": {
  2471. "type": "string"
  2472. }
  2473. }
  2474. }
  2475. }
  2476. }
  2477. }
  2478. },
  2479. "/ocs/v2.php/core/apppassword/confirm": {
  2480. "put": {
  2481. "operationId": "app_password-confirm-user-password",
  2482. "summary": "Confirm the user password",
  2483. "tags": [
  2484. "app_password"
  2485. ],
  2486. "security": [
  2487. {
  2488. "bearer_auth": []
  2489. },
  2490. {
  2491. "basic_auth": []
  2492. }
  2493. ],
  2494. "parameters": [
  2495. {
  2496. "name": "password",
  2497. "in": "query",
  2498. "description": "The password of the user",
  2499. "required": true,
  2500. "schema": {
  2501. "type": "string"
  2502. }
  2503. },
  2504. {
  2505. "name": "OCS-APIRequest",
  2506. "in": "header",
  2507. "description": "Required to be true for the API request to pass",
  2508. "required": true,
  2509. "schema": {
  2510. "type": "boolean",
  2511. "default": true
  2512. }
  2513. }
  2514. ],
  2515. "responses": {
  2516. "200": {
  2517. "description": "Password confirmation succeeded",
  2518. "content": {
  2519. "application/json": {
  2520. "schema": {
  2521. "type": "object",
  2522. "required": [
  2523. "ocs"
  2524. ],
  2525. "properties": {
  2526. "ocs": {
  2527. "type": "object",
  2528. "required": [
  2529. "meta",
  2530. "data"
  2531. ],
  2532. "properties": {
  2533. "meta": {
  2534. "$ref": "#/components/schemas/OCSMeta"
  2535. },
  2536. "data": {
  2537. "type": "object",
  2538. "required": [
  2539. "lastLogin"
  2540. ],
  2541. "properties": {
  2542. "lastLogin": {
  2543. "type": "integer",
  2544. "format": "int64"
  2545. }
  2546. }
  2547. }
  2548. }
  2549. }
  2550. }
  2551. }
  2552. }
  2553. }
  2554. },
  2555. "403": {
  2556. "description": "Password confirmation failed",
  2557. "content": {
  2558. "application/json": {
  2559. "schema": {
  2560. "type": "object",
  2561. "required": [
  2562. "ocs"
  2563. ],
  2564. "properties": {
  2565. "ocs": {
  2566. "type": "object",
  2567. "required": [
  2568. "meta",
  2569. "data"
  2570. ],
  2571. "properties": {
  2572. "meta": {
  2573. "$ref": "#/components/schemas/OCSMeta"
  2574. },
  2575. "data": {}
  2576. }
  2577. }
  2578. }
  2579. }
  2580. }
  2581. }
  2582. }
  2583. }
  2584. }
  2585. },
  2586. "/ocs/v2.php/hovercard/v1/{userId}": {
  2587. "get": {
  2588. "operationId": "hover_card-get-user",
  2589. "summary": "Get the account details for a hovercard",
  2590. "tags": [
  2591. "hover_card"
  2592. ],
  2593. "security": [
  2594. {
  2595. "bearer_auth": []
  2596. },
  2597. {
  2598. "basic_auth": []
  2599. }
  2600. ],
  2601. "parameters": [
  2602. {
  2603. "name": "userId",
  2604. "in": "path",
  2605. "description": "ID of the user",
  2606. "required": true,
  2607. "schema": {
  2608. "type": "string"
  2609. }
  2610. },
  2611. {
  2612. "name": "OCS-APIRequest",
  2613. "in": "header",
  2614. "description": "Required to be true for the API request to pass",
  2615. "required": true,
  2616. "schema": {
  2617. "type": "boolean",
  2618. "default": true
  2619. }
  2620. }
  2621. ],
  2622. "responses": {
  2623. "200": {
  2624. "description": "Account details returned",
  2625. "content": {
  2626. "application/json": {
  2627. "schema": {
  2628. "type": "object",
  2629. "required": [
  2630. "ocs"
  2631. ],
  2632. "properties": {
  2633. "ocs": {
  2634. "type": "object",
  2635. "required": [
  2636. "meta",
  2637. "data"
  2638. ],
  2639. "properties": {
  2640. "meta": {
  2641. "$ref": "#/components/schemas/OCSMeta"
  2642. },
  2643. "data": {
  2644. "type": "object",
  2645. "required": [
  2646. "userId",
  2647. "displayName",
  2648. "actions"
  2649. ],
  2650. "properties": {
  2651. "userId": {
  2652. "type": "string"
  2653. },
  2654. "displayName": {
  2655. "type": "string"
  2656. },
  2657. "actions": {
  2658. "type": "array",
  2659. "items": {
  2660. "$ref": "#/components/schemas/ContactsAction"
  2661. }
  2662. }
  2663. }
  2664. }
  2665. }
  2666. }
  2667. }
  2668. }
  2669. }
  2670. }
  2671. },
  2672. "404": {
  2673. "description": "Account not found",
  2674. "content": {
  2675. "application/json": {
  2676. "schema": {
  2677. "type": "object",
  2678. "required": [
  2679. "ocs"
  2680. ],
  2681. "properties": {
  2682. "ocs": {
  2683. "type": "object",
  2684. "required": [
  2685. "meta",
  2686. "data"
  2687. ],
  2688. "properties": {
  2689. "meta": {
  2690. "$ref": "#/components/schemas/OCSMeta"
  2691. },
  2692. "data": {}
  2693. }
  2694. }
  2695. }
  2696. }
  2697. }
  2698. }
  2699. }
  2700. }
  2701. }
  2702. },
  2703. "/ocs/v2.php/collaboration/resources/collections/search/{filter}": {
  2704. "get": {
  2705. "operationId": "collaboration_resources-search-collections",
  2706. "summary": "Search for collections",
  2707. "tags": [
  2708. "collaboration_resources"
  2709. ],
  2710. "security": [
  2711. {
  2712. "bearer_auth": []
  2713. },
  2714. {
  2715. "basic_auth": []
  2716. }
  2717. ],
  2718. "parameters": [
  2719. {
  2720. "name": "filter",
  2721. "in": "path",
  2722. "description": "Filter collections",
  2723. "required": true,
  2724. "schema": {
  2725. "type": "string"
  2726. }
  2727. },
  2728. {
  2729. "name": "OCS-APIRequest",
  2730. "in": "header",
  2731. "description": "Required to be true for the API request to pass",
  2732. "required": true,
  2733. "schema": {
  2734. "type": "boolean",
  2735. "default": true
  2736. }
  2737. }
  2738. ],
  2739. "responses": {
  2740. "200": {
  2741. "description": "Collections returned",
  2742. "content": {
  2743. "application/json": {
  2744. "schema": {
  2745. "type": "object",
  2746. "required": [
  2747. "ocs"
  2748. ],
  2749. "properties": {
  2750. "ocs": {
  2751. "type": "object",
  2752. "required": [
  2753. "meta",
  2754. "data"
  2755. ],
  2756. "properties": {
  2757. "meta": {
  2758. "$ref": "#/components/schemas/OCSMeta"
  2759. },
  2760. "data": {
  2761. "type": "array",
  2762. "items": {
  2763. "$ref": "#/components/schemas/Collection"
  2764. }
  2765. }
  2766. }
  2767. }
  2768. }
  2769. }
  2770. }
  2771. }
  2772. },
  2773. "404": {
  2774. "description": "Collection not found",
  2775. "content": {
  2776. "application/json": {
  2777. "schema": {
  2778. "type": "object",
  2779. "required": [
  2780. "ocs"
  2781. ],
  2782. "properties": {
  2783. "ocs": {
  2784. "type": "object",
  2785. "required": [
  2786. "meta",
  2787. "data"
  2788. ],
  2789. "properties": {
  2790. "meta": {
  2791. "$ref": "#/components/schemas/OCSMeta"
  2792. },
  2793. "data": {}
  2794. }
  2795. }
  2796. }
  2797. }
  2798. }
  2799. }
  2800. }
  2801. }
  2802. }
  2803. },
  2804. "/ocs/v2.php/collaboration/resources/collections/{collectionId}": {
  2805. "get": {
  2806. "operationId": "collaboration_resources-list-collection",
  2807. "summary": "Get a collection",
  2808. "tags": [
  2809. "collaboration_resources"
  2810. ],
  2811. "security": [
  2812. {
  2813. "bearer_auth": []
  2814. },
  2815. {
  2816. "basic_auth": []
  2817. }
  2818. ],
  2819. "parameters": [
  2820. {
  2821. "name": "collectionId",
  2822. "in": "path",
  2823. "description": "ID of the collection",
  2824. "required": true,
  2825. "schema": {
  2826. "type": "integer",
  2827. "format": "int64"
  2828. }
  2829. },
  2830. {
  2831. "name": "OCS-APIRequest",
  2832. "in": "header",
  2833. "description": "Required to be true for the API request to pass",
  2834. "required": true,
  2835. "schema": {
  2836. "type": "boolean",
  2837. "default": true
  2838. }
  2839. }
  2840. ],
  2841. "responses": {
  2842. "200": {
  2843. "description": "Collection returned",
  2844. "content": {
  2845. "application/json": {
  2846. "schema": {
  2847. "type": "object",
  2848. "required": [
  2849. "ocs"
  2850. ],
  2851. "properties": {
  2852. "ocs": {
  2853. "type": "object",
  2854. "required": [
  2855. "meta",
  2856. "data"
  2857. ],
  2858. "properties": {
  2859. "meta": {
  2860. "$ref": "#/components/schemas/OCSMeta"
  2861. },
  2862. "data": {
  2863. "$ref": "#/components/schemas/Collection"
  2864. }
  2865. }
  2866. }
  2867. }
  2868. }
  2869. }
  2870. }
  2871. },
  2872. "404": {
  2873. "description": "Collection not found",
  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. "500": {
  2901. "description": "",
  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. }
  2929. },
  2930. "put": {
  2931. "operationId": "collaboration_resources-rename-collection",
  2932. "summary": "Rename a collection",
  2933. "tags": [
  2934. "collaboration_resources"
  2935. ],
  2936. "security": [
  2937. {
  2938. "bearer_auth": []
  2939. },
  2940. {
  2941. "basic_auth": []
  2942. }
  2943. ],
  2944. "parameters": [
  2945. {
  2946. "name": "collectionName",
  2947. "in": "query",
  2948. "description": "New name",
  2949. "required": true,
  2950. "schema": {
  2951. "type": "string"
  2952. }
  2953. },
  2954. {
  2955. "name": "collectionId",
  2956. "in": "path",
  2957. "description": "ID of the collection",
  2958. "required": true,
  2959. "schema": {
  2960. "type": "integer",
  2961. "format": "int64"
  2962. }
  2963. },
  2964. {
  2965. "name": "OCS-APIRequest",
  2966. "in": "header",
  2967. "description": "Required to be true for the API request to pass",
  2968. "required": true,
  2969. "schema": {
  2970. "type": "boolean",
  2971. "default": true
  2972. }
  2973. }
  2974. ],
  2975. "responses": {
  2976. "200": {
  2977. "description": "Collection returned",
  2978. "content": {
  2979. "application/json": {
  2980. "schema": {
  2981. "type": "object",
  2982. "required": [
  2983. "ocs"
  2984. ],
  2985. "properties": {
  2986. "ocs": {
  2987. "type": "object",
  2988. "required": [
  2989. "meta",
  2990. "data"
  2991. ],
  2992. "properties": {
  2993. "meta": {
  2994. "$ref": "#/components/schemas/OCSMeta"
  2995. },
  2996. "data": {
  2997. "$ref": "#/components/schemas/Collection"
  2998. }
  2999. }
  3000. }
  3001. }
  3002. }
  3003. }
  3004. }
  3005. },
  3006. "404": {
  3007. "description": "Collection not found",
  3008. "content": {
  3009. "application/json": {
  3010. "schema": {
  3011. "type": "object",
  3012. "required": [
  3013. "ocs"
  3014. ],
  3015. "properties": {
  3016. "ocs": {
  3017. "type": "object",
  3018. "required": [
  3019. "meta",
  3020. "data"
  3021. ],
  3022. "properties": {
  3023. "meta": {
  3024. "$ref": "#/components/schemas/OCSMeta"
  3025. },
  3026. "data": {}
  3027. }
  3028. }
  3029. }
  3030. }
  3031. }
  3032. }
  3033. },
  3034. "500": {
  3035. "description": "",
  3036. "content": {
  3037. "application/json": {
  3038. "schema": {
  3039. "type": "object",
  3040. "required": [
  3041. "ocs"
  3042. ],
  3043. "properties": {
  3044. "ocs": {
  3045. "type": "object",
  3046. "required": [
  3047. "meta",
  3048. "data"
  3049. ],
  3050. "properties": {
  3051. "meta": {
  3052. "$ref": "#/components/schemas/OCSMeta"
  3053. },
  3054. "data": {}
  3055. }
  3056. }
  3057. }
  3058. }
  3059. }
  3060. }
  3061. }
  3062. }
  3063. },
  3064. "post": {
  3065. "operationId": "collaboration_resources-add-resource",
  3066. "summary": "Add a resource to a collection",
  3067. "tags": [
  3068. "collaboration_resources"
  3069. ],
  3070. "security": [
  3071. {
  3072. "bearer_auth": []
  3073. },
  3074. {
  3075. "basic_auth": []
  3076. }
  3077. ],
  3078. "parameters": [
  3079. {
  3080. "name": "resourceType",
  3081. "in": "query",
  3082. "description": "Name of the resource",
  3083. "required": true,
  3084. "schema": {
  3085. "type": "string"
  3086. }
  3087. },
  3088. {
  3089. "name": "resourceId",
  3090. "in": "query",
  3091. "description": "ID of the resource",
  3092. "required": true,
  3093. "schema": {
  3094. "type": "string"
  3095. }
  3096. },
  3097. {
  3098. "name": "collectionId",
  3099. "in": "path",
  3100. "description": "ID of the collection",
  3101. "required": true,
  3102. "schema": {
  3103. "type": "integer",
  3104. "format": "int64"
  3105. }
  3106. },
  3107. {
  3108. "name": "OCS-APIRequest",
  3109. "in": "header",
  3110. "description": "Required to be true for the API request to pass",
  3111. "required": true,
  3112. "schema": {
  3113. "type": "boolean",
  3114. "default": true
  3115. }
  3116. }
  3117. ],
  3118. "responses": {
  3119. "200": {
  3120. "description": "Collection returned",
  3121. "content": {
  3122. "application/json": {
  3123. "schema": {
  3124. "type": "object",
  3125. "required": [
  3126. "ocs"
  3127. ],
  3128. "properties": {
  3129. "ocs": {
  3130. "type": "object",
  3131. "required": [
  3132. "meta",
  3133. "data"
  3134. ],
  3135. "properties": {
  3136. "meta": {
  3137. "$ref": "#/components/schemas/OCSMeta"
  3138. },
  3139. "data": {
  3140. "$ref": "#/components/schemas/Collection"
  3141. }
  3142. }
  3143. }
  3144. }
  3145. }
  3146. }
  3147. }
  3148. },
  3149. "404": {
  3150. "description": "Collection not found or resource inaccessible",
  3151. "content": {
  3152. "application/json": {
  3153. "schema": {
  3154. "type": "object",
  3155. "required": [
  3156. "ocs"
  3157. ],
  3158. "properties": {
  3159. "ocs": {
  3160. "type": "object",
  3161. "required": [
  3162. "meta",
  3163. "data"
  3164. ],
  3165. "properties": {
  3166. "meta": {
  3167. "$ref": "#/components/schemas/OCSMeta"
  3168. },
  3169. "data": {}
  3170. }
  3171. }
  3172. }
  3173. }
  3174. }
  3175. }
  3176. },
  3177. "500": {
  3178. "description": "",
  3179. "content": {
  3180. "application/json": {
  3181. "schema": {
  3182. "type": "object",
  3183. "required": [
  3184. "ocs"
  3185. ],
  3186. "properties": {
  3187. "ocs": {
  3188. "type": "object",
  3189. "required": [
  3190. "meta",
  3191. "data"
  3192. ],
  3193. "properties": {
  3194. "meta": {
  3195. "$ref": "#/components/schemas/OCSMeta"
  3196. },
  3197. "data": {}
  3198. }
  3199. }
  3200. }
  3201. }
  3202. }
  3203. }
  3204. }
  3205. }
  3206. },
  3207. "delete": {
  3208. "operationId": "collaboration_resources-remove-resource",
  3209. "summary": "Remove a resource from a collection",
  3210. "tags": [
  3211. "collaboration_resources"
  3212. ],
  3213. "security": [
  3214. {
  3215. "bearer_auth": []
  3216. },
  3217. {
  3218. "basic_auth": []
  3219. }
  3220. ],
  3221. "parameters": [
  3222. {
  3223. "name": "resourceType",
  3224. "in": "query",
  3225. "description": "Name of the resource",
  3226. "required": true,
  3227. "schema": {
  3228. "type": "string"
  3229. }
  3230. },
  3231. {
  3232. "name": "resourceId",
  3233. "in": "query",
  3234. "description": "ID of the resource",
  3235. "required": true,
  3236. "schema": {
  3237. "type": "string"
  3238. }
  3239. },
  3240. {
  3241. "name": "collectionId",
  3242. "in": "path",
  3243. "description": "ID of the collection",
  3244. "required": true,
  3245. "schema": {
  3246. "type": "integer",
  3247. "format": "int64"
  3248. }
  3249. },
  3250. {
  3251. "name": "OCS-APIRequest",
  3252. "in": "header",
  3253. "description": "Required to be true for the API request to pass",
  3254. "required": true,
  3255. "schema": {
  3256. "type": "boolean",
  3257. "default": true
  3258. }
  3259. }
  3260. ],
  3261. "responses": {
  3262. "200": {
  3263. "description": "Collection returned",
  3264. "content": {
  3265. "application/json": {
  3266. "schema": {
  3267. "type": "object",
  3268. "required": [
  3269. "ocs"
  3270. ],
  3271. "properties": {
  3272. "ocs": {
  3273. "type": "object",
  3274. "required": [
  3275. "meta",
  3276. "data"
  3277. ],
  3278. "properties": {
  3279. "meta": {
  3280. "$ref": "#/components/schemas/OCSMeta"
  3281. },
  3282. "data": {
  3283. "$ref": "#/components/schemas/Collection"
  3284. }
  3285. }
  3286. }
  3287. }
  3288. }
  3289. }
  3290. }
  3291. },
  3292. "404": {
  3293. "description": "Collection or resource not found",
  3294. "content": {
  3295. "application/json": {
  3296. "schema": {
  3297. "type": "object",
  3298. "required": [
  3299. "ocs"
  3300. ],
  3301. "properties": {
  3302. "ocs": {
  3303. "type": "object",
  3304. "required": [
  3305. "meta",
  3306. "data"
  3307. ],
  3308. "properties": {
  3309. "meta": {
  3310. "$ref": "#/components/schemas/OCSMeta"
  3311. },
  3312. "data": {}
  3313. }
  3314. }
  3315. }
  3316. }
  3317. }
  3318. }
  3319. },
  3320. "500": {
  3321. "description": "",
  3322. "content": {
  3323. "application/json": {
  3324. "schema": {
  3325. "type": "object",
  3326. "required": [
  3327. "ocs"
  3328. ],
  3329. "properties": {
  3330. "ocs": {
  3331. "type": "object",
  3332. "required": [
  3333. "meta",
  3334. "data"
  3335. ],
  3336. "properties": {
  3337. "meta": {
  3338. "$ref": "#/components/schemas/OCSMeta"
  3339. },
  3340. "data": {}
  3341. }
  3342. }
  3343. }
  3344. }
  3345. }
  3346. }
  3347. }
  3348. }
  3349. }
  3350. },
  3351. "/ocs/v2.php/collaboration/resources/{resourceType}/{resourceId}": {
  3352. "get": {
  3353. "operationId": "collaboration_resources-get-collections-by-resource",
  3354. "summary": "Get collections by resource",
  3355. "tags": [
  3356. "collaboration_resources"
  3357. ],
  3358. "security": [
  3359. {
  3360. "bearer_auth": []
  3361. },
  3362. {
  3363. "basic_auth": []
  3364. }
  3365. ],
  3366. "parameters": [
  3367. {
  3368. "name": "resourceType",
  3369. "in": "path",
  3370. "description": "Type of the resource",
  3371. "required": true,
  3372. "schema": {
  3373. "type": "string"
  3374. }
  3375. },
  3376. {
  3377. "name": "resourceId",
  3378. "in": "path",
  3379. "description": "ID of the resource",
  3380. "required": true,
  3381. "schema": {
  3382. "type": "string"
  3383. }
  3384. },
  3385. {
  3386. "name": "OCS-APIRequest",
  3387. "in": "header",
  3388. "description": "Required to be true for the API request to pass",
  3389. "required": true,
  3390. "schema": {
  3391. "type": "boolean",
  3392. "default": true
  3393. }
  3394. }
  3395. ],
  3396. "responses": {
  3397. "200": {
  3398. "description": "Collections returned",
  3399. "content": {
  3400. "application/json": {
  3401. "schema": {
  3402. "type": "object",
  3403. "required": [
  3404. "ocs"
  3405. ],
  3406. "properties": {
  3407. "ocs": {
  3408. "type": "object",
  3409. "required": [
  3410. "meta",
  3411. "data"
  3412. ],
  3413. "properties": {
  3414. "meta": {
  3415. "$ref": "#/components/schemas/OCSMeta"
  3416. },
  3417. "data": {
  3418. "type": "array",
  3419. "items": {
  3420. "$ref": "#/components/schemas/Collection"
  3421. }
  3422. }
  3423. }
  3424. }
  3425. }
  3426. }
  3427. }
  3428. }
  3429. },
  3430. "404": {
  3431. "description": "Resource not accessible",
  3432. "content": {
  3433. "application/json": {
  3434. "schema": {
  3435. "type": "object",
  3436. "required": [
  3437. "ocs"
  3438. ],
  3439. "properties": {
  3440. "ocs": {
  3441. "type": "object",
  3442. "required": [
  3443. "meta",
  3444. "data"
  3445. ],
  3446. "properties": {
  3447. "meta": {
  3448. "$ref": "#/components/schemas/OCSMeta"
  3449. },
  3450. "data": {}
  3451. }
  3452. }
  3453. }
  3454. }
  3455. }
  3456. }
  3457. }
  3458. }
  3459. }
  3460. },
  3461. "/ocs/v2.php/collaboration/resources/{baseResourceType}/{baseResourceId}": {
  3462. "post": {
  3463. "operationId": "collaboration_resources-create-collection-on-resource",
  3464. "summary": "Create a collection for a resource",
  3465. "tags": [
  3466. "collaboration_resources"
  3467. ],
  3468. "security": [
  3469. {
  3470. "bearer_auth": []
  3471. },
  3472. {
  3473. "basic_auth": []
  3474. }
  3475. ],
  3476. "parameters": [
  3477. {
  3478. "name": "name",
  3479. "in": "query",
  3480. "description": "Name of the collection",
  3481. "required": true,
  3482. "schema": {
  3483. "type": "string"
  3484. }
  3485. },
  3486. {
  3487. "name": "baseResourceType",
  3488. "in": "path",
  3489. "description": "Type of the base resource",
  3490. "required": true,
  3491. "schema": {
  3492. "type": "string"
  3493. }
  3494. },
  3495. {
  3496. "name": "baseResourceId",
  3497. "in": "path",
  3498. "description": "ID of the base resource",
  3499. "required": true,
  3500. "schema": {
  3501. "type": "string"
  3502. }
  3503. },
  3504. {
  3505. "name": "OCS-APIRequest",
  3506. "in": "header",
  3507. "description": "Required to be true for the API request to pass",
  3508. "required": true,
  3509. "schema": {
  3510. "type": "boolean",
  3511. "default": true
  3512. }
  3513. }
  3514. ],
  3515. "responses": {
  3516. "200": {
  3517. "description": "Collection returned",
  3518. "content": {
  3519. "application/json": {
  3520. "schema": {
  3521. "type": "object",
  3522. "required": [
  3523. "ocs"
  3524. ],
  3525. "properties": {
  3526. "ocs": {
  3527. "type": "object",
  3528. "required": [
  3529. "meta",
  3530. "data"
  3531. ],
  3532. "properties": {
  3533. "meta": {
  3534. "$ref": "#/components/schemas/OCSMeta"
  3535. },
  3536. "data": {
  3537. "$ref": "#/components/schemas/Collection"
  3538. }
  3539. }
  3540. }
  3541. }
  3542. }
  3543. }
  3544. }
  3545. },
  3546. "400": {
  3547. "description": "Creating collection is not possible",
  3548. "content": {
  3549. "application/json": {
  3550. "schema": {
  3551. "type": "object",
  3552. "required": [
  3553. "ocs"
  3554. ],
  3555. "properties": {
  3556. "ocs": {
  3557. "type": "object",
  3558. "required": [
  3559. "meta",
  3560. "data"
  3561. ],
  3562. "properties": {
  3563. "meta": {
  3564. "$ref": "#/components/schemas/OCSMeta"
  3565. },
  3566. "data": {}
  3567. }
  3568. }
  3569. }
  3570. }
  3571. }
  3572. }
  3573. },
  3574. "404": {
  3575. "description": "Resource inaccessible",
  3576. "content": {
  3577. "application/json": {
  3578. "schema": {
  3579. "type": "object",
  3580. "required": [
  3581. "ocs"
  3582. ],
  3583. "properties": {
  3584. "ocs": {
  3585. "type": "object",
  3586. "required": [
  3587. "meta",
  3588. "data"
  3589. ],
  3590. "properties": {
  3591. "meta": {
  3592. "$ref": "#/components/schemas/OCSMeta"
  3593. },
  3594. "data": {}
  3595. }
  3596. }
  3597. }
  3598. }
  3599. }
  3600. }
  3601. },
  3602. "500": {
  3603. "description": "",
  3604. "content": {
  3605. "application/json": {
  3606. "schema": {
  3607. "type": "object",
  3608. "required": [
  3609. "ocs"
  3610. ],
  3611. "properties": {
  3612. "ocs": {
  3613. "type": "object",
  3614. "required": [
  3615. "meta",
  3616. "data"
  3617. ],
  3618. "properties": {
  3619. "meta": {
  3620. "$ref": "#/components/schemas/OCSMeta"
  3621. },
  3622. "data": {}
  3623. }
  3624. }
  3625. }
  3626. }
  3627. }
  3628. }
  3629. }
  3630. }
  3631. }
  3632. },
  3633. "/ocs/v2.php/references/resolve": {
  3634. "get": {
  3635. "operationId": "reference_api-resolve-one",
  3636. "summary": "Resolve a reference",
  3637. "tags": [
  3638. "reference_api"
  3639. ],
  3640. "security": [
  3641. {
  3642. "bearer_auth": []
  3643. },
  3644. {
  3645. "basic_auth": []
  3646. }
  3647. ],
  3648. "parameters": [
  3649. {
  3650. "name": "reference",
  3651. "in": "query",
  3652. "description": "Reference to resolve",
  3653. "required": true,
  3654. "schema": {
  3655. "type": "string"
  3656. }
  3657. },
  3658. {
  3659. "name": "OCS-APIRequest",
  3660. "in": "header",
  3661. "description": "Required to be true for the API request to pass",
  3662. "required": true,
  3663. "schema": {
  3664. "type": "boolean",
  3665. "default": true
  3666. }
  3667. }
  3668. ],
  3669. "responses": {
  3670. "200": {
  3671. "description": "Reference returned",
  3672. "content": {
  3673. "application/json": {
  3674. "schema": {
  3675. "type": "object",
  3676. "required": [
  3677. "ocs"
  3678. ],
  3679. "properties": {
  3680. "ocs": {
  3681. "type": "object",
  3682. "required": [
  3683. "meta",
  3684. "data"
  3685. ],
  3686. "properties": {
  3687. "meta": {
  3688. "$ref": "#/components/schemas/OCSMeta"
  3689. },
  3690. "data": {
  3691. "type": "object",
  3692. "required": [
  3693. "references"
  3694. ],
  3695. "properties": {
  3696. "references": {
  3697. "type": "object",
  3698. "additionalProperties": {
  3699. "$ref": "#/components/schemas/Reference",
  3700. "nullable": true
  3701. }
  3702. }
  3703. }
  3704. }
  3705. }
  3706. }
  3707. }
  3708. }
  3709. }
  3710. }
  3711. }
  3712. }
  3713. },
  3714. "post": {
  3715. "operationId": "reference_api-resolve",
  3716. "summary": "Resolve multiple references",
  3717. "tags": [
  3718. "reference_api"
  3719. ],
  3720. "security": [
  3721. {
  3722. "bearer_auth": []
  3723. },
  3724. {
  3725. "basic_auth": []
  3726. }
  3727. ],
  3728. "parameters": [
  3729. {
  3730. "name": "references[]",
  3731. "in": "query",
  3732. "description": "References to resolve",
  3733. "required": true,
  3734. "schema": {
  3735. "type": "array",
  3736. "items": {
  3737. "type": "string"
  3738. }
  3739. }
  3740. },
  3741. {
  3742. "name": "limit",
  3743. "in": "query",
  3744. "description": "Maximum amount of references to resolve",
  3745. "schema": {
  3746. "type": "integer",
  3747. "format": "int64",
  3748. "default": 1
  3749. }
  3750. },
  3751. {
  3752. "name": "OCS-APIRequest",
  3753. "in": "header",
  3754. "description": "Required to be true for the API request to pass",
  3755. "required": true,
  3756. "schema": {
  3757. "type": "boolean",
  3758. "default": true
  3759. }
  3760. }
  3761. ],
  3762. "responses": {
  3763. "200": {
  3764. "description": "References returned",
  3765. "content": {
  3766. "application/json": {
  3767. "schema": {
  3768. "type": "object",
  3769. "required": [
  3770. "ocs"
  3771. ],
  3772. "properties": {
  3773. "ocs": {
  3774. "type": "object",
  3775. "required": [
  3776. "meta",
  3777. "data"
  3778. ],
  3779. "properties": {
  3780. "meta": {
  3781. "$ref": "#/components/schemas/OCSMeta"
  3782. },
  3783. "data": {
  3784. "type": "object",
  3785. "required": [
  3786. "references"
  3787. ],
  3788. "properties": {
  3789. "references": {
  3790. "type": "object",
  3791. "additionalProperties": {
  3792. "$ref": "#/components/schemas/Reference",
  3793. "nullable": true
  3794. }
  3795. }
  3796. }
  3797. }
  3798. }
  3799. }
  3800. }
  3801. }
  3802. }
  3803. }
  3804. }
  3805. }
  3806. }
  3807. },
  3808. "/ocs/v2.php/references/extract": {
  3809. "post": {
  3810. "operationId": "reference_api-extract",
  3811. "summary": "Extract references from a text",
  3812. "tags": [
  3813. "reference_api"
  3814. ],
  3815. "security": [
  3816. {
  3817. "bearer_auth": []
  3818. },
  3819. {
  3820. "basic_auth": []
  3821. }
  3822. ],
  3823. "parameters": [
  3824. {
  3825. "name": "text",
  3826. "in": "query",
  3827. "description": "Text to extract from",
  3828. "required": true,
  3829. "schema": {
  3830. "type": "string"
  3831. }
  3832. },
  3833. {
  3834. "name": "resolve",
  3835. "in": "query",
  3836. "description": "Resolve the references",
  3837. "schema": {
  3838. "type": "integer",
  3839. "default": 0,
  3840. "enum": [
  3841. 0,
  3842. 1
  3843. ]
  3844. }
  3845. },
  3846. {
  3847. "name": "limit",
  3848. "in": "query",
  3849. "description": "Maximum amount of references to extract",
  3850. "schema": {
  3851. "type": "integer",
  3852. "format": "int64",
  3853. "default": 1
  3854. }
  3855. },
  3856. {
  3857. "name": "OCS-APIRequest",
  3858. "in": "header",
  3859. "description": "Required to be true for the API request to pass",
  3860. "required": true,
  3861. "schema": {
  3862. "type": "boolean",
  3863. "default": true
  3864. }
  3865. }
  3866. ],
  3867. "responses": {
  3868. "200": {
  3869. "description": "References returned",
  3870. "content": {
  3871. "application/json": {
  3872. "schema": {
  3873. "type": "object",
  3874. "required": [
  3875. "ocs"
  3876. ],
  3877. "properties": {
  3878. "ocs": {
  3879. "type": "object",
  3880. "required": [
  3881. "meta",
  3882. "data"
  3883. ],
  3884. "properties": {
  3885. "meta": {
  3886. "$ref": "#/components/schemas/OCSMeta"
  3887. },
  3888. "data": {
  3889. "type": "object",
  3890. "required": [
  3891. "references"
  3892. ],
  3893. "properties": {
  3894. "references": {
  3895. "type": "object",
  3896. "additionalProperties": {
  3897. "$ref": "#/components/schemas/Reference",
  3898. "nullable": true
  3899. }
  3900. }
  3901. }
  3902. }
  3903. }
  3904. }
  3905. }
  3906. }
  3907. }
  3908. }
  3909. }
  3910. }
  3911. }
  3912. },
  3913. "/ocs/v2.php/references/providers": {
  3914. "get": {
  3915. "operationId": "reference_api-get-providers-info",
  3916. "summary": "Get the providers",
  3917. "tags": [
  3918. "reference_api"
  3919. ],
  3920. "security": [
  3921. {
  3922. "bearer_auth": []
  3923. },
  3924. {
  3925. "basic_auth": []
  3926. }
  3927. ],
  3928. "parameters": [
  3929. {
  3930. "name": "OCS-APIRequest",
  3931. "in": "header",
  3932. "description": "Required to be true for the API request to pass",
  3933. "required": true,
  3934. "schema": {
  3935. "type": "boolean",
  3936. "default": true
  3937. }
  3938. }
  3939. ],
  3940. "responses": {
  3941. "200": {
  3942. "description": "Providers returned",
  3943. "content": {
  3944. "application/json": {
  3945. "schema": {
  3946. "type": "object",
  3947. "required": [
  3948. "ocs"
  3949. ],
  3950. "properties": {
  3951. "ocs": {
  3952. "type": "object",
  3953. "required": [
  3954. "meta",
  3955. "data"
  3956. ],
  3957. "properties": {
  3958. "meta": {
  3959. "$ref": "#/components/schemas/OCSMeta"
  3960. },
  3961. "data": {
  3962. "type": "array",
  3963. "items": {
  3964. "$ref": "#/components/schemas/ReferenceProvider"
  3965. }
  3966. }
  3967. }
  3968. }
  3969. }
  3970. }
  3971. }
  3972. }
  3973. }
  3974. }
  3975. }
  3976. },
  3977. "/ocs/v2.php/references/provider/{providerId}": {
  3978. "put": {
  3979. "operationId": "reference_api-touch-provider",
  3980. "summary": "Touch a provider",
  3981. "tags": [
  3982. "reference_api"
  3983. ],
  3984. "security": [
  3985. {
  3986. "bearer_auth": []
  3987. },
  3988. {
  3989. "basic_auth": []
  3990. }
  3991. ],
  3992. "parameters": [
  3993. {
  3994. "name": "timestamp",
  3995. "in": "query",
  3996. "description": "Timestamp of the last usage",
  3997. "schema": {
  3998. "type": "integer",
  3999. "format": "int64",
  4000. "nullable": true
  4001. }
  4002. },
  4003. {
  4004. "name": "providerId",
  4005. "in": "path",
  4006. "description": "ID of the provider",
  4007. "required": true,
  4008. "schema": {
  4009. "type": "string"
  4010. }
  4011. },
  4012. {
  4013. "name": "OCS-APIRequest",
  4014. "in": "header",
  4015. "description": "Required to be true for the API request to pass",
  4016. "required": true,
  4017. "schema": {
  4018. "type": "boolean",
  4019. "default": true
  4020. }
  4021. }
  4022. ],
  4023. "responses": {
  4024. "200": {
  4025. "description": "Provider touched",
  4026. "content": {
  4027. "application/json": {
  4028. "schema": {
  4029. "type": "object",
  4030. "required": [
  4031. "ocs"
  4032. ],
  4033. "properties": {
  4034. "ocs": {
  4035. "type": "object",
  4036. "required": [
  4037. "meta",
  4038. "data"
  4039. ],
  4040. "properties": {
  4041. "meta": {
  4042. "$ref": "#/components/schemas/OCSMeta"
  4043. },
  4044. "data": {
  4045. "type": "object",
  4046. "required": [
  4047. "success"
  4048. ],
  4049. "properties": {
  4050. "success": {
  4051. "type": "boolean"
  4052. }
  4053. }
  4054. }
  4055. }
  4056. }
  4057. }
  4058. }
  4059. }
  4060. }
  4061. }
  4062. }
  4063. }
  4064. },
  4065. "/ocs/v2.php/profile/{targetUserId}": {
  4066. "put": {
  4067. "operationId": "profile_api-set-visibility",
  4068. "summary": "Update the visibility of a parameter",
  4069. "tags": [
  4070. "profile_api"
  4071. ],
  4072. "security": [
  4073. {
  4074. "bearer_auth": []
  4075. },
  4076. {
  4077. "basic_auth": []
  4078. }
  4079. ],
  4080. "parameters": [
  4081. {
  4082. "name": "paramId",
  4083. "in": "query",
  4084. "description": "ID of the parameter",
  4085. "required": true,
  4086. "schema": {
  4087. "type": "string"
  4088. }
  4089. },
  4090. {
  4091. "name": "visibility",
  4092. "in": "query",
  4093. "description": "New visibility",
  4094. "required": true,
  4095. "schema": {
  4096. "type": "string"
  4097. }
  4098. },
  4099. {
  4100. "name": "targetUserId",
  4101. "in": "path",
  4102. "description": "ID of the user",
  4103. "required": true,
  4104. "schema": {
  4105. "type": "string"
  4106. }
  4107. },
  4108. {
  4109. "name": "OCS-APIRequest",
  4110. "in": "header",
  4111. "description": "Required to be true for the API request to pass",
  4112. "required": true,
  4113. "schema": {
  4114. "type": "boolean",
  4115. "default": true
  4116. }
  4117. }
  4118. ],
  4119. "responses": {
  4120. "200": {
  4121. "description": "Visibility updated successfully",
  4122. "content": {
  4123. "application/json": {
  4124. "schema": {
  4125. "type": "object",
  4126. "required": [
  4127. "ocs"
  4128. ],
  4129. "properties": {
  4130. "ocs": {
  4131. "type": "object",
  4132. "required": [
  4133. "meta",
  4134. "data"
  4135. ],
  4136. "properties": {
  4137. "meta": {
  4138. "$ref": "#/components/schemas/OCSMeta"
  4139. },
  4140. "data": {}
  4141. }
  4142. }
  4143. }
  4144. }
  4145. }
  4146. }
  4147. },
  4148. "400": {
  4149. "description": "Updating visibility is not possible",
  4150. "content": {
  4151. "text/plain": {
  4152. "schema": {
  4153. "type": "string"
  4154. }
  4155. }
  4156. }
  4157. },
  4158. "403": {
  4159. "description": "Not allowed to edit other users visibility",
  4160. "content": {
  4161. "text/plain": {
  4162. "schema": {
  4163. "type": "string"
  4164. }
  4165. }
  4166. }
  4167. },
  4168. "404": {
  4169. "description": "Account not found",
  4170. "content": {
  4171. "text/plain": {
  4172. "schema": {
  4173. "type": "string"
  4174. }
  4175. }
  4176. }
  4177. }
  4178. }
  4179. }
  4180. },
  4181. "/ocs/v2.php/search/providers": {
  4182. "get": {
  4183. "operationId": "unified_search-get-providers",
  4184. "summary": "Get the providers for unified search",
  4185. "tags": [
  4186. "unified_search"
  4187. ],
  4188. "security": [
  4189. {
  4190. "bearer_auth": []
  4191. },
  4192. {
  4193. "basic_auth": []
  4194. }
  4195. ],
  4196. "parameters": [
  4197. {
  4198. "name": "from",
  4199. "in": "query",
  4200. "description": "the url the user is currently at",
  4201. "schema": {
  4202. "type": "string",
  4203. "default": ""
  4204. }
  4205. },
  4206. {
  4207. "name": "OCS-APIRequest",
  4208. "in": "header",
  4209. "description": "Required to be true for the API request to pass",
  4210. "required": true,
  4211. "schema": {
  4212. "type": "boolean",
  4213. "default": true
  4214. }
  4215. }
  4216. ],
  4217. "responses": {
  4218. "200": {
  4219. "description": "Providers returned",
  4220. "content": {
  4221. "application/json": {
  4222. "schema": {
  4223. "type": "object",
  4224. "required": [
  4225. "ocs"
  4226. ],
  4227. "properties": {
  4228. "ocs": {
  4229. "type": "object",
  4230. "required": [
  4231. "meta",
  4232. "data"
  4233. ],
  4234. "properties": {
  4235. "meta": {
  4236. "$ref": "#/components/schemas/OCSMeta"
  4237. },
  4238. "data": {
  4239. "type": "array",
  4240. "items": {
  4241. "$ref": "#/components/schemas/UnifiedSearchProvider"
  4242. }
  4243. }
  4244. }
  4245. }
  4246. }
  4247. }
  4248. }
  4249. }
  4250. }
  4251. }
  4252. }
  4253. },
  4254. "/ocs/v2.php/search/providers/{providerId}/search": {
  4255. "get": {
  4256. "operationId": "unified_search-search",
  4257. "summary": "Launch a search for a specific search provider.",
  4258. "description": "Additional filters are available for each provider. Send a request to /providers endpoint to list providers with their available filters.",
  4259. "tags": [
  4260. "unified_search"
  4261. ],
  4262. "security": [
  4263. {
  4264. "bearer_auth": []
  4265. },
  4266. {
  4267. "basic_auth": []
  4268. }
  4269. ],
  4270. "parameters": [
  4271. {
  4272. "name": "term",
  4273. "in": "query",
  4274. "description": "Term to search",
  4275. "schema": {
  4276. "type": "string",
  4277. "default": ""
  4278. }
  4279. },
  4280. {
  4281. "name": "sortOrder",
  4282. "in": "query",
  4283. "description": "Order of entries",
  4284. "schema": {
  4285. "type": "integer",
  4286. "format": "int64",
  4287. "nullable": true
  4288. }
  4289. },
  4290. {
  4291. "name": "limit",
  4292. "in": "query",
  4293. "description": "Maximum amount of entries",
  4294. "schema": {
  4295. "type": "integer",
  4296. "format": "int64",
  4297. "nullable": true
  4298. }
  4299. },
  4300. {
  4301. "name": "cursor",
  4302. "in": "query",
  4303. "description": "Offset for searching",
  4304. "schema": {
  4305. "nullable": true,
  4306. "oneOf": [
  4307. {
  4308. "type": "integer",
  4309. "format": "int64"
  4310. },
  4311. {
  4312. "type": "string"
  4313. }
  4314. ]
  4315. }
  4316. },
  4317. {
  4318. "name": "from",
  4319. "in": "query",
  4320. "description": "The current user URL",
  4321. "schema": {
  4322. "type": "string",
  4323. "default": ""
  4324. }
  4325. },
  4326. {
  4327. "name": "providerId",
  4328. "in": "path",
  4329. "description": "ID of the provider",
  4330. "required": true,
  4331. "schema": {
  4332. "type": "string"
  4333. }
  4334. },
  4335. {
  4336. "name": "OCS-APIRequest",
  4337. "in": "header",
  4338. "description": "Required to be true for the API request to pass",
  4339. "required": true,
  4340. "schema": {
  4341. "type": "boolean",
  4342. "default": true
  4343. }
  4344. }
  4345. ],
  4346. "responses": {
  4347. "200": {
  4348. "description": "Search entries returned",
  4349. "content": {
  4350. "application/json": {
  4351. "schema": {
  4352. "type": "object",
  4353. "required": [
  4354. "ocs"
  4355. ],
  4356. "properties": {
  4357. "ocs": {
  4358. "type": "object",
  4359. "required": [
  4360. "meta",
  4361. "data"
  4362. ],
  4363. "properties": {
  4364. "meta": {
  4365. "$ref": "#/components/schemas/OCSMeta"
  4366. },
  4367. "data": {
  4368. "$ref": "#/components/schemas/UnifiedSearchResult"
  4369. }
  4370. }
  4371. }
  4372. }
  4373. }
  4374. }
  4375. }
  4376. },
  4377. "400": {
  4378. "description": "Searching is not possible",
  4379. "content": {
  4380. "application/json": {
  4381. "schema": {
  4382. "type": "object",
  4383. "required": [
  4384. "ocs"
  4385. ],
  4386. "properties": {
  4387. "ocs": {
  4388. "type": "object",
  4389. "required": [
  4390. "meta",
  4391. "data"
  4392. ],
  4393. "properties": {
  4394. "meta": {
  4395. "$ref": "#/components/schemas/OCSMeta"
  4396. },
  4397. "data": {
  4398. "type": "string"
  4399. }
  4400. }
  4401. }
  4402. }
  4403. }
  4404. }
  4405. }
  4406. }
  4407. }
  4408. }
  4409. },
  4410. "/ocs/v2.php/translation/languages": {
  4411. "get": {
  4412. "operationId": "translation_api-languages",
  4413. "summary": "Get the list of supported languages",
  4414. "tags": [
  4415. "translation_api"
  4416. ],
  4417. "security": [
  4418. {},
  4419. {
  4420. "bearer_auth": []
  4421. },
  4422. {
  4423. "basic_auth": []
  4424. }
  4425. ],
  4426. "parameters": [
  4427. {
  4428. "name": "OCS-APIRequest",
  4429. "in": "header",
  4430. "description": "Required to be true for the API request to pass",
  4431. "required": true,
  4432. "schema": {
  4433. "type": "boolean",
  4434. "default": true
  4435. }
  4436. }
  4437. ],
  4438. "responses": {
  4439. "200": {
  4440. "description": "Supported languages returned",
  4441. "content": {
  4442. "application/json": {
  4443. "schema": {
  4444. "type": "object",
  4445. "required": [
  4446. "ocs"
  4447. ],
  4448. "properties": {
  4449. "ocs": {
  4450. "type": "object",
  4451. "required": [
  4452. "meta",
  4453. "data"
  4454. ],
  4455. "properties": {
  4456. "meta": {
  4457. "$ref": "#/components/schemas/OCSMeta"
  4458. },
  4459. "data": {
  4460. "type": "object",
  4461. "required": [
  4462. "languages",
  4463. "languageDetection"
  4464. ],
  4465. "properties": {
  4466. "languages": {
  4467. "type": "array",
  4468. "items": {
  4469. "type": "object",
  4470. "required": [
  4471. "from",
  4472. "fromLabel",
  4473. "to",
  4474. "toLabel"
  4475. ],
  4476. "properties": {
  4477. "from": {
  4478. "type": "string"
  4479. },
  4480. "fromLabel": {
  4481. "type": "string"
  4482. },
  4483. "to": {
  4484. "type": "string"
  4485. },
  4486. "toLabel": {
  4487. "type": "string"
  4488. }
  4489. }
  4490. }
  4491. },
  4492. "languageDetection": {
  4493. "type": "boolean"
  4494. }
  4495. }
  4496. }
  4497. }
  4498. }
  4499. }
  4500. }
  4501. }
  4502. }
  4503. }
  4504. }
  4505. }
  4506. },
  4507. "/ocs/v2.php/translation/translate": {
  4508. "post": {
  4509. "operationId": "translation_api-translate",
  4510. "summary": "Translate a text",
  4511. "tags": [
  4512. "translation_api"
  4513. ],
  4514. "security": [
  4515. {},
  4516. {
  4517. "bearer_auth": []
  4518. },
  4519. {
  4520. "basic_auth": []
  4521. }
  4522. ],
  4523. "parameters": [
  4524. {
  4525. "name": "text",
  4526. "in": "query",
  4527. "description": "Text to be translated",
  4528. "required": true,
  4529. "schema": {
  4530. "type": "string"
  4531. }
  4532. },
  4533. {
  4534. "name": "fromLanguage",
  4535. "in": "query",
  4536. "description": "Language to translate from",
  4537. "schema": {
  4538. "type": "string",
  4539. "nullable": true
  4540. }
  4541. },
  4542. {
  4543. "name": "toLanguage",
  4544. "in": "query",
  4545. "description": "Language to translate to",
  4546. "required": true,
  4547. "schema": {
  4548. "type": "string"
  4549. }
  4550. },
  4551. {
  4552. "name": "OCS-APIRequest",
  4553. "in": "header",
  4554. "description": "Required to be true for the API request to pass",
  4555. "required": true,
  4556. "schema": {
  4557. "type": "boolean",
  4558. "default": true
  4559. }
  4560. }
  4561. ],
  4562. "responses": {
  4563. "200": {
  4564. "description": "Translated text returned",
  4565. "content": {
  4566. "application/json": {
  4567. "schema": {
  4568. "type": "object",
  4569. "required": [
  4570. "ocs"
  4571. ],
  4572. "properties": {
  4573. "ocs": {
  4574. "type": "object",
  4575. "required": [
  4576. "meta",
  4577. "data"
  4578. ],
  4579. "properties": {
  4580. "meta": {
  4581. "$ref": "#/components/schemas/OCSMeta"
  4582. },
  4583. "data": {
  4584. "type": "object",
  4585. "required": [
  4586. "text",
  4587. "from"
  4588. ],
  4589. "properties": {
  4590. "text": {
  4591. "type": "string"
  4592. },
  4593. "from": {
  4594. "type": "string",
  4595. "nullable": true
  4596. }
  4597. }
  4598. }
  4599. }
  4600. }
  4601. }
  4602. }
  4603. }
  4604. }
  4605. },
  4606. "400": {
  4607. "description": "Language not detected or unable to translate",
  4608. "content": {
  4609. "application/json": {
  4610. "schema": {
  4611. "type": "object",
  4612. "required": [
  4613. "ocs"
  4614. ],
  4615. "properties": {
  4616. "ocs": {
  4617. "type": "object",
  4618. "required": [
  4619. "meta",
  4620. "data"
  4621. ],
  4622. "properties": {
  4623. "meta": {
  4624. "$ref": "#/components/schemas/OCSMeta"
  4625. },
  4626. "data": {
  4627. "type": "object",
  4628. "required": [
  4629. "message"
  4630. ],
  4631. "properties": {
  4632. "message": {
  4633. "type": "string"
  4634. },
  4635. "from": {
  4636. "type": "string",
  4637. "nullable": true
  4638. }
  4639. }
  4640. }
  4641. }
  4642. }
  4643. }
  4644. }
  4645. }
  4646. }
  4647. },
  4648. "412": {
  4649. "description": "Translating is not possible",
  4650. "content": {
  4651. "application/json": {
  4652. "schema": {
  4653. "type": "object",
  4654. "required": [
  4655. "ocs"
  4656. ],
  4657. "properties": {
  4658. "ocs": {
  4659. "type": "object",
  4660. "required": [
  4661. "meta",
  4662. "data"
  4663. ],
  4664. "properties": {
  4665. "meta": {
  4666. "$ref": "#/components/schemas/OCSMeta"
  4667. },
  4668. "data": {
  4669. "type": "object",
  4670. "required": [
  4671. "message"
  4672. ],
  4673. "properties": {
  4674. "message": {
  4675. "type": "string"
  4676. },
  4677. "from": {
  4678. "type": "string",
  4679. "nullable": true
  4680. }
  4681. }
  4682. }
  4683. }
  4684. }
  4685. }
  4686. }
  4687. }
  4688. }
  4689. },
  4690. "500": {
  4691. "description": "",
  4692. "content": {
  4693. "application/json": {
  4694. "schema": {
  4695. "type": "object",
  4696. "required": [
  4697. "ocs"
  4698. ],
  4699. "properties": {
  4700. "ocs": {
  4701. "type": "object",
  4702. "required": [
  4703. "meta",
  4704. "data"
  4705. ],
  4706. "properties": {
  4707. "meta": {
  4708. "$ref": "#/components/schemas/OCSMeta"
  4709. },
  4710. "data": {
  4711. "type": "object",
  4712. "required": [
  4713. "message"
  4714. ],
  4715. "properties": {
  4716. "message": {
  4717. "type": "string"
  4718. },
  4719. "from": {
  4720. "type": "string",
  4721. "nullable": true
  4722. }
  4723. }
  4724. }
  4725. }
  4726. }
  4727. }
  4728. }
  4729. }
  4730. }
  4731. }
  4732. }
  4733. }
  4734. },
  4735. "/ocs/v2.php/textprocessing/tasktypes": {
  4736. "get": {
  4737. "operationId": "text_processing_api-task-types",
  4738. "summary": "This endpoint returns all available LanguageModel task types",
  4739. "tags": [
  4740. "text_processing_api"
  4741. ],
  4742. "security": [
  4743. {},
  4744. {
  4745. "bearer_auth": []
  4746. },
  4747. {
  4748. "basic_auth": []
  4749. }
  4750. ],
  4751. "parameters": [
  4752. {
  4753. "name": "OCS-APIRequest",
  4754. "in": "header",
  4755. "description": "Required to be true for the API request to pass",
  4756. "required": true,
  4757. "schema": {
  4758. "type": "boolean",
  4759. "default": true
  4760. }
  4761. }
  4762. ],
  4763. "responses": {
  4764. "200": {
  4765. "description": "Task types returned",
  4766. "content": {
  4767. "application/json": {
  4768. "schema": {
  4769. "type": "object",
  4770. "required": [
  4771. "ocs"
  4772. ],
  4773. "properties": {
  4774. "ocs": {
  4775. "type": "object",
  4776. "required": [
  4777. "meta",
  4778. "data"
  4779. ],
  4780. "properties": {
  4781. "meta": {
  4782. "$ref": "#/components/schemas/OCSMeta"
  4783. },
  4784. "data": {
  4785. "type": "object",
  4786. "required": [
  4787. "types"
  4788. ],
  4789. "properties": {
  4790. "types": {
  4791. "type": "array",
  4792. "items": {
  4793. "type": "object",
  4794. "required": [
  4795. "id",
  4796. "name",
  4797. "description"
  4798. ],
  4799. "properties": {
  4800. "id": {
  4801. "type": "string"
  4802. },
  4803. "name": {
  4804. "type": "string"
  4805. },
  4806. "description": {
  4807. "type": "string"
  4808. }
  4809. }
  4810. }
  4811. }
  4812. }
  4813. }
  4814. }
  4815. }
  4816. }
  4817. }
  4818. }
  4819. }
  4820. }
  4821. }
  4822. }
  4823. },
  4824. "/ocs/v2.php/textprocessing/schedule": {
  4825. "post": {
  4826. "operationId": "text_processing_api-schedule",
  4827. "summary": "This endpoint allows scheduling a language model task",
  4828. "tags": [
  4829. "text_processing_api"
  4830. ],
  4831. "security": [
  4832. {},
  4833. {
  4834. "bearer_auth": []
  4835. },
  4836. {
  4837. "basic_auth": []
  4838. }
  4839. ],
  4840. "parameters": [
  4841. {
  4842. "name": "input",
  4843. "in": "query",
  4844. "description": "Input text",
  4845. "required": true,
  4846. "schema": {
  4847. "type": "string"
  4848. }
  4849. },
  4850. {
  4851. "name": "type",
  4852. "in": "query",
  4853. "description": "Type of the task",
  4854. "required": true,
  4855. "schema": {
  4856. "type": "string"
  4857. }
  4858. },
  4859. {
  4860. "name": "appId",
  4861. "in": "query",
  4862. "description": "ID of the app that will execute the task",
  4863. "required": true,
  4864. "schema": {
  4865. "type": "string"
  4866. }
  4867. },
  4868. {
  4869. "name": "identifier",
  4870. "in": "query",
  4871. "description": "An arbitrary identifier for the task",
  4872. "schema": {
  4873. "type": "string",
  4874. "default": ""
  4875. }
  4876. },
  4877. {
  4878. "name": "OCS-APIRequest",
  4879. "in": "header",
  4880. "description": "Required to be true for the API request to pass",
  4881. "required": true,
  4882. "schema": {
  4883. "type": "boolean",
  4884. "default": true
  4885. }
  4886. }
  4887. ],
  4888. "responses": {
  4889. "200": {
  4890. "description": "Task scheduled successfully",
  4891. "content": {
  4892. "application/json": {
  4893. "schema": {
  4894. "type": "object",
  4895. "required": [
  4896. "ocs"
  4897. ],
  4898. "properties": {
  4899. "ocs": {
  4900. "type": "object",
  4901. "required": [
  4902. "meta",
  4903. "data"
  4904. ],
  4905. "properties": {
  4906. "meta": {
  4907. "$ref": "#/components/schemas/OCSMeta"
  4908. },
  4909. "data": {
  4910. "type": "object",
  4911. "required": [
  4912. "task"
  4913. ],
  4914. "properties": {
  4915. "task": {
  4916. "$ref": "#/components/schemas/TextProcessingTask"
  4917. }
  4918. }
  4919. }
  4920. }
  4921. }
  4922. }
  4923. }
  4924. }
  4925. }
  4926. },
  4927. "500": {
  4928. "description": "",
  4929. "content": {
  4930. "application/json": {
  4931. "schema": {
  4932. "type": "object",
  4933. "required": [
  4934. "ocs"
  4935. ],
  4936. "properties": {
  4937. "ocs": {
  4938. "type": "object",
  4939. "required": [
  4940. "meta",
  4941. "data"
  4942. ],
  4943. "properties": {
  4944. "meta": {
  4945. "$ref": "#/components/schemas/OCSMeta"
  4946. },
  4947. "data": {
  4948. "type": "object",
  4949. "required": [
  4950. "message"
  4951. ],
  4952. "properties": {
  4953. "message": {
  4954. "type": "string"
  4955. }
  4956. }
  4957. }
  4958. }
  4959. }
  4960. }
  4961. }
  4962. }
  4963. }
  4964. },
  4965. "400": {
  4966. "description": "Scheduling task is not possible",
  4967. "content": {
  4968. "application/json": {
  4969. "schema": {
  4970. "type": "object",
  4971. "required": [
  4972. "ocs"
  4973. ],
  4974. "properties": {
  4975. "ocs": {
  4976. "type": "object",
  4977. "required": [
  4978. "meta",
  4979. "data"
  4980. ],
  4981. "properties": {
  4982. "meta": {
  4983. "$ref": "#/components/schemas/OCSMeta"
  4984. },
  4985. "data": {
  4986. "type": "object",
  4987. "required": [
  4988. "message"
  4989. ],
  4990. "properties": {
  4991. "message": {
  4992. "type": "string"
  4993. }
  4994. }
  4995. }
  4996. }
  4997. }
  4998. }
  4999. }
  5000. }
  5001. }
  5002. },
  5003. "412": {
  5004. "description": "Scheduling task is not possible",
  5005. "content": {
  5006. "application/json": {
  5007. "schema": {
  5008. "type": "object",
  5009. "required": [
  5010. "ocs"
  5011. ],
  5012. "properties": {
  5013. "ocs": {
  5014. "type": "object",
  5015. "required": [
  5016. "meta",
  5017. "data"
  5018. ],
  5019. "properties": {
  5020. "meta": {
  5021. "$ref": "#/components/schemas/OCSMeta"
  5022. },
  5023. "data": {
  5024. "type": "object",
  5025. "required": [
  5026. "message"
  5027. ],
  5028. "properties": {
  5029. "message": {
  5030. "type": "string"
  5031. }
  5032. }
  5033. }
  5034. }
  5035. }
  5036. }
  5037. }
  5038. }
  5039. }
  5040. }
  5041. }
  5042. }
  5043. },
  5044. "/ocs/v2.php/textprocessing/task/{id}": {
  5045. "get": {
  5046. "operationId": "text_processing_api-get-task",
  5047. "summary": "This endpoint allows checking the status and results of a task. Tasks are removed 1 week after receiving their last update.",
  5048. "tags": [
  5049. "text_processing_api"
  5050. ],
  5051. "security": [
  5052. {},
  5053. {
  5054. "bearer_auth": []
  5055. },
  5056. {
  5057. "basic_auth": []
  5058. }
  5059. ],
  5060. "parameters": [
  5061. {
  5062. "name": "id",
  5063. "in": "path",
  5064. "description": "The id of the task",
  5065. "required": true,
  5066. "schema": {
  5067. "type": "integer",
  5068. "format": "int64"
  5069. }
  5070. },
  5071. {
  5072. "name": "OCS-APIRequest",
  5073. "in": "header",
  5074. "description": "Required to be true for the API request to pass",
  5075. "required": true,
  5076. "schema": {
  5077. "type": "boolean",
  5078. "default": true
  5079. }
  5080. }
  5081. ],
  5082. "responses": {
  5083. "200": {
  5084. "description": "Task returned",
  5085. "content": {
  5086. "application/json": {
  5087. "schema": {
  5088. "type": "object",
  5089. "required": [
  5090. "ocs"
  5091. ],
  5092. "properties": {
  5093. "ocs": {
  5094. "type": "object",
  5095. "required": [
  5096. "meta",
  5097. "data"
  5098. ],
  5099. "properties": {
  5100. "meta": {
  5101. "$ref": "#/components/schemas/OCSMeta"
  5102. },
  5103. "data": {
  5104. "type": "object",
  5105. "required": [
  5106. "task"
  5107. ],
  5108. "properties": {
  5109. "task": {
  5110. "$ref": "#/components/schemas/TextProcessingTask"
  5111. }
  5112. }
  5113. }
  5114. }
  5115. }
  5116. }
  5117. }
  5118. }
  5119. }
  5120. },
  5121. "404": {
  5122. "description": "Task not found",
  5123. "content": {
  5124. "application/json": {
  5125. "schema": {
  5126. "type": "object",
  5127. "required": [
  5128. "ocs"
  5129. ],
  5130. "properties": {
  5131. "ocs": {
  5132. "type": "object",
  5133. "required": [
  5134. "meta",
  5135. "data"
  5136. ],
  5137. "properties": {
  5138. "meta": {
  5139. "$ref": "#/components/schemas/OCSMeta"
  5140. },
  5141. "data": {
  5142. "type": "object",
  5143. "required": [
  5144. "message"
  5145. ],
  5146. "properties": {
  5147. "message": {
  5148. "type": "string"
  5149. }
  5150. }
  5151. }
  5152. }
  5153. }
  5154. }
  5155. }
  5156. }
  5157. }
  5158. },
  5159. "500": {
  5160. "description": "",
  5161. "content": {
  5162. "application/json": {
  5163. "schema": {
  5164. "type": "object",
  5165. "required": [
  5166. "ocs"
  5167. ],
  5168. "properties": {
  5169. "ocs": {
  5170. "type": "object",
  5171. "required": [
  5172. "meta",
  5173. "data"
  5174. ],
  5175. "properties": {
  5176. "meta": {
  5177. "$ref": "#/components/schemas/OCSMeta"
  5178. },
  5179. "data": {
  5180. "type": "object",
  5181. "required": [
  5182. "message"
  5183. ],
  5184. "properties": {
  5185. "message": {
  5186. "type": "string"
  5187. }
  5188. }
  5189. }
  5190. }
  5191. }
  5192. }
  5193. }
  5194. }
  5195. }
  5196. }
  5197. }
  5198. },
  5199. "delete": {
  5200. "operationId": "text_processing_api-delete-task",
  5201. "summary": "This endpoint allows to delete a scheduled task for a user",
  5202. "tags": [
  5203. "text_processing_api"
  5204. ],
  5205. "security": [
  5206. {
  5207. "bearer_auth": []
  5208. },
  5209. {
  5210. "basic_auth": []
  5211. }
  5212. ],
  5213. "parameters": [
  5214. {
  5215. "name": "id",
  5216. "in": "path",
  5217. "description": "The id of the task",
  5218. "required": true,
  5219. "schema": {
  5220. "type": "integer",
  5221. "format": "int64"
  5222. }
  5223. },
  5224. {
  5225. "name": "OCS-APIRequest",
  5226. "in": "header",
  5227. "description": "Required to be true for the API request to pass",
  5228. "required": true,
  5229. "schema": {
  5230. "type": "boolean",
  5231. "default": true
  5232. }
  5233. }
  5234. ],
  5235. "responses": {
  5236. "200": {
  5237. "description": "Task returned",
  5238. "content": {
  5239. "application/json": {
  5240. "schema": {
  5241. "type": "object",
  5242. "required": [
  5243. "ocs"
  5244. ],
  5245. "properties": {
  5246. "ocs": {
  5247. "type": "object",
  5248. "required": [
  5249. "meta",
  5250. "data"
  5251. ],
  5252. "properties": {
  5253. "meta": {
  5254. "$ref": "#/components/schemas/OCSMeta"
  5255. },
  5256. "data": {
  5257. "type": "object",
  5258. "required": [
  5259. "task"
  5260. ],
  5261. "properties": {
  5262. "task": {
  5263. "$ref": "#/components/schemas/TextProcessingTask"
  5264. }
  5265. }
  5266. }
  5267. }
  5268. }
  5269. }
  5270. }
  5271. }
  5272. }
  5273. },
  5274. "404": {
  5275. "description": "Task not found",
  5276. "content": {
  5277. "application/json": {
  5278. "schema": {
  5279. "type": "object",
  5280. "required": [
  5281. "ocs"
  5282. ],
  5283. "properties": {
  5284. "ocs": {
  5285. "type": "object",
  5286. "required": [
  5287. "meta",
  5288. "data"
  5289. ],
  5290. "properties": {
  5291. "meta": {
  5292. "$ref": "#/components/schemas/OCSMeta"
  5293. },
  5294. "data": {
  5295. "type": "object",
  5296. "required": [
  5297. "message"
  5298. ],
  5299. "properties": {
  5300. "message": {
  5301. "type": "string"
  5302. }
  5303. }
  5304. }
  5305. }
  5306. }
  5307. }
  5308. }
  5309. }
  5310. }
  5311. },
  5312. "500": {
  5313. "description": "",
  5314. "content": {
  5315. "application/json": {
  5316. "schema": {
  5317. "type": "object",
  5318. "required": [
  5319. "ocs"
  5320. ],
  5321. "properties": {
  5322. "ocs": {
  5323. "type": "object",
  5324. "required": [
  5325. "meta",
  5326. "data"
  5327. ],
  5328. "properties": {
  5329. "meta": {
  5330. "$ref": "#/components/schemas/OCSMeta"
  5331. },
  5332. "data": {
  5333. "type": "object",
  5334. "required": [
  5335. "message"
  5336. ],
  5337. "properties": {
  5338. "message": {
  5339. "type": "string"
  5340. }
  5341. }
  5342. }
  5343. }
  5344. }
  5345. }
  5346. }
  5347. }
  5348. }
  5349. }
  5350. }
  5351. }
  5352. },
  5353. "/ocs/v2.php/textprocessing/tasks/app/{appId}": {
  5354. "get": {
  5355. "operationId": "text_processing_api-list-tasks-by-app",
  5356. "summary": "This endpoint returns a list of tasks of a user that are related with a specific appId and optionally with an identifier",
  5357. "tags": [
  5358. "text_processing_api"
  5359. ],
  5360. "security": [
  5361. {
  5362. "bearer_auth": []
  5363. },
  5364. {
  5365. "basic_auth": []
  5366. }
  5367. ],
  5368. "parameters": [
  5369. {
  5370. "name": "identifier",
  5371. "in": "query",
  5372. "description": "An arbitrary identifier for the task",
  5373. "schema": {
  5374. "type": "string",
  5375. "nullable": true
  5376. }
  5377. },
  5378. {
  5379. "name": "appId",
  5380. "in": "path",
  5381. "description": "ID of the app",
  5382. "required": true,
  5383. "schema": {
  5384. "type": "string"
  5385. }
  5386. },
  5387. {
  5388. "name": "OCS-APIRequest",
  5389. "in": "header",
  5390. "description": "Required to be true for the API request to pass",
  5391. "required": true,
  5392. "schema": {
  5393. "type": "boolean",
  5394. "default": true
  5395. }
  5396. }
  5397. ],
  5398. "responses": {
  5399. "200": {
  5400. "description": "Task list returned",
  5401. "content": {
  5402. "application/json": {
  5403. "schema": {
  5404. "type": "object",
  5405. "required": [
  5406. "ocs"
  5407. ],
  5408. "properties": {
  5409. "ocs": {
  5410. "type": "object",
  5411. "required": [
  5412. "meta",
  5413. "data"
  5414. ],
  5415. "properties": {
  5416. "meta": {
  5417. "$ref": "#/components/schemas/OCSMeta"
  5418. },
  5419. "data": {
  5420. "type": "object",
  5421. "required": [
  5422. "tasks"
  5423. ],
  5424. "properties": {
  5425. "tasks": {
  5426. "type": "array",
  5427. "items": {
  5428. "$ref": "#/components/schemas/TextProcessingTask"
  5429. }
  5430. }
  5431. }
  5432. }
  5433. }
  5434. }
  5435. }
  5436. }
  5437. }
  5438. }
  5439. },
  5440. "500": {
  5441. "description": "",
  5442. "content": {
  5443. "application/json": {
  5444. "schema": {
  5445. "type": "object",
  5446. "required": [
  5447. "ocs"
  5448. ],
  5449. "properties": {
  5450. "ocs": {
  5451. "type": "object",
  5452. "required": [
  5453. "meta",
  5454. "data"
  5455. ],
  5456. "properties": {
  5457. "meta": {
  5458. "$ref": "#/components/schemas/OCSMeta"
  5459. },
  5460. "data": {
  5461. "type": "object",
  5462. "required": [
  5463. "message"
  5464. ],
  5465. "properties": {
  5466. "message": {
  5467. "type": "string"
  5468. }
  5469. }
  5470. }
  5471. }
  5472. }
  5473. }
  5474. }
  5475. }
  5476. }
  5477. }
  5478. }
  5479. }
  5480. },
  5481. "/ocs/v2.php/text2image/is_available": {
  5482. "get": {
  5483. "operationId": "text_to_image_api-is-available",
  5484. "summary": "Check whether this feature is available",
  5485. "tags": [
  5486. "text_to_image_api"
  5487. ],
  5488. "security": [
  5489. {},
  5490. {
  5491. "bearer_auth": []
  5492. },
  5493. {
  5494. "basic_auth": []
  5495. }
  5496. ],
  5497. "parameters": [
  5498. {
  5499. "name": "OCS-APIRequest",
  5500. "in": "header",
  5501. "description": "Required to be true for the API request to pass",
  5502. "required": true,
  5503. "schema": {
  5504. "type": "boolean",
  5505. "default": true
  5506. }
  5507. }
  5508. ],
  5509. "responses": {
  5510. "200": {
  5511. "description": "Returns availability status",
  5512. "content": {
  5513. "application/json": {
  5514. "schema": {
  5515. "type": "object",
  5516. "required": [
  5517. "ocs"
  5518. ],
  5519. "properties": {
  5520. "ocs": {
  5521. "type": "object",
  5522. "required": [
  5523. "meta",
  5524. "data"
  5525. ],
  5526. "properties": {
  5527. "meta": {
  5528. "$ref": "#/components/schemas/OCSMeta"
  5529. },
  5530. "data": {
  5531. "type": "object",
  5532. "required": [
  5533. "isAvailable"
  5534. ],
  5535. "properties": {
  5536. "isAvailable": {
  5537. "type": "boolean"
  5538. }
  5539. }
  5540. }
  5541. }
  5542. }
  5543. }
  5544. }
  5545. }
  5546. }
  5547. }
  5548. }
  5549. }
  5550. },
  5551. "/ocs/v2.php/text2image/schedule": {
  5552. "post": {
  5553. "operationId": "text_to_image_api-schedule",
  5554. "summary": "This endpoint allows scheduling a text to image task",
  5555. "tags": [
  5556. "text_to_image_api"
  5557. ],
  5558. "security": [
  5559. {},
  5560. {
  5561. "bearer_auth": []
  5562. },
  5563. {
  5564. "basic_auth": []
  5565. }
  5566. ],
  5567. "parameters": [
  5568. {
  5569. "name": "input",
  5570. "in": "query",
  5571. "description": "Input text",
  5572. "required": true,
  5573. "schema": {
  5574. "type": "string"
  5575. }
  5576. },
  5577. {
  5578. "name": "appId",
  5579. "in": "query",
  5580. "description": "ID of the app that will execute the task",
  5581. "required": true,
  5582. "schema": {
  5583. "type": "string"
  5584. }
  5585. },
  5586. {
  5587. "name": "identifier",
  5588. "in": "query",
  5589. "description": "An arbitrary identifier for the task",
  5590. "schema": {
  5591. "type": "string",
  5592. "default": ""
  5593. }
  5594. },
  5595. {
  5596. "name": "numberOfImages",
  5597. "in": "query",
  5598. "description": "The number of images to generate",
  5599. "schema": {
  5600. "type": "integer",
  5601. "format": "int64",
  5602. "default": 8
  5603. }
  5604. },
  5605. {
  5606. "name": "OCS-APIRequest",
  5607. "in": "header",
  5608. "description": "Required to be true for the API request to pass",
  5609. "required": true,
  5610. "schema": {
  5611. "type": "boolean",
  5612. "default": true
  5613. }
  5614. }
  5615. ],
  5616. "responses": {
  5617. "200": {
  5618. "description": "Task scheduled successfully",
  5619. "content": {
  5620. "application/json": {
  5621. "schema": {
  5622. "type": "object",
  5623. "required": [
  5624. "ocs"
  5625. ],
  5626. "properties": {
  5627. "ocs": {
  5628. "type": "object",
  5629. "required": [
  5630. "meta",
  5631. "data"
  5632. ],
  5633. "properties": {
  5634. "meta": {
  5635. "$ref": "#/components/schemas/OCSMeta"
  5636. },
  5637. "data": {
  5638. "type": "object",
  5639. "required": [
  5640. "task"
  5641. ],
  5642. "properties": {
  5643. "task": {
  5644. "$ref": "#/components/schemas/TextToImageTask"
  5645. }
  5646. }
  5647. }
  5648. }
  5649. }
  5650. }
  5651. }
  5652. }
  5653. }
  5654. },
  5655. "412": {
  5656. "description": "Scheduling task is not possible",
  5657. "content": {
  5658. "application/json": {
  5659. "schema": {
  5660. "type": "object",
  5661. "required": [
  5662. "ocs"
  5663. ],
  5664. "properties": {
  5665. "ocs": {
  5666. "type": "object",
  5667. "required": [
  5668. "meta",
  5669. "data"
  5670. ],
  5671. "properties": {
  5672. "meta": {
  5673. "$ref": "#/components/schemas/OCSMeta"
  5674. },
  5675. "data": {
  5676. "type": "object",
  5677. "required": [
  5678. "message"
  5679. ],
  5680. "properties": {
  5681. "message": {
  5682. "type": "string"
  5683. }
  5684. }
  5685. }
  5686. }
  5687. }
  5688. }
  5689. }
  5690. }
  5691. }
  5692. },
  5693. "500": {
  5694. "description": "",
  5695. "content": {
  5696. "application/json": {
  5697. "schema": {
  5698. "type": "object",
  5699. "required": [
  5700. "ocs"
  5701. ],
  5702. "properties": {
  5703. "ocs": {
  5704. "type": "object",
  5705. "required": [
  5706. "meta",
  5707. "data"
  5708. ],
  5709. "properties": {
  5710. "meta": {
  5711. "$ref": "#/components/schemas/OCSMeta"
  5712. },
  5713. "data": {
  5714. "type": "object",
  5715. "required": [
  5716. "message"
  5717. ],
  5718. "properties": {
  5719. "message": {
  5720. "type": "string"
  5721. }
  5722. }
  5723. }
  5724. }
  5725. }
  5726. }
  5727. }
  5728. }
  5729. }
  5730. }
  5731. }
  5732. }
  5733. },
  5734. "/ocs/v2.php/text2image/task/{id}": {
  5735. "get": {
  5736. "operationId": "text_to_image_api-get-task",
  5737. "summary": "This endpoint allows checking the status and results of a task. Tasks are removed 1 week after receiving their last update.",
  5738. "tags": [
  5739. "text_to_image_api"
  5740. ],
  5741. "security": [
  5742. {},
  5743. {
  5744. "bearer_auth": []
  5745. },
  5746. {
  5747. "basic_auth": []
  5748. }
  5749. ],
  5750. "parameters": [
  5751. {
  5752. "name": "id",
  5753. "in": "path",
  5754. "description": "The id of the task",
  5755. "required": true,
  5756. "schema": {
  5757. "type": "integer",
  5758. "format": "int64"
  5759. }
  5760. },
  5761. {
  5762. "name": "OCS-APIRequest",
  5763. "in": "header",
  5764. "description": "Required to be true for the API request to pass",
  5765. "required": true,
  5766. "schema": {
  5767. "type": "boolean",
  5768. "default": true
  5769. }
  5770. }
  5771. ],
  5772. "responses": {
  5773. "200": {
  5774. "description": "Task returned",
  5775. "content": {
  5776. "application/json": {
  5777. "schema": {
  5778. "type": "object",
  5779. "required": [
  5780. "ocs"
  5781. ],
  5782. "properties": {
  5783. "ocs": {
  5784. "type": "object",
  5785. "required": [
  5786. "meta",
  5787. "data"
  5788. ],
  5789. "properties": {
  5790. "meta": {
  5791. "$ref": "#/components/schemas/OCSMeta"
  5792. },
  5793. "data": {
  5794. "type": "object",
  5795. "required": [
  5796. "task"
  5797. ],
  5798. "properties": {
  5799. "task": {
  5800. "$ref": "#/components/schemas/TextToImageTask"
  5801. }
  5802. }
  5803. }
  5804. }
  5805. }
  5806. }
  5807. }
  5808. }
  5809. }
  5810. },
  5811. "404": {
  5812. "description": "Task not found",
  5813. "content": {
  5814. "application/json": {
  5815. "schema": {
  5816. "type": "object",
  5817. "required": [
  5818. "ocs"
  5819. ],
  5820. "properties": {
  5821. "ocs": {
  5822. "type": "object",
  5823. "required": [
  5824. "meta",
  5825. "data"
  5826. ],
  5827. "properties": {
  5828. "meta": {
  5829. "$ref": "#/components/schemas/OCSMeta"
  5830. },
  5831. "data": {
  5832. "type": "object",
  5833. "required": [
  5834. "message"
  5835. ],
  5836. "properties": {
  5837. "message": {
  5838. "type": "string"
  5839. }
  5840. }
  5841. }
  5842. }
  5843. }
  5844. }
  5845. }
  5846. }
  5847. }
  5848. },
  5849. "500": {
  5850. "description": "",
  5851. "content": {
  5852. "application/json": {
  5853. "schema": {
  5854. "type": "object",
  5855. "required": [
  5856. "ocs"
  5857. ],
  5858. "properties": {
  5859. "ocs": {
  5860. "type": "object",
  5861. "required": [
  5862. "meta",
  5863. "data"
  5864. ],
  5865. "properties": {
  5866. "meta": {
  5867. "$ref": "#/components/schemas/OCSMeta"
  5868. },
  5869. "data": {
  5870. "type": "object",
  5871. "required": [
  5872. "message"
  5873. ],
  5874. "properties": {
  5875. "message": {
  5876. "type": "string"
  5877. }
  5878. }
  5879. }
  5880. }
  5881. }
  5882. }
  5883. }
  5884. }
  5885. }
  5886. }
  5887. }
  5888. },
  5889. "delete": {
  5890. "operationId": "text_to_image_api-delete-task",
  5891. "summary": "This endpoint allows to delete a scheduled task for a user",
  5892. "tags": [
  5893. "text_to_image_api"
  5894. ],
  5895. "security": [
  5896. {
  5897. "bearer_auth": []
  5898. },
  5899. {
  5900. "basic_auth": []
  5901. }
  5902. ],
  5903. "parameters": [
  5904. {
  5905. "name": "id",
  5906. "in": "path",
  5907. "description": "The id of the task",
  5908. "required": true,
  5909. "schema": {
  5910. "type": "integer",
  5911. "format": "int64"
  5912. }
  5913. },
  5914. {
  5915. "name": "OCS-APIRequest",
  5916. "in": "header",
  5917. "description": "Required to be true for the API request to pass",
  5918. "required": true,
  5919. "schema": {
  5920. "type": "boolean",
  5921. "default": true
  5922. }
  5923. }
  5924. ],
  5925. "responses": {
  5926. "200": {
  5927. "description": "Task returned",
  5928. "content": {
  5929. "application/json": {
  5930. "schema": {
  5931. "type": "object",
  5932. "required": [
  5933. "ocs"
  5934. ],
  5935. "properties": {
  5936. "ocs": {
  5937. "type": "object",
  5938. "required": [
  5939. "meta",
  5940. "data"
  5941. ],
  5942. "properties": {
  5943. "meta": {
  5944. "$ref": "#/components/schemas/OCSMeta"
  5945. },
  5946. "data": {
  5947. "type": "object",
  5948. "required": [
  5949. "task"
  5950. ],
  5951. "properties": {
  5952. "task": {
  5953. "$ref": "#/components/schemas/TextToImageTask"
  5954. }
  5955. }
  5956. }
  5957. }
  5958. }
  5959. }
  5960. }
  5961. }
  5962. }
  5963. },
  5964. "404": {
  5965. "description": "Task not found",
  5966. "content": {
  5967. "application/json": {
  5968. "schema": {
  5969. "type": "object",
  5970. "required": [
  5971. "ocs"
  5972. ],
  5973. "properties": {
  5974. "ocs": {
  5975. "type": "object",
  5976. "required": [
  5977. "meta",
  5978. "data"
  5979. ],
  5980. "properties": {
  5981. "meta": {
  5982. "$ref": "#/components/schemas/OCSMeta"
  5983. },
  5984. "data": {
  5985. "type": "object",
  5986. "required": [
  5987. "message"
  5988. ],
  5989. "properties": {
  5990. "message": {
  5991. "type": "string"
  5992. }
  5993. }
  5994. }
  5995. }
  5996. }
  5997. }
  5998. }
  5999. }
  6000. }
  6001. },
  6002. "500": {
  6003. "description": "",
  6004. "content": {
  6005. "application/json": {
  6006. "schema": {
  6007. "type": "object",
  6008. "required": [
  6009. "ocs"
  6010. ],
  6011. "properties": {
  6012. "ocs": {
  6013. "type": "object",
  6014. "required": [
  6015. "meta",
  6016. "data"
  6017. ],
  6018. "properties": {
  6019. "meta": {
  6020. "$ref": "#/components/schemas/OCSMeta"
  6021. },
  6022. "data": {
  6023. "type": "object",
  6024. "required": [
  6025. "message"
  6026. ],
  6027. "properties": {
  6028. "message": {
  6029. "type": "string"
  6030. }
  6031. }
  6032. }
  6033. }
  6034. }
  6035. }
  6036. }
  6037. }
  6038. }
  6039. }
  6040. }
  6041. }
  6042. },
  6043. "/ocs/v2.php/text2image/task/{id}/image/{index}": {
  6044. "get": {
  6045. "operationId": "text_to_image_api-get-image",
  6046. "summary": "This endpoint allows downloading the resulting image of a task",
  6047. "tags": [
  6048. "text_to_image_api"
  6049. ],
  6050. "security": [
  6051. {},
  6052. {
  6053. "bearer_auth": []
  6054. },
  6055. {
  6056. "basic_auth": []
  6057. }
  6058. ],
  6059. "parameters": [
  6060. {
  6061. "name": "id",
  6062. "in": "path",
  6063. "description": "The id of the task",
  6064. "required": true,
  6065. "schema": {
  6066. "type": "integer",
  6067. "format": "int64"
  6068. }
  6069. },
  6070. {
  6071. "name": "index",
  6072. "in": "path",
  6073. "description": "The index of the image to retrieve",
  6074. "required": true,
  6075. "schema": {
  6076. "type": "integer",
  6077. "format": "int64"
  6078. }
  6079. },
  6080. {
  6081. "name": "OCS-APIRequest",
  6082. "in": "header",
  6083. "description": "Required to be true for the API request to pass",
  6084. "required": true,
  6085. "schema": {
  6086. "type": "boolean",
  6087. "default": true
  6088. }
  6089. }
  6090. ],
  6091. "responses": {
  6092. "200": {
  6093. "description": "Image returned",
  6094. "content": {
  6095. "*/*": {
  6096. "schema": {
  6097. "type": "string",
  6098. "format": "binary"
  6099. }
  6100. }
  6101. }
  6102. },
  6103. "404": {
  6104. "description": "Task or image not found",
  6105. "content": {
  6106. "application/json": {
  6107. "schema": {
  6108. "type": "object",
  6109. "required": [
  6110. "ocs"
  6111. ],
  6112. "properties": {
  6113. "ocs": {
  6114. "type": "object",
  6115. "required": [
  6116. "meta",
  6117. "data"
  6118. ],
  6119. "properties": {
  6120. "meta": {
  6121. "$ref": "#/components/schemas/OCSMeta"
  6122. },
  6123. "data": {
  6124. "type": "object",
  6125. "required": [
  6126. "message"
  6127. ],
  6128. "properties": {
  6129. "message": {
  6130. "type": "string"
  6131. }
  6132. }
  6133. }
  6134. }
  6135. }
  6136. }
  6137. }
  6138. }
  6139. }
  6140. },
  6141. "500": {
  6142. "description": "",
  6143. "content": {
  6144. "application/json": {
  6145. "schema": {
  6146. "type": "object",
  6147. "required": [
  6148. "ocs"
  6149. ],
  6150. "properties": {
  6151. "ocs": {
  6152. "type": "object",
  6153. "required": [
  6154. "meta",
  6155. "data"
  6156. ],
  6157. "properties": {
  6158. "meta": {
  6159. "$ref": "#/components/schemas/OCSMeta"
  6160. },
  6161. "data": {
  6162. "type": "object",
  6163. "required": [
  6164. "message"
  6165. ],
  6166. "properties": {
  6167. "message": {
  6168. "type": "string"
  6169. }
  6170. }
  6171. }
  6172. }
  6173. }
  6174. }
  6175. }
  6176. }
  6177. }
  6178. }
  6179. }
  6180. }
  6181. },
  6182. "/ocs/v2.php/text2image/tasks/app/{appId}": {
  6183. "get": {
  6184. "operationId": "text_to_image_api-list-tasks-by-app",
  6185. "summary": "This endpoint returns a list of tasks of a user that are related with a specific appId and optionally with an identifier",
  6186. "tags": [
  6187. "text_to_image_api"
  6188. ],
  6189. "security": [
  6190. {
  6191. "bearer_auth": []
  6192. },
  6193. {
  6194. "basic_auth": []
  6195. }
  6196. ],
  6197. "parameters": [
  6198. {
  6199. "name": "identifier",
  6200. "in": "query",
  6201. "description": "An arbitrary identifier for the task",
  6202. "schema": {
  6203. "type": "string",
  6204. "nullable": true
  6205. }
  6206. },
  6207. {
  6208. "name": "appId",
  6209. "in": "path",
  6210. "description": "ID of the app",
  6211. "required": true,
  6212. "schema": {
  6213. "type": "string"
  6214. }
  6215. },
  6216. {
  6217. "name": "OCS-APIRequest",
  6218. "in": "header",
  6219. "description": "Required to be true for the API request to pass",
  6220. "required": true,
  6221. "schema": {
  6222. "type": "boolean",
  6223. "default": true
  6224. }
  6225. }
  6226. ],
  6227. "responses": {
  6228. "200": {
  6229. "description": "Task list returned",
  6230. "content": {
  6231. "application/json": {
  6232. "schema": {
  6233. "type": "object",
  6234. "required": [
  6235. "ocs"
  6236. ],
  6237. "properties": {
  6238. "ocs": {
  6239. "type": "object",
  6240. "required": [
  6241. "meta",
  6242. "data"
  6243. ],
  6244. "properties": {
  6245. "meta": {
  6246. "$ref": "#/components/schemas/OCSMeta"
  6247. },
  6248. "data": {
  6249. "type": "object",
  6250. "required": [
  6251. "tasks"
  6252. ],
  6253. "properties": {
  6254. "tasks": {
  6255. "type": "array",
  6256. "items": {
  6257. "$ref": "#/components/schemas/TextToImageTask"
  6258. }
  6259. }
  6260. }
  6261. }
  6262. }
  6263. }
  6264. }
  6265. }
  6266. }
  6267. }
  6268. },
  6269. "500": {
  6270. "description": "",
  6271. "content": {
  6272. "application/json": {
  6273. "schema": {
  6274. "type": "object",
  6275. "required": [
  6276. "ocs"
  6277. ],
  6278. "properties": {
  6279. "ocs": {
  6280. "type": "object",
  6281. "required": [
  6282. "meta",
  6283. "data"
  6284. ],
  6285. "properties": {
  6286. "meta": {
  6287. "$ref": "#/components/schemas/OCSMeta"
  6288. },
  6289. "data": {
  6290. "type": "object",
  6291. "required": [
  6292. "message"
  6293. ],
  6294. "properties": {
  6295. "message": {
  6296. "type": "string"
  6297. }
  6298. }
  6299. }
  6300. }
  6301. }
  6302. }
  6303. }
  6304. }
  6305. }
  6306. }
  6307. }
  6308. }
  6309. },
  6310. "/status.php": {
  6311. "get": {
  6312. "operationId": "get-status",
  6313. "responses": {
  6314. "200": {
  6315. "description": "Status returned",
  6316. "content": {
  6317. "application/json": {
  6318. "schema": {
  6319. "$ref": "#/components/schemas/Status"
  6320. }
  6321. }
  6322. }
  6323. }
  6324. }
  6325. }
  6326. }
  6327. },
  6328. "tags": [
  6329. {
  6330. "name": "avatar",
  6331. "description": "Class AvatarController"
  6332. },
  6333. {
  6334. "name": "guest_avatar",
  6335. "description": "This controller handles guest avatar requests."
  6336. },
  6337. {
  6338. "name": "ocm",
  6339. "description": "Controller about the endpoint /ocm-provider/"
  6340. }
  6341. ]
  6342. }