openapi.json 259 KB

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