openapi.json 156 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812
  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. "anyOf": [
  564. {
  565. "type": "number",
  566. "format": "double"
  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. "nullable": true
  588. },
  589. "mail_send": {
  590. "type": "integer",
  591. "format": "int64",
  592. "enum": [
  593. 0,
  594. 1
  595. ]
  596. },
  597. "mimetype": {
  598. "type": "string"
  599. },
  600. "mount-type": {
  601. "type": "string"
  602. },
  603. "note": {
  604. "type": "string"
  605. },
  606. "parent": {
  607. "nullable": true
  608. },
  609. "password": {
  610. "type": "string",
  611. "nullable": true
  612. },
  613. "password_expiration_time": {
  614. "type": "string",
  615. "nullable": true
  616. },
  617. "path": {
  618. "type": "string",
  619. "nullable": true
  620. },
  621. "permissions": {
  622. "type": "integer",
  623. "format": "int64"
  624. },
  625. "send_password_by_talk": {
  626. "type": "boolean"
  627. },
  628. "share_type": {
  629. "type": "integer",
  630. "format": "int64"
  631. },
  632. "share_with": {
  633. "type": "string",
  634. "nullable": true
  635. },
  636. "share_with_avatar": {
  637. "type": "string"
  638. },
  639. "share_with_displayname": {
  640. "type": "string"
  641. },
  642. "share_with_displayname_unique": {
  643. "type": "string",
  644. "nullable": true
  645. },
  646. "share_with_link": {
  647. "type": "string"
  648. },
  649. "status": {
  650. "type": "object",
  651. "required": [
  652. "clearAt",
  653. "icon",
  654. "message",
  655. "status"
  656. ],
  657. "properties": {
  658. "clearAt": {
  659. "type": "integer",
  660. "format": "int64",
  661. "nullable": true
  662. },
  663. "icon": {
  664. "type": "string",
  665. "nullable": true
  666. },
  667. "message": {
  668. "type": "string",
  669. "nullable": true
  670. },
  671. "status": {
  672. "type": "string"
  673. }
  674. }
  675. },
  676. "stime": {
  677. "type": "integer",
  678. "format": "int64"
  679. },
  680. "storage": {
  681. "type": "integer",
  682. "format": "int64"
  683. },
  684. "storage_id": {
  685. "type": "string"
  686. },
  687. "token": {
  688. "type": "string",
  689. "nullable": true
  690. },
  691. "uid_file_owner": {
  692. "type": "string"
  693. },
  694. "uid_owner": {
  695. "type": "string"
  696. },
  697. "url": {
  698. "type": "string"
  699. }
  700. }
  701. },
  702. "ShareInfo": {
  703. "type": "object",
  704. "required": [
  705. "id",
  706. "parentId",
  707. "mtime",
  708. "name",
  709. "permissions",
  710. "mimetype",
  711. "size",
  712. "type",
  713. "etag"
  714. ],
  715. "properties": {
  716. "id": {
  717. "type": "integer",
  718. "format": "int64"
  719. },
  720. "parentId": {
  721. "type": "integer",
  722. "format": "int64"
  723. },
  724. "mtime": {
  725. "type": "integer",
  726. "format": "int64"
  727. },
  728. "name": {
  729. "type": "string"
  730. },
  731. "permissions": {
  732. "type": "integer",
  733. "format": "int64"
  734. },
  735. "mimetype": {
  736. "type": "string"
  737. },
  738. "size": {
  739. "anyOf": [
  740. {
  741. "type": "integer",
  742. "format": "int64"
  743. },
  744. {
  745. "type": "number",
  746. "format": "double"
  747. }
  748. ]
  749. },
  750. "type": {
  751. "type": "string"
  752. },
  753. "etag": {
  754. "type": "string"
  755. },
  756. "children": {
  757. "type": "array",
  758. "items": {
  759. "type": "object",
  760. "additionalProperties": {
  761. "type": "object"
  762. }
  763. }
  764. }
  765. }
  766. },
  767. "Sharee": {
  768. "type": "object",
  769. "required": [
  770. "count",
  771. "label"
  772. ],
  773. "properties": {
  774. "count": {
  775. "type": "integer",
  776. "format": "int64",
  777. "nullable": true
  778. },
  779. "label": {
  780. "type": "string"
  781. }
  782. }
  783. },
  784. "ShareeCircle": {
  785. "allOf": [
  786. {
  787. "$ref": "#/components/schemas/Sharee"
  788. },
  789. {
  790. "type": "object",
  791. "required": [
  792. "shareWithDescription",
  793. "value"
  794. ],
  795. "properties": {
  796. "shareWithDescription": {
  797. "type": "string"
  798. },
  799. "value": {
  800. "allOf": [
  801. {
  802. "$ref": "#/components/schemas/ShareeValue"
  803. },
  804. {
  805. "type": "object",
  806. "required": [
  807. "circle"
  808. ],
  809. "properties": {
  810. "circle": {
  811. "type": "string"
  812. }
  813. }
  814. }
  815. ]
  816. }
  817. }
  818. }
  819. ]
  820. },
  821. "ShareeEmail": {
  822. "allOf": [
  823. {
  824. "$ref": "#/components/schemas/Sharee"
  825. },
  826. {
  827. "type": "object",
  828. "required": [
  829. "uuid",
  830. "name",
  831. "type",
  832. "shareWithDisplayNameUnique",
  833. "value"
  834. ],
  835. "properties": {
  836. "uuid": {
  837. "type": "string"
  838. },
  839. "name": {
  840. "type": "string"
  841. },
  842. "type": {
  843. "type": "string"
  844. },
  845. "shareWithDisplayNameUnique": {
  846. "type": "string"
  847. },
  848. "value": {
  849. "$ref": "#/components/schemas/ShareeValue"
  850. }
  851. }
  852. }
  853. ]
  854. },
  855. "ShareeLookup": {
  856. "allOf": [
  857. {
  858. "$ref": "#/components/schemas/Sharee"
  859. },
  860. {
  861. "type": "object",
  862. "required": [
  863. "extra",
  864. "value"
  865. ],
  866. "properties": {
  867. "extra": {
  868. "type": "object",
  869. "required": [
  870. "federationId",
  871. "name",
  872. "email",
  873. "address",
  874. "website",
  875. "twitter",
  876. "phone",
  877. "twitter_signature",
  878. "website_signature",
  879. "userid"
  880. ],
  881. "properties": {
  882. "federationId": {
  883. "type": "string"
  884. },
  885. "name": {
  886. "$ref": "#/components/schemas/Lookup",
  887. "nullable": true
  888. },
  889. "email": {
  890. "$ref": "#/components/schemas/Lookup",
  891. "nullable": true
  892. },
  893. "address": {
  894. "$ref": "#/components/schemas/Lookup",
  895. "nullable": true
  896. },
  897. "website": {
  898. "$ref": "#/components/schemas/Lookup",
  899. "nullable": true
  900. },
  901. "twitter": {
  902. "$ref": "#/components/schemas/Lookup",
  903. "nullable": true
  904. },
  905. "phone": {
  906. "$ref": "#/components/schemas/Lookup",
  907. "nullable": true
  908. },
  909. "twitter_signature": {
  910. "$ref": "#/components/schemas/Lookup",
  911. "nullable": true
  912. },
  913. "website_signature": {
  914. "$ref": "#/components/schemas/Lookup",
  915. "nullable": true
  916. },
  917. "userid": {
  918. "$ref": "#/components/schemas/Lookup",
  919. "nullable": true
  920. }
  921. }
  922. },
  923. "value": {
  924. "allOf": [
  925. {
  926. "$ref": "#/components/schemas/ShareeValue"
  927. },
  928. {
  929. "type": "object",
  930. "required": [
  931. "globalScale"
  932. ],
  933. "properties": {
  934. "globalScale": {
  935. "type": "boolean"
  936. }
  937. }
  938. }
  939. ]
  940. }
  941. }
  942. }
  943. ]
  944. },
  945. "ShareeRemote": {
  946. "allOf": [
  947. {
  948. "$ref": "#/components/schemas/Sharee"
  949. },
  950. {
  951. "type": "object",
  952. "required": [
  953. "uuid",
  954. "name",
  955. "type",
  956. "value"
  957. ],
  958. "properties": {
  959. "uuid": {
  960. "type": "string"
  961. },
  962. "name": {
  963. "type": "string"
  964. },
  965. "type": {
  966. "type": "string"
  967. },
  968. "value": {
  969. "allOf": [
  970. {
  971. "$ref": "#/components/schemas/ShareeValue"
  972. },
  973. {
  974. "type": "object",
  975. "required": [
  976. "server"
  977. ],
  978. "properties": {
  979. "server": {
  980. "type": "string"
  981. }
  982. }
  983. }
  984. ]
  985. }
  986. }
  987. }
  988. ]
  989. },
  990. "ShareeRemoteGroup": {
  991. "allOf": [
  992. {
  993. "$ref": "#/components/schemas/Sharee"
  994. },
  995. {
  996. "type": "object",
  997. "required": [
  998. "guid",
  999. "name",
  1000. "value"
  1001. ],
  1002. "properties": {
  1003. "guid": {
  1004. "type": "string"
  1005. },
  1006. "name": {
  1007. "type": "string"
  1008. },
  1009. "value": {
  1010. "allOf": [
  1011. {
  1012. "$ref": "#/components/schemas/ShareeValue"
  1013. },
  1014. {
  1015. "type": "object",
  1016. "required": [
  1017. "server"
  1018. ],
  1019. "properties": {
  1020. "server": {
  1021. "type": "string"
  1022. }
  1023. }
  1024. }
  1025. ]
  1026. }
  1027. }
  1028. }
  1029. ]
  1030. },
  1031. "ShareeUser": {
  1032. "allOf": [
  1033. {
  1034. "$ref": "#/components/schemas/Sharee"
  1035. },
  1036. {
  1037. "type": "object",
  1038. "required": [
  1039. "subline",
  1040. "icon",
  1041. "shareWithDisplayNameUnique",
  1042. "status",
  1043. "value"
  1044. ],
  1045. "properties": {
  1046. "subline": {
  1047. "type": "string"
  1048. },
  1049. "icon": {
  1050. "type": "string"
  1051. },
  1052. "shareWithDisplayNameUnique": {
  1053. "type": "string"
  1054. },
  1055. "status": {
  1056. "type": "object",
  1057. "required": [
  1058. "status",
  1059. "message",
  1060. "icon",
  1061. "clearAt"
  1062. ],
  1063. "properties": {
  1064. "status": {
  1065. "type": "string"
  1066. },
  1067. "message": {
  1068. "type": "string"
  1069. },
  1070. "icon": {
  1071. "type": "string"
  1072. },
  1073. "clearAt": {
  1074. "type": "integer",
  1075. "format": "int64",
  1076. "nullable": true
  1077. }
  1078. }
  1079. },
  1080. "value": {
  1081. "$ref": "#/components/schemas/ShareeValue"
  1082. }
  1083. }
  1084. }
  1085. ]
  1086. },
  1087. "ShareeValue": {
  1088. "type": "object",
  1089. "required": [
  1090. "shareType",
  1091. "shareWith"
  1092. ],
  1093. "properties": {
  1094. "shareType": {
  1095. "type": "integer",
  1096. "format": "int64"
  1097. },
  1098. "shareWith": {
  1099. "type": "string"
  1100. }
  1101. }
  1102. },
  1103. "ShareesRecommendedResult": {
  1104. "type": "object",
  1105. "required": [
  1106. "exact",
  1107. "emails",
  1108. "groups",
  1109. "remote_groups",
  1110. "remotes",
  1111. "users"
  1112. ],
  1113. "properties": {
  1114. "exact": {
  1115. "type": "object",
  1116. "required": [
  1117. "emails",
  1118. "groups",
  1119. "remote_groups",
  1120. "remotes",
  1121. "users"
  1122. ],
  1123. "properties": {
  1124. "emails": {
  1125. "type": "array",
  1126. "items": {
  1127. "$ref": "#/components/schemas/ShareeEmail"
  1128. }
  1129. },
  1130. "groups": {
  1131. "type": "array",
  1132. "items": {
  1133. "$ref": "#/components/schemas/Sharee"
  1134. }
  1135. },
  1136. "remote_groups": {
  1137. "type": "array",
  1138. "items": {
  1139. "$ref": "#/components/schemas/ShareeRemoteGroup"
  1140. }
  1141. },
  1142. "remotes": {
  1143. "type": "array",
  1144. "items": {
  1145. "$ref": "#/components/schemas/ShareeRemote"
  1146. }
  1147. },
  1148. "users": {
  1149. "type": "array",
  1150. "items": {
  1151. "$ref": "#/components/schemas/ShareeUser"
  1152. }
  1153. }
  1154. }
  1155. },
  1156. "emails": {
  1157. "type": "array",
  1158. "items": {
  1159. "$ref": "#/components/schemas/ShareeEmail"
  1160. }
  1161. },
  1162. "groups": {
  1163. "type": "array",
  1164. "items": {
  1165. "$ref": "#/components/schemas/Sharee"
  1166. }
  1167. },
  1168. "remote_groups": {
  1169. "type": "array",
  1170. "items": {
  1171. "$ref": "#/components/schemas/ShareeRemoteGroup"
  1172. }
  1173. },
  1174. "remotes": {
  1175. "type": "array",
  1176. "items": {
  1177. "$ref": "#/components/schemas/ShareeRemote"
  1178. }
  1179. },
  1180. "users": {
  1181. "type": "array",
  1182. "items": {
  1183. "$ref": "#/components/schemas/ShareeUser"
  1184. }
  1185. }
  1186. }
  1187. },
  1188. "ShareesSearchResult": {
  1189. "type": "object",
  1190. "required": [
  1191. "exact",
  1192. "circles",
  1193. "emails",
  1194. "groups",
  1195. "lookup",
  1196. "remote_groups",
  1197. "remotes",
  1198. "rooms",
  1199. "users",
  1200. "lookupEnabled"
  1201. ],
  1202. "properties": {
  1203. "exact": {
  1204. "type": "object",
  1205. "required": [
  1206. "circles",
  1207. "emails",
  1208. "groups",
  1209. "remote_groups",
  1210. "remotes",
  1211. "rooms",
  1212. "users"
  1213. ],
  1214. "properties": {
  1215. "circles": {
  1216. "type": "array",
  1217. "items": {
  1218. "$ref": "#/components/schemas/ShareeCircle"
  1219. }
  1220. },
  1221. "emails": {
  1222. "type": "array",
  1223. "items": {
  1224. "$ref": "#/components/schemas/ShareeEmail"
  1225. }
  1226. },
  1227. "groups": {
  1228. "type": "array",
  1229. "items": {
  1230. "$ref": "#/components/schemas/Sharee"
  1231. }
  1232. },
  1233. "remote_groups": {
  1234. "type": "array",
  1235. "items": {
  1236. "$ref": "#/components/schemas/ShareeRemoteGroup"
  1237. }
  1238. },
  1239. "remotes": {
  1240. "type": "array",
  1241. "items": {
  1242. "$ref": "#/components/schemas/ShareeRemote"
  1243. }
  1244. },
  1245. "rooms": {
  1246. "type": "array",
  1247. "items": {
  1248. "$ref": "#/components/schemas/Sharee"
  1249. }
  1250. },
  1251. "users": {
  1252. "type": "array",
  1253. "items": {
  1254. "$ref": "#/components/schemas/ShareeUser"
  1255. }
  1256. }
  1257. }
  1258. },
  1259. "circles": {
  1260. "type": "array",
  1261. "items": {
  1262. "$ref": "#/components/schemas/ShareeCircle"
  1263. }
  1264. },
  1265. "emails": {
  1266. "type": "array",
  1267. "items": {
  1268. "$ref": "#/components/schemas/ShareeEmail"
  1269. }
  1270. },
  1271. "groups": {
  1272. "type": "array",
  1273. "items": {
  1274. "$ref": "#/components/schemas/Sharee"
  1275. }
  1276. },
  1277. "lookup": {
  1278. "type": "array",
  1279. "items": {
  1280. "$ref": "#/components/schemas/ShareeLookup"
  1281. }
  1282. },
  1283. "remote_groups": {
  1284. "type": "array",
  1285. "items": {
  1286. "$ref": "#/components/schemas/ShareeRemoteGroup"
  1287. }
  1288. },
  1289. "remotes": {
  1290. "type": "array",
  1291. "items": {
  1292. "$ref": "#/components/schemas/ShareeRemote"
  1293. }
  1294. },
  1295. "rooms": {
  1296. "type": "array",
  1297. "items": {
  1298. "$ref": "#/components/schemas/Sharee"
  1299. }
  1300. },
  1301. "users": {
  1302. "type": "array",
  1303. "items": {
  1304. "$ref": "#/components/schemas/ShareeUser"
  1305. }
  1306. },
  1307. "lookupEnabled": {
  1308. "type": "boolean"
  1309. }
  1310. }
  1311. }
  1312. }
  1313. },
  1314. "paths": {
  1315. "/index.php/s/{token}/preview": {
  1316. "get": {
  1317. "operationId": "public_preview-direct-link",
  1318. "summary": "Get a direct link preview for a shared file",
  1319. "tags": [
  1320. "public_preview"
  1321. ],
  1322. "security": [
  1323. {},
  1324. {
  1325. "bearer_auth": []
  1326. },
  1327. {
  1328. "basic_auth": []
  1329. }
  1330. ],
  1331. "parameters": [
  1332. {
  1333. "name": "token",
  1334. "in": "path",
  1335. "description": "Token of the share",
  1336. "required": true,
  1337. "schema": {
  1338. "type": "string"
  1339. }
  1340. }
  1341. ],
  1342. "responses": {
  1343. "200": {
  1344. "description": "Preview returned",
  1345. "content": {
  1346. "*/*": {
  1347. "schema": {
  1348. "type": "string",
  1349. "format": "binary"
  1350. }
  1351. }
  1352. }
  1353. },
  1354. "400": {
  1355. "description": "Getting preview is not possible",
  1356. "content": {
  1357. "application/json": {
  1358. "schema": {}
  1359. }
  1360. }
  1361. },
  1362. "403": {
  1363. "description": "Getting preview is not allowed",
  1364. "content": {
  1365. "application/json": {
  1366. "schema": {}
  1367. }
  1368. }
  1369. },
  1370. "404": {
  1371. "description": "Share or preview not found",
  1372. "content": {
  1373. "application/json": {
  1374. "schema": {}
  1375. }
  1376. }
  1377. }
  1378. }
  1379. }
  1380. },
  1381. "/index.php/apps/files_sharing/publicpreview/{token}": {
  1382. "get": {
  1383. "operationId": "public_preview-get-preview",
  1384. "summary": "Get a preview for a shared file",
  1385. "tags": [
  1386. "public_preview"
  1387. ],
  1388. "security": [
  1389. {},
  1390. {
  1391. "bearer_auth": []
  1392. },
  1393. {
  1394. "basic_auth": []
  1395. }
  1396. ],
  1397. "parameters": [
  1398. {
  1399. "name": "token",
  1400. "in": "path",
  1401. "description": "Token of the share",
  1402. "required": true,
  1403. "schema": {
  1404. "type": "string"
  1405. }
  1406. },
  1407. {
  1408. "name": "file",
  1409. "in": "query",
  1410. "description": "File in the share",
  1411. "schema": {
  1412. "type": "string",
  1413. "default": ""
  1414. }
  1415. },
  1416. {
  1417. "name": "x",
  1418. "in": "query",
  1419. "description": "Width of the preview",
  1420. "schema": {
  1421. "type": "integer",
  1422. "format": "int64",
  1423. "default": 32
  1424. }
  1425. },
  1426. {
  1427. "name": "y",
  1428. "in": "query",
  1429. "description": "Height of the preview",
  1430. "schema": {
  1431. "type": "integer",
  1432. "format": "int64",
  1433. "default": 32
  1434. }
  1435. },
  1436. {
  1437. "name": "a",
  1438. "in": "query",
  1439. "description": "Whether to not crop the preview",
  1440. "schema": {
  1441. "type": "integer",
  1442. "default": 0,
  1443. "enum": [
  1444. 0,
  1445. 1
  1446. ]
  1447. }
  1448. }
  1449. ],
  1450. "responses": {
  1451. "200": {
  1452. "description": "Preview returned",
  1453. "content": {
  1454. "*/*": {
  1455. "schema": {
  1456. "type": "string",
  1457. "format": "binary"
  1458. }
  1459. }
  1460. }
  1461. },
  1462. "400": {
  1463. "description": "Getting preview is not possible",
  1464. "content": {
  1465. "application/json": {
  1466. "schema": {}
  1467. }
  1468. }
  1469. },
  1470. "403": {
  1471. "description": "Getting preview is not allowed",
  1472. "content": {
  1473. "application/json": {
  1474. "schema": {}
  1475. }
  1476. }
  1477. },
  1478. "404": {
  1479. "description": "Share or preview not found",
  1480. "content": {
  1481. "application/json": {
  1482. "schema": {}
  1483. }
  1484. }
  1485. }
  1486. }
  1487. }
  1488. },
  1489. "/index.php/apps/files_sharing/shareinfo": {
  1490. "post": {
  1491. "operationId": "share_info-info",
  1492. "summary": "Get the info about a share",
  1493. "tags": [
  1494. "share_info"
  1495. ],
  1496. "security": [
  1497. {},
  1498. {
  1499. "bearer_auth": []
  1500. },
  1501. {
  1502. "basic_auth": []
  1503. }
  1504. ],
  1505. "requestBody": {
  1506. "required": true,
  1507. "content": {
  1508. "application/json": {
  1509. "schema": {
  1510. "type": "object",
  1511. "required": [
  1512. "t"
  1513. ],
  1514. "properties": {
  1515. "t": {
  1516. "type": "string",
  1517. "description": "Token of the share"
  1518. },
  1519. "password": {
  1520. "type": "string",
  1521. "nullable": true,
  1522. "description": "Password of the share"
  1523. },
  1524. "dir": {
  1525. "type": "string",
  1526. "nullable": true,
  1527. "description": "Subdirectory to get info about"
  1528. },
  1529. "depth": {
  1530. "type": "integer",
  1531. "format": "int64",
  1532. "default": -1,
  1533. "description": "Maximum depth to get info about"
  1534. }
  1535. }
  1536. }
  1537. }
  1538. }
  1539. },
  1540. "responses": {
  1541. "200": {
  1542. "description": "Share info returned",
  1543. "content": {
  1544. "application/json": {
  1545. "schema": {
  1546. "$ref": "#/components/schemas/ShareInfo"
  1547. }
  1548. }
  1549. }
  1550. },
  1551. "403": {
  1552. "description": "Getting share info is not allowed",
  1553. "content": {
  1554. "application/json": {
  1555. "schema": {}
  1556. }
  1557. }
  1558. },
  1559. "404": {
  1560. "description": "Share not found",
  1561. "content": {
  1562. "application/json": {
  1563. "schema": {}
  1564. }
  1565. }
  1566. }
  1567. }
  1568. }
  1569. },
  1570. "/ocs/v2.php/apps/files_sharing/api/v1/shares": {
  1571. "get": {
  1572. "operationId": "shareapi-get-shares",
  1573. "summary": "Get shares of the current user",
  1574. "tags": [
  1575. "shareapi"
  1576. ],
  1577. "security": [
  1578. {
  1579. "bearer_auth": []
  1580. },
  1581. {
  1582. "basic_auth": []
  1583. }
  1584. ],
  1585. "parameters": [
  1586. {
  1587. "name": "shared_with_me",
  1588. "in": "query",
  1589. "description": "Only get shares with the current user",
  1590. "schema": {
  1591. "type": "string",
  1592. "default": "false"
  1593. }
  1594. },
  1595. {
  1596. "name": "reshares",
  1597. "in": "query",
  1598. "description": "Only get shares by the current user and reshares",
  1599. "schema": {
  1600. "type": "string",
  1601. "default": "false"
  1602. }
  1603. },
  1604. {
  1605. "name": "subfiles",
  1606. "in": "query",
  1607. "description": "Only get all shares in a folder",
  1608. "schema": {
  1609. "type": "string",
  1610. "default": "false"
  1611. }
  1612. },
  1613. {
  1614. "name": "path",
  1615. "in": "query",
  1616. "description": "Get shares for a specific path",
  1617. "schema": {
  1618. "type": "string",
  1619. "default": ""
  1620. }
  1621. },
  1622. {
  1623. "name": "include_tags",
  1624. "in": "query",
  1625. "description": "Include tags in the share",
  1626. "schema": {
  1627. "type": "string",
  1628. "default": "false"
  1629. }
  1630. },
  1631. {
  1632. "name": "OCS-APIRequest",
  1633. "in": "header",
  1634. "description": "Required to be true for the API request to pass",
  1635. "required": true,
  1636. "schema": {
  1637. "type": "boolean",
  1638. "default": true
  1639. }
  1640. }
  1641. ],
  1642. "responses": {
  1643. "200": {
  1644. "description": "Shares returned",
  1645. "content": {
  1646. "application/json": {
  1647. "schema": {
  1648. "type": "object",
  1649. "required": [
  1650. "ocs"
  1651. ],
  1652. "properties": {
  1653. "ocs": {
  1654. "type": "object",
  1655. "required": [
  1656. "meta",
  1657. "data"
  1658. ],
  1659. "properties": {
  1660. "meta": {
  1661. "$ref": "#/components/schemas/OCSMeta"
  1662. },
  1663. "data": {
  1664. "type": "array",
  1665. "items": {
  1666. "$ref": "#/components/schemas/Share"
  1667. }
  1668. }
  1669. }
  1670. }
  1671. }
  1672. }
  1673. }
  1674. }
  1675. },
  1676. "404": {
  1677. "description": "The folder was not found or is inaccessible",
  1678. "content": {
  1679. "application/json": {
  1680. "schema": {
  1681. "type": "object",
  1682. "required": [
  1683. "ocs"
  1684. ],
  1685. "properties": {
  1686. "ocs": {
  1687. "type": "object",
  1688. "required": [
  1689. "meta",
  1690. "data"
  1691. ],
  1692. "properties": {
  1693. "meta": {
  1694. "$ref": "#/components/schemas/OCSMeta"
  1695. },
  1696. "data": {}
  1697. }
  1698. }
  1699. }
  1700. }
  1701. }
  1702. }
  1703. }
  1704. }
  1705. },
  1706. "post": {
  1707. "operationId": "shareapi-create-share",
  1708. "summary": "Create a share",
  1709. "tags": [
  1710. "shareapi"
  1711. ],
  1712. "security": [
  1713. {
  1714. "bearer_auth": []
  1715. },
  1716. {
  1717. "basic_auth": []
  1718. }
  1719. ],
  1720. "requestBody": {
  1721. "required": false,
  1722. "content": {
  1723. "application/json": {
  1724. "schema": {
  1725. "type": "object",
  1726. "properties": {
  1727. "path": {
  1728. "type": "string",
  1729. "nullable": true,
  1730. "description": "Path of the share"
  1731. },
  1732. "permissions": {
  1733. "type": "integer",
  1734. "format": "int64",
  1735. "nullable": true,
  1736. "description": "Permissions for the share"
  1737. },
  1738. "shareType": {
  1739. "type": "integer",
  1740. "format": "int64",
  1741. "default": -1,
  1742. "description": "Type of the share"
  1743. },
  1744. "shareWith": {
  1745. "type": "string",
  1746. "nullable": true,
  1747. "description": "The entity this should be shared with"
  1748. },
  1749. "publicUpload": {
  1750. "type": "string",
  1751. "default": "false",
  1752. "description": "If public uploading is allowed"
  1753. },
  1754. "password": {
  1755. "type": "string",
  1756. "default": "",
  1757. "description": "Password for the share"
  1758. },
  1759. "sendPasswordByTalk": {
  1760. "type": "string",
  1761. "nullable": true,
  1762. "description": "Send the password for the share over Talk"
  1763. },
  1764. "expireDate": {
  1765. "type": "string",
  1766. "nullable": true,
  1767. "description": "The expiry date of the share in the user's timezone at 00:00.\n If $expireDate is not supplied or set to `null`, the system default will be used."
  1768. },
  1769. "note": {
  1770. "type": "string",
  1771. "default": "",
  1772. "description": "Note for the share"
  1773. },
  1774. "label": {
  1775. "type": "string",
  1776. "default": "",
  1777. "description": "Label for the share (only used in link and email)"
  1778. },
  1779. "attributes": {
  1780. "type": "string",
  1781. "nullable": true,
  1782. "description": "Additional attributes for the share"
  1783. },
  1784. "sendMail": {
  1785. "type": "string",
  1786. "nullable": true,
  1787. "enum": [
  1788. "false",
  1789. "true"
  1790. ],
  1791. "description": "Send a mail to the recipient"
  1792. }
  1793. }
  1794. }
  1795. }
  1796. }
  1797. },
  1798. "parameters": [
  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. "application/json": {
  1845. "schema": {
  1846. "type": "object",
  1847. "required": [
  1848. "ocs"
  1849. ],
  1850. "properties": {
  1851. "ocs": {
  1852. "type": "object",
  1853. "required": [
  1854. "meta",
  1855. "data"
  1856. ],
  1857. "properties": {
  1858. "meta": {
  1859. "$ref": "#/components/schemas/OCSMeta"
  1860. },
  1861. "data": {}
  1862. }
  1863. }
  1864. }
  1865. }
  1866. }
  1867. }
  1868. },
  1869. "403": {
  1870. "description": "Creating the share is not allowed",
  1871. "content": {
  1872. "application/json": {
  1873. "schema": {
  1874. "type": "object",
  1875. "required": [
  1876. "ocs"
  1877. ],
  1878. "properties": {
  1879. "ocs": {
  1880. "type": "object",
  1881. "required": [
  1882. "meta",
  1883. "data"
  1884. ],
  1885. "properties": {
  1886. "meta": {
  1887. "$ref": "#/components/schemas/OCSMeta"
  1888. },
  1889. "data": {}
  1890. }
  1891. }
  1892. }
  1893. }
  1894. }
  1895. }
  1896. },
  1897. "404": {
  1898. "description": "Creating the share failed",
  1899. "content": {
  1900. "application/json": {
  1901. "schema": {
  1902. "type": "object",
  1903. "required": [
  1904. "ocs"
  1905. ],
  1906. "properties": {
  1907. "ocs": {
  1908. "type": "object",
  1909. "required": [
  1910. "meta",
  1911. "data"
  1912. ],
  1913. "properties": {
  1914. "meta": {
  1915. "$ref": "#/components/schemas/OCSMeta"
  1916. },
  1917. "data": {}
  1918. }
  1919. }
  1920. }
  1921. }
  1922. }
  1923. }
  1924. }
  1925. }
  1926. }
  1927. },
  1928. "/ocs/v2.php/apps/files_sharing/api/v1/shares/inherited": {
  1929. "get": {
  1930. "operationId": "shareapi-get-inherited-shares",
  1931. "summary": "Get all shares relative to a file, including parent folders shares rights",
  1932. "tags": [
  1933. "shareapi"
  1934. ],
  1935. "security": [
  1936. {
  1937. "bearer_auth": []
  1938. },
  1939. {
  1940. "basic_auth": []
  1941. }
  1942. ],
  1943. "parameters": [
  1944. {
  1945. "name": "path",
  1946. "in": "query",
  1947. "description": "Path all shares will be relative to",
  1948. "required": true,
  1949. "schema": {
  1950. "type": "string"
  1951. }
  1952. },
  1953. {
  1954. "name": "OCS-APIRequest",
  1955. "in": "header",
  1956. "description": "Required to be true for the API request to pass",
  1957. "required": true,
  1958. "schema": {
  1959. "type": "boolean",
  1960. "default": true
  1961. }
  1962. }
  1963. ],
  1964. "responses": {
  1965. "200": {
  1966. "description": "Shares returned",
  1967. "content": {
  1968. "application/json": {
  1969. "schema": {
  1970. "type": "object",
  1971. "required": [
  1972. "ocs"
  1973. ],
  1974. "properties": {
  1975. "ocs": {
  1976. "type": "object",
  1977. "required": [
  1978. "meta",
  1979. "data"
  1980. ],
  1981. "properties": {
  1982. "meta": {
  1983. "$ref": "#/components/schemas/OCSMeta"
  1984. },
  1985. "data": {
  1986. "type": "array",
  1987. "items": {
  1988. "$ref": "#/components/schemas/Share"
  1989. }
  1990. }
  1991. }
  1992. }
  1993. }
  1994. }
  1995. }
  1996. }
  1997. },
  1998. "500": {
  1999. "description": "",
  2000. "content": {
  2001. "text/plain": {
  2002. "schema": {
  2003. "type": "string"
  2004. }
  2005. }
  2006. }
  2007. },
  2008. "404": {
  2009. "description": "The given path is invalid",
  2010. "content": {
  2011. "application/json": {
  2012. "schema": {
  2013. "type": "object",
  2014. "required": [
  2015. "ocs"
  2016. ],
  2017. "properties": {
  2018. "ocs": {
  2019. "type": "object",
  2020. "required": [
  2021. "meta",
  2022. "data"
  2023. ],
  2024. "properties": {
  2025. "meta": {
  2026. "$ref": "#/components/schemas/OCSMeta"
  2027. },
  2028. "data": {}
  2029. }
  2030. }
  2031. }
  2032. }
  2033. }
  2034. }
  2035. }
  2036. }
  2037. }
  2038. },
  2039. "/ocs/v2.php/apps/files_sharing/api/v1/shares/pending": {
  2040. "get": {
  2041. "operationId": "shareapi-pending-shares",
  2042. "summary": "Get all shares that are still pending",
  2043. "tags": [
  2044. "shareapi"
  2045. ],
  2046. "security": [
  2047. {
  2048. "bearer_auth": []
  2049. },
  2050. {
  2051. "basic_auth": []
  2052. }
  2053. ],
  2054. "parameters": [
  2055. {
  2056. "name": "OCS-APIRequest",
  2057. "in": "header",
  2058. "description": "Required to be true for the API request to pass",
  2059. "required": true,
  2060. "schema": {
  2061. "type": "boolean",
  2062. "default": true
  2063. }
  2064. }
  2065. ],
  2066. "responses": {
  2067. "200": {
  2068. "description": "Pending shares returned",
  2069. "content": {
  2070. "application/json": {
  2071. "schema": {
  2072. "type": "object",
  2073. "required": [
  2074. "ocs"
  2075. ],
  2076. "properties": {
  2077. "ocs": {
  2078. "type": "object",
  2079. "required": [
  2080. "meta",
  2081. "data"
  2082. ],
  2083. "properties": {
  2084. "meta": {
  2085. "$ref": "#/components/schemas/OCSMeta"
  2086. },
  2087. "data": {
  2088. "type": "array",
  2089. "items": {
  2090. "$ref": "#/components/schemas/Share"
  2091. }
  2092. }
  2093. }
  2094. }
  2095. }
  2096. }
  2097. }
  2098. }
  2099. }
  2100. }
  2101. }
  2102. },
  2103. "/ocs/v2.php/apps/files_sharing/api/v1/shares/{id}": {
  2104. "get": {
  2105. "operationId": "shareapi-get-share",
  2106. "summary": "Get a specific share by id",
  2107. "tags": [
  2108. "shareapi"
  2109. ],
  2110. "security": [
  2111. {
  2112. "bearer_auth": []
  2113. },
  2114. {
  2115. "basic_auth": []
  2116. }
  2117. ],
  2118. "parameters": [
  2119. {
  2120. "name": "id",
  2121. "in": "path",
  2122. "description": "ID of the share",
  2123. "required": true,
  2124. "schema": {
  2125. "type": "string"
  2126. }
  2127. },
  2128. {
  2129. "name": "include_tags",
  2130. "in": "query",
  2131. "description": "Include tags in the share",
  2132. "schema": {
  2133. "type": "integer",
  2134. "default": 0,
  2135. "enum": [
  2136. 0,
  2137. 1
  2138. ]
  2139. }
  2140. },
  2141. {
  2142. "name": "OCS-APIRequest",
  2143. "in": "header",
  2144. "description": "Required to be true for the API request to pass",
  2145. "required": true,
  2146. "schema": {
  2147. "type": "boolean",
  2148. "default": true
  2149. }
  2150. }
  2151. ],
  2152. "responses": {
  2153. "200": {
  2154. "description": "Share returned",
  2155. "content": {
  2156. "application/json": {
  2157. "schema": {
  2158. "type": "object",
  2159. "required": [
  2160. "ocs"
  2161. ],
  2162. "properties": {
  2163. "ocs": {
  2164. "type": "object",
  2165. "required": [
  2166. "meta",
  2167. "data"
  2168. ],
  2169. "properties": {
  2170. "meta": {
  2171. "$ref": "#/components/schemas/OCSMeta"
  2172. },
  2173. "data": {
  2174. "$ref": "#/components/schemas/Share"
  2175. }
  2176. }
  2177. }
  2178. }
  2179. }
  2180. }
  2181. }
  2182. },
  2183. "404": {
  2184. "description": "Share not found",
  2185. "content": {
  2186. "application/json": {
  2187. "schema": {
  2188. "type": "object",
  2189. "required": [
  2190. "ocs"
  2191. ],
  2192. "properties": {
  2193. "ocs": {
  2194. "type": "object",
  2195. "required": [
  2196. "meta",
  2197. "data"
  2198. ],
  2199. "properties": {
  2200. "meta": {
  2201. "$ref": "#/components/schemas/OCSMeta"
  2202. },
  2203. "data": {}
  2204. }
  2205. }
  2206. }
  2207. }
  2208. }
  2209. }
  2210. }
  2211. }
  2212. },
  2213. "put": {
  2214. "operationId": "shareapi-update-share",
  2215. "summary": "Update a share",
  2216. "tags": [
  2217. "shareapi"
  2218. ],
  2219. "security": [
  2220. {
  2221. "bearer_auth": []
  2222. },
  2223. {
  2224. "basic_auth": []
  2225. }
  2226. ],
  2227. "requestBody": {
  2228. "required": false,
  2229. "content": {
  2230. "application/json": {
  2231. "schema": {
  2232. "type": "object",
  2233. "properties": {
  2234. "permissions": {
  2235. "type": "integer",
  2236. "format": "int64",
  2237. "nullable": true,
  2238. "description": "New permissions"
  2239. },
  2240. "password": {
  2241. "type": "string",
  2242. "nullable": true,
  2243. "description": "New password"
  2244. },
  2245. "sendPasswordByTalk": {
  2246. "type": "string",
  2247. "nullable": true,
  2248. "description": "New condition if the password should be send over Talk"
  2249. },
  2250. "publicUpload": {
  2251. "type": "string",
  2252. "nullable": true,
  2253. "description": "New condition if public uploading is allowed"
  2254. },
  2255. "expireDate": {
  2256. "type": "string",
  2257. "nullable": true,
  2258. "description": "New expiry date"
  2259. },
  2260. "note": {
  2261. "type": "string",
  2262. "nullable": true,
  2263. "description": "New note"
  2264. },
  2265. "label": {
  2266. "type": "string",
  2267. "nullable": true,
  2268. "description": "New label"
  2269. },
  2270. "hideDownload": {
  2271. "type": "string",
  2272. "nullable": true,
  2273. "description": "New condition if the download should be hidden"
  2274. },
  2275. "attributes": {
  2276. "type": "string",
  2277. "nullable": true,
  2278. "description": "New additional attributes"
  2279. },
  2280. "sendMail": {
  2281. "type": "string",
  2282. "nullable": true,
  2283. "description": "if the share should be send by mail.\n Considering the share already exists, no mail will be send after the share is updated.\n You will have to use the sendMail action to send the mail."
  2284. }
  2285. }
  2286. }
  2287. }
  2288. }
  2289. },
  2290. "parameters": [
  2291. {
  2292. "name": "id",
  2293. "in": "path",
  2294. "description": "ID of the share",
  2295. "required": true,
  2296. "schema": {
  2297. "type": "string"
  2298. }
  2299. },
  2300. {
  2301. "name": "OCS-APIRequest",
  2302. "in": "header",
  2303. "description": "Required to be true for the API request to pass",
  2304. "required": true,
  2305. "schema": {
  2306. "type": "boolean",
  2307. "default": true
  2308. }
  2309. }
  2310. ],
  2311. "responses": {
  2312. "200": {
  2313. "description": "Share updated successfully",
  2314. "content": {
  2315. "application/json": {
  2316. "schema": {
  2317. "type": "object",
  2318. "required": [
  2319. "ocs"
  2320. ],
  2321. "properties": {
  2322. "ocs": {
  2323. "type": "object",
  2324. "required": [
  2325. "meta",
  2326. "data"
  2327. ],
  2328. "properties": {
  2329. "meta": {
  2330. "$ref": "#/components/schemas/OCSMeta"
  2331. },
  2332. "data": {
  2333. "$ref": "#/components/schemas/Share"
  2334. }
  2335. }
  2336. }
  2337. }
  2338. }
  2339. }
  2340. }
  2341. },
  2342. "400": {
  2343. "description": "Share could not be updated because the requested changes are invalid",
  2344. "content": {
  2345. "application/json": {
  2346. "schema": {
  2347. "type": "object",
  2348. "required": [
  2349. "ocs"
  2350. ],
  2351. "properties": {
  2352. "ocs": {
  2353. "type": "object",
  2354. "required": [
  2355. "meta",
  2356. "data"
  2357. ],
  2358. "properties": {
  2359. "meta": {
  2360. "$ref": "#/components/schemas/OCSMeta"
  2361. },
  2362. "data": {}
  2363. }
  2364. }
  2365. }
  2366. }
  2367. }
  2368. }
  2369. },
  2370. "403": {
  2371. "description": "Missing permissions to update the share",
  2372. "content": {
  2373. "application/json": {
  2374. "schema": {
  2375. "type": "object",
  2376. "required": [
  2377. "ocs"
  2378. ],
  2379. "properties": {
  2380. "ocs": {
  2381. "type": "object",
  2382. "required": [
  2383. "meta",
  2384. "data"
  2385. ],
  2386. "properties": {
  2387. "meta": {
  2388. "$ref": "#/components/schemas/OCSMeta"
  2389. },
  2390. "data": {}
  2391. }
  2392. }
  2393. }
  2394. }
  2395. }
  2396. }
  2397. },
  2398. "404": {
  2399. "description": "Share not found",
  2400. "content": {
  2401. "application/json": {
  2402. "schema": {
  2403. "type": "object",
  2404. "required": [
  2405. "ocs"
  2406. ],
  2407. "properties": {
  2408. "ocs": {
  2409. "type": "object",
  2410. "required": [
  2411. "meta",
  2412. "data"
  2413. ],
  2414. "properties": {
  2415. "meta": {
  2416. "$ref": "#/components/schemas/OCSMeta"
  2417. },
  2418. "data": {}
  2419. }
  2420. }
  2421. }
  2422. }
  2423. }
  2424. }
  2425. }
  2426. }
  2427. },
  2428. "delete": {
  2429. "operationId": "shareapi-delete-share",
  2430. "summary": "Delete a share",
  2431. "tags": [
  2432. "shareapi"
  2433. ],
  2434. "security": [
  2435. {
  2436. "bearer_auth": []
  2437. },
  2438. {
  2439. "basic_auth": []
  2440. }
  2441. ],
  2442. "parameters": [
  2443. {
  2444. "name": "id",
  2445. "in": "path",
  2446. "description": "ID of the share",
  2447. "required": true,
  2448. "schema": {
  2449. "type": "string"
  2450. }
  2451. },
  2452. {
  2453. "name": "OCS-APIRequest",
  2454. "in": "header",
  2455. "description": "Required to be true for the API request to pass",
  2456. "required": true,
  2457. "schema": {
  2458. "type": "boolean",
  2459. "default": true
  2460. }
  2461. }
  2462. ],
  2463. "responses": {
  2464. "200": {
  2465. "description": "Share deleted successfully",
  2466. "content": {
  2467. "application/json": {
  2468. "schema": {
  2469. "type": "object",
  2470. "required": [
  2471. "ocs"
  2472. ],
  2473. "properties": {
  2474. "ocs": {
  2475. "type": "object",
  2476. "required": [
  2477. "meta",
  2478. "data"
  2479. ],
  2480. "properties": {
  2481. "meta": {
  2482. "$ref": "#/components/schemas/OCSMeta"
  2483. },
  2484. "data": {}
  2485. }
  2486. }
  2487. }
  2488. }
  2489. }
  2490. }
  2491. },
  2492. "404": {
  2493. "description": "Share not found",
  2494. "content": {
  2495. "application/json": {
  2496. "schema": {
  2497. "type": "object",
  2498. "required": [
  2499. "ocs"
  2500. ],
  2501. "properties": {
  2502. "ocs": {
  2503. "type": "object",
  2504. "required": [
  2505. "meta",
  2506. "data"
  2507. ],
  2508. "properties": {
  2509. "meta": {
  2510. "$ref": "#/components/schemas/OCSMeta"
  2511. },
  2512. "data": {}
  2513. }
  2514. }
  2515. }
  2516. }
  2517. }
  2518. }
  2519. },
  2520. "403": {
  2521. "description": "Missing permissions to delete the share",
  2522. "content": {
  2523. "application/json": {
  2524. "schema": {
  2525. "type": "object",
  2526. "required": [
  2527. "ocs"
  2528. ],
  2529. "properties": {
  2530. "ocs": {
  2531. "type": "object",
  2532. "required": [
  2533. "meta",
  2534. "data"
  2535. ],
  2536. "properties": {
  2537. "meta": {
  2538. "$ref": "#/components/schemas/OCSMeta"
  2539. },
  2540. "data": {}
  2541. }
  2542. }
  2543. }
  2544. }
  2545. }
  2546. }
  2547. }
  2548. }
  2549. }
  2550. },
  2551. "/ocs/v2.php/apps/files_sharing/api/v1/shares/{id}/send-email": {
  2552. "post": {
  2553. "operationId": "shareapi-send-share-email",
  2554. "summary": "Send a mail notification again for a share. The mail_send option must be enabled for the given share.",
  2555. "tags": [
  2556. "shareapi"
  2557. ],
  2558. "security": [
  2559. {
  2560. "bearer_auth": []
  2561. },
  2562. {
  2563. "basic_auth": []
  2564. }
  2565. ],
  2566. "requestBody": {
  2567. "required": false,
  2568. "content": {
  2569. "application/json": {
  2570. "schema": {
  2571. "type": "object",
  2572. "properties": {
  2573. "password": {
  2574. "type": "string",
  2575. "default": "",
  2576. "description": "the password to check against. Necessary for password protected shares."
  2577. }
  2578. }
  2579. }
  2580. }
  2581. }
  2582. },
  2583. "parameters": [
  2584. {
  2585. "name": "id",
  2586. "in": "path",
  2587. "description": "the share ID",
  2588. "required": true,
  2589. "schema": {
  2590. "type": "string"
  2591. }
  2592. },
  2593. {
  2594. "name": "OCS-APIRequest",
  2595. "in": "header",
  2596. "description": "Required to be true for the API request to pass",
  2597. "required": true,
  2598. "schema": {
  2599. "type": "boolean",
  2600. "default": true
  2601. }
  2602. }
  2603. ],
  2604. "responses": {
  2605. "404": {
  2606. "description": "Share not found",
  2607. "content": {
  2608. "application/json": {
  2609. "schema": {
  2610. "type": "object",
  2611. "required": [
  2612. "ocs"
  2613. ],
  2614. "properties": {
  2615. "ocs": {
  2616. "type": "object",
  2617. "required": [
  2618. "meta",
  2619. "data"
  2620. ],
  2621. "properties": {
  2622. "meta": {
  2623. "$ref": "#/components/schemas/OCSMeta"
  2624. },
  2625. "data": {}
  2626. }
  2627. }
  2628. }
  2629. }
  2630. }
  2631. }
  2632. },
  2633. "403": {
  2634. "description": "You are not allowed to send mail notifications",
  2635. "content": {
  2636. "application/json": {
  2637. "schema": {
  2638. "type": "object",
  2639. "required": [
  2640. "ocs"
  2641. ],
  2642. "properties": {
  2643. "ocs": {
  2644. "type": "object",
  2645. "required": [
  2646. "meta",
  2647. "data"
  2648. ],
  2649. "properties": {
  2650. "meta": {
  2651. "$ref": "#/components/schemas/OCSMeta"
  2652. },
  2653. "data": {}
  2654. }
  2655. }
  2656. }
  2657. }
  2658. }
  2659. }
  2660. },
  2661. "400": {
  2662. "description": "Invalid request or wrong password",
  2663. "content": {
  2664. "application/json": {
  2665. "schema": {
  2666. "type": "object",
  2667. "required": [
  2668. "ocs"
  2669. ],
  2670. "properties": {
  2671. "ocs": {
  2672. "type": "object",
  2673. "required": [
  2674. "meta",
  2675. "data"
  2676. ],
  2677. "properties": {
  2678. "meta": {
  2679. "$ref": "#/components/schemas/OCSMeta"
  2680. },
  2681. "data": {}
  2682. }
  2683. }
  2684. }
  2685. }
  2686. }
  2687. }
  2688. },
  2689. "200": {
  2690. "description": "The email notification was sent successfully",
  2691. "content": {
  2692. "application/json": {
  2693. "schema": {
  2694. "type": "object",
  2695. "required": [
  2696. "ocs"
  2697. ],
  2698. "properties": {
  2699. "ocs": {
  2700. "type": "object",
  2701. "required": [
  2702. "meta",
  2703. "data"
  2704. ],
  2705. "properties": {
  2706. "meta": {
  2707. "$ref": "#/components/schemas/OCSMeta"
  2708. },
  2709. "data": {}
  2710. }
  2711. }
  2712. }
  2713. }
  2714. }
  2715. }
  2716. }
  2717. }
  2718. }
  2719. },
  2720. "/ocs/v2.php/apps/files_sharing/api/v1/shares/pending/{id}": {
  2721. "post": {
  2722. "operationId": "shareapi-accept-share",
  2723. "summary": "Accept a share",
  2724. "tags": [
  2725. "shareapi"
  2726. ],
  2727. "security": [
  2728. {
  2729. "bearer_auth": []
  2730. },
  2731. {
  2732. "basic_auth": []
  2733. }
  2734. ],
  2735. "parameters": [
  2736. {
  2737. "name": "id",
  2738. "in": "path",
  2739. "description": "ID of the share",
  2740. "required": true,
  2741. "schema": {
  2742. "type": "string"
  2743. }
  2744. },
  2745. {
  2746. "name": "OCS-APIRequest",
  2747. "in": "header",
  2748. "description": "Required to be true for the API request to pass",
  2749. "required": true,
  2750. "schema": {
  2751. "type": "boolean",
  2752. "default": true
  2753. }
  2754. }
  2755. ],
  2756. "responses": {
  2757. "200": {
  2758. "description": "Share accepted successfully",
  2759. "content": {
  2760. "application/json": {
  2761. "schema": {
  2762. "type": "object",
  2763. "required": [
  2764. "ocs"
  2765. ],
  2766. "properties": {
  2767. "ocs": {
  2768. "type": "object",
  2769. "required": [
  2770. "meta",
  2771. "data"
  2772. ],
  2773. "properties": {
  2774. "meta": {
  2775. "$ref": "#/components/schemas/OCSMeta"
  2776. },
  2777. "data": {}
  2778. }
  2779. }
  2780. }
  2781. }
  2782. }
  2783. }
  2784. },
  2785. "404": {
  2786. "description": "Share not found",
  2787. "content": {
  2788. "application/json": {
  2789. "schema": {
  2790. "type": "object",
  2791. "required": [
  2792. "ocs"
  2793. ],
  2794. "properties": {
  2795. "ocs": {
  2796. "type": "object",
  2797. "required": [
  2798. "meta",
  2799. "data"
  2800. ],
  2801. "properties": {
  2802. "meta": {
  2803. "$ref": "#/components/schemas/OCSMeta"
  2804. },
  2805. "data": {}
  2806. }
  2807. }
  2808. }
  2809. }
  2810. }
  2811. }
  2812. },
  2813. "400": {
  2814. "description": "Share could not be accepted",
  2815. "content": {
  2816. "application/json": {
  2817. "schema": {
  2818. "type": "object",
  2819. "required": [
  2820. "ocs"
  2821. ],
  2822. "properties": {
  2823. "ocs": {
  2824. "type": "object",
  2825. "required": [
  2826. "meta",
  2827. "data"
  2828. ],
  2829. "properties": {
  2830. "meta": {
  2831. "$ref": "#/components/schemas/OCSMeta"
  2832. },
  2833. "data": {}
  2834. }
  2835. }
  2836. }
  2837. }
  2838. }
  2839. }
  2840. }
  2841. }
  2842. }
  2843. },
  2844. "/ocs/v2.php/apps/files_sharing/api/v1/deletedshares": {
  2845. "get": {
  2846. "operationId": "deleted_shareapi-index",
  2847. "summary": "Get a list of all deleted shares",
  2848. "tags": [
  2849. "deleted_shareapi"
  2850. ],
  2851. "security": [
  2852. {
  2853. "bearer_auth": []
  2854. },
  2855. {
  2856. "basic_auth": []
  2857. }
  2858. ],
  2859. "parameters": [
  2860. {
  2861. "name": "OCS-APIRequest",
  2862. "in": "header",
  2863. "description": "Required to be true for the API request to pass",
  2864. "required": true,
  2865. "schema": {
  2866. "type": "boolean",
  2867. "default": true
  2868. }
  2869. }
  2870. ],
  2871. "responses": {
  2872. "200": {
  2873. "description": "Deleted shares returned",
  2874. "content": {
  2875. "application/json": {
  2876. "schema": {
  2877. "type": "object",
  2878. "required": [
  2879. "ocs"
  2880. ],
  2881. "properties": {
  2882. "ocs": {
  2883. "type": "object",
  2884. "required": [
  2885. "meta",
  2886. "data"
  2887. ],
  2888. "properties": {
  2889. "meta": {
  2890. "$ref": "#/components/schemas/OCSMeta"
  2891. },
  2892. "data": {
  2893. "type": "array",
  2894. "items": {
  2895. "$ref": "#/components/schemas/DeletedShare"
  2896. }
  2897. }
  2898. }
  2899. }
  2900. }
  2901. }
  2902. }
  2903. }
  2904. }
  2905. }
  2906. }
  2907. },
  2908. "/ocs/v2.php/apps/files_sharing/api/v1/deletedshares/{id}": {
  2909. "post": {
  2910. "operationId": "deleted_shareapi-undelete",
  2911. "summary": "Undelete a deleted share",
  2912. "tags": [
  2913. "deleted_shareapi"
  2914. ],
  2915. "security": [
  2916. {
  2917. "bearer_auth": []
  2918. },
  2919. {
  2920. "basic_auth": []
  2921. }
  2922. ],
  2923. "parameters": [
  2924. {
  2925. "name": "id",
  2926. "in": "path",
  2927. "description": "ID of the share",
  2928. "required": true,
  2929. "schema": {
  2930. "type": "string"
  2931. }
  2932. },
  2933. {
  2934. "name": "OCS-APIRequest",
  2935. "in": "header",
  2936. "description": "Required to be true for the API request to pass",
  2937. "required": true,
  2938. "schema": {
  2939. "type": "boolean",
  2940. "default": true
  2941. }
  2942. }
  2943. ],
  2944. "responses": {
  2945. "200": {
  2946. "description": "Share undeleted successfully",
  2947. "content": {
  2948. "application/json": {
  2949. "schema": {
  2950. "type": "object",
  2951. "required": [
  2952. "ocs"
  2953. ],
  2954. "properties": {
  2955. "ocs": {
  2956. "type": "object",
  2957. "required": [
  2958. "meta",
  2959. "data"
  2960. ],
  2961. "properties": {
  2962. "meta": {
  2963. "$ref": "#/components/schemas/OCSMeta"
  2964. },
  2965. "data": {}
  2966. }
  2967. }
  2968. }
  2969. }
  2970. }
  2971. }
  2972. },
  2973. "404": {
  2974. "description": "Share not found",
  2975. "content": {
  2976. "application/json": {
  2977. "schema": {
  2978. "type": "object",
  2979. "required": [
  2980. "ocs"
  2981. ],
  2982. "properties": {
  2983. "ocs": {
  2984. "type": "object",
  2985. "required": [
  2986. "meta",
  2987. "data"
  2988. ],
  2989. "properties": {
  2990. "meta": {
  2991. "$ref": "#/components/schemas/OCSMeta"
  2992. },
  2993. "data": {}
  2994. }
  2995. }
  2996. }
  2997. }
  2998. }
  2999. }
  3000. }
  3001. }
  3002. }
  3003. },
  3004. "/ocs/v2.php/apps/files_sharing/api/v1/sharees": {
  3005. "get": {
  3006. "operationId": "shareesapi-search",
  3007. "summary": "Search for sharees",
  3008. "tags": [
  3009. "shareesapi"
  3010. ],
  3011. "security": [
  3012. {
  3013. "bearer_auth": []
  3014. },
  3015. {
  3016. "basic_auth": []
  3017. }
  3018. ],
  3019. "parameters": [
  3020. {
  3021. "name": "search",
  3022. "in": "query",
  3023. "description": "Text to search for",
  3024. "schema": {
  3025. "type": "string",
  3026. "default": ""
  3027. }
  3028. },
  3029. {
  3030. "name": "itemType",
  3031. "in": "query",
  3032. "description": "Limit to specific item types",
  3033. "schema": {
  3034. "type": "string",
  3035. "nullable": true
  3036. }
  3037. },
  3038. {
  3039. "name": "page",
  3040. "in": "query",
  3041. "description": "Page offset for searching",
  3042. "schema": {
  3043. "type": "integer",
  3044. "format": "int64",
  3045. "default": 1
  3046. }
  3047. },
  3048. {
  3049. "name": "perPage",
  3050. "in": "query",
  3051. "description": "Limit amount of search results per page",
  3052. "schema": {
  3053. "type": "integer",
  3054. "format": "int64",
  3055. "default": 200
  3056. }
  3057. },
  3058. {
  3059. "name": "shareType",
  3060. "in": "query",
  3061. "description": "Limit to specific share types",
  3062. "schema": {
  3063. "nullable": true,
  3064. "oneOf": [
  3065. {
  3066. "type": "integer",
  3067. "format": "int64"
  3068. },
  3069. {
  3070. "type": "array",
  3071. "items": {
  3072. "type": "integer",
  3073. "format": "int64"
  3074. }
  3075. }
  3076. ]
  3077. }
  3078. },
  3079. {
  3080. "name": "lookup",
  3081. "in": "query",
  3082. "description": "If a global lookup should be performed too",
  3083. "schema": {
  3084. "type": "integer",
  3085. "default": 0,
  3086. "enum": [
  3087. 0,
  3088. 1
  3089. ]
  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": "Sharees search result returned",
  3106. "headers": {
  3107. "Link": {
  3108. "schema": {
  3109. "type": "string"
  3110. }
  3111. }
  3112. },
  3113. "content": {
  3114. "application/json": {
  3115. "schema": {
  3116. "type": "object",
  3117. "required": [
  3118. "ocs"
  3119. ],
  3120. "properties": {
  3121. "ocs": {
  3122. "type": "object",
  3123. "required": [
  3124. "meta",
  3125. "data"
  3126. ],
  3127. "properties": {
  3128. "meta": {
  3129. "$ref": "#/components/schemas/OCSMeta"
  3130. },
  3131. "data": {
  3132. "$ref": "#/components/schemas/ShareesSearchResult"
  3133. }
  3134. }
  3135. }
  3136. }
  3137. }
  3138. }
  3139. }
  3140. },
  3141. "400": {
  3142. "description": "Invalid search parameters",
  3143. "content": {
  3144. "application/json": {
  3145. "schema": {
  3146. "type": "object",
  3147. "required": [
  3148. "ocs"
  3149. ],
  3150. "properties": {
  3151. "ocs": {
  3152. "type": "object",
  3153. "required": [
  3154. "meta",
  3155. "data"
  3156. ],
  3157. "properties": {
  3158. "meta": {
  3159. "$ref": "#/components/schemas/OCSMeta"
  3160. },
  3161. "data": {}
  3162. }
  3163. }
  3164. }
  3165. }
  3166. }
  3167. }
  3168. }
  3169. }
  3170. }
  3171. },
  3172. "/ocs/v2.php/apps/files_sharing/api/v1/sharees_recommended": {
  3173. "get": {
  3174. "operationId": "shareesapi-find-recommended",
  3175. "summary": "Find recommended sharees",
  3176. "tags": [
  3177. "shareesapi"
  3178. ],
  3179. "security": [
  3180. {
  3181. "bearer_auth": []
  3182. },
  3183. {
  3184. "basic_auth": []
  3185. }
  3186. ],
  3187. "parameters": [
  3188. {
  3189. "name": "itemType",
  3190. "in": "query",
  3191. "description": "Limit to specific item types",
  3192. "required": true,
  3193. "schema": {
  3194. "type": "string"
  3195. }
  3196. },
  3197. {
  3198. "name": "shareType",
  3199. "in": "query",
  3200. "description": "Limit to specific share types",
  3201. "schema": {
  3202. "nullable": true,
  3203. "oneOf": [
  3204. {
  3205. "type": "integer",
  3206. "format": "int64"
  3207. },
  3208. {
  3209. "type": "array",
  3210. "items": {
  3211. "type": "integer",
  3212. "format": "int64"
  3213. }
  3214. }
  3215. ]
  3216. }
  3217. },
  3218. {
  3219. "name": "OCS-APIRequest",
  3220. "in": "header",
  3221. "description": "Required to be true for the API request to pass",
  3222. "required": true,
  3223. "schema": {
  3224. "type": "boolean",
  3225. "default": true
  3226. }
  3227. }
  3228. ],
  3229. "responses": {
  3230. "200": {
  3231. "description": "Recommended sharees returned",
  3232. "content": {
  3233. "application/json": {
  3234. "schema": {
  3235. "type": "object",
  3236. "required": [
  3237. "ocs"
  3238. ],
  3239. "properties": {
  3240. "ocs": {
  3241. "type": "object",
  3242. "required": [
  3243. "meta",
  3244. "data"
  3245. ],
  3246. "properties": {
  3247. "meta": {
  3248. "$ref": "#/components/schemas/OCSMeta"
  3249. },
  3250. "data": {
  3251. "$ref": "#/components/schemas/ShareesRecommendedResult"
  3252. }
  3253. }
  3254. }
  3255. }
  3256. }
  3257. }
  3258. }
  3259. }
  3260. }
  3261. }
  3262. },
  3263. "/ocs/v2.php/apps/files_sharing/api/v1/remote_shares": {
  3264. "get": {
  3265. "operationId": "remote-get-shares",
  3266. "summary": "Get a list of accepted remote shares",
  3267. "tags": [
  3268. "remote"
  3269. ],
  3270. "security": [
  3271. {
  3272. "bearer_auth": []
  3273. },
  3274. {
  3275. "basic_auth": []
  3276. }
  3277. ],
  3278. "parameters": [
  3279. {
  3280. "name": "OCS-APIRequest",
  3281. "in": "header",
  3282. "description": "Required to be true for the API request to pass",
  3283. "required": true,
  3284. "schema": {
  3285. "type": "boolean",
  3286. "default": true
  3287. }
  3288. }
  3289. ],
  3290. "responses": {
  3291. "200": {
  3292. "description": "Accepted remote shares returned",
  3293. "content": {
  3294. "application/json": {
  3295. "schema": {
  3296. "type": "object",
  3297. "required": [
  3298. "ocs"
  3299. ],
  3300. "properties": {
  3301. "ocs": {
  3302. "type": "object",
  3303. "required": [
  3304. "meta",
  3305. "data"
  3306. ],
  3307. "properties": {
  3308. "meta": {
  3309. "$ref": "#/components/schemas/OCSMeta"
  3310. },
  3311. "data": {
  3312. "type": "array",
  3313. "items": {
  3314. "$ref": "#/components/schemas/RemoteShare"
  3315. }
  3316. }
  3317. }
  3318. }
  3319. }
  3320. }
  3321. }
  3322. }
  3323. }
  3324. }
  3325. }
  3326. },
  3327. "/ocs/v2.php/apps/files_sharing/api/v1/remote_shares/pending": {
  3328. "get": {
  3329. "operationId": "remote-get-open-shares",
  3330. "summary": "Get list of pending remote shares",
  3331. "tags": [
  3332. "remote"
  3333. ],
  3334. "security": [
  3335. {
  3336. "bearer_auth": []
  3337. },
  3338. {
  3339. "basic_auth": []
  3340. }
  3341. ],
  3342. "parameters": [
  3343. {
  3344. "name": "OCS-APIRequest",
  3345. "in": "header",
  3346. "description": "Required to be true for the API request to pass",
  3347. "required": true,
  3348. "schema": {
  3349. "type": "boolean",
  3350. "default": true
  3351. }
  3352. }
  3353. ],
  3354. "responses": {
  3355. "200": {
  3356. "description": "Pending remote shares returned",
  3357. "content": {
  3358. "application/json": {
  3359. "schema": {
  3360. "type": "object",
  3361. "required": [
  3362. "ocs"
  3363. ],
  3364. "properties": {
  3365. "ocs": {
  3366. "type": "object",
  3367. "required": [
  3368. "meta",
  3369. "data"
  3370. ],
  3371. "properties": {
  3372. "meta": {
  3373. "$ref": "#/components/schemas/OCSMeta"
  3374. },
  3375. "data": {
  3376. "type": "array",
  3377. "items": {
  3378. "$ref": "#/components/schemas/RemoteShare"
  3379. }
  3380. }
  3381. }
  3382. }
  3383. }
  3384. }
  3385. }
  3386. }
  3387. }
  3388. }
  3389. }
  3390. },
  3391. "/ocs/v2.php/apps/files_sharing/api/v1/remote_shares/pending/{id}": {
  3392. "post": {
  3393. "operationId": "remote-accept-share",
  3394. "summary": "Accept a remote share",
  3395. "tags": [
  3396. "remote"
  3397. ],
  3398. "security": [
  3399. {
  3400. "bearer_auth": []
  3401. },
  3402. {
  3403. "basic_auth": []
  3404. }
  3405. ],
  3406. "parameters": [
  3407. {
  3408. "name": "id",
  3409. "in": "path",
  3410. "description": "ID of the share",
  3411. "required": true,
  3412. "schema": {
  3413. "type": "integer",
  3414. "format": "int64"
  3415. }
  3416. },
  3417. {
  3418. "name": "OCS-APIRequest",
  3419. "in": "header",
  3420. "description": "Required to be true for the API request to pass",
  3421. "required": true,
  3422. "schema": {
  3423. "type": "boolean",
  3424. "default": true
  3425. }
  3426. }
  3427. ],
  3428. "responses": {
  3429. "200": {
  3430. "description": "Share accepted successfully",
  3431. "content": {
  3432. "application/json": {
  3433. "schema": {
  3434. "type": "object",
  3435. "required": [
  3436. "ocs"
  3437. ],
  3438. "properties": {
  3439. "ocs": {
  3440. "type": "object",
  3441. "required": [
  3442. "meta",
  3443. "data"
  3444. ],
  3445. "properties": {
  3446. "meta": {
  3447. "$ref": "#/components/schemas/OCSMeta"
  3448. },
  3449. "data": {}
  3450. }
  3451. }
  3452. }
  3453. }
  3454. }
  3455. }
  3456. },
  3457. "404": {
  3458. "description": "Share not found",
  3459. "content": {
  3460. "application/json": {
  3461. "schema": {
  3462. "type": "object",
  3463. "required": [
  3464. "ocs"
  3465. ],
  3466. "properties": {
  3467. "ocs": {
  3468. "type": "object",
  3469. "required": [
  3470. "meta",
  3471. "data"
  3472. ],
  3473. "properties": {
  3474. "meta": {
  3475. "$ref": "#/components/schemas/OCSMeta"
  3476. },
  3477. "data": {}
  3478. }
  3479. }
  3480. }
  3481. }
  3482. }
  3483. }
  3484. }
  3485. }
  3486. },
  3487. "delete": {
  3488. "operationId": "remote-decline-share",
  3489. "summary": "Decline a remote share",
  3490. "tags": [
  3491. "remote"
  3492. ],
  3493. "security": [
  3494. {
  3495. "bearer_auth": []
  3496. },
  3497. {
  3498. "basic_auth": []
  3499. }
  3500. ],
  3501. "parameters": [
  3502. {
  3503. "name": "id",
  3504. "in": "path",
  3505. "description": "ID of the share",
  3506. "required": true,
  3507. "schema": {
  3508. "type": "integer",
  3509. "format": "int64"
  3510. }
  3511. },
  3512. {
  3513. "name": "OCS-APIRequest",
  3514. "in": "header",
  3515. "description": "Required to be true for the API request to pass",
  3516. "required": true,
  3517. "schema": {
  3518. "type": "boolean",
  3519. "default": true
  3520. }
  3521. }
  3522. ],
  3523. "responses": {
  3524. "200": {
  3525. "description": "Share declined successfully",
  3526. "content": {
  3527. "application/json": {
  3528. "schema": {
  3529. "type": "object",
  3530. "required": [
  3531. "ocs"
  3532. ],
  3533. "properties": {
  3534. "ocs": {
  3535. "type": "object",
  3536. "required": [
  3537. "meta",
  3538. "data"
  3539. ],
  3540. "properties": {
  3541. "meta": {
  3542. "$ref": "#/components/schemas/OCSMeta"
  3543. },
  3544. "data": {}
  3545. }
  3546. }
  3547. }
  3548. }
  3549. }
  3550. }
  3551. },
  3552. "404": {
  3553. "description": "Share not found",
  3554. "content": {
  3555. "application/json": {
  3556. "schema": {
  3557. "type": "object",
  3558. "required": [
  3559. "ocs"
  3560. ],
  3561. "properties": {
  3562. "ocs": {
  3563. "type": "object",
  3564. "required": [
  3565. "meta",
  3566. "data"
  3567. ],
  3568. "properties": {
  3569. "meta": {
  3570. "$ref": "#/components/schemas/OCSMeta"
  3571. },
  3572. "data": {}
  3573. }
  3574. }
  3575. }
  3576. }
  3577. }
  3578. }
  3579. }
  3580. }
  3581. }
  3582. },
  3583. "/ocs/v2.php/apps/files_sharing/api/v1/remote_shares/{id}": {
  3584. "get": {
  3585. "operationId": "remote-get-share",
  3586. "summary": "Get info of a remote share",
  3587. "tags": [
  3588. "remote"
  3589. ],
  3590. "security": [
  3591. {
  3592. "bearer_auth": []
  3593. },
  3594. {
  3595. "basic_auth": []
  3596. }
  3597. ],
  3598. "parameters": [
  3599. {
  3600. "name": "id",
  3601. "in": "path",
  3602. "description": "ID of the share",
  3603. "required": true,
  3604. "schema": {
  3605. "type": "integer",
  3606. "format": "int64"
  3607. }
  3608. },
  3609. {
  3610. "name": "OCS-APIRequest",
  3611. "in": "header",
  3612. "description": "Required to be true for the API request to pass",
  3613. "required": true,
  3614. "schema": {
  3615. "type": "boolean",
  3616. "default": true
  3617. }
  3618. }
  3619. ],
  3620. "responses": {
  3621. "200": {
  3622. "description": "Share returned",
  3623. "content": {
  3624. "application/json": {
  3625. "schema": {
  3626. "type": "object",
  3627. "required": [
  3628. "ocs"
  3629. ],
  3630. "properties": {
  3631. "ocs": {
  3632. "type": "object",
  3633. "required": [
  3634. "meta",
  3635. "data"
  3636. ],
  3637. "properties": {
  3638. "meta": {
  3639. "$ref": "#/components/schemas/OCSMeta"
  3640. },
  3641. "data": {
  3642. "$ref": "#/components/schemas/RemoteShare"
  3643. }
  3644. }
  3645. }
  3646. }
  3647. }
  3648. }
  3649. }
  3650. },
  3651. "404": {
  3652. "description": "Share not found",
  3653. "content": {
  3654. "application/json": {
  3655. "schema": {
  3656. "type": "object",
  3657. "required": [
  3658. "ocs"
  3659. ],
  3660. "properties": {
  3661. "ocs": {
  3662. "type": "object",
  3663. "required": [
  3664. "meta",
  3665. "data"
  3666. ],
  3667. "properties": {
  3668. "meta": {
  3669. "$ref": "#/components/schemas/OCSMeta"
  3670. },
  3671. "data": {}
  3672. }
  3673. }
  3674. }
  3675. }
  3676. }
  3677. }
  3678. }
  3679. }
  3680. },
  3681. "delete": {
  3682. "operationId": "remote-unshare",
  3683. "summary": "Unshare a remote share",
  3684. "tags": [
  3685. "remote"
  3686. ],
  3687. "security": [
  3688. {
  3689. "bearer_auth": []
  3690. },
  3691. {
  3692. "basic_auth": []
  3693. }
  3694. ],
  3695. "parameters": [
  3696. {
  3697. "name": "id",
  3698. "in": "path",
  3699. "description": "ID of the share",
  3700. "required": true,
  3701. "schema": {
  3702. "type": "integer",
  3703. "format": "int64"
  3704. }
  3705. },
  3706. {
  3707. "name": "OCS-APIRequest",
  3708. "in": "header",
  3709. "description": "Required to be true for the API request to pass",
  3710. "required": true,
  3711. "schema": {
  3712. "type": "boolean",
  3713. "default": true
  3714. }
  3715. }
  3716. ],
  3717. "responses": {
  3718. "200": {
  3719. "description": "Share unshared successfully",
  3720. "content": {
  3721. "application/json": {
  3722. "schema": {
  3723. "type": "object",
  3724. "required": [
  3725. "ocs"
  3726. ],
  3727. "properties": {
  3728. "ocs": {
  3729. "type": "object",
  3730. "required": [
  3731. "meta",
  3732. "data"
  3733. ],
  3734. "properties": {
  3735. "meta": {
  3736. "$ref": "#/components/schemas/OCSMeta"
  3737. },
  3738. "data": {}
  3739. }
  3740. }
  3741. }
  3742. }
  3743. }
  3744. }
  3745. },
  3746. "404": {
  3747. "description": "Share not found",
  3748. "content": {
  3749. "application/json": {
  3750. "schema": {
  3751. "type": "object",
  3752. "required": [
  3753. "ocs"
  3754. ],
  3755. "properties": {
  3756. "ocs": {
  3757. "type": "object",
  3758. "required": [
  3759. "meta",
  3760. "data"
  3761. ],
  3762. "properties": {
  3763. "meta": {
  3764. "$ref": "#/components/schemas/OCSMeta"
  3765. },
  3766. "data": {}
  3767. }
  3768. }
  3769. }
  3770. }
  3771. }
  3772. }
  3773. },
  3774. "403": {
  3775. "description": "Unsharing is not possible",
  3776. "content": {
  3777. "application/json": {
  3778. "schema": {
  3779. "type": "object",
  3780. "required": [
  3781. "ocs"
  3782. ],
  3783. "properties": {
  3784. "ocs": {
  3785. "type": "object",
  3786. "required": [
  3787. "meta",
  3788. "data"
  3789. ],
  3790. "properties": {
  3791. "meta": {
  3792. "$ref": "#/components/schemas/OCSMeta"
  3793. },
  3794. "data": {}
  3795. }
  3796. }
  3797. }
  3798. }
  3799. }
  3800. }
  3801. }
  3802. }
  3803. }
  3804. }
  3805. },
  3806. "tags": [
  3807. {
  3808. "name": "external_shares",
  3809. "description": "Class ExternalSharesController"
  3810. }
  3811. ]
  3812. }