| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515 |
- {
- "openapi": "3.0.3",
- "info": {
- "title": "core-full",
- "version": "0.0.1",
- "description": "Core functionality of Nextcloud",
- "license": {
- "name": "agpl"
- }
- },
- "components": {
- "securitySchemes": {
- "basic_auth": {
- "type": "http",
- "scheme": "basic"
- },
- "bearer_auth": {
- "type": "http",
- "scheme": "bearer"
- }
- },
- "schemas": {
- "AutocompleteResult": {
- "type": "object",
- "required": [
- "id",
- "label",
- "icon",
- "source",
- "status",
- "subline",
- "shareWithDisplayNameUnique"
- ],
- "properties": {
- "id": {
- "type": "string"
- },
- "label": {
- "type": "string"
- },
- "icon": {
- "type": "string"
- },
- "source": {
- "type": "string"
- },
- "status": {
- "oneOf": [
- {
- "type": "object",
- "required": [
- "status",
- "message",
- "icon",
- "clearAt"
- ],
- "properties": {
- "status": {
- "type": "string"
- },
- "message": {
- "type": "string",
- "nullable": true
- },
- "icon": {
- "type": "string",
- "nullable": true
- },
- "clearAt": {
- "type": "integer",
- "format": "int64",
- "nullable": true
- }
- }
- },
- {
- "type": "string"
- }
- ]
- },
- "subline": {
- "type": "string"
- },
- "shareWithDisplayNameUnique": {
- "type": "string"
- }
- }
- },
- "Capabilities": {
- "type": "object",
- "required": [
- "core"
- ],
- "properties": {
- "core": {
- "type": "object",
- "required": [
- "pollinterval",
- "webdav-root",
- "reference-api",
- "reference-regex",
- "mod-rewrite-working"
- ],
- "properties": {
- "pollinterval": {
- "type": "integer",
- "format": "int64"
- },
- "webdav-root": {
- "type": "string"
- },
- "reference-api": {
- "type": "boolean"
- },
- "reference-regex": {
- "type": "string"
- },
- "mod-rewrite-working": {
- "type": "boolean"
- }
- }
- }
- }
- },
- "Collection": {
- "type": "object",
- "required": [
- "id",
- "name",
- "resources"
- ],
- "properties": {
- "id": {
- "type": "integer",
- "format": "int64"
- },
- "name": {
- "type": "string"
- },
- "resources": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Resource"
- }
- }
- }
- },
- "ContactsAction": {
- "type": "object",
- "required": [
- "title",
- "icon",
- "hyperlink",
- "appId"
- ],
- "properties": {
- "title": {
- "type": "string"
- },
- "icon": {
- "type": "string"
- },
- "hyperlink": {
- "type": "string"
- },
- "appId": {
- "type": "string"
- }
- }
- },
- "LoginFlowV2": {
- "type": "object",
- "required": [
- "poll",
- "login"
- ],
- "properties": {
- "poll": {
- "type": "object",
- "required": [
- "token",
- "endpoint"
- ],
- "properties": {
- "token": {
- "type": "string"
- },
- "endpoint": {
- "type": "string"
- }
- }
- },
- "login": {
- "type": "string"
- }
- }
- },
- "LoginFlowV2Credentials": {
- "type": "object",
- "required": [
- "server",
- "loginName",
- "appPassword"
- ],
- "properties": {
- "server": {
- "type": "string"
- },
- "loginName": {
- "type": "string"
- },
- "appPassword": {
- "type": "string"
- }
- }
- },
- "NavigationEntry": {
- "type": "object",
- "required": [
- "id",
- "href",
- "icon",
- "type",
- "name",
- "active",
- "classes",
- "unread"
- ],
- "properties": {
- "id": {
- "type": "string"
- },
- "order": {
- "type": "integer",
- "format": "int64"
- },
- "href": {
- "type": "string"
- },
- "icon": {
- "type": "string"
- },
- "type": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "app": {
- "type": "string"
- },
- "default": {
- "type": "boolean"
- },
- "active": {
- "type": "boolean"
- },
- "classes": {
- "type": "string"
- },
- "unread": {
- "type": "integer",
- "format": "int64"
- }
- }
- },
- "OCSMeta": {
- "type": "object",
- "required": [
- "status",
- "statuscode"
- ],
- "properties": {
- "status": {
- "type": "string"
- },
- "statuscode": {
- "type": "integer"
- },
- "message": {
- "type": "string"
- },
- "totalitems": {
- "type": "string"
- },
- "itemsperpage": {
- "type": "string"
- }
- }
- },
- "OpenGraphObject": {
- "type": "object",
- "required": [
- "id",
- "name",
- "description",
- "thumb",
- "link"
- ],
- "properties": {
- "id": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "description": {
- "type": "string",
- "nullable": true
- },
- "thumb": {
- "type": "string",
- "nullable": true
- },
- "link": {
- "type": "string"
- }
- }
- },
- "PublicCapabilities": {
- "type": "object",
- "required": [
- "bruteforce"
- ],
- "properties": {
- "bruteforce": {
- "type": "object",
- "required": [
- "delay",
- "allow-listed"
- ],
- "properties": {
- "delay": {
- "type": "integer",
- "format": "int64"
- },
- "allow-listed": {
- "type": "boolean"
- }
- }
- }
- }
- },
- "Reference": {
- "type": "object",
- "required": [
- "richObjectType",
- "richObject",
- "openGraphObject",
- "accessible"
- ],
- "properties": {
- "richObjectType": {
- "type": "string"
- },
- "richObject": {
- "type": "object",
- "additionalProperties": {
- "type": "object",
- "nullable": true
- }
- },
- "openGraphObject": {
- "$ref": "#/components/schemas/OpenGraphObject"
- },
- "accessible": {
- "type": "boolean"
- }
- }
- },
- "ReferenceProvider": {
- "type": "object",
- "required": [
- "id",
- "title",
- "icon_url",
- "order",
- "search_providers_ids"
- ],
- "properties": {
- "id": {
- "type": "string"
- },
- "title": {
- "type": "string"
- },
- "icon_url": {
- "type": "string"
- },
- "order": {
- "type": "integer",
- "format": "int64"
- },
- "search_providers_ids": {
- "type": "array",
- "nullable": true,
- "items": {
- "type": "string"
- }
- }
- }
- },
- "Resource": {
- "type": "object",
- "required": [
- "richObjectType",
- "richObject",
- "openGraphObject",
- "accessible"
- ],
- "properties": {
- "richObjectType": {
- "type": "string"
- },
- "richObject": {
- "type": "object",
- "additionalProperties": {
- "type": "object",
- "nullable": true
- }
- },
- "openGraphObject": {
- "$ref": "#/components/schemas/OpenGraphObject"
- },
- "accessible": {
- "type": "boolean"
- }
- }
- },
- "Status": {
- "type": "object",
- "required": [
- "installed",
- "maintenance",
- "needsDbUpgrade",
- "version",
- "versionstring",
- "edition",
- "productname",
- "extendedSupport"
- ],
- "properties": {
- "installed": {
- "type": "boolean"
- },
- "maintenance": {
- "type": "boolean"
- },
- "needsDbUpgrade": {
- "type": "boolean"
- },
- "version": {
- "type": "string"
- },
- "versionstring": {
- "type": "string"
- },
- "edition": {
- "type": "string"
- },
- "productname": {
- "type": "string"
- },
- "extendedSupport": {
- "type": "boolean"
- }
- }
- },
- "TaskProcessingIO": {
- "type": "object",
- "additionalProperties": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "array",
- "items": {
- "type": "number"
- }
- },
- {
- "type": "string"
- },
- {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- ]
- }
- },
- "TaskProcessingShape": {
- "type": "object",
- "required": [
- "name",
- "description",
- "type"
- ],
- "properties": {
- "name": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "type": {
- "type": "string",
- "enum": [
- "Number",
- "Text",
- "Audio",
- "Image",
- "Video",
- "File",
- "Enum",
- "ListOfNumbers",
- "ListOfTexts",
- "ListOfImages",
- "ListOfAudios",
- "ListOfVideos",
- "ListOfFiles"
- ]
- }
- }
- },
- "TaskProcessingTask": {
- "type": "object",
- "required": [
- "id",
- "lastUpdated",
- "type",
- "status",
- "userId",
- "appId",
- "input",
- "output",
- "customId",
- "completionExpectedAt",
- "progress"
- ],
- "properties": {
- "id": {
- "type": "integer",
- "format": "int64"
- },
- "lastUpdated": {
- "type": "integer",
- "format": "int64"
- },
- "type": {
- "type": "string"
- },
- "status": {
- "type": "string",
- "enum": [
- "STATUS_CANCELLED",
- "STATUS_FAILED",
- "STATUS_SUCCESSFUL",
- "STATUS_RUNNING",
- "STATUS_SCHEDULED",
- "STATUS_UNKNOWN"
- ]
- },
- "userId": {
- "type": "string",
- "nullable": true
- },
- "appId": {
- "type": "string"
- },
- "input": {
- "$ref": "#/components/schemas/TaskProcessingIO"
- },
- "output": {
- "$ref": "#/components/schemas/TaskProcessingIO",
- "nullable": true
- },
- "customId": {
- "type": "string",
- "nullable": true
- },
- "completionExpectedAt": {
- "type": "integer",
- "format": "int64",
- "nullable": true
- },
- "progress": {
- "type": "number",
- "format": "double",
- "nullable": true
- }
- }
- },
- "TaskProcessingTaskType": {
- "type": "object",
- "required": [
- "name",
- "description",
- "inputShape",
- "inputShapeEnumValues",
- "inputShapeDefaults",
- "optionalInputShape",
- "optionalInputShapeEnumValues",
- "optionalInputShapeDefaults",
- "outputShape",
- "outputShapeEnumValues",
- "optionalOutputShape",
- "optionalOutputShapeEnumValues"
- ],
- "properties": {
- "name": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "inputShape": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/TaskProcessingShape"
- }
- },
- "inputShapeEnumValues": {
- "type": "array",
- "items": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "name",
- "value"
- ],
- "properties": {
- "name": {
- "type": "string"
- },
- "value": {
- "type": "string"
- }
- }
- }
- }
- },
- "inputShapeDefaults": {
- "type": "object",
- "additionalProperties": {
- "oneOf": [
- {
- "type": "number"
- },
- {
- "type": "string"
- }
- ]
- }
- },
- "optionalInputShape": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/TaskProcessingShape"
- }
- },
- "optionalInputShapeEnumValues": {
- "type": "array",
- "items": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "name",
- "value"
- ],
- "properties": {
- "name": {
- "type": "string"
- },
- "value": {
- "type": "string"
- }
- }
- }
- }
- },
- "optionalInputShapeDefaults": {
- "type": "object",
- "additionalProperties": {
- "oneOf": [
- {
- "type": "number"
- },
- {
- "type": "string"
- }
- ]
- }
- },
- "outputShape": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/TaskProcessingShape"
- }
- },
- "outputShapeEnumValues": {
- "type": "array",
- "items": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "name",
- "value"
- ],
- "properties": {
- "name": {
- "type": "string"
- },
- "value": {
- "type": "string"
- }
- }
- }
- }
- },
- "optionalOutputShape": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/TaskProcessingShape"
- }
- },
- "optionalOutputShapeEnumValues": {
- "type": "array",
- "items": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "name",
- "value"
- ],
- "properties": {
- "name": {
- "type": "string"
- },
- "value": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "Team": {
- "type": "object",
- "required": [
- "id",
- "name",
- "icon"
- ],
- "properties": {
- "id": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "icon": {
- "type": "string"
- }
- }
- },
- "TeamResource": {
- "type": "object",
- "required": [
- "id",
- "label",
- "url",
- "iconSvg",
- "iconURL",
- "iconEmoji"
- ],
- "properties": {
- "id": {
- "type": "integer",
- "format": "int64"
- },
- "label": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "iconSvg": {
- "type": "string",
- "nullable": true
- },
- "iconURL": {
- "type": "string",
- "nullable": true
- },
- "iconEmoji": {
- "type": "string",
- "nullable": true
- }
- }
- },
- "TextProcessingTask": {
- "type": "object",
- "required": [
- "id",
- "type",
- "status",
- "userId",
- "appId",
- "input",
- "output",
- "identifier",
- "completionExpectedAt"
- ],
- "properties": {
- "id": {
- "type": "integer",
- "format": "int64",
- "nullable": true
- },
- "type": {
- "type": "string"
- },
- "status": {
- "type": "integer",
- "format": "int64",
- "enum": [
- 0,
- 1,
- 2,
- 3,
- 4
- ]
- },
- "userId": {
- "type": "string",
- "nullable": true
- },
- "appId": {
- "type": "string"
- },
- "input": {
- "type": "string"
- },
- "output": {
- "type": "string",
- "nullable": true
- },
- "identifier": {
- "type": "string"
- },
- "completionExpectedAt": {
- "type": "integer",
- "format": "int64",
- "nullable": true
- }
- }
- },
- "TextToImageTask": {
- "type": "object",
- "required": [
- "id",
- "status",
- "userId",
- "appId",
- "input",
- "identifier",
- "numberOfImages",
- "completionExpectedAt"
- ],
- "properties": {
- "id": {
- "type": "integer",
- "format": "int64",
- "nullable": true
- },
- "status": {
- "type": "integer",
- "format": "int64",
- "enum": [
- 0,
- 1,
- 2,
- 3,
- 4
- ]
- },
- "userId": {
- "type": "string",
- "nullable": true
- },
- "appId": {
- "type": "string"
- },
- "input": {
- "type": "string"
- },
- "identifier": {
- "type": "string",
- "nullable": true
- },
- "numberOfImages": {
- "type": "integer",
- "format": "int64"
- },
- "completionExpectedAt": {
- "type": "integer",
- "format": "int64",
- "nullable": true
- }
- }
- },
- "UnifiedSearchProvider": {
- "type": "object",
- "required": [
- "id",
- "appId",
- "name",
- "icon",
- "order",
- "triggers",
- "filters",
- "inAppSearch"
- ],
- "properties": {
- "id": {
- "type": "string"
- },
- "appId": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "icon": {
- "type": "string"
- },
- "order": {
- "type": "integer",
- "format": "int64"
- },
- "triggers": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "filters": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "inAppSearch": {
- "type": "boolean"
- }
- }
- },
- "UnifiedSearchResult": {
- "type": "object",
- "required": [
- "name",
- "isPaginated",
- "entries",
- "cursor"
- ],
- "properties": {
- "name": {
- "type": "string"
- },
- "isPaginated": {
- "type": "boolean"
- },
- "entries": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/UnifiedSearchResultEntry"
- }
- },
- "cursor": {
- "nullable": true,
- "oneOf": [
- {
- "type": "integer",
- "format": "int64"
- },
- {
- "type": "string"
- }
- ]
- }
- }
- },
- "UnifiedSearchResultEntry": {
- "type": "object",
- "required": [
- "thumbnailUrl",
- "title",
- "subline",
- "resourceUrl",
- "icon",
- "rounded",
- "attributes"
- ],
- "properties": {
- "thumbnailUrl": {
- "type": "string"
- },
- "title": {
- "type": "string"
- },
- "subline": {
- "type": "string"
- },
- "resourceUrl": {
- "type": "string"
- },
- "icon": {
- "type": "string"
- },
- "rounded": {
- "type": "boolean"
- },
- "attributes": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
- }
- }
- },
- "paths": {
- "/ocs/v2.php/core/getapppassword": {
- "get": {
- "operationId": "app_password-get-app-password",
- "summary": "Create app password",
- "description": "This endpoint requires password confirmation",
- "tags": [
- "app_password"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "App password returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "apppassword"
- ],
- "properties": {
- "apppassword": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "403": {
- "description": "Creating app password is not allowed",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/core/apppassword": {
- "delete": {
- "operationId": "app_password-delete-app-password",
- "summary": "Delete app password",
- "tags": [
- "app_password"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "App password deleted successfully",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- },
- "403": {
- "description": "Deleting app password is not allowed",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/core/apppassword/rotate": {
- "post": {
- "operationId": "app_password-rotate-app-password",
- "summary": "Rotate app password",
- "tags": [
- "app_password"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "App password returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "apppassword"
- ],
- "properties": {
- "apppassword": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "403": {
- "description": "Rotating app password is not allowed",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/core/apppassword/confirm": {
- "put": {
- "operationId": "app_password-confirm-user-password",
- "summary": "Confirm the user password",
- "tags": [
- "app_password"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "password"
- ],
- "properties": {
- "password": {
- "type": "string",
- "description": "The password of the user"
- }
- }
- }
- }
- }
- },
- "parameters": [
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Password confirmation succeeded",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "lastLogin"
- ],
- "properties": {
- "lastLogin": {
- "type": "integer",
- "format": "int64"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "403": {
- "description": "Password confirmation failed",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/core/autocomplete/get": {
- "get": {
- "operationId": "auto_complete-get",
- "summary": "Autocomplete a query",
- "tags": [
- "auto_complete"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "search",
- "in": "query",
- "description": "Text to search for",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "itemType",
- "in": "query",
- "description": "Type of the items to search for",
- "schema": {
- "type": "string",
- "nullable": true
- }
- },
- {
- "name": "itemId",
- "in": "query",
- "description": "ID of the items to search for",
- "schema": {
- "type": "string",
- "nullable": true
- }
- },
- {
- "name": "sorter",
- "in": "query",
- "description": "can be piped, top prio first, e.g.: \"commenters|share-recipients\"",
- "schema": {
- "type": "string",
- "nullable": true
- }
- },
- {
- "name": "shareTypes[]",
- "in": "query",
- "description": "Types of shares to search for",
- "schema": {
- "type": "array",
- "default": [],
- "items": {
- "type": "integer",
- "format": "int64"
- }
- }
- },
- {
- "name": "limit",
- "in": "query",
- "description": "Maximum number of results to return",
- "schema": {
- "type": "integer",
- "format": "int64",
- "default": 10
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Autocomplete results returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/AutocompleteResult"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/collaboration/resources/collections/{collectionId}": {
- "get": {
- "operationId": "collaboration_resources-list-collection",
- "summary": "Get a collection",
- "tags": [
- "collaboration_resources"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "collectionId",
- "in": "path",
- "description": "ID of the collection",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Collection returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "$ref": "#/components/schemas/Collection"
- }
- }
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "Collection not found",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- },
- "500": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "post": {
- "operationId": "collaboration_resources-add-resource",
- "summary": "Add a resource to a collection",
- "tags": [
- "collaboration_resources"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "resourceType",
- "resourceId"
- ],
- "properties": {
- "resourceType": {
- "type": "string",
- "description": "Name of the resource"
- },
- "resourceId": {
- "type": "string",
- "description": "ID of the resource"
- }
- }
- }
- }
- }
- },
- "parameters": [
- {
- "name": "collectionId",
- "in": "path",
- "description": "ID of the collection",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Collection returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "$ref": "#/components/schemas/Collection"
- }
- }
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "Collection not found or resource inaccessible",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- },
- "500": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "delete": {
- "operationId": "collaboration_resources-remove-resource",
- "summary": "Remove a resource from a collection",
- "tags": [
- "collaboration_resources"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "collectionId",
- "in": "path",
- "description": "ID of the collection",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
- },
- {
- "name": "resourceType",
- "in": "query",
- "description": "Name of the resource",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "resourceId",
- "in": "query",
- "description": "ID of the resource",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Collection returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "$ref": "#/components/schemas/Collection"
- }
- }
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "Collection or resource not found",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- },
- "500": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "put": {
- "operationId": "collaboration_resources-rename-collection",
- "summary": "Rename a collection",
- "tags": [
- "collaboration_resources"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "collectionName"
- ],
- "properties": {
- "collectionName": {
- "type": "string",
- "description": "New name"
- }
- }
- }
- }
- }
- },
- "parameters": [
- {
- "name": "collectionId",
- "in": "path",
- "description": "ID of the collection",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Collection returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "$ref": "#/components/schemas/Collection"
- }
- }
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "Collection not found",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- },
- "500": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/collaboration/resources/collections/search/{filter}": {
- "get": {
- "operationId": "collaboration_resources-search-collections",
- "summary": "Search for collections",
- "tags": [
- "collaboration_resources"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "filter",
- "in": "path",
- "description": "Filter collections",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Collections returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Collection"
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "Collection not found",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/collaboration/resources/{resourceType}/{resourceId}": {
- "get": {
- "operationId": "collaboration_resources-get-collections-by-resource",
- "summary": "Get collections by resource",
- "tags": [
- "collaboration_resources"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "resourceType",
- "in": "path",
- "description": "Type of the resource",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "resourceId",
- "in": "path",
- "description": "ID of the resource",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Collections returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Collection"
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "Resource not accessible",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/collaboration/resources/{baseResourceType}/{baseResourceId}": {
- "post": {
- "operationId": "collaboration_resources-create-collection-on-resource",
- "summary": "Create a collection for a resource",
- "tags": [
- "collaboration_resources"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "name": {
- "type": "string",
- "description": "Name of the collection"
- }
- }
- }
- }
- }
- },
- "parameters": [
- {
- "name": "baseResourceType",
- "in": "path",
- "description": "Type of the base resource",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "baseResourceId",
- "in": "path",
- "description": "ID of the base resource",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Collection returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "$ref": "#/components/schemas/Collection"
- }
- }
- }
- }
- }
- }
- }
- },
- "400": {
- "description": "Creating collection is not possible",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "Resource inaccessible",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- },
- "500": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/hovercard/v1/{userId}": {
- "get": {
- "operationId": "hover_card-get-user",
- "summary": "Get the account details for a hovercard",
- "tags": [
- "hover_card"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "userId",
- "in": "path",
- "description": "ID of the user",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Account details returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "userId",
- "displayName",
- "actions"
- ],
- "properties": {
- "userId": {
- "type": "string"
- },
- "displayName": {
- "type": "string"
- },
- "actions": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ContactsAction"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "Account not found",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/core/navigation/apps": {
- "get": {
- "operationId": "navigation-get-apps-navigation",
- "summary": "Get the apps navigation",
- "tags": [
- "navigation"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "absolute",
- "in": "query",
- "description": "Rewrite URLs to absolute ones",
- "schema": {
- "type": "integer",
- "default": 0,
- "enum": [
- 0,
- 1
- ]
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Apps navigation returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/NavigationEntry"
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "304": {
- "description": "No apps navigation changed"
- }
- }
- }
- },
- "/ocs/v2.php/core/navigation/settings": {
- "get": {
- "operationId": "navigation-get-settings-navigation",
- "summary": "Get the settings navigation",
- "tags": [
- "navigation"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "absolute",
- "in": "query",
- "description": "Rewrite URLs to absolute ones",
- "schema": {
- "type": "integer",
- "default": 0,
- "enum": [
- 0,
- 1
- ]
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Apps navigation returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/NavigationEntry"
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "304": {
- "description": "No apps navigation changed"
- }
- }
- }
- },
- "/ocs/v2.php/cloud/capabilities": {
- "get": {
- "operationId": "ocs-get-capabilities",
- "summary": "Get the capabilities",
- "tags": [
- "ocs"
- ],
- "security": [
- {},
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Capabilities returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "version",
- "capabilities"
- ],
- "properties": {
- "version": {
- "type": "object",
- "required": [
- "major",
- "minor",
- "micro",
- "string",
- "edition",
- "extendedSupport"
- ],
- "properties": {
- "major": {
- "type": "integer",
- "format": "int64"
- },
- "minor": {
- "type": "integer",
- "format": "int64"
- },
- "micro": {
- "type": "integer",
- "format": "int64"
- },
- "string": {
- "type": "string"
- },
- "edition": {
- "type": "string"
- },
- "extendedSupport": {
- "type": "boolean"
- }
- }
- },
- "capabilities": {
- "type": "object",
- "additionalProperties": {
- "type": "object"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/profile/{targetUserId}": {
- "put": {
- "operationId": "profile_api-set-visibility",
- "summary": "Update the visibility of a parameter",
- "description": "This endpoint requires password confirmation",
- "tags": [
- "profile_api"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "paramId",
- "visibility"
- ],
- "properties": {
- "paramId": {
- "type": "string",
- "description": "ID of the parameter"
- },
- "visibility": {
- "type": "string",
- "description": "New visibility"
- }
- }
- }
- }
- }
- },
- "parameters": [
- {
- "name": "targetUserId",
- "in": "path",
- "description": "ID of the user",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Visibility updated successfully",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- },
- "400": {
- "description": "Updating visibility is not possible",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- },
- "403": {
- "description": "Not allowed to edit other users visibility",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "Account not found",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/references/extract": {
- "post": {
- "operationId": "reference_api-extract",
- "summary": "Extract references from a text",
- "tags": [
- "reference_api"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "text"
- ],
- "properties": {
- "text": {
- "type": "string",
- "description": "Text to extract from"
- },
- "resolve": {
- "type": "boolean",
- "default": false,
- "description": "Resolve the references"
- },
- "limit": {
- "type": "integer",
- "format": "int64",
- "default": 1,
- "description": "Maximum amount of references to extract"
- }
- }
- }
- }
- }
- },
- "parameters": [
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "References returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "references"
- ],
- "properties": {
- "references": {
- "type": "object",
- "additionalProperties": {
- "$ref": "#/components/schemas/Reference",
- "nullable": true
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/references/extractPublic": {
- "post": {
- "operationId": "reference_api-extract-public",
- "summary": "Extract references from a text",
- "tags": [
- "reference_api"
- ],
- "security": [
- {},
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "text",
- "sharingToken"
- ],
- "properties": {
- "text": {
- "type": "string",
- "description": "Text to extract from"
- },
- "sharingToken": {
- "type": "string",
- "description": "Token of the public share"
- },
- "resolve": {
- "type": "boolean",
- "default": false,
- "description": "Resolve the references"
- },
- "limit": {
- "type": "integer",
- "format": "int64",
- "default": 1,
- "description": "Maximum amount of references to extract, limited to 15"
- }
- }
- }
- }
- }
- },
- "parameters": [
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "References returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "references"
- ],
- "properties": {
- "references": {
- "type": "object",
- "additionalProperties": {
- "$ref": "#/components/schemas/Reference",
- "nullable": true
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/references/resolve": {
- "get": {
- "operationId": "reference_api-resolve-one",
- "summary": "Resolve a reference",
- "tags": [
- "reference_api"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "reference",
- "in": "query",
- "description": "Reference to resolve",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Reference returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "references"
- ],
- "properties": {
- "references": {
- "type": "object",
- "additionalProperties": {
- "$ref": "#/components/schemas/Reference",
- "nullable": true
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "post": {
- "operationId": "reference_api-resolve",
- "summary": "Resolve multiple references",
- "tags": [
- "reference_api"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "references"
- ],
- "properties": {
- "references": {
- "type": "array",
- "description": "References to resolve",
- "items": {
- "type": "string"
- }
- },
- "limit": {
- "type": "integer",
- "format": "int64",
- "default": 1,
- "description": "Maximum amount of references to resolve"
- }
- }
- }
- }
- }
- },
- "parameters": [
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "References returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "references"
- ],
- "properties": {
- "references": {
- "type": "object",
- "additionalProperties": {
- "$ref": "#/components/schemas/Reference",
- "nullable": true
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/references/resolvePublic": {
- "get": {
- "operationId": "reference_api-resolve-one-public",
- "summary": "Resolve from a public page",
- "tags": [
- "reference_api"
- ],
- "security": [
- {},
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "reference",
- "in": "query",
- "description": "Reference to resolve",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "sharingToken",
- "in": "query",
- "description": "Token of the public share",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Reference returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "references"
- ],
- "properties": {
- "references": {
- "type": "object",
- "additionalProperties": {
- "$ref": "#/components/schemas/Reference",
- "nullable": true
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "post": {
- "operationId": "reference_api-resolve-public",
- "summary": "Resolve multiple references from a public page",
- "tags": [
- "reference_api"
- ],
- "security": [
- {},
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "references",
- "sharingToken"
- ],
- "properties": {
- "references": {
- "type": "array",
- "description": "References to resolve",
- "items": {
- "type": "string"
- }
- },
- "sharingToken": {
- "type": "string",
- "description": "Token of the public share"
- },
- "limit": {
- "type": "integer",
- "format": "int64",
- "default": 1,
- "description": "Maximum amount of references to resolve, limited to 15"
- }
- }
- }
- }
- }
- },
- "parameters": [
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "References returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "references"
- ],
- "properties": {
- "references": {
- "type": "object",
- "additionalProperties": {
- "$ref": "#/components/schemas/Reference",
- "nullable": true
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/references/providers": {
- "get": {
- "operationId": "reference_api-get-providers-info",
- "summary": "Get the providers",
- "tags": [
- "reference_api"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Providers returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ReferenceProvider"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/references/provider/{providerId}": {
- "put": {
- "operationId": "reference_api-touch-provider",
- "summary": "Touch a provider",
- "tags": [
- "reference_api"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "timestamp": {
- "type": "integer",
- "format": "int64",
- "nullable": true,
- "description": "Timestamp of the last usage"
- }
- }
- }
- }
- }
- },
- "parameters": [
- {
- "name": "providerId",
- "in": "path",
- "description": "ID of the provider",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Provider touched",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "success"
- ],
- "properties": {
- "success": {
- "type": "boolean"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/taskprocessing/tasktypes": {
- "get": {
- "operationId": "task_processing_api-task-types",
- "summary": "Returns all available TaskProcessing task types",
- "tags": [
- "task_processing_api"
- ],
- "security": [
- {},
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Task types returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "types"
- ],
- "properties": {
- "types": {
- "type": "object",
- "additionalProperties": {
- "$ref": "#/components/schemas/TaskProcessingTaskType"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/taskprocessing/schedule": {
- "post": {
- "operationId": "task_processing_api-schedule",
- "summary": "Schedules a task",
- "tags": [
- "task_processing_api"
- ],
- "security": [
- {},
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "input",
- "type",
- "appId"
- ],
- "properties": {
- "input": {
- "type": "object",
- "description": "Task's input parameters",
- "additionalProperties": {
- "type": "object"
- }
- },
- "type": {
- "type": "string",
- "description": "Type of the task"
- },
- "appId": {
- "type": "string",
- "description": "ID of the app that will execute the task"
- },
- "customId": {
- "type": "string",
- "default": "",
- "description": "An arbitrary identifier for the task"
- },
- "webhookUri": {
- "type": "string",
- "nullable": true,
- "description": "URI to be requested when the task finishes"
- },
- "webhookMethod": {
- "type": "string",
- "nullable": true,
- "description": "Method used for the webhook request (HTTP:GET, HTTP:POST, HTTP:PUT, HTTP:DELETE or AppAPI:APP_ID:GET, AppAPI:APP_ID:POST...)"
- }
- }
- }
- }
- }
- },
- "parameters": [
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Task scheduled successfully",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "task"
- ],
- "properties": {
- "task": {
- "$ref": "#/components/schemas/TaskProcessingTask"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "500": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "400": {
- "description": "Scheduling task is not possible",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "412": {
- "description": "Scheduling task is not possible",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "401": {
- "description": "Cannot schedule task because it references files in its input that the user doesn't have access to",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/taskprocessing/task/{id}": {
- "get": {
- "operationId": "task_processing_api-get-task",
- "summary": "Gets a task including status and result",
- "description": "Tasks are removed 1 week after receiving their last update",
- "tags": [
- "task_processing_api"
- ],
- "security": [
- {},
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "id",
- "in": "path",
- "description": "The id of the task",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Task returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "task"
- ],
- "properties": {
- "task": {
- "$ref": "#/components/schemas/TaskProcessingTask"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "Task not found",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "500": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "delete": {
- "operationId": "task_processing_api-delete-task",
- "summary": "Deletes a task",
- "tags": [
- "task_processing_api"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "id",
- "in": "path",
- "description": "The id of the task",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Task deleted",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "nullable": true
- }
- }
- }
- }
- }
- }
- }
- },
- "500": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/taskprocessing/tasks/app/{appId}": {
- "get": {
- "operationId": "task_processing_api-list-tasks-by-app",
- "summary": "Returns tasks for the current user filtered by the appId and optional customId",
- "tags": [
- "task_processing_api"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "appId",
- "in": "path",
- "description": "ID of the app",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "customId",
- "in": "query",
- "description": "An arbitrary identifier for the task",
- "schema": {
- "type": "string",
- "nullable": true
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Tasks returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "tasks"
- ],
- "properties": {
- "tasks": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/TaskProcessingTask"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "500": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/taskprocessing/tasks": {
- "get": {
- "operationId": "task_processing_api-list-tasks",
- "summary": "Returns tasks for the current user filtered by the optional taskType and optional customId",
- "tags": [
- "task_processing_api"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "taskType",
- "in": "query",
- "description": "The task type to filter by",
- "schema": {
- "type": "string",
- "nullable": true
- }
- },
- {
- "name": "customId",
- "in": "query",
- "description": "An arbitrary identifier for the task",
- "schema": {
- "type": "string",
- "nullable": true
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Tasks returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "tasks"
- ],
- "properties": {
- "tasks": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/TaskProcessingTask"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "500": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/taskprocessing/tasks/{taskId}/file/{fileId}": {
- "get": {
- "operationId": "task_processing_api-get-file-contents",
- "summary": "Returns the contents of a file referenced in a task",
- "tags": [
- "task_processing_api"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "taskId",
- "in": "path",
- "description": "The id of the task",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
- },
- {
- "name": "fileId",
- "in": "path",
- "description": "The file id of the file to retrieve",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "File content returned",
- "content": {
- "*/*": {
- "schema": {
- "type": "string",
- "format": "binary"
- }
- }
- }
- },
- "500": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "Task or file not found",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/taskprocessing/tasks/{taskId}/cancel": {
- "post": {
- "operationId": "task_processing_api-cancel-task",
- "summary": "Cancels a task",
- "tags": [
- "task_processing_api"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "taskId",
- "in": "path",
- "description": "The id of the task",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Task canceled successfully",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "task"
- ],
- "properties": {
- "task": {
- "$ref": "#/components/schemas/TaskProcessingTask"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "500": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "Task not found",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/teams/{teamId}/resources": {
- "get": {
- "operationId": "teams_api-resolve-one",
- "summary": "Get all resources of a team",
- "tags": [
- "teams_api"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "teamId",
- "in": "path",
- "description": "Unique id of the team",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Resources returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "resources"
- ],
- "properties": {
- "resources": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/TeamResource"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/teams/resources/{providerId}/{resourceId}": {
- "get": {
- "operationId": "teams_api-list-teams",
- "summary": "Get all teams of a resource",
- "tags": [
- "teams_api"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "providerId",
- "in": "path",
- "description": "Identifier of the provider (e.g. deck, talk, collectives)",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "resourceId",
- "in": "path",
- "description": "Unique id of the resource to list teams for (e.g. deck board id)",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Teams returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "teams"
- ],
- "properties": {
- "teams": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Team"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/textprocessing/tasktypes": {
- "get": {
- "operationId": "text_processing_api-task-types",
- "summary": "This endpoint returns all available LanguageModel task types",
- "tags": [
- "text_processing_api"
- ],
- "security": [
- {},
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Task types returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "types"
- ],
- "properties": {
- "types": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "id",
- "name",
- "description"
- ],
- "properties": {
- "id": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "description": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/textprocessing/schedule": {
- "post": {
- "operationId": "text_processing_api-schedule",
- "summary": "This endpoint allows scheduling a language model task",
- "tags": [
- "text_processing_api"
- ],
- "security": [
- {},
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "input",
- "type",
- "appId"
- ],
- "properties": {
- "input": {
- "type": "string",
- "description": "Input text"
- },
- "type": {
- "type": "string",
- "description": "Type of the task"
- },
- "appId": {
- "type": "string",
- "description": "ID of the app that will execute the task"
- },
- "identifier": {
- "type": "string",
- "default": "",
- "description": "An arbitrary identifier for the task"
- }
- }
- }
- }
- }
- },
- "parameters": [
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Task scheduled successfully",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "task"
- ],
- "properties": {
- "task": {
- "$ref": "#/components/schemas/TextProcessingTask"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "500": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "400": {
- "description": "Scheduling task is not possible",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "412": {
- "description": "Scheduling task is not possible",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/textprocessing/task/{id}": {
- "get": {
- "operationId": "text_processing_api-get-task",
- "summary": "This endpoint allows checking the status and results of a task. Tasks are removed 1 week after receiving their last update.",
- "tags": [
- "text_processing_api"
- ],
- "security": [
- {},
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "id",
- "in": "path",
- "description": "The id of the task",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Task returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "task"
- ],
- "properties": {
- "task": {
- "$ref": "#/components/schemas/TextProcessingTask"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "Task not found",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "500": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "delete": {
- "operationId": "text_processing_api-delete-task",
- "summary": "This endpoint allows to delete a scheduled task for a user",
- "tags": [
- "text_processing_api"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "id",
- "in": "path",
- "description": "The id of the task",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Task returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "task"
- ],
- "properties": {
- "task": {
- "$ref": "#/components/schemas/TextProcessingTask"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "Task not found",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "500": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/textprocessing/tasks/app/{appId}": {
- "get": {
- "operationId": "text_processing_api-list-tasks-by-app",
- "summary": "This endpoint returns a list of tasks of a user that are related with a specific appId and optionally with an identifier",
- "tags": [
- "text_processing_api"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "appId",
- "in": "path",
- "description": "ID of the app",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "identifier",
- "in": "query",
- "description": "An arbitrary identifier for the task",
- "schema": {
- "type": "string",
- "nullable": true
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Task list returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "tasks"
- ],
- "properties": {
- "tasks": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/TextProcessingTask"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "500": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/text2image/is_available": {
- "get": {
- "operationId": "text_to_image_api-is-available",
- "summary": "Check whether this feature is available",
- "tags": [
- "text_to_image_api"
- ],
- "security": [
- {},
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Returns availability status",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "isAvailable"
- ],
- "properties": {
- "isAvailable": {
- "type": "boolean"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/text2image/schedule": {
- "post": {
- "operationId": "text_to_image_api-schedule",
- "summary": "This endpoint allows scheduling a text to image task",
- "tags": [
- "text_to_image_api"
- ],
- "security": [
- {},
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "input",
- "appId"
- ],
- "properties": {
- "input": {
- "type": "string",
- "description": "Input text"
- },
- "appId": {
- "type": "string",
- "description": "ID of the app that will execute the task"
- },
- "identifier": {
- "type": "string",
- "default": "",
- "description": "An arbitrary identifier for the task"
- },
- "numberOfImages": {
- "type": "integer",
- "format": "int64",
- "default": 8,
- "description": "The number of images to generate"
- }
- }
- }
- }
- }
- },
- "parameters": [
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Task scheduled successfully",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "task"
- ],
- "properties": {
- "task": {
- "$ref": "#/components/schemas/TextToImageTask"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "412": {
- "description": "Scheduling task is not possible",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "500": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/text2image/task/{id}": {
- "get": {
- "operationId": "text_to_image_api-get-task",
- "summary": "This endpoint allows checking the status and results of a task. Tasks are removed 1 week after receiving their last update.",
- "tags": [
- "text_to_image_api"
- ],
- "security": [
- {},
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "id",
- "in": "path",
- "description": "The id of the task",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Task returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "task"
- ],
- "properties": {
- "task": {
- "$ref": "#/components/schemas/TextToImageTask"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "Task not found",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "500": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "delete": {
- "operationId": "text_to_image_api-delete-task",
- "summary": "This endpoint allows to delete a scheduled task for a user",
- "tags": [
- "text_to_image_api"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "id",
- "in": "path",
- "description": "The id of the task",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Task returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "task"
- ],
- "properties": {
- "task": {
- "$ref": "#/components/schemas/TextToImageTask"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "Task not found",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "500": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/text2image/task/{id}/image/{index}": {
- "get": {
- "operationId": "text_to_image_api-get-image",
- "summary": "This endpoint allows downloading the resulting image of a task",
- "tags": [
- "text_to_image_api"
- ],
- "security": [
- {},
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "id",
- "in": "path",
- "description": "The id of the task",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
- },
- {
- "name": "index",
- "in": "path",
- "description": "The index of the image to retrieve",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Image returned",
- "content": {
- "*/*": {
- "schema": {
- "type": "string",
- "format": "binary"
- }
- }
- }
- },
- "404": {
- "description": "Task or image not found",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "500": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/text2image/tasks/app/{appId}": {
- "get": {
- "operationId": "text_to_image_api-list-tasks-by-app",
- "summary": "This endpoint returns a list of tasks of a user that are related with a specific appId and optionally with an identifier",
- "tags": [
- "text_to_image_api"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "appId",
- "in": "path",
- "description": "ID of the app",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "identifier",
- "in": "query",
- "description": "An arbitrary identifier for the task",
- "schema": {
- "type": "string",
- "nullable": true
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Task list returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "tasks"
- ],
- "properties": {
- "tasks": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/TextToImageTask"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "500": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/translation/languages": {
- "get": {
- "operationId": "translation_api-languages",
- "summary": "Get the list of supported languages",
- "tags": [
- "translation_api"
- ],
- "security": [
- {},
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Supported languages returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "languages",
- "languageDetection"
- ],
- "properties": {
- "languages": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "from",
- "fromLabel",
- "to",
- "toLabel"
- ],
- "properties": {
- "from": {
- "type": "string"
- },
- "fromLabel": {
- "type": "string"
- },
- "to": {
- "type": "string"
- },
- "toLabel": {
- "type": "string"
- }
- }
- }
- },
- "languageDetection": {
- "type": "boolean"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/translation/translate": {
- "post": {
- "operationId": "translation_api-translate",
- "summary": "Translate a text",
- "tags": [
- "translation_api"
- ],
- "security": [
- {},
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "text",
- "toLanguage"
- ],
- "properties": {
- "text": {
- "type": "string",
- "description": "Text to be translated"
- },
- "fromLanguage": {
- "type": "string",
- "nullable": true,
- "description": "Language to translate from"
- },
- "toLanguage": {
- "type": "string",
- "description": "Language to translate to"
- }
- }
- }
- }
- }
- },
- "parameters": [
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Translated text returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "text",
- "from"
- ],
- "properties": {
- "text": {
- "type": "string"
- },
- "from": {
- "type": "string",
- "nullable": true
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "400": {
- "description": "Language not detected or unable to translate",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- },
- "from": {
- "type": "string",
- "nullable": true
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "412": {
- "description": "Translating is not possible",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- },
- "from": {
- "type": "string",
- "nullable": true
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "500": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- },
- "from": {
- "type": "string",
- "nullable": true
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/search/providers": {
- "get": {
- "operationId": "unified_search-get-providers",
- "summary": "Get the providers for unified search",
- "tags": [
- "unified_search"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "from",
- "in": "query",
- "description": "the url the user is currently at",
- "schema": {
- "type": "string",
- "default": ""
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Providers returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/UnifiedSearchProvider"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/search/providers/{providerId}/search": {
- "get": {
- "operationId": "unified_search-search",
- "summary": "Launch a search for a specific search provider.",
- "description": "Additional filters are available for each provider. Send a request to /providers endpoint to list providers with their available filters.",
- "tags": [
- "unified_search"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "providerId",
- "in": "path",
- "description": "ID of the provider",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "term",
- "in": "query",
- "description": "Term to search",
- "schema": {
- "type": "string",
- "default": ""
- }
- },
- {
- "name": "sortOrder",
- "in": "query",
- "description": "Order of entries",
- "schema": {
- "type": "integer",
- "format": "int64",
- "nullable": true
- }
- },
- {
- "name": "limit",
- "in": "query",
- "description": "Maximum amount of entries, limited to 25",
- "schema": {
- "type": "integer",
- "format": "int64",
- "nullable": true
- }
- },
- {
- "name": "cursor",
- "in": "query",
- "description": "Offset for searching",
- "schema": {
- "nullable": true,
- "oneOf": [
- {
- "type": "integer",
- "format": "int64"
- },
- {
- "type": "string"
- }
- ]
- }
- },
- {
- "name": "from",
- "in": "query",
- "description": "The current user URL",
- "schema": {
- "type": "string",
- "default": ""
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Search entries returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "$ref": "#/components/schemas/UnifiedSearchResult"
- }
- }
- }
- }
- }
- }
- }
- },
- "400": {
- "description": "Searching is not possible",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/core/whatsnew": {
- "get": {
- "operationId": "whats_new-get",
- "summary": "Get the changes",
- "tags": [
- "whats_new"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Changes returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "changelogURL",
- "product",
- "version"
- ],
- "properties": {
- "changelogURL": {
- "type": "string"
- },
- "product": {
- "type": "string"
- },
- "version": {
- "type": "string"
- },
- "whatsNew": {
- "type": "object",
- "required": [
- "regular",
- "admin"
- ],
- "properties": {
- "regular": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "admin": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "204": {
- "description": "No changes"
- }
- }
- },
- "post": {
- "operationId": "whats_new-dismiss",
- "summary": "Dismiss the changes",
- "tags": [
- "whats_new"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "version"
- ],
- "properties": {
- "version": {
- "type": "string",
- "description": "Version to dismiss the changes for"
- }
- }
- }
- }
- }
- },
- "parameters": [
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Changes dismissed",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- },
- "500": {
- "description": "",
- "content": {
- "text/plain": {
- "schema": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "/index.php/avatar/{userId}/{size}/dark": {
- "get": {
- "operationId": "avatar-get-avatar-dark",
- "summary": "Get the dark avatar",
- "tags": [
- "avatar"
- ],
- "security": [
- {},
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "userId",
- "in": "path",
- "description": "ID of the user",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "size",
- "in": "path",
- "description": "Size of the avatar",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int64",
- "enum": [
- 64,
- 512
- ]
- }
- },
- {
- "name": "guestFallback",
- "in": "query",
- "description": "Fallback to guest avatar if not found",
- "schema": {
- "type": "integer",
- "default": 0,
- "enum": [
- 0,
- 1
- ]
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Avatar returned",
- "headers": {
- "X-NC-IsCustomAvatar": {
- "schema": {
- "type": "integer",
- "format": "int64"
- }
- }
- },
- "content": {
- "*/*": {
- "schema": {
- "type": "string",
- "format": "binary"
- }
- }
- }
- },
- "201": {
- "description": "Avatar returned",
- "headers": {
- "X-NC-IsCustomAvatar": {
- "schema": {
- "type": "integer",
- "format": "int64"
- }
- }
- },
- "content": {
- "*/*": {
- "schema": {
- "type": "string",
- "format": "binary"
- }
- }
- }
- },
- "404": {
- "description": "Avatar not found",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "500": {
- "description": ""
- }
- }
- }
- },
- "/index.php/avatar/{userId}/{size}": {
- "get": {
- "operationId": "avatar-get-avatar",
- "summary": "Get the avatar",
- "tags": [
- "avatar"
- ],
- "security": [
- {},
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "userId",
- "in": "path",
- "description": "ID of the user",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "size",
- "in": "path",
- "description": "Size of the avatar",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int64",
- "enum": [
- 64,
- 512
- ]
- }
- },
- {
- "name": "guestFallback",
- "in": "query",
- "description": "Fallback to guest avatar if not found",
- "schema": {
- "type": "integer",
- "default": 0,
- "enum": [
- 0,
- 1
- ]
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Avatar returned",
- "headers": {
- "X-NC-IsCustomAvatar": {
- "schema": {
- "type": "integer",
- "format": "int64"
- }
- }
- },
- "content": {
- "*/*": {
- "schema": {
- "type": "string",
- "format": "binary"
- }
- }
- }
- },
- "201": {
- "description": "Avatar returned",
- "headers": {
- "X-NC-IsCustomAvatar": {
- "schema": {
- "type": "integer",
- "format": "int64"
- }
- }
- },
- "content": {
- "*/*": {
- "schema": {
- "type": "string",
- "format": "binary"
- }
- }
- }
- },
- "404": {
- "description": "Avatar not found",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "500": {
- "description": ""
- }
- }
- }
- },
- "/index.php/csrftoken": {
- "get": {
- "operationId": "csrf_token-index",
- "summary": "Returns a new CSRF token.",
- "tags": [
- "csrf_token"
- ],
- "security": [
- {},
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "responses": {
- "200": {
- "description": "CSRF token returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "token"
- ],
- "properties": {
- "token": {
- "type": "string"
- }
- }
- }
- }
- }
- },
- "403": {
- "description": "Strict cookie check failed",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- }
- }
- }
- },
- "/index.php/login/v2/poll": {
- "post": {
- "operationId": "client_flow_login_v2-poll",
- "summary": "Poll the login flow credentials",
- "tags": [
- "client_flow_login_v2"
- ],
- "security": [
- {},
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "token"
- ],
- "properties": {
- "token": {
- "type": "string",
- "description": "Token of the flow"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Login flow credentials returned",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/LoginFlowV2Credentials"
- }
- }
- }
- },
- "404": {
- "description": "Login flow not found or completed",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- }
- }
- }
- },
- "/index.php/login/v2": {
- "post": {
- "operationId": "client_flow_login_v2-init",
- "summary": "Init a login flow",
- "tags": [
- "client_flow_login_v2"
- ],
- "security": [
- {},
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "responses": {
- "200": {
- "description": "Login flow init returned",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/LoginFlowV2"
- }
- }
- }
- }
- }
- }
- },
- "/index.php/avatar/guest/{guestName}/{size}": {
- "get": {
- "operationId": "guest_avatar-get-avatar",
- "summary": "Returns a guest avatar image response",
- "tags": [
- "guest_avatar"
- ],
- "security": [
- {},
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "guestName",
- "in": "path",
- "description": "The guest name, e.g. \"Albert\"",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "size",
- "in": "path",
- "description": "The desired avatar size, e.g. 64 for 64x64px",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int64",
- "enum": [
- 64,
- 512
- ]
- }
- },
- {
- "name": "darkTheme",
- "in": "query",
- "description": "Return dark avatar",
- "schema": {
- "type": "integer",
- "nullable": true,
- "default": 0,
- "enum": [
- 0,
- 1
- ]
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Custom avatar returned",
- "headers": {
- "X-NC-IsCustomAvatar": {
- "schema": {
- "type": "integer",
- "format": "int64"
- }
- }
- },
- "content": {
- "*/*": {
- "schema": {
- "type": "string",
- "format": "binary"
- }
- }
- }
- },
- "201": {
- "description": "Avatar returned",
- "headers": {
- "X-NC-IsCustomAvatar": {
- "schema": {
- "type": "integer",
- "format": "int64"
- }
- }
- },
- "content": {
- "*/*": {
- "schema": {
- "type": "string",
- "format": "binary"
- }
- }
- }
- },
- "500": {
- "description": ""
- }
- }
- }
- },
- "/index.php/avatar/guest/{guestName}/{size}/dark": {
- "get": {
- "operationId": "guest_avatar-get-avatar-dark",
- "summary": "Returns a dark guest avatar image response",
- "tags": [
- "guest_avatar"
- ],
- "security": [
- {},
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "guestName",
- "in": "path",
- "description": "The guest name, e.g. \"Albert\"",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "size",
- "in": "path",
- "description": "The desired avatar size, e.g. 64 for 64x64px",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int64",
- "enum": [
- 64,
- 512
- ]
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Custom avatar returned",
- "headers": {
- "X-NC-IsCustomAvatar": {
- "schema": {
- "type": "integer",
- "format": "int64"
- }
- }
- },
- "content": {
- "*/*": {
- "schema": {
- "type": "string",
- "format": "binary"
- }
- }
- }
- },
- "201": {
- "description": "Avatar returned",
- "headers": {
- "X-NC-IsCustomAvatar": {
- "schema": {
- "type": "integer",
- "format": "int64"
- }
- }
- },
- "content": {
- "*/*": {
- "schema": {
- "type": "string",
- "format": "binary"
- }
- }
- }
- },
- "500": {
- "description": ""
- }
- }
- }
- },
- "/index.php/login/confirm": {
- "post": {
- "operationId": "login-confirm-password",
- "summary": "Confirm the user password",
- "tags": [
- "login"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "password"
- ],
- "properties": {
- "password": {
- "type": "string",
- "description": "The password of the user"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Password confirmation succeeded",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "lastLogin"
- ],
- "properties": {
- "lastLogin": {
- "type": "integer",
- "format": "int64"
- }
- }
- }
- }
- }
- },
- "403": {
- "description": "Password confirmation failed",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- }
- }
- }
- },
- "/index.php/ocm-provider": {
- "get": {
- "operationId": "ocm-discovery",
- "summary": "generate a OCMProvider with local data and send it as DataResponse. This replaces the old PHP file ocm-provider/index.php",
- "tags": [
- "ocm"
- ],
- "security": [
- {},
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "responses": {
- "200": {
- "description": "OCM Provider details returned",
- "headers": {
- "X-NEXTCLOUD-OCM-PROVIDERS": {
- "schema": {
- "type": "boolean",
- "enum": [
- true
- ]
- }
- }
- },
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "enabled",
- "apiVersion",
- "endPoint",
- "resourceTypes"
- ],
- "properties": {
- "enabled": {
- "type": "boolean"
- },
- "apiVersion": {
- "type": "string"
- },
- "endPoint": {
- "type": "string"
- },
- "resourceTypes": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "name",
- "shareTypes",
- "protocols"
- ],
- "properties": {
- "name": {
- "type": "string"
- },
- "shareTypes": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "protocols": {
- "type": "object",
- "required": [
- "webdav"
- ],
- "properties": {
- "webdav": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "500": {
- "description": "OCM not supported",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/index.php/core/preview.png": {
- "get": {
- "operationId": "preview-get-preview",
- "summary": "Get a preview by file path",
- "tags": [
- "preview"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "file",
- "in": "query",
- "description": "Path of the file",
- "schema": {
- "type": "string",
- "default": ""
- }
- },
- {
- "name": "x",
- "in": "query",
- "description": "Width of the preview. A width of -1 will use the original image width.",
- "schema": {
- "type": "integer",
- "format": "int64",
- "default": 32
- }
- },
- {
- "name": "y",
- "in": "query",
- "description": "Height of the preview. A height of -1 will use the original image height.",
- "schema": {
- "type": "integer",
- "format": "int64",
- "default": 32
- }
- },
- {
- "name": "a",
- "in": "query",
- "description": "Preserve the aspect ratio",
- "schema": {
- "type": "integer",
- "default": 0,
- "enum": [
- 0,
- 1
- ]
- }
- },
- {
- "name": "forceIcon",
- "in": "query",
- "description": "Force returning an icon",
- "schema": {
- "type": "integer",
- "default": 1,
- "enum": [
- 0,
- 1
- ]
- }
- },
- {
- "name": "mode",
- "in": "query",
- "description": "How to crop the image",
- "schema": {
- "type": "string",
- "default": "fill",
- "enum": [
- "fill",
- "cover"
- ]
- }
- },
- {
- "name": "mimeFallback",
- "in": "query",
- "description": "Whether to fallback to the mime icon if no preview is available",
- "schema": {
- "type": "integer",
- "default": 0,
- "enum": [
- 0,
- 1
- ]
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Preview returned",
- "content": {
- "*/*": {
- "schema": {
- "type": "string",
- "format": "binary"
- }
- }
- }
- },
- "400": {
- "description": "Getting preview is not possible",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "403": {
- "description": "Getting preview is not allowed",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "404": {
- "description": "Preview not found",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "303": {
- "description": "Redirect to the mime icon url if mimeFallback is true",
- "headers": {
- "Location": {
- "schema": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "/index.php/core/preview": {
- "get": {
- "operationId": "preview-get-preview-by-file-id",
- "summary": "Get a preview by file ID",
- "tags": [
- "preview"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "fileId",
- "in": "query",
- "description": "ID of the file",
- "schema": {
- "type": "integer",
- "format": "int64",
- "default": -1
- }
- },
- {
- "name": "x",
- "in": "query",
- "description": "Width of the preview. A width of -1 will use the original image width.",
- "schema": {
- "type": "integer",
- "format": "int64",
- "default": 32
- }
- },
- {
- "name": "y",
- "in": "query",
- "description": "Height of the preview. A height of -1 will use the original image height.",
- "schema": {
- "type": "integer",
- "format": "int64",
- "default": 32
- }
- },
- {
- "name": "a",
- "in": "query",
- "description": "Preserve the aspect ratio",
- "schema": {
- "type": "integer",
- "default": 0,
- "enum": [
- 0,
- 1
- ]
- }
- },
- {
- "name": "forceIcon",
- "in": "query",
- "description": "Force returning an icon",
- "schema": {
- "type": "integer",
- "default": 1,
- "enum": [
- 0,
- 1
- ]
- }
- },
- {
- "name": "mode",
- "in": "query",
- "description": "How to crop the image",
- "schema": {
- "type": "string",
- "default": "fill",
- "enum": [
- "fill",
- "cover"
- ]
- }
- },
- {
- "name": "mimeFallback",
- "in": "query",
- "description": "Whether to fallback to the mime icon if no preview is available",
- "schema": {
- "type": "integer",
- "default": 0,
- "enum": [
- 0,
- 1
- ]
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Preview returned",
- "content": {
- "*/*": {
- "schema": {
- "type": "string",
- "format": "binary"
- }
- }
- }
- },
- "400": {
- "description": "Getting preview is not possible",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "403": {
- "description": "Getting preview is not allowed",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "404": {
- "description": "Preview not found",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "303": {
- "description": "Redirect to the mime icon url if mimeFallback is true",
- "headers": {
- "Location": {
- "schema": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "/index.php/core/references/preview/{referenceId}": {
- "get": {
- "operationId": "reference-preview",
- "summary": "Get a preview for a reference",
- "tags": [
- "reference"
- ],
- "security": [
- {},
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "referenceId",
- "in": "path",
- "description": "the reference cache key",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Preview returned",
- "content": {
- "*/*": {
- "schema": {
- "type": "string",
- "format": "binary"
- }
- }
- }
- },
- "404": {
- "description": "Reference not found",
- "content": {
- "application/json": {
- "schema": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "/index.php/core/wipe/check": {
- "post": {
- "operationId": "wipe-check-wipe",
- "summary": "Check if the device should be wiped",
- "tags": [
- "wipe"
- ],
- "security": [
- {},
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "token"
- ],
- "properties": {
- "token": {
- "type": "string",
- "description": "App password"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Device should be wiped",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "wipe"
- ],
- "properties": {
- "wipe": {
- "type": "boolean"
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "Device should not be wiped",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- }
- }
- }
- },
- "/index.php/core/wipe/success": {
- "post": {
- "operationId": "wipe-wipe-done",
- "summary": "Finish the wipe",
- "tags": [
- "wipe"
- ],
- "security": [
- {},
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "token"
- ],
- "properties": {
- "token": {
- "type": "string",
- "description": "App password"
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "Wipe finished successfully",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "404": {
- "description": "Device should not be wiped",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- }
- }
- }
- },
- "/status.php": {
- "get": {
- "operationId": "get-status",
- "responses": {
- "200": {
- "description": "Status returned",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Status"
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/taskprocessing/tasks_provider/{taskId}/file/{fileId}": {
- "get": {
- "operationId": "task_processing_api-get-file-contents-ex-app",
- "summary": "Returns the contents of a file referenced in a task(ExApp route version)",
- "description": "This endpoint requires admin access",
- "tags": [
- "task_processing_api"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "taskId",
- "in": "path",
- "description": "The id of the task",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
- },
- {
- "name": "fileId",
- "in": "path",
- "description": "The file id of the file to retrieve",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "File content returned",
- "content": {
- "*/*": {
- "schema": {
- "type": "string",
- "format": "binary"
- }
- }
- }
- },
- "500": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "Task or file not found",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/taskprocessing/tasks_provider/{taskId}/file": {
- "post": {
- "operationId": "task_processing_api-set-file-contents-ex-app",
- "summary": "Upload a file so it can be referenced in a task result (ExApp route version)",
- "description": "Use field 'file' for the file upload\nThis endpoint requires admin access",
- "tags": [
- "task_processing_api"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "taskId",
- "in": "path",
- "description": "The id of the task",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "201": {
- "description": "File created",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "fileId"
- ],
- "properties": {
- "fileId": {
- "type": "integer",
- "format": "int64"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "400": {
- "description": "File upload failed or no file was uploaded",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "500": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "Task not found",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/taskprocessing/tasks_provider/{taskId}/progress": {
- "post": {
- "operationId": "task_processing_api-set-progress",
- "summary": "Sets the task progress",
- "description": "This endpoint requires admin access",
- "tags": [
- "task_processing_api"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "progress"
- ],
- "properties": {
- "progress": {
- "type": "number",
- "format": "double",
- "description": "The progress"
- }
- }
- }
- }
- }
- },
- "parameters": [
- {
- "name": "taskId",
- "in": "path",
- "description": "The id of the task",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Progress updated successfully",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "task"
- ],
- "properties": {
- "task": {
- "$ref": "#/components/schemas/TaskProcessingTask"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "500": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "Task not found",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/taskprocessing/tasks_provider/{taskId}/result": {
- "post": {
- "operationId": "task_processing_api-set-result",
- "summary": "Sets the task result",
- "description": "This endpoint requires admin access",
- "tags": [
- "task_processing_api"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "output": {
- "type": "object",
- "nullable": true,
- "description": "The resulting task output, files are represented by their IDs",
- "additionalProperties": {
- "type": "object"
- }
- },
- "errorMessage": {
- "type": "string",
- "nullable": true,
- "description": "An error message if the task failed"
- }
- }
- }
- }
- }
- },
- "parameters": [
- {
- "name": "taskId",
- "in": "path",
- "description": "The id of the task",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Result updated successfully",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "task"
- ],
- "properties": {
- "task": {
- "$ref": "#/components/schemas/TaskProcessingTask"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "500": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "Task not found",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/taskprocessing/tasks_provider/next": {
- "get": {
- "operationId": "task_processing_api-get-next-scheduled-task",
- "summary": "Returns the next scheduled task for the taskTypeId",
- "description": "This endpoint requires admin access",
- "tags": [
- "task_processing_api"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "providerIds[]",
- "in": "query",
- "description": "The ids of the providers",
- "required": true,
- "schema": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- {
- "name": "taskTypeIds[]",
- "in": "query",
- "description": "The ids of the task types",
- "required": true,
- "schema": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Task returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "task",
- "provider"
- ],
- "properties": {
- "task": {
- "$ref": "#/components/schemas/TaskProcessingTask"
- },
- "provider": {
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "name": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "204": {
- "description": "No task found"
- },
- "500": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "tags": [
- {
- "name": "avatar",
- "description": "Class AvatarController"
- },
- {
- "name": "guest_avatar",
- "description": "This controller handles guest avatar requests."
- },
- {
- "name": "ocm",
- "description": "Controller about the endpoint /ocm-provider/"
- }
- ]
- }
|
