openapi.json 128 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320
  1. {
  2. "openapi": "3.0.3",
  3. "info": {
  4. "title": "files_sharing",
  5. "version": "0.0.1",
  6. "description": "File sharing",
  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. "Capabilities": {
  24. "type": "object",
  25. "required": [
  26. "files_sharing"
  27. ],
  28. "properties": {
  29. "files_sharing": {
  30. "type": "object",
  31. "required": [
  32. "api_enabled",
  33. "public",
  34. "user",
  35. "resharing",
  36. "federation",
  37. "sharee"
  38. ],
  39. "properties": {
  40. "api_enabled": {
  41. "type": "boolean"
  42. },
  43. "public": {
  44. "type": "object",
  45. "required": [
  46. "enabled"
  47. ],
  48. "properties": {
  49. "enabled": {
  50. "type": "boolean"
  51. },
  52. "password": {
  53. "type": "object",
  54. "required": [
  55. "enforced",
  56. "askForOptionalPassword"
  57. ],
  58. "properties": {
  59. "enforced": {
  60. "type": "boolean"
  61. },
  62. "askForOptionalPassword": {
  63. "type": "boolean"
  64. }
  65. }
  66. },
  67. "multiple_links": {
  68. "type": "boolean"
  69. },
  70. "expire_date": {
  71. "type": "object",
  72. "required": [
  73. "enabled"
  74. ],
  75. "properties": {
  76. "enabled": {
  77. "type": "boolean"
  78. },
  79. "days": {
  80. "type": "integer",
  81. "format": "int64"
  82. },
  83. "enforced": {
  84. "type": "boolean"
  85. }
  86. }
  87. },
  88. "expire_date_internal": {
  89. "type": "object",
  90. "required": [
  91. "enabled"
  92. ],
  93. "properties": {
  94. "enabled": {
  95. "type": "boolean"
  96. },
  97. "days": {
  98. "type": "integer",
  99. "format": "int64"
  100. },
  101. "enforced": {
  102. "type": "boolean"
  103. }
  104. }
  105. },
  106. "expire_date_remote": {
  107. "type": "object",
  108. "required": [
  109. "enabled"
  110. ],
  111. "properties": {
  112. "enabled": {
  113. "type": "boolean"
  114. },
  115. "days": {
  116. "type": "integer",
  117. "format": "int64"
  118. },
  119. "enforced": {
  120. "type": "boolean"
  121. }
  122. }
  123. },
  124. "send_mail": {
  125. "type": "boolean"
  126. },
  127. "upload": {
  128. "type": "boolean"
  129. },
  130. "upload_files_drop": {
  131. "type": "boolean"
  132. }
  133. }
  134. },
  135. "user": {
  136. "type": "object",
  137. "required": [
  138. "send_mail"
  139. ],
  140. "properties": {
  141. "send_mail": {
  142. "type": "boolean"
  143. },
  144. "expire_date": {
  145. "type": "object",
  146. "required": [
  147. "enabled"
  148. ],
  149. "properties": {
  150. "enabled": {
  151. "type": "boolean"
  152. }
  153. }
  154. }
  155. }
  156. },
  157. "resharing": {
  158. "type": "boolean"
  159. },
  160. "group_sharing": {
  161. "type": "boolean"
  162. },
  163. "group": {
  164. "type": "object",
  165. "required": [
  166. "enabled"
  167. ],
  168. "properties": {
  169. "enabled": {
  170. "type": "boolean"
  171. },
  172. "expire_date": {
  173. "type": "object",
  174. "required": [
  175. "enabled"
  176. ],
  177. "properties": {
  178. "enabled": {
  179. "type": "boolean"
  180. }
  181. }
  182. }
  183. }
  184. },
  185. "default_permissions": {
  186. "type": "integer",
  187. "format": "int64"
  188. },
  189. "federation": {
  190. "type": "object",
  191. "required": [
  192. "outgoing",
  193. "incoming",
  194. "expire_date",
  195. "expire_date_supported"
  196. ],
  197. "properties": {
  198. "outgoing": {
  199. "type": "boolean"
  200. },
  201. "incoming": {
  202. "type": "boolean"
  203. },
  204. "expire_date": {
  205. "type": "object",
  206. "required": [
  207. "enabled"
  208. ],
  209. "properties": {
  210. "enabled": {
  211. "type": "boolean"
  212. }
  213. }
  214. },
  215. "expire_date_supported": {
  216. "type": "object",
  217. "required": [
  218. "enabled"
  219. ],
  220. "properties": {
  221. "enabled": {
  222. "type": "boolean"
  223. }
  224. }
  225. }
  226. }
  227. },
  228. "sharee": {
  229. "type": "object",
  230. "required": [
  231. "query_lookup_default",
  232. "always_show_unique"
  233. ],
  234. "properties": {
  235. "query_lookup_default": {
  236. "type": "boolean"
  237. },
  238. "always_show_unique": {
  239. "type": "boolean"
  240. }
  241. }
  242. }
  243. }
  244. }
  245. }
  246. },
  247. "DeletedShare": {
  248. "type": "object",
  249. "required": [
  250. "id",
  251. "share_type",
  252. "uid_owner",
  253. "displayname_owner",
  254. "permissions",
  255. "stime",
  256. "uid_file_owner",
  257. "displayname_file_owner",
  258. "path",
  259. "item_type",
  260. "mimetype",
  261. "storage",
  262. "item_source",
  263. "file_source",
  264. "file_parent",
  265. "file_target",
  266. "expiration",
  267. "share_with",
  268. "share_with_displayname",
  269. "share_with_link"
  270. ],
  271. "properties": {
  272. "id": {
  273. "type": "string"
  274. },
  275. "share_type": {
  276. "type": "integer",
  277. "format": "int64"
  278. },
  279. "uid_owner": {
  280. "type": "string"
  281. },
  282. "displayname_owner": {
  283. "type": "string"
  284. },
  285. "permissions": {
  286. "type": "integer",
  287. "format": "int64"
  288. },
  289. "stime": {
  290. "type": "integer",
  291. "format": "int64"
  292. },
  293. "uid_file_owner": {
  294. "type": "string"
  295. },
  296. "displayname_file_owner": {
  297. "type": "string"
  298. },
  299. "path": {
  300. "type": "string"
  301. },
  302. "item_type": {
  303. "type": "string"
  304. },
  305. "mimetype": {
  306. "type": "string"
  307. },
  308. "storage": {
  309. "type": "integer",
  310. "format": "int64"
  311. },
  312. "item_source": {
  313. "type": "integer",
  314. "format": "int64"
  315. },
  316. "file_source": {
  317. "type": "integer",
  318. "format": "int64"
  319. },
  320. "file_parent": {
  321. "type": "integer",
  322. "format": "int64"
  323. },
  324. "file_target": {
  325. "type": "integer",
  326. "format": "int64"
  327. },
  328. "expiration": {
  329. "type": "string",
  330. "nullable": true
  331. },
  332. "share_with": {
  333. "type": "string",
  334. "nullable": true
  335. },
  336. "share_with_displayname": {
  337. "type": "string",
  338. "nullable": true
  339. },
  340. "share_with_link": {
  341. "type": "string",
  342. "nullable": true
  343. }
  344. }
  345. },
  346. "Lookup": {
  347. "type": "object",
  348. "required": [
  349. "value",
  350. "verified"
  351. ],
  352. "properties": {
  353. "value": {
  354. "type": "string"
  355. },
  356. "verified": {
  357. "type": "integer",
  358. "format": "int64"
  359. }
  360. }
  361. },
  362. "OCSMeta": {
  363. "type": "object",
  364. "required": [
  365. "status",
  366. "statuscode"
  367. ],
  368. "properties": {
  369. "status": {
  370. "type": "string"
  371. },
  372. "statuscode": {
  373. "type": "integer"
  374. },
  375. "message": {
  376. "type": "string"
  377. },
  378. "totalitems": {
  379. "type": "string"
  380. },
  381. "itemsperpage": {
  382. "type": "string"
  383. }
  384. }
  385. },
  386. "RemoteShare": {
  387. "type": "object",
  388. "required": [
  389. "accepted",
  390. "file_id",
  391. "id",
  392. "mimetype",
  393. "mountpoint",
  394. "mtime",
  395. "name",
  396. "owner",
  397. "parent",
  398. "permissions",
  399. "remote",
  400. "remote_id",
  401. "share_token",
  402. "share_type",
  403. "type",
  404. "user"
  405. ],
  406. "properties": {
  407. "accepted": {
  408. "type": "boolean"
  409. },
  410. "file_id": {
  411. "type": "integer",
  412. "format": "int64",
  413. "nullable": true
  414. },
  415. "id": {
  416. "type": "integer",
  417. "format": "int64"
  418. },
  419. "mimetype": {
  420. "type": "string",
  421. "nullable": true
  422. },
  423. "mountpoint": {
  424. "type": "string"
  425. },
  426. "mtime": {
  427. "type": "integer",
  428. "format": "int64",
  429. "nullable": true
  430. },
  431. "name": {
  432. "type": "string"
  433. },
  434. "owner": {
  435. "type": "string"
  436. },
  437. "parent": {
  438. "type": "integer",
  439. "format": "int64",
  440. "nullable": true
  441. },
  442. "permissions": {
  443. "type": "integer",
  444. "format": "int64",
  445. "nullable": true
  446. },
  447. "remote": {
  448. "type": "string"
  449. },
  450. "remote_id": {
  451. "type": "string"
  452. },
  453. "share_token": {
  454. "type": "string"
  455. },
  456. "share_type": {
  457. "type": "integer",
  458. "format": "int64"
  459. },
  460. "type": {
  461. "type": "string",
  462. "nullable": true
  463. },
  464. "user": {
  465. "type": "string"
  466. }
  467. }
  468. },
  469. "Share": {
  470. "type": "object",
  471. "required": [
  472. "attributes",
  473. "can_delete",
  474. "can_edit",
  475. "displayname_file_owner",
  476. "displayname_owner",
  477. "expiration",
  478. "file_parent",
  479. "file_source",
  480. "file_target",
  481. "has_preview",
  482. "hide_download",
  483. "is-mount-root",
  484. "id",
  485. "item_mtime",
  486. "item_size",
  487. "item_source",
  488. "item_type",
  489. "label",
  490. "mail_send",
  491. "mimetype",
  492. "mount-type",
  493. "note",
  494. "parent",
  495. "path",
  496. "permissions",
  497. "share_type",
  498. "stime",
  499. "storage",
  500. "storage_id",
  501. "token",
  502. "uid_file_owner",
  503. "uid_owner"
  504. ],
  505. "properties": {
  506. "attributes": {
  507. "type": "string",
  508. "nullable": true
  509. },
  510. "can_delete": {
  511. "type": "boolean"
  512. },
  513. "can_edit": {
  514. "type": "boolean"
  515. },
  516. "displayname_file_owner": {
  517. "type": "string"
  518. },
  519. "displayname_owner": {
  520. "type": "string"
  521. },
  522. "expiration": {
  523. "type": "string",
  524. "nullable": true
  525. },
  526. "file_parent": {
  527. "type": "integer",
  528. "format": "int64"
  529. },
  530. "file_source": {
  531. "type": "integer",
  532. "format": "int64"
  533. },
  534. "file_target": {
  535. "type": "string"
  536. },
  537. "has_preview": {
  538. "type": "boolean"
  539. },
  540. "hide_download": {
  541. "type": "integer",
  542. "format": "int64",
  543. "enum": [
  544. 0,
  545. 1
  546. ]
  547. },
  548. "is-mount-root": {
  549. "type": "boolean"
  550. },
  551. "id": {
  552. "type": "string"
  553. },
  554. "item_mtime": {
  555. "type": "integer",
  556. "format": "int64"
  557. },
  558. "item_permissions": {
  559. "type": "integer",
  560. "format": "int64"
  561. },
  562. "item_size": {
  563. "oneOf": [
  564. {
  565. "type": "number",
  566. "format": "float"
  567. },
  568. {
  569. "type": "integer",
  570. "format": "int64"
  571. }
  572. ]
  573. },
  574. "item_source": {
  575. "type": "integer",
  576. "format": "int64"
  577. },
  578. "item_type": {
  579. "type": "string",
  580. "enum": [
  581. "file",
  582. "folder"
  583. ]
  584. },
  585. "label": {
  586. "type": "string"
  587. },
  588. "mail_send": {
  589. "type": "integer",
  590. "format": "int64",
  591. "enum": [
  592. 0,
  593. 1
  594. ]
  595. },
  596. "mimetype": {
  597. "type": "string"
  598. },
  599. "mount-type": {
  600. "type": "string"
  601. },
  602. "note": {
  603. "type": "string"
  604. },
  605. "parent": {
  606. "nullable": true
  607. },
  608. "password": {
  609. "type": "string"
  610. },
  611. "password_expiration_time": {
  612. "type": "string",
  613. "nullable": true
  614. },
  615. "path": {
  616. "type": "string",
  617. "nullable": true
  618. },
  619. "permissions": {
  620. "type": "integer",
  621. "format": "int64"
  622. },
  623. "send_password_by_talk": {
  624. "type": "boolean"
  625. },
  626. "share_type": {
  627. "type": "integer",
  628. "format": "int64"
  629. },
  630. "share_with": {
  631. "type": "string"
  632. },
  633. "share_with_avatar": {
  634. "type": "string"
  635. },
  636. "share_with_displayname": {
  637. "type": "string"
  638. },
  639. "share_with_displayname_unique": {
  640. "type": "string",
  641. "nullable": true
  642. },
  643. "share_with_link": {
  644. "type": "string"
  645. },
  646. "status": {
  647. "type": "object",
  648. "properties": {
  649. "clearAt": {
  650. "type": "integer",
  651. "format": "int64",
  652. "nullable": true
  653. },
  654. "icon": {
  655. "type": "string",
  656. "nullable": true
  657. },
  658. "message": {
  659. "type": "string",
  660. "nullable": true
  661. },
  662. "status": {
  663. "type": "string"
  664. }
  665. }
  666. },
  667. "stime": {
  668. "type": "integer",
  669. "format": "int64"
  670. },
  671. "storage": {
  672. "type": "integer",
  673. "format": "int64"
  674. },
  675. "storage_id": {
  676. "type": "string"
  677. },
  678. "token": {
  679. "type": "string",
  680. "nullable": true
  681. },
  682. "uid_file_owner": {
  683. "type": "string"
  684. },
  685. "uid_owner": {
  686. "type": "string"
  687. },
  688. "url": {
  689. "type": "string"
  690. }
  691. }
  692. },
  693. "ShareInfo": {
  694. "type": "object",
  695. "required": [
  696. "id",
  697. "parentId",
  698. "mtime",
  699. "name",
  700. "permissions",
  701. "mimetype",
  702. "size",
  703. "type",
  704. "etag"
  705. ],
  706. "properties": {
  707. "id": {
  708. "type": "integer",
  709. "format": "int64"
  710. },
  711. "parentId": {
  712. "type": "integer",
  713. "format": "int64"
  714. },
  715. "mtime": {
  716. "type": "integer",
  717. "format": "int64"
  718. },
  719. "name": {
  720. "type": "string"
  721. },
  722. "permissions": {
  723. "type": "integer",
  724. "format": "int64"
  725. },
  726. "mimetype": {
  727. "type": "string"
  728. },
  729. "size": {
  730. "oneOf": [
  731. {
  732. "type": "integer",
  733. "format": "int64"
  734. },
  735. {
  736. "type": "number",
  737. "format": "float"
  738. }
  739. ]
  740. },
  741. "type": {
  742. "type": "string"
  743. },
  744. "etag": {
  745. "type": "string"
  746. },
  747. "children": {
  748. "type": "array",
  749. "items": {
  750. "type": "object",
  751. "additionalProperties": {
  752. "type": "object"
  753. }
  754. }
  755. }
  756. }
  757. },
  758. "Sharee": {
  759. "type": "object",
  760. "required": [
  761. "count",
  762. "label"
  763. ],
  764. "properties": {
  765. "count": {
  766. "type": "integer",
  767. "format": "int64",
  768. "nullable": true
  769. },
  770. "label": {
  771. "type": "string"
  772. }
  773. }
  774. },
  775. "ShareeCircle": {
  776. "allOf": [
  777. {
  778. "$ref": "#/components/schemas/Sharee"
  779. },
  780. {
  781. "type": "object",
  782. "required": [
  783. "shareWithDescription",
  784. "value"
  785. ],
  786. "properties": {
  787. "shareWithDescription": {
  788. "type": "string"
  789. },
  790. "value": {
  791. "allOf": [
  792. {
  793. "$ref": "#/components/schemas/ShareeValue"
  794. },
  795. {
  796. "type": "object",
  797. "required": [
  798. "circle"
  799. ],
  800. "properties": {
  801. "circle": {
  802. "type": "string"
  803. }
  804. }
  805. }
  806. ]
  807. }
  808. }
  809. }
  810. ]
  811. },
  812. "ShareeEmail": {
  813. "allOf": [
  814. {
  815. "$ref": "#/components/schemas/Sharee"
  816. },
  817. {
  818. "type": "object",
  819. "required": [
  820. "uuid",
  821. "name",
  822. "type",
  823. "shareWithDisplayNameUnique",
  824. "value"
  825. ],
  826. "properties": {
  827. "uuid": {
  828. "type": "string"
  829. },
  830. "name": {
  831. "type": "string"
  832. },
  833. "type": {
  834. "type": "string"
  835. },
  836. "shareWithDisplayNameUnique": {
  837. "type": "string"
  838. },
  839. "value": {
  840. "$ref": "#/components/schemas/ShareeValue"
  841. }
  842. }
  843. }
  844. ]
  845. },
  846. "ShareeLookup": {
  847. "allOf": [
  848. {
  849. "$ref": "#/components/schemas/Sharee"
  850. },
  851. {
  852. "type": "object",
  853. "required": [
  854. "extra",
  855. "value"
  856. ],
  857. "properties": {
  858. "extra": {
  859. "type": "object",
  860. "required": [
  861. "federationId",
  862. "name",
  863. "email",
  864. "address",
  865. "website",
  866. "twitter",
  867. "phone",
  868. "twitter_signature",
  869. "website_signature",
  870. "userid"
  871. ],
  872. "properties": {
  873. "federationId": {
  874. "type": "string"
  875. },
  876. "name": {
  877. "$ref": "#/components/schemas/Lookup",
  878. "nullable": true
  879. },
  880. "email": {
  881. "$ref": "#/components/schemas/Lookup",
  882. "nullable": true
  883. },
  884. "address": {
  885. "$ref": "#/components/schemas/Lookup",
  886. "nullable": true
  887. },
  888. "website": {
  889. "$ref": "#/components/schemas/Lookup",
  890. "nullable": true
  891. },
  892. "twitter": {
  893. "$ref": "#/components/schemas/Lookup",
  894. "nullable": true
  895. },
  896. "phone": {
  897. "$ref": "#/components/schemas/Lookup",
  898. "nullable": true
  899. },
  900. "twitter_signature": {
  901. "$ref": "#/components/schemas/Lookup",
  902. "nullable": true
  903. },
  904. "website_signature": {
  905. "$ref": "#/components/schemas/Lookup",
  906. "nullable": true
  907. },
  908. "userid": {
  909. "$ref": "#/components/schemas/Lookup",
  910. "nullable": true
  911. }
  912. }
  913. },
  914. "value": {
  915. "allOf": [
  916. {
  917. "$ref": "#/components/schemas/ShareeValue"
  918. },
  919. {
  920. "type": "object",
  921. "required": [
  922. "globalScale"
  923. ],
  924. "properties": {
  925. "globalScale": {
  926. "type": "boolean"
  927. }
  928. }
  929. }
  930. ]
  931. }
  932. }
  933. }
  934. ]
  935. },
  936. "ShareeRemote": {
  937. "allOf": [
  938. {
  939. "$ref": "#/components/schemas/Sharee"
  940. },
  941. {
  942. "type": "object",
  943. "required": [
  944. "uuid",
  945. "name",
  946. "type",
  947. "value"
  948. ],
  949. "properties": {
  950. "uuid": {
  951. "type": "string"
  952. },
  953. "name": {
  954. "type": "string"
  955. },
  956. "type": {
  957. "type": "string"
  958. },
  959. "value": {
  960. "allOf": [
  961. {
  962. "$ref": "#/components/schemas/ShareeValue"
  963. },
  964. {
  965. "type": "object",
  966. "required": [
  967. "server"
  968. ],
  969. "properties": {
  970. "server": {
  971. "type": "string"
  972. }
  973. }
  974. }
  975. ]
  976. }
  977. }
  978. }
  979. ]
  980. },
  981. "ShareeRemoteGroup": {
  982. "allOf": [
  983. {
  984. "$ref": "#/components/schemas/Sharee"
  985. },
  986. {
  987. "type": "object",
  988. "required": [
  989. "guid",
  990. "name",
  991. "value"
  992. ],
  993. "properties": {
  994. "guid": {
  995. "type": "string"
  996. },
  997. "name": {
  998. "type": "string"
  999. },
  1000. "value": {
  1001. "allOf": [
  1002. {
  1003. "$ref": "#/components/schemas/ShareeValue"
  1004. },
  1005. {
  1006. "type": "object",
  1007. "required": [
  1008. "server"
  1009. ],
  1010. "properties": {
  1011. "server": {
  1012. "type": "string"
  1013. }
  1014. }
  1015. }
  1016. ]
  1017. }
  1018. }
  1019. }
  1020. ]
  1021. },
  1022. "ShareeUser": {
  1023. "allOf": [
  1024. {
  1025. "$ref": "#/components/schemas/Sharee"
  1026. },
  1027. {
  1028. "type": "object",
  1029. "required": [
  1030. "subline",
  1031. "icon",
  1032. "shareWithDisplayNameUnique",
  1033. "status",
  1034. "value"
  1035. ],
  1036. "properties": {
  1037. "subline": {
  1038. "type": "string"
  1039. },
  1040. "icon": {
  1041. "type": "string"
  1042. },
  1043. "shareWithDisplayNameUnique": {
  1044. "type": "string"
  1045. },
  1046. "status": {
  1047. "type": "object",
  1048. "required": [
  1049. "status",
  1050. "message",
  1051. "icon",
  1052. "clearAt"
  1053. ],
  1054. "properties": {
  1055. "status": {
  1056. "type": "string"
  1057. },
  1058. "message": {
  1059. "type": "string"
  1060. },
  1061. "icon": {
  1062. "type": "string"
  1063. },
  1064. "clearAt": {
  1065. "type": "integer",
  1066. "format": "int64",
  1067. "nullable": true
  1068. }
  1069. }
  1070. },
  1071. "value": {
  1072. "$ref": "#/components/schemas/ShareeValue"
  1073. }
  1074. }
  1075. }
  1076. ]
  1077. },
  1078. "ShareeValue": {
  1079. "type": "object",
  1080. "required": [
  1081. "shareType",
  1082. "shareWith"
  1083. ],
  1084. "properties": {
  1085. "shareType": {
  1086. "type": "integer",
  1087. "format": "int64"
  1088. },
  1089. "shareWith": {
  1090. "type": "string"
  1091. }
  1092. }
  1093. },
  1094. "ShareesRecommendedResult": {
  1095. "type": "object",
  1096. "required": [
  1097. "exact",
  1098. "emails",
  1099. "groups",
  1100. "remote_groups",
  1101. "remotes",
  1102. "users"
  1103. ],
  1104. "properties": {
  1105. "exact": {
  1106. "type": "object",
  1107. "required": [
  1108. "emails",
  1109. "groups",
  1110. "remote_groups",
  1111. "remotes",
  1112. "users"
  1113. ],
  1114. "properties": {
  1115. "emails": {
  1116. "type": "array",
  1117. "items": {
  1118. "$ref": "#/components/schemas/ShareeEmail"
  1119. }
  1120. },
  1121. "groups": {
  1122. "type": "array",
  1123. "items": {
  1124. "$ref": "#/components/schemas/Sharee"
  1125. }
  1126. },
  1127. "remote_groups": {
  1128. "type": "array",
  1129. "items": {
  1130. "$ref": "#/components/schemas/ShareeRemoteGroup"
  1131. }
  1132. },
  1133. "remotes": {
  1134. "type": "array",
  1135. "items": {
  1136. "$ref": "#/components/schemas/ShareeRemote"
  1137. }
  1138. },
  1139. "users": {
  1140. "type": "array",
  1141. "items": {
  1142. "$ref": "#/components/schemas/ShareeUser"
  1143. }
  1144. }
  1145. }
  1146. },
  1147. "emails": {
  1148. "type": "array",
  1149. "items": {
  1150. "$ref": "#/components/schemas/ShareeEmail"
  1151. }
  1152. },
  1153. "groups": {
  1154. "type": "array",
  1155. "items": {
  1156. "$ref": "#/components/schemas/Sharee"
  1157. }
  1158. },
  1159. "remote_groups": {
  1160. "type": "array",
  1161. "items": {
  1162. "$ref": "#/components/schemas/ShareeRemoteGroup"
  1163. }
  1164. },
  1165. "remotes": {
  1166. "type": "array",
  1167. "items": {
  1168. "$ref": "#/components/schemas/ShareeRemote"
  1169. }
  1170. },
  1171. "users": {
  1172. "type": "array",
  1173. "items": {
  1174. "$ref": "#/components/schemas/ShareeUser"
  1175. }
  1176. }
  1177. }
  1178. },
  1179. "ShareesSearchResult": {
  1180. "type": "object",
  1181. "required": [
  1182. "exact",
  1183. "circles",
  1184. "emails",
  1185. "groups",
  1186. "lookup",
  1187. "remote_groups",
  1188. "remotes",
  1189. "rooms",
  1190. "users",
  1191. "lookupEnabled"
  1192. ],
  1193. "properties": {
  1194. "exact": {
  1195. "type": "object",
  1196. "required": [
  1197. "circles",
  1198. "emails",
  1199. "groups",
  1200. "remote_groups",
  1201. "remotes",
  1202. "rooms",
  1203. "users"
  1204. ],
  1205. "properties": {
  1206. "circles": {
  1207. "type": "array",
  1208. "items": {
  1209. "$ref": "#/components/schemas/ShareeCircle"
  1210. }
  1211. },
  1212. "emails": {
  1213. "type": "array",
  1214. "items": {
  1215. "$ref": "#/components/schemas/ShareeEmail"
  1216. }
  1217. },
  1218. "groups": {
  1219. "type": "array",
  1220. "items": {
  1221. "$ref": "#/components/schemas/Sharee"
  1222. }
  1223. },
  1224. "remote_groups": {
  1225. "type": "array",
  1226. "items": {
  1227. "$ref": "#/components/schemas/ShareeRemoteGroup"
  1228. }
  1229. },
  1230. "remotes": {
  1231. "type": "array",
  1232. "items": {
  1233. "$ref": "#/components/schemas/ShareeRemote"
  1234. }
  1235. },
  1236. "rooms": {
  1237. "type": "array",
  1238. "items": {
  1239. "$ref": "#/components/schemas/Sharee"
  1240. }
  1241. },
  1242. "users": {
  1243. "type": "array",
  1244. "items": {
  1245. "$ref": "#/components/schemas/ShareeUser"
  1246. }
  1247. }
  1248. }
  1249. },
  1250. "circles": {
  1251. "type": "array",
  1252. "items": {
  1253. "$ref": "#/components/schemas/ShareeCircle"
  1254. }
  1255. },
  1256. "emails": {
  1257. "type": "array",
  1258. "items": {
  1259. "$ref": "#/components/schemas/ShareeEmail"
  1260. }
  1261. },
  1262. "groups": {
  1263. "type": "array",
  1264. "items": {
  1265. "$ref": "#/components/schemas/Sharee"
  1266. }
  1267. },
  1268. "lookup": {
  1269. "type": "array",
  1270. "items": {
  1271. "$ref": "#/components/schemas/ShareeLookup"
  1272. }
  1273. },
  1274. "remote_groups": {
  1275. "type": "array",
  1276. "items": {
  1277. "$ref": "#/components/schemas/ShareeRemoteGroup"
  1278. }
  1279. },
  1280. "remotes": {
  1281. "type": "array",
  1282. "items": {
  1283. "$ref": "#/components/schemas/ShareeRemote"
  1284. }
  1285. },
  1286. "rooms": {
  1287. "type": "array",
  1288. "items": {
  1289. "$ref": "#/components/schemas/Sharee"
  1290. }
  1291. },
  1292. "users": {
  1293. "type": "array",
  1294. "items": {
  1295. "$ref": "#/components/schemas/ShareeUser"
  1296. }
  1297. },
  1298. "lookupEnabled": {
  1299. "type": "boolean"
  1300. }
  1301. }
  1302. }
  1303. }
  1304. },
  1305. "paths": {
  1306. "/index.php/s/{token}/preview": {
  1307. "get": {
  1308. "operationId": "public_preview-direct-link",
  1309. "summary": "Get a direct link preview for a shared file",
  1310. "tags": [
  1311. "public_preview"
  1312. ],
  1313. "security": [
  1314. {},
  1315. {
  1316. "bearer_auth": []
  1317. },
  1318. {
  1319. "basic_auth": []
  1320. }
  1321. ],
  1322. "parameters": [
  1323. {
  1324. "name": "token",
  1325. "in": "path",
  1326. "description": "Token of the share",
  1327. "required": true,
  1328. "schema": {
  1329. "type": "string"
  1330. }
  1331. }
  1332. ],
  1333. "responses": {
  1334. "200": {
  1335. "description": "Preview returned",
  1336. "content": {
  1337. "*/*": {
  1338. "schema": {
  1339. "type": "string",
  1340. "format": "binary"
  1341. }
  1342. }
  1343. }
  1344. },
  1345. "400": {
  1346. "description": "Getting preview is not possible",
  1347. "content": {
  1348. "application/json": {
  1349. "schema": {}
  1350. }
  1351. }
  1352. },
  1353. "403": {
  1354. "description": "Getting preview is not allowed",
  1355. "content": {
  1356. "application/json": {
  1357. "schema": {}
  1358. }
  1359. }
  1360. },
  1361. "404": {
  1362. "description": "Share or preview not found",
  1363. "content": {
  1364. "application/json": {
  1365. "schema": {}
  1366. }
  1367. }
  1368. }
  1369. }
  1370. }
  1371. },
  1372. "/index.php/apps/files_sharing/publicpreview/{token}": {
  1373. "get": {
  1374. "operationId": "public_preview-get-preview",
  1375. "summary": "Get a preview for a shared file",
  1376. "tags": [
  1377. "public_preview"
  1378. ],
  1379. "security": [
  1380. {},
  1381. {
  1382. "bearer_auth": []
  1383. },
  1384. {
  1385. "basic_auth": []
  1386. }
  1387. ],
  1388. "parameters": [
  1389. {
  1390. "name": "file",
  1391. "in": "query",
  1392. "description": "File in the share",
  1393. "schema": {
  1394. "type": "string",
  1395. "default": ""
  1396. }
  1397. },
  1398. {
  1399. "name": "x",
  1400. "in": "query",
  1401. "description": "Width of the preview",
  1402. "schema": {
  1403. "type": "integer",
  1404. "format": "int64",
  1405. "default": 32
  1406. }
  1407. },
  1408. {
  1409. "name": "y",
  1410. "in": "query",
  1411. "description": "Height of the preview",
  1412. "schema": {
  1413. "type": "integer",
  1414. "format": "int64",
  1415. "default": 32
  1416. }
  1417. },
  1418. {
  1419. "name": "a",
  1420. "in": "query",
  1421. "description": "Whether to not crop the preview",
  1422. "schema": {
  1423. "type": "integer",
  1424. "default": 0,
  1425. "enum": [
  1426. 0,
  1427. 1
  1428. ]
  1429. }
  1430. },
  1431. {
  1432. "name": "token",
  1433. "in": "path",
  1434. "description": "Token of the share",
  1435. "required": true,
  1436. "schema": {
  1437. "type": "string"
  1438. }
  1439. }
  1440. ],
  1441. "responses": {
  1442. "200": {
  1443. "description": "Preview returned",
  1444. "content": {
  1445. "*/*": {
  1446. "schema": {
  1447. "type": "string",
  1448. "format": "binary"
  1449. }
  1450. }
  1451. }
  1452. },
  1453. "400": {
  1454. "description": "Getting preview is not possible",
  1455. "content": {
  1456. "application/json": {
  1457. "schema": {}
  1458. }
  1459. }
  1460. },
  1461. "403": {
  1462. "description": "Getting preview is not allowed",
  1463. "content": {
  1464. "application/json": {
  1465. "schema": {}
  1466. }
  1467. }
  1468. },
  1469. "404": {
  1470. "description": "Share or preview not found",
  1471. "content": {
  1472. "application/json": {
  1473. "schema": {}
  1474. }
  1475. }
  1476. }
  1477. }
  1478. }
  1479. },
  1480. "/index.php/apps/files_sharing/shareinfo": {
  1481. "post": {
  1482. "operationId": "share_info-info",
  1483. "summary": "Get the info about a share",
  1484. "tags": [
  1485. "share_info"
  1486. ],
  1487. "security": [
  1488. {},
  1489. {
  1490. "bearer_auth": []
  1491. },
  1492. {
  1493. "basic_auth": []
  1494. }
  1495. ],
  1496. "parameters": [
  1497. {
  1498. "name": "t",
  1499. "in": "query",
  1500. "description": "Token of the share",
  1501. "required": true,
  1502. "schema": {
  1503. "type": "string"
  1504. }
  1505. },
  1506. {
  1507. "name": "password",
  1508. "in": "query",
  1509. "description": "Password of the share",
  1510. "schema": {
  1511. "type": "string",
  1512. "nullable": true
  1513. }
  1514. },
  1515. {
  1516. "name": "dir",
  1517. "in": "query",
  1518. "description": "Subdirectory to get info about",
  1519. "schema": {
  1520. "type": "string",
  1521. "nullable": true
  1522. }
  1523. },
  1524. {
  1525. "name": "depth",
  1526. "in": "query",
  1527. "description": "Maximum depth to get info about",
  1528. "schema": {
  1529. "type": "integer",
  1530. "format": "int64",
  1531. "default": -1
  1532. }
  1533. }
  1534. ],
  1535. "responses": {
  1536. "200": {
  1537. "description": "Share info returned",
  1538. "content": {
  1539. "application/json": {
  1540. "schema": {
  1541. "$ref": "#/components/schemas/ShareInfo"
  1542. }
  1543. }
  1544. }
  1545. },
  1546. "403": {
  1547. "description": "Getting share info is not allowed",
  1548. "content": {
  1549. "application/json": {
  1550. "schema": {}
  1551. }
  1552. }
  1553. },
  1554. "404": {
  1555. "description": "Share not found",
  1556. "content": {
  1557. "application/json": {
  1558. "schema": {}
  1559. }
  1560. }
  1561. }
  1562. }
  1563. }
  1564. },
  1565. "/ocs/v2.php/apps/files_sharing/api/v1/shares": {
  1566. "get": {
  1567. "operationId": "shareapi-get-shares",
  1568. "summary": "Get shares of the current user",
  1569. "tags": [
  1570. "shareapi"
  1571. ],
  1572. "security": [
  1573. {
  1574. "bearer_auth": []
  1575. },
  1576. {
  1577. "basic_auth": []
  1578. }
  1579. ],
  1580. "parameters": [
  1581. {
  1582. "name": "shared_with_me",
  1583. "in": "query",
  1584. "description": "Only get shares with the current user",
  1585. "schema": {
  1586. "type": "string",
  1587. "default": "false"
  1588. }
  1589. },
  1590. {
  1591. "name": "reshares",
  1592. "in": "query",
  1593. "description": "Only get shares by the current user and reshares",
  1594. "schema": {
  1595. "type": "string",
  1596. "default": "false"
  1597. }
  1598. },
  1599. {
  1600. "name": "subfiles",
  1601. "in": "query",
  1602. "description": "Only get all shares in a folder",
  1603. "schema": {
  1604. "type": "string",
  1605. "default": "false"
  1606. }
  1607. },
  1608. {
  1609. "name": "path",
  1610. "in": "query",
  1611. "description": "Get shares for a specific path",
  1612. "schema": {
  1613. "type": "string",
  1614. "default": ""
  1615. }
  1616. },
  1617. {
  1618. "name": "include_tags",
  1619. "in": "query",
  1620. "description": "Include tags in the share",
  1621. "schema": {
  1622. "type": "string",
  1623. "default": "false"
  1624. }
  1625. },
  1626. {
  1627. "name": "OCS-APIRequest",
  1628. "in": "header",
  1629. "description": "Required to be true for the API request to pass",
  1630. "required": true,
  1631. "schema": {
  1632. "type": "boolean",
  1633. "default": true
  1634. }
  1635. }
  1636. ],
  1637. "responses": {
  1638. "200": {
  1639. "description": "Shares returned",
  1640. "content": {
  1641. "application/json": {
  1642. "schema": {
  1643. "type": "object",
  1644. "required": [
  1645. "ocs"
  1646. ],
  1647. "properties": {
  1648. "ocs": {
  1649. "type": "object",
  1650. "required": [
  1651. "meta",
  1652. "data"
  1653. ],
  1654. "properties": {
  1655. "meta": {
  1656. "$ref": "#/components/schemas/OCSMeta"
  1657. },
  1658. "data": {
  1659. "type": "array",
  1660. "items": {
  1661. "$ref": "#/components/schemas/Share"
  1662. }
  1663. }
  1664. }
  1665. }
  1666. }
  1667. }
  1668. }
  1669. }
  1670. },
  1671. "404": {
  1672. "description": "The folder was not found or is inaccessible",
  1673. "content": {
  1674. "text/plain": {
  1675. "schema": {
  1676. "type": "string"
  1677. }
  1678. }
  1679. }
  1680. }
  1681. }
  1682. },
  1683. "post": {
  1684. "operationId": "shareapi-create-share",
  1685. "summary": "Create a share",
  1686. "tags": [
  1687. "shareapi"
  1688. ],
  1689. "security": [
  1690. {
  1691. "bearer_auth": []
  1692. },
  1693. {
  1694. "basic_auth": []
  1695. }
  1696. ],
  1697. "parameters": [
  1698. {
  1699. "name": "path",
  1700. "in": "query",
  1701. "description": "Path of the share",
  1702. "schema": {
  1703. "type": "string",
  1704. "nullable": true
  1705. }
  1706. },
  1707. {
  1708. "name": "permissions",
  1709. "in": "query",
  1710. "description": "Permissions for the share",
  1711. "schema": {
  1712. "type": "integer",
  1713. "format": "int64",
  1714. "nullable": true
  1715. }
  1716. },
  1717. {
  1718. "name": "shareType",
  1719. "in": "query",
  1720. "description": "Type of the share",
  1721. "schema": {
  1722. "type": "integer",
  1723. "format": "int64",
  1724. "default": -1
  1725. }
  1726. },
  1727. {
  1728. "name": "shareWith",
  1729. "in": "query",
  1730. "description": "The entity this should be shared with",
  1731. "schema": {
  1732. "type": "string",
  1733. "nullable": true
  1734. }
  1735. },
  1736. {
  1737. "name": "publicUpload",
  1738. "in": "query",
  1739. "description": "If public uploading is allowed",
  1740. "schema": {
  1741. "type": "string",
  1742. "default": "false"
  1743. }
  1744. },
  1745. {
  1746. "name": "password",
  1747. "in": "query",
  1748. "description": "Password for the share",
  1749. "schema": {
  1750. "type": "string",
  1751. "default": ""
  1752. }
  1753. },
  1754. {
  1755. "name": "sendPasswordByTalk",
  1756. "in": "query",
  1757. "description": "Send the password for the share over Talk",
  1758. "schema": {
  1759. "type": "string",
  1760. "nullable": true
  1761. }
  1762. },
  1763. {
  1764. "name": "expireDate",
  1765. "in": "query",
  1766. "description": "The expiry date of the share in the user's timezone at 00:00. If $expireDate is not supplied or set to `null`, the system default will be used.",
  1767. "schema": {
  1768. "type": "string",
  1769. "nullable": true
  1770. }
  1771. },
  1772. {
  1773. "name": "note",
  1774. "in": "query",
  1775. "description": "Note for the share",
  1776. "schema": {
  1777. "type": "string",
  1778. "default": ""
  1779. }
  1780. },
  1781. {
  1782. "name": "label",
  1783. "in": "query",
  1784. "description": "Label for the share (only used in link and email)",
  1785. "schema": {
  1786. "type": "string",
  1787. "default": ""
  1788. }
  1789. },
  1790. {
  1791. "name": "attributes",
  1792. "in": "query",
  1793. "description": "Additional attributes for the share",
  1794. "schema": {
  1795. "type": "string",
  1796. "nullable": true
  1797. }
  1798. },
  1799. {
  1800. "name": "OCS-APIRequest",
  1801. "in": "header",
  1802. "description": "Required to be true for the API request to pass",
  1803. "required": true,
  1804. "schema": {
  1805. "type": "boolean",
  1806. "default": true
  1807. }
  1808. }
  1809. ],
  1810. "responses": {
  1811. "200": {
  1812. "description": "Share created",
  1813. "content": {
  1814. "application/json": {
  1815. "schema": {
  1816. "type": "object",
  1817. "required": [
  1818. "ocs"
  1819. ],
  1820. "properties": {
  1821. "ocs": {
  1822. "type": "object",
  1823. "required": [
  1824. "meta",
  1825. "data"
  1826. ],
  1827. "properties": {
  1828. "meta": {
  1829. "$ref": "#/components/schemas/OCSMeta"
  1830. },
  1831. "data": {
  1832. "$ref": "#/components/schemas/Share"
  1833. }
  1834. }
  1835. }
  1836. }
  1837. }
  1838. }
  1839. }
  1840. },
  1841. "400": {
  1842. "description": "Unknown share type",
  1843. "content": {
  1844. "text/plain": {
  1845. "schema": {
  1846. "type": "string"
  1847. }
  1848. }
  1849. }
  1850. },
  1851. "403": {
  1852. "description": "Creating the share is not allowed",
  1853. "content": {
  1854. "text/plain": {
  1855. "schema": {
  1856. "type": "string"
  1857. }
  1858. }
  1859. }
  1860. },
  1861. "404": {
  1862. "description": "Creating the share failed",
  1863. "content": {
  1864. "text/plain": {
  1865. "schema": {
  1866. "type": "string"
  1867. }
  1868. }
  1869. }
  1870. }
  1871. }
  1872. }
  1873. },
  1874. "/ocs/v2.php/apps/files_sharing/api/v1/shares/inherited": {
  1875. "get": {
  1876. "operationId": "shareapi-get-inherited-shares",
  1877. "summary": "Get all shares relative to a file, including parent folders shares rights",
  1878. "tags": [
  1879. "shareapi"
  1880. ],
  1881. "security": [
  1882. {
  1883. "bearer_auth": []
  1884. },
  1885. {
  1886. "basic_auth": []
  1887. }
  1888. ],
  1889. "parameters": [
  1890. {
  1891. "name": "path",
  1892. "in": "query",
  1893. "description": "Path all shares will be relative to",
  1894. "required": true,
  1895. "schema": {
  1896. "type": "string"
  1897. }
  1898. },
  1899. {
  1900. "name": "OCS-APIRequest",
  1901. "in": "header",
  1902. "description": "Required to be true for the API request to pass",
  1903. "required": true,
  1904. "schema": {
  1905. "type": "boolean",
  1906. "default": true
  1907. }
  1908. }
  1909. ],
  1910. "responses": {
  1911. "200": {
  1912. "description": "Shares returned",
  1913. "content": {
  1914. "application/json": {
  1915. "schema": {
  1916. "type": "object",
  1917. "required": [
  1918. "ocs"
  1919. ],
  1920. "properties": {
  1921. "ocs": {
  1922. "type": "object",
  1923. "required": [
  1924. "meta",
  1925. "data"
  1926. ],
  1927. "properties": {
  1928. "meta": {
  1929. "$ref": "#/components/schemas/OCSMeta"
  1930. },
  1931. "data": {
  1932. "type": "array",
  1933. "items": {
  1934. "$ref": "#/components/schemas/Share"
  1935. }
  1936. }
  1937. }
  1938. }
  1939. }
  1940. }
  1941. }
  1942. }
  1943. },
  1944. "500": {
  1945. "description": "",
  1946. "content": {
  1947. "text/plain": {
  1948. "schema": {
  1949. "type": "string"
  1950. }
  1951. }
  1952. }
  1953. },
  1954. "404": {
  1955. "description": "The given path is invalid",
  1956. "content": {
  1957. "text/plain": {
  1958. "schema": {
  1959. "type": "string"
  1960. }
  1961. }
  1962. }
  1963. }
  1964. }
  1965. }
  1966. },
  1967. "/ocs/v2.php/apps/files_sharing/api/v1/shares/pending": {
  1968. "get": {
  1969. "operationId": "shareapi-pending-shares",
  1970. "summary": "Get all shares that are still pending",
  1971. "tags": [
  1972. "shareapi"
  1973. ],
  1974. "security": [
  1975. {
  1976. "bearer_auth": []
  1977. },
  1978. {
  1979. "basic_auth": []
  1980. }
  1981. ],
  1982. "parameters": [
  1983. {
  1984. "name": "OCS-APIRequest",
  1985. "in": "header",
  1986. "description": "Required to be true for the API request to pass",
  1987. "required": true,
  1988. "schema": {
  1989. "type": "boolean",
  1990. "default": true
  1991. }
  1992. }
  1993. ],
  1994. "responses": {
  1995. "200": {
  1996. "description": "Pending shares returned",
  1997. "content": {
  1998. "application/json": {
  1999. "schema": {
  2000. "type": "object",
  2001. "required": [
  2002. "ocs"
  2003. ],
  2004. "properties": {
  2005. "ocs": {
  2006. "type": "object",
  2007. "required": [
  2008. "meta",
  2009. "data"
  2010. ],
  2011. "properties": {
  2012. "meta": {
  2013. "$ref": "#/components/schemas/OCSMeta"
  2014. },
  2015. "data": {
  2016. "type": "array",
  2017. "items": {
  2018. "$ref": "#/components/schemas/Share"
  2019. }
  2020. }
  2021. }
  2022. }
  2023. }
  2024. }
  2025. }
  2026. }
  2027. }
  2028. }
  2029. }
  2030. },
  2031. "/ocs/v2.php/apps/files_sharing/api/v1/shares/{id}": {
  2032. "get": {
  2033. "operationId": "shareapi-get-share",
  2034. "summary": "Get a specific share by id",
  2035. "tags": [
  2036. "shareapi"
  2037. ],
  2038. "security": [
  2039. {
  2040. "bearer_auth": []
  2041. },
  2042. {
  2043. "basic_auth": []
  2044. }
  2045. ],
  2046. "parameters": [
  2047. {
  2048. "name": "include_tags",
  2049. "in": "query",
  2050. "description": "Include tags in the share",
  2051. "schema": {
  2052. "type": "integer",
  2053. "default": 0,
  2054. "enum": [
  2055. 0,
  2056. 1
  2057. ]
  2058. }
  2059. },
  2060. {
  2061. "name": "id",
  2062. "in": "path",
  2063. "description": "ID of the share",
  2064. "required": true,
  2065. "schema": {
  2066. "type": "string"
  2067. }
  2068. },
  2069. {
  2070. "name": "OCS-APIRequest",
  2071. "in": "header",
  2072. "description": "Required to be true for the API request to pass",
  2073. "required": true,
  2074. "schema": {
  2075. "type": "boolean",
  2076. "default": true
  2077. }
  2078. }
  2079. ],
  2080. "responses": {
  2081. "200": {
  2082. "description": "Share returned",
  2083. "content": {
  2084. "application/json": {
  2085. "schema": {
  2086. "type": "object",
  2087. "required": [
  2088. "ocs"
  2089. ],
  2090. "properties": {
  2091. "ocs": {
  2092. "type": "object",
  2093. "required": [
  2094. "meta",
  2095. "data"
  2096. ],
  2097. "properties": {
  2098. "meta": {
  2099. "$ref": "#/components/schemas/OCSMeta"
  2100. },
  2101. "data": {
  2102. "$ref": "#/components/schemas/Share"
  2103. }
  2104. }
  2105. }
  2106. }
  2107. }
  2108. }
  2109. }
  2110. },
  2111. "404": {
  2112. "description": "Share not found",
  2113. "content": {
  2114. "text/plain": {
  2115. "schema": {
  2116. "type": "string"
  2117. }
  2118. }
  2119. }
  2120. }
  2121. }
  2122. },
  2123. "put": {
  2124. "operationId": "shareapi-update-share",
  2125. "summary": "Update a share",
  2126. "tags": [
  2127. "shareapi"
  2128. ],
  2129. "security": [
  2130. {
  2131. "bearer_auth": []
  2132. },
  2133. {
  2134. "basic_auth": []
  2135. }
  2136. ],
  2137. "parameters": [
  2138. {
  2139. "name": "permissions",
  2140. "in": "query",
  2141. "description": "New permissions",
  2142. "schema": {
  2143. "type": "integer",
  2144. "format": "int64",
  2145. "nullable": true
  2146. }
  2147. },
  2148. {
  2149. "name": "password",
  2150. "in": "query",
  2151. "description": "New password",
  2152. "schema": {
  2153. "type": "string",
  2154. "nullable": true
  2155. }
  2156. },
  2157. {
  2158. "name": "sendPasswordByTalk",
  2159. "in": "query",
  2160. "description": "New condition if the password should be send over Talk",
  2161. "schema": {
  2162. "type": "string",
  2163. "nullable": true
  2164. }
  2165. },
  2166. {
  2167. "name": "publicUpload",
  2168. "in": "query",
  2169. "description": "New condition if public uploading is allowed",
  2170. "schema": {
  2171. "type": "string",
  2172. "nullable": true
  2173. }
  2174. },
  2175. {
  2176. "name": "expireDate",
  2177. "in": "query",
  2178. "description": "New expiry date",
  2179. "schema": {
  2180. "type": "string",
  2181. "nullable": true
  2182. }
  2183. },
  2184. {
  2185. "name": "note",
  2186. "in": "query",
  2187. "description": "New note",
  2188. "schema": {
  2189. "type": "string",
  2190. "nullable": true
  2191. }
  2192. },
  2193. {
  2194. "name": "label",
  2195. "in": "query",
  2196. "description": "New label",
  2197. "schema": {
  2198. "type": "string",
  2199. "nullable": true
  2200. }
  2201. },
  2202. {
  2203. "name": "hideDownload",
  2204. "in": "query",
  2205. "description": "New condition if the download should be hidden",
  2206. "schema": {
  2207. "type": "string",
  2208. "nullable": true
  2209. }
  2210. },
  2211. {
  2212. "name": "attributes",
  2213. "in": "query",
  2214. "description": "New additional attributes",
  2215. "schema": {
  2216. "type": "string",
  2217. "nullable": true
  2218. }
  2219. },
  2220. {
  2221. "name": "id",
  2222. "in": "path",
  2223. "description": "ID of the share",
  2224. "required": true,
  2225. "schema": {
  2226. "type": "string"
  2227. }
  2228. },
  2229. {
  2230. "name": "OCS-APIRequest",
  2231. "in": "header",
  2232. "description": "Required to be true for the API request to pass",
  2233. "required": true,
  2234. "schema": {
  2235. "type": "boolean",
  2236. "default": true
  2237. }
  2238. }
  2239. ],
  2240. "responses": {
  2241. "200": {
  2242. "description": "Share updated successfully",
  2243. "content": {
  2244. "application/json": {
  2245. "schema": {
  2246. "type": "object",
  2247. "required": [
  2248. "ocs"
  2249. ],
  2250. "properties": {
  2251. "ocs": {
  2252. "type": "object",
  2253. "required": [
  2254. "meta",
  2255. "data"
  2256. ],
  2257. "properties": {
  2258. "meta": {
  2259. "$ref": "#/components/schemas/OCSMeta"
  2260. },
  2261. "data": {
  2262. "$ref": "#/components/schemas/Share"
  2263. }
  2264. }
  2265. }
  2266. }
  2267. }
  2268. }
  2269. }
  2270. },
  2271. "400": {
  2272. "description": "Share could not be updated because the requested changes are invalid",
  2273. "content": {
  2274. "text/plain": {
  2275. "schema": {
  2276. "type": "string"
  2277. }
  2278. }
  2279. }
  2280. },
  2281. "403": {
  2282. "description": "Missing permissions to update the share",
  2283. "content": {
  2284. "text/plain": {
  2285. "schema": {
  2286. "type": "string"
  2287. }
  2288. }
  2289. }
  2290. },
  2291. "404": {
  2292. "description": "Share not found",
  2293. "content": {
  2294. "text/plain": {
  2295. "schema": {
  2296. "type": "string"
  2297. }
  2298. }
  2299. }
  2300. }
  2301. }
  2302. },
  2303. "delete": {
  2304. "operationId": "shareapi-delete-share",
  2305. "summary": "Delete a share",
  2306. "tags": [
  2307. "shareapi"
  2308. ],
  2309. "security": [
  2310. {
  2311. "bearer_auth": []
  2312. },
  2313. {
  2314. "basic_auth": []
  2315. }
  2316. ],
  2317. "parameters": [
  2318. {
  2319. "name": "id",
  2320. "in": "path",
  2321. "description": "ID of the share",
  2322. "required": true,
  2323. "schema": {
  2324. "type": "string"
  2325. }
  2326. },
  2327. {
  2328. "name": "OCS-APIRequest",
  2329. "in": "header",
  2330. "description": "Required to be true for the API request to pass",
  2331. "required": true,
  2332. "schema": {
  2333. "type": "boolean",
  2334. "default": true
  2335. }
  2336. }
  2337. ],
  2338. "responses": {
  2339. "200": {
  2340. "description": "Share deleted successfully",
  2341. "content": {
  2342. "application/json": {
  2343. "schema": {
  2344. "type": "object",
  2345. "required": [
  2346. "ocs"
  2347. ],
  2348. "properties": {
  2349. "ocs": {
  2350. "type": "object",
  2351. "required": [
  2352. "meta",
  2353. "data"
  2354. ],
  2355. "properties": {
  2356. "meta": {
  2357. "$ref": "#/components/schemas/OCSMeta"
  2358. },
  2359. "data": {}
  2360. }
  2361. }
  2362. }
  2363. }
  2364. }
  2365. }
  2366. },
  2367. "404": {
  2368. "description": "Share not found",
  2369. "content": {
  2370. "text/plain": {
  2371. "schema": {
  2372. "type": "string"
  2373. }
  2374. }
  2375. }
  2376. },
  2377. "403": {
  2378. "description": "Missing permissions to delete the share",
  2379. "content": {
  2380. "text/plain": {
  2381. "schema": {
  2382. "type": "string"
  2383. }
  2384. }
  2385. }
  2386. }
  2387. }
  2388. }
  2389. },
  2390. "/ocs/v2.php/apps/files_sharing/api/v1/shares/pending/{id}": {
  2391. "post": {
  2392. "operationId": "shareapi-accept-share",
  2393. "summary": "Accept a share",
  2394. "tags": [
  2395. "shareapi"
  2396. ],
  2397. "security": [
  2398. {
  2399. "bearer_auth": []
  2400. },
  2401. {
  2402. "basic_auth": []
  2403. }
  2404. ],
  2405. "parameters": [
  2406. {
  2407. "name": "id",
  2408. "in": "path",
  2409. "description": "ID of the share",
  2410. "required": true,
  2411. "schema": {
  2412. "type": "string"
  2413. }
  2414. },
  2415. {
  2416. "name": "OCS-APIRequest",
  2417. "in": "header",
  2418. "description": "Required to be true for the API request to pass",
  2419. "required": true,
  2420. "schema": {
  2421. "type": "boolean",
  2422. "default": true
  2423. }
  2424. }
  2425. ],
  2426. "responses": {
  2427. "200": {
  2428. "description": "Share accepted successfully",
  2429. "content": {
  2430. "application/json": {
  2431. "schema": {
  2432. "type": "object",
  2433. "required": [
  2434. "ocs"
  2435. ],
  2436. "properties": {
  2437. "ocs": {
  2438. "type": "object",
  2439. "required": [
  2440. "meta",
  2441. "data"
  2442. ],
  2443. "properties": {
  2444. "meta": {
  2445. "$ref": "#/components/schemas/OCSMeta"
  2446. },
  2447. "data": {}
  2448. }
  2449. }
  2450. }
  2451. }
  2452. }
  2453. }
  2454. },
  2455. "404": {
  2456. "description": "Share not found",
  2457. "content": {
  2458. "text/plain": {
  2459. "schema": {
  2460. "type": "string"
  2461. }
  2462. }
  2463. }
  2464. },
  2465. "400": {
  2466. "description": "Share could not be accepted",
  2467. "content": {
  2468. "text/plain": {
  2469. "schema": {
  2470. "type": "string"
  2471. }
  2472. }
  2473. }
  2474. }
  2475. }
  2476. }
  2477. },
  2478. "/ocs/v2.php/apps/files_sharing/api/v1/deletedshares": {
  2479. "get": {
  2480. "operationId": "deleted_shareapi-index",
  2481. "summary": "Get a list of all deleted shares",
  2482. "tags": [
  2483. "deleted_shareapi"
  2484. ],
  2485. "security": [
  2486. {
  2487. "bearer_auth": []
  2488. },
  2489. {
  2490. "basic_auth": []
  2491. }
  2492. ],
  2493. "parameters": [
  2494. {
  2495. "name": "OCS-APIRequest",
  2496. "in": "header",
  2497. "description": "Required to be true for the API request to pass",
  2498. "required": true,
  2499. "schema": {
  2500. "type": "boolean",
  2501. "default": true
  2502. }
  2503. }
  2504. ],
  2505. "responses": {
  2506. "200": {
  2507. "description": "Deleted shares returned",
  2508. "content": {
  2509. "application/json": {
  2510. "schema": {
  2511. "type": "object",
  2512. "required": [
  2513. "ocs"
  2514. ],
  2515. "properties": {
  2516. "ocs": {
  2517. "type": "object",
  2518. "required": [
  2519. "meta",
  2520. "data"
  2521. ],
  2522. "properties": {
  2523. "meta": {
  2524. "$ref": "#/components/schemas/OCSMeta"
  2525. },
  2526. "data": {
  2527. "type": "array",
  2528. "items": {
  2529. "$ref": "#/components/schemas/DeletedShare"
  2530. }
  2531. }
  2532. }
  2533. }
  2534. }
  2535. }
  2536. }
  2537. }
  2538. }
  2539. }
  2540. }
  2541. },
  2542. "/ocs/v2.php/apps/files_sharing/api/v1/deletedshares/{id}": {
  2543. "post": {
  2544. "operationId": "deleted_shareapi-undelete",
  2545. "summary": "Undelete a deleted share",
  2546. "tags": [
  2547. "deleted_shareapi"
  2548. ],
  2549. "security": [
  2550. {
  2551. "bearer_auth": []
  2552. },
  2553. {
  2554. "basic_auth": []
  2555. }
  2556. ],
  2557. "parameters": [
  2558. {
  2559. "name": "id",
  2560. "in": "path",
  2561. "description": "ID of the share",
  2562. "required": true,
  2563. "schema": {
  2564. "type": "string"
  2565. }
  2566. },
  2567. {
  2568. "name": "OCS-APIRequest",
  2569. "in": "header",
  2570. "description": "Required to be true for the API request to pass",
  2571. "required": true,
  2572. "schema": {
  2573. "type": "boolean",
  2574. "default": true
  2575. }
  2576. }
  2577. ],
  2578. "responses": {
  2579. "200": {
  2580. "description": "Share undeleted successfully",
  2581. "content": {
  2582. "application/json": {
  2583. "schema": {
  2584. "type": "object",
  2585. "required": [
  2586. "ocs"
  2587. ],
  2588. "properties": {
  2589. "ocs": {
  2590. "type": "object",
  2591. "required": [
  2592. "meta",
  2593. "data"
  2594. ],
  2595. "properties": {
  2596. "meta": {
  2597. "$ref": "#/components/schemas/OCSMeta"
  2598. },
  2599. "data": {}
  2600. }
  2601. }
  2602. }
  2603. }
  2604. }
  2605. }
  2606. },
  2607. "404": {
  2608. "description": "Share not found",
  2609. "content": {
  2610. "text/plain": {
  2611. "schema": {
  2612. "type": "string"
  2613. }
  2614. }
  2615. }
  2616. }
  2617. }
  2618. }
  2619. },
  2620. "/ocs/v2.php/apps/files_sharing/api/v1/sharees": {
  2621. "get": {
  2622. "operationId": "shareesapi-search",
  2623. "summary": "Search for sharees",
  2624. "tags": [
  2625. "shareesapi"
  2626. ],
  2627. "security": [
  2628. {
  2629. "bearer_auth": []
  2630. },
  2631. {
  2632. "basic_auth": []
  2633. }
  2634. ],
  2635. "parameters": [
  2636. {
  2637. "name": "search",
  2638. "in": "query",
  2639. "description": "Text to search for",
  2640. "schema": {
  2641. "type": "string",
  2642. "default": ""
  2643. }
  2644. },
  2645. {
  2646. "name": "itemType",
  2647. "in": "query",
  2648. "description": "Limit to specific item types",
  2649. "schema": {
  2650. "type": "string",
  2651. "nullable": true
  2652. }
  2653. },
  2654. {
  2655. "name": "page",
  2656. "in": "query",
  2657. "description": "Page offset for searching",
  2658. "schema": {
  2659. "type": "integer",
  2660. "format": "int64",
  2661. "default": 1
  2662. }
  2663. },
  2664. {
  2665. "name": "perPage",
  2666. "in": "query",
  2667. "description": "Limit amount of search results per page",
  2668. "schema": {
  2669. "type": "integer",
  2670. "format": "int64",
  2671. "default": 200
  2672. }
  2673. },
  2674. {
  2675. "name": "shareType",
  2676. "in": "query",
  2677. "description": "Limit to specific share types",
  2678. "schema": {
  2679. "nullable": true,
  2680. "oneOf": [
  2681. {
  2682. "type": "integer",
  2683. "format": "int64"
  2684. },
  2685. {
  2686. "type": "array",
  2687. "items": {
  2688. "type": "integer",
  2689. "format": "int64"
  2690. }
  2691. }
  2692. ]
  2693. }
  2694. },
  2695. {
  2696. "name": "lookup",
  2697. "in": "query",
  2698. "description": "If a global lookup should be performed too",
  2699. "schema": {
  2700. "type": "integer",
  2701. "default": 0,
  2702. "enum": [
  2703. 0,
  2704. 1
  2705. ]
  2706. }
  2707. },
  2708. {
  2709. "name": "OCS-APIRequest",
  2710. "in": "header",
  2711. "description": "Required to be true for the API request to pass",
  2712. "required": true,
  2713. "schema": {
  2714. "type": "boolean",
  2715. "default": true
  2716. }
  2717. }
  2718. ],
  2719. "responses": {
  2720. "200": {
  2721. "description": "Sharees search result returned",
  2722. "headers": {
  2723. "Link": {
  2724. "schema": {
  2725. "type": "string"
  2726. }
  2727. }
  2728. },
  2729. "content": {
  2730. "application/json": {
  2731. "schema": {
  2732. "type": "object",
  2733. "required": [
  2734. "ocs"
  2735. ],
  2736. "properties": {
  2737. "ocs": {
  2738. "type": "object",
  2739. "required": [
  2740. "meta",
  2741. "data"
  2742. ],
  2743. "properties": {
  2744. "meta": {
  2745. "$ref": "#/components/schemas/OCSMeta"
  2746. },
  2747. "data": {
  2748. "$ref": "#/components/schemas/ShareesSearchResult"
  2749. }
  2750. }
  2751. }
  2752. }
  2753. }
  2754. }
  2755. }
  2756. },
  2757. "400": {
  2758. "description": "Invalid search parameters",
  2759. "content": {
  2760. "text/plain": {
  2761. "schema": {
  2762. "type": "string"
  2763. }
  2764. }
  2765. }
  2766. }
  2767. }
  2768. }
  2769. },
  2770. "/ocs/v2.php/apps/files_sharing/api/v1/sharees_recommended": {
  2771. "get": {
  2772. "operationId": "shareesapi-find-recommended",
  2773. "summary": "Find recommended sharees",
  2774. "tags": [
  2775. "shareesapi"
  2776. ],
  2777. "security": [
  2778. {
  2779. "bearer_auth": []
  2780. },
  2781. {
  2782. "basic_auth": []
  2783. }
  2784. ],
  2785. "parameters": [
  2786. {
  2787. "name": "itemType",
  2788. "in": "query",
  2789. "description": "Limit to specific item types",
  2790. "required": true,
  2791. "schema": {
  2792. "type": "string"
  2793. }
  2794. },
  2795. {
  2796. "name": "shareType",
  2797. "in": "query",
  2798. "description": "Limit to specific share types",
  2799. "schema": {
  2800. "nullable": true,
  2801. "oneOf": [
  2802. {
  2803. "type": "integer",
  2804. "format": "int64"
  2805. },
  2806. {
  2807. "type": "array",
  2808. "items": {
  2809. "type": "integer",
  2810. "format": "int64"
  2811. }
  2812. }
  2813. ]
  2814. }
  2815. },
  2816. {
  2817. "name": "OCS-APIRequest",
  2818. "in": "header",
  2819. "description": "Required to be true for the API request to pass",
  2820. "required": true,
  2821. "schema": {
  2822. "type": "boolean",
  2823. "default": true
  2824. }
  2825. }
  2826. ],
  2827. "responses": {
  2828. "200": {
  2829. "description": "Recommended sharees returned",
  2830. "content": {
  2831. "application/json": {
  2832. "schema": {
  2833. "type": "object",
  2834. "required": [
  2835. "ocs"
  2836. ],
  2837. "properties": {
  2838. "ocs": {
  2839. "type": "object",
  2840. "required": [
  2841. "meta",
  2842. "data"
  2843. ],
  2844. "properties": {
  2845. "meta": {
  2846. "$ref": "#/components/schemas/OCSMeta"
  2847. },
  2848. "data": {
  2849. "$ref": "#/components/schemas/ShareesRecommendedResult"
  2850. }
  2851. }
  2852. }
  2853. }
  2854. }
  2855. }
  2856. }
  2857. }
  2858. }
  2859. }
  2860. },
  2861. "/ocs/v2.php/apps/files_sharing/api/v1/remote_shares": {
  2862. "get": {
  2863. "operationId": "remote-get-shares",
  2864. "summary": "Get a list of accepted remote shares",
  2865. "tags": [
  2866. "remote"
  2867. ],
  2868. "security": [
  2869. {
  2870. "bearer_auth": []
  2871. },
  2872. {
  2873. "basic_auth": []
  2874. }
  2875. ],
  2876. "parameters": [
  2877. {
  2878. "name": "OCS-APIRequest",
  2879. "in": "header",
  2880. "description": "Required to be true for the API request to pass",
  2881. "required": true,
  2882. "schema": {
  2883. "type": "boolean",
  2884. "default": true
  2885. }
  2886. }
  2887. ],
  2888. "responses": {
  2889. "200": {
  2890. "description": "Accepted remote shares returned",
  2891. "content": {
  2892. "application/json": {
  2893. "schema": {
  2894. "type": "object",
  2895. "required": [
  2896. "ocs"
  2897. ],
  2898. "properties": {
  2899. "ocs": {
  2900. "type": "object",
  2901. "required": [
  2902. "meta",
  2903. "data"
  2904. ],
  2905. "properties": {
  2906. "meta": {
  2907. "$ref": "#/components/schemas/OCSMeta"
  2908. },
  2909. "data": {
  2910. "type": "array",
  2911. "items": {
  2912. "$ref": "#/components/schemas/RemoteShare"
  2913. }
  2914. }
  2915. }
  2916. }
  2917. }
  2918. }
  2919. }
  2920. }
  2921. }
  2922. }
  2923. }
  2924. },
  2925. "/ocs/v2.php/apps/files_sharing/api/v1/remote_shares/pending": {
  2926. "get": {
  2927. "operationId": "remote-get-open-shares",
  2928. "summary": "Get list of pending remote shares",
  2929. "tags": [
  2930. "remote"
  2931. ],
  2932. "security": [
  2933. {
  2934. "bearer_auth": []
  2935. },
  2936. {
  2937. "basic_auth": []
  2938. }
  2939. ],
  2940. "parameters": [
  2941. {
  2942. "name": "OCS-APIRequest",
  2943. "in": "header",
  2944. "description": "Required to be true for the API request to pass",
  2945. "required": true,
  2946. "schema": {
  2947. "type": "boolean",
  2948. "default": true
  2949. }
  2950. }
  2951. ],
  2952. "responses": {
  2953. "200": {
  2954. "description": "Pending remote shares returned",
  2955. "content": {
  2956. "application/json": {
  2957. "schema": {
  2958. "type": "object",
  2959. "required": [
  2960. "ocs"
  2961. ],
  2962. "properties": {
  2963. "ocs": {
  2964. "type": "object",
  2965. "required": [
  2966. "meta",
  2967. "data"
  2968. ],
  2969. "properties": {
  2970. "meta": {
  2971. "$ref": "#/components/schemas/OCSMeta"
  2972. },
  2973. "data": {
  2974. "type": "array",
  2975. "items": {
  2976. "$ref": "#/components/schemas/RemoteShare"
  2977. }
  2978. }
  2979. }
  2980. }
  2981. }
  2982. }
  2983. }
  2984. }
  2985. }
  2986. }
  2987. }
  2988. },
  2989. "/ocs/v2.php/apps/files_sharing/api/v1/remote_shares/pending/{id}": {
  2990. "post": {
  2991. "operationId": "remote-accept-share",
  2992. "summary": "Accept a remote share",
  2993. "tags": [
  2994. "remote"
  2995. ],
  2996. "security": [
  2997. {
  2998. "bearer_auth": []
  2999. },
  3000. {
  3001. "basic_auth": []
  3002. }
  3003. ],
  3004. "parameters": [
  3005. {
  3006. "name": "id",
  3007. "in": "path",
  3008. "description": "ID of the share",
  3009. "required": true,
  3010. "schema": {
  3011. "type": "integer",
  3012. "format": "int64"
  3013. }
  3014. },
  3015. {
  3016. "name": "OCS-APIRequest",
  3017. "in": "header",
  3018. "description": "Required to be true for the API request to pass",
  3019. "required": true,
  3020. "schema": {
  3021. "type": "boolean",
  3022. "default": true
  3023. }
  3024. }
  3025. ],
  3026. "responses": {
  3027. "200": {
  3028. "description": "Share accepted successfully",
  3029. "content": {
  3030. "application/json": {
  3031. "schema": {
  3032. "type": "object",
  3033. "required": [
  3034. "ocs"
  3035. ],
  3036. "properties": {
  3037. "ocs": {
  3038. "type": "object",
  3039. "required": [
  3040. "meta",
  3041. "data"
  3042. ],
  3043. "properties": {
  3044. "meta": {
  3045. "$ref": "#/components/schemas/OCSMeta"
  3046. },
  3047. "data": {}
  3048. }
  3049. }
  3050. }
  3051. }
  3052. }
  3053. }
  3054. },
  3055. "404": {
  3056. "description": "Share not found",
  3057. "content": {
  3058. "text/plain": {
  3059. "schema": {
  3060. "type": "string"
  3061. }
  3062. }
  3063. }
  3064. }
  3065. }
  3066. },
  3067. "delete": {
  3068. "operationId": "remote-decline-share",
  3069. "summary": "Decline a remote share",
  3070. "tags": [
  3071. "remote"
  3072. ],
  3073. "security": [
  3074. {
  3075. "bearer_auth": []
  3076. },
  3077. {
  3078. "basic_auth": []
  3079. }
  3080. ],
  3081. "parameters": [
  3082. {
  3083. "name": "id",
  3084. "in": "path",
  3085. "description": "ID of the share",
  3086. "required": true,
  3087. "schema": {
  3088. "type": "integer",
  3089. "format": "int64"
  3090. }
  3091. },
  3092. {
  3093. "name": "OCS-APIRequest",
  3094. "in": "header",
  3095. "description": "Required to be true for the API request to pass",
  3096. "required": true,
  3097. "schema": {
  3098. "type": "boolean",
  3099. "default": true
  3100. }
  3101. }
  3102. ],
  3103. "responses": {
  3104. "200": {
  3105. "description": "Share declined successfully",
  3106. "content": {
  3107. "application/json": {
  3108. "schema": {
  3109. "type": "object",
  3110. "required": [
  3111. "ocs"
  3112. ],
  3113. "properties": {
  3114. "ocs": {
  3115. "type": "object",
  3116. "required": [
  3117. "meta",
  3118. "data"
  3119. ],
  3120. "properties": {
  3121. "meta": {
  3122. "$ref": "#/components/schemas/OCSMeta"
  3123. },
  3124. "data": {}
  3125. }
  3126. }
  3127. }
  3128. }
  3129. }
  3130. }
  3131. },
  3132. "404": {
  3133. "description": "Share not found",
  3134. "content": {
  3135. "text/plain": {
  3136. "schema": {
  3137. "type": "string"
  3138. }
  3139. }
  3140. }
  3141. }
  3142. }
  3143. }
  3144. },
  3145. "/ocs/v2.php/apps/files_sharing/api/v1/remote_shares/{id}": {
  3146. "get": {
  3147. "operationId": "remote-get-share",
  3148. "summary": "Get info of a remote share",
  3149. "tags": [
  3150. "remote"
  3151. ],
  3152. "security": [
  3153. {
  3154. "bearer_auth": []
  3155. },
  3156. {
  3157. "basic_auth": []
  3158. }
  3159. ],
  3160. "parameters": [
  3161. {
  3162. "name": "id",
  3163. "in": "path",
  3164. "description": "ID of the share",
  3165. "required": true,
  3166. "schema": {
  3167. "type": "integer",
  3168. "format": "int64"
  3169. }
  3170. },
  3171. {
  3172. "name": "OCS-APIRequest",
  3173. "in": "header",
  3174. "description": "Required to be true for the API request to pass",
  3175. "required": true,
  3176. "schema": {
  3177. "type": "boolean",
  3178. "default": true
  3179. }
  3180. }
  3181. ],
  3182. "responses": {
  3183. "200": {
  3184. "description": "Share returned",
  3185. "content": {
  3186. "application/json": {
  3187. "schema": {
  3188. "type": "object",
  3189. "required": [
  3190. "ocs"
  3191. ],
  3192. "properties": {
  3193. "ocs": {
  3194. "type": "object",
  3195. "required": [
  3196. "meta",
  3197. "data"
  3198. ],
  3199. "properties": {
  3200. "meta": {
  3201. "$ref": "#/components/schemas/OCSMeta"
  3202. },
  3203. "data": {
  3204. "$ref": "#/components/schemas/RemoteShare"
  3205. }
  3206. }
  3207. }
  3208. }
  3209. }
  3210. }
  3211. }
  3212. },
  3213. "404": {
  3214. "description": "Share not found",
  3215. "content": {
  3216. "text/plain": {
  3217. "schema": {
  3218. "type": "string"
  3219. }
  3220. }
  3221. }
  3222. }
  3223. }
  3224. },
  3225. "delete": {
  3226. "operationId": "remote-unshare",
  3227. "summary": "Unshare a remote share",
  3228. "tags": [
  3229. "remote"
  3230. ],
  3231. "security": [
  3232. {
  3233. "bearer_auth": []
  3234. },
  3235. {
  3236. "basic_auth": []
  3237. }
  3238. ],
  3239. "parameters": [
  3240. {
  3241. "name": "id",
  3242. "in": "path",
  3243. "description": "ID of the share",
  3244. "required": true,
  3245. "schema": {
  3246. "type": "integer",
  3247. "format": "int64"
  3248. }
  3249. },
  3250. {
  3251. "name": "OCS-APIRequest",
  3252. "in": "header",
  3253. "description": "Required to be true for the API request to pass",
  3254. "required": true,
  3255. "schema": {
  3256. "type": "boolean",
  3257. "default": true
  3258. }
  3259. }
  3260. ],
  3261. "responses": {
  3262. "200": {
  3263. "description": "Share unshared successfully",
  3264. "content": {
  3265. "application/json": {
  3266. "schema": {
  3267. "type": "object",
  3268. "required": [
  3269. "ocs"
  3270. ],
  3271. "properties": {
  3272. "ocs": {
  3273. "type": "object",
  3274. "required": [
  3275. "meta",
  3276. "data"
  3277. ],
  3278. "properties": {
  3279. "meta": {
  3280. "$ref": "#/components/schemas/OCSMeta"
  3281. },
  3282. "data": {}
  3283. }
  3284. }
  3285. }
  3286. }
  3287. }
  3288. }
  3289. },
  3290. "404": {
  3291. "description": "Share not found",
  3292. "content": {
  3293. "text/plain": {
  3294. "schema": {
  3295. "type": "string"
  3296. }
  3297. }
  3298. }
  3299. },
  3300. "403": {
  3301. "description": "Unsharing is not possible",
  3302. "content": {
  3303. "text/plain": {
  3304. "schema": {
  3305. "type": "string"
  3306. }
  3307. }
  3308. }
  3309. }
  3310. }
  3311. }
  3312. }
  3313. },
  3314. "tags": [
  3315. {
  3316. "name": "external_shares",
  3317. "description": "Class ExternalSharesController"
  3318. }
  3319. ]
  3320. }