1
0

openapi.json 357 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413
  1. {
  2. "openapi": "3.0.3",
  3. "info": {
  4. "title": "core",
  5. "version": "0.0.1",
  6. "description": "Core functionality of Nextcloud",
  7. "license": {
  8. "name": "agpl"
  9. }
  10. },
  11. "components": {
  12. "securitySchemes": {
  13. "basic_auth": {
  14. "type": "http",
  15. "scheme": "basic"
  16. },
  17. "bearer_auth": {
  18. "type": "http",
  19. "scheme": "bearer"
  20. }
  21. },
  22. "schemas": {
  23. "AutocompleteResult": {
  24. "type": "object",
  25. "required": [
  26. "id",
  27. "label",
  28. "icon",
  29. "source",
  30. "status",
  31. "subline",
  32. "shareWithDisplayNameUnique"
  33. ],
  34. "properties": {
  35. "id": {
  36. "type": "string"
  37. },
  38. "label": {
  39. "type": "string"
  40. },
  41. "icon": {
  42. "type": "string"
  43. },
  44. "source": {
  45. "type": "string"
  46. },
  47. "status": {
  48. "oneOf": [
  49. {
  50. "type": "object",
  51. "required": [
  52. "status",
  53. "message",
  54. "icon",
  55. "clearAt"
  56. ],
  57. "properties": {
  58. "status": {
  59. "type": "string"
  60. },
  61. "message": {
  62. "type": "string",
  63. "nullable": true
  64. },
  65. "icon": {
  66. "type": "string",
  67. "nullable": true
  68. },
  69. "clearAt": {
  70. "type": "integer",
  71. "format": "int64",
  72. "nullable": true
  73. }
  74. }
  75. },
  76. {
  77. "type": "string"
  78. }
  79. ]
  80. },
  81. "subline": {
  82. "type": "string"
  83. },
  84. "shareWithDisplayNameUnique": {
  85. "type": "string"
  86. }
  87. }
  88. },
  89. "Capabilities": {
  90. "type": "object",
  91. "required": [
  92. "core"
  93. ],
  94. "properties": {
  95. "core": {
  96. "type": "object",
  97. "required": [
  98. "pollinterval",
  99. "webdav-root",
  100. "reference-api",
  101. "reference-regex",
  102. "mod-rewrite-working"
  103. ],
  104. "properties": {
  105. "pollinterval": {
  106. "type": "integer",
  107. "format": "int64"
  108. },
  109. "webdav-root": {
  110. "type": "string"
  111. },
  112. "reference-api": {
  113. "type": "boolean"
  114. },
  115. "reference-regex": {
  116. "type": "string"
  117. },
  118. "mod-rewrite-working": {
  119. "type": "boolean"
  120. }
  121. }
  122. }
  123. }
  124. },
  125. "Collection": {
  126. "type": "object",
  127. "required": [
  128. "id",
  129. "name",
  130. "resources"
  131. ],
  132. "properties": {
  133. "id": {
  134. "type": "integer",
  135. "format": "int64"
  136. },
  137. "name": {
  138. "type": "string"
  139. },
  140. "resources": {
  141. "type": "array",
  142. "items": {
  143. "$ref": "#/components/schemas/Resource"
  144. }
  145. }
  146. }
  147. },
  148. "ContactsAction": {
  149. "type": "object",
  150. "required": [
  151. "title",
  152. "icon",
  153. "hyperlink",
  154. "appId"
  155. ],
  156. "properties": {
  157. "title": {
  158. "type": "string"
  159. },
  160. "icon": {
  161. "type": "string"
  162. },
  163. "hyperlink": {
  164. "type": "string"
  165. },
  166. "appId": {
  167. "type": "string"
  168. }
  169. }
  170. },
  171. "LoginFlowV2": {
  172. "type": "object",
  173. "required": [
  174. "poll",
  175. "login"
  176. ],
  177. "properties": {
  178. "poll": {
  179. "type": "object",
  180. "required": [
  181. "token",
  182. "endpoint"
  183. ],
  184. "properties": {
  185. "token": {
  186. "type": "string"
  187. },
  188. "endpoint": {
  189. "type": "string"
  190. }
  191. }
  192. },
  193. "login": {
  194. "type": "string"
  195. }
  196. }
  197. },
  198. "LoginFlowV2Credentials": {
  199. "type": "object",
  200. "required": [
  201. "server",
  202. "loginName",
  203. "appPassword"
  204. ],
  205. "properties": {
  206. "server": {
  207. "type": "string"
  208. },
  209. "loginName": {
  210. "type": "string"
  211. },
  212. "appPassword": {
  213. "type": "string"
  214. }
  215. }
  216. },
  217. "NavigationEntry": {
  218. "type": "object",
  219. "required": [
  220. "id",
  221. "href",
  222. "icon",
  223. "type",
  224. "name",
  225. "active",
  226. "classes",
  227. "unread"
  228. ],
  229. "properties": {
  230. "id": {
  231. "type": "string"
  232. },
  233. "order": {
  234. "type": "integer",
  235. "format": "int64"
  236. },
  237. "href": {
  238. "type": "string"
  239. },
  240. "icon": {
  241. "type": "string"
  242. },
  243. "type": {
  244. "type": "string"
  245. },
  246. "name": {
  247. "type": "string"
  248. },
  249. "app": {
  250. "type": "string"
  251. },
  252. "default": {
  253. "type": "boolean"
  254. },
  255. "active": {
  256. "type": "boolean"
  257. },
  258. "classes": {
  259. "type": "string"
  260. },
  261. "unread": {
  262. "type": "integer",
  263. "format": "int64"
  264. }
  265. }
  266. },
  267. "OCSMeta": {
  268. "type": "object",
  269. "required": [
  270. "status",
  271. "statuscode"
  272. ],
  273. "properties": {
  274. "status": {
  275. "type": "string"
  276. },
  277. "statuscode": {
  278. "type": "integer"
  279. },
  280. "message": {
  281. "type": "string"
  282. },
  283. "totalitems": {
  284. "type": "string"
  285. },
  286. "itemsperpage": {
  287. "type": "string"
  288. }
  289. }
  290. },
  291. "OpenGraphObject": {
  292. "type": "object",
  293. "required": [
  294. "id",
  295. "name",
  296. "description",
  297. "thumb",
  298. "link"
  299. ],
  300. "properties": {
  301. "id": {
  302. "type": "string"
  303. },
  304. "name": {
  305. "type": "string"
  306. },
  307. "description": {
  308. "type": "string",
  309. "nullable": true
  310. },
  311. "thumb": {
  312. "type": "string",
  313. "nullable": true
  314. },
  315. "link": {
  316. "type": "string"
  317. }
  318. }
  319. },
  320. "PublicCapabilities": {
  321. "type": "object",
  322. "required": [
  323. "bruteforce"
  324. ],
  325. "properties": {
  326. "bruteforce": {
  327. "type": "object",
  328. "required": [
  329. "delay",
  330. "allow-listed"
  331. ],
  332. "properties": {
  333. "delay": {
  334. "type": "integer",
  335. "format": "int64"
  336. },
  337. "allow-listed": {
  338. "type": "boolean"
  339. }
  340. }
  341. }
  342. }
  343. },
  344. "Reference": {
  345. "type": "object",
  346. "required": [
  347. "richObjectType",
  348. "richObject",
  349. "openGraphObject",
  350. "accessible"
  351. ],
  352. "properties": {
  353. "richObjectType": {
  354. "type": "string"
  355. },
  356. "richObject": {
  357. "type": "object",
  358. "additionalProperties": {
  359. "type": "object",
  360. "nullable": true
  361. }
  362. },
  363. "openGraphObject": {
  364. "$ref": "#/components/schemas/OpenGraphObject"
  365. },
  366. "accessible": {
  367. "type": "boolean"
  368. }
  369. }
  370. },
  371. "ReferenceProvider": {
  372. "type": "object",
  373. "required": [
  374. "id",
  375. "title",
  376. "icon_url",
  377. "order",
  378. "search_providers_ids"
  379. ],
  380. "properties": {
  381. "id": {
  382. "type": "string"
  383. },
  384. "title": {
  385. "type": "string"
  386. },
  387. "icon_url": {
  388. "type": "string"
  389. },
  390. "order": {
  391. "type": "integer",
  392. "format": "int64"
  393. },
  394. "search_providers_ids": {
  395. "type": "array",
  396. "nullable": true,
  397. "items": {
  398. "type": "string"
  399. }
  400. }
  401. }
  402. },
  403. "Resource": {
  404. "type": "object",
  405. "required": [
  406. "richObjectType",
  407. "richObject",
  408. "openGraphObject",
  409. "accessible"
  410. ],
  411. "properties": {
  412. "richObjectType": {
  413. "type": "string"
  414. },
  415. "richObject": {
  416. "type": "object",
  417. "additionalProperties": {
  418. "type": "object",
  419. "nullable": true
  420. }
  421. },
  422. "openGraphObject": {
  423. "$ref": "#/components/schemas/OpenGraphObject"
  424. },
  425. "accessible": {
  426. "type": "boolean"
  427. }
  428. }
  429. },
  430. "Status": {
  431. "type": "object",
  432. "required": [
  433. "installed",
  434. "maintenance",
  435. "needsDbUpgrade",
  436. "version",
  437. "versionstring",
  438. "edition",
  439. "productname",
  440. "extendedSupport"
  441. ],
  442. "properties": {
  443. "installed": {
  444. "type": "boolean"
  445. },
  446. "maintenance": {
  447. "type": "boolean"
  448. },
  449. "needsDbUpgrade": {
  450. "type": "boolean"
  451. },
  452. "version": {
  453. "type": "string"
  454. },
  455. "versionstring": {
  456. "type": "string"
  457. },
  458. "edition": {
  459. "type": "string"
  460. },
  461. "productname": {
  462. "type": "string"
  463. },
  464. "extendedSupport": {
  465. "type": "boolean"
  466. }
  467. }
  468. },
  469. "TaskProcessingIO": {
  470. "type": "object",
  471. "additionalProperties": {
  472. "anyOf": [
  473. {
  474. "type": "number"
  475. },
  476. {
  477. "type": "array",
  478. "items": {
  479. "type": "number"
  480. }
  481. },
  482. {
  483. "type": "string"
  484. },
  485. {
  486. "type": "array",
  487. "items": {
  488. "type": "string"
  489. }
  490. }
  491. ]
  492. }
  493. },
  494. "TaskProcessingShape": {
  495. "type": "object",
  496. "required": [
  497. "name",
  498. "description",
  499. "type",
  500. "mandatory"
  501. ],
  502. "properties": {
  503. "name": {
  504. "type": "string"
  505. },
  506. "description": {
  507. "type": "string"
  508. },
  509. "type": {
  510. "type": "string",
  511. "enum": [
  512. "Number",
  513. "Text",
  514. "Audio",
  515. "Image",
  516. "Video",
  517. "File",
  518. "ListOfNumbers",
  519. "ListOfTexts",
  520. "ListOfImages",
  521. "ListOfAudios",
  522. "ListOfVideos",
  523. "ListOfFiles"
  524. ]
  525. },
  526. "mandatory": {
  527. "type": "boolean"
  528. }
  529. }
  530. },
  531. "TaskProcessingTask": {
  532. "type": "object",
  533. "required": [
  534. "id",
  535. "lastUpdated",
  536. "type",
  537. "status",
  538. "userId",
  539. "appId",
  540. "input",
  541. "output",
  542. "customId",
  543. "completionExpectedAt",
  544. "progress"
  545. ],
  546. "properties": {
  547. "id": {
  548. "type": "integer",
  549. "format": "int64"
  550. },
  551. "lastUpdated": {
  552. "type": "integer",
  553. "format": "int64"
  554. },
  555. "type": {
  556. "type": "string"
  557. },
  558. "status": {
  559. "type": "string",
  560. "enum": [
  561. "STATUS_CANCELLED",
  562. "STATUS_FAILED",
  563. "STATUS_SUCCESSFUL",
  564. "STATUS_RUNNING",
  565. "STATUS_SCHEDULED",
  566. "STATUS_UNKNOWN"
  567. ]
  568. },
  569. "userId": {
  570. "type": "string",
  571. "nullable": true
  572. },
  573. "appId": {
  574. "type": "string"
  575. },
  576. "input": {
  577. "$ref": "#/components/schemas/TaskProcessingIO"
  578. },
  579. "output": {
  580. "$ref": "#/components/schemas/TaskProcessingIO",
  581. "nullable": true
  582. },
  583. "customId": {
  584. "type": "string",
  585. "nullable": true
  586. },
  587. "completionExpectedAt": {
  588. "type": "integer",
  589. "format": "int64",
  590. "nullable": true
  591. },
  592. "progress": {
  593. "type": "number",
  594. "format": "double",
  595. "nullable": true
  596. }
  597. }
  598. },
  599. "TaskProcessingTaskType": {
  600. "type": "object",
  601. "required": [
  602. "name",
  603. "description",
  604. "inputShape",
  605. "outputShape"
  606. ],
  607. "properties": {
  608. "name": {
  609. "type": "string"
  610. },
  611. "description": {
  612. "type": "string"
  613. },
  614. "inputShape": {
  615. "type": "array",
  616. "items": {
  617. "$ref": "#/components/schemas/TaskProcessingShape"
  618. }
  619. },
  620. "outputShape": {
  621. "type": "array",
  622. "items": {
  623. "$ref": "#/components/schemas/TaskProcessingShape"
  624. }
  625. }
  626. }
  627. },
  628. "Team": {
  629. "type": "object",
  630. "required": [
  631. "id",
  632. "name",
  633. "icon"
  634. ],
  635. "properties": {
  636. "id": {
  637. "type": "string"
  638. },
  639. "name": {
  640. "type": "string"
  641. },
  642. "icon": {
  643. "type": "string"
  644. }
  645. }
  646. },
  647. "TeamResource": {
  648. "type": "object",
  649. "required": [
  650. "id",
  651. "label",
  652. "url",
  653. "iconSvg",
  654. "iconURL",
  655. "iconEmoji"
  656. ],
  657. "properties": {
  658. "id": {
  659. "type": "integer",
  660. "format": "int64"
  661. },
  662. "label": {
  663. "type": "string"
  664. },
  665. "url": {
  666. "type": "string"
  667. },
  668. "iconSvg": {
  669. "type": "string",
  670. "nullable": true
  671. },
  672. "iconURL": {
  673. "type": "string",
  674. "nullable": true
  675. },
  676. "iconEmoji": {
  677. "type": "string",
  678. "nullable": true
  679. }
  680. }
  681. },
  682. "TextProcessingTask": {
  683. "type": "object",
  684. "required": [
  685. "id",
  686. "type",
  687. "status",
  688. "userId",
  689. "appId",
  690. "input",
  691. "output",
  692. "identifier",
  693. "completionExpectedAt"
  694. ],
  695. "properties": {
  696. "id": {
  697. "type": "integer",
  698. "format": "int64",
  699. "nullable": true
  700. },
  701. "type": {
  702. "type": "string"
  703. },
  704. "status": {
  705. "type": "integer",
  706. "format": "int64",
  707. "enum": [
  708. 0,
  709. 1,
  710. 2,
  711. 3,
  712. 4
  713. ]
  714. },
  715. "userId": {
  716. "type": "string",
  717. "nullable": true
  718. },
  719. "appId": {
  720. "type": "string"
  721. },
  722. "input": {
  723. "type": "string"
  724. },
  725. "output": {
  726. "type": "string",
  727. "nullable": true
  728. },
  729. "identifier": {
  730. "type": "string"
  731. },
  732. "completionExpectedAt": {
  733. "type": "integer",
  734. "format": "int64",
  735. "nullable": true
  736. }
  737. }
  738. },
  739. "TextToImageTask": {
  740. "type": "object",
  741. "required": [
  742. "id",
  743. "status",
  744. "userId",
  745. "appId",
  746. "input",
  747. "identifier",
  748. "numberOfImages",
  749. "completionExpectedAt"
  750. ],
  751. "properties": {
  752. "id": {
  753. "type": "integer",
  754. "format": "int64",
  755. "nullable": true
  756. },
  757. "status": {
  758. "type": "integer",
  759. "format": "int64",
  760. "enum": [
  761. 0,
  762. 1,
  763. 2,
  764. 3,
  765. 4
  766. ]
  767. },
  768. "userId": {
  769. "type": "string",
  770. "nullable": true
  771. },
  772. "appId": {
  773. "type": "string"
  774. },
  775. "input": {
  776. "type": "string"
  777. },
  778. "identifier": {
  779. "type": "string",
  780. "nullable": true
  781. },
  782. "numberOfImages": {
  783. "type": "integer",
  784. "format": "int64"
  785. },
  786. "completionExpectedAt": {
  787. "type": "integer",
  788. "format": "int64",
  789. "nullable": true
  790. }
  791. }
  792. },
  793. "UnifiedSearchProvider": {
  794. "type": "object",
  795. "required": [
  796. "id",
  797. "appId",
  798. "name",
  799. "icon",
  800. "order",
  801. "triggers",
  802. "filters",
  803. "inAppSearch"
  804. ],
  805. "properties": {
  806. "id": {
  807. "type": "string"
  808. },
  809. "appId": {
  810. "type": "string"
  811. },
  812. "name": {
  813. "type": "string"
  814. },
  815. "icon": {
  816. "type": "string"
  817. },
  818. "order": {
  819. "type": "integer",
  820. "format": "int64"
  821. },
  822. "triggers": {
  823. "type": "array",
  824. "items": {
  825. "type": "string"
  826. }
  827. },
  828. "filters": {
  829. "type": "object",
  830. "additionalProperties": {
  831. "type": "string"
  832. }
  833. },
  834. "inAppSearch": {
  835. "type": "boolean"
  836. }
  837. }
  838. },
  839. "UnifiedSearchResult": {
  840. "type": "object",
  841. "required": [
  842. "name",
  843. "isPaginated",
  844. "entries",
  845. "cursor"
  846. ],
  847. "properties": {
  848. "name": {
  849. "type": "string"
  850. },
  851. "isPaginated": {
  852. "type": "boolean"
  853. },
  854. "entries": {
  855. "type": "array",
  856. "items": {
  857. "$ref": "#/components/schemas/UnifiedSearchResultEntry"
  858. }
  859. },
  860. "cursor": {
  861. "nullable": true,
  862. "oneOf": [
  863. {
  864. "type": "integer",
  865. "format": "int64"
  866. },
  867. {
  868. "type": "string"
  869. }
  870. ]
  871. }
  872. }
  873. },
  874. "UnifiedSearchResultEntry": {
  875. "type": "object",
  876. "required": [
  877. "thumbnailUrl",
  878. "title",
  879. "subline",
  880. "resourceUrl",
  881. "icon",
  882. "rounded",
  883. "attributes"
  884. ],
  885. "properties": {
  886. "thumbnailUrl": {
  887. "type": "string"
  888. },
  889. "title": {
  890. "type": "string"
  891. },
  892. "subline": {
  893. "type": "string"
  894. },
  895. "resourceUrl": {
  896. "type": "string"
  897. },
  898. "icon": {
  899. "type": "string"
  900. },
  901. "rounded": {
  902. "type": "boolean"
  903. },
  904. "attributes": {
  905. "type": "array",
  906. "items": {
  907. "type": "string"
  908. }
  909. }
  910. }
  911. }
  912. }
  913. },
  914. "paths": {
  915. "/ocs/v2.php/core/getapppassword": {
  916. "get": {
  917. "operationId": "app_password-get-app-password",
  918. "summary": "Create app password",
  919. "description": "This endpoint requires password confirmation",
  920. "tags": [
  921. "app_password"
  922. ],
  923. "security": [
  924. {
  925. "bearer_auth": []
  926. },
  927. {
  928. "basic_auth": []
  929. }
  930. ],
  931. "parameters": [
  932. {
  933. "name": "OCS-APIRequest",
  934. "in": "header",
  935. "description": "Required to be true for the API request to pass",
  936. "required": true,
  937. "schema": {
  938. "type": "boolean",
  939. "default": true
  940. }
  941. }
  942. ],
  943. "responses": {
  944. "200": {
  945. "description": "App password returned",
  946. "content": {
  947. "application/json": {
  948. "schema": {
  949. "type": "object",
  950. "required": [
  951. "ocs"
  952. ],
  953. "properties": {
  954. "ocs": {
  955. "type": "object",
  956. "required": [
  957. "meta",
  958. "data"
  959. ],
  960. "properties": {
  961. "meta": {
  962. "$ref": "#/components/schemas/OCSMeta"
  963. },
  964. "data": {
  965. "type": "object",
  966. "required": [
  967. "apppassword"
  968. ],
  969. "properties": {
  970. "apppassword": {
  971. "type": "string"
  972. }
  973. }
  974. }
  975. }
  976. }
  977. }
  978. }
  979. }
  980. }
  981. },
  982. "403": {
  983. "description": "Creating app password is not allowed",
  984. "content": {
  985. "application/json": {
  986. "schema": {
  987. "type": "object",
  988. "required": [
  989. "ocs"
  990. ],
  991. "properties": {
  992. "ocs": {
  993. "type": "object",
  994. "required": [
  995. "meta",
  996. "data"
  997. ],
  998. "properties": {
  999. "meta": {
  1000. "$ref": "#/components/schemas/OCSMeta"
  1001. },
  1002. "data": {}
  1003. }
  1004. }
  1005. }
  1006. }
  1007. }
  1008. }
  1009. }
  1010. }
  1011. }
  1012. },
  1013. "/ocs/v2.php/core/apppassword": {
  1014. "delete": {
  1015. "operationId": "app_password-delete-app-password",
  1016. "summary": "Delete app password",
  1017. "tags": [
  1018. "app_password"
  1019. ],
  1020. "security": [
  1021. {
  1022. "bearer_auth": []
  1023. },
  1024. {
  1025. "basic_auth": []
  1026. }
  1027. ],
  1028. "parameters": [
  1029. {
  1030. "name": "OCS-APIRequest",
  1031. "in": "header",
  1032. "description": "Required to be true for the API request to pass",
  1033. "required": true,
  1034. "schema": {
  1035. "type": "boolean",
  1036. "default": true
  1037. }
  1038. }
  1039. ],
  1040. "responses": {
  1041. "200": {
  1042. "description": "App password deleted successfully",
  1043. "content": {
  1044. "application/json": {
  1045. "schema": {
  1046. "type": "object",
  1047. "required": [
  1048. "ocs"
  1049. ],
  1050. "properties": {
  1051. "ocs": {
  1052. "type": "object",
  1053. "required": [
  1054. "meta",
  1055. "data"
  1056. ],
  1057. "properties": {
  1058. "meta": {
  1059. "$ref": "#/components/schemas/OCSMeta"
  1060. },
  1061. "data": {}
  1062. }
  1063. }
  1064. }
  1065. }
  1066. }
  1067. }
  1068. },
  1069. "403": {
  1070. "description": "Deleting app password is not allowed",
  1071. "content": {
  1072. "application/json": {
  1073. "schema": {
  1074. "type": "object",
  1075. "required": [
  1076. "ocs"
  1077. ],
  1078. "properties": {
  1079. "ocs": {
  1080. "type": "object",
  1081. "required": [
  1082. "meta",
  1083. "data"
  1084. ],
  1085. "properties": {
  1086. "meta": {
  1087. "$ref": "#/components/schemas/OCSMeta"
  1088. },
  1089. "data": {}
  1090. }
  1091. }
  1092. }
  1093. }
  1094. }
  1095. }
  1096. }
  1097. }
  1098. }
  1099. },
  1100. "/ocs/v2.php/core/apppassword/rotate": {
  1101. "post": {
  1102. "operationId": "app_password-rotate-app-password",
  1103. "summary": "Rotate app password",
  1104. "tags": [
  1105. "app_password"
  1106. ],
  1107. "security": [
  1108. {
  1109. "bearer_auth": []
  1110. },
  1111. {
  1112. "basic_auth": []
  1113. }
  1114. ],
  1115. "parameters": [
  1116. {
  1117. "name": "OCS-APIRequest",
  1118. "in": "header",
  1119. "description": "Required to be true for the API request to pass",
  1120. "required": true,
  1121. "schema": {
  1122. "type": "boolean",
  1123. "default": true
  1124. }
  1125. }
  1126. ],
  1127. "responses": {
  1128. "200": {
  1129. "description": "App password returned",
  1130. "content": {
  1131. "application/json": {
  1132. "schema": {
  1133. "type": "object",
  1134. "required": [
  1135. "ocs"
  1136. ],
  1137. "properties": {
  1138. "ocs": {
  1139. "type": "object",
  1140. "required": [
  1141. "meta",
  1142. "data"
  1143. ],
  1144. "properties": {
  1145. "meta": {
  1146. "$ref": "#/components/schemas/OCSMeta"
  1147. },
  1148. "data": {
  1149. "type": "object",
  1150. "required": [
  1151. "apppassword"
  1152. ],
  1153. "properties": {
  1154. "apppassword": {
  1155. "type": "string"
  1156. }
  1157. }
  1158. }
  1159. }
  1160. }
  1161. }
  1162. }
  1163. }
  1164. }
  1165. },
  1166. "403": {
  1167. "description": "Rotating app password is not allowed",
  1168. "content": {
  1169. "application/json": {
  1170. "schema": {
  1171. "type": "object",
  1172. "required": [
  1173. "ocs"
  1174. ],
  1175. "properties": {
  1176. "ocs": {
  1177. "type": "object",
  1178. "required": [
  1179. "meta",
  1180. "data"
  1181. ],
  1182. "properties": {
  1183. "meta": {
  1184. "$ref": "#/components/schemas/OCSMeta"
  1185. },
  1186. "data": {}
  1187. }
  1188. }
  1189. }
  1190. }
  1191. }
  1192. }
  1193. }
  1194. }
  1195. }
  1196. },
  1197. "/ocs/v2.php/core/apppassword/confirm": {
  1198. "put": {
  1199. "operationId": "app_password-confirm-user-password",
  1200. "summary": "Confirm the user password",
  1201. "tags": [
  1202. "app_password"
  1203. ],
  1204. "security": [
  1205. {
  1206. "bearer_auth": []
  1207. },
  1208. {
  1209. "basic_auth": []
  1210. }
  1211. ],
  1212. "parameters": [
  1213. {
  1214. "name": "password",
  1215. "in": "query",
  1216. "description": "The password of the user",
  1217. "required": true,
  1218. "schema": {
  1219. "type": "string"
  1220. }
  1221. },
  1222. {
  1223. "name": "OCS-APIRequest",
  1224. "in": "header",
  1225. "description": "Required to be true for the API request to pass",
  1226. "required": true,
  1227. "schema": {
  1228. "type": "boolean",
  1229. "default": true
  1230. }
  1231. }
  1232. ],
  1233. "responses": {
  1234. "200": {
  1235. "description": "Password confirmation succeeded",
  1236. "content": {
  1237. "application/json": {
  1238. "schema": {
  1239. "type": "object",
  1240. "required": [
  1241. "ocs"
  1242. ],
  1243. "properties": {
  1244. "ocs": {
  1245. "type": "object",
  1246. "required": [
  1247. "meta",
  1248. "data"
  1249. ],
  1250. "properties": {
  1251. "meta": {
  1252. "$ref": "#/components/schemas/OCSMeta"
  1253. },
  1254. "data": {
  1255. "type": "object",
  1256. "required": [
  1257. "lastLogin"
  1258. ],
  1259. "properties": {
  1260. "lastLogin": {
  1261. "type": "integer",
  1262. "format": "int64"
  1263. }
  1264. }
  1265. }
  1266. }
  1267. }
  1268. }
  1269. }
  1270. }
  1271. }
  1272. },
  1273. "403": {
  1274. "description": "Password confirmation failed",
  1275. "content": {
  1276. "application/json": {
  1277. "schema": {
  1278. "type": "object",
  1279. "required": [
  1280. "ocs"
  1281. ],
  1282. "properties": {
  1283. "ocs": {
  1284. "type": "object",
  1285. "required": [
  1286. "meta",
  1287. "data"
  1288. ],
  1289. "properties": {
  1290. "meta": {
  1291. "$ref": "#/components/schemas/OCSMeta"
  1292. },
  1293. "data": {}
  1294. }
  1295. }
  1296. }
  1297. }
  1298. }
  1299. }
  1300. }
  1301. }
  1302. }
  1303. },
  1304. "/ocs/v2.php/core/autocomplete/get": {
  1305. "get": {
  1306. "operationId": "auto_complete-get",
  1307. "summary": "Autocomplete a query",
  1308. "tags": [
  1309. "auto_complete"
  1310. ],
  1311. "security": [
  1312. {
  1313. "bearer_auth": []
  1314. },
  1315. {
  1316. "basic_auth": []
  1317. }
  1318. ],
  1319. "parameters": [
  1320. {
  1321. "name": "search",
  1322. "in": "query",
  1323. "description": "Text to search for",
  1324. "required": true,
  1325. "schema": {
  1326. "type": "string"
  1327. }
  1328. },
  1329. {
  1330. "name": "itemType",
  1331. "in": "query",
  1332. "description": "Type of the items to search for",
  1333. "schema": {
  1334. "type": "string",
  1335. "nullable": true
  1336. }
  1337. },
  1338. {
  1339. "name": "itemId",
  1340. "in": "query",
  1341. "description": "ID of the items to search for",
  1342. "schema": {
  1343. "type": "string",
  1344. "nullable": true
  1345. }
  1346. },
  1347. {
  1348. "name": "sorter",
  1349. "in": "query",
  1350. "description": "can be piped, top prio first, e.g.: \"commenters|share-recipients\"",
  1351. "schema": {
  1352. "type": "string",
  1353. "nullable": true
  1354. }
  1355. },
  1356. {
  1357. "name": "shareTypes[]",
  1358. "in": "query",
  1359. "description": "Types of shares to search for",
  1360. "schema": {
  1361. "type": "array",
  1362. "default": [],
  1363. "items": {
  1364. "type": "integer",
  1365. "format": "int64"
  1366. }
  1367. }
  1368. },
  1369. {
  1370. "name": "limit",
  1371. "in": "query",
  1372. "description": "Maximum number of results to return",
  1373. "schema": {
  1374. "type": "integer",
  1375. "format": "int64",
  1376. "default": 10
  1377. }
  1378. },
  1379. {
  1380. "name": "OCS-APIRequest",
  1381. "in": "header",
  1382. "description": "Required to be true for the API request to pass",
  1383. "required": true,
  1384. "schema": {
  1385. "type": "boolean",
  1386. "default": true
  1387. }
  1388. }
  1389. ],
  1390. "responses": {
  1391. "200": {
  1392. "description": "Autocomplete results returned",
  1393. "content": {
  1394. "application/json": {
  1395. "schema": {
  1396. "type": "object",
  1397. "required": [
  1398. "ocs"
  1399. ],
  1400. "properties": {
  1401. "ocs": {
  1402. "type": "object",
  1403. "required": [
  1404. "meta",
  1405. "data"
  1406. ],
  1407. "properties": {
  1408. "meta": {
  1409. "$ref": "#/components/schemas/OCSMeta"
  1410. },
  1411. "data": {
  1412. "type": "array",
  1413. "items": {
  1414. "$ref": "#/components/schemas/AutocompleteResult"
  1415. }
  1416. }
  1417. }
  1418. }
  1419. }
  1420. }
  1421. }
  1422. }
  1423. }
  1424. }
  1425. }
  1426. },
  1427. "/ocs/v2.php/collaboration/resources/collections/{collectionId}": {
  1428. "get": {
  1429. "operationId": "collaboration_resources-list-collection",
  1430. "summary": "Get a collection",
  1431. "tags": [
  1432. "collaboration_resources"
  1433. ],
  1434. "security": [
  1435. {
  1436. "bearer_auth": []
  1437. },
  1438. {
  1439. "basic_auth": []
  1440. }
  1441. ],
  1442. "parameters": [
  1443. {
  1444. "name": "collectionId",
  1445. "in": "path",
  1446. "description": "ID of the collection",
  1447. "required": true,
  1448. "schema": {
  1449. "type": "integer",
  1450. "format": "int64"
  1451. }
  1452. },
  1453. {
  1454. "name": "OCS-APIRequest",
  1455. "in": "header",
  1456. "description": "Required to be true for the API request to pass",
  1457. "required": true,
  1458. "schema": {
  1459. "type": "boolean",
  1460. "default": true
  1461. }
  1462. }
  1463. ],
  1464. "responses": {
  1465. "200": {
  1466. "description": "Collection returned",
  1467. "content": {
  1468. "application/json": {
  1469. "schema": {
  1470. "type": "object",
  1471. "required": [
  1472. "ocs"
  1473. ],
  1474. "properties": {
  1475. "ocs": {
  1476. "type": "object",
  1477. "required": [
  1478. "meta",
  1479. "data"
  1480. ],
  1481. "properties": {
  1482. "meta": {
  1483. "$ref": "#/components/schemas/OCSMeta"
  1484. },
  1485. "data": {
  1486. "$ref": "#/components/schemas/Collection"
  1487. }
  1488. }
  1489. }
  1490. }
  1491. }
  1492. }
  1493. }
  1494. },
  1495. "404": {
  1496. "description": "Collection not found",
  1497. "content": {
  1498. "application/json": {
  1499. "schema": {
  1500. "type": "object",
  1501. "required": [
  1502. "ocs"
  1503. ],
  1504. "properties": {
  1505. "ocs": {
  1506. "type": "object",
  1507. "required": [
  1508. "meta",
  1509. "data"
  1510. ],
  1511. "properties": {
  1512. "meta": {
  1513. "$ref": "#/components/schemas/OCSMeta"
  1514. },
  1515. "data": {}
  1516. }
  1517. }
  1518. }
  1519. }
  1520. }
  1521. }
  1522. },
  1523. "500": {
  1524. "description": "",
  1525. "content": {
  1526. "application/json": {
  1527. "schema": {
  1528. "type": "object",
  1529. "required": [
  1530. "ocs"
  1531. ],
  1532. "properties": {
  1533. "ocs": {
  1534. "type": "object",
  1535. "required": [
  1536. "meta",
  1537. "data"
  1538. ],
  1539. "properties": {
  1540. "meta": {
  1541. "$ref": "#/components/schemas/OCSMeta"
  1542. },
  1543. "data": {}
  1544. }
  1545. }
  1546. }
  1547. }
  1548. }
  1549. }
  1550. }
  1551. }
  1552. },
  1553. "post": {
  1554. "operationId": "collaboration_resources-add-resource",
  1555. "summary": "Add a resource to a collection",
  1556. "tags": [
  1557. "collaboration_resources"
  1558. ],
  1559. "security": [
  1560. {
  1561. "bearer_auth": []
  1562. },
  1563. {
  1564. "basic_auth": []
  1565. }
  1566. ],
  1567. "parameters": [
  1568. {
  1569. "name": "resourceType",
  1570. "in": "query",
  1571. "description": "Name of the resource",
  1572. "required": true,
  1573. "schema": {
  1574. "type": "string"
  1575. }
  1576. },
  1577. {
  1578. "name": "resourceId",
  1579. "in": "query",
  1580. "description": "ID of the resource",
  1581. "required": true,
  1582. "schema": {
  1583. "type": "string"
  1584. }
  1585. },
  1586. {
  1587. "name": "collectionId",
  1588. "in": "path",
  1589. "description": "ID of the collection",
  1590. "required": true,
  1591. "schema": {
  1592. "type": "integer",
  1593. "format": "int64"
  1594. }
  1595. },
  1596. {
  1597. "name": "OCS-APIRequest",
  1598. "in": "header",
  1599. "description": "Required to be true for the API request to pass",
  1600. "required": true,
  1601. "schema": {
  1602. "type": "boolean",
  1603. "default": true
  1604. }
  1605. }
  1606. ],
  1607. "responses": {
  1608. "200": {
  1609. "description": "Collection returned",
  1610. "content": {
  1611. "application/json": {
  1612. "schema": {
  1613. "type": "object",
  1614. "required": [
  1615. "ocs"
  1616. ],
  1617. "properties": {
  1618. "ocs": {
  1619. "type": "object",
  1620. "required": [
  1621. "meta",
  1622. "data"
  1623. ],
  1624. "properties": {
  1625. "meta": {
  1626. "$ref": "#/components/schemas/OCSMeta"
  1627. },
  1628. "data": {
  1629. "$ref": "#/components/schemas/Collection"
  1630. }
  1631. }
  1632. }
  1633. }
  1634. }
  1635. }
  1636. }
  1637. },
  1638. "404": {
  1639. "description": "Collection not found or resource inaccessible",
  1640. "content": {
  1641. "application/json": {
  1642. "schema": {
  1643. "type": "object",
  1644. "required": [
  1645. "ocs"
  1646. ],
  1647. "properties": {
  1648. "ocs": {
  1649. "type": "object",
  1650. "required": [
  1651. "meta",
  1652. "data"
  1653. ],
  1654. "properties": {
  1655. "meta": {
  1656. "$ref": "#/components/schemas/OCSMeta"
  1657. },
  1658. "data": {}
  1659. }
  1660. }
  1661. }
  1662. }
  1663. }
  1664. }
  1665. },
  1666. "500": {
  1667. "description": "",
  1668. "content": {
  1669. "application/json": {
  1670. "schema": {
  1671. "type": "object",
  1672. "required": [
  1673. "ocs"
  1674. ],
  1675. "properties": {
  1676. "ocs": {
  1677. "type": "object",
  1678. "required": [
  1679. "meta",
  1680. "data"
  1681. ],
  1682. "properties": {
  1683. "meta": {
  1684. "$ref": "#/components/schemas/OCSMeta"
  1685. },
  1686. "data": {}
  1687. }
  1688. }
  1689. }
  1690. }
  1691. }
  1692. }
  1693. }
  1694. }
  1695. },
  1696. "delete": {
  1697. "operationId": "collaboration_resources-remove-resource",
  1698. "summary": "Remove a resource from a collection",
  1699. "tags": [
  1700. "collaboration_resources"
  1701. ],
  1702. "security": [
  1703. {
  1704. "bearer_auth": []
  1705. },
  1706. {
  1707. "basic_auth": []
  1708. }
  1709. ],
  1710. "parameters": [
  1711. {
  1712. "name": "resourceType",
  1713. "in": "query",
  1714. "description": "Name of the resource",
  1715. "required": true,
  1716. "schema": {
  1717. "type": "string"
  1718. }
  1719. },
  1720. {
  1721. "name": "resourceId",
  1722. "in": "query",
  1723. "description": "ID of the resource",
  1724. "required": true,
  1725. "schema": {
  1726. "type": "string"
  1727. }
  1728. },
  1729. {
  1730. "name": "collectionId",
  1731. "in": "path",
  1732. "description": "ID of the collection",
  1733. "required": true,
  1734. "schema": {
  1735. "type": "integer",
  1736. "format": "int64"
  1737. }
  1738. },
  1739. {
  1740. "name": "OCS-APIRequest",
  1741. "in": "header",
  1742. "description": "Required to be true for the API request to pass",
  1743. "required": true,
  1744. "schema": {
  1745. "type": "boolean",
  1746. "default": true
  1747. }
  1748. }
  1749. ],
  1750. "responses": {
  1751. "200": {
  1752. "description": "Collection returned",
  1753. "content": {
  1754. "application/json": {
  1755. "schema": {
  1756. "type": "object",
  1757. "required": [
  1758. "ocs"
  1759. ],
  1760. "properties": {
  1761. "ocs": {
  1762. "type": "object",
  1763. "required": [
  1764. "meta",
  1765. "data"
  1766. ],
  1767. "properties": {
  1768. "meta": {
  1769. "$ref": "#/components/schemas/OCSMeta"
  1770. },
  1771. "data": {
  1772. "$ref": "#/components/schemas/Collection"
  1773. }
  1774. }
  1775. }
  1776. }
  1777. }
  1778. }
  1779. }
  1780. },
  1781. "404": {
  1782. "description": "Collection or resource not found",
  1783. "content": {
  1784. "application/json": {
  1785. "schema": {
  1786. "type": "object",
  1787. "required": [
  1788. "ocs"
  1789. ],
  1790. "properties": {
  1791. "ocs": {
  1792. "type": "object",
  1793. "required": [
  1794. "meta",
  1795. "data"
  1796. ],
  1797. "properties": {
  1798. "meta": {
  1799. "$ref": "#/components/schemas/OCSMeta"
  1800. },
  1801. "data": {}
  1802. }
  1803. }
  1804. }
  1805. }
  1806. }
  1807. }
  1808. },
  1809. "500": {
  1810. "description": "",
  1811. "content": {
  1812. "application/json": {
  1813. "schema": {
  1814. "type": "object",
  1815. "required": [
  1816. "ocs"
  1817. ],
  1818. "properties": {
  1819. "ocs": {
  1820. "type": "object",
  1821. "required": [
  1822. "meta",
  1823. "data"
  1824. ],
  1825. "properties": {
  1826. "meta": {
  1827. "$ref": "#/components/schemas/OCSMeta"
  1828. },
  1829. "data": {}
  1830. }
  1831. }
  1832. }
  1833. }
  1834. }
  1835. }
  1836. }
  1837. }
  1838. },
  1839. "put": {
  1840. "operationId": "collaboration_resources-rename-collection",
  1841. "summary": "Rename a collection",
  1842. "tags": [
  1843. "collaboration_resources"
  1844. ],
  1845. "security": [
  1846. {
  1847. "bearer_auth": []
  1848. },
  1849. {
  1850. "basic_auth": []
  1851. }
  1852. ],
  1853. "parameters": [
  1854. {
  1855. "name": "collectionName",
  1856. "in": "query",
  1857. "description": "New name",
  1858. "required": true,
  1859. "schema": {
  1860. "type": "string"
  1861. }
  1862. },
  1863. {
  1864. "name": "collectionId",
  1865. "in": "path",
  1866. "description": "ID of the collection",
  1867. "required": true,
  1868. "schema": {
  1869. "type": "integer",
  1870. "format": "int64"
  1871. }
  1872. },
  1873. {
  1874. "name": "OCS-APIRequest",
  1875. "in": "header",
  1876. "description": "Required to be true for the API request to pass",
  1877. "required": true,
  1878. "schema": {
  1879. "type": "boolean",
  1880. "default": true
  1881. }
  1882. }
  1883. ],
  1884. "responses": {
  1885. "200": {
  1886. "description": "Collection returned",
  1887. "content": {
  1888. "application/json": {
  1889. "schema": {
  1890. "type": "object",
  1891. "required": [
  1892. "ocs"
  1893. ],
  1894. "properties": {
  1895. "ocs": {
  1896. "type": "object",
  1897. "required": [
  1898. "meta",
  1899. "data"
  1900. ],
  1901. "properties": {
  1902. "meta": {
  1903. "$ref": "#/components/schemas/OCSMeta"
  1904. },
  1905. "data": {
  1906. "$ref": "#/components/schemas/Collection"
  1907. }
  1908. }
  1909. }
  1910. }
  1911. }
  1912. }
  1913. }
  1914. },
  1915. "404": {
  1916. "description": "Collection not found",
  1917. "content": {
  1918. "application/json": {
  1919. "schema": {
  1920. "type": "object",
  1921. "required": [
  1922. "ocs"
  1923. ],
  1924. "properties": {
  1925. "ocs": {
  1926. "type": "object",
  1927. "required": [
  1928. "meta",
  1929. "data"
  1930. ],
  1931. "properties": {
  1932. "meta": {
  1933. "$ref": "#/components/schemas/OCSMeta"
  1934. },
  1935. "data": {}
  1936. }
  1937. }
  1938. }
  1939. }
  1940. }
  1941. }
  1942. },
  1943. "500": {
  1944. "description": "",
  1945. "content": {
  1946. "application/json": {
  1947. "schema": {
  1948. "type": "object",
  1949. "required": [
  1950. "ocs"
  1951. ],
  1952. "properties": {
  1953. "ocs": {
  1954. "type": "object",
  1955. "required": [
  1956. "meta",
  1957. "data"
  1958. ],
  1959. "properties": {
  1960. "meta": {
  1961. "$ref": "#/components/schemas/OCSMeta"
  1962. },
  1963. "data": {}
  1964. }
  1965. }
  1966. }
  1967. }
  1968. }
  1969. }
  1970. }
  1971. }
  1972. }
  1973. },
  1974. "/ocs/v2.php/collaboration/resources/collections/search/{filter}": {
  1975. "get": {
  1976. "operationId": "collaboration_resources-search-collections",
  1977. "summary": "Search for collections",
  1978. "tags": [
  1979. "collaboration_resources"
  1980. ],
  1981. "security": [
  1982. {
  1983. "bearer_auth": []
  1984. },
  1985. {
  1986. "basic_auth": []
  1987. }
  1988. ],
  1989. "parameters": [
  1990. {
  1991. "name": "filter",
  1992. "in": "path",
  1993. "description": "Filter collections",
  1994. "required": true,
  1995. "schema": {
  1996. "type": "string"
  1997. }
  1998. },
  1999. {
  2000. "name": "OCS-APIRequest",
  2001. "in": "header",
  2002. "description": "Required to be true for the API request to pass",
  2003. "required": true,
  2004. "schema": {
  2005. "type": "boolean",
  2006. "default": true
  2007. }
  2008. }
  2009. ],
  2010. "responses": {
  2011. "200": {
  2012. "description": "Collections returned",
  2013. "content": {
  2014. "application/json": {
  2015. "schema": {
  2016. "type": "object",
  2017. "required": [
  2018. "ocs"
  2019. ],
  2020. "properties": {
  2021. "ocs": {
  2022. "type": "object",
  2023. "required": [
  2024. "meta",
  2025. "data"
  2026. ],
  2027. "properties": {
  2028. "meta": {
  2029. "$ref": "#/components/schemas/OCSMeta"
  2030. },
  2031. "data": {
  2032. "type": "array",
  2033. "items": {
  2034. "$ref": "#/components/schemas/Collection"
  2035. }
  2036. }
  2037. }
  2038. }
  2039. }
  2040. }
  2041. }
  2042. }
  2043. },
  2044. "404": {
  2045. "description": "Collection not found",
  2046. "content": {
  2047. "application/json": {
  2048. "schema": {
  2049. "type": "object",
  2050. "required": [
  2051. "ocs"
  2052. ],
  2053. "properties": {
  2054. "ocs": {
  2055. "type": "object",
  2056. "required": [
  2057. "meta",
  2058. "data"
  2059. ],
  2060. "properties": {
  2061. "meta": {
  2062. "$ref": "#/components/schemas/OCSMeta"
  2063. },
  2064. "data": {}
  2065. }
  2066. }
  2067. }
  2068. }
  2069. }
  2070. }
  2071. }
  2072. }
  2073. }
  2074. },
  2075. "/ocs/v2.php/collaboration/resources/{resourceType}/{resourceId}": {
  2076. "get": {
  2077. "operationId": "collaboration_resources-get-collections-by-resource",
  2078. "summary": "Get collections by resource",
  2079. "tags": [
  2080. "collaboration_resources"
  2081. ],
  2082. "security": [
  2083. {
  2084. "bearer_auth": []
  2085. },
  2086. {
  2087. "basic_auth": []
  2088. }
  2089. ],
  2090. "parameters": [
  2091. {
  2092. "name": "resourceType",
  2093. "in": "path",
  2094. "description": "Type of the resource",
  2095. "required": true,
  2096. "schema": {
  2097. "type": "string"
  2098. }
  2099. },
  2100. {
  2101. "name": "resourceId",
  2102. "in": "path",
  2103. "description": "ID of the resource",
  2104. "required": true,
  2105. "schema": {
  2106. "type": "string"
  2107. }
  2108. },
  2109. {
  2110. "name": "OCS-APIRequest",
  2111. "in": "header",
  2112. "description": "Required to be true for the API request to pass",
  2113. "required": true,
  2114. "schema": {
  2115. "type": "boolean",
  2116. "default": true
  2117. }
  2118. }
  2119. ],
  2120. "responses": {
  2121. "200": {
  2122. "description": "Collections returned",
  2123. "content": {
  2124. "application/json": {
  2125. "schema": {
  2126. "type": "object",
  2127. "required": [
  2128. "ocs"
  2129. ],
  2130. "properties": {
  2131. "ocs": {
  2132. "type": "object",
  2133. "required": [
  2134. "meta",
  2135. "data"
  2136. ],
  2137. "properties": {
  2138. "meta": {
  2139. "$ref": "#/components/schemas/OCSMeta"
  2140. },
  2141. "data": {
  2142. "type": "array",
  2143. "items": {
  2144. "$ref": "#/components/schemas/Collection"
  2145. }
  2146. }
  2147. }
  2148. }
  2149. }
  2150. }
  2151. }
  2152. }
  2153. },
  2154. "404": {
  2155. "description": "Resource not accessible",
  2156. "content": {
  2157. "application/json": {
  2158. "schema": {
  2159. "type": "object",
  2160. "required": [
  2161. "ocs"
  2162. ],
  2163. "properties": {
  2164. "ocs": {
  2165. "type": "object",
  2166. "required": [
  2167. "meta",
  2168. "data"
  2169. ],
  2170. "properties": {
  2171. "meta": {
  2172. "$ref": "#/components/schemas/OCSMeta"
  2173. },
  2174. "data": {}
  2175. }
  2176. }
  2177. }
  2178. }
  2179. }
  2180. }
  2181. }
  2182. }
  2183. }
  2184. },
  2185. "/ocs/v2.php/collaboration/resources/{baseResourceType}/{baseResourceId}": {
  2186. "post": {
  2187. "operationId": "collaboration_resources-create-collection-on-resource",
  2188. "summary": "Create a collection for a resource",
  2189. "tags": [
  2190. "collaboration_resources"
  2191. ],
  2192. "security": [
  2193. {
  2194. "bearer_auth": []
  2195. },
  2196. {
  2197. "basic_auth": []
  2198. }
  2199. ],
  2200. "parameters": [
  2201. {
  2202. "name": "name",
  2203. "in": "query",
  2204. "description": "Name of the collection",
  2205. "required": true,
  2206. "schema": {
  2207. "type": "string"
  2208. }
  2209. },
  2210. {
  2211. "name": "baseResourceType",
  2212. "in": "path",
  2213. "description": "Type of the base resource",
  2214. "required": true,
  2215. "schema": {
  2216. "type": "string"
  2217. }
  2218. },
  2219. {
  2220. "name": "baseResourceId",
  2221. "in": "path",
  2222. "description": "ID of the base resource",
  2223. "required": true,
  2224. "schema": {
  2225. "type": "string"
  2226. }
  2227. },
  2228. {
  2229. "name": "OCS-APIRequest",
  2230. "in": "header",
  2231. "description": "Required to be true for the API request to pass",
  2232. "required": true,
  2233. "schema": {
  2234. "type": "boolean",
  2235. "default": true
  2236. }
  2237. }
  2238. ],
  2239. "responses": {
  2240. "200": {
  2241. "description": "Collection returned",
  2242. "content": {
  2243. "application/json": {
  2244. "schema": {
  2245. "type": "object",
  2246. "required": [
  2247. "ocs"
  2248. ],
  2249. "properties": {
  2250. "ocs": {
  2251. "type": "object",
  2252. "required": [
  2253. "meta",
  2254. "data"
  2255. ],
  2256. "properties": {
  2257. "meta": {
  2258. "$ref": "#/components/schemas/OCSMeta"
  2259. },
  2260. "data": {
  2261. "$ref": "#/components/schemas/Collection"
  2262. }
  2263. }
  2264. }
  2265. }
  2266. }
  2267. }
  2268. }
  2269. },
  2270. "400": {
  2271. "description": "Creating collection is not possible",
  2272. "content": {
  2273. "application/json": {
  2274. "schema": {
  2275. "type": "object",
  2276. "required": [
  2277. "ocs"
  2278. ],
  2279. "properties": {
  2280. "ocs": {
  2281. "type": "object",
  2282. "required": [
  2283. "meta",
  2284. "data"
  2285. ],
  2286. "properties": {
  2287. "meta": {
  2288. "$ref": "#/components/schemas/OCSMeta"
  2289. },
  2290. "data": {}
  2291. }
  2292. }
  2293. }
  2294. }
  2295. }
  2296. }
  2297. },
  2298. "404": {
  2299. "description": "Resource inaccessible",
  2300. "content": {
  2301. "application/json": {
  2302. "schema": {
  2303. "type": "object",
  2304. "required": [
  2305. "ocs"
  2306. ],
  2307. "properties": {
  2308. "ocs": {
  2309. "type": "object",
  2310. "required": [
  2311. "meta",
  2312. "data"
  2313. ],
  2314. "properties": {
  2315. "meta": {
  2316. "$ref": "#/components/schemas/OCSMeta"
  2317. },
  2318. "data": {}
  2319. }
  2320. }
  2321. }
  2322. }
  2323. }
  2324. }
  2325. },
  2326. "500": {
  2327. "description": "",
  2328. "content": {
  2329. "application/json": {
  2330. "schema": {
  2331. "type": "object",
  2332. "required": [
  2333. "ocs"
  2334. ],
  2335. "properties": {
  2336. "ocs": {
  2337. "type": "object",
  2338. "required": [
  2339. "meta",
  2340. "data"
  2341. ],
  2342. "properties": {
  2343. "meta": {
  2344. "$ref": "#/components/schemas/OCSMeta"
  2345. },
  2346. "data": {}
  2347. }
  2348. }
  2349. }
  2350. }
  2351. }
  2352. }
  2353. }
  2354. }
  2355. }
  2356. },
  2357. "/ocs/v2.php/hovercard/v1/{userId}": {
  2358. "get": {
  2359. "operationId": "hover_card-get-user",
  2360. "summary": "Get the account details for a hovercard",
  2361. "tags": [
  2362. "hover_card"
  2363. ],
  2364. "security": [
  2365. {
  2366. "bearer_auth": []
  2367. },
  2368. {
  2369. "basic_auth": []
  2370. }
  2371. ],
  2372. "parameters": [
  2373. {
  2374. "name": "userId",
  2375. "in": "path",
  2376. "description": "ID of the user",
  2377. "required": true,
  2378. "schema": {
  2379. "type": "string"
  2380. }
  2381. },
  2382. {
  2383. "name": "OCS-APIRequest",
  2384. "in": "header",
  2385. "description": "Required to be true for the API request to pass",
  2386. "required": true,
  2387. "schema": {
  2388. "type": "boolean",
  2389. "default": true
  2390. }
  2391. }
  2392. ],
  2393. "responses": {
  2394. "200": {
  2395. "description": "Account details returned",
  2396. "content": {
  2397. "application/json": {
  2398. "schema": {
  2399. "type": "object",
  2400. "required": [
  2401. "ocs"
  2402. ],
  2403. "properties": {
  2404. "ocs": {
  2405. "type": "object",
  2406. "required": [
  2407. "meta",
  2408. "data"
  2409. ],
  2410. "properties": {
  2411. "meta": {
  2412. "$ref": "#/components/schemas/OCSMeta"
  2413. },
  2414. "data": {
  2415. "type": "object",
  2416. "required": [
  2417. "userId",
  2418. "displayName",
  2419. "actions"
  2420. ],
  2421. "properties": {
  2422. "userId": {
  2423. "type": "string"
  2424. },
  2425. "displayName": {
  2426. "type": "string"
  2427. },
  2428. "actions": {
  2429. "type": "array",
  2430. "items": {
  2431. "$ref": "#/components/schemas/ContactsAction"
  2432. }
  2433. }
  2434. }
  2435. }
  2436. }
  2437. }
  2438. }
  2439. }
  2440. }
  2441. }
  2442. },
  2443. "404": {
  2444. "description": "Account not found",
  2445. "content": {
  2446. "application/json": {
  2447. "schema": {
  2448. "type": "object",
  2449. "required": [
  2450. "ocs"
  2451. ],
  2452. "properties": {
  2453. "ocs": {
  2454. "type": "object",
  2455. "required": [
  2456. "meta",
  2457. "data"
  2458. ],
  2459. "properties": {
  2460. "meta": {
  2461. "$ref": "#/components/schemas/OCSMeta"
  2462. },
  2463. "data": {}
  2464. }
  2465. }
  2466. }
  2467. }
  2468. }
  2469. }
  2470. }
  2471. }
  2472. }
  2473. },
  2474. "/ocs/v2.php/core/navigation/apps": {
  2475. "get": {
  2476. "operationId": "navigation-get-apps-navigation",
  2477. "summary": "Get the apps navigation",
  2478. "tags": [
  2479. "navigation"
  2480. ],
  2481. "security": [
  2482. {
  2483. "bearer_auth": []
  2484. },
  2485. {
  2486. "basic_auth": []
  2487. }
  2488. ],
  2489. "parameters": [
  2490. {
  2491. "name": "absolute",
  2492. "in": "query",
  2493. "description": "Rewrite URLs to absolute ones",
  2494. "schema": {
  2495. "type": "integer",
  2496. "default": 0,
  2497. "enum": [
  2498. 0,
  2499. 1
  2500. ]
  2501. }
  2502. },
  2503. {
  2504. "name": "OCS-APIRequest",
  2505. "in": "header",
  2506. "description": "Required to be true for the API request to pass",
  2507. "required": true,
  2508. "schema": {
  2509. "type": "boolean",
  2510. "default": true
  2511. }
  2512. }
  2513. ],
  2514. "responses": {
  2515. "200": {
  2516. "description": "Apps navigation returned",
  2517. "content": {
  2518. "application/json": {
  2519. "schema": {
  2520. "type": "object",
  2521. "required": [
  2522. "ocs"
  2523. ],
  2524. "properties": {
  2525. "ocs": {
  2526. "type": "object",
  2527. "required": [
  2528. "meta",
  2529. "data"
  2530. ],
  2531. "properties": {
  2532. "meta": {
  2533. "$ref": "#/components/schemas/OCSMeta"
  2534. },
  2535. "data": {
  2536. "type": "array",
  2537. "items": {
  2538. "$ref": "#/components/schemas/NavigationEntry"
  2539. }
  2540. }
  2541. }
  2542. }
  2543. }
  2544. }
  2545. }
  2546. }
  2547. },
  2548. "304": {
  2549. "description": "No apps navigation changed"
  2550. }
  2551. }
  2552. }
  2553. },
  2554. "/ocs/v2.php/core/navigation/settings": {
  2555. "get": {
  2556. "operationId": "navigation-get-settings-navigation",
  2557. "summary": "Get the settings navigation",
  2558. "tags": [
  2559. "navigation"
  2560. ],
  2561. "security": [
  2562. {
  2563. "bearer_auth": []
  2564. },
  2565. {
  2566. "basic_auth": []
  2567. }
  2568. ],
  2569. "parameters": [
  2570. {
  2571. "name": "absolute",
  2572. "in": "query",
  2573. "description": "Rewrite URLs to absolute ones",
  2574. "schema": {
  2575. "type": "integer",
  2576. "default": 0,
  2577. "enum": [
  2578. 0,
  2579. 1
  2580. ]
  2581. }
  2582. },
  2583. {
  2584. "name": "OCS-APIRequest",
  2585. "in": "header",
  2586. "description": "Required to be true for the API request to pass",
  2587. "required": true,
  2588. "schema": {
  2589. "type": "boolean",
  2590. "default": true
  2591. }
  2592. }
  2593. ],
  2594. "responses": {
  2595. "200": {
  2596. "description": "Apps navigation returned",
  2597. "content": {
  2598. "application/json": {
  2599. "schema": {
  2600. "type": "object",
  2601. "required": [
  2602. "ocs"
  2603. ],
  2604. "properties": {
  2605. "ocs": {
  2606. "type": "object",
  2607. "required": [
  2608. "meta",
  2609. "data"
  2610. ],
  2611. "properties": {
  2612. "meta": {
  2613. "$ref": "#/components/schemas/OCSMeta"
  2614. },
  2615. "data": {
  2616. "type": "array",
  2617. "items": {
  2618. "$ref": "#/components/schemas/NavigationEntry"
  2619. }
  2620. }
  2621. }
  2622. }
  2623. }
  2624. }
  2625. }
  2626. }
  2627. },
  2628. "304": {
  2629. "description": "No apps navigation changed"
  2630. }
  2631. }
  2632. }
  2633. },
  2634. "/ocs/v2.php/cloud/capabilities": {
  2635. "get": {
  2636. "operationId": "ocs-get-capabilities",
  2637. "summary": "Get the capabilities",
  2638. "tags": [
  2639. "ocs"
  2640. ],
  2641. "security": [
  2642. {},
  2643. {
  2644. "bearer_auth": []
  2645. },
  2646. {
  2647. "basic_auth": []
  2648. }
  2649. ],
  2650. "parameters": [
  2651. {
  2652. "name": "OCS-APIRequest",
  2653. "in": "header",
  2654. "description": "Required to be true for the API request to pass",
  2655. "required": true,
  2656. "schema": {
  2657. "type": "boolean",
  2658. "default": true
  2659. }
  2660. }
  2661. ],
  2662. "responses": {
  2663. "200": {
  2664. "description": "Capabilities returned",
  2665. "content": {
  2666. "application/json": {
  2667. "schema": {
  2668. "type": "object",
  2669. "required": [
  2670. "ocs"
  2671. ],
  2672. "properties": {
  2673. "ocs": {
  2674. "type": "object",
  2675. "required": [
  2676. "meta",
  2677. "data"
  2678. ],
  2679. "properties": {
  2680. "meta": {
  2681. "$ref": "#/components/schemas/OCSMeta"
  2682. },
  2683. "data": {
  2684. "type": "object",
  2685. "required": [
  2686. "version",
  2687. "capabilities"
  2688. ],
  2689. "properties": {
  2690. "version": {
  2691. "type": "object",
  2692. "required": [
  2693. "major",
  2694. "minor",
  2695. "micro",
  2696. "string",
  2697. "edition",
  2698. "extendedSupport"
  2699. ],
  2700. "properties": {
  2701. "major": {
  2702. "type": "integer",
  2703. "format": "int64"
  2704. },
  2705. "minor": {
  2706. "type": "integer",
  2707. "format": "int64"
  2708. },
  2709. "micro": {
  2710. "type": "integer",
  2711. "format": "int64"
  2712. },
  2713. "string": {
  2714. "type": "string"
  2715. },
  2716. "edition": {
  2717. "type": "string"
  2718. },
  2719. "extendedSupport": {
  2720. "type": "boolean"
  2721. }
  2722. }
  2723. },
  2724. "capabilities": {
  2725. "type": "object",
  2726. "additionalProperties": {
  2727. "type": "object"
  2728. }
  2729. }
  2730. }
  2731. }
  2732. }
  2733. }
  2734. }
  2735. }
  2736. }
  2737. }
  2738. }
  2739. }
  2740. }
  2741. },
  2742. "/ocs/v2.php/profile/{targetUserId}": {
  2743. "put": {
  2744. "operationId": "profile_api-set-visibility",
  2745. "summary": "Update the visibility of a parameter",
  2746. "description": "This endpoint requires password confirmation",
  2747. "tags": [
  2748. "profile_api"
  2749. ],
  2750. "security": [
  2751. {
  2752. "bearer_auth": []
  2753. },
  2754. {
  2755. "basic_auth": []
  2756. }
  2757. ],
  2758. "parameters": [
  2759. {
  2760. "name": "paramId",
  2761. "in": "query",
  2762. "description": "ID of the parameter",
  2763. "required": true,
  2764. "schema": {
  2765. "type": "string"
  2766. }
  2767. },
  2768. {
  2769. "name": "visibility",
  2770. "in": "query",
  2771. "description": "New visibility",
  2772. "required": true,
  2773. "schema": {
  2774. "type": "string"
  2775. }
  2776. },
  2777. {
  2778. "name": "targetUserId",
  2779. "in": "path",
  2780. "description": "ID of the user",
  2781. "required": true,
  2782. "schema": {
  2783. "type": "string"
  2784. }
  2785. },
  2786. {
  2787. "name": "OCS-APIRequest",
  2788. "in": "header",
  2789. "description": "Required to be true for the API request to pass",
  2790. "required": true,
  2791. "schema": {
  2792. "type": "boolean",
  2793. "default": true
  2794. }
  2795. }
  2796. ],
  2797. "responses": {
  2798. "200": {
  2799. "description": "Visibility updated successfully",
  2800. "content": {
  2801. "application/json": {
  2802. "schema": {
  2803. "type": "object",
  2804. "required": [
  2805. "ocs"
  2806. ],
  2807. "properties": {
  2808. "ocs": {
  2809. "type": "object",
  2810. "required": [
  2811. "meta",
  2812. "data"
  2813. ],
  2814. "properties": {
  2815. "meta": {
  2816. "$ref": "#/components/schemas/OCSMeta"
  2817. },
  2818. "data": {}
  2819. }
  2820. }
  2821. }
  2822. }
  2823. }
  2824. }
  2825. },
  2826. "400": {
  2827. "description": "Updating visibility is not possible",
  2828. "content": {
  2829. "application/json": {
  2830. "schema": {
  2831. "type": "object",
  2832. "required": [
  2833. "ocs"
  2834. ],
  2835. "properties": {
  2836. "ocs": {
  2837. "type": "object",
  2838. "required": [
  2839. "meta",
  2840. "data"
  2841. ],
  2842. "properties": {
  2843. "meta": {
  2844. "$ref": "#/components/schemas/OCSMeta"
  2845. },
  2846. "data": {}
  2847. }
  2848. }
  2849. }
  2850. }
  2851. }
  2852. }
  2853. },
  2854. "403": {
  2855. "description": "Not allowed to edit other users visibility",
  2856. "content": {
  2857. "application/json": {
  2858. "schema": {
  2859. "type": "object",
  2860. "required": [
  2861. "ocs"
  2862. ],
  2863. "properties": {
  2864. "ocs": {
  2865. "type": "object",
  2866. "required": [
  2867. "meta",
  2868. "data"
  2869. ],
  2870. "properties": {
  2871. "meta": {
  2872. "$ref": "#/components/schemas/OCSMeta"
  2873. },
  2874. "data": {}
  2875. }
  2876. }
  2877. }
  2878. }
  2879. }
  2880. }
  2881. },
  2882. "404": {
  2883. "description": "Account not found",
  2884. "content": {
  2885. "application/json": {
  2886. "schema": {
  2887. "type": "object",
  2888. "required": [
  2889. "ocs"
  2890. ],
  2891. "properties": {
  2892. "ocs": {
  2893. "type": "object",
  2894. "required": [
  2895. "meta",
  2896. "data"
  2897. ],
  2898. "properties": {
  2899. "meta": {
  2900. "$ref": "#/components/schemas/OCSMeta"
  2901. },
  2902. "data": {}
  2903. }
  2904. }
  2905. }
  2906. }
  2907. }
  2908. }
  2909. }
  2910. }
  2911. }
  2912. },
  2913. "/ocs/v2.php/references/extract": {
  2914. "post": {
  2915. "operationId": "reference_api-extract",
  2916. "summary": "Extract references from a text",
  2917. "tags": [
  2918. "reference_api"
  2919. ],
  2920. "security": [
  2921. {
  2922. "bearer_auth": []
  2923. },
  2924. {
  2925. "basic_auth": []
  2926. }
  2927. ],
  2928. "parameters": [
  2929. {
  2930. "name": "text",
  2931. "in": "query",
  2932. "description": "Text to extract from",
  2933. "required": true,
  2934. "schema": {
  2935. "type": "string"
  2936. }
  2937. },
  2938. {
  2939. "name": "resolve",
  2940. "in": "query",
  2941. "description": "Resolve the references",
  2942. "schema": {
  2943. "type": "integer",
  2944. "default": 0,
  2945. "enum": [
  2946. 0,
  2947. 1
  2948. ]
  2949. }
  2950. },
  2951. {
  2952. "name": "limit",
  2953. "in": "query",
  2954. "description": "Maximum amount of references to extract",
  2955. "schema": {
  2956. "type": "integer",
  2957. "format": "int64",
  2958. "default": 1
  2959. }
  2960. },
  2961. {
  2962. "name": "OCS-APIRequest",
  2963. "in": "header",
  2964. "description": "Required to be true for the API request to pass",
  2965. "required": true,
  2966. "schema": {
  2967. "type": "boolean",
  2968. "default": true
  2969. }
  2970. }
  2971. ],
  2972. "responses": {
  2973. "200": {
  2974. "description": "References returned",
  2975. "content": {
  2976. "application/json": {
  2977. "schema": {
  2978. "type": "object",
  2979. "required": [
  2980. "ocs"
  2981. ],
  2982. "properties": {
  2983. "ocs": {
  2984. "type": "object",
  2985. "required": [
  2986. "meta",
  2987. "data"
  2988. ],
  2989. "properties": {
  2990. "meta": {
  2991. "$ref": "#/components/schemas/OCSMeta"
  2992. },
  2993. "data": {
  2994. "type": "object",
  2995. "required": [
  2996. "references"
  2997. ],
  2998. "properties": {
  2999. "references": {
  3000. "type": "object",
  3001. "additionalProperties": {
  3002. "$ref": "#/components/schemas/Reference",
  3003. "nullable": true
  3004. }
  3005. }
  3006. }
  3007. }
  3008. }
  3009. }
  3010. }
  3011. }
  3012. }
  3013. }
  3014. }
  3015. }
  3016. }
  3017. },
  3018. "/ocs/v2.php/references/resolve": {
  3019. "get": {
  3020. "operationId": "reference_api-resolve-one",
  3021. "summary": "Resolve a reference",
  3022. "tags": [
  3023. "reference_api"
  3024. ],
  3025. "security": [
  3026. {
  3027. "bearer_auth": []
  3028. },
  3029. {
  3030. "basic_auth": []
  3031. }
  3032. ],
  3033. "parameters": [
  3034. {
  3035. "name": "reference",
  3036. "in": "query",
  3037. "description": "Reference to resolve",
  3038. "required": true,
  3039. "schema": {
  3040. "type": "string"
  3041. }
  3042. },
  3043. {
  3044. "name": "OCS-APIRequest",
  3045. "in": "header",
  3046. "description": "Required to be true for the API request to pass",
  3047. "required": true,
  3048. "schema": {
  3049. "type": "boolean",
  3050. "default": true
  3051. }
  3052. }
  3053. ],
  3054. "responses": {
  3055. "200": {
  3056. "description": "Reference returned",
  3057. "content": {
  3058. "application/json": {
  3059. "schema": {
  3060. "type": "object",
  3061. "required": [
  3062. "ocs"
  3063. ],
  3064. "properties": {
  3065. "ocs": {
  3066. "type": "object",
  3067. "required": [
  3068. "meta",
  3069. "data"
  3070. ],
  3071. "properties": {
  3072. "meta": {
  3073. "$ref": "#/components/schemas/OCSMeta"
  3074. },
  3075. "data": {
  3076. "type": "object",
  3077. "required": [
  3078. "references"
  3079. ],
  3080. "properties": {
  3081. "references": {
  3082. "type": "object",
  3083. "additionalProperties": {
  3084. "$ref": "#/components/schemas/Reference",
  3085. "nullable": true
  3086. }
  3087. }
  3088. }
  3089. }
  3090. }
  3091. }
  3092. }
  3093. }
  3094. }
  3095. }
  3096. }
  3097. }
  3098. },
  3099. "post": {
  3100. "operationId": "reference_api-resolve",
  3101. "summary": "Resolve multiple references",
  3102. "tags": [
  3103. "reference_api"
  3104. ],
  3105. "security": [
  3106. {
  3107. "bearer_auth": []
  3108. },
  3109. {
  3110. "basic_auth": []
  3111. }
  3112. ],
  3113. "parameters": [
  3114. {
  3115. "name": "references[]",
  3116. "in": "query",
  3117. "description": "References to resolve",
  3118. "required": true,
  3119. "schema": {
  3120. "type": "array",
  3121. "items": {
  3122. "type": "string"
  3123. }
  3124. }
  3125. },
  3126. {
  3127. "name": "limit",
  3128. "in": "query",
  3129. "description": "Maximum amount of references to resolve",
  3130. "schema": {
  3131. "type": "integer",
  3132. "format": "int64",
  3133. "default": 1
  3134. }
  3135. },
  3136. {
  3137. "name": "OCS-APIRequest",
  3138. "in": "header",
  3139. "description": "Required to be true for the API request to pass",
  3140. "required": true,
  3141. "schema": {
  3142. "type": "boolean",
  3143. "default": true
  3144. }
  3145. }
  3146. ],
  3147. "responses": {
  3148. "200": {
  3149. "description": "References returned",
  3150. "content": {
  3151. "application/json": {
  3152. "schema": {
  3153. "type": "object",
  3154. "required": [
  3155. "ocs"
  3156. ],
  3157. "properties": {
  3158. "ocs": {
  3159. "type": "object",
  3160. "required": [
  3161. "meta",
  3162. "data"
  3163. ],
  3164. "properties": {
  3165. "meta": {
  3166. "$ref": "#/components/schemas/OCSMeta"
  3167. },
  3168. "data": {
  3169. "type": "object",
  3170. "required": [
  3171. "references"
  3172. ],
  3173. "properties": {
  3174. "references": {
  3175. "type": "object",
  3176. "additionalProperties": {
  3177. "$ref": "#/components/schemas/Reference",
  3178. "nullable": true
  3179. }
  3180. }
  3181. }
  3182. }
  3183. }
  3184. }
  3185. }
  3186. }
  3187. }
  3188. }
  3189. }
  3190. }
  3191. }
  3192. },
  3193. "/ocs/v2.php/references/providers": {
  3194. "get": {
  3195. "operationId": "reference_api-get-providers-info",
  3196. "summary": "Get the providers",
  3197. "tags": [
  3198. "reference_api"
  3199. ],
  3200. "security": [
  3201. {
  3202. "bearer_auth": []
  3203. },
  3204. {
  3205. "basic_auth": []
  3206. }
  3207. ],
  3208. "parameters": [
  3209. {
  3210. "name": "OCS-APIRequest",
  3211. "in": "header",
  3212. "description": "Required to be true for the API request to pass",
  3213. "required": true,
  3214. "schema": {
  3215. "type": "boolean",
  3216. "default": true
  3217. }
  3218. }
  3219. ],
  3220. "responses": {
  3221. "200": {
  3222. "description": "Providers returned",
  3223. "content": {
  3224. "application/json": {
  3225. "schema": {
  3226. "type": "object",
  3227. "required": [
  3228. "ocs"
  3229. ],
  3230. "properties": {
  3231. "ocs": {
  3232. "type": "object",
  3233. "required": [
  3234. "meta",
  3235. "data"
  3236. ],
  3237. "properties": {
  3238. "meta": {
  3239. "$ref": "#/components/schemas/OCSMeta"
  3240. },
  3241. "data": {
  3242. "type": "array",
  3243. "items": {
  3244. "$ref": "#/components/schemas/ReferenceProvider"
  3245. }
  3246. }
  3247. }
  3248. }
  3249. }
  3250. }
  3251. }
  3252. }
  3253. }
  3254. }
  3255. }
  3256. },
  3257. "/ocs/v2.php/references/provider/{providerId}": {
  3258. "put": {
  3259. "operationId": "reference_api-touch-provider",
  3260. "summary": "Touch a provider",
  3261. "tags": [
  3262. "reference_api"
  3263. ],
  3264. "security": [
  3265. {
  3266. "bearer_auth": []
  3267. },
  3268. {
  3269. "basic_auth": []
  3270. }
  3271. ],
  3272. "parameters": [
  3273. {
  3274. "name": "timestamp",
  3275. "in": "query",
  3276. "description": "Timestamp of the last usage",
  3277. "schema": {
  3278. "type": "integer",
  3279. "format": "int64",
  3280. "nullable": true
  3281. }
  3282. },
  3283. {
  3284. "name": "providerId",
  3285. "in": "path",
  3286. "description": "ID of the provider",
  3287. "required": true,
  3288. "schema": {
  3289. "type": "string"
  3290. }
  3291. },
  3292. {
  3293. "name": "OCS-APIRequest",
  3294. "in": "header",
  3295. "description": "Required to be true for the API request to pass",
  3296. "required": true,
  3297. "schema": {
  3298. "type": "boolean",
  3299. "default": true
  3300. }
  3301. }
  3302. ],
  3303. "responses": {
  3304. "200": {
  3305. "description": "Provider touched",
  3306. "content": {
  3307. "application/json": {
  3308. "schema": {
  3309. "type": "object",
  3310. "required": [
  3311. "ocs"
  3312. ],
  3313. "properties": {
  3314. "ocs": {
  3315. "type": "object",
  3316. "required": [
  3317. "meta",
  3318. "data"
  3319. ],
  3320. "properties": {
  3321. "meta": {
  3322. "$ref": "#/components/schemas/OCSMeta"
  3323. },
  3324. "data": {
  3325. "type": "object",
  3326. "required": [
  3327. "success"
  3328. ],
  3329. "properties": {
  3330. "success": {
  3331. "type": "boolean"
  3332. }
  3333. }
  3334. }
  3335. }
  3336. }
  3337. }
  3338. }
  3339. }
  3340. }
  3341. }
  3342. }
  3343. }
  3344. },
  3345. "/ocs/v2.php/taskprocessing/tasktypes": {
  3346. "get": {
  3347. "operationId": "task_processing_api-task-types",
  3348. "summary": "Returns all available TaskProcessing task types",
  3349. "tags": [
  3350. "task_processing_api"
  3351. ],
  3352. "security": [
  3353. {},
  3354. {
  3355. "bearer_auth": []
  3356. },
  3357. {
  3358. "basic_auth": []
  3359. }
  3360. ],
  3361. "parameters": [
  3362. {
  3363. "name": "OCS-APIRequest",
  3364. "in": "header",
  3365. "description": "Required to be true for the API request to pass",
  3366. "required": true,
  3367. "schema": {
  3368. "type": "boolean",
  3369. "default": true
  3370. }
  3371. }
  3372. ],
  3373. "responses": {
  3374. "200": {
  3375. "description": "Task types returned",
  3376. "content": {
  3377. "application/json": {
  3378. "schema": {
  3379. "type": "object",
  3380. "required": [
  3381. "ocs"
  3382. ],
  3383. "properties": {
  3384. "ocs": {
  3385. "type": "object",
  3386. "required": [
  3387. "meta",
  3388. "data"
  3389. ],
  3390. "properties": {
  3391. "meta": {
  3392. "$ref": "#/components/schemas/OCSMeta"
  3393. },
  3394. "data": {
  3395. "type": "object",
  3396. "required": [
  3397. "types"
  3398. ],
  3399. "properties": {
  3400. "types": {
  3401. "type": "object",
  3402. "additionalProperties": {
  3403. "$ref": "#/components/schemas/TaskProcessingTaskType"
  3404. }
  3405. }
  3406. }
  3407. }
  3408. }
  3409. }
  3410. }
  3411. }
  3412. }
  3413. }
  3414. }
  3415. }
  3416. }
  3417. },
  3418. "/ocs/v2.php/taskprocessing/schedule": {
  3419. "post": {
  3420. "operationId": "task_processing_api-schedule",
  3421. "summary": "Schedules a task",
  3422. "tags": [
  3423. "task_processing_api"
  3424. ],
  3425. "security": [
  3426. {},
  3427. {
  3428. "bearer_auth": []
  3429. },
  3430. {
  3431. "basic_auth": []
  3432. }
  3433. ],
  3434. "parameters": [
  3435. {
  3436. "name": "input",
  3437. "in": "query",
  3438. "description": "Task's input parameters",
  3439. "required": true,
  3440. "schema": {
  3441. "type": "string"
  3442. }
  3443. },
  3444. {
  3445. "name": "type",
  3446. "in": "query",
  3447. "description": "Type of the task",
  3448. "required": true,
  3449. "schema": {
  3450. "type": "string"
  3451. }
  3452. },
  3453. {
  3454. "name": "appId",
  3455. "in": "query",
  3456. "description": "ID of the app that will execute the task",
  3457. "required": true,
  3458. "schema": {
  3459. "type": "string"
  3460. }
  3461. },
  3462. {
  3463. "name": "customId",
  3464. "in": "query",
  3465. "description": "An arbitrary identifier for the task",
  3466. "schema": {
  3467. "type": "string",
  3468. "default": ""
  3469. }
  3470. },
  3471. {
  3472. "name": "OCS-APIRequest",
  3473. "in": "header",
  3474. "description": "Required to be true for the API request to pass",
  3475. "required": true,
  3476. "schema": {
  3477. "type": "boolean",
  3478. "default": true
  3479. }
  3480. }
  3481. ],
  3482. "responses": {
  3483. "200": {
  3484. "description": "Task scheduled successfully",
  3485. "content": {
  3486. "application/json": {
  3487. "schema": {
  3488. "type": "object",
  3489. "required": [
  3490. "ocs"
  3491. ],
  3492. "properties": {
  3493. "ocs": {
  3494. "type": "object",
  3495. "required": [
  3496. "meta",
  3497. "data"
  3498. ],
  3499. "properties": {
  3500. "meta": {
  3501. "$ref": "#/components/schemas/OCSMeta"
  3502. },
  3503. "data": {
  3504. "type": "object",
  3505. "required": [
  3506. "task"
  3507. ],
  3508. "properties": {
  3509. "task": {
  3510. "$ref": "#/components/schemas/TaskProcessingTask"
  3511. }
  3512. }
  3513. }
  3514. }
  3515. }
  3516. }
  3517. }
  3518. }
  3519. }
  3520. },
  3521. "500": {
  3522. "description": "",
  3523. "content": {
  3524. "application/json": {
  3525. "schema": {
  3526. "type": "object",
  3527. "required": [
  3528. "ocs"
  3529. ],
  3530. "properties": {
  3531. "ocs": {
  3532. "type": "object",
  3533. "required": [
  3534. "meta",
  3535. "data"
  3536. ],
  3537. "properties": {
  3538. "meta": {
  3539. "$ref": "#/components/schemas/OCSMeta"
  3540. },
  3541. "data": {
  3542. "type": "object",
  3543. "required": [
  3544. "message"
  3545. ],
  3546. "properties": {
  3547. "message": {
  3548. "type": "string"
  3549. }
  3550. }
  3551. }
  3552. }
  3553. }
  3554. }
  3555. }
  3556. }
  3557. }
  3558. },
  3559. "400": {
  3560. "description": "Scheduling task is not possible",
  3561. "content": {
  3562. "application/json": {
  3563. "schema": {
  3564. "type": "object",
  3565. "required": [
  3566. "ocs"
  3567. ],
  3568. "properties": {
  3569. "ocs": {
  3570. "type": "object",
  3571. "required": [
  3572. "meta",
  3573. "data"
  3574. ],
  3575. "properties": {
  3576. "meta": {
  3577. "$ref": "#/components/schemas/OCSMeta"
  3578. },
  3579. "data": {
  3580. "type": "object",
  3581. "required": [
  3582. "message"
  3583. ],
  3584. "properties": {
  3585. "message": {
  3586. "type": "string"
  3587. }
  3588. }
  3589. }
  3590. }
  3591. }
  3592. }
  3593. }
  3594. }
  3595. }
  3596. },
  3597. "412": {
  3598. "description": "Scheduling task is not possible",
  3599. "content": {
  3600. "application/json": {
  3601. "schema": {
  3602. "type": "object",
  3603. "required": [
  3604. "ocs"
  3605. ],
  3606. "properties": {
  3607. "ocs": {
  3608. "type": "object",
  3609. "required": [
  3610. "meta",
  3611. "data"
  3612. ],
  3613. "properties": {
  3614. "meta": {
  3615. "$ref": "#/components/schemas/OCSMeta"
  3616. },
  3617. "data": {
  3618. "type": "object",
  3619. "required": [
  3620. "message"
  3621. ],
  3622. "properties": {
  3623. "message": {
  3624. "type": "string"
  3625. }
  3626. }
  3627. }
  3628. }
  3629. }
  3630. }
  3631. }
  3632. }
  3633. }
  3634. },
  3635. "401": {
  3636. "description": "Cannot schedule task because it references files in its input that the user doesn't have access to",
  3637. "content": {
  3638. "application/json": {
  3639. "schema": {
  3640. "type": "object",
  3641. "required": [
  3642. "ocs"
  3643. ],
  3644. "properties": {
  3645. "ocs": {
  3646. "type": "object",
  3647. "required": [
  3648. "meta",
  3649. "data"
  3650. ],
  3651. "properties": {
  3652. "meta": {
  3653. "$ref": "#/components/schemas/OCSMeta"
  3654. },
  3655. "data": {
  3656. "type": "object",
  3657. "required": [
  3658. "message"
  3659. ],
  3660. "properties": {
  3661. "message": {
  3662. "type": "string"
  3663. }
  3664. }
  3665. }
  3666. }
  3667. }
  3668. }
  3669. }
  3670. }
  3671. }
  3672. }
  3673. }
  3674. }
  3675. },
  3676. "/ocs/v2.php/taskprocessing/task/{id}": {
  3677. "get": {
  3678. "operationId": "task_processing_api-get-task",
  3679. "summary": "Gets a task including status and result",
  3680. "description": "Tasks are removed 1 week after receiving their last update",
  3681. "tags": [
  3682. "task_processing_api"
  3683. ],
  3684. "security": [
  3685. {},
  3686. {
  3687. "bearer_auth": []
  3688. },
  3689. {
  3690. "basic_auth": []
  3691. }
  3692. ],
  3693. "parameters": [
  3694. {
  3695. "name": "id",
  3696. "in": "path",
  3697. "description": "The id of the task",
  3698. "required": true,
  3699. "schema": {
  3700. "type": "integer",
  3701. "format": "int64"
  3702. }
  3703. },
  3704. {
  3705. "name": "OCS-APIRequest",
  3706. "in": "header",
  3707. "description": "Required to be true for the API request to pass",
  3708. "required": true,
  3709. "schema": {
  3710. "type": "boolean",
  3711. "default": true
  3712. }
  3713. }
  3714. ],
  3715. "responses": {
  3716. "200": {
  3717. "description": "Task returned",
  3718. "content": {
  3719. "application/json": {
  3720. "schema": {
  3721. "type": "object",
  3722. "required": [
  3723. "ocs"
  3724. ],
  3725. "properties": {
  3726. "ocs": {
  3727. "type": "object",
  3728. "required": [
  3729. "meta",
  3730. "data"
  3731. ],
  3732. "properties": {
  3733. "meta": {
  3734. "$ref": "#/components/schemas/OCSMeta"
  3735. },
  3736. "data": {
  3737. "type": "object",
  3738. "required": [
  3739. "task"
  3740. ],
  3741. "properties": {
  3742. "task": {
  3743. "$ref": "#/components/schemas/TaskProcessingTask"
  3744. }
  3745. }
  3746. }
  3747. }
  3748. }
  3749. }
  3750. }
  3751. }
  3752. }
  3753. },
  3754. "404": {
  3755. "description": "Task not found",
  3756. "content": {
  3757. "application/json": {
  3758. "schema": {
  3759. "type": "object",
  3760. "required": [
  3761. "ocs"
  3762. ],
  3763. "properties": {
  3764. "ocs": {
  3765. "type": "object",
  3766. "required": [
  3767. "meta",
  3768. "data"
  3769. ],
  3770. "properties": {
  3771. "meta": {
  3772. "$ref": "#/components/schemas/OCSMeta"
  3773. },
  3774. "data": {
  3775. "type": "object",
  3776. "required": [
  3777. "message"
  3778. ],
  3779. "properties": {
  3780. "message": {
  3781. "type": "string"
  3782. }
  3783. }
  3784. }
  3785. }
  3786. }
  3787. }
  3788. }
  3789. }
  3790. }
  3791. },
  3792. "500": {
  3793. "description": "",
  3794. "content": {
  3795. "application/json": {
  3796. "schema": {
  3797. "type": "object",
  3798. "required": [
  3799. "ocs"
  3800. ],
  3801. "properties": {
  3802. "ocs": {
  3803. "type": "object",
  3804. "required": [
  3805. "meta",
  3806. "data"
  3807. ],
  3808. "properties": {
  3809. "meta": {
  3810. "$ref": "#/components/schemas/OCSMeta"
  3811. },
  3812. "data": {
  3813. "type": "object",
  3814. "required": [
  3815. "message"
  3816. ],
  3817. "properties": {
  3818. "message": {
  3819. "type": "string"
  3820. }
  3821. }
  3822. }
  3823. }
  3824. }
  3825. }
  3826. }
  3827. }
  3828. }
  3829. }
  3830. }
  3831. },
  3832. "delete": {
  3833. "operationId": "task_processing_api-delete-task",
  3834. "summary": "Deletes a task",
  3835. "tags": [
  3836. "task_processing_api"
  3837. ],
  3838. "security": [
  3839. {
  3840. "bearer_auth": []
  3841. },
  3842. {
  3843. "basic_auth": []
  3844. }
  3845. ],
  3846. "parameters": [
  3847. {
  3848. "name": "id",
  3849. "in": "path",
  3850. "description": "The id of the task",
  3851. "required": true,
  3852. "schema": {
  3853. "type": "integer",
  3854. "format": "int64"
  3855. }
  3856. },
  3857. {
  3858. "name": "OCS-APIRequest",
  3859. "in": "header",
  3860. "description": "Required to be true for the API request to pass",
  3861. "required": true,
  3862. "schema": {
  3863. "type": "boolean",
  3864. "default": true
  3865. }
  3866. }
  3867. ],
  3868. "responses": {
  3869. "200": {
  3870. "description": "Task deleted",
  3871. "content": {
  3872. "application/json": {
  3873. "schema": {
  3874. "type": "object",
  3875. "required": [
  3876. "ocs"
  3877. ],
  3878. "properties": {
  3879. "ocs": {
  3880. "type": "object",
  3881. "required": [
  3882. "meta",
  3883. "data"
  3884. ],
  3885. "properties": {
  3886. "meta": {
  3887. "$ref": "#/components/schemas/OCSMeta"
  3888. },
  3889. "data": {
  3890. "nullable": true
  3891. }
  3892. }
  3893. }
  3894. }
  3895. }
  3896. }
  3897. }
  3898. },
  3899. "500": {
  3900. "description": "",
  3901. "content": {
  3902. "application/json": {
  3903. "schema": {
  3904. "type": "object",
  3905. "required": [
  3906. "ocs"
  3907. ],
  3908. "properties": {
  3909. "ocs": {
  3910. "type": "object",
  3911. "required": [
  3912. "meta",
  3913. "data"
  3914. ],
  3915. "properties": {
  3916. "meta": {
  3917. "$ref": "#/components/schemas/OCSMeta"
  3918. },
  3919. "data": {
  3920. "type": "object",
  3921. "required": [
  3922. "message"
  3923. ],
  3924. "properties": {
  3925. "message": {
  3926. "type": "string"
  3927. }
  3928. }
  3929. }
  3930. }
  3931. }
  3932. }
  3933. }
  3934. }
  3935. }
  3936. }
  3937. }
  3938. }
  3939. },
  3940. "/ocs/v2.php/taskprocessing/tasks/app/{appId}": {
  3941. "get": {
  3942. "operationId": "task_processing_api-list-tasks-by-app",
  3943. "summary": "Returns tasks for the current user filtered by the appId and optional customId",
  3944. "tags": [
  3945. "task_processing_api"
  3946. ],
  3947. "security": [
  3948. {
  3949. "bearer_auth": []
  3950. },
  3951. {
  3952. "basic_auth": []
  3953. }
  3954. ],
  3955. "parameters": [
  3956. {
  3957. "name": "customId",
  3958. "in": "query",
  3959. "description": "An arbitrary identifier for the task",
  3960. "schema": {
  3961. "type": "string",
  3962. "nullable": true
  3963. }
  3964. },
  3965. {
  3966. "name": "appId",
  3967. "in": "path",
  3968. "description": "ID of the app",
  3969. "required": true,
  3970. "schema": {
  3971. "type": "string"
  3972. }
  3973. },
  3974. {
  3975. "name": "OCS-APIRequest",
  3976. "in": "header",
  3977. "description": "Required to be true for the API request to pass",
  3978. "required": true,
  3979. "schema": {
  3980. "type": "boolean",
  3981. "default": true
  3982. }
  3983. }
  3984. ],
  3985. "responses": {
  3986. "200": {
  3987. "description": "Tasks returned",
  3988. "content": {
  3989. "application/json": {
  3990. "schema": {
  3991. "type": "object",
  3992. "required": [
  3993. "ocs"
  3994. ],
  3995. "properties": {
  3996. "ocs": {
  3997. "type": "object",
  3998. "required": [
  3999. "meta",
  4000. "data"
  4001. ],
  4002. "properties": {
  4003. "meta": {
  4004. "$ref": "#/components/schemas/OCSMeta"
  4005. },
  4006. "data": {
  4007. "type": "object",
  4008. "required": [
  4009. "tasks"
  4010. ],
  4011. "properties": {
  4012. "tasks": {
  4013. "type": "array",
  4014. "items": {
  4015. "$ref": "#/components/schemas/TaskProcessingTask"
  4016. }
  4017. }
  4018. }
  4019. }
  4020. }
  4021. }
  4022. }
  4023. }
  4024. }
  4025. }
  4026. },
  4027. "500": {
  4028. "description": "",
  4029. "content": {
  4030. "application/json": {
  4031. "schema": {
  4032. "type": "object",
  4033. "required": [
  4034. "ocs"
  4035. ],
  4036. "properties": {
  4037. "ocs": {
  4038. "type": "object",
  4039. "required": [
  4040. "meta",
  4041. "data"
  4042. ],
  4043. "properties": {
  4044. "meta": {
  4045. "$ref": "#/components/schemas/OCSMeta"
  4046. },
  4047. "data": {
  4048. "type": "object",
  4049. "required": [
  4050. "message"
  4051. ],
  4052. "properties": {
  4053. "message": {
  4054. "type": "string"
  4055. }
  4056. }
  4057. }
  4058. }
  4059. }
  4060. }
  4061. }
  4062. }
  4063. }
  4064. }
  4065. }
  4066. }
  4067. },
  4068. "/ocs/v2.php/taskprocessing/tasks": {
  4069. "get": {
  4070. "operationId": "task_processing_api-list-tasks",
  4071. "summary": "Returns tasks for the current user filtered by the optional taskType and optional customId",
  4072. "tags": [
  4073. "task_processing_api"
  4074. ],
  4075. "security": [
  4076. {
  4077. "bearer_auth": []
  4078. },
  4079. {
  4080. "basic_auth": []
  4081. }
  4082. ],
  4083. "parameters": [
  4084. {
  4085. "name": "taskType",
  4086. "in": "query",
  4087. "description": "The task type to filter by",
  4088. "schema": {
  4089. "type": "string",
  4090. "nullable": true
  4091. }
  4092. },
  4093. {
  4094. "name": "customId",
  4095. "in": "query",
  4096. "description": "An arbitrary identifier for the task",
  4097. "schema": {
  4098. "type": "string",
  4099. "nullable": true
  4100. }
  4101. },
  4102. {
  4103. "name": "OCS-APIRequest",
  4104. "in": "header",
  4105. "description": "Required to be true for the API request to pass",
  4106. "required": true,
  4107. "schema": {
  4108. "type": "boolean",
  4109. "default": true
  4110. }
  4111. }
  4112. ],
  4113. "responses": {
  4114. "200": {
  4115. "description": "Tasks returned",
  4116. "content": {
  4117. "application/json": {
  4118. "schema": {
  4119. "type": "object",
  4120. "required": [
  4121. "ocs"
  4122. ],
  4123. "properties": {
  4124. "ocs": {
  4125. "type": "object",
  4126. "required": [
  4127. "meta",
  4128. "data"
  4129. ],
  4130. "properties": {
  4131. "meta": {
  4132. "$ref": "#/components/schemas/OCSMeta"
  4133. },
  4134. "data": {
  4135. "type": "object",
  4136. "required": [
  4137. "tasks"
  4138. ],
  4139. "properties": {
  4140. "tasks": {
  4141. "type": "array",
  4142. "items": {
  4143. "$ref": "#/components/schemas/TaskProcessingTask"
  4144. }
  4145. }
  4146. }
  4147. }
  4148. }
  4149. }
  4150. }
  4151. }
  4152. }
  4153. }
  4154. },
  4155. "500": {
  4156. "description": "",
  4157. "content": {
  4158. "application/json": {
  4159. "schema": {
  4160. "type": "object",
  4161. "required": [
  4162. "ocs"
  4163. ],
  4164. "properties": {
  4165. "ocs": {
  4166. "type": "object",
  4167. "required": [
  4168. "meta",
  4169. "data"
  4170. ],
  4171. "properties": {
  4172. "meta": {
  4173. "$ref": "#/components/schemas/OCSMeta"
  4174. },
  4175. "data": {
  4176. "type": "object",
  4177. "required": [
  4178. "message"
  4179. ],
  4180. "properties": {
  4181. "message": {
  4182. "type": "string"
  4183. }
  4184. }
  4185. }
  4186. }
  4187. }
  4188. }
  4189. }
  4190. }
  4191. }
  4192. }
  4193. }
  4194. }
  4195. },
  4196. "/ocs/v2.php/taskprocessing/tasks/{taskId}/file/{fileId}": {
  4197. "get": {
  4198. "operationId": "task_processing_api-get-file-contents",
  4199. "summary": "Returns the contents of a file referenced in a task",
  4200. "tags": [
  4201. "task_processing_api"
  4202. ],
  4203. "security": [
  4204. {
  4205. "bearer_auth": []
  4206. },
  4207. {
  4208. "basic_auth": []
  4209. }
  4210. ],
  4211. "parameters": [
  4212. {
  4213. "name": "taskId",
  4214. "in": "path",
  4215. "description": "The id of the task",
  4216. "required": true,
  4217. "schema": {
  4218. "type": "integer",
  4219. "format": "int64"
  4220. }
  4221. },
  4222. {
  4223. "name": "fileId",
  4224. "in": "path",
  4225. "description": "The file id of the file to retrieve",
  4226. "required": true,
  4227. "schema": {
  4228. "type": "integer",
  4229. "format": "int64"
  4230. }
  4231. },
  4232. {
  4233. "name": "OCS-APIRequest",
  4234. "in": "header",
  4235. "description": "Required to be true for the API request to pass",
  4236. "required": true,
  4237. "schema": {
  4238. "type": "boolean",
  4239. "default": true
  4240. }
  4241. }
  4242. ],
  4243. "responses": {
  4244. "200": {
  4245. "description": "File content returned",
  4246. "content": {
  4247. "*/*": {
  4248. "schema": {
  4249. "type": "string",
  4250. "format": "binary"
  4251. }
  4252. }
  4253. }
  4254. },
  4255. "500": {
  4256. "description": "",
  4257. "content": {
  4258. "application/json": {
  4259. "schema": {
  4260. "type": "object",
  4261. "required": [
  4262. "ocs"
  4263. ],
  4264. "properties": {
  4265. "ocs": {
  4266. "type": "object",
  4267. "required": [
  4268. "meta",
  4269. "data"
  4270. ],
  4271. "properties": {
  4272. "meta": {
  4273. "$ref": "#/components/schemas/OCSMeta"
  4274. },
  4275. "data": {
  4276. "type": "object",
  4277. "required": [
  4278. "message"
  4279. ],
  4280. "properties": {
  4281. "message": {
  4282. "type": "string"
  4283. }
  4284. }
  4285. }
  4286. }
  4287. }
  4288. }
  4289. }
  4290. }
  4291. }
  4292. },
  4293. "404": {
  4294. "description": "Task or file not found",
  4295. "content": {
  4296. "application/json": {
  4297. "schema": {
  4298. "type": "object",
  4299. "required": [
  4300. "ocs"
  4301. ],
  4302. "properties": {
  4303. "ocs": {
  4304. "type": "object",
  4305. "required": [
  4306. "meta",
  4307. "data"
  4308. ],
  4309. "properties": {
  4310. "meta": {
  4311. "$ref": "#/components/schemas/OCSMeta"
  4312. },
  4313. "data": {
  4314. "type": "object",
  4315. "required": [
  4316. "message"
  4317. ],
  4318. "properties": {
  4319. "message": {
  4320. "type": "string"
  4321. }
  4322. }
  4323. }
  4324. }
  4325. }
  4326. }
  4327. }
  4328. }
  4329. }
  4330. }
  4331. }
  4332. }
  4333. },
  4334. "/ocs/v2.php/taskprocessing/tasks/{taskId}/progress": {
  4335. "post": {
  4336. "operationId": "task_processing_api-set-progress",
  4337. "summary": "Sets the task progress",
  4338. "tags": [
  4339. "task_processing_api"
  4340. ],
  4341. "security": [
  4342. {
  4343. "bearer_auth": []
  4344. },
  4345. {
  4346. "basic_auth": []
  4347. }
  4348. ],
  4349. "parameters": [
  4350. {
  4351. "name": "progress",
  4352. "in": "query",
  4353. "description": "The progress",
  4354. "required": true,
  4355. "schema": {
  4356. "type": "number",
  4357. "format": "double"
  4358. }
  4359. },
  4360. {
  4361. "name": "taskId",
  4362. "in": "path",
  4363. "description": "The id of the task",
  4364. "required": true,
  4365. "schema": {
  4366. "type": "integer",
  4367. "format": "int64"
  4368. }
  4369. },
  4370. {
  4371. "name": "OCS-APIRequest",
  4372. "in": "header",
  4373. "description": "Required to be true for the API request to pass",
  4374. "required": true,
  4375. "schema": {
  4376. "type": "boolean",
  4377. "default": true
  4378. }
  4379. }
  4380. ],
  4381. "responses": {
  4382. "200": {
  4383. "description": "Progress updated successfully",
  4384. "content": {
  4385. "application/json": {
  4386. "schema": {
  4387. "type": "object",
  4388. "required": [
  4389. "ocs"
  4390. ],
  4391. "properties": {
  4392. "ocs": {
  4393. "type": "object",
  4394. "required": [
  4395. "meta",
  4396. "data"
  4397. ],
  4398. "properties": {
  4399. "meta": {
  4400. "$ref": "#/components/schemas/OCSMeta"
  4401. },
  4402. "data": {
  4403. "type": "object",
  4404. "required": [
  4405. "task"
  4406. ],
  4407. "properties": {
  4408. "task": {
  4409. "$ref": "#/components/schemas/TaskProcessingTask"
  4410. }
  4411. }
  4412. }
  4413. }
  4414. }
  4415. }
  4416. }
  4417. }
  4418. }
  4419. },
  4420. "500": {
  4421. "description": "",
  4422. "content": {
  4423. "application/json": {
  4424. "schema": {
  4425. "type": "object",
  4426. "required": [
  4427. "ocs"
  4428. ],
  4429. "properties": {
  4430. "ocs": {
  4431. "type": "object",
  4432. "required": [
  4433. "meta",
  4434. "data"
  4435. ],
  4436. "properties": {
  4437. "meta": {
  4438. "$ref": "#/components/schemas/OCSMeta"
  4439. },
  4440. "data": {
  4441. "type": "object",
  4442. "required": [
  4443. "message"
  4444. ],
  4445. "properties": {
  4446. "message": {
  4447. "type": "string"
  4448. }
  4449. }
  4450. }
  4451. }
  4452. }
  4453. }
  4454. }
  4455. }
  4456. }
  4457. },
  4458. "404": {
  4459. "description": "Task not found",
  4460. "content": {
  4461. "application/json": {
  4462. "schema": {
  4463. "type": "object",
  4464. "required": [
  4465. "ocs"
  4466. ],
  4467. "properties": {
  4468. "ocs": {
  4469. "type": "object",
  4470. "required": [
  4471. "meta",
  4472. "data"
  4473. ],
  4474. "properties": {
  4475. "meta": {
  4476. "$ref": "#/components/schemas/OCSMeta"
  4477. },
  4478. "data": {
  4479. "type": "object",
  4480. "required": [
  4481. "message"
  4482. ],
  4483. "properties": {
  4484. "message": {
  4485. "type": "string"
  4486. }
  4487. }
  4488. }
  4489. }
  4490. }
  4491. }
  4492. }
  4493. }
  4494. }
  4495. }
  4496. }
  4497. }
  4498. },
  4499. "/ocs/v2.php/taskprocessing/tasks/{taskId}/result": {
  4500. "post": {
  4501. "operationId": "task_processing_api-set-result",
  4502. "summary": "Sets the task result",
  4503. "tags": [
  4504. "task_processing_api"
  4505. ],
  4506. "security": [
  4507. {
  4508. "bearer_auth": []
  4509. },
  4510. {
  4511. "basic_auth": []
  4512. }
  4513. ],
  4514. "parameters": [
  4515. {
  4516. "name": "output",
  4517. "in": "query",
  4518. "description": "The resulting task output",
  4519. "schema": {
  4520. "type": "string",
  4521. "nullable": true
  4522. }
  4523. },
  4524. {
  4525. "name": "errorMessage",
  4526. "in": "query",
  4527. "description": "An error message if the task failed",
  4528. "schema": {
  4529. "type": "string",
  4530. "nullable": true
  4531. }
  4532. },
  4533. {
  4534. "name": "taskId",
  4535. "in": "path",
  4536. "description": "The id of the task",
  4537. "required": true,
  4538. "schema": {
  4539. "type": "integer",
  4540. "format": "int64"
  4541. }
  4542. },
  4543. {
  4544. "name": "OCS-APIRequest",
  4545. "in": "header",
  4546. "description": "Required to be true for the API request to pass",
  4547. "required": true,
  4548. "schema": {
  4549. "type": "boolean",
  4550. "default": true
  4551. }
  4552. }
  4553. ],
  4554. "responses": {
  4555. "200": {
  4556. "description": "Result updated successfully",
  4557. "content": {
  4558. "application/json": {
  4559. "schema": {
  4560. "type": "object",
  4561. "required": [
  4562. "ocs"
  4563. ],
  4564. "properties": {
  4565. "ocs": {
  4566. "type": "object",
  4567. "required": [
  4568. "meta",
  4569. "data"
  4570. ],
  4571. "properties": {
  4572. "meta": {
  4573. "$ref": "#/components/schemas/OCSMeta"
  4574. },
  4575. "data": {
  4576. "type": "object",
  4577. "required": [
  4578. "task"
  4579. ],
  4580. "properties": {
  4581. "task": {
  4582. "$ref": "#/components/schemas/TaskProcessingTask"
  4583. }
  4584. }
  4585. }
  4586. }
  4587. }
  4588. }
  4589. }
  4590. }
  4591. }
  4592. },
  4593. "500": {
  4594. "description": "",
  4595. "content": {
  4596. "application/json": {
  4597. "schema": {
  4598. "type": "object",
  4599. "required": [
  4600. "ocs"
  4601. ],
  4602. "properties": {
  4603. "ocs": {
  4604. "type": "object",
  4605. "required": [
  4606. "meta",
  4607. "data"
  4608. ],
  4609. "properties": {
  4610. "meta": {
  4611. "$ref": "#/components/schemas/OCSMeta"
  4612. },
  4613. "data": {
  4614. "type": "object",
  4615. "required": [
  4616. "message"
  4617. ],
  4618. "properties": {
  4619. "message": {
  4620. "type": "string"
  4621. }
  4622. }
  4623. }
  4624. }
  4625. }
  4626. }
  4627. }
  4628. }
  4629. }
  4630. },
  4631. "404": {
  4632. "description": "Task not found",
  4633. "content": {
  4634. "application/json": {
  4635. "schema": {
  4636. "type": "object",
  4637. "required": [
  4638. "ocs"
  4639. ],
  4640. "properties": {
  4641. "ocs": {
  4642. "type": "object",
  4643. "required": [
  4644. "meta",
  4645. "data"
  4646. ],
  4647. "properties": {
  4648. "meta": {
  4649. "$ref": "#/components/schemas/OCSMeta"
  4650. },
  4651. "data": {
  4652. "type": "object",
  4653. "required": [
  4654. "message"
  4655. ],
  4656. "properties": {
  4657. "message": {
  4658. "type": "string"
  4659. }
  4660. }
  4661. }
  4662. }
  4663. }
  4664. }
  4665. }
  4666. }
  4667. }
  4668. }
  4669. }
  4670. }
  4671. },
  4672. "/ocs/v2.php/taskprocessing/tasks/{taskId}/cancel": {
  4673. "post": {
  4674. "operationId": "task_processing_api-cancel-task",
  4675. "summary": "Cancels a task",
  4676. "tags": [
  4677. "task_processing_api"
  4678. ],
  4679. "security": [
  4680. {
  4681. "bearer_auth": []
  4682. },
  4683. {
  4684. "basic_auth": []
  4685. }
  4686. ],
  4687. "parameters": [
  4688. {
  4689. "name": "taskId",
  4690. "in": "path",
  4691. "description": "The id of the task",
  4692. "required": true,
  4693. "schema": {
  4694. "type": "integer",
  4695. "format": "int64"
  4696. }
  4697. },
  4698. {
  4699. "name": "OCS-APIRequest",
  4700. "in": "header",
  4701. "description": "Required to be true for the API request to pass",
  4702. "required": true,
  4703. "schema": {
  4704. "type": "boolean",
  4705. "default": true
  4706. }
  4707. }
  4708. ],
  4709. "responses": {
  4710. "200": {
  4711. "description": "Task canceled successfully",
  4712. "content": {
  4713. "application/json": {
  4714. "schema": {
  4715. "type": "object",
  4716. "required": [
  4717. "ocs"
  4718. ],
  4719. "properties": {
  4720. "ocs": {
  4721. "type": "object",
  4722. "required": [
  4723. "meta",
  4724. "data"
  4725. ],
  4726. "properties": {
  4727. "meta": {
  4728. "$ref": "#/components/schemas/OCSMeta"
  4729. },
  4730. "data": {
  4731. "type": "object",
  4732. "required": [
  4733. "task"
  4734. ],
  4735. "properties": {
  4736. "task": {
  4737. "$ref": "#/components/schemas/TaskProcessingTask"
  4738. }
  4739. }
  4740. }
  4741. }
  4742. }
  4743. }
  4744. }
  4745. }
  4746. }
  4747. },
  4748. "500": {
  4749. "description": "",
  4750. "content": {
  4751. "application/json": {
  4752. "schema": {
  4753. "type": "object",
  4754. "required": [
  4755. "ocs"
  4756. ],
  4757. "properties": {
  4758. "ocs": {
  4759. "type": "object",
  4760. "required": [
  4761. "meta",
  4762. "data"
  4763. ],
  4764. "properties": {
  4765. "meta": {
  4766. "$ref": "#/components/schemas/OCSMeta"
  4767. },
  4768. "data": {
  4769. "type": "object",
  4770. "required": [
  4771. "message"
  4772. ],
  4773. "properties": {
  4774. "message": {
  4775. "type": "string"
  4776. }
  4777. }
  4778. }
  4779. }
  4780. }
  4781. }
  4782. }
  4783. }
  4784. }
  4785. },
  4786. "404": {
  4787. "description": "Task not found",
  4788. "content": {
  4789. "application/json": {
  4790. "schema": {
  4791. "type": "object",
  4792. "required": [
  4793. "ocs"
  4794. ],
  4795. "properties": {
  4796. "ocs": {
  4797. "type": "object",
  4798. "required": [
  4799. "meta",
  4800. "data"
  4801. ],
  4802. "properties": {
  4803. "meta": {
  4804. "$ref": "#/components/schemas/OCSMeta"
  4805. },
  4806. "data": {
  4807. "type": "object",
  4808. "required": [
  4809. "message"
  4810. ],
  4811. "properties": {
  4812. "message": {
  4813. "type": "string"
  4814. }
  4815. }
  4816. }
  4817. }
  4818. }
  4819. }
  4820. }
  4821. }
  4822. }
  4823. }
  4824. }
  4825. }
  4826. },
  4827. "/ocs/v2.php/teams/{teamId}/resources": {
  4828. "get": {
  4829. "operationId": "teams_api-resolve-one",
  4830. "summary": "Get all resources of a team",
  4831. "tags": [
  4832. "teams_api"
  4833. ],
  4834. "security": [
  4835. {
  4836. "bearer_auth": []
  4837. },
  4838. {
  4839. "basic_auth": []
  4840. }
  4841. ],
  4842. "parameters": [
  4843. {
  4844. "name": "teamId",
  4845. "in": "path",
  4846. "description": "Unique id of the team",
  4847. "required": true,
  4848. "schema": {
  4849. "type": "string"
  4850. }
  4851. },
  4852. {
  4853. "name": "OCS-APIRequest",
  4854. "in": "header",
  4855. "description": "Required to be true for the API request to pass",
  4856. "required": true,
  4857. "schema": {
  4858. "type": "boolean",
  4859. "default": true
  4860. }
  4861. }
  4862. ],
  4863. "responses": {
  4864. "200": {
  4865. "description": "Resources returned",
  4866. "content": {
  4867. "application/json": {
  4868. "schema": {
  4869. "type": "object",
  4870. "required": [
  4871. "ocs"
  4872. ],
  4873. "properties": {
  4874. "ocs": {
  4875. "type": "object",
  4876. "required": [
  4877. "meta",
  4878. "data"
  4879. ],
  4880. "properties": {
  4881. "meta": {
  4882. "$ref": "#/components/schemas/OCSMeta"
  4883. },
  4884. "data": {
  4885. "type": "object",
  4886. "required": [
  4887. "resources"
  4888. ],
  4889. "properties": {
  4890. "resources": {
  4891. "type": "array",
  4892. "items": {
  4893. "$ref": "#/components/schemas/TeamResource"
  4894. }
  4895. }
  4896. }
  4897. }
  4898. }
  4899. }
  4900. }
  4901. }
  4902. }
  4903. }
  4904. }
  4905. }
  4906. }
  4907. },
  4908. "/ocs/v2.php/teams/resources/{providerId}/{resourceId}": {
  4909. "get": {
  4910. "operationId": "teams_api-list-teams",
  4911. "summary": "Get all teams of a resource",
  4912. "tags": [
  4913. "teams_api"
  4914. ],
  4915. "security": [
  4916. {
  4917. "bearer_auth": []
  4918. },
  4919. {
  4920. "basic_auth": []
  4921. }
  4922. ],
  4923. "parameters": [
  4924. {
  4925. "name": "providerId",
  4926. "in": "path",
  4927. "description": "Identifier of the provider (e.g. deck, talk, collectives)",
  4928. "required": true,
  4929. "schema": {
  4930. "type": "string"
  4931. }
  4932. },
  4933. {
  4934. "name": "resourceId",
  4935. "in": "path",
  4936. "description": "Unique id of the resource to list teams for (e.g. deck board id)",
  4937. "required": true,
  4938. "schema": {
  4939. "type": "string"
  4940. }
  4941. },
  4942. {
  4943. "name": "OCS-APIRequest",
  4944. "in": "header",
  4945. "description": "Required to be true for the API request to pass",
  4946. "required": true,
  4947. "schema": {
  4948. "type": "boolean",
  4949. "default": true
  4950. }
  4951. }
  4952. ],
  4953. "responses": {
  4954. "200": {
  4955. "description": "Teams returned",
  4956. "content": {
  4957. "application/json": {
  4958. "schema": {
  4959. "type": "object",
  4960. "required": [
  4961. "ocs"
  4962. ],
  4963. "properties": {
  4964. "ocs": {
  4965. "type": "object",
  4966. "required": [
  4967. "meta",
  4968. "data"
  4969. ],
  4970. "properties": {
  4971. "meta": {
  4972. "$ref": "#/components/schemas/OCSMeta"
  4973. },
  4974. "data": {
  4975. "type": "object",
  4976. "required": [
  4977. "teams"
  4978. ],
  4979. "properties": {
  4980. "teams": {
  4981. "type": "array",
  4982. "items": {
  4983. "$ref": "#/components/schemas/Team"
  4984. }
  4985. }
  4986. }
  4987. }
  4988. }
  4989. }
  4990. }
  4991. }
  4992. }
  4993. }
  4994. }
  4995. }
  4996. }
  4997. },
  4998. "/ocs/v2.php/textprocessing/tasktypes": {
  4999. "get": {
  5000. "operationId": "text_processing_api-task-types",
  5001. "summary": "This endpoint returns all available LanguageModel task types",
  5002. "tags": [
  5003. "text_processing_api"
  5004. ],
  5005. "security": [
  5006. {},
  5007. {
  5008. "bearer_auth": []
  5009. },
  5010. {
  5011. "basic_auth": []
  5012. }
  5013. ],
  5014. "parameters": [
  5015. {
  5016. "name": "OCS-APIRequest",
  5017. "in": "header",
  5018. "description": "Required to be true for the API request to pass",
  5019. "required": true,
  5020. "schema": {
  5021. "type": "boolean",
  5022. "default": true
  5023. }
  5024. }
  5025. ],
  5026. "responses": {
  5027. "200": {
  5028. "description": "Task types returned",
  5029. "content": {
  5030. "application/json": {
  5031. "schema": {
  5032. "type": "object",
  5033. "required": [
  5034. "ocs"
  5035. ],
  5036. "properties": {
  5037. "ocs": {
  5038. "type": "object",
  5039. "required": [
  5040. "meta",
  5041. "data"
  5042. ],
  5043. "properties": {
  5044. "meta": {
  5045. "$ref": "#/components/schemas/OCSMeta"
  5046. },
  5047. "data": {
  5048. "type": "object",
  5049. "required": [
  5050. "types"
  5051. ],
  5052. "properties": {
  5053. "types": {
  5054. "type": "array",
  5055. "items": {
  5056. "type": "object",
  5057. "required": [
  5058. "id",
  5059. "name",
  5060. "description"
  5061. ],
  5062. "properties": {
  5063. "id": {
  5064. "type": "string"
  5065. },
  5066. "name": {
  5067. "type": "string"
  5068. },
  5069. "description": {
  5070. "type": "string"
  5071. }
  5072. }
  5073. }
  5074. }
  5075. }
  5076. }
  5077. }
  5078. }
  5079. }
  5080. }
  5081. }
  5082. }
  5083. }
  5084. }
  5085. }
  5086. },
  5087. "/ocs/v2.php/textprocessing/schedule": {
  5088. "post": {
  5089. "operationId": "text_processing_api-schedule",
  5090. "summary": "This endpoint allows scheduling a language model task",
  5091. "tags": [
  5092. "text_processing_api"
  5093. ],
  5094. "security": [
  5095. {},
  5096. {
  5097. "bearer_auth": []
  5098. },
  5099. {
  5100. "basic_auth": []
  5101. }
  5102. ],
  5103. "parameters": [
  5104. {
  5105. "name": "input",
  5106. "in": "query",
  5107. "description": "Input text",
  5108. "required": true,
  5109. "schema": {
  5110. "type": "string"
  5111. }
  5112. },
  5113. {
  5114. "name": "type",
  5115. "in": "query",
  5116. "description": "Type of the task",
  5117. "required": true,
  5118. "schema": {
  5119. "type": "string"
  5120. }
  5121. },
  5122. {
  5123. "name": "appId",
  5124. "in": "query",
  5125. "description": "ID of the app that will execute the task",
  5126. "required": true,
  5127. "schema": {
  5128. "type": "string"
  5129. }
  5130. },
  5131. {
  5132. "name": "identifier",
  5133. "in": "query",
  5134. "description": "An arbitrary identifier for the task",
  5135. "schema": {
  5136. "type": "string",
  5137. "default": ""
  5138. }
  5139. },
  5140. {
  5141. "name": "OCS-APIRequest",
  5142. "in": "header",
  5143. "description": "Required to be true for the API request to pass",
  5144. "required": true,
  5145. "schema": {
  5146. "type": "boolean",
  5147. "default": true
  5148. }
  5149. }
  5150. ],
  5151. "responses": {
  5152. "200": {
  5153. "description": "Task scheduled successfully",
  5154. "content": {
  5155. "application/json": {
  5156. "schema": {
  5157. "type": "object",
  5158. "required": [
  5159. "ocs"
  5160. ],
  5161. "properties": {
  5162. "ocs": {
  5163. "type": "object",
  5164. "required": [
  5165. "meta",
  5166. "data"
  5167. ],
  5168. "properties": {
  5169. "meta": {
  5170. "$ref": "#/components/schemas/OCSMeta"
  5171. },
  5172. "data": {
  5173. "type": "object",
  5174. "required": [
  5175. "task"
  5176. ],
  5177. "properties": {
  5178. "task": {
  5179. "$ref": "#/components/schemas/TextProcessingTask"
  5180. }
  5181. }
  5182. }
  5183. }
  5184. }
  5185. }
  5186. }
  5187. }
  5188. }
  5189. },
  5190. "500": {
  5191. "description": "",
  5192. "content": {
  5193. "application/json": {
  5194. "schema": {
  5195. "type": "object",
  5196. "required": [
  5197. "ocs"
  5198. ],
  5199. "properties": {
  5200. "ocs": {
  5201. "type": "object",
  5202. "required": [
  5203. "meta",
  5204. "data"
  5205. ],
  5206. "properties": {
  5207. "meta": {
  5208. "$ref": "#/components/schemas/OCSMeta"
  5209. },
  5210. "data": {
  5211. "type": "object",
  5212. "required": [
  5213. "message"
  5214. ],
  5215. "properties": {
  5216. "message": {
  5217. "type": "string"
  5218. }
  5219. }
  5220. }
  5221. }
  5222. }
  5223. }
  5224. }
  5225. }
  5226. }
  5227. },
  5228. "400": {
  5229. "description": "Scheduling task is not possible",
  5230. "content": {
  5231. "application/json": {
  5232. "schema": {
  5233. "type": "object",
  5234. "required": [
  5235. "ocs"
  5236. ],
  5237. "properties": {
  5238. "ocs": {
  5239. "type": "object",
  5240. "required": [
  5241. "meta",
  5242. "data"
  5243. ],
  5244. "properties": {
  5245. "meta": {
  5246. "$ref": "#/components/schemas/OCSMeta"
  5247. },
  5248. "data": {
  5249. "type": "object",
  5250. "required": [
  5251. "message"
  5252. ],
  5253. "properties": {
  5254. "message": {
  5255. "type": "string"
  5256. }
  5257. }
  5258. }
  5259. }
  5260. }
  5261. }
  5262. }
  5263. }
  5264. }
  5265. },
  5266. "412": {
  5267. "description": "Scheduling task is not possible",
  5268. "content": {
  5269. "application/json": {
  5270. "schema": {
  5271. "type": "object",
  5272. "required": [
  5273. "ocs"
  5274. ],
  5275. "properties": {
  5276. "ocs": {
  5277. "type": "object",
  5278. "required": [
  5279. "meta",
  5280. "data"
  5281. ],
  5282. "properties": {
  5283. "meta": {
  5284. "$ref": "#/components/schemas/OCSMeta"
  5285. },
  5286. "data": {
  5287. "type": "object",
  5288. "required": [
  5289. "message"
  5290. ],
  5291. "properties": {
  5292. "message": {
  5293. "type": "string"
  5294. }
  5295. }
  5296. }
  5297. }
  5298. }
  5299. }
  5300. }
  5301. }
  5302. }
  5303. }
  5304. }
  5305. }
  5306. },
  5307. "/ocs/v2.php/textprocessing/task/{id}": {
  5308. "get": {
  5309. "operationId": "text_processing_api-get-task",
  5310. "summary": "This endpoint allows checking the status and results of a task. Tasks are removed 1 week after receiving their last update.",
  5311. "tags": [
  5312. "text_processing_api"
  5313. ],
  5314. "security": [
  5315. {},
  5316. {
  5317. "bearer_auth": []
  5318. },
  5319. {
  5320. "basic_auth": []
  5321. }
  5322. ],
  5323. "parameters": [
  5324. {
  5325. "name": "id",
  5326. "in": "path",
  5327. "description": "The id of the task",
  5328. "required": true,
  5329. "schema": {
  5330. "type": "integer",
  5331. "format": "int64"
  5332. }
  5333. },
  5334. {
  5335. "name": "OCS-APIRequest",
  5336. "in": "header",
  5337. "description": "Required to be true for the API request to pass",
  5338. "required": true,
  5339. "schema": {
  5340. "type": "boolean",
  5341. "default": true
  5342. }
  5343. }
  5344. ],
  5345. "responses": {
  5346. "200": {
  5347. "description": "Task returned",
  5348. "content": {
  5349. "application/json": {
  5350. "schema": {
  5351. "type": "object",
  5352. "required": [
  5353. "ocs"
  5354. ],
  5355. "properties": {
  5356. "ocs": {
  5357. "type": "object",
  5358. "required": [
  5359. "meta",
  5360. "data"
  5361. ],
  5362. "properties": {
  5363. "meta": {
  5364. "$ref": "#/components/schemas/OCSMeta"
  5365. },
  5366. "data": {
  5367. "type": "object",
  5368. "required": [
  5369. "task"
  5370. ],
  5371. "properties": {
  5372. "task": {
  5373. "$ref": "#/components/schemas/TextProcessingTask"
  5374. }
  5375. }
  5376. }
  5377. }
  5378. }
  5379. }
  5380. }
  5381. }
  5382. }
  5383. },
  5384. "404": {
  5385. "description": "Task not found",
  5386. "content": {
  5387. "application/json": {
  5388. "schema": {
  5389. "type": "object",
  5390. "required": [
  5391. "ocs"
  5392. ],
  5393. "properties": {
  5394. "ocs": {
  5395. "type": "object",
  5396. "required": [
  5397. "meta",
  5398. "data"
  5399. ],
  5400. "properties": {
  5401. "meta": {
  5402. "$ref": "#/components/schemas/OCSMeta"
  5403. },
  5404. "data": {
  5405. "type": "object",
  5406. "required": [
  5407. "message"
  5408. ],
  5409. "properties": {
  5410. "message": {
  5411. "type": "string"
  5412. }
  5413. }
  5414. }
  5415. }
  5416. }
  5417. }
  5418. }
  5419. }
  5420. }
  5421. },
  5422. "500": {
  5423. "description": "",
  5424. "content": {
  5425. "application/json": {
  5426. "schema": {
  5427. "type": "object",
  5428. "required": [
  5429. "ocs"
  5430. ],
  5431. "properties": {
  5432. "ocs": {
  5433. "type": "object",
  5434. "required": [
  5435. "meta",
  5436. "data"
  5437. ],
  5438. "properties": {
  5439. "meta": {
  5440. "$ref": "#/components/schemas/OCSMeta"
  5441. },
  5442. "data": {
  5443. "type": "object",
  5444. "required": [
  5445. "message"
  5446. ],
  5447. "properties": {
  5448. "message": {
  5449. "type": "string"
  5450. }
  5451. }
  5452. }
  5453. }
  5454. }
  5455. }
  5456. }
  5457. }
  5458. }
  5459. }
  5460. }
  5461. },
  5462. "delete": {
  5463. "operationId": "text_processing_api-delete-task",
  5464. "summary": "This endpoint allows to delete a scheduled task for a user",
  5465. "tags": [
  5466. "text_processing_api"
  5467. ],
  5468. "security": [
  5469. {
  5470. "bearer_auth": []
  5471. },
  5472. {
  5473. "basic_auth": []
  5474. }
  5475. ],
  5476. "parameters": [
  5477. {
  5478. "name": "id",
  5479. "in": "path",
  5480. "description": "The id of the task",
  5481. "required": true,
  5482. "schema": {
  5483. "type": "integer",
  5484. "format": "int64"
  5485. }
  5486. },
  5487. {
  5488. "name": "OCS-APIRequest",
  5489. "in": "header",
  5490. "description": "Required to be true for the API request to pass",
  5491. "required": true,
  5492. "schema": {
  5493. "type": "boolean",
  5494. "default": true
  5495. }
  5496. }
  5497. ],
  5498. "responses": {
  5499. "200": {
  5500. "description": "Task returned",
  5501. "content": {
  5502. "application/json": {
  5503. "schema": {
  5504. "type": "object",
  5505. "required": [
  5506. "ocs"
  5507. ],
  5508. "properties": {
  5509. "ocs": {
  5510. "type": "object",
  5511. "required": [
  5512. "meta",
  5513. "data"
  5514. ],
  5515. "properties": {
  5516. "meta": {
  5517. "$ref": "#/components/schemas/OCSMeta"
  5518. },
  5519. "data": {
  5520. "type": "object",
  5521. "required": [
  5522. "task"
  5523. ],
  5524. "properties": {
  5525. "task": {
  5526. "$ref": "#/components/schemas/TextProcessingTask"
  5527. }
  5528. }
  5529. }
  5530. }
  5531. }
  5532. }
  5533. }
  5534. }
  5535. }
  5536. },
  5537. "404": {
  5538. "description": "Task not found",
  5539. "content": {
  5540. "application/json": {
  5541. "schema": {
  5542. "type": "object",
  5543. "required": [
  5544. "ocs"
  5545. ],
  5546. "properties": {
  5547. "ocs": {
  5548. "type": "object",
  5549. "required": [
  5550. "meta",
  5551. "data"
  5552. ],
  5553. "properties": {
  5554. "meta": {
  5555. "$ref": "#/components/schemas/OCSMeta"
  5556. },
  5557. "data": {
  5558. "type": "object",
  5559. "required": [
  5560. "message"
  5561. ],
  5562. "properties": {
  5563. "message": {
  5564. "type": "string"
  5565. }
  5566. }
  5567. }
  5568. }
  5569. }
  5570. }
  5571. }
  5572. }
  5573. }
  5574. },
  5575. "500": {
  5576. "description": "",
  5577. "content": {
  5578. "application/json": {
  5579. "schema": {
  5580. "type": "object",
  5581. "required": [
  5582. "ocs"
  5583. ],
  5584. "properties": {
  5585. "ocs": {
  5586. "type": "object",
  5587. "required": [
  5588. "meta",
  5589. "data"
  5590. ],
  5591. "properties": {
  5592. "meta": {
  5593. "$ref": "#/components/schemas/OCSMeta"
  5594. },
  5595. "data": {
  5596. "type": "object",
  5597. "required": [
  5598. "message"
  5599. ],
  5600. "properties": {
  5601. "message": {
  5602. "type": "string"
  5603. }
  5604. }
  5605. }
  5606. }
  5607. }
  5608. }
  5609. }
  5610. }
  5611. }
  5612. }
  5613. }
  5614. }
  5615. },
  5616. "/ocs/v2.php/textprocessing/tasks/app/{appId}": {
  5617. "get": {
  5618. "operationId": "text_processing_api-list-tasks-by-app",
  5619. "summary": "This endpoint returns a list of tasks of a user that are related with a specific appId and optionally with an identifier",
  5620. "tags": [
  5621. "text_processing_api"
  5622. ],
  5623. "security": [
  5624. {
  5625. "bearer_auth": []
  5626. },
  5627. {
  5628. "basic_auth": []
  5629. }
  5630. ],
  5631. "parameters": [
  5632. {
  5633. "name": "identifier",
  5634. "in": "query",
  5635. "description": "An arbitrary identifier for the task",
  5636. "schema": {
  5637. "type": "string",
  5638. "nullable": true
  5639. }
  5640. },
  5641. {
  5642. "name": "appId",
  5643. "in": "path",
  5644. "description": "ID of the app",
  5645. "required": true,
  5646. "schema": {
  5647. "type": "string"
  5648. }
  5649. },
  5650. {
  5651. "name": "OCS-APIRequest",
  5652. "in": "header",
  5653. "description": "Required to be true for the API request to pass",
  5654. "required": true,
  5655. "schema": {
  5656. "type": "boolean",
  5657. "default": true
  5658. }
  5659. }
  5660. ],
  5661. "responses": {
  5662. "200": {
  5663. "description": "Task list returned",
  5664. "content": {
  5665. "application/json": {
  5666. "schema": {
  5667. "type": "object",
  5668. "required": [
  5669. "ocs"
  5670. ],
  5671. "properties": {
  5672. "ocs": {
  5673. "type": "object",
  5674. "required": [
  5675. "meta",
  5676. "data"
  5677. ],
  5678. "properties": {
  5679. "meta": {
  5680. "$ref": "#/components/schemas/OCSMeta"
  5681. },
  5682. "data": {
  5683. "type": "object",
  5684. "required": [
  5685. "tasks"
  5686. ],
  5687. "properties": {
  5688. "tasks": {
  5689. "type": "array",
  5690. "items": {
  5691. "$ref": "#/components/schemas/TextProcessingTask"
  5692. }
  5693. }
  5694. }
  5695. }
  5696. }
  5697. }
  5698. }
  5699. }
  5700. }
  5701. }
  5702. },
  5703. "500": {
  5704. "description": "",
  5705. "content": {
  5706. "application/json": {
  5707. "schema": {
  5708. "type": "object",
  5709. "required": [
  5710. "ocs"
  5711. ],
  5712. "properties": {
  5713. "ocs": {
  5714. "type": "object",
  5715. "required": [
  5716. "meta",
  5717. "data"
  5718. ],
  5719. "properties": {
  5720. "meta": {
  5721. "$ref": "#/components/schemas/OCSMeta"
  5722. },
  5723. "data": {
  5724. "type": "object",
  5725. "required": [
  5726. "message"
  5727. ],
  5728. "properties": {
  5729. "message": {
  5730. "type": "string"
  5731. }
  5732. }
  5733. }
  5734. }
  5735. }
  5736. }
  5737. }
  5738. }
  5739. }
  5740. }
  5741. }
  5742. }
  5743. },
  5744. "/ocs/v2.php/text2image/is_available": {
  5745. "get": {
  5746. "operationId": "text_to_image_api-is-available",
  5747. "summary": "Check whether this feature is available",
  5748. "tags": [
  5749. "text_to_image_api"
  5750. ],
  5751. "security": [
  5752. {},
  5753. {
  5754. "bearer_auth": []
  5755. },
  5756. {
  5757. "basic_auth": []
  5758. }
  5759. ],
  5760. "parameters": [
  5761. {
  5762. "name": "OCS-APIRequest",
  5763. "in": "header",
  5764. "description": "Required to be true for the API request to pass",
  5765. "required": true,
  5766. "schema": {
  5767. "type": "boolean",
  5768. "default": true
  5769. }
  5770. }
  5771. ],
  5772. "responses": {
  5773. "200": {
  5774. "description": "Returns availability status",
  5775. "content": {
  5776. "application/json": {
  5777. "schema": {
  5778. "type": "object",
  5779. "required": [
  5780. "ocs"
  5781. ],
  5782. "properties": {
  5783. "ocs": {
  5784. "type": "object",
  5785. "required": [
  5786. "meta",
  5787. "data"
  5788. ],
  5789. "properties": {
  5790. "meta": {
  5791. "$ref": "#/components/schemas/OCSMeta"
  5792. },
  5793. "data": {
  5794. "type": "object",
  5795. "required": [
  5796. "isAvailable"
  5797. ],
  5798. "properties": {
  5799. "isAvailable": {
  5800. "type": "boolean"
  5801. }
  5802. }
  5803. }
  5804. }
  5805. }
  5806. }
  5807. }
  5808. }
  5809. }
  5810. }
  5811. }
  5812. }
  5813. },
  5814. "/ocs/v2.php/text2image/schedule": {
  5815. "post": {
  5816. "operationId": "text_to_image_api-schedule",
  5817. "summary": "This endpoint allows scheduling a text to image task",
  5818. "tags": [
  5819. "text_to_image_api"
  5820. ],
  5821. "security": [
  5822. {},
  5823. {
  5824. "bearer_auth": []
  5825. },
  5826. {
  5827. "basic_auth": []
  5828. }
  5829. ],
  5830. "parameters": [
  5831. {
  5832. "name": "input",
  5833. "in": "query",
  5834. "description": "Input text",
  5835. "required": true,
  5836. "schema": {
  5837. "type": "string"
  5838. }
  5839. },
  5840. {
  5841. "name": "appId",
  5842. "in": "query",
  5843. "description": "ID of the app that will execute the task",
  5844. "required": true,
  5845. "schema": {
  5846. "type": "string"
  5847. }
  5848. },
  5849. {
  5850. "name": "identifier",
  5851. "in": "query",
  5852. "description": "An arbitrary identifier for the task",
  5853. "schema": {
  5854. "type": "string",
  5855. "default": ""
  5856. }
  5857. },
  5858. {
  5859. "name": "numberOfImages",
  5860. "in": "query",
  5861. "description": "The number of images to generate",
  5862. "schema": {
  5863. "type": "integer",
  5864. "format": "int64",
  5865. "default": 8
  5866. }
  5867. },
  5868. {
  5869. "name": "OCS-APIRequest",
  5870. "in": "header",
  5871. "description": "Required to be true for the API request to pass",
  5872. "required": true,
  5873. "schema": {
  5874. "type": "boolean",
  5875. "default": true
  5876. }
  5877. }
  5878. ],
  5879. "responses": {
  5880. "200": {
  5881. "description": "Task scheduled successfully",
  5882. "content": {
  5883. "application/json": {
  5884. "schema": {
  5885. "type": "object",
  5886. "required": [
  5887. "ocs"
  5888. ],
  5889. "properties": {
  5890. "ocs": {
  5891. "type": "object",
  5892. "required": [
  5893. "meta",
  5894. "data"
  5895. ],
  5896. "properties": {
  5897. "meta": {
  5898. "$ref": "#/components/schemas/OCSMeta"
  5899. },
  5900. "data": {
  5901. "type": "object",
  5902. "required": [
  5903. "task"
  5904. ],
  5905. "properties": {
  5906. "task": {
  5907. "$ref": "#/components/schemas/TextToImageTask"
  5908. }
  5909. }
  5910. }
  5911. }
  5912. }
  5913. }
  5914. }
  5915. }
  5916. }
  5917. },
  5918. "412": {
  5919. "description": "Scheduling task is not possible",
  5920. "content": {
  5921. "application/json": {
  5922. "schema": {
  5923. "type": "object",
  5924. "required": [
  5925. "ocs"
  5926. ],
  5927. "properties": {
  5928. "ocs": {
  5929. "type": "object",
  5930. "required": [
  5931. "meta",
  5932. "data"
  5933. ],
  5934. "properties": {
  5935. "meta": {
  5936. "$ref": "#/components/schemas/OCSMeta"
  5937. },
  5938. "data": {
  5939. "type": "object",
  5940. "required": [
  5941. "message"
  5942. ],
  5943. "properties": {
  5944. "message": {
  5945. "type": "string"
  5946. }
  5947. }
  5948. }
  5949. }
  5950. }
  5951. }
  5952. }
  5953. }
  5954. }
  5955. },
  5956. "500": {
  5957. "description": "",
  5958. "content": {
  5959. "application/json": {
  5960. "schema": {
  5961. "type": "object",
  5962. "required": [
  5963. "ocs"
  5964. ],
  5965. "properties": {
  5966. "ocs": {
  5967. "type": "object",
  5968. "required": [
  5969. "meta",
  5970. "data"
  5971. ],
  5972. "properties": {
  5973. "meta": {
  5974. "$ref": "#/components/schemas/OCSMeta"
  5975. },
  5976. "data": {
  5977. "type": "object",
  5978. "required": [
  5979. "message"
  5980. ],
  5981. "properties": {
  5982. "message": {
  5983. "type": "string"
  5984. }
  5985. }
  5986. }
  5987. }
  5988. }
  5989. }
  5990. }
  5991. }
  5992. }
  5993. }
  5994. }
  5995. }
  5996. },
  5997. "/ocs/v2.php/text2image/task/{id}": {
  5998. "get": {
  5999. "operationId": "text_to_image_api-get-task",
  6000. "summary": "This endpoint allows checking the status and results of a task. Tasks are removed 1 week after receiving their last update.",
  6001. "tags": [
  6002. "text_to_image_api"
  6003. ],
  6004. "security": [
  6005. {},
  6006. {
  6007. "bearer_auth": []
  6008. },
  6009. {
  6010. "basic_auth": []
  6011. }
  6012. ],
  6013. "parameters": [
  6014. {
  6015. "name": "id",
  6016. "in": "path",
  6017. "description": "The id of the task",
  6018. "required": true,
  6019. "schema": {
  6020. "type": "integer",
  6021. "format": "int64"
  6022. }
  6023. },
  6024. {
  6025. "name": "OCS-APIRequest",
  6026. "in": "header",
  6027. "description": "Required to be true for the API request to pass",
  6028. "required": true,
  6029. "schema": {
  6030. "type": "boolean",
  6031. "default": true
  6032. }
  6033. }
  6034. ],
  6035. "responses": {
  6036. "200": {
  6037. "description": "Task returned",
  6038. "content": {
  6039. "application/json": {
  6040. "schema": {
  6041. "type": "object",
  6042. "required": [
  6043. "ocs"
  6044. ],
  6045. "properties": {
  6046. "ocs": {
  6047. "type": "object",
  6048. "required": [
  6049. "meta",
  6050. "data"
  6051. ],
  6052. "properties": {
  6053. "meta": {
  6054. "$ref": "#/components/schemas/OCSMeta"
  6055. },
  6056. "data": {
  6057. "type": "object",
  6058. "required": [
  6059. "task"
  6060. ],
  6061. "properties": {
  6062. "task": {
  6063. "$ref": "#/components/schemas/TextToImageTask"
  6064. }
  6065. }
  6066. }
  6067. }
  6068. }
  6069. }
  6070. }
  6071. }
  6072. }
  6073. },
  6074. "404": {
  6075. "description": "Task not found",
  6076. "content": {
  6077. "application/json": {
  6078. "schema": {
  6079. "type": "object",
  6080. "required": [
  6081. "ocs"
  6082. ],
  6083. "properties": {
  6084. "ocs": {
  6085. "type": "object",
  6086. "required": [
  6087. "meta",
  6088. "data"
  6089. ],
  6090. "properties": {
  6091. "meta": {
  6092. "$ref": "#/components/schemas/OCSMeta"
  6093. },
  6094. "data": {
  6095. "type": "object",
  6096. "required": [
  6097. "message"
  6098. ],
  6099. "properties": {
  6100. "message": {
  6101. "type": "string"
  6102. }
  6103. }
  6104. }
  6105. }
  6106. }
  6107. }
  6108. }
  6109. }
  6110. }
  6111. },
  6112. "500": {
  6113. "description": "",
  6114. "content": {
  6115. "application/json": {
  6116. "schema": {
  6117. "type": "object",
  6118. "required": [
  6119. "ocs"
  6120. ],
  6121. "properties": {
  6122. "ocs": {
  6123. "type": "object",
  6124. "required": [
  6125. "meta",
  6126. "data"
  6127. ],
  6128. "properties": {
  6129. "meta": {
  6130. "$ref": "#/components/schemas/OCSMeta"
  6131. },
  6132. "data": {
  6133. "type": "object",
  6134. "required": [
  6135. "message"
  6136. ],
  6137. "properties": {
  6138. "message": {
  6139. "type": "string"
  6140. }
  6141. }
  6142. }
  6143. }
  6144. }
  6145. }
  6146. }
  6147. }
  6148. }
  6149. }
  6150. }
  6151. },
  6152. "delete": {
  6153. "operationId": "text_to_image_api-delete-task",
  6154. "summary": "This endpoint allows to delete a scheduled task for a user",
  6155. "tags": [
  6156. "text_to_image_api"
  6157. ],
  6158. "security": [
  6159. {
  6160. "bearer_auth": []
  6161. },
  6162. {
  6163. "basic_auth": []
  6164. }
  6165. ],
  6166. "parameters": [
  6167. {
  6168. "name": "id",
  6169. "in": "path",
  6170. "description": "The id of the task",
  6171. "required": true,
  6172. "schema": {
  6173. "type": "integer",
  6174. "format": "int64"
  6175. }
  6176. },
  6177. {
  6178. "name": "OCS-APIRequest",
  6179. "in": "header",
  6180. "description": "Required to be true for the API request to pass",
  6181. "required": true,
  6182. "schema": {
  6183. "type": "boolean",
  6184. "default": true
  6185. }
  6186. }
  6187. ],
  6188. "responses": {
  6189. "200": {
  6190. "description": "Task returned",
  6191. "content": {
  6192. "application/json": {
  6193. "schema": {
  6194. "type": "object",
  6195. "required": [
  6196. "ocs"
  6197. ],
  6198. "properties": {
  6199. "ocs": {
  6200. "type": "object",
  6201. "required": [
  6202. "meta",
  6203. "data"
  6204. ],
  6205. "properties": {
  6206. "meta": {
  6207. "$ref": "#/components/schemas/OCSMeta"
  6208. },
  6209. "data": {
  6210. "type": "object",
  6211. "required": [
  6212. "task"
  6213. ],
  6214. "properties": {
  6215. "task": {
  6216. "$ref": "#/components/schemas/TextToImageTask"
  6217. }
  6218. }
  6219. }
  6220. }
  6221. }
  6222. }
  6223. }
  6224. }
  6225. }
  6226. },
  6227. "404": {
  6228. "description": "Task not found",
  6229. "content": {
  6230. "application/json": {
  6231. "schema": {
  6232. "type": "object",
  6233. "required": [
  6234. "ocs"
  6235. ],
  6236. "properties": {
  6237. "ocs": {
  6238. "type": "object",
  6239. "required": [
  6240. "meta",
  6241. "data"
  6242. ],
  6243. "properties": {
  6244. "meta": {
  6245. "$ref": "#/components/schemas/OCSMeta"
  6246. },
  6247. "data": {
  6248. "type": "object",
  6249. "required": [
  6250. "message"
  6251. ],
  6252. "properties": {
  6253. "message": {
  6254. "type": "string"
  6255. }
  6256. }
  6257. }
  6258. }
  6259. }
  6260. }
  6261. }
  6262. }
  6263. }
  6264. },
  6265. "500": {
  6266. "description": "",
  6267. "content": {
  6268. "application/json": {
  6269. "schema": {
  6270. "type": "object",
  6271. "required": [
  6272. "ocs"
  6273. ],
  6274. "properties": {
  6275. "ocs": {
  6276. "type": "object",
  6277. "required": [
  6278. "meta",
  6279. "data"
  6280. ],
  6281. "properties": {
  6282. "meta": {
  6283. "$ref": "#/components/schemas/OCSMeta"
  6284. },
  6285. "data": {
  6286. "type": "object",
  6287. "required": [
  6288. "message"
  6289. ],
  6290. "properties": {
  6291. "message": {
  6292. "type": "string"
  6293. }
  6294. }
  6295. }
  6296. }
  6297. }
  6298. }
  6299. }
  6300. }
  6301. }
  6302. }
  6303. }
  6304. }
  6305. },
  6306. "/ocs/v2.php/text2image/task/{id}/image/{index}": {
  6307. "get": {
  6308. "operationId": "text_to_image_api-get-image",
  6309. "summary": "This endpoint allows downloading the resulting image of a task",
  6310. "tags": [
  6311. "text_to_image_api"
  6312. ],
  6313. "security": [
  6314. {},
  6315. {
  6316. "bearer_auth": []
  6317. },
  6318. {
  6319. "basic_auth": []
  6320. }
  6321. ],
  6322. "parameters": [
  6323. {
  6324. "name": "id",
  6325. "in": "path",
  6326. "description": "The id of the task",
  6327. "required": true,
  6328. "schema": {
  6329. "type": "integer",
  6330. "format": "int64"
  6331. }
  6332. },
  6333. {
  6334. "name": "index",
  6335. "in": "path",
  6336. "description": "The index of the image to retrieve",
  6337. "required": true,
  6338. "schema": {
  6339. "type": "integer",
  6340. "format": "int64"
  6341. }
  6342. },
  6343. {
  6344. "name": "OCS-APIRequest",
  6345. "in": "header",
  6346. "description": "Required to be true for the API request to pass",
  6347. "required": true,
  6348. "schema": {
  6349. "type": "boolean",
  6350. "default": true
  6351. }
  6352. }
  6353. ],
  6354. "responses": {
  6355. "200": {
  6356. "description": "Image returned",
  6357. "content": {
  6358. "*/*": {
  6359. "schema": {
  6360. "type": "string",
  6361. "format": "binary"
  6362. }
  6363. }
  6364. }
  6365. },
  6366. "404": {
  6367. "description": "Task or image not found",
  6368. "content": {
  6369. "application/json": {
  6370. "schema": {
  6371. "type": "object",
  6372. "required": [
  6373. "ocs"
  6374. ],
  6375. "properties": {
  6376. "ocs": {
  6377. "type": "object",
  6378. "required": [
  6379. "meta",
  6380. "data"
  6381. ],
  6382. "properties": {
  6383. "meta": {
  6384. "$ref": "#/components/schemas/OCSMeta"
  6385. },
  6386. "data": {
  6387. "type": "object",
  6388. "required": [
  6389. "message"
  6390. ],
  6391. "properties": {
  6392. "message": {
  6393. "type": "string"
  6394. }
  6395. }
  6396. }
  6397. }
  6398. }
  6399. }
  6400. }
  6401. }
  6402. }
  6403. },
  6404. "500": {
  6405. "description": "",
  6406. "content": {
  6407. "application/json": {
  6408. "schema": {
  6409. "type": "object",
  6410. "required": [
  6411. "ocs"
  6412. ],
  6413. "properties": {
  6414. "ocs": {
  6415. "type": "object",
  6416. "required": [
  6417. "meta",
  6418. "data"
  6419. ],
  6420. "properties": {
  6421. "meta": {
  6422. "$ref": "#/components/schemas/OCSMeta"
  6423. },
  6424. "data": {
  6425. "type": "object",
  6426. "required": [
  6427. "message"
  6428. ],
  6429. "properties": {
  6430. "message": {
  6431. "type": "string"
  6432. }
  6433. }
  6434. }
  6435. }
  6436. }
  6437. }
  6438. }
  6439. }
  6440. }
  6441. }
  6442. }
  6443. }
  6444. },
  6445. "/ocs/v2.php/text2image/tasks/app/{appId}": {
  6446. "get": {
  6447. "operationId": "text_to_image_api-list-tasks-by-app",
  6448. "summary": "This endpoint returns a list of tasks of a user that are related with a specific appId and optionally with an identifier",
  6449. "tags": [
  6450. "text_to_image_api"
  6451. ],
  6452. "security": [
  6453. {
  6454. "bearer_auth": []
  6455. },
  6456. {
  6457. "basic_auth": []
  6458. }
  6459. ],
  6460. "parameters": [
  6461. {
  6462. "name": "identifier",
  6463. "in": "query",
  6464. "description": "An arbitrary identifier for the task",
  6465. "schema": {
  6466. "type": "string",
  6467. "nullable": true
  6468. }
  6469. },
  6470. {
  6471. "name": "appId",
  6472. "in": "path",
  6473. "description": "ID of the app",
  6474. "required": true,
  6475. "schema": {
  6476. "type": "string"
  6477. }
  6478. },
  6479. {
  6480. "name": "OCS-APIRequest",
  6481. "in": "header",
  6482. "description": "Required to be true for the API request to pass",
  6483. "required": true,
  6484. "schema": {
  6485. "type": "boolean",
  6486. "default": true
  6487. }
  6488. }
  6489. ],
  6490. "responses": {
  6491. "200": {
  6492. "description": "Task list returned",
  6493. "content": {
  6494. "application/json": {
  6495. "schema": {
  6496. "type": "object",
  6497. "required": [
  6498. "ocs"
  6499. ],
  6500. "properties": {
  6501. "ocs": {
  6502. "type": "object",
  6503. "required": [
  6504. "meta",
  6505. "data"
  6506. ],
  6507. "properties": {
  6508. "meta": {
  6509. "$ref": "#/components/schemas/OCSMeta"
  6510. },
  6511. "data": {
  6512. "type": "object",
  6513. "required": [
  6514. "tasks"
  6515. ],
  6516. "properties": {
  6517. "tasks": {
  6518. "type": "array",
  6519. "items": {
  6520. "$ref": "#/components/schemas/TextToImageTask"
  6521. }
  6522. }
  6523. }
  6524. }
  6525. }
  6526. }
  6527. }
  6528. }
  6529. }
  6530. }
  6531. },
  6532. "500": {
  6533. "description": "",
  6534. "content": {
  6535. "application/json": {
  6536. "schema": {
  6537. "type": "object",
  6538. "required": [
  6539. "ocs"
  6540. ],
  6541. "properties": {
  6542. "ocs": {
  6543. "type": "object",
  6544. "required": [
  6545. "meta",
  6546. "data"
  6547. ],
  6548. "properties": {
  6549. "meta": {
  6550. "$ref": "#/components/schemas/OCSMeta"
  6551. },
  6552. "data": {
  6553. "type": "object",
  6554. "required": [
  6555. "message"
  6556. ],
  6557. "properties": {
  6558. "message": {
  6559. "type": "string"
  6560. }
  6561. }
  6562. }
  6563. }
  6564. }
  6565. }
  6566. }
  6567. }
  6568. }
  6569. }
  6570. }
  6571. }
  6572. },
  6573. "/ocs/v2.php/translation/languages": {
  6574. "get": {
  6575. "operationId": "translation_api-languages",
  6576. "summary": "Get the list of supported languages",
  6577. "tags": [
  6578. "translation_api"
  6579. ],
  6580. "security": [
  6581. {},
  6582. {
  6583. "bearer_auth": []
  6584. },
  6585. {
  6586. "basic_auth": []
  6587. }
  6588. ],
  6589. "parameters": [
  6590. {
  6591. "name": "OCS-APIRequest",
  6592. "in": "header",
  6593. "description": "Required to be true for the API request to pass",
  6594. "required": true,
  6595. "schema": {
  6596. "type": "boolean",
  6597. "default": true
  6598. }
  6599. }
  6600. ],
  6601. "responses": {
  6602. "200": {
  6603. "description": "Supported languages returned",
  6604. "content": {
  6605. "application/json": {
  6606. "schema": {
  6607. "type": "object",
  6608. "required": [
  6609. "ocs"
  6610. ],
  6611. "properties": {
  6612. "ocs": {
  6613. "type": "object",
  6614. "required": [
  6615. "meta",
  6616. "data"
  6617. ],
  6618. "properties": {
  6619. "meta": {
  6620. "$ref": "#/components/schemas/OCSMeta"
  6621. },
  6622. "data": {
  6623. "type": "object",
  6624. "required": [
  6625. "languages",
  6626. "languageDetection"
  6627. ],
  6628. "properties": {
  6629. "languages": {
  6630. "type": "array",
  6631. "items": {
  6632. "type": "object",
  6633. "required": [
  6634. "from",
  6635. "fromLabel",
  6636. "to",
  6637. "toLabel"
  6638. ],
  6639. "properties": {
  6640. "from": {
  6641. "type": "string"
  6642. },
  6643. "fromLabel": {
  6644. "type": "string"
  6645. },
  6646. "to": {
  6647. "type": "string"
  6648. },
  6649. "toLabel": {
  6650. "type": "string"
  6651. }
  6652. }
  6653. }
  6654. },
  6655. "languageDetection": {
  6656. "type": "boolean"
  6657. }
  6658. }
  6659. }
  6660. }
  6661. }
  6662. }
  6663. }
  6664. }
  6665. }
  6666. }
  6667. }
  6668. }
  6669. },
  6670. "/ocs/v2.php/translation/translate": {
  6671. "post": {
  6672. "operationId": "translation_api-translate",
  6673. "summary": "Translate a text",
  6674. "tags": [
  6675. "translation_api"
  6676. ],
  6677. "security": [
  6678. {},
  6679. {
  6680. "bearer_auth": []
  6681. },
  6682. {
  6683. "basic_auth": []
  6684. }
  6685. ],
  6686. "parameters": [
  6687. {
  6688. "name": "text",
  6689. "in": "query",
  6690. "description": "Text to be translated",
  6691. "required": true,
  6692. "schema": {
  6693. "type": "string"
  6694. }
  6695. },
  6696. {
  6697. "name": "fromLanguage",
  6698. "in": "query",
  6699. "description": "Language to translate from",
  6700. "schema": {
  6701. "type": "string",
  6702. "nullable": true
  6703. }
  6704. },
  6705. {
  6706. "name": "toLanguage",
  6707. "in": "query",
  6708. "description": "Language to translate to",
  6709. "required": true,
  6710. "schema": {
  6711. "type": "string"
  6712. }
  6713. },
  6714. {
  6715. "name": "OCS-APIRequest",
  6716. "in": "header",
  6717. "description": "Required to be true for the API request to pass",
  6718. "required": true,
  6719. "schema": {
  6720. "type": "boolean",
  6721. "default": true
  6722. }
  6723. }
  6724. ],
  6725. "responses": {
  6726. "200": {
  6727. "description": "Translated text returned",
  6728. "content": {
  6729. "application/json": {
  6730. "schema": {
  6731. "type": "object",
  6732. "required": [
  6733. "ocs"
  6734. ],
  6735. "properties": {
  6736. "ocs": {
  6737. "type": "object",
  6738. "required": [
  6739. "meta",
  6740. "data"
  6741. ],
  6742. "properties": {
  6743. "meta": {
  6744. "$ref": "#/components/schemas/OCSMeta"
  6745. },
  6746. "data": {
  6747. "type": "object",
  6748. "required": [
  6749. "text",
  6750. "from"
  6751. ],
  6752. "properties": {
  6753. "text": {
  6754. "type": "string"
  6755. },
  6756. "from": {
  6757. "type": "string",
  6758. "nullable": true
  6759. }
  6760. }
  6761. }
  6762. }
  6763. }
  6764. }
  6765. }
  6766. }
  6767. }
  6768. },
  6769. "400": {
  6770. "description": "Language not detected or unable to translate",
  6771. "content": {
  6772. "application/json": {
  6773. "schema": {
  6774. "type": "object",
  6775. "required": [
  6776. "ocs"
  6777. ],
  6778. "properties": {
  6779. "ocs": {
  6780. "type": "object",
  6781. "required": [
  6782. "meta",
  6783. "data"
  6784. ],
  6785. "properties": {
  6786. "meta": {
  6787. "$ref": "#/components/schemas/OCSMeta"
  6788. },
  6789. "data": {
  6790. "type": "object",
  6791. "required": [
  6792. "message"
  6793. ],
  6794. "properties": {
  6795. "message": {
  6796. "type": "string"
  6797. },
  6798. "from": {
  6799. "type": "string",
  6800. "nullable": true
  6801. }
  6802. }
  6803. }
  6804. }
  6805. }
  6806. }
  6807. }
  6808. }
  6809. }
  6810. },
  6811. "412": {
  6812. "description": "Translating is not possible",
  6813. "content": {
  6814. "application/json": {
  6815. "schema": {
  6816. "type": "object",
  6817. "required": [
  6818. "ocs"
  6819. ],
  6820. "properties": {
  6821. "ocs": {
  6822. "type": "object",
  6823. "required": [
  6824. "meta",
  6825. "data"
  6826. ],
  6827. "properties": {
  6828. "meta": {
  6829. "$ref": "#/components/schemas/OCSMeta"
  6830. },
  6831. "data": {
  6832. "type": "object",
  6833. "required": [
  6834. "message"
  6835. ],
  6836. "properties": {
  6837. "message": {
  6838. "type": "string"
  6839. },
  6840. "from": {
  6841. "type": "string",
  6842. "nullable": true
  6843. }
  6844. }
  6845. }
  6846. }
  6847. }
  6848. }
  6849. }
  6850. }
  6851. }
  6852. },
  6853. "500": {
  6854. "description": "",
  6855. "content": {
  6856. "application/json": {
  6857. "schema": {
  6858. "type": "object",
  6859. "required": [
  6860. "ocs"
  6861. ],
  6862. "properties": {
  6863. "ocs": {
  6864. "type": "object",
  6865. "required": [
  6866. "meta",
  6867. "data"
  6868. ],
  6869. "properties": {
  6870. "meta": {
  6871. "$ref": "#/components/schemas/OCSMeta"
  6872. },
  6873. "data": {
  6874. "type": "object",
  6875. "required": [
  6876. "message"
  6877. ],
  6878. "properties": {
  6879. "message": {
  6880. "type": "string"
  6881. },
  6882. "from": {
  6883. "type": "string",
  6884. "nullable": true
  6885. }
  6886. }
  6887. }
  6888. }
  6889. }
  6890. }
  6891. }
  6892. }
  6893. }
  6894. }
  6895. }
  6896. }
  6897. },
  6898. "/ocs/v2.php/search/providers": {
  6899. "get": {
  6900. "operationId": "unified_search-get-providers",
  6901. "summary": "Get the providers for unified search",
  6902. "tags": [
  6903. "unified_search"
  6904. ],
  6905. "security": [
  6906. {
  6907. "bearer_auth": []
  6908. },
  6909. {
  6910. "basic_auth": []
  6911. }
  6912. ],
  6913. "parameters": [
  6914. {
  6915. "name": "from",
  6916. "in": "query",
  6917. "description": "the url the user is currently at",
  6918. "schema": {
  6919. "type": "string",
  6920. "default": ""
  6921. }
  6922. },
  6923. {
  6924. "name": "OCS-APIRequest",
  6925. "in": "header",
  6926. "description": "Required to be true for the API request to pass",
  6927. "required": true,
  6928. "schema": {
  6929. "type": "boolean",
  6930. "default": true
  6931. }
  6932. }
  6933. ],
  6934. "responses": {
  6935. "200": {
  6936. "description": "Providers returned",
  6937. "content": {
  6938. "application/json": {
  6939. "schema": {
  6940. "type": "object",
  6941. "required": [
  6942. "ocs"
  6943. ],
  6944. "properties": {
  6945. "ocs": {
  6946. "type": "object",
  6947. "required": [
  6948. "meta",
  6949. "data"
  6950. ],
  6951. "properties": {
  6952. "meta": {
  6953. "$ref": "#/components/schemas/OCSMeta"
  6954. },
  6955. "data": {
  6956. "type": "array",
  6957. "items": {
  6958. "$ref": "#/components/schemas/UnifiedSearchProvider"
  6959. }
  6960. }
  6961. }
  6962. }
  6963. }
  6964. }
  6965. }
  6966. }
  6967. }
  6968. }
  6969. }
  6970. },
  6971. "/ocs/v2.php/search/providers/{providerId}/search": {
  6972. "get": {
  6973. "operationId": "unified_search-search",
  6974. "summary": "Launch a search for a specific search provider.",
  6975. "description": "Additional filters are available for each provider. Send a request to /providers endpoint to list providers with their available filters.",
  6976. "tags": [
  6977. "unified_search"
  6978. ],
  6979. "security": [
  6980. {
  6981. "bearer_auth": []
  6982. },
  6983. {
  6984. "basic_auth": []
  6985. }
  6986. ],
  6987. "parameters": [
  6988. {
  6989. "name": "term",
  6990. "in": "query",
  6991. "description": "Term to search",
  6992. "schema": {
  6993. "type": "string",
  6994. "default": ""
  6995. }
  6996. },
  6997. {
  6998. "name": "sortOrder",
  6999. "in": "query",
  7000. "description": "Order of entries",
  7001. "schema": {
  7002. "type": "integer",
  7003. "format": "int64",
  7004. "nullable": true
  7005. }
  7006. },
  7007. {
  7008. "name": "limit",
  7009. "in": "query",
  7010. "description": "Maximum amount of entries, limited to 25",
  7011. "schema": {
  7012. "type": "integer",
  7013. "format": "int64",
  7014. "nullable": true
  7015. }
  7016. },
  7017. {
  7018. "name": "cursor",
  7019. "in": "query",
  7020. "description": "Offset for searching",
  7021. "schema": {
  7022. "nullable": true,
  7023. "oneOf": [
  7024. {
  7025. "type": "integer",
  7026. "format": "int64"
  7027. },
  7028. {
  7029. "type": "string"
  7030. }
  7031. ]
  7032. }
  7033. },
  7034. {
  7035. "name": "from",
  7036. "in": "query",
  7037. "description": "The current user URL",
  7038. "schema": {
  7039. "type": "string",
  7040. "default": ""
  7041. }
  7042. },
  7043. {
  7044. "name": "providerId",
  7045. "in": "path",
  7046. "description": "ID of the provider",
  7047. "required": true,
  7048. "schema": {
  7049. "type": "string"
  7050. }
  7051. },
  7052. {
  7053. "name": "OCS-APIRequest",
  7054. "in": "header",
  7055. "description": "Required to be true for the API request to pass",
  7056. "required": true,
  7057. "schema": {
  7058. "type": "boolean",
  7059. "default": true
  7060. }
  7061. }
  7062. ],
  7063. "responses": {
  7064. "200": {
  7065. "description": "Search entries returned",
  7066. "content": {
  7067. "application/json": {
  7068. "schema": {
  7069. "type": "object",
  7070. "required": [
  7071. "ocs"
  7072. ],
  7073. "properties": {
  7074. "ocs": {
  7075. "type": "object",
  7076. "required": [
  7077. "meta",
  7078. "data"
  7079. ],
  7080. "properties": {
  7081. "meta": {
  7082. "$ref": "#/components/schemas/OCSMeta"
  7083. },
  7084. "data": {
  7085. "$ref": "#/components/schemas/UnifiedSearchResult"
  7086. }
  7087. }
  7088. }
  7089. }
  7090. }
  7091. }
  7092. }
  7093. },
  7094. "400": {
  7095. "description": "Searching is not possible",
  7096. "content": {
  7097. "application/json": {
  7098. "schema": {
  7099. "type": "object",
  7100. "required": [
  7101. "ocs"
  7102. ],
  7103. "properties": {
  7104. "ocs": {
  7105. "type": "object",
  7106. "required": [
  7107. "meta",
  7108. "data"
  7109. ],
  7110. "properties": {
  7111. "meta": {
  7112. "$ref": "#/components/schemas/OCSMeta"
  7113. },
  7114. "data": {
  7115. "type": "string"
  7116. }
  7117. }
  7118. }
  7119. }
  7120. }
  7121. }
  7122. }
  7123. }
  7124. }
  7125. }
  7126. },
  7127. "/ocs/v2.php/core/whatsnew": {
  7128. "get": {
  7129. "operationId": "whats_new-get",
  7130. "summary": "Get the changes",
  7131. "tags": [
  7132. "whats_new"
  7133. ],
  7134. "security": [
  7135. {
  7136. "bearer_auth": []
  7137. },
  7138. {
  7139. "basic_auth": []
  7140. }
  7141. ],
  7142. "parameters": [
  7143. {
  7144. "name": "OCS-APIRequest",
  7145. "in": "header",
  7146. "description": "Required to be true for the API request to pass",
  7147. "required": true,
  7148. "schema": {
  7149. "type": "boolean",
  7150. "default": true
  7151. }
  7152. }
  7153. ],
  7154. "responses": {
  7155. "200": {
  7156. "description": "Changes returned",
  7157. "content": {
  7158. "application/json": {
  7159. "schema": {
  7160. "type": "object",
  7161. "required": [
  7162. "ocs"
  7163. ],
  7164. "properties": {
  7165. "ocs": {
  7166. "type": "object",
  7167. "required": [
  7168. "meta",
  7169. "data"
  7170. ],
  7171. "properties": {
  7172. "meta": {
  7173. "$ref": "#/components/schemas/OCSMeta"
  7174. },
  7175. "data": {
  7176. "type": "object",
  7177. "required": [
  7178. "changelogURL",
  7179. "product",
  7180. "version"
  7181. ],
  7182. "properties": {
  7183. "changelogURL": {
  7184. "type": "string"
  7185. },
  7186. "product": {
  7187. "type": "string"
  7188. },
  7189. "version": {
  7190. "type": "string"
  7191. },
  7192. "whatsNew": {
  7193. "type": "object",
  7194. "required": [
  7195. "regular",
  7196. "admin"
  7197. ],
  7198. "properties": {
  7199. "regular": {
  7200. "type": "array",
  7201. "items": {
  7202. "type": "string"
  7203. }
  7204. },
  7205. "admin": {
  7206. "type": "array",
  7207. "items": {
  7208. "type": "string"
  7209. }
  7210. }
  7211. }
  7212. }
  7213. }
  7214. }
  7215. }
  7216. }
  7217. }
  7218. }
  7219. }
  7220. }
  7221. },
  7222. "204": {
  7223. "description": "No changes"
  7224. }
  7225. }
  7226. },
  7227. "post": {
  7228. "operationId": "whats_new-dismiss",
  7229. "summary": "Dismiss the changes",
  7230. "tags": [
  7231. "whats_new"
  7232. ],
  7233. "security": [
  7234. {
  7235. "bearer_auth": []
  7236. },
  7237. {
  7238. "basic_auth": []
  7239. }
  7240. ],
  7241. "parameters": [
  7242. {
  7243. "name": "version",
  7244. "in": "query",
  7245. "description": "Version to dismiss the changes for",
  7246. "required": true,
  7247. "schema": {
  7248. "type": "string"
  7249. }
  7250. },
  7251. {
  7252. "name": "OCS-APIRequest",
  7253. "in": "header",
  7254. "description": "Required to be true for the API request to pass",
  7255. "required": true,
  7256. "schema": {
  7257. "type": "boolean",
  7258. "default": true
  7259. }
  7260. }
  7261. ],
  7262. "responses": {
  7263. "200": {
  7264. "description": "Changes dismissed",
  7265. "content": {
  7266. "application/json": {
  7267. "schema": {
  7268. "type": "object",
  7269. "required": [
  7270. "ocs"
  7271. ],
  7272. "properties": {
  7273. "ocs": {
  7274. "type": "object",
  7275. "required": [
  7276. "meta",
  7277. "data"
  7278. ],
  7279. "properties": {
  7280. "meta": {
  7281. "$ref": "#/components/schemas/OCSMeta"
  7282. },
  7283. "data": {}
  7284. }
  7285. }
  7286. }
  7287. }
  7288. }
  7289. }
  7290. },
  7291. "500": {
  7292. "description": "",
  7293. "content": {
  7294. "text/plain": {
  7295. "schema": {
  7296. "type": "string"
  7297. }
  7298. }
  7299. }
  7300. }
  7301. }
  7302. }
  7303. },
  7304. "/index.php/avatar/{userId}/{size}/dark": {
  7305. "get": {
  7306. "operationId": "avatar-get-avatar-dark",
  7307. "summary": "Get the dark avatar",
  7308. "tags": [
  7309. "avatar"
  7310. ],
  7311. "security": [
  7312. {},
  7313. {
  7314. "bearer_auth": []
  7315. },
  7316. {
  7317. "basic_auth": []
  7318. }
  7319. ],
  7320. "parameters": [
  7321. {
  7322. "name": "guestFallback",
  7323. "in": "query",
  7324. "description": "Fallback to guest avatar if not found",
  7325. "schema": {
  7326. "type": "integer",
  7327. "default": 0,
  7328. "enum": [
  7329. 0,
  7330. 1
  7331. ]
  7332. }
  7333. },
  7334. {
  7335. "name": "userId",
  7336. "in": "path",
  7337. "description": "ID of the user",
  7338. "required": true,
  7339. "schema": {
  7340. "type": "string"
  7341. }
  7342. },
  7343. {
  7344. "name": "size",
  7345. "in": "path",
  7346. "description": "Size of the avatar",
  7347. "required": true,
  7348. "schema": {
  7349. "type": "integer",
  7350. "format": "int64"
  7351. }
  7352. }
  7353. ],
  7354. "responses": {
  7355. "200": {
  7356. "description": "Avatar returned",
  7357. "headers": {
  7358. "X-NC-IsCustomAvatar": {
  7359. "schema": {
  7360. "type": "integer",
  7361. "format": "int64"
  7362. }
  7363. }
  7364. },
  7365. "content": {
  7366. "*/*": {
  7367. "schema": {
  7368. "type": "string",
  7369. "format": "binary"
  7370. }
  7371. }
  7372. }
  7373. },
  7374. "201": {
  7375. "description": "Avatar returned",
  7376. "headers": {
  7377. "X-NC-IsCustomAvatar": {
  7378. "schema": {
  7379. "type": "integer",
  7380. "format": "int64"
  7381. }
  7382. }
  7383. },
  7384. "content": {
  7385. "*/*": {
  7386. "schema": {
  7387. "type": "string",
  7388. "format": "binary"
  7389. }
  7390. }
  7391. }
  7392. },
  7393. "404": {
  7394. "description": "Avatar not found",
  7395. "content": {
  7396. "application/json": {
  7397. "schema": {}
  7398. }
  7399. }
  7400. },
  7401. "500": {
  7402. "description": ""
  7403. }
  7404. }
  7405. }
  7406. },
  7407. "/index.php/avatar/{userId}/{size}": {
  7408. "get": {
  7409. "operationId": "avatar-get-avatar",
  7410. "summary": "Get the avatar",
  7411. "tags": [
  7412. "avatar"
  7413. ],
  7414. "security": [
  7415. {},
  7416. {
  7417. "bearer_auth": []
  7418. },
  7419. {
  7420. "basic_auth": []
  7421. }
  7422. ],
  7423. "parameters": [
  7424. {
  7425. "name": "guestFallback",
  7426. "in": "query",
  7427. "description": "Fallback to guest avatar if not found",
  7428. "schema": {
  7429. "type": "integer",
  7430. "default": 0,
  7431. "enum": [
  7432. 0,
  7433. 1
  7434. ]
  7435. }
  7436. },
  7437. {
  7438. "name": "userId",
  7439. "in": "path",
  7440. "description": "ID of the user",
  7441. "required": true,
  7442. "schema": {
  7443. "type": "string"
  7444. }
  7445. },
  7446. {
  7447. "name": "size",
  7448. "in": "path",
  7449. "description": "Size of the avatar",
  7450. "required": true,
  7451. "schema": {
  7452. "type": "integer",
  7453. "format": "int64"
  7454. }
  7455. }
  7456. ],
  7457. "responses": {
  7458. "200": {
  7459. "description": "Avatar returned",
  7460. "headers": {
  7461. "X-NC-IsCustomAvatar": {
  7462. "schema": {
  7463. "type": "integer",
  7464. "format": "int64"
  7465. }
  7466. }
  7467. },
  7468. "content": {
  7469. "*/*": {
  7470. "schema": {
  7471. "type": "string",
  7472. "format": "binary"
  7473. }
  7474. }
  7475. }
  7476. },
  7477. "201": {
  7478. "description": "Avatar returned",
  7479. "headers": {
  7480. "X-NC-IsCustomAvatar": {
  7481. "schema": {
  7482. "type": "integer",
  7483. "format": "int64"
  7484. }
  7485. }
  7486. },
  7487. "content": {
  7488. "*/*": {
  7489. "schema": {
  7490. "type": "string",
  7491. "format": "binary"
  7492. }
  7493. }
  7494. }
  7495. },
  7496. "404": {
  7497. "description": "Avatar not found",
  7498. "content": {
  7499. "application/json": {
  7500. "schema": {}
  7501. }
  7502. }
  7503. },
  7504. "500": {
  7505. "description": ""
  7506. }
  7507. }
  7508. }
  7509. },
  7510. "/index.php/login/v2/poll": {
  7511. "post": {
  7512. "operationId": "client_flow_login_v2-poll",
  7513. "summary": "Poll the login flow credentials",
  7514. "tags": [
  7515. "client_flow_login_v2"
  7516. ],
  7517. "security": [
  7518. {},
  7519. {
  7520. "bearer_auth": []
  7521. },
  7522. {
  7523. "basic_auth": []
  7524. }
  7525. ],
  7526. "parameters": [
  7527. {
  7528. "name": "token",
  7529. "in": "query",
  7530. "description": "Token of the flow",
  7531. "required": true,
  7532. "schema": {
  7533. "type": "string"
  7534. }
  7535. }
  7536. ],
  7537. "responses": {
  7538. "200": {
  7539. "description": "Login flow credentials returned",
  7540. "content": {
  7541. "application/json": {
  7542. "schema": {
  7543. "$ref": "#/components/schemas/LoginFlowV2Credentials"
  7544. }
  7545. }
  7546. }
  7547. },
  7548. "404": {
  7549. "description": "Login flow not found or completed",
  7550. "content": {
  7551. "application/json": {
  7552. "schema": {}
  7553. }
  7554. }
  7555. }
  7556. }
  7557. }
  7558. },
  7559. "/index.php/login/v2": {
  7560. "post": {
  7561. "operationId": "client_flow_login_v2-init",
  7562. "summary": "Init a login flow",
  7563. "tags": [
  7564. "client_flow_login_v2"
  7565. ],
  7566. "security": [
  7567. {},
  7568. {
  7569. "bearer_auth": []
  7570. },
  7571. {
  7572. "basic_auth": []
  7573. }
  7574. ],
  7575. "responses": {
  7576. "200": {
  7577. "description": "Login flow init returned",
  7578. "content": {
  7579. "application/json": {
  7580. "schema": {
  7581. "$ref": "#/components/schemas/LoginFlowV2"
  7582. }
  7583. }
  7584. }
  7585. }
  7586. }
  7587. }
  7588. },
  7589. "/index.php/avatar/guest/{guestName}/{size}": {
  7590. "get": {
  7591. "operationId": "guest_avatar-get-avatar",
  7592. "summary": "Returns a guest avatar image response",
  7593. "tags": [
  7594. "guest_avatar"
  7595. ],
  7596. "security": [
  7597. {},
  7598. {
  7599. "bearer_auth": []
  7600. },
  7601. {
  7602. "basic_auth": []
  7603. }
  7604. ],
  7605. "parameters": [
  7606. {
  7607. "name": "darkTheme",
  7608. "in": "query",
  7609. "description": "Return dark avatar",
  7610. "schema": {
  7611. "type": "integer",
  7612. "nullable": true,
  7613. "default": 0,
  7614. "enum": [
  7615. 0,
  7616. 1
  7617. ]
  7618. }
  7619. },
  7620. {
  7621. "name": "guestName",
  7622. "in": "path",
  7623. "description": "The guest name, e.g. \"Albert\"",
  7624. "required": true,
  7625. "schema": {
  7626. "type": "string"
  7627. }
  7628. },
  7629. {
  7630. "name": "size",
  7631. "in": "path",
  7632. "description": "The desired avatar size, e.g. 64 for 64x64px",
  7633. "required": true,
  7634. "schema": {
  7635. "type": "string"
  7636. }
  7637. }
  7638. ],
  7639. "responses": {
  7640. "200": {
  7641. "description": "Custom avatar returned",
  7642. "headers": {
  7643. "X-NC-IsCustomAvatar": {
  7644. "schema": {
  7645. "type": "integer",
  7646. "format": "int64"
  7647. }
  7648. }
  7649. },
  7650. "content": {
  7651. "*/*": {
  7652. "schema": {
  7653. "type": "string",
  7654. "format": "binary"
  7655. }
  7656. }
  7657. }
  7658. },
  7659. "201": {
  7660. "description": "Avatar returned",
  7661. "headers": {
  7662. "X-NC-IsCustomAvatar": {
  7663. "schema": {
  7664. "type": "integer",
  7665. "format": "int64"
  7666. }
  7667. }
  7668. },
  7669. "content": {
  7670. "*/*": {
  7671. "schema": {
  7672. "type": "string",
  7673. "format": "binary"
  7674. }
  7675. }
  7676. }
  7677. },
  7678. "500": {
  7679. "description": ""
  7680. }
  7681. }
  7682. }
  7683. },
  7684. "/index.php/avatar/guest/{guestName}/{size}/dark": {
  7685. "get": {
  7686. "operationId": "guest_avatar-get-avatar-dark",
  7687. "summary": "Returns a dark guest avatar image response",
  7688. "tags": [
  7689. "guest_avatar"
  7690. ],
  7691. "security": [
  7692. {},
  7693. {
  7694. "bearer_auth": []
  7695. },
  7696. {
  7697. "basic_auth": []
  7698. }
  7699. ],
  7700. "parameters": [
  7701. {
  7702. "name": "guestName",
  7703. "in": "path",
  7704. "description": "The guest name, e.g. \"Albert\"",
  7705. "required": true,
  7706. "schema": {
  7707. "type": "string"
  7708. }
  7709. },
  7710. {
  7711. "name": "size",
  7712. "in": "path",
  7713. "description": "The desired avatar size, e.g. 64 for 64x64px",
  7714. "required": true,
  7715. "schema": {
  7716. "type": "string"
  7717. }
  7718. }
  7719. ],
  7720. "responses": {
  7721. "200": {
  7722. "description": "Custom avatar returned",
  7723. "headers": {
  7724. "X-NC-IsCustomAvatar": {
  7725. "schema": {
  7726. "type": "integer",
  7727. "format": "int64"
  7728. }
  7729. }
  7730. },
  7731. "content": {
  7732. "*/*": {
  7733. "schema": {
  7734. "type": "string",
  7735. "format": "binary"
  7736. }
  7737. }
  7738. }
  7739. },
  7740. "201": {
  7741. "description": "Avatar returned",
  7742. "headers": {
  7743. "X-NC-IsCustomAvatar": {
  7744. "schema": {
  7745. "type": "integer",
  7746. "format": "int64"
  7747. }
  7748. }
  7749. },
  7750. "content": {
  7751. "*/*": {
  7752. "schema": {
  7753. "type": "string",
  7754. "format": "binary"
  7755. }
  7756. }
  7757. }
  7758. },
  7759. "500": {
  7760. "description": ""
  7761. }
  7762. }
  7763. }
  7764. },
  7765. "/index.php/login/confirm": {
  7766. "post": {
  7767. "operationId": "login-confirm-password",
  7768. "summary": "Confirm the user password",
  7769. "tags": [
  7770. "login"
  7771. ],
  7772. "security": [
  7773. {
  7774. "bearer_auth": []
  7775. },
  7776. {
  7777. "basic_auth": []
  7778. }
  7779. ],
  7780. "parameters": [
  7781. {
  7782. "name": "password",
  7783. "in": "query",
  7784. "description": "The password of the user",
  7785. "required": true,
  7786. "schema": {
  7787. "type": "string"
  7788. }
  7789. }
  7790. ],
  7791. "responses": {
  7792. "200": {
  7793. "description": "Password confirmation succeeded",
  7794. "content": {
  7795. "application/json": {
  7796. "schema": {
  7797. "type": "object",
  7798. "required": [
  7799. "lastLogin"
  7800. ],
  7801. "properties": {
  7802. "lastLogin": {
  7803. "type": "integer",
  7804. "format": "int64"
  7805. }
  7806. }
  7807. }
  7808. }
  7809. }
  7810. },
  7811. "403": {
  7812. "description": "Password confirmation failed",
  7813. "content": {
  7814. "application/json": {
  7815. "schema": {}
  7816. }
  7817. }
  7818. }
  7819. }
  7820. }
  7821. },
  7822. "/index.php/ocm-provider": {
  7823. "get": {
  7824. "operationId": "ocm-discovery",
  7825. "summary": "generate a OCMProvider with local data and send it as DataResponse. This replaces the old PHP file ocm-provider/index.php",
  7826. "tags": [
  7827. "ocm"
  7828. ],
  7829. "security": [
  7830. {},
  7831. {
  7832. "bearer_auth": []
  7833. },
  7834. {
  7835. "basic_auth": []
  7836. }
  7837. ],
  7838. "responses": {
  7839. "200": {
  7840. "description": "OCM Provider details returned",
  7841. "headers": {
  7842. "X-NEXTCLOUD-OCM-PROVIDERS": {
  7843. "schema": {
  7844. "type": "boolean",
  7845. "enum": [
  7846. true
  7847. ]
  7848. }
  7849. }
  7850. },
  7851. "content": {
  7852. "application/json": {
  7853. "schema": {
  7854. "type": "object",
  7855. "required": [
  7856. "enabled",
  7857. "apiVersion",
  7858. "endPoint",
  7859. "resourceTypes"
  7860. ],
  7861. "properties": {
  7862. "enabled": {
  7863. "type": "boolean"
  7864. },
  7865. "apiVersion": {
  7866. "type": "string"
  7867. },
  7868. "endPoint": {
  7869. "type": "string"
  7870. },
  7871. "resourceTypes": {
  7872. "type": "array",
  7873. "items": {
  7874. "type": "object",
  7875. "required": [
  7876. "name",
  7877. "shareTypes",
  7878. "protocols"
  7879. ],
  7880. "properties": {
  7881. "name": {
  7882. "type": "string"
  7883. },
  7884. "shareTypes": {
  7885. "type": "array",
  7886. "items": {
  7887. "type": "string"
  7888. }
  7889. },
  7890. "protocols": {
  7891. "type": "object",
  7892. "required": [
  7893. "webdav"
  7894. ],
  7895. "properties": {
  7896. "webdav": {
  7897. "type": "string"
  7898. }
  7899. }
  7900. }
  7901. }
  7902. }
  7903. }
  7904. }
  7905. }
  7906. }
  7907. }
  7908. },
  7909. "500": {
  7910. "description": "OCM not supported",
  7911. "content": {
  7912. "application/json": {
  7913. "schema": {
  7914. "type": "object",
  7915. "required": [
  7916. "message"
  7917. ],
  7918. "properties": {
  7919. "message": {
  7920. "type": "string"
  7921. }
  7922. }
  7923. }
  7924. }
  7925. }
  7926. }
  7927. }
  7928. }
  7929. },
  7930. "/index.php/core/preview.png": {
  7931. "get": {
  7932. "operationId": "preview-get-preview",
  7933. "summary": "Get a preview by file path",
  7934. "tags": [
  7935. "preview"
  7936. ],
  7937. "security": [
  7938. {
  7939. "bearer_auth": []
  7940. },
  7941. {
  7942. "basic_auth": []
  7943. }
  7944. ],
  7945. "parameters": [
  7946. {
  7947. "name": "file",
  7948. "in": "query",
  7949. "description": "Path of the file",
  7950. "schema": {
  7951. "type": "string",
  7952. "default": ""
  7953. }
  7954. },
  7955. {
  7956. "name": "x",
  7957. "in": "query",
  7958. "description": "Width of the preview. A width of -1 will use the original image width.",
  7959. "schema": {
  7960. "type": "integer",
  7961. "format": "int64",
  7962. "default": 32
  7963. }
  7964. },
  7965. {
  7966. "name": "y",
  7967. "in": "query",
  7968. "description": "Height of the preview. A height of -1 will use the original image height.",
  7969. "schema": {
  7970. "type": "integer",
  7971. "format": "int64",
  7972. "default": 32
  7973. }
  7974. },
  7975. {
  7976. "name": "a",
  7977. "in": "query",
  7978. "description": "Preserve the aspect ratio",
  7979. "schema": {
  7980. "type": "integer",
  7981. "default": 0,
  7982. "enum": [
  7983. 0,
  7984. 1
  7985. ]
  7986. }
  7987. },
  7988. {
  7989. "name": "forceIcon",
  7990. "in": "query",
  7991. "description": "Force returning an icon",
  7992. "schema": {
  7993. "type": "integer",
  7994. "default": 1,
  7995. "enum": [
  7996. 0,
  7997. 1
  7998. ]
  7999. }
  8000. },
  8001. {
  8002. "name": "mode",
  8003. "in": "query",
  8004. "description": "How to crop the image",
  8005. "schema": {
  8006. "type": "string",
  8007. "default": "fill",
  8008. "enum": [
  8009. "fill",
  8010. "cover"
  8011. ]
  8012. }
  8013. },
  8014. {
  8015. "name": "mimeFallback",
  8016. "in": "query",
  8017. "description": "Whether to fallback to the mime icon if no preview is available",
  8018. "schema": {
  8019. "type": "integer",
  8020. "default": 0,
  8021. "enum": [
  8022. 0,
  8023. 1
  8024. ]
  8025. }
  8026. }
  8027. ],
  8028. "responses": {
  8029. "200": {
  8030. "description": "Preview returned",
  8031. "content": {
  8032. "*/*": {
  8033. "schema": {
  8034. "type": "string",
  8035. "format": "binary"
  8036. }
  8037. }
  8038. }
  8039. },
  8040. "400": {
  8041. "description": "Getting preview is not possible",
  8042. "content": {
  8043. "application/json": {
  8044. "schema": {}
  8045. }
  8046. }
  8047. },
  8048. "403": {
  8049. "description": "Getting preview is not allowed",
  8050. "content": {
  8051. "application/json": {
  8052. "schema": {}
  8053. }
  8054. }
  8055. },
  8056. "404": {
  8057. "description": "Preview not found",
  8058. "content": {
  8059. "application/json": {
  8060. "schema": {}
  8061. }
  8062. }
  8063. },
  8064. "303": {
  8065. "description": "Redirect to the mime icon url if mimeFallback is true",
  8066. "headers": {
  8067. "Location": {
  8068. "schema": {
  8069. "type": "string"
  8070. }
  8071. }
  8072. }
  8073. }
  8074. }
  8075. }
  8076. },
  8077. "/index.php/core/preview": {
  8078. "get": {
  8079. "operationId": "preview-get-preview-by-file-id",
  8080. "summary": "Get a preview by file ID",
  8081. "tags": [
  8082. "preview"
  8083. ],
  8084. "security": [
  8085. {
  8086. "bearer_auth": []
  8087. },
  8088. {
  8089. "basic_auth": []
  8090. }
  8091. ],
  8092. "parameters": [
  8093. {
  8094. "name": "fileId",
  8095. "in": "query",
  8096. "description": "ID of the file",
  8097. "schema": {
  8098. "type": "integer",
  8099. "format": "int64",
  8100. "default": -1
  8101. }
  8102. },
  8103. {
  8104. "name": "x",
  8105. "in": "query",
  8106. "description": "Width of the preview. A width of -1 will use the original image width.",
  8107. "schema": {
  8108. "type": "integer",
  8109. "format": "int64",
  8110. "default": 32
  8111. }
  8112. },
  8113. {
  8114. "name": "y",
  8115. "in": "query",
  8116. "description": "Height of the preview. A height of -1 will use the original image height.",
  8117. "schema": {
  8118. "type": "integer",
  8119. "format": "int64",
  8120. "default": 32
  8121. }
  8122. },
  8123. {
  8124. "name": "a",
  8125. "in": "query",
  8126. "description": "Preserve the aspect ratio",
  8127. "schema": {
  8128. "type": "integer",
  8129. "default": 0,
  8130. "enum": [
  8131. 0,
  8132. 1
  8133. ]
  8134. }
  8135. },
  8136. {
  8137. "name": "forceIcon",
  8138. "in": "query",
  8139. "description": "Force returning an icon",
  8140. "schema": {
  8141. "type": "integer",
  8142. "default": 1,
  8143. "enum": [
  8144. 0,
  8145. 1
  8146. ]
  8147. }
  8148. },
  8149. {
  8150. "name": "mode",
  8151. "in": "query",
  8152. "description": "How to crop the image",
  8153. "schema": {
  8154. "type": "string",
  8155. "default": "fill",
  8156. "enum": [
  8157. "fill",
  8158. "cover"
  8159. ]
  8160. }
  8161. },
  8162. {
  8163. "name": "mimeFallback",
  8164. "in": "query",
  8165. "description": "Whether to fallback to the mime icon if no preview is available",
  8166. "schema": {
  8167. "type": "integer",
  8168. "default": 0,
  8169. "enum": [
  8170. 0,
  8171. 1
  8172. ]
  8173. }
  8174. }
  8175. ],
  8176. "responses": {
  8177. "200": {
  8178. "description": "Preview returned",
  8179. "content": {
  8180. "*/*": {
  8181. "schema": {
  8182. "type": "string",
  8183. "format": "binary"
  8184. }
  8185. }
  8186. }
  8187. },
  8188. "400": {
  8189. "description": "Getting preview is not possible",
  8190. "content": {
  8191. "application/json": {
  8192. "schema": {}
  8193. }
  8194. }
  8195. },
  8196. "403": {
  8197. "description": "Getting preview is not allowed",
  8198. "content": {
  8199. "application/json": {
  8200. "schema": {}
  8201. }
  8202. }
  8203. },
  8204. "404": {
  8205. "description": "Preview not found",
  8206. "content": {
  8207. "application/json": {
  8208. "schema": {}
  8209. }
  8210. }
  8211. },
  8212. "303": {
  8213. "description": "Redirect to the mime icon url if mimeFallback is true",
  8214. "headers": {
  8215. "Location": {
  8216. "schema": {
  8217. "type": "string"
  8218. }
  8219. }
  8220. }
  8221. }
  8222. }
  8223. }
  8224. },
  8225. "/index.php/core/references/preview/{referenceId}": {
  8226. "get": {
  8227. "operationId": "reference-preview",
  8228. "summary": "Get a preview for a reference",
  8229. "tags": [
  8230. "reference"
  8231. ],
  8232. "security": [
  8233. {},
  8234. {
  8235. "bearer_auth": []
  8236. },
  8237. {
  8238. "basic_auth": []
  8239. }
  8240. ],
  8241. "parameters": [
  8242. {
  8243. "name": "referenceId",
  8244. "in": "path",
  8245. "description": "the reference cache key",
  8246. "required": true,
  8247. "schema": {
  8248. "type": "string"
  8249. }
  8250. }
  8251. ],
  8252. "responses": {
  8253. "200": {
  8254. "description": "Preview returned",
  8255. "content": {
  8256. "*/*": {
  8257. "schema": {
  8258. "type": "string",
  8259. "format": "binary"
  8260. }
  8261. }
  8262. }
  8263. },
  8264. "404": {
  8265. "description": "Reference not found",
  8266. "content": {
  8267. "application/json": {
  8268. "schema": {
  8269. "type": "string"
  8270. }
  8271. }
  8272. }
  8273. }
  8274. }
  8275. }
  8276. },
  8277. "/index.php/core/wipe/check": {
  8278. "post": {
  8279. "operationId": "wipe-check-wipe",
  8280. "summary": "Check if the device should be wiped",
  8281. "tags": [
  8282. "wipe"
  8283. ],
  8284. "security": [
  8285. {},
  8286. {
  8287. "bearer_auth": []
  8288. },
  8289. {
  8290. "basic_auth": []
  8291. }
  8292. ],
  8293. "parameters": [
  8294. {
  8295. "name": "token",
  8296. "in": "query",
  8297. "description": "App password",
  8298. "required": true,
  8299. "schema": {
  8300. "type": "string"
  8301. }
  8302. }
  8303. ],
  8304. "responses": {
  8305. "200": {
  8306. "description": "Device should be wiped",
  8307. "content": {
  8308. "application/json": {
  8309. "schema": {
  8310. "type": "object",
  8311. "required": [
  8312. "wipe"
  8313. ],
  8314. "properties": {
  8315. "wipe": {
  8316. "type": "boolean"
  8317. }
  8318. }
  8319. }
  8320. }
  8321. }
  8322. },
  8323. "404": {
  8324. "description": "Device should not be wiped",
  8325. "content": {
  8326. "application/json": {
  8327. "schema": {}
  8328. }
  8329. }
  8330. }
  8331. }
  8332. }
  8333. },
  8334. "/index.php/core/wipe/success": {
  8335. "post": {
  8336. "operationId": "wipe-wipe-done",
  8337. "summary": "Finish the wipe",
  8338. "tags": [
  8339. "wipe"
  8340. ],
  8341. "security": [
  8342. {},
  8343. {
  8344. "bearer_auth": []
  8345. },
  8346. {
  8347. "basic_auth": []
  8348. }
  8349. ],
  8350. "parameters": [
  8351. {
  8352. "name": "token",
  8353. "in": "query",
  8354. "description": "App password",
  8355. "required": true,
  8356. "schema": {
  8357. "type": "string"
  8358. }
  8359. }
  8360. ],
  8361. "responses": {
  8362. "200": {
  8363. "description": "Wipe finished successfully",
  8364. "content": {
  8365. "application/json": {
  8366. "schema": {}
  8367. }
  8368. }
  8369. },
  8370. "404": {
  8371. "description": "Device should not be wiped",
  8372. "content": {
  8373. "application/json": {
  8374. "schema": {}
  8375. }
  8376. }
  8377. }
  8378. }
  8379. }
  8380. },
  8381. "/status.php": {
  8382. "get": {
  8383. "operationId": "get-status",
  8384. "responses": {
  8385. "200": {
  8386. "description": "Status returned",
  8387. "content": {
  8388. "application/json": {
  8389. "schema": {
  8390. "$ref": "#/components/schemas/Status"
  8391. }
  8392. }
  8393. }
  8394. }
  8395. }
  8396. }
  8397. }
  8398. },
  8399. "tags": [
  8400. {
  8401. "name": "avatar",
  8402. "description": "Class AvatarController"
  8403. },
  8404. {
  8405. "name": "guest_avatar",
  8406. "description": "This controller handles guest avatar requests."
  8407. },
  8408. {
  8409. "name": "ocm",
  8410. "description": "Controller about the endpoint /ocm-provider/"
  8411. }
  8412. ]
  8413. }