openapi.json 176 KB

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