You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

openapi.json 213KB

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