openapi.json 214 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165
  1. {
  2. "openapi": "3.0.3",
  3. "info": {
  4. "title": "core",
  5. "version": "0.0.1",
  6. "description": "Core functionality of Nextcloud",
  7. "license": {
  8. "name": "agpl"
  9. }
  10. },
  11. "components": {
  12. "securitySchemes": {
  13. "basic_auth": {
  14. "type": "http",
  15. "scheme": "basic"
  16. },
  17. "bearer_auth": {
  18. "type": "http",
  19. "scheme": "bearer"
  20. }
  21. },
  22. "schemas": {
  23. "AutocompleteResult": {
  24. "type": "object",
  25. "required": [
  26. "id",
  27. "label",
  28. "icon",
  29. "source",
  30. "status",
  31. "subline",
  32. "shareWithDisplayNameUnique"
  33. ],
  34. "properties": {
  35. "id": {
  36. "type": "string"
  37. },
  38. "label": {
  39. "type": "string"
  40. },
  41. "icon": {
  42. "type": "string"
  43. },
  44. "source": {
  45. "type": "string"
  46. },
  47. "status": {
  48. "oneOf": [
  49. {
  50. "type": "object",
  51. "required": [
  52. "status",
  53. "message",
  54. "icon",
  55. "clearAt"
  56. ],
  57. "properties": {
  58. "status": {
  59. "type": "string"
  60. },
  61. "message": {
  62. "type": "string",
  63. "nullable": true
  64. },
  65. "icon": {
  66. "type": "string",
  67. "nullable": true
  68. },
  69. "clearAt": {
  70. "type": "integer",
  71. "format": "int64",
  72. "nullable": true
  73. }
  74. }
  75. },
  76. {
  77. "type": "string"
  78. }
  79. ]
  80. },
  81. "subline": {
  82. "type": "string"
  83. },
  84. "shareWithDisplayNameUnique": {
  85. "type": "string"
  86. }
  87. }
  88. },
  89. "Collection": {
  90. "type": "object",
  91. "required": [
  92. "id",
  93. "name",
  94. "resources"
  95. ],
  96. "properties": {
  97. "id": {
  98. "type": "integer",
  99. "format": "int64"
  100. },
  101. "name": {
  102. "type": "string"
  103. },
  104. "resources": {
  105. "type": "array",
  106. "items": {
  107. "$ref": "#/components/schemas/Resource"
  108. }
  109. }
  110. }
  111. },
  112. "ContactsAction": {
  113. "type": "object",
  114. "required": [
  115. "title",
  116. "icon",
  117. "hyperlink",
  118. "appId"
  119. ],
  120. "properties": {
  121. "title": {
  122. "type": "string"
  123. },
  124. "icon": {
  125. "type": "string"
  126. },
  127. "hyperlink": {
  128. "type": "string"
  129. },
  130. "appId": {
  131. "type": "string"
  132. }
  133. }
  134. },
  135. "LoginFlowV2": {
  136. "type": "object",
  137. "required": [
  138. "poll",
  139. "login"
  140. ],
  141. "properties": {
  142. "poll": {
  143. "type": "object",
  144. "required": [
  145. "token",
  146. "endpoint"
  147. ],
  148. "properties": {
  149. "token": {
  150. "type": "string"
  151. },
  152. "endpoint": {
  153. "type": "string"
  154. }
  155. }
  156. },
  157. "login": {
  158. "type": "string"
  159. }
  160. }
  161. },
  162. "LoginFlowV2Credentials": {
  163. "type": "object",
  164. "required": [
  165. "server",
  166. "loginName",
  167. "appPassword"
  168. ],
  169. "properties": {
  170. "server": {
  171. "type": "string"
  172. },
  173. "loginName": {
  174. "type": "string"
  175. },
  176. "appPassword": {
  177. "type": "string"
  178. }
  179. }
  180. },
  181. "NavigationEntry": {
  182. "type": "object",
  183. "required": [
  184. "id",
  185. "order",
  186. "href",
  187. "icon",
  188. "type",
  189. "name",
  190. "active",
  191. "classes",
  192. "unread"
  193. ],
  194. "properties": {
  195. "id": {
  196. "type": "string"
  197. },
  198. "order": {
  199. "oneOf": [
  200. {
  201. "type": "integer",
  202. "format": "int64"
  203. },
  204. {
  205. "type": "string"
  206. }
  207. ]
  208. },
  209. "href": {
  210. "type": "string"
  211. },
  212. "icon": {
  213. "type": "string"
  214. },
  215. "type": {
  216. "type": "string"
  217. },
  218. "name": {
  219. "type": "string"
  220. },
  221. "active": {
  222. "type": "boolean"
  223. },
  224. "classes": {
  225. "type": "string"
  226. },
  227. "unread": {
  228. "type": "integer",
  229. "format": "int64"
  230. }
  231. }
  232. },
  233. "OCSMeta": {
  234. "type": "object",
  235. "required": [
  236. "status",
  237. "statuscode"
  238. ],
  239. "properties": {
  240. "status": {
  241. "type": "string"
  242. },
  243. "statuscode": {
  244. "type": "integer"
  245. },
  246. "message": {
  247. "type": "string"
  248. },
  249. "totalitems": {
  250. "type": "string"
  251. },
  252. "itemsperpage": {
  253. "type": "string"
  254. }
  255. }
  256. },
  257. "OpenGraphObject": {
  258. "type": "object",
  259. "required": [
  260. "id",
  261. "name",
  262. "description",
  263. "thumb",
  264. "link"
  265. ],
  266. "properties": {
  267. "id": {
  268. "type": "string"
  269. },
  270. "name": {
  271. "type": "string"
  272. },
  273. "description": {
  274. "type": "string",
  275. "nullable": true
  276. },
  277. "thumb": {
  278. "type": "string",
  279. "nullable": true
  280. },
  281. "link": {
  282. "type": "string"
  283. }
  284. }
  285. },
  286. "Reference": {
  287. "type": "object",
  288. "required": [
  289. "richObjectType",
  290. "richObject",
  291. "openGraphObject",
  292. "accessible"
  293. ],
  294. "properties": {
  295. "richObjectType": {
  296. "type": "string"
  297. },
  298. "richObject": {
  299. "type": "object",
  300. "additionalProperties": {
  301. "type": "object"
  302. }
  303. },
  304. "openGraphObject": {
  305. "$ref": "#/components/schemas/OpenGraphObject"
  306. },
  307. "accessible": {
  308. "type": "boolean"
  309. }
  310. }
  311. },
  312. "ReferenceProvider": {
  313. "type": "object",
  314. "required": [
  315. "id",
  316. "title",
  317. "icon_url",
  318. "order",
  319. "search_providers_ids"
  320. ],
  321. "properties": {
  322. "id": {
  323. "type": "string"
  324. },
  325. "title": {
  326. "type": "string"
  327. },
  328. "icon_url": {
  329. "type": "string"
  330. },
  331. "order": {
  332. "type": "integer",
  333. "format": "int64"
  334. },
  335. "search_providers_ids": {
  336. "type": "array",
  337. "nullable": true,
  338. "items": {
  339. "type": "string"
  340. }
  341. }
  342. }
  343. },
  344. "Resource": {
  345. "type": "object",
  346. "required": [
  347. "richObjectType",
  348. "richObject",
  349. "openGraphObject",
  350. "accessible"
  351. ],
  352. "properties": {
  353. "richObjectType": {
  354. "type": "string"
  355. },
  356. "richObject": {
  357. "type": "object",
  358. "additionalProperties": {
  359. "type": "object"
  360. }
  361. },
  362. "openGraphObject": {
  363. "$ref": "#/components/schemas/OpenGraphObject"
  364. },
  365. "accessible": {
  366. "type": "boolean"
  367. }
  368. }
  369. },
  370. "Status": {
  371. "type": "object",
  372. "required": [
  373. "installed",
  374. "maintenance",
  375. "needsDbUpgrade",
  376. "version",
  377. "versionstring",
  378. "edition",
  379. "productname",
  380. "extendedSupport"
  381. ],
  382. "properties": {
  383. "installed": {
  384. "type": "boolean"
  385. },
  386. "maintenance": {
  387. "type": "boolean"
  388. },
  389. "needsDbUpgrade": {
  390. "type": "boolean"
  391. },
  392. "version": {
  393. "type": "string"
  394. },
  395. "versionstring": {
  396. "type": "string"
  397. },
  398. "edition": {
  399. "type": "string"
  400. },
  401. "productname": {
  402. "type": "string"
  403. },
  404. "extendedSupport": {
  405. "type": "boolean"
  406. }
  407. }
  408. },
  409. "TextProcessingTask": {
  410. "type": "object",
  411. "required": [
  412. "id",
  413. "type",
  414. "status",
  415. "userId",
  416. "appId",
  417. "input",
  418. "output",
  419. "identifier"
  420. ],
  421. "properties": {
  422. "id": {
  423. "type": "integer",
  424. "format": "int64",
  425. "nullable": true
  426. },
  427. "type": {
  428. "type": "string"
  429. },
  430. "status": {
  431. "type": "integer",
  432. "format": "int64"
  433. },
  434. "userId": {
  435. "type": "string",
  436. "nullable": true
  437. },
  438. "appId": {
  439. "type": "string"
  440. },
  441. "input": {
  442. "type": "string"
  443. },
  444. "output": {
  445. "type": "string",
  446. "nullable": true
  447. },
  448. "identifier": {
  449. "type": "string"
  450. }
  451. }
  452. },
  453. "UnifiedSearchProvider": {
  454. "type": "object",
  455. "required": [
  456. "id",
  457. "name",
  458. "order"
  459. ],
  460. "properties": {
  461. "id": {
  462. "type": "string"
  463. },
  464. "name": {
  465. "type": "string"
  466. },
  467. "order": {
  468. "type": "integer",
  469. "format": "int64"
  470. }
  471. }
  472. },
  473. "UnifiedSearchResult": {
  474. "type": "object",
  475. "required": [
  476. "name",
  477. "isPaginated",
  478. "entries",
  479. "cursor"
  480. ],
  481. "properties": {
  482. "name": {
  483. "type": "string"
  484. },
  485. "isPaginated": {
  486. "type": "boolean"
  487. },
  488. "entries": {
  489. "type": "array",
  490. "items": {
  491. "$ref": "#/components/schemas/UnifiedSearchResultEntry"
  492. }
  493. },
  494. "cursor": {
  495. "nullable": true,
  496. "oneOf": [
  497. {
  498. "type": "integer",
  499. "format": "int64"
  500. },
  501. {
  502. "type": "string"
  503. }
  504. ]
  505. }
  506. }
  507. },
  508. "UnifiedSearchResultEntry": {
  509. "type": "object",
  510. "required": [
  511. "thumbnailUrl",
  512. "title",
  513. "subline",
  514. "resourceUrl",
  515. "icon",
  516. "rounded",
  517. "attributes"
  518. ],
  519. "properties": {
  520. "thumbnailUrl": {
  521. "type": "string"
  522. },
  523. "title": {
  524. "type": "string"
  525. },
  526. "subline": {
  527. "type": "string"
  528. },
  529. "resourceUrl": {
  530. "type": "string"
  531. },
  532. "icon": {
  533. "type": "string"
  534. },
  535. "rounded": {
  536. "type": "boolean"
  537. },
  538. "attributes": {
  539. "type": "array",
  540. "items": {
  541. "type": "string"
  542. }
  543. }
  544. }
  545. }
  546. }
  547. },
  548. "paths": {
  549. "/index.php/avatar/{userId}/{size}/dark": {
  550. "get": {
  551. "operationId": "avatar-get-avatar-dark",
  552. "summary": "Get the dark avatar",
  553. "tags": [
  554. "avatar"
  555. ],
  556. "security": [
  557. {},
  558. {
  559. "bearer_auth": []
  560. },
  561. {
  562. "basic_auth": []
  563. }
  564. ],
  565. "parameters": [
  566. {
  567. "name": "userId",
  568. "in": "path",
  569. "description": "ID of the user",
  570. "required": true,
  571. "schema": {
  572. "type": "string"
  573. }
  574. },
  575. {
  576. "name": "size",
  577. "in": "path",
  578. "description": "Size of the avatar",
  579. "required": true,
  580. "schema": {
  581. "type": "integer",
  582. "format": "int64"
  583. }
  584. }
  585. ],
  586. "responses": {
  587. "200": {
  588. "description": "Avatar returned",
  589. "headers": {
  590. "X-NC-IsCustomAvatar": {
  591. "schema": {
  592. "type": "integer",
  593. "format": "int64"
  594. }
  595. }
  596. },
  597. "content": {
  598. "*/*": {
  599. "schema": {
  600. "type": "string",
  601. "format": "binary"
  602. }
  603. }
  604. }
  605. },
  606. "404": {
  607. "description": "Avatar not found",
  608. "content": {
  609. "application/json": {
  610. "schema": {}
  611. }
  612. }
  613. }
  614. }
  615. }
  616. },
  617. "/index.php/avatar/{userId}/{size}": {
  618. "get": {
  619. "operationId": "avatar-get-avatar",
  620. "summary": "Get the avatar",
  621. "tags": [
  622. "avatar"
  623. ],
  624. "security": [
  625. {},
  626. {
  627. "bearer_auth": []
  628. },
  629. {
  630. "basic_auth": []
  631. }
  632. ],
  633. "parameters": [
  634. {
  635. "name": "userId",
  636. "in": "path",
  637. "description": "ID of the user",
  638. "required": true,
  639. "schema": {
  640. "type": "string"
  641. }
  642. },
  643. {
  644. "name": "size",
  645. "in": "path",
  646. "description": "Size of the avatar",
  647. "required": true,
  648. "schema": {
  649. "type": "integer",
  650. "format": "int64"
  651. }
  652. }
  653. ],
  654. "responses": {
  655. "200": {
  656. "description": "Avatar returned",
  657. "headers": {
  658. "X-NC-IsCustomAvatar": {
  659. "schema": {
  660. "type": "integer",
  661. "format": "int64"
  662. }
  663. }
  664. },
  665. "content": {
  666. "*/*": {
  667. "schema": {
  668. "type": "string",
  669. "format": "binary"
  670. }
  671. }
  672. }
  673. },
  674. "404": {
  675. "description": "Avatar not found",
  676. "content": {
  677. "application/json": {
  678. "schema": {}
  679. }
  680. }
  681. }
  682. }
  683. }
  684. },
  685. "/index.php/avatar/guest/{guestName}/{size}/dark": {
  686. "get": {
  687. "operationId": "guest_avatar-get-avatar-dark",
  688. "summary": "Returns a dark guest avatar image response",
  689. "tags": [
  690. "guest_avatar"
  691. ],
  692. "security": [
  693. {},
  694. {
  695. "bearer_auth": []
  696. },
  697. {
  698. "basic_auth": []
  699. }
  700. ],
  701. "parameters": [
  702. {
  703. "name": "guestName",
  704. "in": "path",
  705. "description": "The guest name, e.g. \"Albert\"",
  706. "required": true,
  707. "schema": {
  708. "type": "string"
  709. }
  710. },
  711. {
  712. "name": "size",
  713. "in": "path",
  714. "description": "The desired avatar size, e.g. 64 for 64x64px",
  715. "required": true,
  716. "schema": {
  717. "type": "string"
  718. }
  719. }
  720. ],
  721. "responses": {
  722. "200": {
  723. "description": "Custom avatar returned",
  724. "content": {
  725. "*/*": {
  726. "schema": {
  727. "type": "string",
  728. "format": "binary"
  729. }
  730. }
  731. }
  732. },
  733. "201": {
  734. "description": "Avatar returned",
  735. "content": {
  736. "*/*": {
  737. "schema": {
  738. "type": "string",
  739. "format": "binary"
  740. }
  741. }
  742. }
  743. },
  744. "500": {
  745. "description": ""
  746. }
  747. }
  748. }
  749. },
  750. "/index.php/avatar/guest/{guestName}/{size}": {
  751. "get": {
  752. "operationId": "guest_avatar-get-avatar",
  753. "summary": "Returns a guest avatar image response",
  754. "tags": [
  755. "guest_avatar"
  756. ],
  757. "security": [
  758. {},
  759. {
  760. "bearer_auth": []
  761. },
  762. {
  763. "basic_auth": []
  764. }
  765. ],
  766. "parameters": [
  767. {
  768. "name": "darkTheme",
  769. "in": "query",
  770. "description": "Return dark avatar",
  771. "schema": {
  772. "type": "integer",
  773. "nullable": true,
  774. "default": 0
  775. }
  776. },
  777. {
  778. "name": "guestName",
  779. "in": "path",
  780. "description": "The guest name, e.g. \"Albert\"",
  781. "required": true,
  782. "schema": {
  783. "type": "string"
  784. }
  785. },
  786. {
  787. "name": "size",
  788. "in": "path",
  789. "description": "The desired avatar size, e.g. 64 for 64x64px",
  790. "required": true,
  791. "schema": {
  792. "type": "string"
  793. }
  794. }
  795. ],
  796. "responses": {
  797. "200": {
  798. "description": "Custom avatar returned",
  799. "content": {
  800. "*/*": {
  801. "schema": {
  802. "type": "string",
  803. "format": "binary"
  804. }
  805. }
  806. }
  807. },
  808. "201": {
  809. "description": "Avatar returned",
  810. "content": {
  811. "*/*": {
  812. "schema": {
  813. "type": "string",
  814. "format": "binary"
  815. }
  816. }
  817. }
  818. },
  819. "500": {
  820. "description": ""
  821. }
  822. }
  823. }
  824. },
  825. "/index.php/login/v2/poll": {
  826. "post": {
  827. "operationId": "client_flow_login_v2-poll",
  828. "summary": "Poll the login flow credentials",
  829. "tags": [
  830. "client_flow_login_v2"
  831. ],
  832. "security": [
  833. {},
  834. {
  835. "bearer_auth": []
  836. },
  837. {
  838. "basic_auth": []
  839. }
  840. ],
  841. "parameters": [
  842. {
  843. "name": "token",
  844. "in": "query",
  845. "description": "Token of the flow",
  846. "required": true,
  847. "schema": {
  848. "type": "string"
  849. }
  850. }
  851. ],
  852. "responses": {
  853. "200": {
  854. "description": "Login flow credentials returned",
  855. "content": {
  856. "application/json": {
  857. "schema": {
  858. "$ref": "#/components/schemas/LoginFlowV2Credentials"
  859. }
  860. }
  861. }
  862. },
  863. "404": {
  864. "description": "Login flow not found or completed",
  865. "content": {
  866. "application/json": {
  867. "schema": {}
  868. }
  869. }
  870. }
  871. }
  872. }
  873. },
  874. "/index.php/login/v2": {
  875. "post": {
  876. "operationId": "client_flow_login_v2-init",
  877. "summary": "Init a login flow",
  878. "tags": [
  879. "client_flow_login_v2"
  880. ],
  881. "security": [
  882. {},
  883. {
  884. "bearer_auth": []
  885. },
  886. {
  887. "basic_auth": []
  888. }
  889. ],
  890. "responses": {
  891. "200": {
  892. "description": "Login flow init returned",
  893. "content": {
  894. "application/json": {
  895. "schema": {
  896. "$ref": "#/components/schemas/LoginFlowV2"
  897. }
  898. }
  899. }
  900. }
  901. }
  902. }
  903. },
  904. "/index.php/core/preview": {
  905. "get": {
  906. "operationId": "preview-get-preview-by-file-id",
  907. "summary": "Get a preview by file ID",
  908. "tags": [
  909. "preview"
  910. ],
  911. "security": [
  912. {
  913. "bearer_auth": []
  914. },
  915. {
  916. "basic_auth": []
  917. }
  918. ],
  919. "parameters": [
  920. {
  921. "name": "fileId",
  922. "in": "query",
  923. "description": "ID of the file",
  924. "schema": {
  925. "type": "integer",
  926. "format": "int64",
  927. "default": -1
  928. }
  929. },
  930. {
  931. "name": "x",
  932. "in": "query",
  933. "description": "Width of the preview",
  934. "schema": {
  935. "type": "integer",
  936. "format": "int64",
  937. "default": 32
  938. }
  939. },
  940. {
  941. "name": "y",
  942. "in": "query",
  943. "description": "Height of the preview",
  944. "schema": {
  945. "type": "integer",
  946. "format": "int64",
  947. "default": 32
  948. }
  949. },
  950. {
  951. "name": "a",
  952. "in": "query",
  953. "description": "Whether to not crop the preview",
  954. "schema": {
  955. "type": "integer",
  956. "default": 0
  957. }
  958. },
  959. {
  960. "name": "forceIcon",
  961. "in": "query",
  962. "description": "Force returning an icon",
  963. "schema": {
  964. "type": "integer",
  965. "default": 1
  966. }
  967. },
  968. {
  969. "name": "mode",
  970. "in": "query",
  971. "description": "How to crop the image",
  972. "schema": {
  973. "type": "string",
  974. "default": "fill"
  975. }
  976. },
  977. {
  978. "name": "mimeFallback",
  979. "in": "query",
  980. "description": "Whether to fallback to the mime icon if no preview is available",
  981. "schema": {
  982. "type": "integer",
  983. "default": 0
  984. }
  985. }
  986. ],
  987. "responses": {
  988. "200": {
  989. "description": "Preview returned",
  990. "content": {
  991. "*/*": {
  992. "schema": {
  993. "type": "string",
  994. "format": "binary"
  995. }
  996. }
  997. }
  998. },
  999. "400": {
  1000. "description": "Getting preview is not possible",
  1001. "content": {
  1002. "application/json": {
  1003. "schema": {}
  1004. }
  1005. }
  1006. },
  1007. "403": {
  1008. "description": "Getting preview is not allowed",
  1009. "content": {
  1010. "application/json": {
  1011. "schema": {}
  1012. }
  1013. }
  1014. },
  1015. "404": {
  1016. "description": "Preview not found",
  1017. "content": {
  1018. "application/json": {
  1019. "schema": {}
  1020. }
  1021. }
  1022. },
  1023. "303": {
  1024. "description": "Redirect to the mime icon url if mimeFallback is true",
  1025. "headers": {
  1026. "Location": {
  1027. "schema": {
  1028. "type": "string"
  1029. }
  1030. }
  1031. }
  1032. }
  1033. }
  1034. }
  1035. },
  1036. "/index.php/core/preview.png": {
  1037. "get": {
  1038. "operationId": "preview-get-preview",
  1039. "summary": "Get a preview by file path",
  1040. "tags": [
  1041. "preview"
  1042. ],
  1043. "security": [
  1044. {
  1045. "bearer_auth": []
  1046. },
  1047. {
  1048. "basic_auth": []
  1049. }
  1050. ],
  1051. "parameters": [
  1052. {
  1053. "name": "file",
  1054. "in": "query",
  1055. "description": "Path of the file",
  1056. "schema": {
  1057. "type": "string",
  1058. "default": ""
  1059. }
  1060. },
  1061. {
  1062. "name": "x",
  1063. "in": "query",
  1064. "description": "Width of the preview",
  1065. "schema": {
  1066. "type": "integer",
  1067. "format": "int64",
  1068. "default": 32
  1069. }
  1070. },
  1071. {
  1072. "name": "y",
  1073. "in": "query",
  1074. "description": "Height of the preview",
  1075. "schema": {
  1076. "type": "integer",
  1077. "format": "int64",
  1078. "default": 32
  1079. }
  1080. },
  1081. {
  1082. "name": "a",
  1083. "in": "query",
  1084. "description": "Whether to not crop the preview",
  1085. "schema": {
  1086. "type": "integer",
  1087. "default": 0
  1088. }
  1089. },
  1090. {
  1091. "name": "forceIcon",
  1092. "in": "query",
  1093. "description": "Force returning an icon",
  1094. "schema": {
  1095. "type": "integer",
  1096. "default": 1
  1097. }
  1098. },
  1099. {
  1100. "name": "mode",
  1101. "in": "query",
  1102. "description": "How to crop the image",
  1103. "schema": {
  1104. "type": "string",
  1105. "default": "fill"
  1106. }
  1107. },
  1108. {
  1109. "name": "mimeFallback",
  1110. "in": "query",
  1111. "description": "Whether to fallback to the mime icon if no preview is available",
  1112. "schema": {
  1113. "type": "integer",
  1114. "default": 0
  1115. }
  1116. }
  1117. ],
  1118. "responses": {
  1119. "200": {
  1120. "description": "Preview returned",
  1121. "content": {
  1122. "*/*": {
  1123. "schema": {
  1124. "type": "string",
  1125. "format": "binary"
  1126. }
  1127. }
  1128. }
  1129. },
  1130. "400": {
  1131. "description": "Getting preview is not possible",
  1132. "content": {
  1133. "application/json": {
  1134. "schema": {}
  1135. }
  1136. }
  1137. },
  1138. "403": {
  1139. "description": "Getting preview is not allowed",
  1140. "content": {
  1141. "application/json": {
  1142. "schema": {}
  1143. }
  1144. }
  1145. },
  1146. "404": {
  1147. "description": "Preview not found",
  1148. "content": {
  1149. "application/json": {
  1150. "schema": {}
  1151. }
  1152. }
  1153. },
  1154. "303": {
  1155. "description": "Redirect to the mime icon url if mimeFallback is true",
  1156. "headers": {
  1157. "Location": {
  1158. "schema": {
  1159. "type": "string"
  1160. }
  1161. }
  1162. }
  1163. }
  1164. }
  1165. }
  1166. },
  1167. "/index.php/core/references/preview/{referenceId}": {
  1168. "get": {
  1169. "operationId": "reference-preview",
  1170. "summary": "Get a preview for a reference",
  1171. "tags": [
  1172. "reference"
  1173. ],
  1174. "security": [
  1175. {},
  1176. {
  1177. "bearer_auth": []
  1178. },
  1179. {
  1180. "basic_auth": []
  1181. }
  1182. ],
  1183. "parameters": [
  1184. {
  1185. "name": "referenceId",
  1186. "in": "path",
  1187. "description": "the reference cache key",
  1188. "required": true,
  1189. "schema": {
  1190. "type": "string"
  1191. }
  1192. }
  1193. ],
  1194. "responses": {
  1195. "200": {
  1196. "description": "Preview returned",
  1197. "content": {
  1198. "*/*": {
  1199. "schema": {
  1200. "type": "string",
  1201. "format": "binary"
  1202. }
  1203. }
  1204. }
  1205. },
  1206. "404": {
  1207. "description": "Reference not found",
  1208. "content": {
  1209. "application/json": {
  1210. "schema": {
  1211. "type": "string"
  1212. }
  1213. }
  1214. }
  1215. }
  1216. }
  1217. }
  1218. },
  1219. "/index.php/core/wipe/check": {
  1220. "post": {
  1221. "operationId": "wipe-check-wipe",
  1222. "summary": "Check if the device should be wiped",
  1223. "tags": [
  1224. "wipe"
  1225. ],
  1226. "security": [
  1227. {},
  1228. {
  1229. "bearer_auth": []
  1230. },
  1231. {
  1232. "basic_auth": []
  1233. }
  1234. ],
  1235. "parameters": [
  1236. {
  1237. "name": "token",
  1238. "in": "query",
  1239. "description": "App password",
  1240. "required": true,
  1241. "schema": {
  1242. "type": "string"
  1243. }
  1244. }
  1245. ],
  1246. "responses": {
  1247. "200": {
  1248. "description": "Device should be wiped",
  1249. "content": {
  1250. "application/json": {
  1251. "schema": {
  1252. "type": "object",
  1253. "required": [
  1254. "wipe"
  1255. ],
  1256. "properties": {
  1257. "wipe": {
  1258. "type": "boolean"
  1259. }
  1260. }
  1261. }
  1262. }
  1263. }
  1264. },
  1265. "404": {
  1266. "description": "Device should not be wiped",
  1267. "content": {
  1268. "application/json": {
  1269. "schema": {}
  1270. }
  1271. }
  1272. }
  1273. }
  1274. }
  1275. },
  1276. "/index.php/core/wipe/success": {
  1277. "post": {
  1278. "operationId": "wipe-wipe-done",
  1279. "summary": "Finish the wipe",
  1280. "tags": [
  1281. "wipe"
  1282. ],
  1283. "security": [
  1284. {},
  1285. {
  1286. "bearer_auth": []
  1287. },
  1288. {
  1289. "basic_auth": []
  1290. }
  1291. ],
  1292. "parameters": [
  1293. {
  1294. "name": "token",
  1295. "in": "query",
  1296. "description": "App password",
  1297. "required": true,
  1298. "schema": {
  1299. "type": "string"
  1300. }
  1301. }
  1302. ],
  1303. "responses": {
  1304. "200": {
  1305. "description": "Wipe finished successfully",
  1306. "content": {
  1307. "application/json": {
  1308. "schema": {}
  1309. }
  1310. }
  1311. },
  1312. "404": {
  1313. "description": "Device should not be wiped",
  1314. "content": {
  1315. "application/json": {
  1316. "schema": {}
  1317. }
  1318. }
  1319. }
  1320. }
  1321. }
  1322. },
  1323. "/index.php/ocm-provider": {
  1324. "get": {
  1325. "operationId": "ocm-discovery",
  1326. "summary": "generate a OCMProvider with local data and send it as DataResponse. This replaces the old PHP file ocm-provider/index.php",
  1327. "tags": [
  1328. "ocm"
  1329. ],
  1330. "security": [
  1331. {},
  1332. {
  1333. "bearer_auth": []
  1334. },
  1335. {
  1336. "basic_auth": []
  1337. }
  1338. ],
  1339. "responses": {
  1340. "200": {
  1341. "description": "OCM Provider details returned",
  1342. "headers": {
  1343. "X-NEXTCLOUD-OCM-PROVIDERS": {
  1344. "schema": {
  1345. "type": "boolean"
  1346. }
  1347. }
  1348. },
  1349. "content": {
  1350. "application/json": {
  1351. "schema": {
  1352. "type": "object",
  1353. "required": [
  1354. "enabled",
  1355. "apiVersion",
  1356. "endPoint",
  1357. "resourceTypes"
  1358. ],
  1359. "properties": {
  1360. "enabled": {
  1361. "type": "boolean"
  1362. },
  1363. "apiVersion": {
  1364. "type": "string"
  1365. },
  1366. "endPoint": {
  1367. "type": "string"
  1368. },
  1369. "resourceTypes": {
  1370. "type": "array",
  1371. "items": {
  1372. "type": "object",
  1373. "required": [
  1374. "name",
  1375. "shareTypes",
  1376. "protocols"
  1377. ],
  1378. "properties": {
  1379. "name": {
  1380. "type": "string"
  1381. },
  1382. "shareTypes": {
  1383. "type": "array",
  1384. "items": {
  1385. "type": "string"
  1386. }
  1387. },
  1388. "protocols": {
  1389. "type": "object",
  1390. "required": [
  1391. "webdav"
  1392. ],
  1393. "properties": {
  1394. "webdav": {
  1395. "type": "string"
  1396. }
  1397. }
  1398. }
  1399. }
  1400. }
  1401. }
  1402. }
  1403. }
  1404. }
  1405. }
  1406. },
  1407. "500": {
  1408. "description": "OCM not supported",
  1409. "content": {
  1410. "application/json": {
  1411. "schema": {
  1412. "type": "object",
  1413. "required": [
  1414. "message"
  1415. ],
  1416. "properties": {
  1417. "message": {
  1418. "type": "string"
  1419. }
  1420. }
  1421. }
  1422. }
  1423. }
  1424. }
  1425. }
  1426. }
  1427. },
  1428. "/ocs/v2.php/cloud/capabilities": {
  1429. "get": {
  1430. "operationId": "ocs-get-capabilities",
  1431. "summary": "Get the capabilities",
  1432. "tags": [
  1433. "ocs"
  1434. ],
  1435. "security": [
  1436. {},
  1437. {
  1438. "bearer_auth": []
  1439. },
  1440. {
  1441. "basic_auth": []
  1442. }
  1443. ],
  1444. "parameters": [
  1445. {
  1446. "name": "OCS-APIRequest",
  1447. "in": "header",
  1448. "description": "Required to be true for the API request to pass",
  1449. "required": true,
  1450. "schema": {
  1451. "type": "boolean",
  1452. "default": true
  1453. }
  1454. }
  1455. ],
  1456. "responses": {
  1457. "200": {
  1458. "description": "Capabilities returned",
  1459. "content": {
  1460. "application/json": {
  1461. "schema": {
  1462. "type": "object",
  1463. "required": [
  1464. "ocs"
  1465. ],
  1466. "properties": {
  1467. "ocs": {
  1468. "type": "object",
  1469. "required": [
  1470. "meta",
  1471. "data"
  1472. ],
  1473. "properties": {
  1474. "meta": {
  1475. "$ref": "#/components/schemas/OCSMeta"
  1476. },
  1477. "data": {
  1478. "type": "object",
  1479. "required": [
  1480. "version",
  1481. "capabilities"
  1482. ],
  1483. "properties": {
  1484. "version": {
  1485. "type": "object",
  1486. "required": [
  1487. "major",
  1488. "minor",
  1489. "micro",
  1490. "string",
  1491. "edition",
  1492. "extendedSupport"
  1493. ],
  1494. "properties": {
  1495. "major": {
  1496. "type": "integer",
  1497. "format": "int64"
  1498. },
  1499. "minor": {
  1500. "type": "integer",
  1501. "format": "int64"
  1502. },
  1503. "micro": {
  1504. "type": "integer",
  1505. "format": "int64"
  1506. },
  1507. "string": {
  1508. "type": "string"
  1509. },
  1510. "edition": {
  1511. "type": "string"
  1512. },
  1513. "extendedSupport": {
  1514. "type": "boolean"
  1515. }
  1516. }
  1517. },
  1518. "capabilities": {
  1519. "type": "object",
  1520. "additionalProperties": {
  1521. "type": "object"
  1522. }
  1523. }
  1524. }
  1525. }
  1526. }
  1527. }
  1528. }
  1529. }
  1530. }
  1531. }
  1532. }
  1533. }
  1534. }
  1535. },
  1536. "/ocs/v2.php/core/navigation/apps": {
  1537. "get": {
  1538. "operationId": "navigation-get-apps-navigation",
  1539. "summary": "Get the apps navigation",
  1540. "tags": [
  1541. "navigation"
  1542. ],
  1543. "security": [
  1544. {
  1545. "bearer_auth": []
  1546. },
  1547. {
  1548. "basic_auth": []
  1549. }
  1550. ],
  1551. "parameters": [
  1552. {
  1553. "name": "absolute",
  1554. "in": "query",
  1555. "description": "Rewrite URLs to absolute ones",
  1556. "schema": {
  1557. "type": "integer",
  1558. "default": 0
  1559. }
  1560. },
  1561. {
  1562. "name": "OCS-APIRequest",
  1563. "in": "header",
  1564. "description": "Required to be true for the API request to pass",
  1565. "required": true,
  1566. "schema": {
  1567. "type": "boolean",
  1568. "default": true
  1569. }
  1570. }
  1571. ],
  1572. "responses": {
  1573. "200": {
  1574. "description": "Apps navigation returned",
  1575. "content": {
  1576. "application/json": {
  1577. "schema": {
  1578. "type": "object",
  1579. "required": [
  1580. "ocs"
  1581. ],
  1582. "properties": {
  1583. "ocs": {
  1584. "type": "object",
  1585. "required": [
  1586. "meta",
  1587. "data"
  1588. ],
  1589. "properties": {
  1590. "meta": {
  1591. "$ref": "#/components/schemas/OCSMeta"
  1592. },
  1593. "data": {
  1594. "type": "array",
  1595. "items": {
  1596. "$ref": "#/components/schemas/NavigationEntry"
  1597. }
  1598. }
  1599. }
  1600. }
  1601. }
  1602. }
  1603. }
  1604. }
  1605. },
  1606. "304": {
  1607. "description": "No apps navigation changed",
  1608. "content": {
  1609. "application/json": {
  1610. "schema": {
  1611. "type": "object",
  1612. "required": [
  1613. "ocs"
  1614. ],
  1615. "properties": {
  1616. "ocs": {
  1617. "type": "object",
  1618. "required": [
  1619. "meta",
  1620. "data"
  1621. ],
  1622. "properties": {
  1623. "meta": {
  1624. "$ref": "#/components/schemas/OCSMeta"
  1625. },
  1626. "data": {}
  1627. }
  1628. }
  1629. }
  1630. }
  1631. }
  1632. }
  1633. }
  1634. }
  1635. }
  1636. },
  1637. "/ocs/v2.php/core/navigation/settings": {
  1638. "get": {
  1639. "operationId": "navigation-get-settings-navigation",
  1640. "summary": "Get the settings navigation",
  1641. "tags": [
  1642. "navigation"
  1643. ],
  1644. "security": [
  1645. {
  1646. "bearer_auth": []
  1647. },
  1648. {
  1649. "basic_auth": []
  1650. }
  1651. ],
  1652. "parameters": [
  1653. {
  1654. "name": "absolute",
  1655. "in": "query",
  1656. "description": "Rewrite URLs to absolute ones",
  1657. "schema": {
  1658. "type": "integer",
  1659. "default": 0
  1660. }
  1661. },
  1662. {
  1663. "name": "OCS-APIRequest",
  1664. "in": "header",
  1665. "description": "Required to be true for the API request to pass",
  1666. "required": true,
  1667. "schema": {
  1668. "type": "boolean",
  1669. "default": true
  1670. }
  1671. }
  1672. ],
  1673. "responses": {
  1674. "200": {
  1675. "description": "Apps navigation returned",
  1676. "content": {
  1677. "application/json": {
  1678. "schema": {
  1679. "type": "object",
  1680. "required": [
  1681. "ocs"
  1682. ],
  1683. "properties": {
  1684. "ocs": {
  1685. "type": "object",
  1686. "required": [
  1687. "meta",
  1688. "data"
  1689. ],
  1690. "properties": {
  1691. "meta": {
  1692. "$ref": "#/components/schemas/OCSMeta"
  1693. },
  1694. "data": {
  1695. "type": "array",
  1696. "items": {
  1697. "$ref": "#/components/schemas/NavigationEntry"
  1698. }
  1699. }
  1700. }
  1701. }
  1702. }
  1703. }
  1704. }
  1705. }
  1706. },
  1707. "304": {
  1708. "description": "No apps navigation changed",
  1709. "content": {
  1710. "application/json": {
  1711. "schema": {
  1712. "type": "object",
  1713. "required": [
  1714. "ocs"
  1715. ],
  1716. "properties": {
  1717. "ocs": {
  1718. "type": "object",
  1719. "required": [
  1720. "meta",
  1721. "data"
  1722. ],
  1723. "properties": {
  1724. "meta": {
  1725. "$ref": "#/components/schemas/OCSMeta"
  1726. },
  1727. "data": {}
  1728. }
  1729. }
  1730. }
  1731. }
  1732. }
  1733. }
  1734. }
  1735. }
  1736. }
  1737. },
  1738. "/ocs/v2.php/core/autocomplete/get": {
  1739. "get": {
  1740. "operationId": "auto_complete-get",
  1741. "summary": "Autocomplete a query",
  1742. "tags": [
  1743. "auto_complete"
  1744. ],
  1745. "security": [
  1746. {
  1747. "bearer_auth": []
  1748. },
  1749. {
  1750. "basic_auth": []
  1751. }
  1752. ],
  1753. "parameters": [
  1754. {
  1755. "name": "search",
  1756. "in": "query",
  1757. "description": "Text to search for",
  1758. "required": true,
  1759. "schema": {
  1760. "type": "string"
  1761. }
  1762. },
  1763. {
  1764. "name": "itemType",
  1765. "in": "query",
  1766. "description": "Type of the items to search for",
  1767. "schema": {
  1768. "type": "string",
  1769. "nullable": true
  1770. }
  1771. },
  1772. {
  1773. "name": "itemId",
  1774. "in": "query",
  1775. "description": "ID of the items to search for",
  1776. "schema": {
  1777. "type": "string",
  1778. "nullable": true
  1779. }
  1780. },
  1781. {
  1782. "name": "sorter",
  1783. "in": "query",
  1784. "description": "can be piped, top prio first, e.g.: \"commenters|share-recipients\"",
  1785. "schema": {
  1786. "type": "string",
  1787. "nullable": true
  1788. }
  1789. },
  1790. {
  1791. "name": "shareTypes[]",
  1792. "in": "query",
  1793. "description": "Types of shares to search for",
  1794. "schema": {
  1795. "type": "array",
  1796. "items": {
  1797. "type": "integer",
  1798. "format": "int64"
  1799. }
  1800. }
  1801. },
  1802. {
  1803. "name": "limit",
  1804. "in": "query",
  1805. "description": "Maximum number of results to return",
  1806. "schema": {
  1807. "type": "integer",
  1808. "format": "int64",
  1809. "default": 10
  1810. }
  1811. },
  1812. {
  1813. "name": "OCS-APIRequest",
  1814. "in": "header",
  1815. "description": "Required to be true for the API request to pass",
  1816. "required": true,
  1817. "schema": {
  1818. "type": "boolean",
  1819. "default": true
  1820. }
  1821. }
  1822. ],
  1823. "responses": {
  1824. "200": {
  1825. "description": "Autocomplete results returned",
  1826. "content": {
  1827. "application/json": {
  1828. "schema": {
  1829. "type": "object",
  1830. "required": [
  1831. "ocs"
  1832. ],
  1833. "properties": {
  1834. "ocs": {
  1835. "type": "object",
  1836. "required": [
  1837. "meta",
  1838. "data"
  1839. ],
  1840. "properties": {
  1841. "meta": {
  1842. "$ref": "#/components/schemas/OCSMeta"
  1843. },
  1844. "data": {
  1845. "type": "array",
  1846. "items": {
  1847. "$ref": "#/components/schemas/AutocompleteResult"
  1848. }
  1849. }
  1850. }
  1851. }
  1852. }
  1853. }
  1854. }
  1855. }
  1856. }
  1857. }
  1858. }
  1859. },
  1860. "/ocs/v2.php/core/whatsnew": {
  1861. "get": {
  1862. "operationId": "whats_new-get",
  1863. "summary": "Get the changes",
  1864. "tags": [
  1865. "whats_new"
  1866. ],
  1867. "security": [
  1868. {
  1869. "bearer_auth": []
  1870. },
  1871. {
  1872. "basic_auth": []
  1873. }
  1874. ],
  1875. "parameters": [
  1876. {
  1877. "name": "OCS-APIRequest",
  1878. "in": "header",
  1879. "description": "Required to be true for the API request to pass",
  1880. "required": true,
  1881. "schema": {
  1882. "type": "boolean",
  1883. "default": true
  1884. }
  1885. }
  1886. ],
  1887. "responses": {
  1888. "200": {
  1889. "description": "Changes returned",
  1890. "content": {
  1891. "application/json": {
  1892. "schema": {
  1893. "type": "object",
  1894. "required": [
  1895. "ocs"
  1896. ],
  1897. "properties": {
  1898. "ocs": {
  1899. "type": "object",
  1900. "required": [
  1901. "meta",
  1902. "data"
  1903. ],
  1904. "properties": {
  1905. "meta": {
  1906. "$ref": "#/components/schemas/OCSMeta"
  1907. },
  1908. "data": {
  1909. "type": "object",
  1910. "required": [
  1911. "changelogURL",
  1912. "product",
  1913. "version"
  1914. ],
  1915. "properties": {
  1916. "changelogURL": {
  1917. "type": "string"
  1918. },
  1919. "product": {
  1920. "type": "string"
  1921. },
  1922. "version": {
  1923. "type": "string"
  1924. },
  1925. "whatsNew": {
  1926. "type": "object",
  1927. "required": [
  1928. "regular",
  1929. "admin"
  1930. ],
  1931. "properties": {
  1932. "regular": {
  1933. "type": "array",
  1934. "items": {
  1935. "type": "string"
  1936. }
  1937. },
  1938. "admin": {
  1939. "type": "array",
  1940. "items": {
  1941. "type": "string"
  1942. }
  1943. }
  1944. }
  1945. }
  1946. }
  1947. }
  1948. }
  1949. }
  1950. }
  1951. }
  1952. }
  1953. }
  1954. },
  1955. "204": {
  1956. "description": "No changes",
  1957. "content": {
  1958. "application/json": {
  1959. "schema": {
  1960. "type": "object",
  1961. "required": [
  1962. "ocs"
  1963. ],
  1964. "properties": {
  1965. "ocs": {
  1966. "type": "object",
  1967. "required": [
  1968. "meta",
  1969. "data"
  1970. ],
  1971. "properties": {
  1972. "meta": {
  1973. "$ref": "#/components/schemas/OCSMeta"
  1974. },
  1975. "data": {}
  1976. }
  1977. }
  1978. }
  1979. }
  1980. }
  1981. }
  1982. }
  1983. }
  1984. },
  1985. "post": {
  1986. "operationId": "whats_new-dismiss",
  1987. "summary": "Dismiss the changes",
  1988. "tags": [
  1989. "whats_new"
  1990. ],
  1991. "security": [
  1992. {
  1993. "bearer_auth": []
  1994. },
  1995. {
  1996. "basic_auth": []
  1997. }
  1998. ],
  1999. "parameters": [
  2000. {
  2001. "name": "version",
  2002. "in": "query",
  2003. "description": "Version to dismiss the changes for",
  2004. "required": true,
  2005. "schema": {
  2006. "type": "string"
  2007. }
  2008. },
  2009. {
  2010. "name": "OCS-APIRequest",
  2011. "in": "header",
  2012. "description": "Required to be true for the API request to pass",
  2013. "required": true,
  2014. "schema": {
  2015. "type": "boolean",
  2016. "default": true
  2017. }
  2018. }
  2019. ],
  2020. "responses": {
  2021. "200": {
  2022. "description": "Changes dismissed",
  2023. "content": {
  2024. "application/json": {
  2025. "schema": {
  2026. "type": "object",
  2027. "required": [
  2028. "ocs"
  2029. ],
  2030. "properties": {
  2031. "ocs": {
  2032. "type": "object",
  2033. "required": [
  2034. "meta",
  2035. "data"
  2036. ],
  2037. "properties": {
  2038. "meta": {
  2039. "$ref": "#/components/schemas/OCSMeta"
  2040. },
  2041. "data": {}
  2042. }
  2043. }
  2044. }
  2045. }
  2046. }
  2047. }
  2048. },
  2049. "500": {
  2050. "description": "",
  2051. "content": {
  2052. "text/plain": {
  2053. "schema": {
  2054. "type": "string"
  2055. }
  2056. }
  2057. }
  2058. }
  2059. }
  2060. }
  2061. },
  2062. "/ocs/v2.php/core/getapppassword": {
  2063. "get": {
  2064. "operationId": "app_password-get-app-password",
  2065. "summary": "Create app password",
  2066. "tags": [
  2067. "app_password"
  2068. ],
  2069. "security": [
  2070. {
  2071. "bearer_auth": []
  2072. },
  2073. {
  2074. "basic_auth": []
  2075. }
  2076. ],
  2077. "parameters": [
  2078. {
  2079. "name": "OCS-APIRequest",
  2080. "in": "header",
  2081. "description": "Required to be true for the API request to pass",
  2082. "required": true,
  2083. "schema": {
  2084. "type": "boolean",
  2085. "default": true
  2086. }
  2087. }
  2088. ],
  2089. "responses": {
  2090. "200": {
  2091. "description": "App password returned",
  2092. "content": {
  2093. "application/json": {
  2094. "schema": {
  2095. "type": "object",
  2096. "required": [
  2097. "ocs"
  2098. ],
  2099. "properties": {
  2100. "ocs": {
  2101. "type": "object",
  2102. "required": [
  2103. "meta",
  2104. "data"
  2105. ],
  2106. "properties": {
  2107. "meta": {
  2108. "$ref": "#/components/schemas/OCSMeta"
  2109. },
  2110. "data": {
  2111. "type": "object",
  2112. "required": [
  2113. "apppassword"
  2114. ],
  2115. "properties": {
  2116. "apppassword": {
  2117. "type": "string"
  2118. }
  2119. }
  2120. }
  2121. }
  2122. }
  2123. }
  2124. }
  2125. }
  2126. }
  2127. },
  2128. "403": {
  2129. "description": "Creating app password is not allowed",
  2130. "content": {
  2131. "text/plain": {
  2132. "schema": {
  2133. "type": "string"
  2134. }
  2135. }
  2136. }
  2137. }
  2138. }
  2139. }
  2140. },
  2141. "/ocs/v2.php/core/apppassword/rotate": {
  2142. "post": {
  2143. "operationId": "app_password-rotate-app-password",
  2144. "summary": "Rotate app password",
  2145. "tags": [
  2146. "app_password"
  2147. ],
  2148. "security": [
  2149. {
  2150. "bearer_auth": []
  2151. },
  2152. {
  2153. "basic_auth": []
  2154. }
  2155. ],
  2156. "parameters": [
  2157. {
  2158. "name": "OCS-APIRequest",
  2159. "in": "header",
  2160. "description": "Required to be true for the API request to pass",
  2161. "required": true,
  2162. "schema": {
  2163. "type": "boolean",
  2164. "default": true
  2165. }
  2166. }
  2167. ],
  2168. "responses": {
  2169. "200": {
  2170. "description": "App password returned",
  2171. "content": {
  2172. "application/json": {
  2173. "schema": {
  2174. "type": "object",
  2175. "required": [
  2176. "ocs"
  2177. ],
  2178. "properties": {
  2179. "ocs": {
  2180. "type": "object",
  2181. "required": [
  2182. "meta",
  2183. "data"
  2184. ],
  2185. "properties": {
  2186. "meta": {
  2187. "$ref": "#/components/schemas/OCSMeta"
  2188. },
  2189. "data": {
  2190. "type": "object",
  2191. "required": [
  2192. "apppassword"
  2193. ],
  2194. "properties": {
  2195. "apppassword": {
  2196. "type": "string"
  2197. }
  2198. }
  2199. }
  2200. }
  2201. }
  2202. }
  2203. }
  2204. }
  2205. }
  2206. },
  2207. "403": {
  2208. "description": "Rotating app password is not allowed",
  2209. "content": {
  2210. "text/plain": {
  2211. "schema": {
  2212. "type": "string"
  2213. }
  2214. }
  2215. }
  2216. }
  2217. }
  2218. }
  2219. },
  2220. "/ocs/v2.php/core/apppassword": {
  2221. "delete": {
  2222. "operationId": "app_password-delete-app-password",
  2223. "summary": "Delete app password",
  2224. "tags": [
  2225. "app_password"
  2226. ],
  2227. "security": [
  2228. {
  2229. "bearer_auth": []
  2230. },
  2231. {
  2232. "basic_auth": []
  2233. }
  2234. ],
  2235. "parameters": [
  2236. {
  2237. "name": "OCS-APIRequest",
  2238. "in": "header",
  2239. "description": "Required to be true for the API request to pass",
  2240. "required": true,
  2241. "schema": {
  2242. "type": "boolean",
  2243. "default": true
  2244. }
  2245. }
  2246. ],
  2247. "responses": {
  2248. "200": {
  2249. "description": "App password deleted successfully",
  2250. "content": {
  2251. "application/json": {
  2252. "schema": {
  2253. "type": "object",
  2254. "required": [
  2255. "ocs"
  2256. ],
  2257. "properties": {
  2258. "ocs": {
  2259. "type": "object",
  2260. "required": [
  2261. "meta",
  2262. "data"
  2263. ],
  2264. "properties": {
  2265. "meta": {
  2266. "$ref": "#/components/schemas/OCSMeta"
  2267. },
  2268. "data": {}
  2269. }
  2270. }
  2271. }
  2272. }
  2273. }
  2274. }
  2275. },
  2276. "403": {
  2277. "description": "Deleting app password is not allowed",
  2278. "content": {
  2279. "text/plain": {
  2280. "schema": {
  2281. "type": "string"
  2282. }
  2283. }
  2284. }
  2285. }
  2286. }
  2287. }
  2288. },
  2289. "/ocs/v2.php/hovercard/v1/{userId}": {
  2290. "get": {
  2291. "operationId": "hover_card-get-user",
  2292. "summary": "Get the user details for a hovercard",
  2293. "tags": [
  2294. "hover_card"
  2295. ],
  2296. "security": [
  2297. {
  2298. "bearer_auth": []
  2299. },
  2300. {
  2301. "basic_auth": []
  2302. }
  2303. ],
  2304. "parameters": [
  2305. {
  2306. "name": "userId",
  2307. "in": "path",
  2308. "description": "ID of the user",
  2309. "required": true,
  2310. "schema": {
  2311. "type": "string"
  2312. }
  2313. },
  2314. {
  2315. "name": "OCS-APIRequest",
  2316. "in": "header",
  2317. "description": "Required to be true for the API request to pass",
  2318. "required": true,
  2319. "schema": {
  2320. "type": "boolean",
  2321. "default": true
  2322. }
  2323. }
  2324. ],
  2325. "responses": {
  2326. "200": {
  2327. "description": "User details returned",
  2328. "content": {
  2329. "application/json": {
  2330. "schema": {
  2331. "type": "object",
  2332. "required": [
  2333. "ocs"
  2334. ],
  2335. "properties": {
  2336. "ocs": {
  2337. "type": "object",
  2338. "required": [
  2339. "meta",
  2340. "data"
  2341. ],
  2342. "properties": {
  2343. "meta": {
  2344. "$ref": "#/components/schemas/OCSMeta"
  2345. },
  2346. "data": {
  2347. "type": "object",
  2348. "required": [
  2349. "userId",
  2350. "displayName",
  2351. "actions"
  2352. ],
  2353. "properties": {
  2354. "userId": {
  2355. "type": "string"
  2356. },
  2357. "displayName": {
  2358. "type": "string"
  2359. },
  2360. "actions": {
  2361. "type": "array",
  2362. "items": {
  2363. "$ref": "#/components/schemas/ContactsAction"
  2364. }
  2365. }
  2366. }
  2367. }
  2368. }
  2369. }
  2370. }
  2371. }
  2372. }
  2373. }
  2374. },
  2375. "404": {
  2376. "description": "User not found",
  2377. "content": {
  2378. "application/json": {
  2379. "schema": {
  2380. "type": "object",
  2381. "required": [
  2382. "ocs"
  2383. ],
  2384. "properties": {
  2385. "ocs": {
  2386. "type": "object",
  2387. "required": [
  2388. "meta",
  2389. "data"
  2390. ],
  2391. "properties": {
  2392. "meta": {
  2393. "$ref": "#/components/schemas/OCSMeta"
  2394. },
  2395. "data": {}
  2396. }
  2397. }
  2398. }
  2399. }
  2400. }
  2401. }
  2402. }
  2403. }
  2404. }
  2405. },
  2406. "/ocs/v2.php/collaboration/resources/collections/search/{filter}": {
  2407. "get": {
  2408. "operationId": "collaboration_resources-search-collections",
  2409. "summary": "Search for collections",
  2410. "tags": [
  2411. "collaboration_resources"
  2412. ],
  2413. "security": [
  2414. {
  2415. "bearer_auth": []
  2416. },
  2417. {
  2418. "basic_auth": []
  2419. }
  2420. ],
  2421. "parameters": [
  2422. {
  2423. "name": "filter",
  2424. "in": "path",
  2425. "description": "Filter collections",
  2426. "required": true,
  2427. "schema": {
  2428. "type": "string"
  2429. }
  2430. },
  2431. {
  2432. "name": "OCS-APIRequest",
  2433. "in": "header",
  2434. "description": "Required to be true for the API request to pass",
  2435. "required": true,
  2436. "schema": {
  2437. "type": "boolean",
  2438. "default": true
  2439. }
  2440. }
  2441. ],
  2442. "responses": {
  2443. "200": {
  2444. "description": "Collections returned",
  2445. "content": {
  2446. "application/json": {
  2447. "schema": {
  2448. "type": "object",
  2449. "required": [
  2450. "ocs"
  2451. ],
  2452. "properties": {
  2453. "ocs": {
  2454. "type": "object",
  2455. "required": [
  2456. "meta",
  2457. "data"
  2458. ],
  2459. "properties": {
  2460. "meta": {
  2461. "$ref": "#/components/schemas/OCSMeta"
  2462. },
  2463. "data": {
  2464. "type": "array",
  2465. "items": {
  2466. "$ref": "#/components/schemas/Collection"
  2467. }
  2468. }
  2469. }
  2470. }
  2471. }
  2472. }
  2473. }
  2474. }
  2475. },
  2476. "404": {
  2477. "description": "Collection not found",
  2478. "content": {
  2479. "application/json": {
  2480. "schema": {
  2481. "type": "object",
  2482. "required": [
  2483. "ocs"
  2484. ],
  2485. "properties": {
  2486. "ocs": {
  2487. "type": "object",
  2488. "required": [
  2489. "meta",
  2490. "data"
  2491. ],
  2492. "properties": {
  2493. "meta": {
  2494. "$ref": "#/components/schemas/OCSMeta"
  2495. },
  2496. "data": {}
  2497. }
  2498. }
  2499. }
  2500. }
  2501. }
  2502. }
  2503. }
  2504. }
  2505. }
  2506. },
  2507. "/ocs/v2.php/collaboration/resources/collections/{collectionId}": {
  2508. "get": {
  2509. "operationId": "collaboration_resources-list-collection",
  2510. "summary": "Get a collection",
  2511. "tags": [
  2512. "collaboration_resources"
  2513. ],
  2514. "security": [
  2515. {
  2516. "bearer_auth": []
  2517. },
  2518. {
  2519. "basic_auth": []
  2520. }
  2521. ],
  2522. "parameters": [
  2523. {
  2524. "name": "collectionId",
  2525. "in": "path",
  2526. "description": "ID of the collection",
  2527. "required": true,
  2528. "schema": {
  2529. "type": "integer",
  2530. "format": "int64"
  2531. }
  2532. },
  2533. {
  2534. "name": "OCS-APIRequest",
  2535. "in": "header",
  2536. "description": "Required to be true for the API request to pass",
  2537. "required": true,
  2538. "schema": {
  2539. "type": "boolean",
  2540. "default": true
  2541. }
  2542. }
  2543. ],
  2544. "responses": {
  2545. "200": {
  2546. "description": "Collection returned",
  2547. "content": {
  2548. "application/json": {
  2549. "schema": {
  2550. "type": "object",
  2551. "required": [
  2552. "ocs"
  2553. ],
  2554. "properties": {
  2555. "ocs": {
  2556. "type": "object",
  2557. "required": [
  2558. "meta",
  2559. "data"
  2560. ],
  2561. "properties": {
  2562. "meta": {
  2563. "$ref": "#/components/schemas/OCSMeta"
  2564. },
  2565. "data": {
  2566. "$ref": "#/components/schemas/Collection"
  2567. }
  2568. }
  2569. }
  2570. }
  2571. }
  2572. }
  2573. }
  2574. },
  2575. "404": {
  2576. "description": "Collection not found",
  2577. "content": {
  2578. "application/json": {
  2579. "schema": {
  2580. "type": "object",
  2581. "required": [
  2582. "ocs"
  2583. ],
  2584. "properties": {
  2585. "ocs": {
  2586. "type": "object",
  2587. "required": [
  2588. "meta",
  2589. "data"
  2590. ],
  2591. "properties": {
  2592. "meta": {
  2593. "$ref": "#/components/schemas/OCSMeta"
  2594. },
  2595. "data": {}
  2596. }
  2597. }
  2598. }
  2599. }
  2600. }
  2601. }
  2602. },
  2603. "500": {
  2604. "description": "",
  2605. "content": {
  2606. "application/json": {
  2607. "schema": {
  2608. "type": "object",
  2609. "required": [
  2610. "ocs"
  2611. ],
  2612. "properties": {
  2613. "ocs": {
  2614. "type": "object",
  2615. "required": [
  2616. "meta",
  2617. "data"
  2618. ],
  2619. "properties": {
  2620. "meta": {
  2621. "$ref": "#/components/schemas/OCSMeta"
  2622. },
  2623. "data": {}
  2624. }
  2625. }
  2626. }
  2627. }
  2628. }
  2629. }
  2630. }
  2631. }
  2632. },
  2633. "put": {
  2634. "operationId": "collaboration_resources-rename-collection",
  2635. "summary": "Rename a collection",
  2636. "tags": [
  2637. "collaboration_resources"
  2638. ],
  2639. "security": [
  2640. {
  2641. "bearer_auth": []
  2642. },
  2643. {
  2644. "basic_auth": []
  2645. }
  2646. ],
  2647. "parameters": [
  2648. {
  2649. "name": "collectionName",
  2650. "in": "query",
  2651. "description": "New name",
  2652. "required": true,
  2653. "schema": {
  2654. "type": "string"
  2655. }
  2656. },
  2657. {
  2658. "name": "collectionId",
  2659. "in": "path",
  2660. "description": "ID of the collection",
  2661. "required": true,
  2662. "schema": {
  2663. "type": "integer",
  2664. "format": "int64"
  2665. }
  2666. },
  2667. {
  2668. "name": "OCS-APIRequest",
  2669. "in": "header",
  2670. "description": "Required to be true for the API request to pass",
  2671. "required": true,
  2672. "schema": {
  2673. "type": "boolean",
  2674. "default": true
  2675. }
  2676. }
  2677. ],
  2678. "responses": {
  2679. "200": {
  2680. "description": "Collection returned",
  2681. "content": {
  2682. "application/json": {
  2683. "schema": {
  2684. "type": "object",
  2685. "required": [
  2686. "ocs"
  2687. ],
  2688. "properties": {
  2689. "ocs": {
  2690. "type": "object",
  2691. "required": [
  2692. "meta",
  2693. "data"
  2694. ],
  2695. "properties": {
  2696. "meta": {
  2697. "$ref": "#/components/schemas/OCSMeta"
  2698. },
  2699. "data": {
  2700. "$ref": "#/components/schemas/Collection"
  2701. }
  2702. }
  2703. }
  2704. }
  2705. }
  2706. }
  2707. }
  2708. },
  2709. "404": {
  2710. "description": "Collection not found",
  2711. "content": {
  2712. "application/json": {
  2713. "schema": {
  2714. "type": "object",
  2715. "required": [
  2716. "ocs"
  2717. ],
  2718. "properties": {
  2719. "ocs": {
  2720. "type": "object",
  2721. "required": [
  2722. "meta",
  2723. "data"
  2724. ],
  2725. "properties": {
  2726. "meta": {
  2727. "$ref": "#/components/schemas/OCSMeta"
  2728. },
  2729. "data": {}
  2730. }
  2731. }
  2732. }
  2733. }
  2734. }
  2735. }
  2736. },
  2737. "500": {
  2738. "description": "",
  2739. "content": {
  2740. "application/json": {
  2741. "schema": {
  2742. "type": "object",
  2743. "required": [
  2744. "ocs"
  2745. ],
  2746. "properties": {
  2747. "ocs": {
  2748. "type": "object",
  2749. "required": [
  2750. "meta",
  2751. "data"
  2752. ],
  2753. "properties": {
  2754. "meta": {
  2755. "$ref": "#/components/schemas/OCSMeta"
  2756. },
  2757. "data": {}
  2758. }
  2759. }
  2760. }
  2761. }
  2762. }
  2763. }
  2764. }
  2765. }
  2766. },
  2767. "post": {
  2768. "operationId": "collaboration_resources-add-resource",
  2769. "summary": "Add a resource to a collection",
  2770. "tags": [
  2771. "collaboration_resources"
  2772. ],
  2773. "security": [
  2774. {
  2775. "bearer_auth": []
  2776. },
  2777. {
  2778. "basic_auth": []
  2779. }
  2780. ],
  2781. "parameters": [
  2782. {
  2783. "name": "resourceType",
  2784. "in": "query",
  2785. "description": "Name of the resource",
  2786. "required": true,
  2787. "schema": {
  2788. "type": "string"
  2789. }
  2790. },
  2791. {
  2792. "name": "resourceId",
  2793. "in": "query",
  2794. "description": "ID of the resource",
  2795. "required": true,
  2796. "schema": {
  2797. "type": "string"
  2798. }
  2799. },
  2800. {
  2801. "name": "collectionId",
  2802. "in": "path",
  2803. "description": "ID of the collection",
  2804. "required": true,
  2805. "schema": {
  2806. "type": "integer",
  2807. "format": "int64"
  2808. }
  2809. },
  2810. {
  2811. "name": "OCS-APIRequest",
  2812. "in": "header",
  2813. "description": "Required to be true for the API request to pass",
  2814. "required": true,
  2815. "schema": {
  2816. "type": "boolean",
  2817. "default": true
  2818. }
  2819. }
  2820. ],
  2821. "responses": {
  2822. "200": {
  2823. "description": "Collection returned",
  2824. "content": {
  2825. "application/json": {
  2826. "schema": {
  2827. "type": "object",
  2828. "required": [
  2829. "ocs"
  2830. ],
  2831. "properties": {
  2832. "ocs": {
  2833. "type": "object",
  2834. "required": [
  2835. "meta",
  2836. "data"
  2837. ],
  2838. "properties": {
  2839. "meta": {
  2840. "$ref": "#/components/schemas/OCSMeta"
  2841. },
  2842. "data": {
  2843. "$ref": "#/components/schemas/Collection"
  2844. }
  2845. }
  2846. }
  2847. }
  2848. }
  2849. }
  2850. }
  2851. },
  2852. "404": {
  2853. "description": "Collection not found or resource inaccessible",
  2854. "content": {
  2855. "application/json": {
  2856. "schema": {
  2857. "type": "object",
  2858. "required": [
  2859. "ocs"
  2860. ],
  2861. "properties": {
  2862. "ocs": {
  2863. "type": "object",
  2864. "required": [
  2865. "meta",
  2866. "data"
  2867. ],
  2868. "properties": {
  2869. "meta": {
  2870. "$ref": "#/components/schemas/OCSMeta"
  2871. },
  2872. "data": {}
  2873. }
  2874. }
  2875. }
  2876. }
  2877. }
  2878. }
  2879. },
  2880. "500": {
  2881. "description": "",
  2882. "content": {
  2883. "application/json": {
  2884. "schema": {
  2885. "type": "object",
  2886. "required": [
  2887. "ocs"
  2888. ],
  2889. "properties": {
  2890. "ocs": {
  2891. "type": "object",
  2892. "required": [
  2893. "meta",
  2894. "data"
  2895. ],
  2896. "properties": {
  2897. "meta": {
  2898. "$ref": "#/components/schemas/OCSMeta"
  2899. },
  2900. "data": {}
  2901. }
  2902. }
  2903. }
  2904. }
  2905. }
  2906. }
  2907. }
  2908. }
  2909. },
  2910. "delete": {
  2911. "operationId": "collaboration_resources-remove-resource",
  2912. "summary": "Remove a resource from a collection",
  2913. "tags": [
  2914. "collaboration_resources"
  2915. ],
  2916. "security": [
  2917. {
  2918. "bearer_auth": []
  2919. },
  2920. {
  2921. "basic_auth": []
  2922. }
  2923. ],
  2924. "parameters": [
  2925. {
  2926. "name": "resourceType",
  2927. "in": "query",
  2928. "description": "Name of the resource",
  2929. "required": true,
  2930. "schema": {
  2931. "type": "string"
  2932. }
  2933. },
  2934. {
  2935. "name": "resourceId",
  2936. "in": "query",
  2937. "description": "ID of the resource",
  2938. "required": true,
  2939. "schema": {
  2940. "type": "string"
  2941. }
  2942. },
  2943. {
  2944. "name": "collectionId",
  2945. "in": "path",
  2946. "description": "ID of the collection",
  2947. "required": true,
  2948. "schema": {
  2949. "type": "integer",
  2950. "format": "int64"
  2951. }
  2952. },
  2953. {
  2954. "name": "OCS-APIRequest",
  2955. "in": "header",
  2956. "description": "Required to be true for the API request to pass",
  2957. "required": true,
  2958. "schema": {
  2959. "type": "boolean",
  2960. "default": true
  2961. }
  2962. }
  2963. ],
  2964. "responses": {
  2965. "200": {
  2966. "description": "Collection returned",
  2967. "content": {
  2968. "application/json": {
  2969. "schema": {
  2970. "type": "object",
  2971. "required": [
  2972. "ocs"
  2973. ],
  2974. "properties": {
  2975. "ocs": {
  2976. "type": "object",
  2977. "required": [
  2978. "meta",
  2979. "data"
  2980. ],
  2981. "properties": {
  2982. "meta": {
  2983. "$ref": "#/components/schemas/OCSMeta"
  2984. },
  2985. "data": {
  2986. "$ref": "#/components/schemas/Collection"
  2987. }
  2988. }
  2989. }
  2990. }
  2991. }
  2992. }
  2993. }
  2994. },
  2995. "404": {
  2996. "description": "Collection or resource not found",
  2997. "content": {
  2998. "application/json": {
  2999. "schema": {
  3000. "type": "object",
  3001. "required": [
  3002. "ocs"
  3003. ],
  3004. "properties": {
  3005. "ocs": {
  3006. "type": "object",
  3007. "required": [
  3008. "meta",
  3009. "data"
  3010. ],
  3011. "properties": {
  3012. "meta": {
  3013. "$ref": "#/components/schemas/OCSMeta"
  3014. },
  3015. "data": {}
  3016. }
  3017. }
  3018. }
  3019. }
  3020. }
  3021. }
  3022. },
  3023. "500": {
  3024. "description": "",
  3025. "content": {
  3026. "application/json": {
  3027. "schema": {
  3028. "type": "object",
  3029. "required": [
  3030. "ocs"
  3031. ],
  3032. "properties": {
  3033. "ocs": {
  3034. "type": "object",
  3035. "required": [
  3036. "meta",
  3037. "data"
  3038. ],
  3039. "properties": {
  3040. "meta": {
  3041. "$ref": "#/components/schemas/OCSMeta"
  3042. },
  3043. "data": {}
  3044. }
  3045. }
  3046. }
  3047. }
  3048. }
  3049. }
  3050. }
  3051. }
  3052. }
  3053. },
  3054. "/ocs/v2.php/collaboration/resources/{resourceType}/{resourceId}": {
  3055. "get": {
  3056. "operationId": "collaboration_resources-get-collections-by-resource",
  3057. "summary": "Get collections by resource",
  3058. "tags": [
  3059. "collaboration_resources"
  3060. ],
  3061. "security": [
  3062. {
  3063. "bearer_auth": []
  3064. },
  3065. {
  3066. "basic_auth": []
  3067. }
  3068. ],
  3069. "parameters": [
  3070. {
  3071. "name": "resourceType",
  3072. "in": "path",
  3073. "description": "Type of the resource",
  3074. "required": true,
  3075. "schema": {
  3076. "type": "string"
  3077. }
  3078. },
  3079. {
  3080. "name": "resourceId",
  3081. "in": "path",
  3082. "description": "ID of the resource",
  3083. "required": true,
  3084. "schema": {
  3085. "type": "string"
  3086. }
  3087. },
  3088. {
  3089. "name": "OCS-APIRequest",
  3090. "in": "header",
  3091. "description": "Required to be true for the API request to pass",
  3092. "required": true,
  3093. "schema": {
  3094. "type": "boolean",
  3095. "default": true
  3096. }
  3097. }
  3098. ],
  3099. "responses": {
  3100. "200": {
  3101. "description": "Collections returned",
  3102. "content": {
  3103. "application/json": {
  3104. "schema": {
  3105. "type": "object",
  3106. "required": [
  3107. "ocs"
  3108. ],
  3109. "properties": {
  3110. "ocs": {
  3111. "type": "object",
  3112. "required": [
  3113. "meta",
  3114. "data"
  3115. ],
  3116. "properties": {
  3117. "meta": {
  3118. "$ref": "#/components/schemas/OCSMeta"
  3119. },
  3120. "data": {
  3121. "type": "array",
  3122. "items": {
  3123. "$ref": "#/components/schemas/Collection"
  3124. }
  3125. }
  3126. }
  3127. }
  3128. }
  3129. }
  3130. }
  3131. }
  3132. },
  3133. "404": {
  3134. "description": "Resource not accessible",
  3135. "content": {
  3136. "application/json": {
  3137. "schema": {
  3138. "type": "object",
  3139. "required": [
  3140. "ocs"
  3141. ],
  3142. "properties": {
  3143. "ocs": {
  3144. "type": "object",
  3145. "required": [
  3146. "meta",
  3147. "data"
  3148. ],
  3149. "properties": {
  3150. "meta": {
  3151. "$ref": "#/components/schemas/OCSMeta"
  3152. },
  3153. "data": {}
  3154. }
  3155. }
  3156. }
  3157. }
  3158. }
  3159. }
  3160. }
  3161. }
  3162. }
  3163. },
  3164. "/ocs/v2.php/collaboration/resources/{baseResourceType}/{baseResourceId}": {
  3165. "post": {
  3166. "operationId": "collaboration_resources-create-collection-on-resource",
  3167. "summary": "Create a collection for a resource",
  3168. "tags": [
  3169. "collaboration_resources"
  3170. ],
  3171. "security": [
  3172. {
  3173. "bearer_auth": []
  3174. },
  3175. {
  3176. "basic_auth": []
  3177. }
  3178. ],
  3179. "parameters": [
  3180. {
  3181. "name": "name",
  3182. "in": "query",
  3183. "description": "Name of the collection",
  3184. "required": true,
  3185. "schema": {
  3186. "type": "string"
  3187. }
  3188. },
  3189. {
  3190. "name": "baseResourceType",
  3191. "in": "path",
  3192. "description": "Type of the base resource",
  3193. "required": true,
  3194. "schema": {
  3195. "type": "string"
  3196. }
  3197. },
  3198. {
  3199. "name": "baseResourceId",
  3200. "in": "path",
  3201. "description": "ID of the base resource",
  3202. "required": true,
  3203. "schema": {
  3204. "type": "string"
  3205. }
  3206. },
  3207. {
  3208. "name": "OCS-APIRequest",
  3209. "in": "header",
  3210. "description": "Required to be true for the API request to pass",
  3211. "required": true,
  3212. "schema": {
  3213. "type": "boolean",
  3214. "default": true
  3215. }
  3216. }
  3217. ],
  3218. "responses": {
  3219. "200": {
  3220. "description": "Collection returned",
  3221. "content": {
  3222. "application/json": {
  3223. "schema": {
  3224. "type": "object",
  3225. "required": [
  3226. "ocs"
  3227. ],
  3228. "properties": {
  3229. "ocs": {
  3230. "type": "object",
  3231. "required": [
  3232. "meta",
  3233. "data"
  3234. ],
  3235. "properties": {
  3236. "meta": {
  3237. "$ref": "#/components/schemas/OCSMeta"
  3238. },
  3239. "data": {
  3240. "$ref": "#/components/schemas/Collection"
  3241. }
  3242. }
  3243. }
  3244. }
  3245. }
  3246. }
  3247. }
  3248. },
  3249. "400": {
  3250. "description": "Creating collection is not possible",
  3251. "content": {
  3252. "application/json": {
  3253. "schema": {
  3254. "type": "object",
  3255. "required": [
  3256. "ocs"
  3257. ],
  3258. "properties": {
  3259. "ocs": {
  3260. "type": "object",
  3261. "required": [
  3262. "meta",
  3263. "data"
  3264. ],
  3265. "properties": {
  3266. "meta": {
  3267. "$ref": "#/components/schemas/OCSMeta"
  3268. },
  3269. "data": {}
  3270. }
  3271. }
  3272. }
  3273. }
  3274. }
  3275. }
  3276. },
  3277. "404": {
  3278. "description": "Resource inaccessible",
  3279. "content": {
  3280. "application/json": {
  3281. "schema": {
  3282. "type": "object",
  3283. "required": [
  3284. "ocs"
  3285. ],
  3286. "properties": {
  3287. "ocs": {
  3288. "type": "object",
  3289. "required": [
  3290. "meta",
  3291. "data"
  3292. ],
  3293. "properties": {
  3294. "meta": {
  3295. "$ref": "#/components/schemas/OCSMeta"
  3296. },
  3297. "data": {}
  3298. }
  3299. }
  3300. }
  3301. }
  3302. }
  3303. }
  3304. },
  3305. "500": {
  3306. "description": "",
  3307. "content": {
  3308. "application/json": {
  3309. "schema": {
  3310. "type": "object",
  3311. "required": [
  3312. "ocs"
  3313. ],
  3314. "properties": {
  3315. "ocs": {
  3316. "type": "object",
  3317. "required": [
  3318. "meta",
  3319. "data"
  3320. ],
  3321. "properties": {
  3322. "meta": {
  3323. "$ref": "#/components/schemas/OCSMeta"
  3324. },
  3325. "data": {}
  3326. }
  3327. }
  3328. }
  3329. }
  3330. }
  3331. }
  3332. }
  3333. }
  3334. }
  3335. },
  3336. "/ocs/v2.php/references/resolve": {
  3337. "get": {
  3338. "operationId": "reference_api-resolve-one",
  3339. "summary": "Resolve a reference",
  3340. "tags": [
  3341. "reference_api"
  3342. ],
  3343. "security": [
  3344. {
  3345. "bearer_auth": []
  3346. },
  3347. {
  3348. "basic_auth": []
  3349. }
  3350. ],
  3351. "parameters": [
  3352. {
  3353. "name": "reference",
  3354. "in": "query",
  3355. "description": "Reference to resolve",
  3356. "required": true,
  3357. "schema": {
  3358. "type": "string"
  3359. }
  3360. },
  3361. {
  3362. "name": "OCS-APIRequest",
  3363. "in": "header",
  3364. "description": "Required to be true for the API request to pass",
  3365. "required": true,
  3366. "schema": {
  3367. "type": "boolean",
  3368. "default": true
  3369. }
  3370. }
  3371. ],
  3372. "responses": {
  3373. "200": {
  3374. "description": "Reference returned",
  3375. "content": {
  3376. "application/json": {
  3377. "schema": {
  3378. "type": "object",
  3379. "required": [
  3380. "ocs"
  3381. ],
  3382. "properties": {
  3383. "ocs": {
  3384. "type": "object",
  3385. "required": [
  3386. "meta",
  3387. "data"
  3388. ],
  3389. "properties": {
  3390. "meta": {
  3391. "$ref": "#/components/schemas/OCSMeta"
  3392. },
  3393. "data": {
  3394. "type": "object",
  3395. "required": [
  3396. "references"
  3397. ],
  3398. "properties": {
  3399. "references": {
  3400. "type": "object",
  3401. "additionalProperties": {
  3402. "$ref": "#/components/schemas/Reference",
  3403. "nullable": true
  3404. }
  3405. }
  3406. }
  3407. }
  3408. }
  3409. }
  3410. }
  3411. }
  3412. }
  3413. }
  3414. }
  3415. }
  3416. },
  3417. "post": {
  3418. "operationId": "reference_api-resolve",
  3419. "summary": "Resolve multiple references",
  3420. "tags": [
  3421. "reference_api"
  3422. ],
  3423. "security": [
  3424. {
  3425. "bearer_auth": []
  3426. },
  3427. {
  3428. "basic_auth": []
  3429. }
  3430. ],
  3431. "parameters": [
  3432. {
  3433. "name": "references[]",
  3434. "in": "query",
  3435. "description": "References to resolve",
  3436. "required": true,
  3437. "schema": {
  3438. "type": "array",
  3439. "items": {
  3440. "type": "string"
  3441. }
  3442. }
  3443. },
  3444. {
  3445. "name": "limit",
  3446. "in": "query",
  3447. "description": "Maximum amount of references to resolve",
  3448. "schema": {
  3449. "type": "integer",
  3450. "format": "int64",
  3451. "default": 1
  3452. }
  3453. },
  3454. {
  3455. "name": "OCS-APIRequest",
  3456. "in": "header",
  3457. "description": "Required to be true for the API request to pass",
  3458. "required": true,
  3459. "schema": {
  3460. "type": "boolean",
  3461. "default": true
  3462. }
  3463. }
  3464. ],
  3465. "responses": {
  3466. "200": {
  3467. "description": "References returned",
  3468. "content": {
  3469. "application/json": {
  3470. "schema": {
  3471. "type": "object",
  3472. "required": [
  3473. "ocs"
  3474. ],
  3475. "properties": {
  3476. "ocs": {
  3477. "type": "object",
  3478. "required": [
  3479. "meta",
  3480. "data"
  3481. ],
  3482. "properties": {
  3483. "meta": {
  3484. "$ref": "#/components/schemas/OCSMeta"
  3485. },
  3486. "data": {
  3487. "type": "object",
  3488. "required": [
  3489. "references"
  3490. ],
  3491. "properties": {
  3492. "references": {
  3493. "type": "object",
  3494. "additionalProperties": {
  3495. "$ref": "#/components/schemas/Reference",
  3496. "nullable": true
  3497. }
  3498. }
  3499. }
  3500. }
  3501. }
  3502. }
  3503. }
  3504. }
  3505. }
  3506. }
  3507. }
  3508. }
  3509. }
  3510. },
  3511. "/ocs/v2.php/references/extract": {
  3512. "post": {
  3513. "operationId": "reference_api-extract",
  3514. "summary": "Extract references from a text",
  3515. "tags": [
  3516. "reference_api"
  3517. ],
  3518. "security": [
  3519. {
  3520. "bearer_auth": []
  3521. },
  3522. {
  3523. "basic_auth": []
  3524. }
  3525. ],
  3526. "parameters": [
  3527. {
  3528. "name": "text",
  3529. "in": "query",
  3530. "description": "Text to extract from",
  3531. "required": true,
  3532. "schema": {
  3533. "type": "string"
  3534. }
  3535. },
  3536. {
  3537. "name": "resolve",
  3538. "in": "query",
  3539. "description": "Resolve the references",
  3540. "schema": {
  3541. "type": "integer",
  3542. "default": 0
  3543. }
  3544. },
  3545. {
  3546. "name": "limit",
  3547. "in": "query",
  3548. "description": "Maximum amount of references to extract",
  3549. "schema": {
  3550. "type": "integer",
  3551. "format": "int64",
  3552. "default": 1
  3553. }
  3554. },
  3555. {
  3556. "name": "OCS-APIRequest",
  3557. "in": "header",
  3558. "description": "Required to be true for the API request to pass",
  3559. "required": true,
  3560. "schema": {
  3561. "type": "boolean",
  3562. "default": true
  3563. }
  3564. }
  3565. ],
  3566. "responses": {
  3567. "200": {
  3568. "description": "References returned",
  3569. "content": {
  3570. "application/json": {
  3571. "schema": {
  3572. "type": "object",
  3573. "required": [
  3574. "ocs"
  3575. ],
  3576. "properties": {
  3577. "ocs": {
  3578. "type": "object",
  3579. "required": [
  3580. "meta",
  3581. "data"
  3582. ],
  3583. "properties": {
  3584. "meta": {
  3585. "$ref": "#/components/schemas/OCSMeta"
  3586. },
  3587. "data": {
  3588. "type": "object",
  3589. "required": [
  3590. "references"
  3591. ],
  3592. "properties": {
  3593. "references": {
  3594. "type": "object",
  3595. "additionalProperties": {
  3596. "$ref": "#/components/schemas/Reference",
  3597. "nullable": true
  3598. }
  3599. }
  3600. }
  3601. }
  3602. }
  3603. }
  3604. }
  3605. }
  3606. }
  3607. }
  3608. }
  3609. }
  3610. }
  3611. },
  3612. "/ocs/v2.php/references/providers": {
  3613. "get": {
  3614. "operationId": "reference_api-get-providers-info",
  3615. "summary": "Get the providers",
  3616. "tags": [
  3617. "reference_api"
  3618. ],
  3619. "security": [
  3620. {
  3621. "bearer_auth": []
  3622. },
  3623. {
  3624. "basic_auth": []
  3625. }
  3626. ],
  3627. "parameters": [
  3628. {
  3629. "name": "OCS-APIRequest",
  3630. "in": "header",
  3631. "description": "Required to be true for the API request to pass",
  3632. "required": true,
  3633. "schema": {
  3634. "type": "boolean",
  3635. "default": true
  3636. }
  3637. }
  3638. ],
  3639. "responses": {
  3640. "200": {
  3641. "description": "Providers returned",
  3642. "content": {
  3643. "application/json": {
  3644. "schema": {
  3645. "type": "object",
  3646. "required": [
  3647. "ocs"
  3648. ],
  3649. "properties": {
  3650. "ocs": {
  3651. "type": "object",
  3652. "required": [
  3653. "meta",
  3654. "data"
  3655. ],
  3656. "properties": {
  3657. "meta": {
  3658. "$ref": "#/components/schemas/OCSMeta"
  3659. },
  3660. "data": {
  3661. "type": "array",
  3662. "items": {
  3663. "$ref": "#/components/schemas/ReferenceProvider"
  3664. }
  3665. }
  3666. }
  3667. }
  3668. }
  3669. }
  3670. }
  3671. }
  3672. }
  3673. }
  3674. }
  3675. },
  3676. "/ocs/v2.php/references/provider/{providerId}": {
  3677. "put": {
  3678. "operationId": "reference_api-touch-provider",
  3679. "summary": "Touch a provider",
  3680. "tags": [
  3681. "reference_api"
  3682. ],
  3683. "security": [
  3684. {
  3685. "bearer_auth": []
  3686. },
  3687. {
  3688. "basic_auth": []
  3689. }
  3690. ],
  3691. "parameters": [
  3692. {
  3693. "name": "timestamp",
  3694. "in": "query",
  3695. "description": "Timestamp of the last usage",
  3696. "schema": {
  3697. "type": "integer",
  3698. "format": "int64",
  3699. "nullable": true
  3700. }
  3701. },
  3702. {
  3703. "name": "providerId",
  3704. "in": "path",
  3705. "description": "ID of the provider",
  3706. "required": true,
  3707. "schema": {
  3708. "type": "string"
  3709. }
  3710. },
  3711. {
  3712. "name": "OCS-APIRequest",
  3713. "in": "header",
  3714. "description": "Required to be true for the API request to pass",
  3715. "required": true,
  3716. "schema": {
  3717. "type": "boolean",
  3718. "default": true
  3719. }
  3720. }
  3721. ],
  3722. "responses": {
  3723. "200": {
  3724. "description": "Provider touched",
  3725. "content": {
  3726. "application/json": {
  3727. "schema": {
  3728. "type": "object",
  3729. "required": [
  3730. "ocs"
  3731. ],
  3732. "properties": {
  3733. "ocs": {
  3734. "type": "object",
  3735. "required": [
  3736. "meta",
  3737. "data"
  3738. ],
  3739. "properties": {
  3740. "meta": {
  3741. "$ref": "#/components/schemas/OCSMeta"
  3742. },
  3743. "data": {
  3744. "type": "object",
  3745. "required": [
  3746. "success"
  3747. ],
  3748. "properties": {
  3749. "success": {
  3750. "type": "boolean"
  3751. }
  3752. }
  3753. }
  3754. }
  3755. }
  3756. }
  3757. }
  3758. }
  3759. }
  3760. }
  3761. }
  3762. }
  3763. },
  3764. "/ocs/v2.php/profile/{targetUserId}": {
  3765. "put": {
  3766. "operationId": "profile_api-set-visibility",
  3767. "summary": "Update the visibility of a parameter",
  3768. "tags": [
  3769. "profile_api"
  3770. ],
  3771. "security": [
  3772. {
  3773. "bearer_auth": []
  3774. },
  3775. {
  3776. "basic_auth": []
  3777. }
  3778. ],
  3779. "parameters": [
  3780. {
  3781. "name": "paramId",
  3782. "in": "query",
  3783. "description": "ID of the parameter",
  3784. "required": true,
  3785. "schema": {
  3786. "type": "string"
  3787. }
  3788. },
  3789. {
  3790. "name": "visibility",
  3791. "in": "query",
  3792. "description": "New visibility",
  3793. "required": true,
  3794. "schema": {
  3795. "type": "string"
  3796. }
  3797. },
  3798. {
  3799. "name": "targetUserId",
  3800. "in": "path",
  3801. "description": "ID of the user",
  3802. "required": true,
  3803. "schema": {
  3804. "type": "string"
  3805. }
  3806. },
  3807. {
  3808. "name": "OCS-APIRequest",
  3809. "in": "header",
  3810. "description": "Required to be true for the API request to pass",
  3811. "required": true,
  3812. "schema": {
  3813. "type": "boolean",
  3814. "default": true
  3815. }
  3816. }
  3817. ],
  3818. "responses": {
  3819. "200": {
  3820. "description": "Visibility updated successfully",
  3821. "content": {
  3822. "application/json": {
  3823. "schema": {
  3824. "type": "object",
  3825. "required": [
  3826. "ocs"
  3827. ],
  3828. "properties": {
  3829. "ocs": {
  3830. "type": "object",
  3831. "required": [
  3832. "meta",
  3833. "data"
  3834. ],
  3835. "properties": {
  3836. "meta": {
  3837. "$ref": "#/components/schemas/OCSMeta"
  3838. },
  3839. "data": {}
  3840. }
  3841. }
  3842. }
  3843. }
  3844. }
  3845. }
  3846. },
  3847. "400": {
  3848. "description": "Updating visibility is not possible",
  3849. "content": {
  3850. "text/plain": {
  3851. "schema": {
  3852. "type": "string"
  3853. }
  3854. }
  3855. }
  3856. },
  3857. "403": {
  3858. "description": "Not allowed to edit other users visibility",
  3859. "content": {
  3860. "text/plain": {
  3861. "schema": {
  3862. "type": "string"
  3863. }
  3864. }
  3865. }
  3866. },
  3867. "404": {
  3868. "description": "User not found",
  3869. "content": {
  3870. "text/plain": {
  3871. "schema": {
  3872. "type": "string"
  3873. }
  3874. }
  3875. }
  3876. }
  3877. }
  3878. }
  3879. },
  3880. "/ocs/v2.php/search/providers": {
  3881. "get": {
  3882. "operationId": "unified_search-get-providers",
  3883. "summary": "Get the providers for unified search",
  3884. "tags": [
  3885. "unified_search"
  3886. ],
  3887. "security": [
  3888. {
  3889. "bearer_auth": []
  3890. },
  3891. {
  3892. "basic_auth": []
  3893. }
  3894. ],
  3895. "parameters": [
  3896. {
  3897. "name": "from",
  3898. "in": "query",
  3899. "description": "the url the user is currently at",
  3900. "schema": {
  3901. "type": "string",
  3902. "default": ""
  3903. }
  3904. },
  3905. {
  3906. "name": "OCS-APIRequest",
  3907. "in": "header",
  3908. "description": "Required to be true for the API request to pass",
  3909. "required": true,
  3910. "schema": {
  3911. "type": "boolean",
  3912. "default": true
  3913. }
  3914. }
  3915. ],
  3916. "responses": {
  3917. "200": {
  3918. "description": "Providers returned",
  3919. "content": {
  3920. "application/json": {
  3921. "schema": {
  3922. "type": "object",
  3923. "required": [
  3924. "ocs"
  3925. ],
  3926. "properties": {
  3927. "ocs": {
  3928. "type": "object",
  3929. "required": [
  3930. "meta",
  3931. "data"
  3932. ],
  3933. "properties": {
  3934. "meta": {
  3935. "$ref": "#/components/schemas/OCSMeta"
  3936. },
  3937. "data": {
  3938. "type": "array",
  3939. "items": {
  3940. "$ref": "#/components/schemas/UnifiedSearchProvider"
  3941. }
  3942. }
  3943. }
  3944. }
  3945. }
  3946. }
  3947. }
  3948. }
  3949. }
  3950. }
  3951. }
  3952. },
  3953. "/ocs/v2.php/search/providers/{providerId}/search": {
  3954. "get": {
  3955. "operationId": "unified_search-search",
  3956. "summary": "Search",
  3957. "tags": [
  3958. "unified_search"
  3959. ],
  3960. "security": [
  3961. {
  3962. "bearer_auth": []
  3963. },
  3964. {
  3965. "basic_auth": []
  3966. }
  3967. ],
  3968. "parameters": [
  3969. {
  3970. "name": "term",
  3971. "in": "query",
  3972. "description": "Term to search",
  3973. "schema": {
  3974. "type": "string",
  3975. "default": ""
  3976. }
  3977. },
  3978. {
  3979. "name": "sortOrder",
  3980. "in": "query",
  3981. "description": "Order of entries",
  3982. "schema": {
  3983. "type": "integer",
  3984. "format": "int64",
  3985. "nullable": true
  3986. }
  3987. },
  3988. {
  3989. "name": "limit",
  3990. "in": "query",
  3991. "description": "Maximum amount of entries",
  3992. "schema": {
  3993. "type": "integer",
  3994. "format": "int64",
  3995. "nullable": true
  3996. }
  3997. },
  3998. {
  3999. "name": "cursor",
  4000. "in": "query",
  4001. "description": "Offset for searching",
  4002. "schema": {
  4003. "type": "string",
  4004. "nullable": true
  4005. }
  4006. },
  4007. {
  4008. "name": "from",
  4009. "in": "query",
  4010. "description": "The current user URL",
  4011. "schema": {
  4012. "type": "string",
  4013. "default": ""
  4014. }
  4015. },
  4016. {
  4017. "name": "providerId",
  4018. "in": "path",
  4019. "description": "ID of the provider",
  4020. "required": true,
  4021. "schema": {
  4022. "type": "string"
  4023. }
  4024. },
  4025. {
  4026. "name": "OCS-APIRequest",
  4027. "in": "header",
  4028. "description": "Required to be true for the API request to pass",
  4029. "required": true,
  4030. "schema": {
  4031. "type": "boolean",
  4032. "default": true
  4033. }
  4034. }
  4035. ],
  4036. "responses": {
  4037. "200": {
  4038. "description": "Search entries returned",
  4039. "content": {
  4040. "application/json": {
  4041. "schema": {
  4042. "type": "object",
  4043. "required": [
  4044. "ocs"
  4045. ],
  4046. "properties": {
  4047. "ocs": {
  4048. "type": "object",
  4049. "required": [
  4050. "meta",
  4051. "data"
  4052. ],
  4053. "properties": {
  4054. "meta": {
  4055. "$ref": "#/components/schemas/OCSMeta"
  4056. },
  4057. "data": {
  4058. "$ref": "#/components/schemas/UnifiedSearchResult"
  4059. }
  4060. }
  4061. }
  4062. }
  4063. }
  4064. }
  4065. }
  4066. },
  4067. "400": {
  4068. "description": "Searching is not possible",
  4069. "content": {
  4070. "application/json": {
  4071. "schema": {
  4072. "type": "object",
  4073. "required": [
  4074. "ocs"
  4075. ],
  4076. "properties": {
  4077. "ocs": {
  4078. "type": "object",
  4079. "required": [
  4080. "meta",
  4081. "data"
  4082. ],
  4083. "properties": {
  4084. "meta": {
  4085. "$ref": "#/components/schemas/OCSMeta"
  4086. },
  4087. "data": {
  4088. "nullable": true
  4089. }
  4090. }
  4091. }
  4092. }
  4093. }
  4094. }
  4095. }
  4096. }
  4097. }
  4098. }
  4099. },
  4100. "/ocs/v2.php/translation/languages": {
  4101. "get": {
  4102. "operationId": "translation_api-languages",
  4103. "summary": "Get the list of supported languages",
  4104. "tags": [
  4105. "translation_api"
  4106. ],
  4107. "security": [
  4108. {},
  4109. {
  4110. "bearer_auth": []
  4111. },
  4112. {
  4113. "basic_auth": []
  4114. }
  4115. ],
  4116. "parameters": [
  4117. {
  4118. "name": "OCS-APIRequest",
  4119. "in": "header",
  4120. "description": "Required to be true for the API request to pass",
  4121. "required": true,
  4122. "schema": {
  4123. "type": "boolean",
  4124. "default": true
  4125. }
  4126. }
  4127. ],
  4128. "responses": {
  4129. "200": {
  4130. "description": "Supported languages returned",
  4131. "content": {
  4132. "application/json": {
  4133. "schema": {
  4134. "type": "object",
  4135. "required": [
  4136. "ocs"
  4137. ],
  4138. "properties": {
  4139. "ocs": {
  4140. "type": "object",
  4141. "required": [
  4142. "meta",
  4143. "data"
  4144. ],
  4145. "properties": {
  4146. "meta": {
  4147. "$ref": "#/components/schemas/OCSMeta"
  4148. },
  4149. "data": {
  4150. "type": "object",
  4151. "required": [
  4152. "languages",
  4153. "languageDetection"
  4154. ],
  4155. "properties": {
  4156. "languages": {
  4157. "type": "array",
  4158. "items": {
  4159. "type": "object",
  4160. "required": [
  4161. "from",
  4162. "fromLabel",
  4163. "to",
  4164. "toLabel"
  4165. ],
  4166. "properties": {
  4167. "from": {
  4168. "type": "string"
  4169. },
  4170. "fromLabel": {
  4171. "type": "string"
  4172. },
  4173. "to": {
  4174. "type": "string"
  4175. },
  4176. "toLabel": {
  4177. "type": "string"
  4178. }
  4179. }
  4180. }
  4181. },
  4182. "languageDetection": {
  4183. "type": "boolean"
  4184. }
  4185. }
  4186. }
  4187. }
  4188. }
  4189. }
  4190. }
  4191. }
  4192. }
  4193. }
  4194. }
  4195. }
  4196. },
  4197. "/ocs/v2.php/translation/translate": {
  4198. "post": {
  4199. "operationId": "translation_api-translate",
  4200. "summary": "Translate a text",
  4201. "tags": [
  4202. "translation_api"
  4203. ],
  4204. "security": [
  4205. {},
  4206. {
  4207. "bearer_auth": []
  4208. },
  4209. {
  4210. "basic_auth": []
  4211. }
  4212. ],
  4213. "parameters": [
  4214. {
  4215. "name": "text",
  4216. "in": "query",
  4217. "description": "Text to be translated",
  4218. "required": true,
  4219. "schema": {
  4220. "type": "string"
  4221. }
  4222. },
  4223. {
  4224. "name": "fromLanguage",
  4225. "in": "query",
  4226. "description": "Language to translate from",
  4227. "schema": {
  4228. "type": "string",
  4229. "nullable": true
  4230. }
  4231. },
  4232. {
  4233. "name": "toLanguage",
  4234. "in": "query",
  4235. "description": "Language to translate to",
  4236. "required": true,
  4237. "schema": {
  4238. "type": "string"
  4239. }
  4240. },
  4241. {
  4242. "name": "OCS-APIRequest",
  4243. "in": "header",
  4244. "description": "Required to be true for the API request to pass",
  4245. "required": true,
  4246. "schema": {
  4247. "type": "boolean",
  4248. "default": true
  4249. }
  4250. }
  4251. ],
  4252. "responses": {
  4253. "200": {
  4254. "description": "Translated text returned",
  4255. "content": {
  4256. "application/json": {
  4257. "schema": {
  4258. "type": "object",
  4259. "required": [
  4260. "ocs"
  4261. ],
  4262. "properties": {
  4263. "ocs": {
  4264. "type": "object",
  4265. "required": [
  4266. "meta",
  4267. "data"
  4268. ],
  4269. "properties": {
  4270. "meta": {
  4271. "$ref": "#/components/schemas/OCSMeta"
  4272. },
  4273. "data": {
  4274. "type": "object",
  4275. "required": [
  4276. "text",
  4277. "from"
  4278. ],
  4279. "properties": {
  4280. "text": {
  4281. "type": "string"
  4282. },
  4283. "from": {
  4284. "type": "string",
  4285. "nullable": true
  4286. }
  4287. }
  4288. }
  4289. }
  4290. }
  4291. }
  4292. }
  4293. }
  4294. }
  4295. },
  4296. "400": {
  4297. "description": "Language not detected or unable to translate",
  4298. "content": {
  4299. "application/json": {
  4300. "schema": {
  4301. "type": "object",
  4302. "required": [
  4303. "ocs"
  4304. ],
  4305. "properties": {
  4306. "ocs": {
  4307. "type": "object",
  4308. "required": [
  4309. "meta",
  4310. "data"
  4311. ],
  4312. "properties": {
  4313. "meta": {
  4314. "$ref": "#/components/schemas/OCSMeta"
  4315. },
  4316. "data": {
  4317. "type": "object",
  4318. "required": [
  4319. "message"
  4320. ],
  4321. "properties": {
  4322. "message": {
  4323. "type": "string"
  4324. },
  4325. "from": {
  4326. "type": "string",
  4327. "nullable": true
  4328. }
  4329. }
  4330. }
  4331. }
  4332. }
  4333. }
  4334. }
  4335. }
  4336. }
  4337. },
  4338. "412": {
  4339. "description": "Translating is not possible",
  4340. "content": {
  4341. "application/json": {
  4342. "schema": {
  4343. "type": "object",
  4344. "required": [
  4345. "ocs"
  4346. ],
  4347. "properties": {
  4348. "ocs": {
  4349. "type": "object",
  4350. "required": [
  4351. "meta",
  4352. "data"
  4353. ],
  4354. "properties": {
  4355. "meta": {
  4356. "$ref": "#/components/schemas/OCSMeta"
  4357. },
  4358. "data": {
  4359. "type": "object",
  4360. "required": [
  4361. "message"
  4362. ],
  4363. "properties": {
  4364. "message": {
  4365. "type": "string"
  4366. },
  4367. "from": {
  4368. "type": "string",
  4369. "nullable": true
  4370. }
  4371. }
  4372. }
  4373. }
  4374. }
  4375. }
  4376. }
  4377. }
  4378. }
  4379. },
  4380. "500": {
  4381. "description": "",
  4382. "content": {
  4383. "application/json": {
  4384. "schema": {
  4385. "type": "object",
  4386. "required": [
  4387. "ocs"
  4388. ],
  4389. "properties": {
  4390. "ocs": {
  4391. "type": "object",
  4392. "required": [
  4393. "meta",
  4394. "data"
  4395. ],
  4396. "properties": {
  4397. "meta": {
  4398. "$ref": "#/components/schemas/OCSMeta"
  4399. },
  4400. "data": {
  4401. "type": "object",
  4402. "required": [
  4403. "message"
  4404. ],
  4405. "properties": {
  4406. "message": {
  4407. "type": "string"
  4408. },
  4409. "from": {
  4410. "type": "string",
  4411. "nullable": true
  4412. }
  4413. }
  4414. }
  4415. }
  4416. }
  4417. }
  4418. }
  4419. }
  4420. }
  4421. }
  4422. }
  4423. }
  4424. },
  4425. "/ocs/v2.php/textprocessing/tasktypes": {
  4426. "get": {
  4427. "operationId": "text_processing_api-task-types",
  4428. "summary": "This endpoint returns all available LanguageModel task types",
  4429. "tags": [
  4430. "text_processing_api"
  4431. ],
  4432. "security": [
  4433. {},
  4434. {
  4435. "bearer_auth": []
  4436. },
  4437. {
  4438. "basic_auth": []
  4439. }
  4440. ],
  4441. "parameters": [
  4442. {
  4443. "name": "OCS-APIRequest",
  4444. "in": "header",
  4445. "description": "Required to be true for the API request to pass",
  4446. "required": true,
  4447. "schema": {
  4448. "type": "boolean",
  4449. "default": true
  4450. }
  4451. }
  4452. ],
  4453. "responses": {
  4454. "200": {
  4455. "description": "Task types returned",
  4456. "content": {
  4457. "application/json": {
  4458. "schema": {
  4459. "type": "object",
  4460. "required": [
  4461. "ocs"
  4462. ],
  4463. "properties": {
  4464. "ocs": {
  4465. "type": "object",
  4466. "required": [
  4467. "meta",
  4468. "data"
  4469. ],
  4470. "properties": {
  4471. "meta": {
  4472. "$ref": "#/components/schemas/OCSMeta"
  4473. },
  4474. "data": {
  4475. "type": "object",
  4476. "required": [
  4477. "types"
  4478. ],
  4479. "properties": {
  4480. "types": {
  4481. "type": "array",
  4482. "items": {
  4483. "type": "object",
  4484. "required": [
  4485. "id",
  4486. "name",
  4487. "description"
  4488. ],
  4489. "properties": {
  4490. "id": {
  4491. "type": "string"
  4492. },
  4493. "name": {
  4494. "type": "string"
  4495. },
  4496. "description": {
  4497. "type": "string"
  4498. }
  4499. }
  4500. }
  4501. }
  4502. }
  4503. }
  4504. }
  4505. }
  4506. }
  4507. }
  4508. }
  4509. }
  4510. }
  4511. }
  4512. }
  4513. },
  4514. "/ocs/v2.php/textprocessing/schedule": {
  4515. "post": {
  4516. "operationId": "text_processing_api-schedule",
  4517. "summary": "This endpoint allows scheduling a language model task",
  4518. "tags": [
  4519. "text_processing_api"
  4520. ],
  4521. "security": [
  4522. {},
  4523. {
  4524. "bearer_auth": []
  4525. },
  4526. {
  4527. "basic_auth": []
  4528. }
  4529. ],
  4530. "parameters": [
  4531. {
  4532. "name": "input",
  4533. "in": "query",
  4534. "description": "Input text",
  4535. "required": true,
  4536. "schema": {
  4537. "type": "string"
  4538. }
  4539. },
  4540. {
  4541. "name": "type",
  4542. "in": "query",
  4543. "description": "Type of the task",
  4544. "required": true,
  4545. "schema": {
  4546. "type": "string"
  4547. }
  4548. },
  4549. {
  4550. "name": "appId",
  4551. "in": "query",
  4552. "description": "ID of the app that will execute the task",
  4553. "required": true,
  4554. "schema": {
  4555. "type": "string"
  4556. }
  4557. },
  4558. {
  4559. "name": "identifier",
  4560. "in": "query",
  4561. "description": "An arbitrary identifier for the task",
  4562. "schema": {
  4563. "type": "string",
  4564. "default": ""
  4565. }
  4566. },
  4567. {
  4568. "name": "OCS-APIRequest",
  4569. "in": "header",
  4570. "description": "Required to be true for the API request to pass",
  4571. "required": true,
  4572. "schema": {
  4573. "type": "boolean",
  4574. "default": true
  4575. }
  4576. }
  4577. ],
  4578. "responses": {
  4579. "200": {
  4580. "description": "Task scheduled successfully",
  4581. "content": {
  4582. "application/json": {
  4583. "schema": {
  4584. "type": "object",
  4585. "required": [
  4586. "ocs"
  4587. ],
  4588. "properties": {
  4589. "ocs": {
  4590. "type": "object",
  4591. "required": [
  4592. "meta",
  4593. "data"
  4594. ],
  4595. "properties": {
  4596. "meta": {
  4597. "$ref": "#/components/schemas/OCSMeta"
  4598. },
  4599. "data": {
  4600. "type": "object",
  4601. "required": [
  4602. "task"
  4603. ],
  4604. "properties": {
  4605. "task": {
  4606. "$ref": "#/components/schemas/TextProcessingTask"
  4607. }
  4608. }
  4609. }
  4610. }
  4611. }
  4612. }
  4613. }
  4614. }
  4615. }
  4616. },
  4617. "400": {
  4618. "description": "Scheduling task is not possible",
  4619. "content": {
  4620. "application/json": {
  4621. "schema": {
  4622. "type": "object",
  4623. "required": [
  4624. "ocs"
  4625. ],
  4626. "properties": {
  4627. "ocs": {
  4628. "type": "object",
  4629. "required": [
  4630. "meta",
  4631. "data"
  4632. ],
  4633. "properties": {
  4634. "meta": {
  4635. "$ref": "#/components/schemas/OCSMeta"
  4636. },
  4637. "data": {
  4638. "type": "object",
  4639. "required": [
  4640. "message"
  4641. ],
  4642. "properties": {
  4643. "message": {
  4644. "type": "string"
  4645. }
  4646. }
  4647. }
  4648. }
  4649. }
  4650. }
  4651. }
  4652. }
  4653. }
  4654. },
  4655. "412": {
  4656. "description": "Scheduling task is not possible",
  4657. "content": {
  4658. "application/json": {
  4659. "schema": {
  4660. "type": "object",
  4661. "required": [
  4662. "ocs"
  4663. ],
  4664. "properties": {
  4665. "ocs": {
  4666. "type": "object",
  4667. "required": [
  4668. "meta",
  4669. "data"
  4670. ],
  4671. "properties": {
  4672. "meta": {
  4673. "$ref": "#/components/schemas/OCSMeta"
  4674. },
  4675. "data": {
  4676. "type": "object",
  4677. "required": [
  4678. "message"
  4679. ],
  4680. "properties": {
  4681. "message": {
  4682. "type": "string"
  4683. }
  4684. }
  4685. }
  4686. }
  4687. }
  4688. }
  4689. }
  4690. }
  4691. }
  4692. }
  4693. }
  4694. }
  4695. },
  4696. "/ocs/v2.php/textprocessing/task/{id}": {
  4697. "get": {
  4698. "operationId": "text_processing_api-get-task",
  4699. "summary": "This endpoint allows checking the status and results of a task. Tasks are removed 1 week after receiving their last update.",
  4700. "tags": [
  4701. "text_processing_api"
  4702. ],
  4703. "security": [
  4704. {},
  4705. {
  4706. "bearer_auth": []
  4707. },
  4708. {
  4709. "basic_auth": []
  4710. }
  4711. ],
  4712. "parameters": [
  4713. {
  4714. "name": "id",
  4715. "in": "path",
  4716. "description": "The id of the task",
  4717. "required": true,
  4718. "schema": {
  4719. "type": "integer",
  4720. "format": "int64"
  4721. }
  4722. },
  4723. {
  4724. "name": "OCS-APIRequest",
  4725. "in": "header",
  4726. "description": "Required to be true for the API request to pass",
  4727. "required": true,
  4728. "schema": {
  4729. "type": "boolean",
  4730. "default": true
  4731. }
  4732. }
  4733. ],
  4734. "responses": {
  4735. "200": {
  4736. "description": "Task returned",
  4737. "content": {
  4738. "application/json": {
  4739. "schema": {
  4740. "type": "object",
  4741. "required": [
  4742. "ocs"
  4743. ],
  4744. "properties": {
  4745. "ocs": {
  4746. "type": "object",
  4747. "required": [
  4748. "meta",
  4749. "data"
  4750. ],
  4751. "properties": {
  4752. "meta": {
  4753. "$ref": "#/components/schemas/OCSMeta"
  4754. },
  4755. "data": {
  4756. "type": "object",
  4757. "required": [
  4758. "task"
  4759. ],
  4760. "properties": {
  4761. "task": {
  4762. "$ref": "#/components/schemas/TextProcessingTask"
  4763. }
  4764. }
  4765. }
  4766. }
  4767. }
  4768. }
  4769. }
  4770. }
  4771. }
  4772. },
  4773. "404": {
  4774. "description": "Task not found",
  4775. "content": {
  4776. "application/json": {
  4777. "schema": {
  4778. "type": "object",
  4779. "required": [
  4780. "ocs"
  4781. ],
  4782. "properties": {
  4783. "ocs": {
  4784. "type": "object",
  4785. "required": [
  4786. "meta",
  4787. "data"
  4788. ],
  4789. "properties": {
  4790. "meta": {
  4791. "$ref": "#/components/schemas/OCSMeta"
  4792. },
  4793. "data": {
  4794. "type": "object",
  4795. "required": [
  4796. "message"
  4797. ],
  4798. "properties": {
  4799. "message": {
  4800. "type": "string"
  4801. }
  4802. }
  4803. }
  4804. }
  4805. }
  4806. }
  4807. }
  4808. }
  4809. }
  4810. },
  4811. "500": {
  4812. "description": "",
  4813. "content": {
  4814. "application/json": {
  4815. "schema": {
  4816. "type": "object",
  4817. "required": [
  4818. "ocs"
  4819. ],
  4820. "properties": {
  4821. "ocs": {
  4822. "type": "object",
  4823. "required": [
  4824. "meta",
  4825. "data"
  4826. ],
  4827. "properties": {
  4828. "meta": {
  4829. "$ref": "#/components/schemas/OCSMeta"
  4830. },
  4831. "data": {
  4832. "type": "object",
  4833. "required": [
  4834. "message"
  4835. ],
  4836. "properties": {
  4837. "message": {
  4838. "type": "string"
  4839. }
  4840. }
  4841. }
  4842. }
  4843. }
  4844. }
  4845. }
  4846. }
  4847. }
  4848. }
  4849. }
  4850. },
  4851. "delete": {
  4852. "operationId": "text_processing_api-delete-task",
  4853. "summary": "This endpoint allows to delete a scheduled task for a user",
  4854. "tags": [
  4855. "text_processing_api"
  4856. ],
  4857. "security": [
  4858. {
  4859. "bearer_auth": []
  4860. },
  4861. {
  4862. "basic_auth": []
  4863. }
  4864. ],
  4865. "parameters": [
  4866. {
  4867. "name": "id",
  4868. "in": "path",
  4869. "description": "The id of the task",
  4870. "required": true,
  4871. "schema": {
  4872. "type": "integer",
  4873. "format": "int64"
  4874. }
  4875. },
  4876. {
  4877. "name": "OCS-APIRequest",
  4878. "in": "header",
  4879. "description": "Required to be true for the API request to pass",
  4880. "required": true,
  4881. "schema": {
  4882. "type": "boolean",
  4883. "default": true
  4884. }
  4885. }
  4886. ],
  4887. "responses": {
  4888. "200": {
  4889. "description": "Task returned",
  4890. "content": {
  4891. "application/json": {
  4892. "schema": {
  4893. "type": "object",
  4894. "required": [
  4895. "ocs"
  4896. ],
  4897. "properties": {
  4898. "ocs": {
  4899. "type": "object",
  4900. "required": [
  4901. "meta",
  4902. "data"
  4903. ],
  4904. "properties": {
  4905. "meta": {
  4906. "$ref": "#/components/schemas/OCSMeta"
  4907. },
  4908. "data": {
  4909. "type": "object",
  4910. "required": [
  4911. "task"
  4912. ],
  4913. "properties": {
  4914. "task": {
  4915. "$ref": "#/components/schemas/TextProcessingTask"
  4916. }
  4917. }
  4918. }
  4919. }
  4920. }
  4921. }
  4922. }
  4923. }
  4924. }
  4925. },
  4926. "404": {
  4927. "description": "Task not found",
  4928. "content": {
  4929. "application/json": {
  4930. "schema": {
  4931. "type": "object",
  4932. "required": [
  4933. "ocs"
  4934. ],
  4935. "properties": {
  4936. "ocs": {
  4937. "type": "object",
  4938. "required": [
  4939. "meta",
  4940. "data"
  4941. ],
  4942. "properties": {
  4943. "meta": {
  4944. "$ref": "#/components/schemas/OCSMeta"
  4945. },
  4946. "data": {
  4947. "type": "object",
  4948. "required": [
  4949. "message"
  4950. ],
  4951. "properties": {
  4952. "message": {
  4953. "type": "string"
  4954. }
  4955. }
  4956. }
  4957. }
  4958. }
  4959. }
  4960. }
  4961. }
  4962. }
  4963. },
  4964. "500": {
  4965. "description": "",
  4966. "content": {
  4967. "application/json": {
  4968. "schema": {
  4969. "type": "object",
  4970. "required": [
  4971. "ocs"
  4972. ],
  4973. "properties": {
  4974. "ocs": {
  4975. "type": "object",
  4976. "required": [
  4977. "meta",
  4978. "data"
  4979. ],
  4980. "properties": {
  4981. "meta": {
  4982. "$ref": "#/components/schemas/OCSMeta"
  4983. },
  4984. "data": {
  4985. "type": "object",
  4986. "required": [
  4987. "message"
  4988. ],
  4989. "properties": {
  4990. "message": {
  4991. "type": "string"
  4992. }
  4993. }
  4994. }
  4995. }
  4996. }
  4997. }
  4998. }
  4999. }
  5000. }
  5001. }
  5002. }
  5003. }
  5004. },
  5005. "/ocs/v2.php/textprocessing/tasks/app/{appId}": {
  5006. "get": {
  5007. "operationId": "text_processing_api-list-tasks-by-app",
  5008. "summary": "This endpoint returns a list of tasks of a user that are related with a specific appId and optionally with an identifier",
  5009. "tags": [
  5010. "text_processing_api"
  5011. ],
  5012. "security": [
  5013. {
  5014. "bearer_auth": []
  5015. },
  5016. {
  5017. "basic_auth": []
  5018. }
  5019. ],
  5020. "parameters": [
  5021. {
  5022. "name": "identifier",
  5023. "in": "query",
  5024. "description": "An arbitrary identifier for the task",
  5025. "schema": {
  5026. "type": "string",
  5027. "nullable": true
  5028. }
  5029. },
  5030. {
  5031. "name": "appId",
  5032. "in": "path",
  5033. "description": "ID of the app",
  5034. "required": true,
  5035. "schema": {
  5036. "type": "string"
  5037. }
  5038. },
  5039. {
  5040. "name": "OCS-APIRequest",
  5041. "in": "header",
  5042. "description": "Required to be true for the API request to pass",
  5043. "required": true,
  5044. "schema": {
  5045. "type": "boolean",
  5046. "default": true
  5047. }
  5048. }
  5049. ],
  5050. "responses": {
  5051. "200": {
  5052. "description": "Task list returned",
  5053. "content": {
  5054. "application/json": {
  5055. "schema": {
  5056. "type": "object",
  5057. "required": [
  5058. "ocs"
  5059. ],
  5060. "properties": {
  5061. "ocs": {
  5062. "type": "object",
  5063. "required": [
  5064. "meta",
  5065. "data"
  5066. ],
  5067. "properties": {
  5068. "meta": {
  5069. "$ref": "#/components/schemas/OCSMeta"
  5070. },
  5071. "data": {
  5072. "type": "object",
  5073. "required": [
  5074. "tasks"
  5075. ],
  5076. "properties": {
  5077. "tasks": {
  5078. "type": "array",
  5079. "items": {
  5080. "$ref": "#/components/schemas/TextProcessingTask"
  5081. }
  5082. }
  5083. }
  5084. }
  5085. }
  5086. }
  5087. }
  5088. }
  5089. }
  5090. }
  5091. },
  5092. "500": {
  5093. "description": "",
  5094. "content": {
  5095. "application/json": {
  5096. "schema": {
  5097. "type": "object",
  5098. "required": [
  5099. "ocs"
  5100. ],
  5101. "properties": {
  5102. "ocs": {
  5103. "type": "object",
  5104. "required": [
  5105. "meta",
  5106. "data"
  5107. ],
  5108. "properties": {
  5109. "meta": {
  5110. "$ref": "#/components/schemas/OCSMeta"
  5111. },
  5112. "data": {
  5113. "type": "object",
  5114. "required": [
  5115. "message"
  5116. ],
  5117. "properties": {
  5118. "message": {
  5119. "type": "string"
  5120. }
  5121. }
  5122. }
  5123. }
  5124. }
  5125. }
  5126. }
  5127. }
  5128. }
  5129. }
  5130. }
  5131. }
  5132. },
  5133. "/status.php": {
  5134. "get": {
  5135. "operationId": "get-status",
  5136. "responses": {
  5137. "200": {
  5138. "description": "Status returned",
  5139. "content": {
  5140. "application/json": {
  5141. "schema": {
  5142. "$ref": "#/components/schemas/Status"
  5143. }
  5144. }
  5145. }
  5146. }
  5147. }
  5148. }
  5149. }
  5150. },
  5151. "tags": [
  5152. {
  5153. "name": "avatar",
  5154. "description": "Class AvatarController"
  5155. },
  5156. {
  5157. "name": "guest_avatar",
  5158. "description": "This controller handles guest avatar requests."
  5159. },
  5160. {
  5161. "name": "ocm",
  5162. "description": "Controller about the endpoint /ocm-provider/"
  5163. }
  5164. ]
  5165. }