openapi.json 279 KB

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