12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096 |
- {
- "openapi": "3.0.3",
- "info": {
- "title": "files",
- "version": "0.0.1",
- "description": "File Management",
- "license": {
- "name": "agpl"
- }
- },
- "components": {
- "securitySchemes": {
- "basic_auth": {
- "type": "http",
- "scheme": "basic"
- },
- "bearer_auth": {
- "type": "http",
- "scheme": "bearer"
- }
- },
- "schemas": {
- "Capabilities": {
- "type": "object",
- "required": [
- "files"
- ],
- "properties": {
- "files": {
- "type": "object",
- "required": [
- "$comment",
- "bigfilechunking",
- "blacklisted_files",
- "forbidden_filenames",
- "forbidden_filename_basenames",
- "forbidden_filename_characters",
- "forbidden_filename_extensions",
- "directEditing"
- ],
- "properties": {
- "$comment": {
- "type": "string",
- "nullable": true
- },
- "bigfilechunking": {
- "type": "boolean"
- },
- "blacklisted_files": {
- "type": "array",
- "items": {
- "type": "object"
- }
- },
- "forbidden_filenames": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "forbidden_filename_basenames": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "forbidden_filename_characters": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "forbidden_filename_extensions": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "directEditing": {
- "type": "object",
- "required": [
- "url",
- "etag",
- "supportsFileId"
- ],
- "properties": {
- "url": {
- "type": "string"
- },
- "etag": {
- "type": "string"
- },
- "supportsFileId": {
- "type": "boolean"
- }
- }
- }
- }
- }
- }
- },
- "FolderTree": {
- "type": "array",
- "items": {
- "type": "object",
- "required": [
- "id",
- "basename",
- "children"
- ],
- "properties": {
- "id": {
- "type": "integer",
- "format": "int64"
- },
- "basename": {
- "type": "string"
- },
- "displayName": {
- "type": "string"
- },
- "children": {
- "type": "array",
- "items": {
- "type": "object"
- }
- }
- }
- }
- },
- "OCSMeta": {
- "type": "object",
- "required": [
- "status",
- "statuscode"
- ],
- "properties": {
- "status": {
- "type": "string"
- },
- "statuscode": {
- "type": "integer"
- },
- "message": {
- "type": "string"
- },
- "totalitems": {
- "type": "string"
- },
- "itemsperpage": {
- "type": "string"
- }
- }
- },
- "TemplateField": {
- "type": "object",
- "required": [
- "index",
- "content",
- "type"
- ],
- "properties": {
- "index": {
- "type": "string"
- },
- "content": {
- "type": "string"
- },
- "type": {
- "type": "string"
- }
- }
- },
- "TemplateFile": {
- "type": "object",
- "required": [
- "basename",
- "etag",
- "fileid",
- "filename",
- "lastmod",
- "mime",
- "size",
- "type",
- "hasPreview"
- ],
- "properties": {
- "basename": {
- "type": "string"
- },
- "etag": {
- "type": "string"
- },
- "fileid": {
- "type": "integer",
- "format": "int64"
- },
- "filename": {
- "type": "string",
- "nullable": true
- },
- "lastmod": {
- "type": "integer",
- "format": "int64"
- },
- "mime": {
- "type": "string"
- },
- "size": {
- "type": "integer",
- "format": "int64"
- },
- "type": {
- "type": "string"
- },
- "hasPreview": {
- "type": "boolean"
- }
- }
- },
- "TemplateFileCreator": {
- "type": "object",
- "required": [
- "app",
- "label",
- "extension",
- "iconClass",
- "iconSvgInline",
- "mimetypes",
- "ratio",
- "actionLabel"
- ],
- "properties": {
- "app": {
- "type": "string"
- },
- "label": {
- "type": "string"
- },
- "extension": {
- "type": "string"
- },
- "iconClass": {
- "type": "string",
- "nullable": true
- },
- "iconSvgInline": {
- "type": "string",
- "nullable": true
- },
- "mimetypes": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "ratio": {
- "type": "number",
- "format": "double",
- "nullable": true
- },
- "actionLabel": {
- "type": "string"
- }
- }
- }
- }
- },
- "paths": {
- "/index.php/apps/files/api/v1/thumbnail/{x}/{y}/{file}": {
- "get": {
- "operationId": "api-get-thumbnail",
- "summary": "Gets a thumbnail of the specified file",
- "tags": [
- "api"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "x",
- "in": "path",
- "description": "Width of the thumbnail",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
- },
- {
- "name": "y",
- "in": "path",
- "description": "Height of the thumbnail",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int64"
- }
- },
- {
- "name": "file",
- "in": "path",
- "description": "URL-encoded filename",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "^.+$"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Thumbnail returned",
- "content": {
- "*/*": {
- "schema": {
- "type": "string",
- "format": "binary"
- }
- }
- }
- },
- "400": {
- "description": "Getting thumbnail is not possible",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "File not found",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/apps/files/api/v1/directEditing": {
- "get": {
- "operationId": "direct_editing-info",
- "summary": "Get the direct editing capabilities",
- "tags": [
- "direct_editing"
- ],
- "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": "Direct editing capabilities returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "editors",
- "creators"
- ],
- "properties": {
- "editors": {
- "type": "object",
- "additionalProperties": {
- "type": "object",
- "required": [
- "id",
- "name",
- "mimetypes",
- "optionalMimetypes",
- "secure"
- ],
- "properties": {
- "id": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "mimetypes": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "optionalMimetypes": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "secure": {
- "type": "boolean"
- }
- }
- }
- },
- "creators": {
- "type": "object",
- "additionalProperties": {
- "type": "object",
- "required": [
- "id",
- "editor",
- "name",
- "extension",
- "templates",
- "mimetypes"
- ],
- "properties": {
- "id": {
- "type": "string"
- },
- "editor": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "extension": {
- "type": "string"
- },
- "templates": {
- "type": "boolean"
- },
- "mimetypes": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/apps/files/api/v1/directEditing/templates/{editorId}/{creatorId}": {
- "get": {
- "operationId": "direct_editing-templates",
- "summary": "Get the templates for direct editing",
- "tags": [
- "direct_editing"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "editorId",
- "in": "path",
- "description": "ID of the editor",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "creatorId",
- "in": "path",
- "description": "ID of the creator",
- "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": "Templates returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "templates"
- ],
- "properties": {
- "templates": {
- "type": "object",
- "additionalProperties": {
- "type": "object",
- "required": [
- "id",
- "title",
- "preview",
- "extension",
- "mimetype"
- ],
- "properties": {
- "id": {
- "type": "string"
- },
- "title": {
- "type": "string"
- },
- "preview": {
- "type": "string",
- "nullable": true
- },
- "extension": {
- "type": "string"
- },
- "mimetype": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "500": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/apps/files/api/v1/directEditing/open": {
- "post": {
- "operationId": "direct_editing-open",
- "summary": "Open a file for direct editing",
- "tags": [
- "direct_editing"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "path"
- ],
- "properties": {
- "path": {
- "type": "string",
- "description": "Path of the file"
- },
- "editorId": {
- "type": "string",
- "nullable": true,
- "description": "ID of the editor"
- },
- "fileId": {
- "type": "integer",
- "format": "int64",
- "nullable": true,
- "description": "ID of the file"
- }
- }
- }
- }
- }
- },
- "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": "URL for direct editing returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "url"
- ],
- "properties": {
- "url": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "403": {
- "description": "Opening file is not allowed",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "500": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/apps/files/api/v1/directEditing/create": {
- "post": {
- "operationId": "direct_editing-create",
- "summary": "Create a file for direct editing",
- "tags": [
- "direct_editing"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "path",
- "editorId",
- "creatorId"
- ],
- "properties": {
- "path": {
- "type": "string",
- "description": "Path of the file"
- },
- "editorId": {
- "type": "string",
- "description": "ID of the editor"
- },
- "creatorId": {
- "type": "string",
- "description": "ID of the creator"
- },
- "templateId": {
- "type": "string",
- "nullable": true,
- "description": "ID of the template"
- }
- }
- }
- }
- }
- },
- "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": "URL for direct editing returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "url"
- ],
- "properties": {
- "url": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "403": {
- "description": "Opening file is not allowed",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "500": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/apps/files/api/v1/templates": {
- "get": {
- "operationId": "template-list",
- "summary": "List the available templates",
- "tags": [
- "template"
- ],
- "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": "Available templates 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/TemplateFileCreator"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/apps/files/api/v1/templates/create": {
- "post": {
- "operationId": "template-create",
- "summary": "Create a template",
- "tags": [
- "template"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "filePath"
- ],
- "properties": {
- "filePath": {
- "type": "string",
- "description": "Path of the file"
- },
- "templatePath": {
- "type": "string",
- "default": "",
- "description": "Name of the template"
- },
- "templateType": {
- "type": "string",
- "default": "user",
- "description": "Type of the template"
- },
- "templateFields": {
- "type": "array",
- "default": [],
- "description": "Fields of the template",
- "items": {
- "$ref": "#/components/schemas/TemplateField"
- }
- }
- }
- }
- }
- }
- },
- "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": "Template created 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/TemplateFile"
- }
- }
- }
- }
- }
- }
- }
- },
- "403": {
- "description": "Creating template is not allowed",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/apps/files/api/v1/templates/path": {
- "post": {
- "operationId": "template-path",
- "summary": "Initialize the template directory",
- "tags": [
- "template"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "requestBody": {
- "required": false,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "templatePath": {
- "type": "string",
- "default": "",
- "description": "Path of the template directory"
- },
- "copySystemTemplates": {
- "type": "boolean",
- "default": false,
- "description": "Whether to copy the system templates to the template directory"
- }
- }
- }
- }
- }
- },
- "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": "Template directory initialized successfully",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "template_path",
- "templates"
- ],
- "properties": {
- "template_path": {
- "type": "string"
- },
- "templates": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/TemplateFileCreator"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "403": {
- "description": "Initializing the template directory is not allowed",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/apps/files/api/v1/transferownership": {
- "post": {
- "operationId": "transfer_ownership-transfer",
- "summary": "Transfer the ownership to another user",
- "tags": [
- "transfer_ownership"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "recipient",
- "path"
- ],
- "properties": {
- "recipient": {
- "type": "string",
- "description": "Username of the recipient"
- },
- "path": {
- "type": "string",
- "description": "Path of the file"
- }
- }
- }
- }
- }
- },
- "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": "Ownership transferred successfully",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- },
- "400": {
- "description": "Transferring ownership is not possible",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- },
- "403": {
- "description": "Transferring ownership is not allowed",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/apps/files/api/v1/transferownership/{id}": {
- "post": {
- "operationId": "transfer_ownership-accept",
- "summary": "Accept an ownership transfer",
- "tags": [
- "transfer_ownership"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "id",
- "in": "path",
- "description": "ID of the ownership transfer",
- "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": "Ownership transfer accepted successfully",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- },
- "403": {
- "description": "Accepting ownership transfer is not allowed",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "Ownership transfer not found",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "delete": {
- "operationId": "transfer_ownership-reject",
- "summary": "Reject an ownership transfer",
- "tags": [
- "transfer_ownership"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "id",
- "in": "path",
- "description": "ID of the ownership transfer",
- "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": "Ownership transfer rejected successfully",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- },
- "403": {
- "description": "Rejecting ownership transfer is not allowed",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "Ownership transfer not found",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/apps/files/api/v1/openlocaleditor": {
- "post": {
- "operationId": "open_local_editor-create",
- "summary": "Create a local editor",
- "tags": [
- "open_local_editor"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "path"
- ],
- "properties": {
- "path": {
- "type": "string",
- "description": "Path of the file"
- }
- }
- }
- }
- }
- },
- "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": "Local editor returned",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "userId",
- "pathHash",
- "expirationTime",
- "token"
- ],
- "properties": {
- "userId": {
- "type": "string",
- "nullable": true
- },
- "pathHash": {
- "type": "string"
- },
- "expirationTime": {
- "type": "integer",
- "format": "int64"
- },
- "token": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "500": {
- "description": "",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/apps/files/api/v1/openlocaleditor/{token}": {
- "post": {
- "operationId": "open_local_editor-validate",
- "summary": "Validate a local editor",
- "tags": [
- "open_local_editor"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "path"
- ],
- "properties": {
- "path": {
- "type": "string",
- "description": "Path of the file"
- }
- }
- }
- }
- }
- },
- "parameters": [
- {
- "name": "token",
- "in": "path",
- "description": "Token of the local editor",
- "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": "Local editor validated successfully",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {
- "type": "object",
- "required": [
- "userId",
- "pathHash",
- "expirationTime",
- "token"
- ],
- "properties": {
- "userId": {
- "type": "string"
- },
- "pathHash": {
- "type": "string"
- },
- "expirationTime": {
- "type": "integer",
- "format": "int64"
- },
- "token": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "Local editor not found",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "ocs"
- ],
- "properties": {
- "ocs": {
- "type": "object",
- "required": [
- "meta",
- "data"
- ],
- "properties": {
- "meta": {
- "$ref": "#/components/schemas/OCSMeta"
- },
- "data": {}
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "/ocs/v2.php/apps/files/api/v1/folder-tree": {
- "get": {
- "operationId": "api-get-folder-tree",
- "summary": "Returns the folder tree of the user",
- "tags": [
- "api"
- ],
- "security": [
- {
- "bearer_auth": []
- },
- {
- "basic_auth": []
- }
- ],
- "parameters": [
- {
- "name": "path",
- "in": "query",
- "description": "The path relative to the user folder",
- "schema": {
- "type": "string",
- "default": "/"
- }
- },
- {
- "name": "depth",
- "in": "query",
- "description": "The depth of the tree",
- "schema": {
- "type": "integer",
- "format": "int64",
- "default": 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": "Folder tree returned successfully",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/FolderTree"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- },
- "400": {
- "description": "Invalid folder path",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "Folder not found",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "required": [
- "message"
- ],
- "properties": {
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "tags": []
- }
|