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 128KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312
  1. {
  2. "openapi": "3.0.3",
  3. "info": {
  4. "title": "files_sharing",
  5. "version": "0.0.1",
  6. "description": "File sharing",
  7. "license": {
  8. "name": "agpl"
  9. }
  10. },
  11. "components": {
  12. "securitySchemes": {
  13. "basic_auth": {
  14. "type": "http",
  15. "scheme": "basic"
  16. },
  17. "bearer_auth": {
  18. "type": "http",
  19. "scheme": "bearer"
  20. }
  21. },
  22. "schemas": {
  23. "Capabilities": {
  24. "type": "object",
  25. "required": [
  26. "files_sharing"
  27. ],
  28. "properties": {
  29. "files_sharing": {
  30. "type": "object",
  31. "required": [
  32. "api_enabled",
  33. "public",
  34. "user",
  35. "resharing",
  36. "federation",
  37. "sharee"
  38. ],
  39. "properties": {
  40. "api_enabled": {
  41. "type": "boolean"
  42. },
  43. "public": {
  44. "type": "object",
  45. "required": [
  46. "enabled"
  47. ],
  48. "properties": {
  49. "enabled": {
  50. "type": "boolean"
  51. },
  52. "password": {
  53. "type": "object",
  54. "required": [
  55. "enforced",
  56. "askForOptionalPassword"
  57. ],
  58. "properties": {
  59. "enforced": {
  60. "type": "boolean"
  61. },
  62. "askForOptionalPassword": {
  63. "type": "boolean"
  64. }
  65. }
  66. },
  67. "multiple_links": {
  68. "type": "boolean"
  69. },
  70. "expire_date": {
  71. "type": "object",
  72. "required": [
  73. "enabled"
  74. ],
  75. "properties": {
  76. "enabled": {
  77. "type": "boolean"
  78. },
  79. "days": {
  80. "type": "integer",
  81. "format": "int64"
  82. },
  83. "enforced": {
  84. "type": "boolean"
  85. }
  86. }
  87. },
  88. "expire_date_internal": {
  89. "type": "object",
  90. "required": [
  91. "enabled"
  92. ],
  93. "properties": {
  94. "enabled": {
  95. "type": "boolean"
  96. },
  97. "days": {
  98. "type": "integer",
  99. "format": "int64"
  100. },
  101. "enforced": {
  102. "type": "boolean"
  103. }
  104. }
  105. },
  106. "expire_date_remote": {
  107. "type": "object",
  108. "required": [
  109. "enabled"
  110. ],
  111. "properties": {
  112. "enabled": {
  113. "type": "boolean"
  114. },
  115. "days": {
  116. "type": "integer",
  117. "format": "int64"
  118. },
  119. "enforced": {
  120. "type": "boolean"
  121. }
  122. }
  123. },
  124. "send_mail": {
  125. "type": "boolean"
  126. },
  127. "upload": {
  128. "type": "boolean"
  129. },
  130. "upload_files_drop": {
  131. "type": "boolean"
  132. }
  133. }
  134. },
  135. "user": {
  136. "type": "object",
  137. "required": [
  138. "send_mail"
  139. ],
  140. "properties": {
  141. "send_mail": {
  142. "type": "boolean"
  143. },
  144. "expire_date": {
  145. "type": "object",
  146. "required": [
  147. "enabled"
  148. ],
  149. "properties": {
  150. "enabled": {
  151. "type": "boolean"
  152. }
  153. }
  154. }
  155. }
  156. },
  157. "resharing": {
  158. "type": "boolean"
  159. },
  160. "group_sharing": {
  161. "type": "boolean"
  162. },
  163. "group": {
  164. "type": "object",
  165. "required": [
  166. "enabled"
  167. ],
  168. "properties": {
  169. "enabled": {
  170. "type": "boolean"
  171. },
  172. "expire_date": {
  173. "type": "object",
  174. "required": [
  175. "enabled"
  176. ],
  177. "properties": {
  178. "enabled": {
  179. "type": "boolean"
  180. }
  181. }
  182. }
  183. }
  184. },
  185. "default_permissions": {
  186. "type": "integer",
  187. "format": "int64"
  188. },
  189. "federation": {
  190. "type": "object",
  191. "required": [
  192. "outgoing",
  193. "incoming",
  194. "expire_date",
  195. "expire_date_supported"
  196. ],
  197. "properties": {
  198. "outgoing": {
  199. "type": "boolean"
  200. },
  201. "incoming": {
  202. "type": "boolean"
  203. },
  204. "expire_date": {
  205. "type": "object",
  206. "required": [
  207. "enabled"
  208. ],
  209. "properties": {
  210. "enabled": {
  211. "type": "boolean"
  212. }
  213. }
  214. },
  215. "expire_date_supported": {
  216. "type": "object",
  217. "required": [
  218. "enabled"
  219. ],
  220. "properties": {
  221. "enabled": {
  222. "type": "boolean"
  223. }
  224. }
  225. }
  226. }
  227. },
  228. "sharee": {
  229. "type": "object",
  230. "required": [
  231. "query_lookup_default",
  232. "always_show_unique"
  233. ],
  234. "properties": {
  235. "query_lookup_default": {
  236. "type": "boolean"
  237. },
  238. "always_show_unique": {
  239. "type": "boolean"
  240. }
  241. }
  242. }
  243. }
  244. }
  245. }
  246. },
  247. "DeletedShare": {
  248. "type": "object",
  249. "required": [
  250. "id",
  251. "share_type",
  252. "uid_owner",
  253. "displayname_owner",
  254. "permissions",
  255. "stime",
  256. "uid_file_owner",
  257. "displayname_file_owner",
  258. "path",
  259. "item_type",
  260. "mimetype",
  261. "storage",
  262. "item_source",
  263. "file_source",
  264. "file_parent",
  265. "file_target",
  266. "expiration",
  267. "share_with",
  268. "share_with_displayname",
  269. "share_with_link"
  270. ],
  271. "properties": {
  272. "id": {
  273. "type": "string"
  274. },
  275. "share_type": {
  276. "type": "integer",
  277. "format": "int64"
  278. },
  279. "uid_owner": {
  280. "type": "string"
  281. },
  282. "displayname_owner": {
  283. "type": "string"
  284. },
  285. "permissions": {
  286. "type": "integer",
  287. "format": "int64"
  288. },
  289. "stime": {
  290. "type": "integer",
  291. "format": "int64"
  292. },
  293. "uid_file_owner": {
  294. "type": "string"
  295. },
  296. "displayname_file_owner": {
  297. "type": "string"
  298. },
  299. "path": {
  300. "type": "string"
  301. },
  302. "item_type": {
  303. "type": "string"
  304. },
  305. "mimetype": {
  306. "type": "string"
  307. },
  308. "storage": {
  309. "type": "integer",
  310. "format": "int64"
  311. },
  312. "item_source": {
  313. "type": "integer",
  314. "format": "int64"
  315. },
  316. "file_source": {
  317. "type": "integer",
  318. "format": "int64"
  319. },
  320. "file_parent": {
  321. "type": "integer",
  322. "format": "int64"
  323. },
  324. "file_target": {
  325. "type": "integer",
  326. "format": "int64"
  327. },
  328. "expiration": {
  329. "type": "string",
  330. "nullable": true
  331. },
  332. "share_with": {
  333. "type": "string",
  334. "nullable": true
  335. },
  336. "share_with_displayname": {
  337. "type": "string",
  338. "nullable": true
  339. },
  340. "share_with_link": {
  341. "type": "string",
  342. "nullable": true
  343. }
  344. }
  345. },
  346. "Lookup": {
  347. "type": "object",
  348. "required": [
  349. "value",
  350. "verified"
  351. ],
  352. "properties": {
  353. "value": {
  354. "type": "string"
  355. },
  356. "verified": {
  357. "type": "integer",
  358. "format": "int64"
  359. }
  360. }
  361. },
  362. "OCSMeta": {
  363. "type": "object",
  364. "required": [
  365. "status",
  366. "statuscode"
  367. ],
  368. "properties": {
  369. "status": {
  370. "type": "string"
  371. },
  372. "statuscode": {
  373. "type": "integer"
  374. },
  375. "message": {
  376. "type": "string"
  377. },
  378. "totalitems": {
  379. "type": "string"
  380. },
  381. "itemsperpage": {
  382. "type": "string"
  383. }
  384. }
  385. },
  386. "RemoteShare": {
  387. "type": "object",
  388. "required": [
  389. "accepted",
  390. "file_id",
  391. "id",
  392. "mimetype",
  393. "mountpoint",
  394. "mtime",
  395. "name",
  396. "owner",
  397. "parent",
  398. "permissions",
  399. "remote",
  400. "remote_id",
  401. "share_token",
  402. "share_type",
  403. "type",
  404. "user"
  405. ],
  406. "properties": {
  407. "accepted": {
  408. "type": "boolean"
  409. },
  410. "file_id": {
  411. "type": "integer",
  412. "format": "int64",
  413. "nullable": true
  414. },
  415. "id": {
  416. "type": "integer",
  417. "format": "int64"
  418. },
  419. "mimetype": {
  420. "type": "string",
  421. "nullable": true
  422. },
  423. "mountpoint": {
  424. "type": "string"
  425. },
  426. "mtime": {
  427. "type": "integer",
  428. "format": "int64",
  429. "nullable": true
  430. },
  431. "name": {
  432. "type": "string"
  433. },
  434. "owner": {
  435. "type": "string"
  436. },
  437. "parent": {
  438. "type": "integer",
  439. "format": "int64",
  440. "nullable": true
  441. },
  442. "permissions": {
  443. "type": "integer",
  444. "format": "int64",
  445. "nullable": true
  446. },
  447. "remote": {
  448. "type": "string"
  449. },
  450. "remote_id": {
  451. "type": "string"
  452. },
  453. "share_token": {
  454. "type": "string"
  455. },
  456. "share_type": {
  457. "type": "integer",
  458. "format": "int64"
  459. },
  460. "type": {
  461. "type": "string",
  462. "nullable": true
  463. },
  464. "user": {
  465. "type": "string"
  466. }
  467. }
  468. },
  469. "Share": {
  470. "type": "object",
  471. "required": [
  472. "attributes",
  473. "can_delete",
  474. "can_edit",
  475. "displayname_file_owner",
  476. "displayname_owner",
  477. "expiration",
  478. "file_parent",
  479. "file_source",
  480. "file_target",
  481. "has_preview",
  482. "hide_download",
  483. "id",
  484. "item_mtime",
  485. "item_size",
  486. "item_source",
  487. "item_type",
  488. "label",
  489. "mail_send",
  490. "mimetype",
  491. "note",
  492. "parent",
  493. "path",
  494. "permissions",
  495. "share_type",
  496. "stime",
  497. "storage",
  498. "storage_id",
  499. "token",
  500. "uid_file_owner",
  501. "uid_owner"
  502. ],
  503. "properties": {
  504. "attributes": {
  505. "type": "string",
  506. "nullable": true
  507. },
  508. "can_delete": {
  509. "type": "boolean"
  510. },
  511. "can_edit": {
  512. "type": "boolean"
  513. },
  514. "displayname_file_owner": {
  515. "type": "string"
  516. },
  517. "displayname_owner": {
  518. "type": "string"
  519. },
  520. "expiration": {
  521. "type": "string",
  522. "nullable": true
  523. },
  524. "file_parent": {
  525. "type": "integer",
  526. "format": "int64"
  527. },
  528. "file_source": {
  529. "type": "integer",
  530. "format": "int64"
  531. },
  532. "file_target": {
  533. "type": "string"
  534. },
  535. "has_preview": {
  536. "type": "boolean"
  537. },
  538. "hide_download": {
  539. "type": "integer",
  540. "format": "int64",
  541. "enum": [
  542. 0,
  543. 1
  544. ]
  545. },
  546. "id": {
  547. "type": "string"
  548. },
  549. "item_mtime": {
  550. "type": "integer",
  551. "format": "int64"
  552. },
  553. "item_permissions": {
  554. "type": "integer",
  555. "format": "int64"
  556. },
  557. "item_size": {
  558. "oneOf": [
  559. {
  560. "type": "number",
  561. "format": "float"
  562. },
  563. {
  564. "type": "integer",
  565. "format": "int64"
  566. }
  567. ]
  568. },
  569. "item_source": {
  570. "type": "integer",
  571. "format": "int64"
  572. },
  573. "item_type": {
  574. "type": "string",
  575. "enum": [
  576. "file",
  577. "folder"
  578. ]
  579. },
  580. "label": {
  581. "type": "string"
  582. },
  583. "mail_send": {
  584. "type": "integer",
  585. "format": "int64",
  586. "enum": [
  587. 0,
  588. 1
  589. ]
  590. },
  591. "mimetype": {
  592. "type": "string"
  593. },
  594. "note": {
  595. "type": "string"
  596. },
  597. "parent": {
  598. "nullable": true
  599. },
  600. "password": {
  601. "type": "string"
  602. },
  603. "password_expiration_time": {
  604. "type": "string",
  605. "nullable": true
  606. },
  607. "path": {
  608. "type": "string",
  609. "nullable": true
  610. },
  611. "permissions": {
  612. "type": "integer",
  613. "format": "int64"
  614. },
  615. "send_password_by_talk": {
  616. "type": "boolean"
  617. },
  618. "share_type": {
  619. "type": "integer",
  620. "format": "int64"
  621. },
  622. "share_with": {
  623. "type": "string"
  624. },
  625. "share_with_avatar": {
  626. "type": "string"
  627. },
  628. "share_with_displayname": {
  629. "type": "string"
  630. },
  631. "share_with_displayname_unique": {
  632. "type": "string",
  633. "nullable": true
  634. },
  635. "share_with_link": {
  636. "type": "string"
  637. },
  638. "status": {
  639. "type": "object",
  640. "properties": {
  641. "clearAt": {
  642. "type": "integer",
  643. "format": "int64",
  644. "nullable": true
  645. },
  646. "icon": {
  647. "type": "string",
  648. "nullable": true
  649. },
  650. "message": {
  651. "type": "string",
  652. "nullable": true
  653. },
  654. "status": {
  655. "type": "string"
  656. }
  657. }
  658. },
  659. "stime": {
  660. "type": "integer",
  661. "format": "int64"
  662. },
  663. "storage": {
  664. "type": "integer",
  665. "format": "int64"
  666. },
  667. "storage_id": {
  668. "type": "string"
  669. },
  670. "token": {
  671. "type": "string",
  672. "nullable": true
  673. },
  674. "uid_file_owner": {
  675. "type": "string"
  676. },
  677. "uid_owner": {
  678. "type": "string"
  679. },
  680. "url": {
  681. "type": "string"
  682. }
  683. }
  684. },
  685. "ShareInfo": {
  686. "type": "object",
  687. "required": [
  688. "id",
  689. "parentId",
  690. "mtime",
  691. "name",
  692. "permissions",
  693. "mimetype",
  694. "size",
  695. "type",
  696. "etag"
  697. ],
  698. "properties": {
  699. "id": {
  700. "type": "integer",
  701. "format": "int64"
  702. },
  703. "parentId": {
  704. "type": "integer",
  705. "format": "int64"
  706. },
  707. "mtime": {
  708. "type": "integer",
  709. "format": "int64"
  710. },
  711. "name": {
  712. "type": "string"
  713. },
  714. "permissions": {
  715. "type": "integer",
  716. "format": "int64"
  717. },
  718. "mimetype": {
  719. "type": "string"
  720. },
  721. "size": {
  722. "oneOf": [
  723. {
  724. "type": "integer",
  725. "format": "int64"
  726. },
  727. {
  728. "type": "number",
  729. "format": "float"
  730. }
  731. ]
  732. },
  733. "type": {
  734. "type": "string"
  735. },
  736. "etag": {
  737. "type": "string"
  738. },
  739. "children": {
  740. "type": "array",
  741. "items": {
  742. "type": "object",
  743. "additionalProperties": {
  744. "type": "object"
  745. }
  746. }
  747. }
  748. }
  749. },
  750. "Sharee": {
  751. "type": "object",
  752. "required": [
  753. "count",
  754. "label"
  755. ],
  756. "properties": {
  757. "count": {
  758. "type": "integer",
  759. "format": "int64",
  760. "nullable": true
  761. },
  762. "label": {
  763. "type": "string"
  764. }
  765. }
  766. },
  767. "ShareeCircle": {
  768. "allOf": [
  769. {
  770. "$ref": "#/components/schemas/Sharee"
  771. },
  772. {
  773. "type": "object",
  774. "required": [
  775. "shareWithDescription",
  776. "value"
  777. ],
  778. "properties": {
  779. "shareWithDescription": {
  780. "type": "string"
  781. },
  782. "value": {
  783. "allOf": [
  784. {
  785. "$ref": "#/components/schemas/ShareeValue"
  786. },
  787. {
  788. "type": "object",
  789. "required": [
  790. "circle"
  791. ],
  792. "properties": {
  793. "circle": {
  794. "type": "string"
  795. }
  796. }
  797. }
  798. ]
  799. }
  800. }
  801. }
  802. ]
  803. },
  804. "ShareeEmail": {
  805. "allOf": [
  806. {
  807. "$ref": "#/components/schemas/Sharee"
  808. },
  809. {
  810. "type": "object",
  811. "required": [
  812. "uuid",
  813. "name",
  814. "type",
  815. "shareWithDisplayNameUnique",
  816. "value"
  817. ],
  818. "properties": {
  819. "uuid": {
  820. "type": "string"
  821. },
  822. "name": {
  823. "type": "string"
  824. },
  825. "type": {
  826. "type": "string"
  827. },
  828. "shareWithDisplayNameUnique": {
  829. "type": "string"
  830. },
  831. "value": {
  832. "$ref": "#/components/schemas/ShareeValue"
  833. }
  834. }
  835. }
  836. ]
  837. },
  838. "ShareeLookup": {
  839. "allOf": [
  840. {
  841. "$ref": "#/components/schemas/Sharee"
  842. },
  843. {
  844. "type": "object",
  845. "required": [
  846. "extra",
  847. "value"
  848. ],
  849. "properties": {
  850. "extra": {
  851. "type": "object",
  852. "required": [
  853. "federationId",
  854. "name",
  855. "email",
  856. "address",
  857. "website",
  858. "twitter",
  859. "phone",
  860. "twitter_signature",
  861. "website_signature",
  862. "userid"
  863. ],
  864. "properties": {
  865. "federationId": {
  866. "type": "string"
  867. },
  868. "name": {
  869. "$ref": "#/components/schemas/Lookup",
  870. "nullable": true
  871. },
  872. "email": {
  873. "$ref": "#/components/schemas/Lookup",
  874. "nullable": true
  875. },
  876. "address": {
  877. "$ref": "#/components/schemas/Lookup",
  878. "nullable": true
  879. },
  880. "website": {
  881. "$ref": "#/components/schemas/Lookup",
  882. "nullable": true
  883. },
  884. "twitter": {
  885. "$ref": "#/components/schemas/Lookup",
  886. "nullable": true
  887. },
  888. "phone": {
  889. "$ref": "#/components/schemas/Lookup",
  890. "nullable": true
  891. },
  892. "twitter_signature": {
  893. "$ref": "#/components/schemas/Lookup",
  894. "nullable": true
  895. },
  896. "website_signature": {
  897. "$ref": "#/components/schemas/Lookup",
  898. "nullable": true
  899. },
  900. "userid": {
  901. "$ref": "#/components/schemas/Lookup",
  902. "nullable": true
  903. }
  904. }
  905. },
  906. "value": {
  907. "allOf": [
  908. {
  909. "$ref": "#/components/schemas/ShareeValue"
  910. },
  911. {
  912. "type": "object",
  913. "required": [
  914. "globalScale"
  915. ],
  916. "properties": {
  917. "globalScale": {
  918. "type": "boolean"
  919. }
  920. }
  921. }
  922. ]
  923. }
  924. }
  925. }
  926. ]
  927. },
  928. "ShareeRemote": {
  929. "allOf": [
  930. {
  931. "$ref": "#/components/schemas/Sharee"
  932. },
  933. {
  934. "type": "object",
  935. "required": [
  936. "uuid",
  937. "name",
  938. "type",
  939. "value"
  940. ],
  941. "properties": {
  942. "uuid": {
  943. "type": "string"
  944. },
  945. "name": {
  946. "type": "string"
  947. },
  948. "type": {
  949. "type": "string"
  950. },
  951. "value": {
  952. "allOf": [
  953. {
  954. "$ref": "#/components/schemas/ShareeValue"
  955. },
  956. {
  957. "type": "object",
  958. "required": [
  959. "server"
  960. ],
  961. "properties": {
  962. "server": {
  963. "type": "string"
  964. }
  965. }
  966. }
  967. ]
  968. }
  969. }
  970. }
  971. ]
  972. },
  973. "ShareeRemoteGroup": {
  974. "allOf": [
  975. {
  976. "$ref": "#/components/schemas/Sharee"
  977. },
  978. {
  979. "type": "object",
  980. "required": [
  981. "guid",
  982. "name",
  983. "value"
  984. ],
  985. "properties": {
  986. "guid": {
  987. "type": "string"
  988. },
  989. "name": {
  990. "type": "string"
  991. },
  992. "value": {
  993. "allOf": [
  994. {
  995. "$ref": "#/components/schemas/ShareeValue"
  996. },
  997. {
  998. "type": "object",
  999. "required": [
  1000. "server"
  1001. ],
  1002. "properties": {
  1003. "server": {
  1004. "type": "string"
  1005. }
  1006. }
  1007. }
  1008. ]
  1009. }
  1010. }
  1011. }
  1012. ]
  1013. },
  1014. "ShareeUser": {
  1015. "allOf": [
  1016. {
  1017. "$ref": "#/components/schemas/Sharee"
  1018. },
  1019. {
  1020. "type": "object",
  1021. "required": [
  1022. "subline",
  1023. "icon",
  1024. "shareWithDisplayNameUnique",
  1025. "status",
  1026. "value"
  1027. ],
  1028. "properties": {
  1029. "subline": {
  1030. "type": "string"
  1031. },
  1032. "icon": {
  1033. "type": "string"
  1034. },
  1035. "shareWithDisplayNameUnique": {
  1036. "type": "string"
  1037. },
  1038. "status": {
  1039. "type": "object",
  1040. "required": [
  1041. "status",
  1042. "message",
  1043. "icon",
  1044. "clearAt"
  1045. ],
  1046. "properties": {
  1047. "status": {
  1048. "type": "string"
  1049. },
  1050. "message": {
  1051. "type": "string"
  1052. },
  1053. "icon": {
  1054. "type": "string"
  1055. },
  1056. "clearAt": {
  1057. "type": "integer",
  1058. "format": "int64",
  1059. "nullable": true
  1060. }
  1061. }
  1062. },
  1063. "value": {
  1064. "$ref": "#/components/schemas/ShareeValue"
  1065. }
  1066. }
  1067. }
  1068. ]
  1069. },
  1070. "ShareeValue": {
  1071. "type": "object",
  1072. "required": [
  1073. "shareType",
  1074. "shareWith"
  1075. ],
  1076. "properties": {
  1077. "shareType": {
  1078. "type": "integer",
  1079. "format": "int64"
  1080. },
  1081. "shareWith": {
  1082. "type": "string"
  1083. }
  1084. }
  1085. },
  1086. "ShareesRecommendedResult": {
  1087. "type": "object",
  1088. "required": [
  1089. "exact",
  1090. "emails",
  1091. "groups",
  1092. "remote_groups",
  1093. "remotes",
  1094. "users"
  1095. ],
  1096. "properties": {
  1097. "exact": {
  1098. "type": "object",
  1099. "required": [
  1100. "emails",
  1101. "groups",
  1102. "remote_groups",
  1103. "remotes",
  1104. "users"
  1105. ],
  1106. "properties": {
  1107. "emails": {
  1108. "type": "array",
  1109. "items": {
  1110. "$ref": "#/components/schemas/ShareeEmail"
  1111. }
  1112. },
  1113. "groups": {
  1114. "type": "array",
  1115. "items": {
  1116. "$ref": "#/components/schemas/Sharee"
  1117. }
  1118. },
  1119. "remote_groups": {
  1120. "type": "array",
  1121. "items": {
  1122. "$ref": "#/components/schemas/ShareeRemoteGroup"
  1123. }
  1124. },
  1125. "remotes": {
  1126. "type": "array",
  1127. "items": {
  1128. "$ref": "#/components/schemas/ShareeRemote"
  1129. }
  1130. },
  1131. "users": {
  1132. "type": "array",
  1133. "items": {
  1134. "$ref": "#/components/schemas/ShareeUser"
  1135. }
  1136. }
  1137. }
  1138. },
  1139. "emails": {
  1140. "type": "array",
  1141. "items": {
  1142. "$ref": "#/components/schemas/ShareeEmail"
  1143. }
  1144. },
  1145. "groups": {
  1146. "type": "array",
  1147. "items": {
  1148. "$ref": "#/components/schemas/Sharee"
  1149. }
  1150. },
  1151. "remote_groups": {
  1152. "type": "array",
  1153. "items": {
  1154. "$ref": "#/components/schemas/ShareeRemoteGroup"
  1155. }
  1156. },
  1157. "remotes": {
  1158. "type": "array",
  1159. "items": {
  1160. "$ref": "#/components/schemas/ShareeRemote"
  1161. }
  1162. },
  1163. "users": {
  1164. "type": "array",
  1165. "items": {
  1166. "$ref": "#/components/schemas/ShareeUser"
  1167. }
  1168. }
  1169. }
  1170. },
  1171. "ShareesSearchResult": {
  1172. "type": "object",
  1173. "required": [
  1174. "exact",
  1175. "circles",
  1176. "emails",
  1177. "groups",
  1178. "lookup",
  1179. "remote_groups",
  1180. "remotes",
  1181. "rooms",
  1182. "users",
  1183. "lookupEnabled"
  1184. ],
  1185. "properties": {
  1186. "exact": {
  1187. "type": "object",
  1188. "required": [
  1189. "circles",
  1190. "emails",
  1191. "groups",
  1192. "remote_groups",
  1193. "remotes",
  1194. "rooms",
  1195. "users"
  1196. ],
  1197. "properties": {
  1198. "circles": {
  1199. "type": "array",
  1200. "items": {
  1201. "$ref": "#/components/schemas/ShareeCircle"
  1202. }
  1203. },
  1204. "emails": {
  1205. "type": "array",
  1206. "items": {
  1207. "$ref": "#/components/schemas/ShareeEmail"
  1208. }
  1209. },
  1210. "groups": {
  1211. "type": "array",
  1212. "items": {
  1213. "$ref": "#/components/schemas/Sharee"
  1214. }
  1215. },
  1216. "remote_groups": {
  1217. "type": "array",
  1218. "items": {
  1219. "$ref": "#/components/schemas/ShareeRemoteGroup"
  1220. }
  1221. },
  1222. "remotes": {
  1223. "type": "array",
  1224. "items": {
  1225. "$ref": "#/components/schemas/ShareeRemote"
  1226. }
  1227. },
  1228. "rooms": {
  1229. "type": "array",
  1230. "items": {
  1231. "$ref": "#/components/schemas/Sharee"
  1232. }
  1233. },
  1234. "users": {
  1235. "type": "array",
  1236. "items": {
  1237. "$ref": "#/components/schemas/ShareeUser"
  1238. }
  1239. }
  1240. }
  1241. },
  1242. "circles": {
  1243. "type": "array",
  1244. "items": {
  1245. "$ref": "#/components/schemas/ShareeCircle"
  1246. }
  1247. },
  1248. "emails": {
  1249. "type": "array",
  1250. "items": {
  1251. "$ref": "#/components/schemas/ShareeEmail"
  1252. }
  1253. },
  1254. "groups": {
  1255. "type": "array",
  1256. "items": {
  1257. "$ref": "#/components/schemas/Sharee"
  1258. }
  1259. },
  1260. "lookup": {
  1261. "type": "array",
  1262. "items": {
  1263. "$ref": "#/components/schemas/ShareeLookup"
  1264. }
  1265. },
  1266. "remote_groups": {
  1267. "type": "array",
  1268. "items": {
  1269. "$ref": "#/components/schemas/ShareeRemoteGroup"
  1270. }
  1271. },
  1272. "remotes": {
  1273. "type": "array",
  1274. "items": {
  1275. "$ref": "#/components/schemas/ShareeRemote"
  1276. }
  1277. },
  1278. "rooms": {
  1279. "type": "array",
  1280. "items": {
  1281. "$ref": "#/components/schemas/Sharee"
  1282. }
  1283. },
  1284. "users": {
  1285. "type": "array",
  1286. "items": {
  1287. "$ref": "#/components/schemas/ShareeUser"
  1288. }
  1289. },
  1290. "lookupEnabled": {
  1291. "type": "boolean"
  1292. }
  1293. }
  1294. }
  1295. }
  1296. },
  1297. "paths": {
  1298. "/index.php/s/{token}/preview": {
  1299. "get": {
  1300. "operationId": "public_preview-direct-link",
  1301. "summary": "Get a direct link preview for a shared file",
  1302. "tags": [
  1303. "public_preview"
  1304. ],
  1305. "security": [
  1306. {},
  1307. {
  1308. "bearer_auth": []
  1309. },
  1310. {
  1311. "basic_auth": []
  1312. }
  1313. ],
  1314. "parameters": [
  1315. {
  1316. "name": "token",
  1317. "in": "path",
  1318. "description": "Token of the share",
  1319. "required": true,
  1320. "schema": {
  1321. "type": "string"
  1322. }
  1323. }
  1324. ],
  1325. "responses": {
  1326. "200": {
  1327. "description": "Preview returned",
  1328. "content": {
  1329. "*/*": {
  1330. "schema": {
  1331. "type": "string",
  1332. "format": "binary"
  1333. }
  1334. }
  1335. }
  1336. },
  1337. "400": {
  1338. "description": "Getting preview is not possible",
  1339. "content": {
  1340. "application/json": {
  1341. "schema": {}
  1342. }
  1343. }
  1344. },
  1345. "403": {
  1346. "description": "Getting preview is not allowed",
  1347. "content": {
  1348. "application/json": {
  1349. "schema": {}
  1350. }
  1351. }
  1352. },
  1353. "404": {
  1354. "description": "Share or preview not found",
  1355. "content": {
  1356. "application/json": {
  1357. "schema": {}
  1358. }
  1359. }
  1360. }
  1361. }
  1362. }
  1363. },
  1364. "/index.php/apps/files_sharing/publicpreview/{token}": {
  1365. "get": {
  1366. "operationId": "public_preview-get-preview",
  1367. "summary": "Get a preview for a shared file",
  1368. "tags": [
  1369. "public_preview"
  1370. ],
  1371. "security": [
  1372. {},
  1373. {
  1374. "bearer_auth": []
  1375. },
  1376. {
  1377. "basic_auth": []
  1378. }
  1379. ],
  1380. "parameters": [
  1381. {
  1382. "name": "file",
  1383. "in": "query",
  1384. "description": "File in the share",
  1385. "schema": {
  1386. "type": "string",
  1387. "default": ""
  1388. }
  1389. },
  1390. {
  1391. "name": "x",
  1392. "in": "query",
  1393. "description": "Width of the preview",
  1394. "schema": {
  1395. "type": "integer",
  1396. "format": "int64",
  1397. "default": 32
  1398. }
  1399. },
  1400. {
  1401. "name": "y",
  1402. "in": "query",
  1403. "description": "Height of the preview",
  1404. "schema": {
  1405. "type": "integer",
  1406. "format": "int64",
  1407. "default": 32
  1408. }
  1409. },
  1410. {
  1411. "name": "a",
  1412. "in": "query",
  1413. "description": "Whether to not crop the preview",
  1414. "schema": {
  1415. "type": "integer",
  1416. "default": 0,
  1417. "enum": [
  1418. 0,
  1419. 1
  1420. ]
  1421. }
  1422. },
  1423. {
  1424. "name": "token",
  1425. "in": "path",
  1426. "description": "Token of the share",
  1427. "required": true,
  1428. "schema": {
  1429. "type": "string"
  1430. }
  1431. }
  1432. ],
  1433. "responses": {
  1434. "200": {
  1435. "description": "Preview returned",
  1436. "content": {
  1437. "*/*": {
  1438. "schema": {
  1439. "type": "string",
  1440. "format": "binary"
  1441. }
  1442. }
  1443. }
  1444. },
  1445. "400": {
  1446. "description": "Getting preview is not possible",
  1447. "content": {
  1448. "application/json": {
  1449. "schema": {}
  1450. }
  1451. }
  1452. },
  1453. "403": {
  1454. "description": "Getting preview is not allowed",
  1455. "content": {
  1456. "application/json": {
  1457. "schema": {}
  1458. }
  1459. }
  1460. },
  1461. "404": {
  1462. "description": "Share or preview not found",
  1463. "content": {
  1464. "application/json": {
  1465. "schema": {}
  1466. }
  1467. }
  1468. }
  1469. }
  1470. }
  1471. },
  1472. "/index.php/apps/files_sharing/shareinfo": {
  1473. "post": {
  1474. "operationId": "share_info-info",
  1475. "summary": "Get the info about a share",
  1476. "tags": [
  1477. "share_info"
  1478. ],
  1479. "security": [
  1480. {},
  1481. {
  1482. "bearer_auth": []
  1483. },
  1484. {
  1485. "basic_auth": []
  1486. }
  1487. ],
  1488. "parameters": [
  1489. {
  1490. "name": "t",
  1491. "in": "query",
  1492. "description": "Token of the share",
  1493. "required": true,
  1494. "schema": {
  1495. "type": "string"
  1496. }
  1497. },
  1498. {
  1499. "name": "password",
  1500. "in": "query",
  1501. "description": "Password of the share",
  1502. "schema": {
  1503. "type": "string",
  1504. "nullable": true
  1505. }
  1506. },
  1507. {
  1508. "name": "dir",
  1509. "in": "query",
  1510. "description": "Subdirectory to get info about",
  1511. "schema": {
  1512. "type": "string",
  1513. "nullable": true
  1514. }
  1515. },
  1516. {
  1517. "name": "depth",
  1518. "in": "query",
  1519. "description": "Maximum depth to get info about",
  1520. "schema": {
  1521. "type": "integer",
  1522. "format": "int64",
  1523. "default": -1
  1524. }
  1525. }
  1526. ],
  1527. "responses": {
  1528. "200": {
  1529. "description": "Share info returned",
  1530. "content": {
  1531. "application/json": {
  1532. "schema": {
  1533. "$ref": "#/components/schemas/ShareInfo"
  1534. }
  1535. }
  1536. }
  1537. },
  1538. "403": {
  1539. "description": "Getting share info is not allowed",
  1540. "content": {
  1541. "application/json": {
  1542. "schema": {}
  1543. }
  1544. }
  1545. },
  1546. "404": {
  1547. "description": "Share not found",
  1548. "content": {
  1549. "application/json": {
  1550. "schema": {}
  1551. }
  1552. }
  1553. }
  1554. }
  1555. }
  1556. },
  1557. "/ocs/v2.php/apps/files_sharing/api/v1/shares": {
  1558. "get": {
  1559. "operationId": "shareapi-get-shares",
  1560. "summary": "Get shares of the current user",
  1561. "tags": [
  1562. "shareapi"
  1563. ],
  1564. "security": [
  1565. {
  1566. "bearer_auth": []
  1567. },
  1568. {
  1569. "basic_auth": []
  1570. }
  1571. ],
  1572. "parameters": [
  1573. {
  1574. "name": "shared_with_me",
  1575. "in": "query",
  1576. "description": "Only get shares with the current user",
  1577. "schema": {
  1578. "type": "string",
  1579. "default": "false"
  1580. }
  1581. },
  1582. {
  1583. "name": "reshares",
  1584. "in": "query",
  1585. "description": "Only get shares by the current user and reshares",
  1586. "schema": {
  1587. "type": "string",
  1588. "default": "false"
  1589. }
  1590. },
  1591. {
  1592. "name": "subfiles",
  1593. "in": "query",
  1594. "description": "Only get all shares in a folder",
  1595. "schema": {
  1596. "type": "string",
  1597. "default": "false"
  1598. }
  1599. },
  1600. {
  1601. "name": "path",
  1602. "in": "query",
  1603. "description": "Get shares for a specific path",
  1604. "schema": {
  1605. "type": "string",
  1606. "default": ""
  1607. }
  1608. },
  1609. {
  1610. "name": "include_tags",
  1611. "in": "query",
  1612. "description": "Include tags in the share",
  1613. "schema": {
  1614. "type": "string",
  1615. "default": "false"
  1616. }
  1617. },
  1618. {
  1619. "name": "OCS-APIRequest",
  1620. "in": "header",
  1621. "description": "Required to be true for the API request to pass",
  1622. "required": true,
  1623. "schema": {
  1624. "type": "boolean",
  1625. "default": true
  1626. }
  1627. }
  1628. ],
  1629. "responses": {
  1630. "200": {
  1631. "description": "Shares returned",
  1632. "content": {
  1633. "application/json": {
  1634. "schema": {
  1635. "type": "object",
  1636. "required": [
  1637. "ocs"
  1638. ],
  1639. "properties": {
  1640. "ocs": {
  1641. "type": "object",
  1642. "required": [
  1643. "meta",
  1644. "data"
  1645. ],
  1646. "properties": {
  1647. "meta": {
  1648. "$ref": "#/components/schemas/OCSMeta"
  1649. },
  1650. "data": {
  1651. "type": "array",
  1652. "items": {
  1653. "$ref": "#/components/schemas/Share"
  1654. }
  1655. }
  1656. }
  1657. }
  1658. }
  1659. }
  1660. }
  1661. }
  1662. },
  1663. "404": {
  1664. "description": "The folder was not found or is inaccessible",
  1665. "content": {
  1666. "text/plain": {
  1667. "schema": {
  1668. "type": "string"
  1669. }
  1670. }
  1671. }
  1672. }
  1673. }
  1674. },
  1675. "post": {
  1676. "operationId": "shareapi-create-share",
  1677. "summary": "Create a share",
  1678. "tags": [
  1679. "shareapi"
  1680. ],
  1681. "security": [
  1682. {
  1683. "bearer_auth": []
  1684. },
  1685. {
  1686. "basic_auth": []
  1687. }
  1688. ],
  1689. "parameters": [
  1690. {
  1691. "name": "path",
  1692. "in": "query",
  1693. "description": "Path of the share",
  1694. "schema": {
  1695. "type": "string",
  1696. "nullable": true
  1697. }
  1698. },
  1699. {
  1700. "name": "permissions",
  1701. "in": "query",
  1702. "description": "Permissions for the share",
  1703. "schema": {
  1704. "type": "integer",
  1705. "format": "int64",
  1706. "nullable": true
  1707. }
  1708. },
  1709. {
  1710. "name": "shareType",
  1711. "in": "query",
  1712. "description": "Type of the share",
  1713. "schema": {
  1714. "type": "integer",
  1715. "format": "int64",
  1716. "default": -1
  1717. }
  1718. },
  1719. {
  1720. "name": "shareWith",
  1721. "in": "query",
  1722. "description": "The entity this should be shared with",
  1723. "schema": {
  1724. "type": "string",
  1725. "nullable": true
  1726. }
  1727. },
  1728. {
  1729. "name": "publicUpload",
  1730. "in": "query",
  1731. "description": "If public uploading is allowed",
  1732. "schema": {
  1733. "type": "string",
  1734. "default": "false"
  1735. }
  1736. },
  1737. {
  1738. "name": "password",
  1739. "in": "query",
  1740. "description": "Password for the share",
  1741. "schema": {
  1742. "type": "string",
  1743. "default": ""
  1744. }
  1745. },
  1746. {
  1747. "name": "sendPasswordByTalk",
  1748. "in": "query",
  1749. "description": "Send the password for the share over Talk",
  1750. "schema": {
  1751. "type": "string",
  1752. "nullable": true
  1753. }
  1754. },
  1755. {
  1756. "name": "expireDate",
  1757. "in": "query",
  1758. "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.",
  1759. "schema": {
  1760. "type": "string",
  1761. "nullable": true
  1762. }
  1763. },
  1764. {
  1765. "name": "note",
  1766. "in": "query",
  1767. "description": "Note for the share",
  1768. "schema": {
  1769. "type": "string",
  1770. "default": ""
  1771. }
  1772. },
  1773. {
  1774. "name": "label",
  1775. "in": "query",
  1776. "description": "Label for the share (only used in link and email)",
  1777. "schema": {
  1778. "type": "string",
  1779. "default": ""
  1780. }
  1781. },
  1782. {
  1783. "name": "attributes",
  1784. "in": "query",
  1785. "description": "Additional attributes for the share",
  1786. "schema": {
  1787. "type": "string",
  1788. "nullable": true
  1789. }
  1790. },
  1791. {
  1792. "name": "OCS-APIRequest",
  1793. "in": "header",
  1794. "description": "Required to be true for the API request to pass",
  1795. "required": true,
  1796. "schema": {
  1797. "type": "boolean",
  1798. "default": true
  1799. }
  1800. }
  1801. ],
  1802. "responses": {
  1803. "200": {
  1804. "description": "Share created",
  1805. "content": {
  1806. "application/json": {
  1807. "schema": {
  1808. "type": "object",
  1809. "required": [
  1810. "ocs"
  1811. ],
  1812. "properties": {
  1813. "ocs": {
  1814. "type": "object",
  1815. "required": [
  1816. "meta",
  1817. "data"
  1818. ],
  1819. "properties": {
  1820. "meta": {
  1821. "$ref": "#/components/schemas/OCSMeta"
  1822. },
  1823. "data": {
  1824. "$ref": "#/components/schemas/Share"
  1825. }
  1826. }
  1827. }
  1828. }
  1829. }
  1830. }
  1831. }
  1832. },
  1833. "400": {
  1834. "description": "Unknown share type",
  1835. "content": {
  1836. "text/plain": {
  1837. "schema": {
  1838. "type": "string"
  1839. }
  1840. }
  1841. }
  1842. },
  1843. "403": {
  1844. "description": "Creating the share is not allowed",
  1845. "content": {
  1846. "text/plain": {
  1847. "schema": {
  1848. "type": "string"
  1849. }
  1850. }
  1851. }
  1852. },
  1853. "404": {
  1854. "description": "Creating the share failed",
  1855. "content": {
  1856. "text/plain": {
  1857. "schema": {
  1858. "type": "string"
  1859. }
  1860. }
  1861. }
  1862. }
  1863. }
  1864. }
  1865. },
  1866. "/ocs/v2.php/apps/files_sharing/api/v1/shares/inherited": {
  1867. "get": {
  1868. "operationId": "shareapi-get-inherited-shares",
  1869. "summary": "Get all shares relative to a file, including parent folders shares rights",
  1870. "tags": [
  1871. "shareapi"
  1872. ],
  1873. "security": [
  1874. {
  1875. "bearer_auth": []
  1876. },
  1877. {
  1878. "basic_auth": []
  1879. }
  1880. ],
  1881. "parameters": [
  1882. {
  1883. "name": "path",
  1884. "in": "query",
  1885. "description": "Path all shares will be relative to",
  1886. "required": true,
  1887. "schema": {
  1888. "type": "string"
  1889. }
  1890. },
  1891. {
  1892. "name": "OCS-APIRequest",
  1893. "in": "header",
  1894. "description": "Required to be true for the API request to pass",
  1895. "required": true,
  1896. "schema": {
  1897. "type": "boolean",
  1898. "default": true
  1899. }
  1900. }
  1901. ],
  1902. "responses": {
  1903. "200": {
  1904. "description": "Shares returned",
  1905. "content": {
  1906. "application/json": {
  1907. "schema": {
  1908. "type": "object",
  1909. "required": [
  1910. "ocs"
  1911. ],
  1912. "properties": {
  1913. "ocs": {
  1914. "type": "object",
  1915. "required": [
  1916. "meta",
  1917. "data"
  1918. ],
  1919. "properties": {
  1920. "meta": {
  1921. "$ref": "#/components/schemas/OCSMeta"
  1922. },
  1923. "data": {
  1924. "type": "array",
  1925. "items": {
  1926. "$ref": "#/components/schemas/Share"
  1927. }
  1928. }
  1929. }
  1930. }
  1931. }
  1932. }
  1933. }
  1934. }
  1935. },
  1936. "500": {
  1937. "description": "",
  1938. "content": {
  1939. "text/plain": {
  1940. "schema": {
  1941. "type": "string"
  1942. }
  1943. }
  1944. }
  1945. },
  1946. "404": {
  1947. "description": "The given path is invalid",
  1948. "content": {
  1949. "text/plain": {
  1950. "schema": {
  1951. "type": "string"
  1952. }
  1953. }
  1954. }
  1955. }
  1956. }
  1957. }
  1958. },
  1959. "/ocs/v2.php/apps/files_sharing/api/v1/shares/pending": {
  1960. "get": {
  1961. "operationId": "shareapi-pending-shares",
  1962. "summary": "Get all shares that are still pending",
  1963. "tags": [
  1964. "shareapi"
  1965. ],
  1966. "security": [
  1967. {
  1968. "bearer_auth": []
  1969. },
  1970. {
  1971. "basic_auth": []
  1972. }
  1973. ],
  1974. "parameters": [
  1975. {
  1976. "name": "OCS-APIRequest",
  1977. "in": "header",
  1978. "description": "Required to be true for the API request to pass",
  1979. "required": true,
  1980. "schema": {
  1981. "type": "boolean",
  1982. "default": true
  1983. }
  1984. }
  1985. ],
  1986. "responses": {
  1987. "200": {
  1988. "description": "Pending shares returned",
  1989. "content": {
  1990. "application/json": {
  1991. "schema": {
  1992. "type": "object",
  1993. "required": [
  1994. "ocs"
  1995. ],
  1996. "properties": {
  1997. "ocs": {
  1998. "type": "object",
  1999. "required": [
  2000. "meta",
  2001. "data"
  2002. ],
  2003. "properties": {
  2004. "meta": {
  2005. "$ref": "#/components/schemas/OCSMeta"
  2006. },
  2007. "data": {
  2008. "type": "array",
  2009. "items": {
  2010. "$ref": "#/components/schemas/Share"
  2011. }
  2012. }
  2013. }
  2014. }
  2015. }
  2016. }
  2017. }
  2018. }
  2019. }
  2020. }
  2021. }
  2022. },
  2023. "/ocs/v2.php/apps/files_sharing/api/v1/shares/{id}": {
  2024. "get": {
  2025. "operationId": "shareapi-get-share",
  2026. "summary": "Get a specific share by id",
  2027. "tags": [
  2028. "shareapi"
  2029. ],
  2030. "security": [
  2031. {
  2032. "bearer_auth": []
  2033. },
  2034. {
  2035. "basic_auth": []
  2036. }
  2037. ],
  2038. "parameters": [
  2039. {
  2040. "name": "include_tags",
  2041. "in": "query",
  2042. "description": "Include tags in the share",
  2043. "schema": {
  2044. "type": "integer",
  2045. "default": 0,
  2046. "enum": [
  2047. 0,
  2048. 1
  2049. ]
  2050. }
  2051. },
  2052. {
  2053. "name": "id",
  2054. "in": "path",
  2055. "description": "ID of the share",
  2056. "required": true,
  2057. "schema": {
  2058. "type": "string"
  2059. }
  2060. },
  2061. {
  2062. "name": "OCS-APIRequest",
  2063. "in": "header",
  2064. "description": "Required to be true for the API request to pass",
  2065. "required": true,
  2066. "schema": {
  2067. "type": "boolean",
  2068. "default": true
  2069. }
  2070. }
  2071. ],
  2072. "responses": {
  2073. "200": {
  2074. "description": "Share returned",
  2075. "content": {
  2076. "application/json": {
  2077. "schema": {
  2078. "type": "object",
  2079. "required": [
  2080. "ocs"
  2081. ],
  2082. "properties": {
  2083. "ocs": {
  2084. "type": "object",
  2085. "required": [
  2086. "meta",
  2087. "data"
  2088. ],
  2089. "properties": {
  2090. "meta": {
  2091. "$ref": "#/components/schemas/OCSMeta"
  2092. },
  2093. "data": {
  2094. "$ref": "#/components/schemas/Share"
  2095. }
  2096. }
  2097. }
  2098. }
  2099. }
  2100. }
  2101. }
  2102. },
  2103. "404": {
  2104. "description": "Share not found",
  2105. "content": {
  2106. "text/plain": {
  2107. "schema": {
  2108. "type": "string"
  2109. }
  2110. }
  2111. }
  2112. }
  2113. }
  2114. },
  2115. "put": {
  2116. "operationId": "shareapi-update-share",
  2117. "summary": "Update a share",
  2118. "tags": [
  2119. "shareapi"
  2120. ],
  2121. "security": [
  2122. {
  2123. "bearer_auth": []
  2124. },
  2125. {
  2126. "basic_auth": []
  2127. }
  2128. ],
  2129. "parameters": [
  2130. {
  2131. "name": "permissions",
  2132. "in": "query",
  2133. "description": "New permissions",
  2134. "schema": {
  2135. "type": "integer",
  2136. "format": "int64",
  2137. "nullable": true
  2138. }
  2139. },
  2140. {
  2141. "name": "password",
  2142. "in": "query",
  2143. "description": "New password",
  2144. "schema": {
  2145. "type": "string",
  2146. "nullable": true
  2147. }
  2148. },
  2149. {
  2150. "name": "sendPasswordByTalk",
  2151. "in": "query",
  2152. "description": "New condition if the password should be send over Talk",
  2153. "schema": {
  2154. "type": "string",
  2155. "nullable": true
  2156. }
  2157. },
  2158. {
  2159. "name": "publicUpload",
  2160. "in": "query",
  2161. "description": "New condition if public uploading is allowed",
  2162. "schema": {
  2163. "type": "string",
  2164. "nullable": true
  2165. }
  2166. },
  2167. {
  2168. "name": "expireDate",
  2169. "in": "query",
  2170. "description": "New expiry date",
  2171. "schema": {
  2172. "type": "string",
  2173. "nullable": true
  2174. }
  2175. },
  2176. {
  2177. "name": "note",
  2178. "in": "query",
  2179. "description": "New note",
  2180. "schema": {
  2181. "type": "string",
  2182. "nullable": true
  2183. }
  2184. },
  2185. {
  2186. "name": "label",
  2187. "in": "query",
  2188. "description": "New label",
  2189. "schema": {
  2190. "type": "string",
  2191. "nullable": true
  2192. }
  2193. },
  2194. {
  2195. "name": "hideDownload",
  2196. "in": "query",
  2197. "description": "New condition if the download should be hidden",
  2198. "schema": {
  2199. "type": "string",
  2200. "nullable": true
  2201. }
  2202. },
  2203. {
  2204. "name": "attributes",
  2205. "in": "query",
  2206. "description": "New additional attributes",
  2207. "schema": {
  2208. "type": "string",
  2209. "nullable": true
  2210. }
  2211. },
  2212. {
  2213. "name": "id",
  2214. "in": "path",
  2215. "description": "ID of the share",
  2216. "required": true,
  2217. "schema": {
  2218. "type": "string"
  2219. }
  2220. },
  2221. {
  2222. "name": "OCS-APIRequest",
  2223. "in": "header",
  2224. "description": "Required to be true for the API request to pass",
  2225. "required": true,
  2226. "schema": {
  2227. "type": "boolean",
  2228. "default": true
  2229. }
  2230. }
  2231. ],
  2232. "responses": {
  2233. "200": {
  2234. "description": "Share updated successfully",
  2235. "content": {
  2236. "application/json": {
  2237. "schema": {
  2238. "type": "object",
  2239. "required": [
  2240. "ocs"
  2241. ],
  2242. "properties": {
  2243. "ocs": {
  2244. "type": "object",
  2245. "required": [
  2246. "meta",
  2247. "data"
  2248. ],
  2249. "properties": {
  2250. "meta": {
  2251. "$ref": "#/components/schemas/OCSMeta"
  2252. },
  2253. "data": {
  2254. "$ref": "#/components/schemas/Share"
  2255. }
  2256. }
  2257. }
  2258. }
  2259. }
  2260. }
  2261. }
  2262. },
  2263. "400": {
  2264. "description": "Share could not be updated because the requested changes are invalid",
  2265. "content": {
  2266. "text/plain": {
  2267. "schema": {
  2268. "type": "string"
  2269. }
  2270. }
  2271. }
  2272. },
  2273. "403": {
  2274. "description": "Missing permissions to update the share",
  2275. "content": {
  2276. "text/plain": {
  2277. "schema": {
  2278. "type": "string"
  2279. }
  2280. }
  2281. }
  2282. },
  2283. "404": {
  2284. "description": "Share not found",
  2285. "content": {
  2286. "text/plain": {
  2287. "schema": {
  2288. "type": "string"
  2289. }
  2290. }
  2291. }
  2292. }
  2293. }
  2294. },
  2295. "delete": {
  2296. "operationId": "shareapi-delete-share",
  2297. "summary": "Delete a share",
  2298. "tags": [
  2299. "shareapi"
  2300. ],
  2301. "security": [
  2302. {
  2303. "bearer_auth": []
  2304. },
  2305. {
  2306. "basic_auth": []
  2307. }
  2308. ],
  2309. "parameters": [
  2310. {
  2311. "name": "id",
  2312. "in": "path",
  2313. "description": "ID of the share",
  2314. "required": true,
  2315. "schema": {
  2316. "type": "string"
  2317. }
  2318. },
  2319. {
  2320. "name": "OCS-APIRequest",
  2321. "in": "header",
  2322. "description": "Required to be true for the API request to pass",
  2323. "required": true,
  2324. "schema": {
  2325. "type": "boolean",
  2326. "default": true
  2327. }
  2328. }
  2329. ],
  2330. "responses": {
  2331. "200": {
  2332. "description": "Share deleted successfully",
  2333. "content": {
  2334. "application/json": {
  2335. "schema": {
  2336. "type": "object",
  2337. "required": [
  2338. "ocs"
  2339. ],
  2340. "properties": {
  2341. "ocs": {
  2342. "type": "object",
  2343. "required": [
  2344. "meta",
  2345. "data"
  2346. ],
  2347. "properties": {
  2348. "meta": {
  2349. "$ref": "#/components/schemas/OCSMeta"
  2350. },
  2351. "data": {}
  2352. }
  2353. }
  2354. }
  2355. }
  2356. }
  2357. }
  2358. },
  2359. "404": {
  2360. "description": "Share not found",
  2361. "content": {
  2362. "text/plain": {
  2363. "schema": {
  2364. "type": "string"
  2365. }
  2366. }
  2367. }
  2368. },
  2369. "403": {
  2370. "description": "Missing permissions to delete the share",
  2371. "content": {
  2372. "text/plain": {
  2373. "schema": {
  2374. "type": "string"
  2375. }
  2376. }
  2377. }
  2378. }
  2379. }
  2380. }
  2381. },
  2382. "/ocs/v2.php/apps/files_sharing/api/v1/shares/pending/{id}": {
  2383. "post": {
  2384. "operationId": "shareapi-accept-share",
  2385. "summary": "Accept a share",
  2386. "tags": [
  2387. "shareapi"
  2388. ],
  2389. "security": [
  2390. {
  2391. "bearer_auth": []
  2392. },
  2393. {
  2394. "basic_auth": []
  2395. }
  2396. ],
  2397. "parameters": [
  2398. {
  2399. "name": "id",
  2400. "in": "path",
  2401. "description": "ID of the share",
  2402. "required": true,
  2403. "schema": {
  2404. "type": "string"
  2405. }
  2406. },
  2407. {
  2408. "name": "OCS-APIRequest",
  2409. "in": "header",
  2410. "description": "Required to be true for the API request to pass",
  2411. "required": true,
  2412. "schema": {
  2413. "type": "boolean",
  2414. "default": true
  2415. }
  2416. }
  2417. ],
  2418. "responses": {
  2419. "200": {
  2420. "description": "Share accepted successfully",
  2421. "content": {
  2422. "application/json": {
  2423. "schema": {
  2424. "type": "object",
  2425. "required": [
  2426. "ocs"
  2427. ],
  2428. "properties": {
  2429. "ocs": {
  2430. "type": "object",
  2431. "required": [
  2432. "meta",
  2433. "data"
  2434. ],
  2435. "properties": {
  2436. "meta": {
  2437. "$ref": "#/components/schemas/OCSMeta"
  2438. },
  2439. "data": {}
  2440. }
  2441. }
  2442. }
  2443. }
  2444. }
  2445. }
  2446. },
  2447. "404": {
  2448. "description": "Share not found",
  2449. "content": {
  2450. "text/plain": {
  2451. "schema": {
  2452. "type": "string"
  2453. }
  2454. }
  2455. }
  2456. },
  2457. "400": {
  2458. "description": "Share could not be accepted",
  2459. "content": {
  2460. "text/plain": {
  2461. "schema": {
  2462. "type": "string"
  2463. }
  2464. }
  2465. }
  2466. }
  2467. }
  2468. }
  2469. },
  2470. "/ocs/v2.php/apps/files_sharing/api/v1/deletedshares": {
  2471. "get": {
  2472. "operationId": "deleted_shareapi-index",
  2473. "summary": "Get a list of all deleted shares",
  2474. "tags": [
  2475. "deleted_shareapi"
  2476. ],
  2477. "security": [
  2478. {
  2479. "bearer_auth": []
  2480. },
  2481. {
  2482. "basic_auth": []
  2483. }
  2484. ],
  2485. "parameters": [
  2486. {
  2487. "name": "OCS-APIRequest",
  2488. "in": "header",
  2489. "description": "Required to be true for the API request to pass",
  2490. "required": true,
  2491. "schema": {
  2492. "type": "boolean",
  2493. "default": true
  2494. }
  2495. }
  2496. ],
  2497. "responses": {
  2498. "200": {
  2499. "description": "Deleted shares returned",
  2500. "content": {
  2501. "application/json": {
  2502. "schema": {
  2503. "type": "object",
  2504. "required": [
  2505. "ocs"
  2506. ],
  2507. "properties": {
  2508. "ocs": {
  2509. "type": "object",
  2510. "required": [
  2511. "meta",
  2512. "data"
  2513. ],
  2514. "properties": {
  2515. "meta": {
  2516. "$ref": "#/components/schemas/OCSMeta"
  2517. },
  2518. "data": {
  2519. "type": "array",
  2520. "items": {
  2521. "$ref": "#/components/schemas/DeletedShare"
  2522. }
  2523. }
  2524. }
  2525. }
  2526. }
  2527. }
  2528. }
  2529. }
  2530. }
  2531. }
  2532. }
  2533. },
  2534. "/ocs/v2.php/apps/files_sharing/api/v1/deletedshares/{id}": {
  2535. "post": {
  2536. "operationId": "deleted_shareapi-undelete",
  2537. "summary": "Undelete a deleted share",
  2538. "tags": [
  2539. "deleted_shareapi"
  2540. ],
  2541. "security": [
  2542. {
  2543. "bearer_auth": []
  2544. },
  2545. {
  2546. "basic_auth": []
  2547. }
  2548. ],
  2549. "parameters": [
  2550. {
  2551. "name": "id",
  2552. "in": "path",
  2553. "description": "ID of the share",
  2554. "required": true,
  2555. "schema": {
  2556. "type": "string"
  2557. }
  2558. },
  2559. {
  2560. "name": "OCS-APIRequest",
  2561. "in": "header",
  2562. "description": "Required to be true for the API request to pass",
  2563. "required": true,
  2564. "schema": {
  2565. "type": "boolean",
  2566. "default": true
  2567. }
  2568. }
  2569. ],
  2570. "responses": {
  2571. "200": {
  2572. "description": "Share undeleted successfully",
  2573. "content": {
  2574. "application/json": {
  2575. "schema": {
  2576. "type": "object",
  2577. "required": [
  2578. "ocs"
  2579. ],
  2580. "properties": {
  2581. "ocs": {
  2582. "type": "object",
  2583. "required": [
  2584. "meta",
  2585. "data"
  2586. ],
  2587. "properties": {
  2588. "meta": {
  2589. "$ref": "#/components/schemas/OCSMeta"
  2590. },
  2591. "data": {}
  2592. }
  2593. }
  2594. }
  2595. }
  2596. }
  2597. }
  2598. },
  2599. "404": {
  2600. "description": "Share not found",
  2601. "content": {
  2602. "text/plain": {
  2603. "schema": {
  2604. "type": "string"
  2605. }
  2606. }
  2607. }
  2608. }
  2609. }
  2610. }
  2611. },
  2612. "/ocs/v2.php/apps/files_sharing/api/v1/sharees": {
  2613. "get": {
  2614. "operationId": "shareesapi-search",
  2615. "summary": "Search for sharees",
  2616. "tags": [
  2617. "shareesapi"
  2618. ],
  2619. "security": [
  2620. {
  2621. "bearer_auth": []
  2622. },
  2623. {
  2624. "basic_auth": []
  2625. }
  2626. ],
  2627. "parameters": [
  2628. {
  2629. "name": "search",
  2630. "in": "query",
  2631. "description": "Text to search for",
  2632. "schema": {
  2633. "type": "string",
  2634. "default": ""
  2635. }
  2636. },
  2637. {
  2638. "name": "itemType",
  2639. "in": "query",
  2640. "description": "Limit to specific item types",
  2641. "schema": {
  2642. "type": "string",
  2643. "nullable": true
  2644. }
  2645. },
  2646. {
  2647. "name": "page",
  2648. "in": "query",
  2649. "description": "Page offset for searching",
  2650. "schema": {
  2651. "type": "integer",
  2652. "format": "int64",
  2653. "default": 1
  2654. }
  2655. },
  2656. {
  2657. "name": "perPage",
  2658. "in": "query",
  2659. "description": "Limit amount of search results per page",
  2660. "schema": {
  2661. "type": "integer",
  2662. "format": "int64",
  2663. "default": 200
  2664. }
  2665. },
  2666. {
  2667. "name": "shareType",
  2668. "in": "query",
  2669. "description": "Limit to specific share types",
  2670. "schema": {
  2671. "nullable": true,
  2672. "oneOf": [
  2673. {
  2674. "type": "integer",
  2675. "format": "int64"
  2676. },
  2677. {
  2678. "type": "array",
  2679. "items": {
  2680. "type": "integer",
  2681. "format": "int64"
  2682. }
  2683. }
  2684. ]
  2685. }
  2686. },
  2687. {
  2688. "name": "lookup",
  2689. "in": "query",
  2690. "description": "If a global lookup should be performed too",
  2691. "schema": {
  2692. "type": "integer",
  2693. "default": 0,
  2694. "enum": [
  2695. 0,
  2696. 1
  2697. ]
  2698. }
  2699. },
  2700. {
  2701. "name": "OCS-APIRequest",
  2702. "in": "header",
  2703. "description": "Required to be true for the API request to pass",
  2704. "required": true,
  2705. "schema": {
  2706. "type": "boolean",
  2707. "default": true
  2708. }
  2709. }
  2710. ],
  2711. "responses": {
  2712. "200": {
  2713. "description": "Sharees search result returned",
  2714. "headers": {
  2715. "Link": {
  2716. "schema": {
  2717. "type": "string"
  2718. }
  2719. }
  2720. },
  2721. "content": {
  2722. "application/json": {
  2723. "schema": {
  2724. "type": "object",
  2725. "required": [
  2726. "ocs"
  2727. ],
  2728. "properties": {
  2729. "ocs": {
  2730. "type": "object",
  2731. "required": [
  2732. "meta",
  2733. "data"
  2734. ],
  2735. "properties": {
  2736. "meta": {
  2737. "$ref": "#/components/schemas/OCSMeta"
  2738. },
  2739. "data": {
  2740. "$ref": "#/components/schemas/ShareesSearchResult"
  2741. }
  2742. }
  2743. }
  2744. }
  2745. }
  2746. }
  2747. }
  2748. },
  2749. "400": {
  2750. "description": "Invalid search parameters",
  2751. "content": {
  2752. "text/plain": {
  2753. "schema": {
  2754. "type": "string"
  2755. }
  2756. }
  2757. }
  2758. }
  2759. }
  2760. }
  2761. },
  2762. "/ocs/v2.php/apps/files_sharing/api/v1/sharees_recommended": {
  2763. "get": {
  2764. "operationId": "shareesapi-find-recommended",
  2765. "summary": "Find recommended sharees",
  2766. "tags": [
  2767. "shareesapi"
  2768. ],
  2769. "security": [
  2770. {
  2771. "bearer_auth": []
  2772. },
  2773. {
  2774. "basic_auth": []
  2775. }
  2776. ],
  2777. "parameters": [
  2778. {
  2779. "name": "itemType",
  2780. "in": "query",
  2781. "description": "Limit to specific item types",
  2782. "required": true,
  2783. "schema": {
  2784. "type": "string"
  2785. }
  2786. },
  2787. {
  2788. "name": "shareType",
  2789. "in": "query",
  2790. "description": "Limit to specific share types",
  2791. "schema": {
  2792. "nullable": true,
  2793. "oneOf": [
  2794. {
  2795. "type": "integer",
  2796. "format": "int64"
  2797. },
  2798. {
  2799. "type": "array",
  2800. "items": {
  2801. "type": "integer",
  2802. "format": "int64"
  2803. }
  2804. }
  2805. ]
  2806. }
  2807. },
  2808. {
  2809. "name": "OCS-APIRequest",
  2810. "in": "header",
  2811. "description": "Required to be true for the API request to pass",
  2812. "required": true,
  2813. "schema": {
  2814. "type": "boolean",
  2815. "default": true
  2816. }
  2817. }
  2818. ],
  2819. "responses": {
  2820. "200": {
  2821. "description": "Recommended sharees returned",
  2822. "content": {
  2823. "application/json": {
  2824. "schema": {
  2825. "type": "object",
  2826. "required": [
  2827. "ocs"
  2828. ],
  2829. "properties": {
  2830. "ocs": {
  2831. "type": "object",
  2832. "required": [
  2833. "meta",
  2834. "data"
  2835. ],
  2836. "properties": {
  2837. "meta": {
  2838. "$ref": "#/components/schemas/OCSMeta"
  2839. },
  2840. "data": {
  2841. "$ref": "#/components/schemas/ShareesRecommendedResult"
  2842. }
  2843. }
  2844. }
  2845. }
  2846. }
  2847. }
  2848. }
  2849. }
  2850. }
  2851. }
  2852. },
  2853. "/ocs/v2.php/apps/files_sharing/api/v1/remote_shares": {
  2854. "get": {
  2855. "operationId": "remote-get-shares",
  2856. "summary": "Get a list of accepted remote shares",
  2857. "tags": [
  2858. "remote"
  2859. ],
  2860. "security": [
  2861. {
  2862. "bearer_auth": []
  2863. },
  2864. {
  2865. "basic_auth": []
  2866. }
  2867. ],
  2868. "parameters": [
  2869. {
  2870. "name": "OCS-APIRequest",
  2871. "in": "header",
  2872. "description": "Required to be true for the API request to pass",
  2873. "required": true,
  2874. "schema": {
  2875. "type": "boolean",
  2876. "default": true
  2877. }
  2878. }
  2879. ],
  2880. "responses": {
  2881. "200": {
  2882. "description": "Accepted remote shares returned",
  2883. "content": {
  2884. "application/json": {
  2885. "schema": {
  2886. "type": "object",
  2887. "required": [
  2888. "ocs"
  2889. ],
  2890. "properties": {
  2891. "ocs": {
  2892. "type": "object",
  2893. "required": [
  2894. "meta",
  2895. "data"
  2896. ],
  2897. "properties": {
  2898. "meta": {
  2899. "$ref": "#/components/schemas/OCSMeta"
  2900. },
  2901. "data": {
  2902. "type": "array",
  2903. "items": {
  2904. "$ref": "#/components/schemas/RemoteShare"
  2905. }
  2906. }
  2907. }
  2908. }
  2909. }
  2910. }
  2911. }
  2912. }
  2913. }
  2914. }
  2915. }
  2916. },
  2917. "/ocs/v2.php/apps/files_sharing/api/v1/remote_shares/pending": {
  2918. "get": {
  2919. "operationId": "remote-get-open-shares",
  2920. "summary": "Get list of pending remote shares",
  2921. "tags": [
  2922. "remote"
  2923. ],
  2924. "security": [
  2925. {
  2926. "bearer_auth": []
  2927. },
  2928. {
  2929. "basic_auth": []
  2930. }
  2931. ],
  2932. "parameters": [
  2933. {
  2934. "name": "OCS-APIRequest",
  2935. "in": "header",
  2936. "description": "Required to be true for the API request to pass",
  2937. "required": true,
  2938. "schema": {
  2939. "type": "boolean",
  2940. "default": true
  2941. }
  2942. }
  2943. ],
  2944. "responses": {
  2945. "200": {
  2946. "description": "Pending remote shares returned",
  2947. "content": {
  2948. "application/json": {
  2949. "schema": {
  2950. "type": "object",
  2951. "required": [
  2952. "ocs"
  2953. ],
  2954. "properties": {
  2955. "ocs": {
  2956. "type": "object",
  2957. "required": [
  2958. "meta",
  2959. "data"
  2960. ],
  2961. "properties": {
  2962. "meta": {
  2963. "$ref": "#/components/schemas/OCSMeta"
  2964. },
  2965. "data": {
  2966. "type": "array",
  2967. "items": {
  2968. "$ref": "#/components/schemas/RemoteShare"
  2969. }
  2970. }
  2971. }
  2972. }
  2973. }
  2974. }
  2975. }
  2976. }
  2977. }
  2978. }
  2979. }
  2980. },
  2981. "/ocs/v2.php/apps/files_sharing/api/v1/remote_shares/pending/{id}": {
  2982. "post": {
  2983. "operationId": "remote-accept-share",
  2984. "summary": "Accept a remote share",
  2985. "tags": [
  2986. "remote"
  2987. ],
  2988. "security": [
  2989. {
  2990. "bearer_auth": []
  2991. },
  2992. {
  2993. "basic_auth": []
  2994. }
  2995. ],
  2996. "parameters": [
  2997. {
  2998. "name": "id",
  2999. "in": "path",
  3000. "description": "ID of the share",
  3001. "required": true,
  3002. "schema": {
  3003. "type": "integer",
  3004. "format": "int64"
  3005. }
  3006. },
  3007. {
  3008. "name": "OCS-APIRequest",
  3009. "in": "header",
  3010. "description": "Required to be true for the API request to pass",
  3011. "required": true,
  3012. "schema": {
  3013. "type": "boolean",
  3014. "default": true
  3015. }
  3016. }
  3017. ],
  3018. "responses": {
  3019. "200": {
  3020. "description": "Share accepted successfully",
  3021. "content": {
  3022. "application/json": {
  3023. "schema": {
  3024. "type": "object",
  3025. "required": [
  3026. "ocs"
  3027. ],
  3028. "properties": {
  3029. "ocs": {
  3030. "type": "object",
  3031. "required": [
  3032. "meta",
  3033. "data"
  3034. ],
  3035. "properties": {
  3036. "meta": {
  3037. "$ref": "#/components/schemas/OCSMeta"
  3038. },
  3039. "data": {}
  3040. }
  3041. }
  3042. }
  3043. }
  3044. }
  3045. }
  3046. },
  3047. "404": {
  3048. "description": "Share not found",
  3049. "content": {
  3050. "text/plain": {
  3051. "schema": {
  3052. "type": "string"
  3053. }
  3054. }
  3055. }
  3056. }
  3057. }
  3058. },
  3059. "delete": {
  3060. "operationId": "remote-decline-share",
  3061. "summary": "Decline a remote share",
  3062. "tags": [
  3063. "remote"
  3064. ],
  3065. "security": [
  3066. {
  3067. "bearer_auth": []
  3068. },
  3069. {
  3070. "basic_auth": []
  3071. }
  3072. ],
  3073. "parameters": [
  3074. {
  3075. "name": "id",
  3076. "in": "path",
  3077. "description": "ID of the share",
  3078. "required": true,
  3079. "schema": {
  3080. "type": "integer",
  3081. "format": "int64"
  3082. }
  3083. },
  3084. {
  3085. "name": "OCS-APIRequest",
  3086. "in": "header",
  3087. "description": "Required to be true for the API request to pass",
  3088. "required": true,
  3089. "schema": {
  3090. "type": "boolean",
  3091. "default": true
  3092. }
  3093. }
  3094. ],
  3095. "responses": {
  3096. "200": {
  3097. "description": "Share declined successfully",
  3098. "content": {
  3099. "application/json": {
  3100. "schema": {
  3101. "type": "object",
  3102. "required": [
  3103. "ocs"
  3104. ],
  3105. "properties": {
  3106. "ocs": {
  3107. "type": "object",
  3108. "required": [
  3109. "meta",
  3110. "data"
  3111. ],
  3112. "properties": {
  3113. "meta": {
  3114. "$ref": "#/components/schemas/OCSMeta"
  3115. },
  3116. "data": {}
  3117. }
  3118. }
  3119. }
  3120. }
  3121. }
  3122. }
  3123. },
  3124. "404": {
  3125. "description": "Share not found",
  3126. "content": {
  3127. "text/plain": {
  3128. "schema": {
  3129. "type": "string"
  3130. }
  3131. }
  3132. }
  3133. }
  3134. }
  3135. }
  3136. },
  3137. "/ocs/v2.php/apps/files_sharing/api/v1/remote_shares/{id}": {
  3138. "get": {
  3139. "operationId": "remote-get-share",
  3140. "summary": "Get info of 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. "description": "Required to be true for the API request to pass",
  3167. "required": true,
  3168. "schema": {
  3169. "type": "boolean",
  3170. "default": true
  3171. }
  3172. }
  3173. ],
  3174. "responses": {
  3175. "200": {
  3176. "description": "Share returned",
  3177. "content": {
  3178. "application/json": {
  3179. "schema": {
  3180. "type": "object",
  3181. "required": [
  3182. "ocs"
  3183. ],
  3184. "properties": {
  3185. "ocs": {
  3186. "type": "object",
  3187. "required": [
  3188. "meta",
  3189. "data"
  3190. ],
  3191. "properties": {
  3192. "meta": {
  3193. "$ref": "#/components/schemas/OCSMeta"
  3194. },
  3195. "data": {
  3196. "$ref": "#/components/schemas/RemoteShare"
  3197. }
  3198. }
  3199. }
  3200. }
  3201. }
  3202. }
  3203. }
  3204. },
  3205. "404": {
  3206. "description": "Share not found",
  3207. "content": {
  3208. "text/plain": {
  3209. "schema": {
  3210. "type": "string"
  3211. }
  3212. }
  3213. }
  3214. }
  3215. }
  3216. },
  3217. "delete": {
  3218. "operationId": "remote-unshare",
  3219. "summary": "Unshare a remote share",
  3220. "tags": [
  3221. "remote"
  3222. ],
  3223. "security": [
  3224. {
  3225. "bearer_auth": []
  3226. },
  3227. {
  3228. "basic_auth": []
  3229. }
  3230. ],
  3231. "parameters": [
  3232. {
  3233. "name": "id",
  3234. "in": "path",
  3235. "description": "ID of the share",
  3236. "required": true,
  3237. "schema": {
  3238. "type": "integer",
  3239. "format": "int64"
  3240. }
  3241. },
  3242. {
  3243. "name": "OCS-APIRequest",
  3244. "in": "header",
  3245. "description": "Required to be true for the API request to pass",
  3246. "required": true,
  3247. "schema": {
  3248. "type": "boolean",
  3249. "default": true
  3250. }
  3251. }
  3252. ],
  3253. "responses": {
  3254. "200": {
  3255. "description": "Share unshared successfully",
  3256. "content": {
  3257. "application/json": {
  3258. "schema": {
  3259. "type": "object",
  3260. "required": [
  3261. "ocs"
  3262. ],
  3263. "properties": {
  3264. "ocs": {
  3265. "type": "object",
  3266. "required": [
  3267. "meta",
  3268. "data"
  3269. ],
  3270. "properties": {
  3271. "meta": {
  3272. "$ref": "#/components/schemas/OCSMeta"
  3273. },
  3274. "data": {}
  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. "403": {
  3293. "description": "Unsharing is not possible",
  3294. "content": {
  3295. "text/plain": {
  3296. "schema": {
  3297. "type": "string"
  3298. }
  3299. }
  3300. }
  3301. }
  3302. }
  3303. }
  3304. }
  3305. },
  3306. "tags": [
  3307. {
  3308. "name": "external_shares",
  3309. "description": "Class ExternalSharesController"
  3310. }
  3311. ]
  3312. }