1
0

openapi.json 147 KB

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