You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

openapi.json 131KB

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