1
0

openapi.json 119 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086
  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. "id",
  483. "item_source",
  484. "item_type",
  485. "label",
  486. "mail_send",
  487. "mimetype",
  488. "note",
  489. "password",
  490. "password_expiration_time",
  491. "path",
  492. "permissions",
  493. "send_password_by_talk",
  494. "share_type",
  495. "share_with",
  496. "share_with_avatar",
  497. "share_with_displayname",
  498. "share_with_link",
  499. "status",
  500. "stime",
  501. "storage",
  502. "storage_id",
  503. "token",
  504. "uid_file_owner",
  505. "uid_owner",
  506. "url"
  507. ],
  508. "properties": {
  509. "attributes": {
  510. "type": "string",
  511. "nullable": true
  512. },
  513. "can_delete": {
  514. "type": "boolean"
  515. },
  516. "can_edit": {
  517. "type": "boolean"
  518. },
  519. "displayname_file_owner": {
  520. "type": "string"
  521. },
  522. "displayname_owner": {
  523. "type": "string"
  524. },
  525. "expiration": {
  526. "type": "string",
  527. "nullable": true
  528. },
  529. "file_parent": {
  530. "type": "integer",
  531. "format": "int64"
  532. },
  533. "file_source": {
  534. "type": "integer",
  535. "format": "int64"
  536. },
  537. "file_target": {
  538. "type": "string"
  539. },
  540. "has_preview": {
  541. "type": "boolean"
  542. },
  543. "id": {
  544. "type": "string"
  545. },
  546. "item_source": {
  547. "type": "integer",
  548. "format": "int64"
  549. },
  550. "item_type": {
  551. "type": "string"
  552. },
  553. "label": {
  554. "type": "string"
  555. },
  556. "mail_send": {
  557. "type": "integer",
  558. "format": "int64"
  559. },
  560. "mimetype": {
  561. "type": "string"
  562. },
  563. "note": {
  564. "type": "string"
  565. },
  566. "password": {
  567. "type": "string",
  568. "nullable": true
  569. },
  570. "password_expiration_time": {
  571. "type": "string",
  572. "nullable": true
  573. },
  574. "path": {
  575. "type": "string"
  576. },
  577. "permissions": {
  578. "type": "integer",
  579. "format": "int64"
  580. },
  581. "send_password_by_talk": {
  582. "type": "boolean",
  583. "nullable": true
  584. },
  585. "share_type": {
  586. "type": "integer",
  587. "format": "int64"
  588. },
  589. "share_with": {
  590. "type": "string",
  591. "nullable": true
  592. },
  593. "share_with_avatar": {
  594. "type": "string",
  595. "nullable": true
  596. },
  597. "share_with_displayname": {
  598. "type": "string",
  599. "nullable": true
  600. },
  601. "share_with_link": {
  602. "type": "string",
  603. "nullable": true
  604. },
  605. "status": {
  606. "nullable": true,
  607. "oneOf": [
  608. {
  609. "type": "object",
  610. "required": [
  611. "status",
  612. "message",
  613. "icon",
  614. "clearAt"
  615. ],
  616. "properties": {
  617. "status": {
  618. "type": "string"
  619. },
  620. "message": {
  621. "type": "string",
  622. "nullable": true
  623. },
  624. "icon": {
  625. "type": "string",
  626. "nullable": true
  627. },
  628. "clearAt": {
  629. "type": "integer",
  630. "format": "int64",
  631. "nullable": true
  632. }
  633. }
  634. },
  635. {
  636. "type": "integer",
  637. "format": "int64"
  638. }
  639. ]
  640. },
  641. "stime": {
  642. "type": "integer",
  643. "format": "int64"
  644. },
  645. "storage": {
  646. "type": "integer",
  647. "format": "int64"
  648. },
  649. "storage_id": {
  650. "type": "string"
  651. },
  652. "token": {
  653. "type": "string",
  654. "nullable": true
  655. },
  656. "uid_file_owner": {
  657. "type": "string"
  658. },
  659. "uid_owner": {
  660. "type": "string"
  661. },
  662. "url": {
  663. "type": "string",
  664. "nullable": true
  665. }
  666. }
  667. },
  668. "ShareInfo": {
  669. "type": "object",
  670. "required": [
  671. "id",
  672. "parentId",
  673. "mtime",
  674. "name",
  675. "permissions",
  676. "mimetype",
  677. "size",
  678. "type",
  679. "etag",
  680. "children"
  681. ],
  682. "properties": {
  683. "id": {
  684. "type": "integer",
  685. "format": "int64"
  686. },
  687. "parentId": {
  688. "type": "integer",
  689. "format": "int64"
  690. },
  691. "mtime": {
  692. "type": "integer",
  693. "format": "int64"
  694. },
  695. "name": {
  696. "type": "string"
  697. },
  698. "permissions": {
  699. "type": "integer",
  700. "format": "int64"
  701. },
  702. "mimetype": {
  703. "type": "string"
  704. },
  705. "size": {
  706. "type": "integer",
  707. "format": "int64"
  708. },
  709. "type": {
  710. "type": "string"
  711. },
  712. "etag": {
  713. "type": "string"
  714. },
  715. "children": {
  716. "type": "array",
  717. "nullable": true,
  718. "items": {
  719. "type": "object",
  720. "additionalProperties": {
  721. "type": "object"
  722. }
  723. }
  724. }
  725. }
  726. },
  727. "Sharee": {
  728. "type": "object",
  729. "required": [
  730. "count",
  731. "label"
  732. ],
  733. "properties": {
  734. "count": {
  735. "type": "integer",
  736. "format": "int64",
  737. "nullable": true
  738. },
  739. "label": {
  740. "type": "string"
  741. }
  742. }
  743. },
  744. "ShareeCircle": {
  745. "allOf": [
  746. {
  747. "$ref": "#/components/schemas/Sharee"
  748. },
  749. {
  750. "type": "object",
  751. "required": [
  752. "shareWithDescription",
  753. "value"
  754. ],
  755. "properties": {
  756. "shareWithDescription": {
  757. "type": "string"
  758. },
  759. "value": {
  760. "allOf": [
  761. {
  762. "$ref": "#/components/schemas/ShareeValue"
  763. },
  764. {
  765. "type": "object",
  766. "required": [
  767. "circle"
  768. ],
  769. "properties": {
  770. "circle": {
  771. "type": "string"
  772. }
  773. }
  774. }
  775. ]
  776. }
  777. }
  778. }
  779. ]
  780. },
  781. "ShareeEmail": {
  782. "allOf": [
  783. {
  784. "$ref": "#/components/schemas/Sharee"
  785. },
  786. {
  787. "type": "object",
  788. "required": [
  789. "uuid",
  790. "name",
  791. "type",
  792. "shareWithDisplayNameUnique",
  793. "value"
  794. ],
  795. "properties": {
  796. "uuid": {
  797. "type": "string"
  798. },
  799. "name": {
  800. "type": "string"
  801. },
  802. "type": {
  803. "type": "string"
  804. },
  805. "shareWithDisplayNameUnique": {
  806. "type": "string"
  807. },
  808. "value": {
  809. "$ref": "#/components/schemas/ShareeValue"
  810. }
  811. }
  812. }
  813. ]
  814. },
  815. "ShareeLookup": {
  816. "allOf": [
  817. {
  818. "$ref": "#/components/schemas/Sharee"
  819. },
  820. {
  821. "type": "object",
  822. "required": [
  823. "extra",
  824. "value"
  825. ],
  826. "properties": {
  827. "extra": {
  828. "type": "object",
  829. "required": [
  830. "federationId",
  831. "name",
  832. "email",
  833. "address",
  834. "website",
  835. "twitter",
  836. "phone",
  837. "twitter_signature",
  838. "website_signature",
  839. "userid"
  840. ],
  841. "properties": {
  842. "federationId": {
  843. "type": "string"
  844. },
  845. "name": {
  846. "$ref": "#/components/schemas/Lookup",
  847. "nullable": true
  848. },
  849. "email": {
  850. "$ref": "#/components/schemas/Lookup",
  851. "nullable": true
  852. },
  853. "address": {
  854. "$ref": "#/components/schemas/Lookup",
  855. "nullable": true
  856. },
  857. "website": {
  858. "$ref": "#/components/schemas/Lookup",
  859. "nullable": true
  860. },
  861. "twitter": {
  862. "$ref": "#/components/schemas/Lookup",
  863. "nullable": true
  864. },
  865. "phone": {
  866. "$ref": "#/components/schemas/Lookup",
  867. "nullable": true
  868. },
  869. "twitter_signature": {
  870. "$ref": "#/components/schemas/Lookup",
  871. "nullable": true
  872. },
  873. "website_signature": {
  874. "$ref": "#/components/schemas/Lookup",
  875. "nullable": true
  876. },
  877. "userid": {
  878. "$ref": "#/components/schemas/Lookup",
  879. "nullable": true
  880. }
  881. }
  882. },
  883. "value": {
  884. "allOf": [
  885. {
  886. "$ref": "#/components/schemas/ShareeValue"
  887. },
  888. {
  889. "type": "object",
  890. "required": [
  891. "globalScale"
  892. ],
  893. "properties": {
  894. "globalScale": {
  895. "type": "boolean"
  896. }
  897. }
  898. }
  899. ]
  900. }
  901. }
  902. }
  903. ]
  904. },
  905. "ShareeRemote": {
  906. "allOf": [
  907. {
  908. "$ref": "#/components/schemas/Sharee"
  909. },
  910. {
  911. "type": "object",
  912. "required": [
  913. "uuid",
  914. "name",
  915. "type",
  916. "value"
  917. ],
  918. "properties": {
  919. "uuid": {
  920. "type": "string"
  921. },
  922. "name": {
  923. "type": "string"
  924. },
  925. "type": {
  926. "type": "string"
  927. },
  928. "value": {
  929. "allOf": [
  930. {
  931. "$ref": "#/components/schemas/ShareeValue"
  932. },
  933. {
  934. "type": "object",
  935. "required": [
  936. "server"
  937. ],
  938. "properties": {
  939. "server": {
  940. "type": "string"
  941. }
  942. }
  943. }
  944. ]
  945. }
  946. }
  947. }
  948. ]
  949. },
  950. "ShareeRemoteGroup": {
  951. "allOf": [
  952. {
  953. "$ref": "#/components/schemas/Sharee"
  954. },
  955. {
  956. "type": "object",
  957. "required": [
  958. "guid",
  959. "name",
  960. "value"
  961. ],
  962. "properties": {
  963. "guid": {
  964. "type": "string"
  965. },
  966. "name": {
  967. "type": "string"
  968. },
  969. "value": {
  970. "allOf": [
  971. {
  972. "$ref": "#/components/schemas/ShareeValue"
  973. },
  974. {
  975. "type": "object",
  976. "required": [
  977. "server"
  978. ],
  979. "properties": {
  980. "server": {
  981. "type": "string"
  982. }
  983. }
  984. }
  985. ]
  986. }
  987. }
  988. }
  989. ]
  990. },
  991. "ShareeUser": {
  992. "allOf": [
  993. {
  994. "$ref": "#/components/schemas/Sharee"
  995. },
  996. {
  997. "type": "object",
  998. "required": [
  999. "subline",
  1000. "icon",
  1001. "shareWithDisplayNameUnique",
  1002. "status",
  1003. "value"
  1004. ],
  1005. "properties": {
  1006. "subline": {
  1007. "type": "string"
  1008. },
  1009. "icon": {
  1010. "type": "string"
  1011. },
  1012. "shareWithDisplayNameUnique": {
  1013. "type": "string"
  1014. },
  1015. "status": {
  1016. "type": "object",
  1017. "required": [
  1018. "status",
  1019. "message",
  1020. "icon",
  1021. "clearAt"
  1022. ],
  1023. "properties": {
  1024. "status": {
  1025. "type": "string"
  1026. },
  1027. "message": {
  1028. "type": "string"
  1029. },
  1030. "icon": {
  1031. "type": "string"
  1032. },
  1033. "clearAt": {
  1034. "type": "integer",
  1035. "format": "int64",
  1036. "nullable": true
  1037. }
  1038. }
  1039. },
  1040. "value": {
  1041. "$ref": "#/components/schemas/ShareeValue"
  1042. }
  1043. }
  1044. }
  1045. ]
  1046. },
  1047. "ShareeValue": {
  1048. "type": "object",
  1049. "required": [
  1050. "shareType",
  1051. "shareWith"
  1052. ],
  1053. "properties": {
  1054. "shareType": {
  1055. "type": "integer",
  1056. "format": "int64"
  1057. },
  1058. "shareWith": {
  1059. "type": "string"
  1060. }
  1061. }
  1062. },
  1063. "ShareesRecommendedResult": {
  1064. "type": "object",
  1065. "required": [
  1066. "exact",
  1067. "emails",
  1068. "groups",
  1069. "remote_groups",
  1070. "remotes",
  1071. "users"
  1072. ],
  1073. "properties": {
  1074. "exact": {
  1075. "type": "object",
  1076. "required": [
  1077. "emails",
  1078. "groups",
  1079. "remote_groups",
  1080. "remotes",
  1081. "users"
  1082. ],
  1083. "properties": {
  1084. "emails": {
  1085. "type": "array",
  1086. "items": {
  1087. "$ref": "#/components/schemas/ShareeEmail"
  1088. }
  1089. },
  1090. "groups": {
  1091. "type": "array",
  1092. "items": {
  1093. "$ref": "#/components/schemas/Sharee"
  1094. }
  1095. },
  1096. "remote_groups": {
  1097. "type": "array",
  1098. "items": {
  1099. "$ref": "#/components/schemas/ShareeRemoteGroup"
  1100. }
  1101. },
  1102. "remotes": {
  1103. "type": "array",
  1104. "items": {
  1105. "$ref": "#/components/schemas/ShareeRemote"
  1106. }
  1107. },
  1108. "users": {
  1109. "type": "array",
  1110. "items": {
  1111. "$ref": "#/components/schemas/ShareeUser"
  1112. }
  1113. }
  1114. }
  1115. },
  1116. "emails": {
  1117. "type": "array",
  1118. "items": {
  1119. "$ref": "#/components/schemas/ShareeEmail"
  1120. }
  1121. },
  1122. "groups": {
  1123. "type": "array",
  1124. "items": {
  1125. "$ref": "#/components/schemas/Sharee"
  1126. }
  1127. },
  1128. "remote_groups": {
  1129. "type": "array",
  1130. "items": {
  1131. "$ref": "#/components/schemas/ShareeRemoteGroup"
  1132. }
  1133. },
  1134. "remotes": {
  1135. "type": "array",
  1136. "items": {
  1137. "$ref": "#/components/schemas/ShareeRemote"
  1138. }
  1139. },
  1140. "users": {
  1141. "type": "array",
  1142. "items": {
  1143. "$ref": "#/components/schemas/ShareeUser"
  1144. }
  1145. }
  1146. }
  1147. },
  1148. "ShareesSearchResult": {
  1149. "type": "object",
  1150. "required": [
  1151. "exact",
  1152. "circles",
  1153. "emails",
  1154. "groups",
  1155. "lookup",
  1156. "remote_groups",
  1157. "remotes",
  1158. "rooms",
  1159. "users",
  1160. "lookupEnabled"
  1161. ],
  1162. "properties": {
  1163. "exact": {
  1164. "type": "object",
  1165. "required": [
  1166. "circles",
  1167. "emails",
  1168. "groups",
  1169. "remote_groups",
  1170. "remotes",
  1171. "rooms",
  1172. "users"
  1173. ],
  1174. "properties": {
  1175. "circles": {
  1176. "type": "array",
  1177. "items": {
  1178. "$ref": "#/components/schemas/ShareeCircle"
  1179. }
  1180. },
  1181. "emails": {
  1182. "type": "array",
  1183. "items": {
  1184. "$ref": "#/components/schemas/ShareeEmail"
  1185. }
  1186. },
  1187. "groups": {
  1188. "type": "array",
  1189. "items": {
  1190. "$ref": "#/components/schemas/Sharee"
  1191. }
  1192. },
  1193. "remote_groups": {
  1194. "type": "array",
  1195. "items": {
  1196. "$ref": "#/components/schemas/ShareeRemoteGroup"
  1197. }
  1198. },
  1199. "remotes": {
  1200. "type": "array",
  1201. "items": {
  1202. "$ref": "#/components/schemas/ShareeRemote"
  1203. }
  1204. },
  1205. "rooms": {
  1206. "type": "array",
  1207. "items": {
  1208. "$ref": "#/components/schemas/Sharee"
  1209. }
  1210. },
  1211. "users": {
  1212. "type": "array",
  1213. "items": {
  1214. "$ref": "#/components/schemas/ShareeUser"
  1215. }
  1216. }
  1217. }
  1218. },
  1219. "circles": {
  1220. "type": "array",
  1221. "items": {
  1222. "$ref": "#/components/schemas/ShareeCircle"
  1223. }
  1224. },
  1225. "emails": {
  1226. "type": "array",
  1227. "items": {
  1228. "$ref": "#/components/schemas/ShareeEmail"
  1229. }
  1230. },
  1231. "groups": {
  1232. "type": "array",
  1233. "items": {
  1234. "$ref": "#/components/schemas/Sharee"
  1235. }
  1236. },
  1237. "lookup": {
  1238. "type": "array",
  1239. "items": {
  1240. "$ref": "#/components/schemas/ShareeLookup"
  1241. }
  1242. },
  1243. "remote_groups": {
  1244. "type": "array",
  1245. "items": {
  1246. "$ref": "#/components/schemas/ShareeRemoteGroup"
  1247. }
  1248. },
  1249. "remotes": {
  1250. "type": "array",
  1251. "items": {
  1252. "$ref": "#/components/schemas/ShareeRemote"
  1253. }
  1254. },
  1255. "rooms": {
  1256. "type": "array",
  1257. "items": {
  1258. "$ref": "#/components/schemas/Sharee"
  1259. }
  1260. },
  1261. "users": {
  1262. "type": "array",
  1263. "items": {
  1264. "$ref": "#/components/schemas/ShareeUser"
  1265. }
  1266. },
  1267. "lookupEnabled": {
  1268. "type": "boolean"
  1269. }
  1270. }
  1271. }
  1272. }
  1273. },
  1274. "paths": {
  1275. "/index.php/apps/files_sharing/shareinfo": {
  1276. "post": {
  1277. "operationId": "share_info-info",
  1278. "summary": "Get the info about a share",
  1279. "tags": [
  1280. "share_info"
  1281. ],
  1282. "security": [
  1283. {},
  1284. {
  1285. "bearer_auth": []
  1286. },
  1287. {
  1288. "basic_auth": []
  1289. }
  1290. ],
  1291. "parameters": [
  1292. {
  1293. "name": "t",
  1294. "in": "query",
  1295. "description": "Token of the share",
  1296. "required": true,
  1297. "schema": {
  1298. "type": "string"
  1299. }
  1300. },
  1301. {
  1302. "name": "password",
  1303. "in": "query",
  1304. "description": "Password of the share",
  1305. "schema": {
  1306. "type": "string",
  1307. "nullable": true
  1308. }
  1309. },
  1310. {
  1311. "name": "dir",
  1312. "in": "query",
  1313. "description": "Subdirectory to get info about",
  1314. "schema": {
  1315. "type": "string",
  1316. "nullable": true
  1317. }
  1318. },
  1319. {
  1320. "name": "depth",
  1321. "in": "query",
  1322. "description": "Maximum depth to get info about",
  1323. "schema": {
  1324. "type": "integer",
  1325. "format": "int64",
  1326. "default": 1
  1327. }
  1328. }
  1329. ],
  1330. "responses": {
  1331. "200": {
  1332. "description": "Share info returned",
  1333. "content": {
  1334. "application/json": {
  1335. "schema": {
  1336. "$ref": "#/components/schemas/ShareInfo"
  1337. }
  1338. }
  1339. }
  1340. },
  1341. "403": {
  1342. "description": "Getting share info not allowed",
  1343. "content": {
  1344. "application/json": {
  1345. "schema": {
  1346. "type": "object",
  1347. "additionalProperties": true
  1348. }
  1349. }
  1350. }
  1351. },
  1352. "404": {
  1353. "description": "Share not found",
  1354. "content": {
  1355. "application/json": {
  1356. "schema": {
  1357. "type": "object",
  1358. "additionalProperties": true
  1359. }
  1360. }
  1361. }
  1362. }
  1363. }
  1364. }
  1365. },
  1366. "/ocs/v2.php/apps/files_sharing/api/v1/shares": {
  1367. "get": {
  1368. "operationId": "shareapi-get-shares",
  1369. "summary": "Get shares of the current user",
  1370. "tags": [
  1371. "shareapi"
  1372. ],
  1373. "security": [
  1374. {
  1375. "bearer_auth": []
  1376. },
  1377. {
  1378. "basic_auth": []
  1379. }
  1380. ],
  1381. "parameters": [
  1382. {
  1383. "name": "shared_with_me",
  1384. "in": "query",
  1385. "description": "Only get shares with the current user",
  1386. "schema": {
  1387. "type": "string",
  1388. "default": "false"
  1389. }
  1390. },
  1391. {
  1392. "name": "reshares",
  1393. "in": "query",
  1394. "description": "Only get shares by the current user and reshares",
  1395. "schema": {
  1396. "type": "string",
  1397. "default": "false"
  1398. }
  1399. },
  1400. {
  1401. "name": "subfiles",
  1402. "in": "query",
  1403. "description": "Only get all shares in a folder",
  1404. "schema": {
  1405. "type": "string",
  1406. "default": "false"
  1407. }
  1408. },
  1409. {
  1410. "name": "path",
  1411. "in": "query",
  1412. "description": "Get shares for a specific path",
  1413. "schema": {
  1414. "type": "string",
  1415. "default": ""
  1416. }
  1417. },
  1418. {
  1419. "name": "include_tags",
  1420. "in": "query",
  1421. "description": "Include tags in the share",
  1422. "schema": {
  1423. "type": "string",
  1424. "default": "false"
  1425. }
  1426. },
  1427. {
  1428. "name": "OCS-APIRequest",
  1429. "in": "header",
  1430. "required": true,
  1431. "schema": {
  1432. "type": "string",
  1433. "default": "true"
  1434. }
  1435. }
  1436. ],
  1437. "responses": {
  1438. "200": {
  1439. "description": "Shares returned",
  1440. "content": {
  1441. "application/json": {
  1442. "schema": {
  1443. "type": "object",
  1444. "required": [
  1445. "ocs"
  1446. ],
  1447. "properties": {
  1448. "ocs": {
  1449. "type": "object",
  1450. "required": [
  1451. "meta",
  1452. "data"
  1453. ],
  1454. "properties": {
  1455. "meta": {
  1456. "$ref": "#/components/schemas/OCSMeta"
  1457. },
  1458. "data": {
  1459. "type": "array",
  1460. "items": {
  1461. "$ref": "#/components/schemas/Share"
  1462. }
  1463. }
  1464. }
  1465. }
  1466. }
  1467. }
  1468. }
  1469. }
  1470. },
  1471. "404": {
  1472. "description": "The folder was not found or is inaccessible",
  1473. "content": {
  1474. "text/plain": {
  1475. "schema": {
  1476. "type": "string"
  1477. }
  1478. }
  1479. }
  1480. }
  1481. }
  1482. },
  1483. "post": {
  1484. "operationId": "shareapi-create-share",
  1485. "summary": "Create a share",
  1486. "tags": [
  1487. "shareapi"
  1488. ],
  1489. "security": [
  1490. {
  1491. "bearer_auth": []
  1492. },
  1493. {
  1494. "basic_auth": []
  1495. }
  1496. ],
  1497. "parameters": [
  1498. {
  1499. "name": "path",
  1500. "in": "query",
  1501. "description": "Path of the share",
  1502. "schema": {
  1503. "type": "string",
  1504. "nullable": true
  1505. }
  1506. },
  1507. {
  1508. "name": "permissions",
  1509. "in": "query",
  1510. "description": "Permissions for the share",
  1511. "schema": {
  1512. "type": "integer",
  1513. "format": "int64",
  1514. "nullable": true
  1515. }
  1516. },
  1517. {
  1518. "name": "shareType",
  1519. "in": "query",
  1520. "description": "Type of the share",
  1521. "schema": {
  1522. "type": "integer",
  1523. "format": "int64",
  1524. "default": 1
  1525. }
  1526. },
  1527. {
  1528. "name": "shareWith",
  1529. "in": "query",
  1530. "description": "The entity this should be shared with",
  1531. "schema": {
  1532. "type": "string",
  1533. "nullable": true
  1534. }
  1535. },
  1536. {
  1537. "name": "publicUpload",
  1538. "in": "query",
  1539. "description": "If public uploading is allowed",
  1540. "schema": {
  1541. "type": "string",
  1542. "default": "false"
  1543. }
  1544. },
  1545. {
  1546. "name": "password",
  1547. "in": "query",
  1548. "description": "Password for the share",
  1549. "schema": {
  1550. "type": "string",
  1551. "default": ""
  1552. }
  1553. },
  1554. {
  1555. "name": "sendPasswordByTalk",
  1556. "in": "query",
  1557. "description": "Send the password for the share over Talk",
  1558. "schema": {
  1559. "type": "string",
  1560. "nullable": true
  1561. }
  1562. },
  1563. {
  1564. "name": "expireDate",
  1565. "in": "query",
  1566. "description": "Expiry date of the share",
  1567. "schema": {
  1568. "type": "string",
  1569. "default": ""
  1570. }
  1571. },
  1572. {
  1573. "name": "note",
  1574. "in": "query",
  1575. "description": "Note for the share",
  1576. "schema": {
  1577. "type": "string",
  1578. "default": ""
  1579. }
  1580. },
  1581. {
  1582. "name": "label",
  1583. "in": "query",
  1584. "description": "Label for the share (only used in link and email)",
  1585. "schema": {
  1586. "type": "string",
  1587. "default": ""
  1588. }
  1589. },
  1590. {
  1591. "name": "attributes",
  1592. "in": "query",
  1593. "description": "Additional attributes for the share",
  1594. "schema": {
  1595. "type": "string",
  1596. "nullable": true
  1597. }
  1598. },
  1599. {
  1600. "name": "OCS-APIRequest",
  1601. "in": "header",
  1602. "required": true,
  1603. "schema": {
  1604. "type": "string",
  1605. "default": "true"
  1606. }
  1607. }
  1608. ],
  1609. "responses": {
  1610. "200": {
  1611. "description": "Share created",
  1612. "content": {
  1613. "application/json": {
  1614. "schema": {
  1615. "type": "object",
  1616. "required": [
  1617. "ocs"
  1618. ],
  1619. "properties": {
  1620. "ocs": {
  1621. "type": "object",
  1622. "required": [
  1623. "meta",
  1624. "data"
  1625. ],
  1626. "properties": {
  1627. "meta": {
  1628. "$ref": "#/components/schemas/OCSMeta"
  1629. },
  1630. "data": {
  1631. "$ref": "#/components/schemas/Share"
  1632. }
  1633. }
  1634. }
  1635. }
  1636. }
  1637. }
  1638. }
  1639. },
  1640. "400": {
  1641. "description": "Unknown share type",
  1642. "content": {
  1643. "text/plain": {
  1644. "schema": {
  1645. "type": "string"
  1646. }
  1647. }
  1648. }
  1649. },
  1650. "403": {
  1651. "description": "Creating the share is not allowed",
  1652. "content": {
  1653. "text/plain": {
  1654. "schema": {
  1655. "type": "string"
  1656. }
  1657. }
  1658. }
  1659. },
  1660. "404": {
  1661. "description": "Creating the share failed",
  1662. "content": {
  1663. "text/plain": {
  1664. "schema": {
  1665. "type": "string"
  1666. }
  1667. }
  1668. }
  1669. }
  1670. }
  1671. }
  1672. },
  1673. "/ocs/v2.php/apps/files_sharing/api/v1/shares/inherited": {
  1674. "get": {
  1675. "operationId": "shareapi-get-inherited-shares",
  1676. "summary": "Get all shares relative to a file, including parent folders shares rights",
  1677. "tags": [
  1678. "shareapi"
  1679. ],
  1680. "security": [
  1681. {
  1682. "bearer_auth": []
  1683. },
  1684. {
  1685. "basic_auth": []
  1686. }
  1687. ],
  1688. "parameters": [
  1689. {
  1690. "name": "path",
  1691. "in": "query",
  1692. "description": "Path all shares will be relative to",
  1693. "required": true,
  1694. "schema": {
  1695. "type": "string"
  1696. }
  1697. },
  1698. {
  1699. "name": "OCS-APIRequest",
  1700. "in": "header",
  1701. "required": true,
  1702. "schema": {
  1703. "type": "string",
  1704. "default": "true"
  1705. }
  1706. }
  1707. ],
  1708. "responses": {
  1709. "200": {
  1710. "description": "Shares returned",
  1711. "content": {
  1712. "application/json": {
  1713. "schema": {
  1714. "type": "object",
  1715. "required": [
  1716. "ocs"
  1717. ],
  1718. "properties": {
  1719. "ocs": {
  1720. "type": "object",
  1721. "required": [
  1722. "meta",
  1723. "data"
  1724. ],
  1725. "properties": {
  1726. "meta": {
  1727. "$ref": "#/components/schemas/OCSMeta"
  1728. },
  1729. "data": {
  1730. "type": "array",
  1731. "items": {
  1732. "$ref": "#/components/schemas/Share"
  1733. }
  1734. }
  1735. }
  1736. }
  1737. }
  1738. }
  1739. }
  1740. }
  1741. },
  1742. "500": {
  1743. "description": "",
  1744. "content": {
  1745. "text/plain": {
  1746. "schema": {
  1747. "type": "string"
  1748. }
  1749. }
  1750. }
  1751. },
  1752. "404": {
  1753. "description": "The given path is invalid",
  1754. "content": {
  1755. "text/plain": {
  1756. "schema": {
  1757. "type": "string"
  1758. }
  1759. }
  1760. }
  1761. }
  1762. }
  1763. }
  1764. },
  1765. "/ocs/v2.php/apps/files_sharing/api/v1/shares/pending": {
  1766. "get": {
  1767. "operationId": "shareapi-pending-shares",
  1768. "summary": "Get all shares that are still pending",
  1769. "tags": [
  1770. "shareapi"
  1771. ],
  1772. "security": [
  1773. {
  1774. "bearer_auth": []
  1775. },
  1776. {
  1777. "basic_auth": []
  1778. }
  1779. ],
  1780. "parameters": [
  1781. {
  1782. "name": "OCS-APIRequest",
  1783. "in": "header",
  1784. "required": true,
  1785. "schema": {
  1786. "type": "string",
  1787. "default": "true"
  1788. }
  1789. }
  1790. ],
  1791. "responses": {
  1792. "200": {
  1793. "description": "",
  1794. "content": {
  1795. "application/json": {
  1796. "schema": {
  1797. "type": "object",
  1798. "required": [
  1799. "ocs"
  1800. ],
  1801. "properties": {
  1802. "ocs": {
  1803. "type": "object",
  1804. "required": [
  1805. "meta",
  1806. "data"
  1807. ],
  1808. "properties": {
  1809. "meta": {
  1810. "$ref": "#/components/schemas/OCSMeta"
  1811. },
  1812. "data": {
  1813. "type": "array",
  1814. "items": {
  1815. "$ref": "#/components/schemas/Share"
  1816. }
  1817. }
  1818. }
  1819. }
  1820. }
  1821. }
  1822. }
  1823. }
  1824. }
  1825. }
  1826. }
  1827. },
  1828. "/ocs/v2.php/apps/files_sharing/api/v1/shares/{id}": {
  1829. "get": {
  1830. "operationId": "shareapi-get-share",
  1831. "summary": "Get a specific share by id",
  1832. "tags": [
  1833. "shareapi"
  1834. ],
  1835. "security": [
  1836. {
  1837. "bearer_auth": []
  1838. },
  1839. {
  1840. "basic_auth": []
  1841. }
  1842. ],
  1843. "parameters": [
  1844. {
  1845. "name": "include_tags",
  1846. "in": "query",
  1847. "description": "Include tags in the share",
  1848. "schema": {
  1849. "type": "integer",
  1850. "default": 0
  1851. }
  1852. },
  1853. {
  1854. "name": "id",
  1855. "in": "path",
  1856. "description": "ID of the share",
  1857. "required": true,
  1858. "schema": {
  1859. "type": "string"
  1860. }
  1861. },
  1862. {
  1863. "name": "OCS-APIRequest",
  1864. "in": "header",
  1865. "required": true,
  1866. "schema": {
  1867. "type": "string",
  1868. "default": "true"
  1869. }
  1870. }
  1871. ],
  1872. "responses": {
  1873. "200": {
  1874. "description": "Share returned",
  1875. "content": {
  1876. "application/json": {
  1877. "schema": {
  1878. "type": "object",
  1879. "required": [
  1880. "ocs"
  1881. ],
  1882. "properties": {
  1883. "ocs": {
  1884. "type": "object",
  1885. "required": [
  1886. "meta",
  1887. "data"
  1888. ],
  1889. "properties": {
  1890. "meta": {
  1891. "$ref": "#/components/schemas/OCSMeta"
  1892. },
  1893. "data": {
  1894. "$ref": "#/components/schemas/Share"
  1895. }
  1896. }
  1897. }
  1898. }
  1899. }
  1900. }
  1901. }
  1902. },
  1903. "404": {
  1904. "description": "Share not found",
  1905. "content": {
  1906. "text/plain": {
  1907. "schema": {
  1908. "type": "string"
  1909. }
  1910. }
  1911. }
  1912. }
  1913. }
  1914. },
  1915. "put": {
  1916. "operationId": "shareapi-update-share",
  1917. "summary": "Update a share",
  1918. "tags": [
  1919. "shareapi"
  1920. ],
  1921. "security": [
  1922. {
  1923. "bearer_auth": []
  1924. },
  1925. {
  1926. "basic_auth": []
  1927. }
  1928. ],
  1929. "parameters": [
  1930. {
  1931. "name": "permissions",
  1932. "in": "query",
  1933. "description": "New permissions",
  1934. "schema": {
  1935. "type": "integer",
  1936. "format": "int64",
  1937. "nullable": true
  1938. }
  1939. },
  1940. {
  1941. "name": "password",
  1942. "in": "query",
  1943. "description": "New password",
  1944. "schema": {
  1945. "type": "string",
  1946. "nullable": true
  1947. }
  1948. },
  1949. {
  1950. "name": "sendPasswordByTalk",
  1951. "in": "query",
  1952. "description": "New condition if the password should be send over Talk",
  1953. "schema": {
  1954. "type": "string",
  1955. "nullable": true
  1956. }
  1957. },
  1958. {
  1959. "name": "publicUpload",
  1960. "in": "query",
  1961. "description": "New condition if public uploading is allowed",
  1962. "schema": {
  1963. "type": "string",
  1964. "nullable": true
  1965. }
  1966. },
  1967. {
  1968. "name": "expireDate",
  1969. "in": "query",
  1970. "description": "New expiry date",
  1971. "schema": {
  1972. "type": "string",
  1973. "nullable": true
  1974. }
  1975. },
  1976. {
  1977. "name": "note",
  1978. "in": "query",
  1979. "description": "New note",
  1980. "schema": {
  1981. "type": "string",
  1982. "nullable": true
  1983. }
  1984. },
  1985. {
  1986. "name": "label",
  1987. "in": "query",
  1988. "description": "New label",
  1989. "schema": {
  1990. "type": "string",
  1991. "nullable": true
  1992. }
  1993. },
  1994. {
  1995. "name": "hideDownload",
  1996. "in": "query",
  1997. "description": "New condition if the download should be hidden",
  1998. "schema": {
  1999. "type": "string",
  2000. "nullable": true
  2001. }
  2002. },
  2003. {
  2004. "name": "attributes",
  2005. "in": "query",
  2006. "description": "New additional attributes",
  2007. "schema": {
  2008. "type": "string",
  2009. "nullable": true
  2010. }
  2011. },
  2012. {
  2013. "name": "id",
  2014. "in": "path",
  2015. "description": "ID of the share",
  2016. "required": true,
  2017. "schema": {
  2018. "type": "string"
  2019. }
  2020. },
  2021. {
  2022. "name": "OCS-APIRequest",
  2023. "in": "header",
  2024. "required": true,
  2025. "schema": {
  2026. "type": "string",
  2027. "default": "true"
  2028. }
  2029. }
  2030. ],
  2031. "responses": {
  2032. "200": {
  2033. "description": "Share updated successfully",
  2034. "content": {
  2035. "application/json": {
  2036. "schema": {
  2037. "type": "object",
  2038. "required": [
  2039. "ocs"
  2040. ],
  2041. "properties": {
  2042. "ocs": {
  2043. "type": "object",
  2044. "required": [
  2045. "meta",
  2046. "data"
  2047. ],
  2048. "properties": {
  2049. "meta": {
  2050. "$ref": "#/components/schemas/OCSMeta"
  2051. },
  2052. "data": {
  2053. "$ref": "#/components/schemas/Share"
  2054. }
  2055. }
  2056. }
  2057. }
  2058. }
  2059. }
  2060. }
  2061. },
  2062. "400": {
  2063. "description": "Share could not be updated because the requested changes are invalid",
  2064. "content": {
  2065. "text/plain": {
  2066. "schema": {
  2067. "type": "string"
  2068. }
  2069. }
  2070. }
  2071. },
  2072. "403": {
  2073. "description": "Missing permissions to update the share",
  2074. "content": {
  2075. "text/plain": {
  2076. "schema": {
  2077. "type": "string"
  2078. }
  2079. }
  2080. }
  2081. },
  2082. "404": {
  2083. "description": "Share not found",
  2084. "content": {
  2085. "text/plain": {
  2086. "schema": {
  2087. "type": "string"
  2088. }
  2089. }
  2090. }
  2091. }
  2092. }
  2093. },
  2094. "delete": {
  2095. "operationId": "shareapi-delete-share",
  2096. "summary": "Delete a share",
  2097. "tags": [
  2098. "shareapi"
  2099. ],
  2100. "security": [
  2101. {
  2102. "bearer_auth": []
  2103. },
  2104. {
  2105. "basic_auth": []
  2106. }
  2107. ],
  2108. "parameters": [
  2109. {
  2110. "name": "id",
  2111. "in": "path",
  2112. "description": "ID of the share",
  2113. "required": true,
  2114. "schema": {
  2115. "type": "string"
  2116. }
  2117. },
  2118. {
  2119. "name": "OCS-APIRequest",
  2120. "in": "header",
  2121. "required": true,
  2122. "schema": {
  2123. "type": "string",
  2124. "default": "true"
  2125. }
  2126. }
  2127. ],
  2128. "responses": {
  2129. "200": {
  2130. "description": "Share deleted successfully",
  2131. "content": {
  2132. "application/json": {
  2133. "schema": {
  2134. "type": "object",
  2135. "required": [
  2136. "ocs"
  2137. ],
  2138. "properties": {
  2139. "ocs": {
  2140. "type": "object",
  2141. "required": [
  2142. "meta",
  2143. "data"
  2144. ],
  2145. "properties": {
  2146. "meta": {
  2147. "$ref": "#/components/schemas/OCSMeta"
  2148. },
  2149. "data": {
  2150. "type": "object",
  2151. "additionalProperties": true
  2152. }
  2153. }
  2154. }
  2155. }
  2156. }
  2157. }
  2158. }
  2159. },
  2160. "404": {
  2161. "description": "Share not found",
  2162. "content": {
  2163. "text/plain": {
  2164. "schema": {
  2165. "type": "string"
  2166. }
  2167. }
  2168. }
  2169. },
  2170. "403": {
  2171. "description": "Missing permissions to delete the share",
  2172. "content": {
  2173. "text/plain": {
  2174. "schema": {
  2175. "type": "string"
  2176. }
  2177. }
  2178. }
  2179. }
  2180. }
  2181. }
  2182. },
  2183. "/ocs/v2.php/apps/files_sharing/api/v1/shares/pending/{id}": {
  2184. "post": {
  2185. "operationId": "shareapi-accept-share",
  2186. "summary": "Accept a share",
  2187. "tags": [
  2188. "shareapi"
  2189. ],
  2190. "security": [
  2191. {
  2192. "bearer_auth": []
  2193. },
  2194. {
  2195. "basic_auth": []
  2196. }
  2197. ],
  2198. "parameters": [
  2199. {
  2200. "name": "id",
  2201. "in": "path",
  2202. "description": "ID of the share",
  2203. "required": true,
  2204. "schema": {
  2205. "type": "string"
  2206. }
  2207. },
  2208. {
  2209. "name": "OCS-APIRequest",
  2210. "in": "header",
  2211. "required": true,
  2212. "schema": {
  2213. "type": "string",
  2214. "default": "true"
  2215. }
  2216. }
  2217. ],
  2218. "responses": {
  2219. "200": {
  2220. "description": "Share accepted successfully",
  2221. "content": {
  2222. "application/json": {
  2223. "schema": {
  2224. "type": "object",
  2225. "required": [
  2226. "ocs"
  2227. ],
  2228. "properties": {
  2229. "ocs": {
  2230. "type": "object",
  2231. "required": [
  2232. "meta",
  2233. "data"
  2234. ],
  2235. "properties": {
  2236. "meta": {
  2237. "$ref": "#/components/schemas/OCSMeta"
  2238. },
  2239. "data": {
  2240. "type": "object",
  2241. "additionalProperties": true
  2242. }
  2243. }
  2244. }
  2245. }
  2246. }
  2247. }
  2248. }
  2249. },
  2250. "404": {
  2251. "description": "Share not found",
  2252. "content": {
  2253. "text/plain": {
  2254. "schema": {
  2255. "type": "string"
  2256. }
  2257. }
  2258. }
  2259. },
  2260. "400": {
  2261. "description": "Share could not be accepted",
  2262. "content": {
  2263. "text/plain": {
  2264. "schema": {
  2265. "type": "string"
  2266. }
  2267. }
  2268. }
  2269. }
  2270. }
  2271. }
  2272. },
  2273. "/ocs/v2.php/apps/files_sharing/api/v1/deletedshares": {
  2274. "get": {
  2275. "operationId": "deleted_shareapi-list",
  2276. "summary": "Get a list of all deleted shares",
  2277. "tags": [
  2278. "deleted_shareapi"
  2279. ],
  2280. "security": [
  2281. {
  2282. "bearer_auth": []
  2283. },
  2284. {
  2285. "basic_auth": []
  2286. }
  2287. ],
  2288. "parameters": [
  2289. {
  2290. "name": "OCS-APIRequest",
  2291. "in": "header",
  2292. "required": true,
  2293. "schema": {
  2294. "type": "string",
  2295. "default": "true"
  2296. }
  2297. }
  2298. ],
  2299. "responses": {
  2300. "200": {
  2301. "description": "",
  2302. "content": {
  2303. "application/json": {
  2304. "schema": {
  2305. "type": "object",
  2306. "required": [
  2307. "ocs"
  2308. ],
  2309. "properties": {
  2310. "ocs": {
  2311. "type": "object",
  2312. "required": [
  2313. "meta",
  2314. "data"
  2315. ],
  2316. "properties": {
  2317. "meta": {
  2318. "$ref": "#/components/schemas/OCSMeta"
  2319. },
  2320. "data": {
  2321. "type": "array",
  2322. "items": {
  2323. "$ref": "#/components/schemas/DeletedShare"
  2324. }
  2325. }
  2326. }
  2327. }
  2328. }
  2329. }
  2330. }
  2331. }
  2332. }
  2333. }
  2334. }
  2335. },
  2336. "/ocs/v2.php/apps/files_sharing/api/v1/deletedshares/{id}": {
  2337. "post": {
  2338. "operationId": "deleted_shareapi-undelete",
  2339. "summary": "Undelete a deleted share",
  2340. "tags": [
  2341. "deleted_shareapi"
  2342. ],
  2343. "security": [
  2344. {
  2345. "bearer_auth": []
  2346. },
  2347. {
  2348. "basic_auth": []
  2349. }
  2350. ],
  2351. "parameters": [
  2352. {
  2353. "name": "id",
  2354. "in": "path",
  2355. "description": "ID of the share",
  2356. "required": true,
  2357. "schema": {
  2358. "type": "string"
  2359. }
  2360. },
  2361. {
  2362. "name": "OCS-APIRequest",
  2363. "in": "header",
  2364. "required": true,
  2365. "schema": {
  2366. "type": "string",
  2367. "default": "true"
  2368. }
  2369. }
  2370. ],
  2371. "responses": {
  2372. "200": {
  2373. "description": "Share undeleted successfully",
  2374. "content": {
  2375. "application/json": {
  2376. "schema": {
  2377. "type": "object",
  2378. "required": [
  2379. "ocs"
  2380. ],
  2381. "properties": {
  2382. "ocs": {
  2383. "type": "object",
  2384. "required": [
  2385. "meta",
  2386. "data"
  2387. ],
  2388. "properties": {
  2389. "meta": {
  2390. "$ref": "#/components/schemas/OCSMeta"
  2391. },
  2392. "data": {
  2393. "type": "object",
  2394. "additionalProperties": true
  2395. }
  2396. }
  2397. }
  2398. }
  2399. }
  2400. }
  2401. }
  2402. },
  2403. "404": {
  2404. "description": "Share not found",
  2405. "content": {
  2406. "text/plain": {
  2407. "schema": {
  2408. "type": "string"
  2409. }
  2410. }
  2411. }
  2412. }
  2413. }
  2414. }
  2415. },
  2416. "/ocs/v2.php/apps/files_sharing/api/v1/sharees": {
  2417. "get": {
  2418. "operationId": "shareesapi-search",
  2419. "summary": "Search for sharees",
  2420. "tags": [
  2421. "shareesapi"
  2422. ],
  2423. "security": [
  2424. {
  2425. "bearer_auth": []
  2426. },
  2427. {
  2428. "basic_auth": []
  2429. }
  2430. ],
  2431. "parameters": [
  2432. {
  2433. "name": "search",
  2434. "in": "query",
  2435. "description": "Text to search for",
  2436. "schema": {
  2437. "type": "string",
  2438. "default": ""
  2439. }
  2440. },
  2441. {
  2442. "name": "itemType",
  2443. "in": "query",
  2444. "description": "Limit to specific item types",
  2445. "schema": {
  2446. "type": "string",
  2447. "nullable": true
  2448. }
  2449. },
  2450. {
  2451. "name": "page",
  2452. "in": "query",
  2453. "description": "Page offset for searching",
  2454. "schema": {
  2455. "type": "integer",
  2456. "format": "int64",
  2457. "default": 1
  2458. }
  2459. },
  2460. {
  2461. "name": "perPage",
  2462. "in": "query",
  2463. "description": "Limit amount of search results per page",
  2464. "schema": {
  2465. "type": "integer",
  2466. "format": "int64",
  2467. "default": 200
  2468. }
  2469. },
  2470. {
  2471. "name": "shareType",
  2472. "in": "query",
  2473. "description": "Limit to specific share types",
  2474. "schema": {
  2475. "type": "string",
  2476. "nullable": true
  2477. }
  2478. },
  2479. {
  2480. "name": "lookup",
  2481. "in": "query",
  2482. "description": "If a global lookup should be performed too",
  2483. "schema": {
  2484. "type": "integer",
  2485. "default": 0
  2486. }
  2487. },
  2488. {
  2489. "name": "OCS-APIRequest",
  2490. "in": "header",
  2491. "required": true,
  2492. "schema": {
  2493. "type": "string",
  2494. "default": "true"
  2495. }
  2496. }
  2497. ],
  2498. "responses": {
  2499. "200": {
  2500. "description": "Sharees search result returned",
  2501. "content": {
  2502. "application/json": {
  2503. "schema": {
  2504. "type": "object",
  2505. "required": [
  2506. "ocs"
  2507. ],
  2508. "properties": {
  2509. "ocs": {
  2510. "type": "object",
  2511. "required": [
  2512. "meta",
  2513. "data"
  2514. ],
  2515. "properties": {
  2516. "meta": {
  2517. "$ref": "#/components/schemas/OCSMeta"
  2518. },
  2519. "data": {
  2520. "$ref": "#/components/schemas/ShareesSearchResult"
  2521. }
  2522. }
  2523. }
  2524. }
  2525. }
  2526. }
  2527. }
  2528. },
  2529. "400": {
  2530. "description": "Invalid search parameters",
  2531. "content": {
  2532. "text/plain": {
  2533. "schema": {
  2534. "type": "string"
  2535. }
  2536. }
  2537. }
  2538. }
  2539. }
  2540. }
  2541. },
  2542. "/ocs/v2.php/apps/files_sharing/api/v1/sharees_recommended": {
  2543. "get": {
  2544. "operationId": "shareesapi-find-recommended",
  2545. "summary": "Find recommended sharees",
  2546. "tags": [
  2547. "shareesapi"
  2548. ],
  2549. "security": [
  2550. {
  2551. "bearer_auth": []
  2552. },
  2553. {
  2554. "basic_auth": []
  2555. }
  2556. ],
  2557. "parameters": [
  2558. {
  2559. "name": "itemType",
  2560. "in": "query",
  2561. "description": "Limit to specific item types",
  2562. "required": true,
  2563. "schema": {
  2564. "type": "string"
  2565. }
  2566. },
  2567. {
  2568. "name": "shareType",
  2569. "in": "query",
  2570. "description": "Limit to specific share types",
  2571. "schema": {
  2572. "type": "string",
  2573. "nullable": true
  2574. }
  2575. },
  2576. {
  2577. "name": "OCS-APIRequest",
  2578. "in": "header",
  2579. "required": true,
  2580. "schema": {
  2581. "type": "string",
  2582. "default": "true"
  2583. }
  2584. }
  2585. ],
  2586. "responses": {
  2587. "200": {
  2588. "description": "",
  2589. "content": {
  2590. "application/json": {
  2591. "schema": {
  2592. "type": "object",
  2593. "required": [
  2594. "ocs"
  2595. ],
  2596. "properties": {
  2597. "ocs": {
  2598. "type": "object",
  2599. "required": [
  2600. "meta",
  2601. "data"
  2602. ],
  2603. "properties": {
  2604. "meta": {
  2605. "$ref": "#/components/schemas/OCSMeta"
  2606. },
  2607. "data": {
  2608. "$ref": "#/components/schemas/ShareesRecommendedResult"
  2609. }
  2610. }
  2611. }
  2612. }
  2613. }
  2614. }
  2615. }
  2616. }
  2617. }
  2618. }
  2619. },
  2620. "/ocs/v2.php/apps/files_sharing/api/v1/remote_shares": {
  2621. "get": {
  2622. "operationId": "remote-get-shares",
  2623. "summary": "Get a list of accepted remote shares",
  2624. "tags": [
  2625. "remote"
  2626. ],
  2627. "security": [
  2628. {
  2629. "bearer_auth": []
  2630. },
  2631. {
  2632. "basic_auth": []
  2633. }
  2634. ],
  2635. "parameters": [
  2636. {
  2637. "name": "OCS-APIRequest",
  2638. "in": "header",
  2639. "required": true,
  2640. "schema": {
  2641. "type": "string",
  2642. "default": "true"
  2643. }
  2644. }
  2645. ],
  2646. "responses": {
  2647. "200": {
  2648. "description": "",
  2649. "content": {
  2650. "application/json": {
  2651. "schema": {
  2652. "type": "object",
  2653. "required": [
  2654. "ocs"
  2655. ],
  2656. "properties": {
  2657. "ocs": {
  2658. "type": "object",
  2659. "required": [
  2660. "meta",
  2661. "data"
  2662. ],
  2663. "properties": {
  2664. "meta": {
  2665. "$ref": "#/components/schemas/OCSMeta"
  2666. },
  2667. "data": {
  2668. "type": "array",
  2669. "items": {
  2670. "$ref": "#/components/schemas/RemoteShare"
  2671. }
  2672. }
  2673. }
  2674. }
  2675. }
  2676. }
  2677. }
  2678. }
  2679. }
  2680. }
  2681. }
  2682. },
  2683. "/ocs/v2.php/apps/files_sharing/api/v1/remote_shares/pending": {
  2684. "get": {
  2685. "operationId": "remote-get-open-shares",
  2686. "summary": "Get list of pending remote shares",
  2687. "tags": [
  2688. "remote"
  2689. ],
  2690. "security": [
  2691. {
  2692. "bearer_auth": []
  2693. },
  2694. {
  2695. "basic_auth": []
  2696. }
  2697. ],
  2698. "parameters": [
  2699. {
  2700. "name": "OCS-APIRequest",
  2701. "in": "header",
  2702. "required": true,
  2703. "schema": {
  2704. "type": "string",
  2705. "default": "true"
  2706. }
  2707. }
  2708. ],
  2709. "responses": {
  2710. "200": {
  2711. "description": "",
  2712. "content": {
  2713. "application/json": {
  2714. "schema": {
  2715. "type": "object",
  2716. "required": [
  2717. "ocs"
  2718. ],
  2719. "properties": {
  2720. "ocs": {
  2721. "type": "object",
  2722. "required": [
  2723. "meta",
  2724. "data"
  2725. ],
  2726. "properties": {
  2727. "meta": {
  2728. "$ref": "#/components/schemas/OCSMeta"
  2729. },
  2730. "data": {
  2731. "type": "array",
  2732. "items": {
  2733. "$ref": "#/components/schemas/RemoteShare"
  2734. }
  2735. }
  2736. }
  2737. }
  2738. }
  2739. }
  2740. }
  2741. }
  2742. }
  2743. }
  2744. }
  2745. },
  2746. "/ocs/v2.php/apps/files_sharing/api/v1/remote_shares/pending/{id}": {
  2747. "post": {
  2748. "operationId": "remote-accept-share",
  2749. "summary": "Accept a remote share",
  2750. "tags": [
  2751. "remote"
  2752. ],
  2753. "security": [
  2754. {
  2755. "bearer_auth": []
  2756. },
  2757. {
  2758. "basic_auth": []
  2759. }
  2760. ],
  2761. "parameters": [
  2762. {
  2763. "name": "id",
  2764. "in": "path",
  2765. "description": "ID of the share",
  2766. "required": true,
  2767. "schema": {
  2768. "type": "integer",
  2769. "format": "int64"
  2770. }
  2771. },
  2772. {
  2773. "name": "OCS-APIRequest",
  2774. "in": "header",
  2775. "required": true,
  2776. "schema": {
  2777. "type": "string",
  2778. "default": "true"
  2779. }
  2780. }
  2781. ],
  2782. "responses": {
  2783. "200": {
  2784. "description": "Share accepted successfully",
  2785. "content": {
  2786. "application/json": {
  2787. "schema": {
  2788. "type": "object",
  2789. "required": [
  2790. "ocs"
  2791. ],
  2792. "properties": {
  2793. "ocs": {
  2794. "type": "object",
  2795. "required": [
  2796. "meta",
  2797. "data"
  2798. ],
  2799. "properties": {
  2800. "meta": {
  2801. "$ref": "#/components/schemas/OCSMeta"
  2802. },
  2803. "data": {
  2804. "type": "object",
  2805. "additionalProperties": true
  2806. }
  2807. }
  2808. }
  2809. }
  2810. }
  2811. }
  2812. }
  2813. },
  2814. "404": {
  2815. "description": "Share not found",
  2816. "content": {
  2817. "text/plain": {
  2818. "schema": {
  2819. "type": "string"
  2820. }
  2821. }
  2822. }
  2823. }
  2824. }
  2825. },
  2826. "delete": {
  2827. "operationId": "remote-decline-share",
  2828. "summary": "Decline a remote share",
  2829. "tags": [
  2830. "remote"
  2831. ],
  2832. "security": [
  2833. {
  2834. "bearer_auth": []
  2835. },
  2836. {
  2837. "basic_auth": []
  2838. }
  2839. ],
  2840. "parameters": [
  2841. {
  2842. "name": "id",
  2843. "in": "path",
  2844. "description": "ID of the share",
  2845. "required": true,
  2846. "schema": {
  2847. "type": "integer",
  2848. "format": "int64"
  2849. }
  2850. },
  2851. {
  2852. "name": "OCS-APIRequest",
  2853. "in": "header",
  2854. "required": true,
  2855. "schema": {
  2856. "type": "string",
  2857. "default": "true"
  2858. }
  2859. }
  2860. ],
  2861. "responses": {
  2862. "200": {
  2863. "description": "Share declined successfully",
  2864. "content": {
  2865. "application/json": {
  2866. "schema": {
  2867. "type": "object",
  2868. "required": [
  2869. "ocs"
  2870. ],
  2871. "properties": {
  2872. "ocs": {
  2873. "type": "object",
  2874. "required": [
  2875. "meta",
  2876. "data"
  2877. ],
  2878. "properties": {
  2879. "meta": {
  2880. "$ref": "#/components/schemas/OCSMeta"
  2881. },
  2882. "data": {
  2883. "type": "object",
  2884. "additionalProperties": true
  2885. }
  2886. }
  2887. }
  2888. }
  2889. }
  2890. }
  2891. }
  2892. },
  2893. "404": {
  2894. "description": "Share not found",
  2895. "content": {
  2896. "text/plain": {
  2897. "schema": {
  2898. "type": "string"
  2899. }
  2900. }
  2901. }
  2902. }
  2903. }
  2904. }
  2905. },
  2906. "/ocs/v2.php/apps/files_sharing/api/v1/remote_shares/{id}": {
  2907. "get": {
  2908. "operationId": "remote-get-share",
  2909. "summary": "Get info of a remote share",
  2910. "tags": [
  2911. "remote"
  2912. ],
  2913. "security": [
  2914. {
  2915. "bearer_auth": []
  2916. },
  2917. {
  2918. "basic_auth": []
  2919. }
  2920. ],
  2921. "parameters": [
  2922. {
  2923. "name": "id",
  2924. "in": "path",
  2925. "description": "ID of the share",
  2926. "required": true,
  2927. "schema": {
  2928. "type": "integer",
  2929. "format": "int64"
  2930. }
  2931. },
  2932. {
  2933. "name": "OCS-APIRequest",
  2934. "in": "header",
  2935. "required": true,
  2936. "schema": {
  2937. "type": "string",
  2938. "default": "true"
  2939. }
  2940. }
  2941. ],
  2942. "responses": {
  2943. "200": {
  2944. "description": "Share returned",
  2945. "content": {
  2946. "application/json": {
  2947. "schema": {
  2948. "type": "object",
  2949. "required": [
  2950. "ocs"
  2951. ],
  2952. "properties": {
  2953. "ocs": {
  2954. "type": "object",
  2955. "required": [
  2956. "meta",
  2957. "data"
  2958. ],
  2959. "properties": {
  2960. "meta": {
  2961. "$ref": "#/components/schemas/OCSMeta"
  2962. },
  2963. "data": {
  2964. "$ref": "#/components/schemas/RemoteShare"
  2965. }
  2966. }
  2967. }
  2968. }
  2969. }
  2970. }
  2971. }
  2972. },
  2973. "404": {
  2974. "description": "Share not found",
  2975. "content": {
  2976. "text/plain": {
  2977. "schema": {
  2978. "type": "string"
  2979. }
  2980. }
  2981. }
  2982. }
  2983. }
  2984. },
  2985. "delete": {
  2986. "operationId": "remote-unshare",
  2987. "summary": "Unshare a remote share",
  2988. "tags": [
  2989. "remote"
  2990. ],
  2991. "security": [
  2992. {
  2993. "bearer_auth": []
  2994. },
  2995. {
  2996. "basic_auth": []
  2997. }
  2998. ],
  2999. "parameters": [
  3000. {
  3001. "name": "id",
  3002. "in": "path",
  3003. "description": "ID of the share",
  3004. "required": true,
  3005. "schema": {
  3006. "type": "integer",
  3007. "format": "int64"
  3008. }
  3009. },
  3010. {
  3011. "name": "OCS-APIRequest",
  3012. "in": "header",
  3013. "required": true,
  3014. "schema": {
  3015. "type": "string",
  3016. "default": "true"
  3017. }
  3018. }
  3019. ],
  3020. "responses": {
  3021. "200": {
  3022. "description": "Share unshared successfully",
  3023. "content": {
  3024. "application/json": {
  3025. "schema": {
  3026. "type": "object",
  3027. "required": [
  3028. "ocs"
  3029. ],
  3030. "properties": {
  3031. "ocs": {
  3032. "type": "object",
  3033. "required": [
  3034. "meta",
  3035. "data"
  3036. ],
  3037. "properties": {
  3038. "meta": {
  3039. "$ref": "#/components/schemas/OCSMeta"
  3040. },
  3041. "data": {
  3042. "type": "object",
  3043. "additionalProperties": true
  3044. }
  3045. }
  3046. }
  3047. }
  3048. }
  3049. }
  3050. }
  3051. },
  3052. "404": {
  3053. "description": "Share not found",
  3054. "content": {
  3055. "text/plain": {
  3056. "schema": {
  3057. "type": "string"
  3058. }
  3059. }
  3060. }
  3061. },
  3062. "403": {
  3063. "description": "Unsharing not possible",
  3064. "content": {
  3065. "text/plain": {
  3066. "schema": {
  3067. "type": "string"
  3068. }
  3069. }
  3070. }
  3071. }
  3072. }
  3073. }
  3074. }
  3075. },
  3076. "tags": [
  3077. {
  3078. "name": "share",
  3079. "description": "Class ShareController"
  3080. },
  3081. {
  3082. "name": "external_shares",
  3083. "description": "Class ExternalSharesController"
  3084. }
  3085. ]
  3086. }