12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320 |
- {
- "openapi": "3.0.3",
- "info": {
- "title": "files_sharing",
- "version": "0.0.1",
- "description": "File sharing",
- "license": {
- "name": "agpl"
- }
- },
- "components": {
- "securitySchemes": {
- "basic_auth": {
- "type": "http",
- "scheme": "basic"
- },
- "bearer_auth": {
- "type": "http",
- "scheme": "bearer"
- }
- },
- "schemas": {
- "Capabilities": {
- "type": "object",
- "required": [
- "files_sharing"
- ],
- "properties": {
- "files_sharing": {
- "type": "object",
- "required": [
- "api_enabled",
- "public",
- "user",
- "resharing",
- "federation",
- "sharee"
- ],
- "properties": {
- "api_enabled": {
- "type": "boolean"
- },
- "public": {
- "type": "object",
- "required": [
- "enabled"
- ],
- "properties": {
- "enabled": {
- "type": "boolean"
- },
- "password": {
- "type": "object",
- "required": [
- "enforced",
- "askForOptionalPassword"
- ],
- "properties": {
- "enforced": {
- "type": "boolean"
- },
- "askForOptionalPassword": {
- "type": "boolean"
- }
- }
- },
- "multiple_links": {
- "type": "boolean"
- },
- "expire_date": {
- "type": "object",
- "required": [
- "enabled"
- ],
- "properties": {
- "enabled": {
- "type": "boolean"
- },
- "days": {
- "type": "integer",
- "format": "int64"
- },
- "enforced": {
- "type": "boolean"
- }
- }
- },
- "expire_date_internal": {
- "type": "object",
- "required": [
- "enabled"
- ],
- "properties": {
- "enabled": {
- "type": "boolean"
- },
- "days": {
- "type": "integer",
- "format": "int64"
- },
- "enforced": {
- "type": "boolean"
- }
- }
- },
- "expire_date_remote": {
- "type": "object",
- "required": [
- "enabled"
- ],
- "properties": {
- "enabled": {
- "type": "boolean"
- },
- "days": {
- "type": "integer",
- "format": "int64"
- },
- "enforced": {
- "type": "boolean"
- }
- }
- },
- "send_mail": {
- "type": "boolean"
- },
- "upload": {
- "type": "boolean"
- },
- "upload_files_drop": {
- "type": "boolean"
- }
- }
- },
- "user": {
- "type": "object",
- "required": [
- "send_mail"
- ],
- "properties": {
- "send_mail": {
- "type": "boolean"
- },
- "expire_date": {
- "type": "object",
- "required": [
- "enabled"
- ],
- "properties": {
- "enabled": {
- "type": "boolean"
- }
- }
- }
- }
- },
- "resharing": {
- "type": "boolean"
- },
- "group_sharing": {
- "type": "boolean"
- },
- "group": {
- "type": "object",
- "required": [
- "enabled"
- ],
- "properties": {
- "enabled": {
- "type": "boolean"
- },
- "expire_date": {
- "type": "object",
- "required": [
- "enabled"
- ],
- "properties": {
- "enabled": {
- "type": "boolean"
- }
- }
- }
- }
- },
- "default_permissions": {
- "type": "integer",
- "format": "int64"
- },
- "federation": {
- "type": "object",
- "required": [
- "outgoing",
- "incoming",
- "expire_date",
- "expire_date_supported"
- ],
- "properties": {
- "outgoing": {
- "type": "boolean"
- },
- "incoming": {
- "type": "boolean"
- },
- "expire_date": {
- "type": "object",
- "required": [
- "enabled"
- ],
- "properties": {
- "enabled": {
- "type": "boolean"
- }
- }
- },
- "expire_date_supported": {
- "type": "object",
- "required": [
- "enabled"
- ],
- "properties": {
- "enabled": {
- "type": "boolean"
- }
- }
- }
- }
- },
- "sharee": {
- "type": "object",
- "required": [
- "query_lookup_default",
- "always_show_unique"
- ],
- "properties": {
- "query_lookup_default": {
- "type": "boolean"
- },
- "always_show_unique": {
- "type": "boolean"
- }
- }
- }
- }
- }
- }
- },
- "DeletedShare": {
- "type": "object",
- "required": [
- "id",
- "share_type",
- "uid_owner",
- "displayname_owner",
- "permissions",
- "stime",
- "uid_file_owner",
- "displayname_file_owner",
- "path",
- "item_type",
- "mimetype",
- "storage",
- "item_source",
- "file_source",
- "file_parent",
- "file_target",
- "expiration",
- "share_with",
- "share_with_displayname",
- "share_with_link"
- ],
- "properties": {
- "id": {
- "type": "string"
- },
- "share_type": {
- "type": "integer",
- "format": "int64"
- },
- "uid_owner": {
- "type": "string"
- },
- "displayname_owner": {
- "type": "string"
- },
- "permissions": {
- "type": "integer",
- "format": "int64"
- },
- "stime": {
- "type": "integer",
- "format": "int64"
- },
- "uid_file_owner": {
- "type": "string"
- },
- "displayname_file_owner": {
- "type": "string"
- },
- "path": {
- "type": "string"
- },
- "item_type": {
- "type": "string"
- },
- "mimetype": {
- "type": "string"
- },
- "storage": {
- "type": "integer",
- "format": "int64"
- },
- "item_source": {
- "type": "integer",
- "format": "int64"
- },
- "file_source": {
- "type": "integer",
- "format": "int64"
- },
- "file_parent": {
- "type": "integer",
- "format": "int64"
- },
- "file_target": {
- "type": "integer",
- "format": "int64"
- },
- "expiration": {
- "type": "string",
- "nullable": true
- },
- "share_with": {
- "type": "string",
- "nullable": true
- },
- "share_with_displayname": {
- "type": "string",
- "nullable": true
- },
- "share_with_link": {
- "type": "string",
- "nullable": true
- }
- }
- },
- "Lookup": {
- "type": "object",
- "required": [
- "value",
- "verified"
- ],
- "properties": {
- "value": {
- "type": "string"
- },
- "verified": {
- "type": "integer",
- "format": "int64"
- }
- }
- },
- "OCSMeta": {
- "type": "object",
- "required": [
- "status",
- "statuscode"
- ],
- "properties": {
- "status": {
- "type": "string"
- },
- "statuscode": {
- "type": "integer"
- },
- "message": {
- "type": "string"
- },
- "totalitems": {
- "type": "string"
- },
- "itemsperpage": {
- "type": "string"
- }
- }
- },
- "RemoteShare": {
- "type": "object",
- "required": [
- "accepted",
- "file_id",
- "id",
- "mimetype",
- "mountpoint",
- "mtime",
- "name",
- "owner",
- "parent",
- "permissions",
- "remote",
- "remote_id",
- "share_token",
- "share_type",
- "type",
- "user"
- ],
- "properties": {
- "accepted": {
- "type": "boolean"
- },
- "file_id": {
- "type": "integer",
- "format": "int64",
- "nullable": true
- },
- "id": {
- "type": "integer",
- "format": "int64"
- },
- "mimetype": {
- "type": "string",
- "nullable": true
- },
- "mountpoint": {
- "type": "string"
- },
- "mtime": {
- "type": "integer",
- "format": "int64",
- "nullable": true
- },
- "name": {
- "type": "string"
- },
- "owner": {
- "type": "string"
- },
- "parent": {
- "type": "integer",
- "format": "int64",
- "nullable": true
- },
- "permissions": {
- "type": "integer",
- "format": "int64",
- "nullable": true
- },
- "remote": {
- "type": "string"
- },
- "remote_id": {
- "type": "string"
- },
- "share_token": {
- "type": "string"
- },
- "share_type": {
- "type": "integer",
- "format": "int64"
- },
- "type": {
- "type": "string",
- "nullable": true
- },
- "user": {
- "type": "string"
- }
- }
- },
- "Share": {
- "type": "object",
- "required": [
- "attributes",
- "can_delete",
- "can_edit",
- "displayname_file_owner",
- "displayname_owner",
- "expiration",
- "file_parent",
- "file_source",
- "file_target",
- "has_preview",
- "hide_download",
- "id",
- "item_mtime",
- "item_size",
- "item_source",
- "item_type",
- "label",
- "mail_send",
- "mimetype",
- "note",
- "parent",
- "path",
- "permissions",
- "share_type",
- "stime",
- "storage",
- "storage_id",
- "token",
- "uid_file_owner",
- "uid_owner"
- ],
- "properties": {
- "attributes": {
- "type": "string",
- "nullable": true
- },
- "can_delete": {
- "type": "boolean"
- },
- "can_edit": {
- "type": "boolean"
- },
- "displayname_file_owner": {
- "type": "string"
- },
- "displayname_owner": {
- "type": "string"
- },
- "expiration": {
- "type": "string",
- "nullable": true
- },
- "file_parent": {
- "type": "integer",
- "format": "int64"
- },
- "file_source": {
- "type": "integer",
- "format": "int64"
- },
- "file_target": {
- "type": "string"
- },
- "has_preview": {
- "type": "boolean"
- },
- "hide_download": {
- "type": "integer",
- "format": "int64",
- "enum": [
- 0,
- 1
- ]
- },
- "id": {
- "type": "string"
- },
- "item_mtime": {
- "type": "integer",
- "format": "int64"
- },
- "item_permissions": {
- "type": "integer",
- "format": "int64"
- },
- "item_size": {
- "oneOf": [
- {
- "type": "number",
- "format": "float"
- },
- {
- "type": "integer",
- "format": "int64"
- }
- ]
- },
- "item_source": {
- "type": "integer",
- "format": "int64"
- },
- "item_type": {
- "type": "string",
- "enum": [
- "file",
- "folder"
- ]
- },
- "label": {
- "type": "string"
- },
- "mail_send": {
- "type": "integer",
- "format": "int64",
- "enum": [
- 0,
- 1
- ]
- },
- "mimetype": {
- "type": "string"
- },
- "note": {
- "type": "string"
- },
- "parent": {
- "nullable": true
- },
- "password": {
- "type": "string",
- "nullable": true
- },
- "password_expiration_time": {
- "type": "string",
- "nullable": true
- },
- "path": {
- "type": "string",
- "nullable": true
- },
- "permissions": {
- "type": "integer",
- "format": "int64"
- },
- "send_password_by_talk": {
- "type": "boolean"
- },
- "share_type": {
- "type": "integer",
- "format": "int64"
- },
- "share_with": {
- "type": "string",
- "nullable": true
- },
- "share_with_avatar": {
- "type": "string"
- },
- "share_with_displayname": {
- "type": "string"
- },
- "share_with_displayname_unique": {
- "type": "string",
- "nullable": true
- },
- "share_with_link": {
- "type": "string"
- },
- "status": {
- "type": "object",
- "required": [
- "clearAt",
- "icon",
- "message",
- "status"
- ],
- "properties": {
- "clearAt": {
- "type": "integer",
- "format": "int64",
- "nullable": true
- },
- "icon": {
- "type": "string",
- "nullable": true
- },
- "message": {
- "type": "string",
- "nullable": true
- },
- "status": {
- "type": "string"
- }
- }
- },
- "stime": {
- "type": "integer",
- "format": "int64"
- },
- "storage": {
- "type": "integer",
- "format": "int64"
- },
- "storage_id": {
- "type": "string"
- },
- "token": {
- "type": "string",
- "nullable": true
- },
- "uid_file_owner": {
- "type": "string"
- },
- "uid_owner": {
- "type": "string"
- },
- "url": {
- "type": "string"
- }
- }
- },
- "ShareInfo": {
- "type": "object",
- "required": [
- "id",
- "parentId",
- "mtime",
- "name",
- "permissions",
- "mimetype",
- "size",
- "type",
- "etag"
- ],
- "properties": {
- "id": {
- "type": "integer",
- "format": "int64"
- },
- "parentId": {
- "type": "integer",
- "format": "int64"
- },
- "mtime": {
- "type": "integer",
- "format": "int64"
- },
- "name": {
- "type": "string"
- },
- "permissions": {
- "type": "integer",
- "format": "int64"
- },
- "mimetype": {
- "type": "string"
- },
- "size": {
- "oneOf": [
- {
- "type": "integer",
- "format": "int64"
- },
- {
- "type": "number",
- "format": "float"
- }
- ]
- },
- "type": {
- "type": "string"
- },
- "etag": {
- "type": "string"
- },
- "children": {
- "type": "array",
- "items": {
- "type": "object",
- "additionalProperties": {
- "type": "object"
- }
- }
- }
- }
- },
- "Sharee": {
- "type": "object",
- "required": [
- "count",
- "label"
- ],
- "properties": {
- "count": {
- "type": "integer",
- "format": "int64",
- "nullable": true
- },
- "label": {
- "type": "string"
- }
- }
- },
- "ShareeCircle": {
- "allOf": [
- {
- "$ref": "#/components/schemas/Sharee"
- },
- {
- "type": "object",
- "required": [
- "shareWithDescription",
- "value"
- ],
- "properties": {
- "shareWithDescription": {
- "type": "string"
- },
- "value": {
- "allOf": [
- {
- "$ref": "#/components/schemas/ShareeValue"
- },
- {
- "type": "object",
- "required": [
- "circle"
- ],
- "properties": {
- "circle": {
- "type": "string"
- }
- }
- }
- ]
- }
- }
- }
- ]
- },
- "ShareeEmail": {
- "allOf": [
- {
- "$ref": "#/components/schemas/Sharee"
- },
- {
- "type": "object",
- "required": [
- "uuid",
- "name",
- "type",
- "shareWithDisplayNameUnique",
- "value"
- ],
- "properties": {
- "uuid": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "type": {
- "type": "string"
- },
- "shareWithDisplayNameUnique": {
- "type": "string"
- },
- "value": {
- "$ref": "#/components/schemas/ShareeValue"
- }
- }
- }
- ]
- },
- "ShareeLookup": {
- "allOf": [
- {
- "$ref": "#/components/schemas/Sharee"
- },
- {
- "type": "object",
- "required": [
- "extra",
- "value"
- ],
- "properties": {
- "extra": {
- "type": "object",
- "required": [
- "federationId",
- "name",
- "email",
- "address",
- "website",
- "twitter",
- "phone",
- "twitter_signature",
- "website_signature",
- "userid"
- ],
- "properties": {
- "federationId": {
- "type": "string"
- },
- "name": {
- "$ref": "#/components/schemas/Lookup",
- "nullable": true
- },
- "email": {
- "$ref": "#/components/schemas/Lookup",
- "nullable": true
- },
- "address": {
- "$ref": "#/components/schemas/Lookup",
- "nullable": true
- },
- "website": {
- "$ref": "#/components/schemas/Lookup",
- "nullable": true
- },
- "twitter": {
- "$ref": "#/components/schemas/Lookup",
- "nullable": true
- },
- "phone": {
- "$ref": "#/components/schemas/Lookup",
- "nullable": true
- },
- "twitter_signature": {
- "$ref": "#/components/schemas/Lookup",
- "nullable": true
- },
- "website_signature": {
- "$ref": "#/components/schemas/Lookup",
- "nullable": true
- },
- "userid": {
- "$ref": "#/components/schemas/Lookup",
- "nullable": true
- }
- }
- },
- "value": {
- "allOf": [
- {
- "$ref": "#/components/schemas/ShareeValue"
- },
- {
- "type": "object",
- "required": [
- "globalScale"
- ],
- "properties": {
- "globalScale": {
- "type": "boolean"
- }
- }
- }
- ]
- }
- }
- }
- ]
- },
- "ShareeRemote": {
- "allOf": [
- {
- "$ref": "#/components/schemas/Sharee"
- },
- {
- "type": "object",
- "required": [
- "uuid",
- "name",
- "type",
- "value"
- ],
- "properties": {
- "uuid": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "type": {
- "type": "string"
- },
- "value": {
- "allOf": [
- {
- "$ref": "#/components/schemas/ShareeValue"
- },
- {
- "type": "object",
- "required": [
- "server"
- ],
- "properties": {
- "server": {
- "type": "string"
- }
- }
- }
- ]
- }
- }
- }
- ]
- },
- "ShareeRemoteGroup": {
- "allOf": [
- {
- "$ref": "#/components/schemas/Sharee"
- },
- {
- "type": "object",
- "required": [
- "guid",
- "name",
- "value"
- ],
- "properties": {
- "guid": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "value": {
- "allOf": [
- {
- "$ref": "#/components/schemas/ShareeValue"
- },
- {
- "type": "object",
- "required": [
- "server"
- ],
- "properties": {
- "server": {
- "type": "string"
- }
- }
- }
- ]
- }
- }
- }
- ]
- },
- "ShareeUser": {
- "allOf": [
- {
- "$ref": "#/components/schemas/Sharee"
- },
- {
- "type": "object",
- "required": [
- "subline",
- "icon",
- "shareWithDisplayNameUnique",
- "status",
- "value"
- ],
- "properties": {
- "subline": {
- "type": "string"
- },
- "icon": {
- "type": "string"
- },
- "shareWithDisplayNameUnique": {
- "type": "string"
- },
- "status": {
- "type": "object",
- "required": [
- "status",
- "message",
- "icon",
- "clearAt"
- ],
- "properties": {
- "status": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "icon": {
- "type": "string"
- },
- "clearAt": {
- "type": "integer",
- "format": "int64",
- "nullable": true
- }
- }
- },
- "value": {
- "$ref": "#/components/schemas/ShareeValue"
- }
- }
- }
- ]
- },
- "ShareeValue": {
- "type": "object",
- "required": [
- "shareType",
- "shareWith"
- ],
- "properties": {
- "shareType": {
- "type": "integer",
- "format": "int64"
- },
- "shareWith": {
- "type": "string"
- }
- }
- },
- "ShareesRecommendedResult": {
- "type": "object",
- "required": [
- "exact",
- "emails",
- "groups",
- "remote_groups",
- "remotes",
- "users"
- ],
- "properties": {
- "exact": {
- "type": "object",
- "required": [
- "emails",
- "groups",
- "remote_groups",
- "remotes",
- "users"
- ],
- "properties": {
- "emails": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ShareeEmail"
- }
- },
- "groups": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Sharee"
- }
- },
- "remote_groups": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ShareeRemoteGroup"
- }
- },
- "remotes": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ShareeRemote"
- }
- },
- "users": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ShareeUser"
- }
- }
- }
- },
- "emails": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ShareeEmail"
- }
- },
- "groups": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Sharee"
- }
- },
- "remote_groups": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ShareeRemoteGroup"
- }
- },
- "remotes": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ShareeRemote"
- }
- },
- "users": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ShareeUser"
- }
- }
- }
- },
- "ShareesSearchResult": {
- "type": "object",
- "required": [
- "exact",
- "circles",
- "emails",
- "groups",
- "lookup",
- "remote_groups",
- "remotes",
- "rooms",
- "users",
- "lookupEnabled"
- ],
- "properties": {
- "exact": {
- "type": "object",
- "required": [
- "circles",
- "emails",
- "groups",
- "remote_groups",
- "remotes",
- "rooms",
- "users"
- ],
- "properties": {
- "circles": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ShareeCircle"
- }
- },
- "emails": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ShareeEmail"
- }
- },
- "groups": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Sharee"
- }
- },
- "remote_groups": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ShareeRemoteGroup"
- }
- },
- "remotes": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ShareeRemote"
- }
- },
- "rooms": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Sharee"
- }
- },
- "users": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ShareeUser"
- }
- }
- }
- },
- "circles": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ShareeCircle"
- }
- },
- "emails": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ShareeEmail"
- }
- },
- "groups": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Sharee"
- }
- },
- "lookup": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ShareeLookup"
- }
- },
- "remote_groups": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ShareeRemoteGroup"
- }
- },
- "remotes": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ShareeRemote"
- }
- },
- "rooms": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Sharee"
- }
- },
- "users": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ShareeUser"
- }
- },
- "lookupEnabled": {
- "type": "boolean"
- }
- }
- }
- }
- },
- "paths": {
- "/index.php/s/{token}/preview": {
- "get": {
- "operationId": "public_preview-direct-link",
- "summary": "Get a direct link preview for a shared file",
- "tags": [
- "public_preview"
- ],
- "security": [
- {},
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "token",
- "in": "path",
- "description": "Token of the share",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Preview returned",
- "content": {
- "*/*": {
- "schema": {
- "type": "string",
- "format": "binary"
- }
- }
- }
- },
- "400": {
- "description": "Getting preview is not possible",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "403": {
- "description": "Getting preview is not allowed",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "404": {
- "description": "Share or preview not found",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- }
- }
- }
- },
- "/index.php/apps/files_sharing/publicpreview/{token}": {
- "get": {
- "operationId": "public_preview-get-preview",
- "summary": "Get a preview for a shared file",
- "tags": [
- "public_preview"
- ],
- "security": [
- {},
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "file",
- "in": "query",
- "description": "File in the share",
- "schema": {
- "type": "string",
- "default": ""
- }
- },
- {
- "name": "x",
- "in": "query",
- "description": "Width of the preview",
- "schema": {
- "type": "integer",
- "format": "int64",
- "default": 32
- }
- },
- {
- "name": "y",
- "in": "query",
- "description": "Height of the preview",
- "schema": {
- "type": "integer",
- "format": "int64",
- "default": 32
- }
- },
- {
- "name": "a",
- "in": "query",
- "description": "Whether to not crop the preview",
- "schema": {
- "type": "integer",
- "default": 0,
- "enum": [
- 0,
- 1
- ]
- }
- },
- {
- "name": "token",
- "in": "path",
- "description": "Token of the share",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Preview returned",
- "content": {
- "*/*": {
- "schema": {
- "type": "string",
- "format": "binary"
- }
- }
- }
- },
- "400": {
- "description": "Getting preview is not possible",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "403": {
- "description": "Getting preview is not allowed",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "404": {
- "description": "Share or preview not found",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- }
- }
- }
- },
- "/index.php/apps/files_sharing/shareinfo": {
- "post": {
- "operationId": "share_info-info",
- "summary": "Get the info about a share",
- "tags": [
- "share_info"
- ],
- "security": [
- {},
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "t",
- "in": "query",
- "description": "Token of the share",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "password",
- "in": "query",
- "description": "Password of the share",
- "schema": {
- "type": "string",
- "nullable": true
- }
- },
- {
- "name": "dir",
- "in": "query",
- "description": "Subdirectory to get info about",
- "schema": {
- "type": "string",
- "nullable": true
- }
- },
- {
- "name": "depth",
- "in": "query",
- "description": "Maximum depth to get info about",
- "schema": {
- "type": "integer",
- "format": "int64",
- "default": -1
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Share info returned",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ShareInfo"
- }
- }
- }
- },
- "403": {
- "description": "Getting share info is not allowed",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "404": {
- "description": "Share not found",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/apps/files_sharing/api/v1/shares": {
- "get": {
- "operationId": "shareapi-get-shares",
- "summary": "Get shares of the current user",
- "tags": [
- "shareapi"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "shared_with_me",
- "in": "query",
- "description": "Only get shares with the current user",
- "schema": {
- "type": "string",
- "default": "false"
- }
- },
- {
- "name": "reshares",
- "in": "query",
- "description": "Only get shares by the current user and reshares",
- "schema": {
- "type": "string",
- "default": "false"
- }
- },
- {
- "name": "subfiles",
- "in": "query",
- "description": "Only get all shares in a folder",
- "schema": {
- "type": "string",
- "default": "false"
- }
- },
- {
- "name": "path",
- "in": "query",
- "description": "Get shares for a specific path",
- "schema": {
- "type": "string",
- "default": ""
- }
- },
- {
- "name": "include_tags",
- "in": "query",
- "description": "Include tags in the share",
- "schema": {
- "type": "string",
- "default": "false"
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Shares returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Share"
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "The folder was not found or is inaccessible",
- "content": {
- "text/plain": {
- "schema": {
- "type": "string"
- }
- }
- }
- }
- }
- },
- "post": {
- "operationId": "shareapi-create-share",
- "summary": "Create a share",
- "tags": [
- "shareapi"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "path",
- "in": "query",
- "description": "Path of the share",
- "schema": {
- "type": "string",
- "nullable": true
- }
- },
- {
- "name": "permissions",
- "in": "query",
- "description": "Permissions for the share",
- "schema": {
- "type": "integer",
- "format": "int64",
- "nullable": true
- }
- },
- {
- "name": "shareType",
- "in": "query",
- "description": "Type of the share",
- "schema": {
- "type": "integer",
- "format": "int64",
- "default": -1
- }
- },
- {
- "name": "shareWith",
- "in": "query",
- "description": "The entity this should be shared with",
- "schema": {
- "type": "string",
- "nullable": true
- }
- },
- {
- "name": "publicUpload",
- "in": "query",
- "description": "If public uploading is allowed",
- "schema": {
- "type": "string",
- "default": "false"
- }
- },
- {
- "name": "password",
- "in": "query",
- "description": "Password for the share",
- "schema": {
- "type": "string",
- "default": ""
- }
- },
- {
- "name": "sendPasswordByTalk",
- "in": "query",
- "description": "Send the password for the share over Talk",
- "schema": {
- "type": "string",
- "nullable": true
- }
- },
- {
- "name": "expireDate",
- "in": "query",
- "description": "Expiry date of the share using user timezone at 00:00. It means date in UTC timezone will be used.",
- "schema": {
- "type": "string",
- "default": ""
- }
- },
- {
- "name": "note",
- "in": "query",
- "description": "Note for the share",
- "schema": {
- "type": "string",
- "default": ""
- }
- },
- {
- "name": "label",
- "in": "query",
- "description": "Label for the share (only used in link and email)",
- "schema": {
- "type": "string",
- "default": ""
- }
- },
- {
- "name": "attributes",
- "in": "query",
- "description": "Additional attributes for the share",
- "schema": {
- "type": "string",
- "nullable": true
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Share created",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "$ref": "#/components/schemas/Share"
- }
- }
- }
- }
- }
- }
- }
- },
- "400": {
- "description": "Unknown share type",
- "content": {
- "text/plain": {
- "schema": {
- "type": "string"
- }
- }
- }
- },
- "403": {
- "description": "Creating the share is not allowed",
- "content": {
- "text/plain": {
- "schema": {
- "type": "string"
- }
- }
- }
- },
- "404": {
- "description": "Creating the share failed",
- "content": {
- "text/plain": {
- "schema": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/apps/files_sharing/api/v1/shares/inherited": {
- "get": {
- "operationId": "shareapi-get-inherited-shares",
- "summary": "Get all shares relative to a file, including parent folders shares rights",
- "tags": [
- "shareapi"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "path",
- "in": "query",
- "description": "Path all shares will be relative to",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Shares returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Share"
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "500": {
- "description": "",
- "content": {
- "text/plain": {
- "schema": {
- "type": "string"
- }
- }
- }
- },
- "404": {
- "description": "The given path is invalid",
- "content": {
- "text/plain": {
- "schema": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/apps/files_sharing/api/v1/shares/pending": {
- "get": {
- "operationId": "shareapi-pending-shares",
- "summary": "Get all shares that are still pending",
- "tags": [
- "shareapi"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Pending shares returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Share"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/apps/files_sharing/api/v1/shares/{id}": {
- "get": {
- "operationId": "shareapi-get-share",
- "summary": "Get a specific share by id",
- "tags": [
- "shareapi"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "include_tags",
- "in": "query",
- "description": "Include tags in the share",
- "schema": {
- "type": "integer",
- "default": 0,
- "enum": [
- 0,
- 1
- ]
- }
- },
- {
- "name": "id",
- "in": "path",
- "description": "ID of the share",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Share returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "$ref": "#/components/schemas/Share"
- }
- }
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "Share not found",
- "content": {
- "text/plain": {
- "schema": {
- "type": "string"
- }
- }
- }
- }
- }
- },
- "put": {
- "operationId": "shareapi-update-share",
- "summary": "Update a share",
- "tags": [
- "shareapi"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "permissions",
- "in": "query",
- "description": "New permissions",
- "schema": {
- "type": "integer",
- "format": "int64",
- "nullable": true
- }
- },
- {
- "name": "password",
- "in": "query",
- "description": "New password",
- "schema": {
- "type": "string",
- "nullable": true
- }
- },
- {
- "name": "sendPasswordByTalk",
- "in": "query",
- "description": "New condition if the password should be send over Talk",
- "schema": {
- "type": "string",
- "nullable": true
- }
- },
- {
- "name": "publicUpload",
- "in": "query",
- "description": "New condition if public uploading is allowed",
- "schema": {
- "type": "string",
- "nullable": true
- }
- },
- {
- "name": "expireDate",
- "in": "query",
- "description": "New expiry date",
- "schema": {
- "type": "string",
- "nullable": true
- }
- },
- {
- "name": "note",
- "in": "query",
- "description": "New note",
- "schema": {
- "type": "string",
- "nullable": true
- }
- },
- {
- "name": "label",
- "in": "query",
- "description": "New label",
- "schema": {
- "type": "string",
- "nullable": true
- }
- },
- {
- "name": "hideDownload",
- "in": "query",
- "description": "New condition if the download should be hidden",
- "schema": {
- "type": "string",
- "nullable": true
- }
- },
- {
- "name": "attributes",
- "in": "query",
- "description": "New additional attributes",
- "schema": {
- "type": "string",
- "nullable": true
- }
- },
- {
- "name": "id",
- "in": "path",
- "description": "ID of the share",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Share updated successfully",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "$ref": "#/components/schemas/Share"
- }
- }
- }
- }
- }
- }
- }
- },
- "400": {
- "description": "Share could not be updated because the requested changes are invalid",
- "content": {
- "text/plain": {
- "schema": {
- "type": "string"
- }
- }
- }
- },
- "403": {
- "description": "Missing permissions to update the share",
- "content": {
- "text/plain": {
- "schema": {
- "type": "string"
- }
- }
- }
- },
- "404": {
- "description": "Share not found",
- "content": {
- "text/plain": {
- "schema": {
- "type": "string"
- }
- }
- }
- }
- }
- },
- "delete": {
- "operationId": "shareapi-delete-share",
- "summary": "Delete a share",
- "tags": [
- "shareapi"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "id",
- "in": "path",
- "description": "ID of the share",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Share deleted successfully",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "Share not found",
- "content": {
- "text/plain": {
- "schema": {
- "type": "string"
- }
- }
- }
- },
- "403": {
- "description": "Missing permissions to delete the share",
- "content": {
- "text/plain": {
- "schema": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/apps/files_sharing/api/v1/shares/pending/{id}": {
- "post": {
- "operationId": "shareapi-accept-share",
- "summary": "Accept a share",
- "tags": [
- "shareapi"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "id",
- "in": "path",
- "description": "ID of the share",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Share accepted successfully",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "Share not found",
- "content": {
- "text/plain": {
- "schema": {
- "type": "string"
- }
- }
- }
- },
- "400": {
- "description": "Share could not be accepted",
- "content": {
- "text/plain": {
- "schema": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/apps/files_sharing/api/v1/deletedshares": {
- "get": {
- "operationId": "deleted_shareapi-index",
- "summary": "Get a list of all deleted shares",
- "tags": [
- "deleted_shareapi"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Deleted shares returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/DeletedShare"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/apps/files_sharing/api/v1/deletedshares/{id}": {
- "post": {
- "operationId": "deleted_shareapi-undelete",
- "summary": "Undelete a deleted share",
- "tags": [
- "deleted_shareapi"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "id",
- "in": "path",
- "description": "ID of the share",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Share undeleted successfully",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "Share not found",
- "content": {
- "text/plain": {
- "schema": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/apps/files_sharing/api/v1/sharees": {
- "get": {
- "operationId": "shareesapi-search",
- "summary": "Search for sharees",
- "tags": [
- "shareesapi"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "search",
- "in": "query",
- "description": "Text to search for",
- "schema": {
- "type": "string",
- "default": ""
- }
- },
- {
- "name": "itemType",
- "in": "query",
- "description": "Limit to specific item types",
- "schema": {
- "type": "string",
- "nullable": true
- }
- },
- {
- "name": "page",
- "in": "query",
- "description": "Page offset for searching",
- "schema": {
- "type": "integer",
- "format": "int64",
- "default": 1
- }
- },
- {
- "name": "perPage",
- "in": "query",
- "description": "Limit amount of search results per page",
- "schema": {
- "type": "integer",
- "format": "int64",
- "default": 200
- }
- },
- {
- "name": "shareType",
- "in": "query",
- "description": "Limit to specific share types",
- "schema": {
- "nullable": true,
- "oneOf": [
- {
- "type": "integer",
- "format": "int64"
- },
- {
- "type": "array",
- "items": {
- "type": "integer",
- "format": "int64"
- }
- }
- ]
- }
- },
- {
- "name": "lookup",
- "in": "query",
- "description": "If a global lookup should be performed too",
- "schema": {
- "type": "integer",
- "default": 0,
- "enum": [
- 0,
- 1
- ]
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Sharees search result returned",
- "headers": {
- "Link": {
- "schema": {
- "type": "string"
- }
- }
- },
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "$ref": "#/components/schemas/ShareesSearchResult"
- }
- }
- }
- }
- }
- }
- }
- },
- "400": {
- "description": "Invalid search parameters",
- "content": {
- "text/plain": {
- "schema": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/apps/files_sharing/api/v1/sharees_recommended": {
- "get": {
- "operationId": "shareesapi-find-recommended",
- "summary": "Find recommended sharees",
- "tags": [
- "shareesapi"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "itemType",
- "in": "query",
- "description": "Limit to specific item types",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "shareType",
- "in": "query",
- "description": "Limit to specific share types",
- "schema": {
- "nullable": true,
- "oneOf": [
- {
- "type": "integer",
- "format": "int64"
- },
- {
- "type": "array",
- "items": {
- "type": "integer",
- "format": "int64"
- }
- }
- ]
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Recommended sharees returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "$ref": "#/components/schemas/ShareesRecommendedResult"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/apps/files_sharing/api/v1/remote_shares": {
- "get": {
- "operationId": "remote-get-shares",
- "summary": "Get a list of accepted remote shares",
- "tags": [
- "remote"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Accepted remote shares returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/RemoteShare"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/apps/files_sharing/api/v1/remote_shares/pending": {
- "get": {
- "operationId": "remote-get-open-shares",
- "summary": "Get list of pending remote shares",
- "tags": [
- "remote"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Pending remote shares returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/RemoteShare"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/apps/files_sharing/api/v1/remote_shares/pending/{id}": {
- "post": {
- "operationId": "remote-accept-share",
- "summary": "Accept a remote share",
- "tags": [
- "remote"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "id",
- "in": "path",
- "description": "ID of the share",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Share accepted successfully",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "Share not found",
- "content": {
- "text/plain": {
- "schema": {
- "type": "string"
- }
- }
- }
- }
- }
- },
- "delete": {
- "operationId": "remote-decline-share",
- "summary": "Decline a remote share",
- "tags": [
- "remote"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "id",
- "in": "path",
- "description": "ID of the share",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Share declined successfully",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "Share not found",
- "content": {
- "text/plain": {
- "schema": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/apps/files_sharing/api/v1/remote_shares/{id}": {
- "get": {
- "operationId": "remote-get-share",
- "summary": "Get info of a remote share",
- "tags": [
- "remote"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "id",
- "in": "path",
- "description": "ID of the share",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Share returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "$ref": "#/components/schemas/RemoteShare"
- }
- }
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "Share not found",
- "content": {
- "text/plain": {
- "schema": {
- "type": "string"
- }
- }
- }
- }
- }
- },
- "delete": {
- "operationId": "remote-unshare",
- "summary": "Unshare a remote share",
- "tags": [
- "remote"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "id",
- "in": "path",
- "description": "ID of the share",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
- },
- {
- "name": "OCS-APIRequest",
- "in": "header",
- "description": "Required to be true for the API request to pass",
- "required": true,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Share unshared successfully",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "Share not found",
- "content": {
- "text/plain": {
- "schema": {
- "type": "string"
- }
- }
- }
- },
- "403": {
- "description": "Unsharing is not possible",
- "content": {
- "text/plain": {
- "schema": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- },
- "tags": [
- {
- "name": "external_shares",
- "description": "Class ExternalSharesController"
- }
- ]
- }
|