| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695 |
- {
- "openapi": "3.0.3",
- "info": {
- "title": "core",
- "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",
- "scheduledAt",
- "startedAt",
- "endedAt"
- ],
- "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
- },
- "scheduledAt": {
- "type": "integer",
- "format": "int64",
- "nullable": true
- },
- "startedAt": {
- "type": "integer",
- "format": "int64",
- "nullable": true
- },
- "endedAt": {
- "type": "integer",
- "format": "int64",
- "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"
- }
- }
- }
- }
- }
- }
- }
- },
- "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/"
- }
- ]
- }
|
