openapi.json 147 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688
  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": "file",
  1399. "in": "query",
  1400. "description": "File in the share",
  1401. "schema": {
  1402. "type": "string",
  1403. "default": ""
  1404. }
  1405. },
  1406. {
  1407. "name": "x",
  1408. "in": "query",
  1409. "description": "Width of the preview",
  1410. "schema": {
  1411. "type": "integer",
  1412. "format": "int64",
  1413. "default": 32
  1414. }
  1415. },
  1416. {
  1417. "name": "y",
  1418. "in": "query",
  1419. "description": "Height of the preview",
  1420. "schema": {
  1421. "type": "integer",
  1422. "format": "int64",
  1423. "default": 32
  1424. }
  1425. },
  1426. {
  1427. "name": "a",
  1428. "in": "query",
  1429. "description": "Whether to not crop the preview",
  1430. "schema": {
  1431. "type": "integer",
  1432. "default": 0,
  1433. "enum": [
  1434. 0,
  1435. 1
  1436. ]
  1437. }
  1438. },
  1439. {
  1440. "name": "token",
  1441. "in": "path",
  1442. "description": "Token of the share",
  1443. "required": true,
  1444. "schema": {
  1445. "type": "string"
  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. "parameters": [
  1505. {
  1506. "name": "t",
  1507. "in": "query",
  1508. "description": "Token of the share",
  1509. "required": true,
  1510. "schema": {
  1511. "type": "string"
  1512. }
  1513. },
  1514. {
  1515. "name": "password",
  1516. "in": "query",
  1517. "description": "Password of the share",
  1518. "schema": {
  1519. "type": "string",
  1520. "nullable": true
  1521. }
  1522. },
  1523. {
  1524. "name": "dir",
  1525. "in": "query",
  1526. "description": "Subdirectory to get info about",
  1527. "schema": {
  1528. "type": "string",
  1529. "nullable": true
  1530. }
  1531. },
  1532. {
  1533. "name": "depth",
  1534. "in": "query",
  1535. "description": "Maximum depth to get info about",
  1536. "schema": {
  1537. "type": "integer",
  1538. "format": "int64",
  1539. "default": -1
  1540. }
  1541. }
  1542. ],
  1543. "responses": {
  1544. "200": {
  1545. "description": "Share info returned",
  1546. "content": {
  1547. "application/json": {
  1548. "schema": {
  1549. "$ref": "#/components/schemas/ShareInfo"
  1550. }
  1551. }
  1552. }
  1553. },
  1554. "403": {
  1555. "description": "Getting share info is not allowed",
  1556. "content": {
  1557. "application/json": {
  1558. "schema": {}
  1559. }
  1560. }
  1561. },
  1562. "404": {
  1563. "description": "Share not found",
  1564. "content": {
  1565. "application/json": {
  1566. "schema": {}
  1567. }
  1568. }
  1569. }
  1570. }
  1571. }
  1572. },
  1573. "/ocs/v2.php/apps/files_sharing/api/v1/shares": {
  1574. "get": {
  1575. "operationId": "shareapi-get-shares",
  1576. "summary": "Get shares of the current user",
  1577. "tags": [
  1578. "shareapi"
  1579. ],
  1580. "security": [
  1581. {
  1582. "bearer_auth": []
  1583. },
  1584. {
  1585. "basic_auth": []
  1586. }
  1587. ],
  1588. "parameters": [
  1589. {
  1590. "name": "shared_with_me",
  1591. "in": "query",
  1592. "description": "Only get shares with the current user",
  1593. "schema": {
  1594. "type": "string",
  1595. "default": "false"
  1596. }
  1597. },
  1598. {
  1599. "name": "reshares",
  1600. "in": "query",
  1601. "description": "Only get shares by the current user and reshares",
  1602. "schema": {
  1603. "type": "string",
  1604. "default": "false"
  1605. }
  1606. },
  1607. {
  1608. "name": "subfiles",
  1609. "in": "query",
  1610. "description": "Only get all shares in a folder",
  1611. "schema": {
  1612. "type": "string",
  1613. "default": "false"
  1614. }
  1615. },
  1616. {
  1617. "name": "path",
  1618. "in": "query",
  1619. "description": "Get shares for a specific path",
  1620. "schema": {
  1621. "type": "string",
  1622. "default": ""
  1623. }
  1624. },
  1625. {
  1626. "name": "include_tags",
  1627. "in": "query",
  1628. "description": "Include tags in the share",
  1629. "schema": {
  1630. "type": "string",
  1631. "default": "false"
  1632. }
  1633. },
  1634. {
  1635. "name": "OCS-APIRequest",
  1636. "in": "header",
  1637. "description": "Required to be true for the API request to pass",
  1638. "required": true,
  1639. "schema": {
  1640. "type": "boolean",
  1641. "default": true
  1642. }
  1643. }
  1644. ],
  1645. "responses": {
  1646. "200": {
  1647. "description": "Shares returned",
  1648. "content": {
  1649. "application/json": {
  1650. "schema": {
  1651. "type": "object",
  1652. "required": [
  1653. "ocs"
  1654. ],
  1655. "properties": {
  1656. "ocs": {
  1657. "type": "object",
  1658. "required": [
  1659. "meta",
  1660. "data"
  1661. ],
  1662. "properties": {
  1663. "meta": {
  1664. "$ref": "#/components/schemas/OCSMeta"
  1665. },
  1666. "data": {
  1667. "type": "array",
  1668. "items": {
  1669. "$ref": "#/components/schemas/Share"
  1670. }
  1671. }
  1672. }
  1673. }
  1674. }
  1675. }
  1676. }
  1677. }
  1678. },
  1679. "404": {
  1680. "description": "The folder was not found or is inaccessible",
  1681. "content": {
  1682. "application/json": {
  1683. "schema": {
  1684. "type": "object",
  1685. "required": [
  1686. "ocs"
  1687. ],
  1688. "properties": {
  1689. "ocs": {
  1690. "type": "object",
  1691. "required": [
  1692. "meta",
  1693. "data"
  1694. ],
  1695. "properties": {
  1696. "meta": {
  1697. "$ref": "#/components/schemas/OCSMeta"
  1698. },
  1699. "data": {}
  1700. }
  1701. }
  1702. }
  1703. }
  1704. }
  1705. }
  1706. }
  1707. }
  1708. },
  1709. "post": {
  1710. "operationId": "shareapi-create-share",
  1711. "summary": "Create a share",
  1712. "tags": [
  1713. "shareapi"
  1714. ],
  1715. "security": [
  1716. {
  1717. "bearer_auth": []
  1718. },
  1719. {
  1720. "basic_auth": []
  1721. }
  1722. ],
  1723. "parameters": [
  1724. {
  1725. "name": "path",
  1726. "in": "query",
  1727. "description": "Path of the share",
  1728. "schema": {
  1729. "type": "string",
  1730. "nullable": true
  1731. }
  1732. },
  1733. {
  1734. "name": "permissions",
  1735. "in": "query",
  1736. "description": "Permissions for the share",
  1737. "schema": {
  1738. "type": "integer",
  1739. "format": "int64",
  1740. "nullable": true
  1741. }
  1742. },
  1743. {
  1744. "name": "shareType",
  1745. "in": "query",
  1746. "description": "Type of the share",
  1747. "schema": {
  1748. "type": "integer",
  1749. "format": "int64",
  1750. "default": -1
  1751. }
  1752. },
  1753. {
  1754. "name": "shareWith",
  1755. "in": "query",
  1756. "description": "The entity this should be shared with",
  1757. "schema": {
  1758. "type": "string",
  1759. "nullable": true
  1760. }
  1761. },
  1762. {
  1763. "name": "publicUpload",
  1764. "in": "query",
  1765. "description": "If public uploading is allowed",
  1766. "schema": {
  1767. "type": "string",
  1768. "default": "false"
  1769. }
  1770. },
  1771. {
  1772. "name": "password",
  1773. "in": "query",
  1774. "description": "Password for the share",
  1775. "schema": {
  1776. "type": "string",
  1777. "default": ""
  1778. }
  1779. },
  1780. {
  1781. "name": "sendPasswordByTalk",
  1782. "in": "query",
  1783. "description": "Send the password for the share over Talk",
  1784. "schema": {
  1785. "type": "string",
  1786. "nullable": true
  1787. }
  1788. },
  1789. {
  1790. "name": "expireDate",
  1791. "in": "query",
  1792. "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.",
  1793. "schema": {
  1794. "type": "string",
  1795. "nullable": true
  1796. }
  1797. },
  1798. {
  1799. "name": "note",
  1800. "in": "query",
  1801. "description": "Note for the share",
  1802. "schema": {
  1803. "type": "string",
  1804. "default": ""
  1805. }
  1806. },
  1807. {
  1808. "name": "label",
  1809. "in": "query",
  1810. "description": "Label for the share (only used in link and email)",
  1811. "schema": {
  1812. "type": "string",
  1813. "default": ""
  1814. }
  1815. },
  1816. {
  1817. "name": "attributes",
  1818. "in": "query",
  1819. "description": "Additional attributes for the share",
  1820. "schema": {
  1821. "type": "string",
  1822. "nullable": true
  1823. }
  1824. },
  1825. {
  1826. "name": "OCS-APIRequest",
  1827. "in": "header",
  1828. "description": "Required to be true for the API request to pass",
  1829. "required": true,
  1830. "schema": {
  1831. "type": "boolean",
  1832. "default": true
  1833. }
  1834. }
  1835. ],
  1836. "responses": {
  1837. "200": {
  1838. "description": "Share created",
  1839. "content": {
  1840. "application/json": {
  1841. "schema": {
  1842. "type": "object",
  1843. "required": [
  1844. "ocs"
  1845. ],
  1846. "properties": {
  1847. "ocs": {
  1848. "type": "object",
  1849. "required": [
  1850. "meta",
  1851. "data"
  1852. ],
  1853. "properties": {
  1854. "meta": {
  1855. "$ref": "#/components/schemas/OCSMeta"
  1856. },
  1857. "data": {
  1858. "$ref": "#/components/schemas/Share"
  1859. }
  1860. }
  1861. }
  1862. }
  1863. }
  1864. }
  1865. }
  1866. },
  1867. "400": {
  1868. "description": "Unknown share type",
  1869. "content": {
  1870. "application/json": {
  1871. "schema": {
  1872. "type": "object",
  1873. "required": [
  1874. "ocs"
  1875. ],
  1876. "properties": {
  1877. "ocs": {
  1878. "type": "object",
  1879. "required": [
  1880. "meta",
  1881. "data"
  1882. ],
  1883. "properties": {
  1884. "meta": {
  1885. "$ref": "#/components/schemas/OCSMeta"
  1886. },
  1887. "data": {}
  1888. }
  1889. }
  1890. }
  1891. }
  1892. }
  1893. }
  1894. },
  1895. "403": {
  1896. "description": "Creating the share is not allowed",
  1897. "content": {
  1898. "application/json": {
  1899. "schema": {
  1900. "type": "object",
  1901. "required": [
  1902. "ocs"
  1903. ],
  1904. "properties": {
  1905. "ocs": {
  1906. "type": "object",
  1907. "required": [
  1908. "meta",
  1909. "data"
  1910. ],
  1911. "properties": {
  1912. "meta": {
  1913. "$ref": "#/components/schemas/OCSMeta"
  1914. },
  1915. "data": {}
  1916. }
  1917. }
  1918. }
  1919. }
  1920. }
  1921. }
  1922. },
  1923. "404": {
  1924. "description": "Creating the share failed",
  1925. "content": {
  1926. "application/json": {
  1927. "schema": {
  1928. "type": "object",
  1929. "required": [
  1930. "ocs"
  1931. ],
  1932. "properties": {
  1933. "ocs": {
  1934. "type": "object",
  1935. "required": [
  1936. "meta",
  1937. "data"
  1938. ],
  1939. "properties": {
  1940. "meta": {
  1941. "$ref": "#/components/schemas/OCSMeta"
  1942. },
  1943. "data": {}
  1944. }
  1945. }
  1946. }
  1947. }
  1948. }
  1949. }
  1950. }
  1951. }
  1952. }
  1953. },
  1954. "/ocs/v2.php/apps/files_sharing/api/v1/shares/inherited": {
  1955. "get": {
  1956. "operationId": "shareapi-get-inherited-shares",
  1957. "summary": "Get all shares relative to a file, including parent folders shares rights",
  1958. "tags": [
  1959. "shareapi"
  1960. ],
  1961. "security": [
  1962. {
  1963. "bearer_auth": []
  1964. },
  1965. {
  1966. "basic_auth": []
  1967. }
  1968. ],
  1969. "parameters": [
  1970. {
  1971. "name": "path",
  1972. "in": "query",
  1973. "description": "Path all shares will be relative to",
  1974. "required": true,
  1975. "schema": {
  1976. "type": "string"
  1977. }
  1978. },
  1979. {
  1980. "name": "OCS-APIRequest",
  1981. "in": "header",
  1982. "description": "Required to be true for the API request to pass",
  1983. "required": true,
  1984. "schema": {
  1985. "type": "boolean",
  1986. "default": true
  1987. }
  1988. }
  1989. ],
  1990. "responses": {
  1991. "200": {
  1992. "description": "Shares returned",
  1993. "content": {
  1994. "application/json": {
  1995. "schema": {
  1996. "type": "object",
  1997. "required": [
  1998. "ocs"
  1999. ],
  2000. "properties": {
  2001. "ocs": {
  2002. "type": "object",
  2003. "required": [
  2004. "meta",
  2005. "data"
  2006. ],
  2007. "properties": {
  2008. "meta": {
  2009. "$ref": "#/components/schemas/OCSMeta"
  2010. },
  2011. "data": {
  2012. "type": "array",
  2013. "items": {
  2014. "$ref": "#/components/schemas/Share"
  2015. }
  2016. }
  2017. }
  2018. }
  2019. }
  2020. }
  2021. }
  2022. }
  2023. },
  2024. "500": {
  2025. "description": "",
  2026. "content": {
  2027. "text/plain": {
  2028. "schema": {
  2029. "type": "string"
  2030. }
  2031. }
  2032. }
  2033. },
  2034. "404": {
  2035. "description": "The given path is invalid",
  2036. "content": {
  2037. "application/json": {
  2038. "schema": {
  2039. "type": "object",
  2040. "required": [
  2041. "ocs"
  2042. ],
  2043. "properties": {
  2044. "ocs": {
  2045. "type": "object",
  2046. "required": [
  2047. "meta",
  2048. "data"
  2049. ],
  2050. "properties": {
  2051. "meta": {
  2052. "$ref": "#/components/schemas/OCSMeta"
  2053. },
  2054. "data": {}
  2055. }
  2056. }
  2057. }
  2058. }
  2059. }
  2060. }
  2061. }
  2062. }
  2063. }
  2064. },
  2065. "/ocs/v2.php/apps/files_sharing/api/v1/shares/pending": {
  2066. "get": {
  2067. "operationId": "shareapi-pending-shares",
  2068. "summary": "Get all shares that are still pending",
  2069. "tags": [
  2070. "shareapi"
  2071. ],
  2072. "security": [
  2073. {
  2074. "bearer_auth": []
  2075. },
  2076. {
  2077. "basic_auth": []
  2078. }
  2079. ],
  2080. "parameters": [
  2081. {
  2082. "name": "OCS-APIRequest",
  2083. "in": "header",
  2084. "description": "Required to be true for the API request to pass",
  2085. "required": true,
  2086. "schema": {
  2087. "type": "boolean",
  2088. "default": true
  2089. }
  2090. }
  2091. ],
  2092. "responses": {
  2093. "200": {
  2094. "description": "Pending shares returned",
  2095. "content": {
  2096. "application/json": {
  2097. "schema": {
  2098. "type": "object",
  2099. "required": [
  2100. "ocs"
  2101. ],
  2102. "properties": {
  2103. "ocs": {
  2104. "type": "object",
  2105. "required": [
  2106. "meta",
  2107. "data"
  2108. ],
  2109. "properties": {
  2110. "meta": {
  2111. "$ref": "#/components/schemas/OCSMeta"
  2112. },
  2113. "data": {
  2114. "type": "array",
  2115. "items": {
  2116. "$ref": "#/components/schemas/Share"
  2117. }
  2118. }
  2119. }
  2120. }
  2121. }
  2122. }
  2123. }
  2124. }
  2125. }
  2126. }
  2127. }
  2128. },
  2129. "/ocs/v2.php/apps/files_sharing/api/v1/shares/{id}": {
  2130. "get": {
  2131. "operationId": "shareapi-get-share",
  2132. "summary": "Get a specific share by id",
  2133. "tags": [
  2134. "shareapi"
  2135. ],
  2136. "security": [
  2137. {
  2138. "bearer_auth": []
  2139. },
  2140. {
  2141. "basic_auth": []
  2142. }
  2143. ],
  2144. "parameters": [
  2145. {
  2146. "name": "include_tags",
  2147. "in": "query",
  2148. "description": "Include tags in the share",
  2149. "schema": {
  2150. "type": "integer",
  2151. "default": 0,
  2152. "enum": [
  2153. 0,
  2154. 1
  2155. ]
  2156. }
  2157. },
  2158. {
  2159. "name": "id",
  2160. "in": "path",
  2161. "description": "ID of the share",
  2162. "required": true,
  2163. "schema": {
  2164. "type": "string"
  2165. }
  2166. },
  2167. {
  2168. "name": "OCS-APIRequest",
  2169. "in": "header",
  2170. "description": "Required to be true for the API request to pass",
  2171. "required": true,
  2172. "schema": {
  2173. "type": "boolean",
  2174. "default": true
  2175. }
  2176. }
  2177. ],
  2178. "responses": {
  2179. "200": {
  2180. "description": "Share returned",
  2181. "content": {
  2182. "application/json": {
  2183. "schema": {
  2184. "type": "object",
  2185. "required": [
  2186. "ocs"
  2187. ],
  2188. "properties": {
  2189. "ocs": {
  2190. "type": "object",
  2191. "required": [
  2192. "meta",
  2193. "data"
  2194. ],
  2195. "properties": {
  2196. "meta": {
  2197. "$ref": "#/components/schemas/OCSMeta"
  2198. },
  2199. "data": {
  2200. "$ref": "#/components/schemas/Share"
  2201. }
  2202. }
  2203. }
  2204. }
  2205. }
  2206. }
  2207. }
  2208. },
  2209. "404": {
  2210. "description": "Share not found",
  2211. "content": {
  2212. "application/json": {
  2213. "schema": {
  2214. "type": "object",
  2215. "required": [
  2216. "ocs"
  2217. ],
  2218. "properties": {
  2219. "ocs": {
  2220. "type": "object",
  2221. "required": [
  2222. "meta",
  2223. "data"
  2224. ],
  2225. "properties": {
  2226. "meta": {
  2227. "$ref": "#/components/schemas/OCSMeta"
  2228. },
  2229. "data": {}
  2230. }
  2231. }
  2232. }
  2233. }
  2234. }
  2235. }
  2236. }
  2237. }
  2238. },
  2239. "put": {
  2240. "operationId": "shareapi-update-share",
  2241. "summary": "Update a share",
  2242. "tags": [
  2243. "shareapi"
  2244. ],
  2245. "security": [
  2246. {
  2247. "bearer_auth": []
  2248. },
  2249. {
  2250. "basic_auth": []
  2251. }
  2252. ],
  2253. "parameters": [
  2254. {
  2255. "name": "permissions",
  2256. "in": "query",
  2257. "description": "New permissions",
  2258. "schema": {
  2259. "type": "integer",
  2260. "format": "int64",
  2261. "nullable": true
  2262. }
  2263. },
  2264. {
  2265. "name": "password",
  2266. "in": "query",
  2267. "description": "New password",
  2268. "schema": {
  2269. "type": "string",
  2270. "nullable": true
  2271. }
  2272. },
  2273. {
  2274. "name": "sendPasswordByTalk",
  2275. "in": "query",
  2276. "description": "New condition if the password should be send over Talk",
  2277. "schema": {
  2278. "type": "string",
  2279. "nullable": true
  2280. }
  2281. },
  2282. {
  2283. "name": "publicUpload",
  2284. "in": "query",
  2285. "description": "New condition if public uploading is allowed",
  2286. "schema": {
  2287. "type": "string",
  2288. "nullable": true
  2289. }
  2290. },
  2291. {
  2292. "name": "expireDate",
  2293. "in": "query",
  2294. "description": "New expiry date",
  2295. "schema": {
  2296. "type": "string",
  2297. "nullable": true
  2298. }
  2299. },
  2300. {
  2301. "name": "note",
  2302. "in": "query",
  2303. "description": "New note",
  2304. "schema": {
  2305. "type": "string",
  2306. "nullable": true
  2307. }
  2308. },
  2309. {
  2310. "name": "label",
  2311. "in": "query",
  2312. "description": "New label",
  2313. "schema": {
  2314. "type": "string",
  2315. "nullable": true
  2316. }
  2317. },
  2318. {
  2319. "name": "hideDownload",
  2320. "in": "query",
  2321. "description": "New condition if the download should be hidden",
  2322. "schema": {
  2323. "type": "string",
  2324. "nullable": true
  2325. }
  2326. },
  2327. {
  2328. "name": "attributes",
  2329. "in": "query",
  2330. "description": "New additional attributes",
  2331. "schema": {
  2332. "type": "string",
  2333. "nullable": true
  2334. }
  2335. },
  2336. {
  2337. "name": "id",
  2338. "in": "path",
  2339. "description": "ID of the share",
  2340. "required": true,
  2341. "schema": {
  2342. "type": "string"
  2343. }
  2344. },
  2345. {
  2346. "name": "OCS-APIRequest",
  2347. "in": "header",
  2348. "description": "Required to be true for the API request to pass",
  2349. "required": true,
  2350. "schema": {
  2351. "type": "boolean",
  2352. "default": true
  2353. }
  2354. }
  2355. ],
  2356. "responses": {
  2357. "200": {
  2358. "description": "Share updated successfully",
  2359. "content": {
  2360. "application/json": {
  2361. "schema": {
  2362. "type": "object",
  2363. "required": [
  2364. "ocs"
  2365. ],
  2366. "properties": {
  2367. "ocs": {
  2368. "type": "object",
  2369. "required": [
  2370. "meta",
  2371. "data"
  2372. ],
  2373. "properties": {
  2374. "meta": {
  2375. "$ref": "#/components/schemas/OCSMeta"
  2376. },
  2377. "data": {
  2378. "$ref": "#/components/schemas/Share"
  2379. }
  2380. }
  2381. }
  2382. }
  2383. }
  2384. }
  2385. }
  2386. },
  2387. "400": {
  2388. "description": "Share could not be updated because the requested changes are invalid",
  2389. "content": {
  2390. "application/json": {
  2391. "schema": {
  2392. "type": "object",
  2393. "required": [
  2394. "ocs"
  2395. ],
  2396. "properties": {
  2397. "ocs": {
  2398. "type": "object",
  2399. "required": [
  2400. "meta",
  2401. "data"
  2402. ],
  2403. "properties": {
  2404. "meta": {
  2405. "$ref": "#/components/schemas/OCSMeta"
  2406. },
  2407. "data": {}
  2408. }
  2409. }
  2410. }
  2411. }
  2412. }
  2413. }
  2414. },
  2415. "403": {
  2416. "description": "Missing permissions to update the share",
  2417. "content": {
  2418. "application/json": {
  2419. "schema": {
  2420. "type": "object",
  2421. "required": [
  2422. "ocs"
  2423. ],
  2424. "properties": {
  2425. "ocs": {
  2426. "type": "object",
  2427. "required": [
  2428. "meta",
  2429. "data"
  2430. ],
  2431. "properties": {
  2432. "meta": {
  2433. "$ref": "#/components/schemas/OCSMeta"
  2434. },
  2435. "data": {}
  2436. }
  2437. }
  2438. }
  2439. }
  2440. }
  2441. }
  2442. },
  2443. "404": {
  2444. "description": "Share not found",
  2445. "content": {
  2446. "application/json": {
  2447. "schema": {
  2448. "type": "object",
  2449. "required": [
  2450. "ocs"
  2451. ],
  2452. "properties": {
  2453. "ocs": {
  2454. "type": "object",
  2455. "required": [
  2456. "meta",
  2457. "data"
  2458. ],
  2459. "properties": {
  2460. "meta": {
  2461. "$ref": "#/components/schemas/OCSMeta"
  2462. },
  2463. "data": {}
  2464. }
  2465. }
  2466. }
  2467. }
  2468. }
  2469. }
  2470. }
  2471. }
  2472. },
  2473. "delete": {
  2474. "operationId": "shareapi-delete-share",
  2475. "summary": "Delete a share",
  2476. "tags": [
  2477. "shareapi"
  2478. ],
  2479. "security": [
  2480. {
  2481. "bearer_auth": []
  2482. },
  2483. {
  2484. "basic_auth": []
  2485. }
  2486. ],
  2487. "parameters": [
  2488. {
  2489. "name": "id",
  2490. "in": "path",
  2491. "description": "ID of the share",
  2492. "required": true,
  2493. "schema": {
  2494. "type": "string"
  2495. }
  2496. },
  2497. {
  2498. "name": "OCS-APIRequest",
  2499. "in": "header",
  2500. "description": "Required to be true for the API request to pass",
  2501. "required": true,
  2502. "schema": {
  2503. "type": "boolean",
  2504. "default": true
  2505. }
  2506. }
  2507. ],
  2508. "responses": {
  2509. "200": {
  2510. "description": "Share deleted successfully",
  2511. "content": {
  2512. "application/json": {
  2513. "schema": {
  2514. "type": "object",
  2515. "required": [
  2516. "ocs"
  2517. ],
  2518. "properties": {
  2519. "ocs": {
  2520. "type": "object",
  2521. "required": [
  2522. "meta",
  2523. "data"
  2524. ],
  2525. "properties": {
  2526. "meta": {
  2527. "$ref": "#/components/schemas/OCSMeta"
  2528. },
  2529. "data": {}
  2530. }
  2531. }
  2532. }
  2533. }
  2534. }
  2535. }
  2536. },
  2537. "404": {
  2538. "description": "Share not found",
  2539. "content": {
  2540. "application/json": {
  2541. "schema": {
  2542. "type": "object",
  2543. "required": [
  2544. "ocs"
  2545. ],
  2546. "properties": {
  2547. "ocs": {
  2548. "type": "object",
  2549. "required": [
  2550. "meta",
  2551. "data"
  2552. ],
  2553. "properties": {
  2554. "meta": {
  2555. "$ref": "#/components/schemas/OCSMeta"
  2556. },
  2557. "data": {}
  2558. }
  2559. }
  2560. }
  2561. }
  2562. }
  2563. }
  2564. },
  2565. "403": {
  2566. "description": "Missing permissions to delete the share",
  2567. "content": {
  2568. "application/json": {
  2569. "schema": {
  2570. "type": "object",
  2571. "required": [
  2572. "ocs"
  2573. ],
  2574. "properties": {
  2575. "ocs": {
  2576. "type": "object",
  2577. "required": [
  2578. "meta",
  2579. "data"
  2580. ],
  2581. "properties": {
  2582. "meta": {
  2583. "$ref": "#/components/schemas/OCSMeta"
  2584. },
  2585. "data": {}
  2586. }
  2587. }
  2588. }
  2589. }
  2590. }
  2591. }
  2592. }
  2593. }
  2594. }
  2595. },
  2596. "/ocs/v2.php/apps/files_sharing/api/v1/shares/pending/{id}": {
  2597. "post": {
  2598. "operationId": "shareapi-accept-share",
  2599. "summary": "Accept a share",
  2600. "tags": [
  2601. "shareapi"
  2602. ],
  2603. "security": [
  2604. {
  2605. "bearer_auth": []
  2606. },
  2607. {
  2608. "basic_auth": []
  2609. }
  2610. ],
  2611. "parameters": [
  2612. {
  2613. "name": "id",
  2614. "in": "path",
  2615. "description": "ID of the share",
  2616. "required": true,
  2617. "schema": {
  2618. "type": "string"
  2619. }
  2620. },
  2621. {
  2622. "name": "OCS-APIRequest",
  2623. "in": "header",
  2624. "description": "Required to be true for the API request to pass",
  2625. "required": true,
  2626. "schema": {
  2627. "type": "boolean",
  2628. "default": true
  2629. }
  2630. }
  2631. ],
  2632. "responses": {
  2633. "200": {
  2634. "description": "Share accepted successfully",
  2635. "content": {
  2636. "application/json": {
  2637. "schema": {
  2638. "type": "object",
  2639. "required": [
  2640. "ocs"
  2641. ],
  2642. "properties": {
  2643. "ocs": {
  2644. "type": "object",
  2645. "required": [
  2646. "meta",
  2647. "data"
  2648. ],
  2649. "properties": {
  2650. "meta": {
  2651. "$ref": "#/components/schemas/OCSMeta"
  2652. },
  2653. "data": {}
  2654. }
  2655. }
  2656. }
  2657. }
  2658. }
  2659. }
  2660. },
  2661. "404": {
  2662. "description": "Share not found",
  2663. "content": {
  2664. "application/json": {
  2665. "schema": {
  2666. "type": "object",
  2667. "required": [
  2668. "ocs"
  2669. ],
  2670. "properties": {
  2671. "ocs": {
  2672. "type": "object",
  2673. "required": [
  2674. "meta",
  2675. "data"
  2676. ],
  2677. "properties": {
  2678. "meta": {
  2679. "$ref": "#/components/schemas/OCSMeta"
  2680. },
  2681. "data": {}
  2682. }
  2683. }
  2684. }
  2685. }
  2686. }
  2687. }
  2688. },
  2689. "400": {
  2690. "description": "Share could not be accepted",
  2691. "content": {
  2692. "application/json": {
  2693. "schema": {
  2694. "type": "object",
  2695. "required": [
  2696. "ocs"
  2697. ],
  2698. "properties": {
  2699. "ocs": {
  2700. "type": "object",
  2701. "required": [
  2702. "meta",
  2703. "data"
  2704. ],
  2705. "properties": {
  2706. "meta": {
  2707. "$ref": "#/components/schemas/OCSMeta"
  2708. },
  2709. "data": {}
  2710. }
  2711. }
  2712. }
  2713. }
  2714. }
  2715. }
  2716. }
  2717. }
  2718. }
  2719. },
  2720. "/ocs/v2.php/apps/files_sharing/api/v1/deletedshares": {
  2721. "get": {
  2722. "operationId": "deleted_shareapi-index",
  2723. "summary": "Get a list of all deleted shares",
  2724. "tags": [
  2725. "deleted_shareapi"
  2726. ],
  2727. "security": [
  2728. {
  2729. "bearer_auth": []
  2730. },
  2731. {
  2732. "basic_auth": []
  2733. }
  2734. ],
  2735. "parameters": [
  2736. {
  2737. "name": "OCS-APIRequest",
  2738. "in": "header",
  2739. "description": "Required to be true for the API request to pass",
  2740. "required": true,
  2741. "schema": {
  2742. "type": "boolean",
  2743. "default": true
  2744. }
  2745. }
  2746. ],
  2747. "responses": {
  2748. "200": {
  2749. "description": "Deleted shares returned",
  2750. "content": {
  2751. "application/json": {
  2752. "schema": {
  2753. "type": "object",
  2754. "required": [
  2755. "ocs"
  2756. ],
  2757. "properties": {
  2758. "ocs": {
  2759. "type": "object",
  2760. "required": [
  2761. "meta",
  2762. "data"
  2763. ],
  2764. "properties": {
  2765. "meta": {
  2766. "$ref": "#/components/schemas/OCSMeta"
  2767. },
  2768. "data": {
  2769. "type": "array",
  2770. "items": {
  2771. "$ref": "#/components/schemas/DeletedShare"
  2772. }
  2773. }
  2774. }
  2775. }
  2776. }
  2777. }
  2778. }
  2779. }
  2780. }
  2781. }
  2782. }
  2783. },
  2784. "/ocs/v2.php/apps/files_sharing/api/v1/deletedshares/{id}": {
  2785. "post": {
  2786. "operationId": "deleted_shareapi-undelete",
  2787. "summary": "Undelete a deleted share",
  2788. "tags": [
  2789. "deleted_shareapi"
  2790. ],
  2791. "security": [
  2792. {
  2793. "bearer_auth": []
  2794. },
  2795. {
  2796. "basic_auth": []
  2797. }
  2798. ],
  2799. "parameters": [
  2800. {
  2801. "name": "id",
  2802. "in": "path",
  2803. "description": "ID of the share",
  2804. "required": true,
  2805. "schema": {
  2806. "type": "string"
  2807. }
  2808. },
  2809. {
  2810. "name": "OCS-APIRequest",
  2811. "in": "header",
  2812. "description": "Required to be true for the API request to pass",
  2813. "required": true,
  2814. "schema": {
  2815. "type": "boolean",
  2816. "default": true
  2817. }
  2818. }
  2819. ],
  2820. "responses": {
  2821. "200": {
  2822. "description": "Share undeleted successfully",
  2823. "content": {
  2824. "application/json": {
  2825. "schema": {
  2826. "type": "object",
  2827. "required": [
  2828. "ocs"
  2829. ],
  2830. "properties": {
  2831. "ocs": {
  2832. "type": "object",
  2833. "required": [
  2834. "meta",
  2835. "data"
  2836. ],
  2837. "properties": {
  2838. "meta": {
  2839. "$ref": "#/components/schemas/OCSMeta"
  2840. },
  2841. "data": {}
  2842. }
  2843. }
  2844. }
  2845. }
  2846. }
  2847. }
  2848. },
  2849. "404": {
  2850. "description": "Share not found",
  2851. "content": {
  2852. "application/json": {
  2853. "schema": {
  2854. "type": "object",
  2855. "required": [
  2856. "ocs"
  2857. ],
  2858. "properties": {
  2859. "ocs": {
  2860. "type": "object",
  2861. "required": [
  2862. "meta",
  2863. "data"
  2864. ],
  2865. "properties": {
  2866. "meta": {
  2867. "$ref": "#/components/schemas/OCSMeta"
  2868. },
  2869. "data": {}
  2870. }
  2871. }
  2872. }
  2873. }
  2874. }
  2875. }
  2876. }
  2877. }
  2878. }
  2879. },
  2880. "/ocs/v2.php/apps/files_sharing/api/v1/sharees": {
  2881. "get": {
  2882. "operationId": "shareesapi-search",
  2883. "summary": "Search for sharees",
  2884. "tags": [
  2885. "shareesapi"
  2886. ],
  2887. "security": [
  2888. {
  2889. "bearer_auth": []
  2890. },
  2891. {
  2892. "basic_auth": []
  2893. }
  2894. ],
  2895. "parameters": [
  2896. {
  2897. "name": "search",
  2898. "in": "query",
  2899. "description": "Text to search for",
  2900. "schema": {
  2901. "type": "string",
  2902. "default": ""
  2903. }
  2904. },
  2905. {
  2906. "name": "itemType",
  2907. "in": "query",
  2908. "description": "Limit to specific item types",
  2909. "schema": {
  2910. "type": "string",
  2911. "nullable": true
  2912. }
  2913. },
  2914. {
  2915. "name": "page",
  2916. "in": "query",
  2917. "description": "Page offset for searching",
  2918. "schema": {
  2919. "type": "integer",
  2920. "format": "int64",
  2921. "default": 1
  2922. }
  2923. },
  2924. {
  2925. "name": "perPage",
  2926. "in": "query",
  2927. "description": "Limit amount of search results per page",
  2928. "schema": {
  2929. "type": "integer",
  2930. "format": "int64",
  2931. "default": 200
  2932. }
  2933. },
  2934. {
  2935. "name": "shareType",
  2936. "in": "query",
  2937. "description": "Limit to specific share types",
  2938. "schema": {
  2939. "nullable": true,
  2940. "oneOf": [
  2941. {
  2942. "type": "integer",
  2943. "format": "int64"
  2944. },
  2945. {
  2946. "type": "array",
  2947. "items": {
  2948. "type": "integer",
  2949. "format": "int64"
  2950. }
  2951. }
  2952. ]
  2953. }
  2954. },
  2955. {
  2956. "name": "lookup",
  2957. "in": "query",
  2958. "description": "If a global lookup should be performed too",
  2959. "schema": {
  2960. "type": "integer",
  2961. "default": 0,
  2962. "enum": [
  2963. 0,
  2964. 1
  2965. ]
  2966. }
  2967. },
  2968. {
  2969. "name": "OCS-APIRequest",
  2970. "in": "header",
  2971. "description": "Required to be true for the API request to pass",
  2972. "required": true,
  2973. "schema": {
  2974. "type": "boolean",
  2975. "default": true
  2976. }
  2977. }
  2978. ],
  2979. "responses": {
  2980. "200": {
  2981. "description": "Sharees search result returned",
  2982. "headers": {
  2983. "Link": {
  2984. "schema": {
  2985. "type": "string"
  2986. }
  2987. }
  2988. },
  2989. "content": {
  2990. "application/json": {
  2991. "schema": {
  2992. "type": "object",
  2993. "required": [
  2994. "ocs"
  2995. ],
  2996. "properties": {
  2997. "ocs": {
  2998. "type": "object",
  2999. "required": [
  3000. "meta",
  3001. "data"
  3002. ],
  3003. "properties": {
  3004. "meta": {
  3005. "$ref": "#/components/schemas/OCSMeta"
  3006. },
  3007. "data": {
  3008. "$ref": "#/components/schemas/ShareesSearchResult"
  3009. }
  3010. }
  3011. }
  3012. }
  3013. }
  3014. }
  3015. }
  3016. },
  3017. "400": {
  3018. "description": "Invalid search parameters",
  3019. "content": {
  3020. "application/json": {
  3021. "schema": {
  3022. "type": "object",
  3023. "required": [
  3024. "ocs"
  3025. ],
  3026. "properties": {
  3027. "ocs": {
  3028. "type": "object",
  3029. "required": [
  3030. "meta",
  3031. "data"
  3032. ],
  3033. "properties": {
  3034. "meta": {
  3035. "$ref": "#/components/schemas/OCSMeta"
  3036. },
  3037. "data": {}
  3038. }
  3039. }
  3040. }
  3041. }
  3042. }
  3043. }
  3044. }
  3045. }
  3046. }
  3047. },
  3048. "/ocs/v2.php/apps/files_sharing/api/v1/sharees_recommended": {
  3049. "get": {
  3050. "operationId": "shareesapi-find-recommended",
  3051. "summary": "Find recommended sharees",
  3052. "tags": [
  3053. "shareesapi"
  3054. ],
  3055. "security": [
  3056. {
  3057. "bearer_auth": []
  3058. },
  3059. {
  3060. "basic_auth": []
  3061. }
  3062. ],
  3063. "parameters": [
  3064. {
  3065. "name": "itemType",
  3066. "in": "query",
  3067. "description": "Limit to specific item types",
  3068. "required": true,
  3069. "schema": {
  3070. "type": "string"
  3071. }
  3072. },
  3073. {
  3074. "name": "shareType",
  3075. "in": "query",
  3076. "description": "Limit to specific share types",
  3077. "schema": {
  3078. "nullable": true,
  3079. "oneOf": [
  3080. {
  3081. "type": "integer",
  3082. "format": "int64"
  3083. },
  3084. {
  3085. "type": "array",
  3086. "items": {
  3087. "type": "integer",
  3088. "format": "int64"
  3089. }
  3090. }
  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": "Recommended sharees returned",
  3108. "content": {
  3109. "application/json": {
  3110. "schema": {
  3111. "type": "object",
  3112. "required": [
  3113. "ocs"
  3114. ],
  3115. "properties": {
  3116. "ocs": {
  3117. "type": "object",
  3118. "required": [
  3119. "meta",
  3120. "data"
  3121. ],
  3122. "properties": {
  3123. "meta": {
  3124. "$ref": "#/components/schemas/OCSMeta"
  3125. },
  3126. "data": {
  3127. "$ref": "#/components/schemas/ShareesRecommendedResult"
  3128. }
  3129. }
  3130. }
  3131. }
  3132. }
  3133. }
  3134. }
  3135. }
  3136. }
  3137. }
  3138. },
  3139. "/ocs/v2.php/apps/files_sharing/api/v1/remote_shares": {
  3140. "get": {
  3141. "operationId": "remote-get-shares",
  3142. "summary": "Get a list of accepted remote shares",
  3143. "tags": [
  3144. "remote"
  3145. ],
  3146. "security": [
  3147. {
  3148. "bearer_auth": []
  3149. },
  3150. {
  3151. "basic_auth": []
  3152. }
  3153. ],
  3154. "parameters": [
  3155. {
  3156. "name": "OCS-APIRequest",
  3157. "in": "header",
  3158. "description": "Required to be true for the API request to pass",
  3159. "required": true,
  3160. "schema": {
  3161. "type": "boolean",
  3162. "default": true
  3163. }
  3164. }
  3165. ],
  3166. "responses": {
  3167. "200": {
  3168. "description": "Accepted remote shares returned",
  3169. "content": {
  3170. "application/json": {
  3171. "schema": {
  3172. "type": "object",
  3173. "required": [
  3174. "ocs"
  3175. ],
  3176. "properties": {
  3177. "ocs": {
  3178. "type": "object",
  3179. "required": [
  3180. "meta",
  3181. "data"
  3182. ],
  3183. "properties": {
  3184. "meta": {
  3185. "$ref": "#/components/schemas/OCSMeta"
  3186. },
  3187. "data": {
  3188. "type": "array",
  3189. "items": {
  3190. "$ref": "#/components/schemas/RemoteShare"
  3191. }
  3192. }
  3193. }
  3194. }
  3195. }
  3196. }
  3197. }
  3198. }
  3199. }
  3200. }
  3201. }
  3202. },
  3203. "/ocs/v2.php/apps/files_sharing/api/v1/remote_shares/pending": {
  3204. "get": {
  3205. "operationId": "remote-get-open-shares",
  3206. "summary": "Get list of pending remote shares",
  3207. "tags": [
  3208. "remote"
  3209. ],
  3210. "security": [
  3211. {
  3212. "bearer_auth": []
  3213. },
  3214. {
  3215. "basic_auth": []
  3216. }
  3217. ],
  3218. "parameters": [
  3219. {
  3220. "name": "OCS-APIRequest",
  3221. "in": "header",
  3222. "description": "Required to be true for the API request to pass",
  3223. "required": true,
  3224. "schema": {
  3225. "type": "boolean",
  3226. "default": true
  3227. }
  3228. }
  3229. ],
  3230. "responses": {
  3231. "200": {
  3232. "description": "Pending remote shares returned",
  3233. "content": {
  3234. "application/json": {
  3235. "schema": {
  3236. "type": "object",
  3237. "required": [
  3238. "ocs"
  3239. ],
  3240. "properties": {
  3241. "ocs": {
  3242. "type": "object",
  3243. "required": [
  3244. "meta",
  3245. "data"
  3246. ],
  3247. "properties": {
  3248. "meta": {
  3249. "$ref": "#/components/schemas/OCSMeta"
  3250. },
  3251. "data": {
  3252. "type": "array",
  3253. "items": {
  3254. "$ref": "#/components/schemas/RemoteShare"
  3255. }
  3256. }
  3257. }
  3258. }
  3259. }
  3260. }
  3261. }
  3262. }
  3263. }
  3264. }
  3265. }
  3266. },
  3267. "/ocs/v2.php/apps/files_sharing/api/v1/remote_shares/pending/{id}": {
  3268. "post": {
  3269. "operationId": "remote-accept-share",
  3270. "summary": "Accept a remote share",
  3271. "tags": [
  3272. "remote"
  3273. ],
  3274. "security": [
  3275. {
  3276. "bearer_auth": []
  3277. },
  3278. {
  3279. "basic_auth": []
  3280. }
  3281. ],
  3282. "parameters": [
  3283. {
  3284. "name": "id",
  3285. "in": "path",
  3286. "description": "ID of the share",
  3287. "required": true,
  3288. "schema": {
  3289. "type": "integer",
  3290. "format": "int64"
  3291. }
  3292. },
  3293. {
  3294. "name": "OCS-APIRequest",
  3295. "in": "header",
  3296. "description": "Required to be true for the API request to pass",
  3297. "required": true,
  3298. "schema": {
  3299. "type": "boolean",
  3300. "default": true
  3301. }
  3302. }
  3303. ],
  3304. "responses": {
  3305. "200": {
  3306. "description": "Share accepted successfully",
  3307. "content": {
  3308. "application/json": {
  3309. "schema": {
  3310. "type": "object",
  3311. "required": [
  3312. "ocs"
  3313. ],
  3314. "properties": {
  3315. "ocs": {
  3316. "type": "object",
  3317. "required": [
  3318. "meta",
  3319. "data"
  3320. ],
  3321. "properties": {
  3322. "meta": {
  3323. "$ref": "#/components/schemas/OCSMeta"
  3324. },
  3325. "data": {}
  3326. }
  3327. }
  3328. }
  3329. }
  3330. }
  3331. }
  3332. },
  3333. "404": {
  3334. "description": "Share not found",
  3335. "content": {
  3336. "application/json": {
  3337. "schema": {
  3338. "type": "object",
  3339. "required": [
  3340. "ocs"
  3341. ],
  3342. "properties": {
  3343. "ocs": {
  3344. "type": "object",
  3345. "required": [
  3346. "meta",
  3347. "data"
  3348. ],
  3349. "properties": {
  3350. "meta": {
  3351. "$ref": "#/components/schemas/OCSMeta"
  3352. },
  3353. "data": {}
  3354. }
  3355. }
  3356. }
  3357. }
  3358. }
  3359. }
  3360. }
  3361. }
  3362. },
  3363. "delete": {
  3364. "operationId": "remote-decline-share",
  3365. "summary": "Decline a remote share",
  3366. "tags": [
  3367. "remote"
  3368. ],
  3369. "security": [
  3370. {
  3371. "bearer_auth": []
  3372. },
  3373. {
  3374. "basic_auth": []
  3375. }
  3376. ],
  3377. "parameters": [
  3378. {
  3379. "name": "id",
  3380. "in": "path",
  3381. "description": "ID of the share",
  3382. "required": true,
  3383. "schema": {
  3384. "type": "integer",
  3385. "format": "int64"
  3386. }
  3387. },
  3388. {
  3389. "name": "OCS-APIRequest",
  3390. "in": "header",
  3391. "description": "Required to be true for the API request to pass",
  3392. "required": true,
  3393. "schema": {
  3394. "type": "boolean",
  3395. "default": true
  3396. }
  3397. }
  3398. ],
  3399. "responses": {
  3400. "200": {
  3401. "description": "Share declined successfully",
  3402. "content": {
  3403. "application/json": {
  3404. "schema": {
  3405. "type": "object",
  3406. "required": [
  3407. "ocs"
  3408. ],
  3409. "properties": {
  3410. "ocs": {
  3411. "type": "object",
  3412. "required": [
  3413. "meta",
  3414. "data"
  3415. ],
  3416. "properties": {
  3417. "meta": {
  3418. "$ref": "#/components/schemas/OCSMeta"
  3419. },
  3420. "data": {}
  3421. }
  3422. }
  3423. }
  3424. }
  3425. }
  3426. }
  3427. },
  3428. "404": {
  3429. "description": "Share not found",
  3430. "content": {
  3431. "application/json": {
  3432. "schema": {
  3433. "type": "object",
  3434. "required": [
  3435. "ocs"
  3436. ],
  3437. "properties": {
  3438. "ocs": {
  3439. "type": "object",
  3440. "required": [
  3441. "meta",
  3442. "data"
  3443. ],
  3444. "properties": {
  3445. "meta": {
  3446. "$ref": "#/components/schemas/OCSMeta"
  3447. },
  3448. "data": {}
  3449. }
  3450. }
  3451. }
  3452. }
  3453. }
  3454. }
  3455. }
  3456. }
  3457. }
  3458. },
  3459. "/ocs/v2.php/apps/files_sharing/api/v1/remote_shares/{id}": {
  3460. "get": {
  3461. "operationId": "remote-get-share",
  3462. "summary": "Get info of a remote share",
  3463. "tags": [
  3464. "remote"
  3465. ],
  3466. "security": [
  3467. {
  3468. "bearer_auth": []
  3469. },
  3470. {
  3471. "basic_auth": []
  3472. }
  3473. ],
  3474. "parameters": [
  3475. {
  3476. "name": "id",
  3477. "in": "path",
  3478. "description": "ID of the share",
  3479. "required": true,
  3480. "schema": {
  3481. "type": "integer",
  3482. "format": "int64"
  3483. }
  3484. },
  3485. {
  3486. "name": "OCS-APIRequest",
  3487. "in": "header",
  3488. "description": "Required to be true for the API request to pass",
  3489. "required": true,
  3490. "schema": {
  3491. "type": "boolean",
  3492. "default": true
  3493. }
  3494. }
  3495. ],
  3496. "responses": {
  3497. "200": {
  3498. "description": "Share returned",
  3499. "content": {
  3500. "application/json": {
  3501. "schema": {
  3502. "type": "object",
  3503. "required": [
  3504. "ocs"
  3505. ],
  3506. "properties": {
  3507. "ocs": {
  3508. "type": "object",
  3509. "required": [
  3510. "meta",
  3511. "data"
  3512. ],
  3513. "properties": {
  3514. "meta": {
  3515. "$ref": "#/components/schemas/OCSMeta"
  3516. },
  3517. "data": {
  3518. "$ref": "#/components/schemas/RemoteShare"
  3519. }
  3520. }
  3521. }
  3522. }
  3523. }
  3524. }
  3525. }
  3526. },
  3527. "404": {
  3528. "description": "Share not found",
  3529. "content": {
  3530. "application/json": {
  3531. "schema": {
  3532. "type": "object",
  3533. "required": [
  3534. "ocs"
  3535. ],
  3536. "properties": {
  3537. "ocs": {
  3538. "type": "object",
  3539. "required": [
  3540. "meta",
  3541. "data"
  3542. ],
  3543. "properties": {
  3544. "meta": {
  3545. "$ref": "#/components/schemas/OCSMeta"
  3546. },
  3547. "data": {}
  3548. }
  3549. }
  3550. }
  3551. }
  3552. }
  3553. }
  3554. }
  3555. }
  3556. },
  3557. "delete": {
  3558. "operationId": "remote-unshare",
  3559. "summary": "Unshare a remote share",
  3560. "tags": [
  3561. "remote"
  3562. ],
  3563. "security": [
  3564. {
  3565. "bearer_auth": []
  3566. },
  3567. {
  3568. "basic_auth": []
  3569. }
  3570. ],
  3571. "parameters": [
  3572. {
  3573. "name": "id",
  3574. "in": "path",
  3575. "description": "ID of the share",
  3576. "required": true,
  3577. "schema": {
  3578. "type": "integer",
  3579. "format": "int64"
  3580. }
  3581. },
  3582. {
  3583. "name": "OCS-APIRequest",
  3584. "in": "header",
  3585. "description": "Required to be true for the API request to pass",
  3586. "required": true,
  3587. "schema": {
  3588. "type": "boolean",
  3589. "default": true
  3590. }
  3591. }
  3592. ],
  3593. "responses": {
  3594. "200": {
  3595. "description": "Share unshared successfully",
  3596. "content": {
  3597. "application/json": {
  3598. "schema": {
  3599. "type": "object",
  3600. "required": [
  3601. "ocs"
  3602. ],
  3603. "properties": {
  3604. "ocs": {
  3605. "type": "object",
  3606. "required": [
  3607. "meta",
  3608. "data"
  3609. ],
  3610. "properties": {
  3611. "meta": {
  3612. "$ref": "#/components/schemas/OCSMeta"
  3613. },
  3614. "data": {}
  3615. }
  3616. }
  3617. }
  3618. }
  3619. }
  3620. }
  3621. },
  3622. "404": {
  3623. "description": "Share not found",
  3624. "content": {
  3625. "application/json": {
  3626. "schema": {
  3627. "type": "object",
  3628. "required": [
  3629. "ocs"
  3630. ],
  3631. "properties": {
  3632. "ocs": {
  3633. "type": "object",
  3634. "required": [
  3635. "meta",
  3636. "data"
  3637. ],
  3638. "properties": {
  3639. "meta": {
  3640. "$ref": "#/components/schemas/OCSMeta"
  3641. },
  3642. "data": {}
  3643. }
  3644. }
  3645. }
  3646. }
  3647. }
  3648. }
  3649. },
  3650. "403": {
  3651. "description": "Unsharing is not possible",
  3652. "content": {
  3653. "application/json": {
  3654. "schema": {
  3655. "type": "object",
  3656. "required": [
  3657. "ocs"
  3658. ],
  3659. "properties": {
  3660. "ocs": {
  3661. "type": "object",
  3662. "required": [
  3663. "meta",
  3664. "data"
  3665. ],
  3666. "properties": {
  3667. "meta": {
  3668. "$ref": "#/components/schemas/OCSMeta"
  3669. },
  3670. "data": {}
  3671. }
  3672. }
  3673. }
  3674. }
  3675. }
  3676. }
  3677. }
  3678. }
  3679. }
  3680. }
  3681. },
  3682. "tags": [
  3683. {
  3684. "name": "external_shares",
  3685. "description": "Class ExternalSharesController"
  3686. }
  3687. ]
  3688. }