openapi.json 156 KB

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