1
0

openapi.json 266 KB

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