123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393 |
- // Code generated by swaggo/swag. DO NOT EDIT.
- package v1
- import "github.com/swaggo/swag"
- const docTemplate = `{
- "schemes": {{ marshal .Schemes }},
- "swagger": "2.0",
- "info": {
- "description": "{{escape .Description}}",
- "title": "{{.Title}}",
- "contact": {
- "name": "API Support",
- "url": "https://github.com/orgs/usememos/discussions"
- },
- "license": {
- "name": "MIT License",
- "url": "https://github.com/usememos/memos/blob/main/LICENSE"
- },
- "version": "{{.Version}}"
- },
- "host": "{{.Host}}",
- "basePath": "{{.BasePath}}",
- "paths": {
- "/api/v1/auth/signin": {
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "auth"
- ],
- "summary": "Sign-in to memos.",
- "parameters": [
- {
- "description": "Sign-in object",
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/github_com_usememos_memos_api_v1.SignIn"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "User information",
- "schema": {
- "$ref": "#/definitions/store.User"
- }
- },
- "400": {
- "description": "Malformatted signin request"
- },
- "401": {
- "description": "Password login is deactivated | Incorrect login credentials, please try again"
- },
- "403": {
- "description": "User has been archived with username %s"
- },
- "500": {
- "description": "Failed to find system setting | Failed to unmarshal system setting | Incorrect login credentials, please try again | Failed to generate tokens | Failed to create activity"
- }
- }
- }
- },
- "/api/v1/auth/signin/sso": {
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "auth"
- ],
- "summary": "Sign-in to memos using SSO.",
- "parameters": [
- {
- "description": "SSO sign-in object",
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/github_com_usememos_memos_api_v1.SSOSignIn"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "User information",
- "schema": {
- "$ref": "#/definitions/store.User"
- }
- },
- "400": {
- "description": "Malformatted signin request"
- },
- "401": {
- "description": "Access denied, identifier does not match the filter."
- },
- "403": {
- "description": "User has been archived with username {username}"
- },
- "404": {
- "description": "Identity provider not found"
- },
- "500": {
- "description": "Failed to find identity provider | Failed to create identity provider instance | Failed to exchange token | Failed to get user info | Failed to compile identifier filter | Incorrect login credentials, please try again | Failed to generate random password | Failed to generate password hash | Failed to create user | Failed to generate tokens | Failed to create activity"
- }
- }
- }
- },
- "/api/v1/auth/signout": {
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "auth"
- ],
- "summary": "Sign-out from memos.",
- "responses": {
- "200": {
- "description": "Sign-out success",
- "schema": {
- "type": "boolean"
- }
- }
- }
- }
- },
- "/api/v1/auth/signup": {
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "auth"
- ],
- "summary": "Sign-up to memos.",
- "parameters": [
- {
- "description": "Sign-up object",
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/github_com_usememos_memos_api_v1.SignUp"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "User information",
- "schema": {
- "$ref": "#/definitions/store.User"
- }
- },
- "400": {
- "description": "Malformatted signup request | Failed to find users"
- },
- "401": {
- "description": "signup is disabled"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not found"
- },
- "500": {
- "description": "Failed to find system setting | Failed to unmarshal system setting allow signup | Failed to generate password hash | Failed to create user | Failed to generate tokens | Failed to create activity"
- }
- }
- }
- },
- "/api/v1/idp": {
- "get": {
- "description": "*clientSecret is only available for host user",
- "produces": [
- "application/json"
- ],
- "tags": [
- "idp"
- ],
- "summary": "Get a list of identity providers",
- "responses": {
- "200": {
- "description": "List of available identity providers",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/api_v1.IdentityProvider"
- }
- }
- },
- "500": {
- "description": "Failed to find identity provider list | Failed to find user"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "idp"
- ],
- "summary": "Create Identity Provider",
- "parameters": [
- {
- "description": "Identity provider information",
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/api_v1.CreateIdentityProviderRequest"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Identity provider information",
- "schema": {
- "$ref": "#/definitions/store.IdentityProvider"
- }
- },
- "400": {
- "description": "Malformatted post identity provider request"
- },
- "401": {
- "description": "Missing user in session | Unauthorized"
- },
- "500": {
- "description": "Failed to find user | Failed to create identity provider"
- }
- }
- }
- },
- "/api/v1/idp/{idpId}": {
- "get": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "idp"
- ],
- "summary": "Get an identity provider by ID",
- "parameters": [
- {
- "type": "integer",
- "description": "Identity provider ID",
- "name": "idpId",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "Requested identity provider",
- "schema": {
- "$ref": "#/definitions/store.IdentityProvider"
- }
- },
- "400": {
- "description": "ID is not a number: %s"
- },
- "401": {
- "description": "Missing user in session | Unauthorized"
- },
- "404": {
- "description": "Identity provider not found"
- },
- "500": {
- "description": "Failed to find identity provider list | Failed to find user"
- }
- }
- },
- "delete": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "idp"
- ],
- "summary": "Delete an identity provider by ID",
- "parameters": [
- {
- "type": "integer",
- "description": "Identity Provider ID",
- "name": "idpId",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "Identity Provider deleted",
- "schema": {
- "type": "boolean"
- }
- },
- "400": {
- "description": "ID is not a number: %s | Malformatted patch identity provider request"
- },
- "401": {
- "description": "Missing user in session | Unauthorized"
- },
- "500": {
- "description": "Failed to find user | Failed to patch identity provider"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "idp"
- ],
- "summary": "Update an identity provider by ID",
- "parameters": [
- {
- "type": "integer",
- "description": "Identity Provider ID",
- "name": "idpId",
- "in": "path",
- "required": true
- },
- {
- "description": "Patched identity provider information",
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/api_v1.UpdateIdentityProviderRequest"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Patched identity provider",
- "schema": {
- "$ref": "#/definitions/store.IdentityProvider"
- }
- },
- "400": {
- "description": "ID is not a number: %s | Malformatted patch identity provider request"
- },
- "401": {
- "description": "Missing user in session | Unauthorized"
- },
- "500": {
- "description": "Failed to find user | Failed to patch identity provider"
- }
- }
- }
- },
- "/api/v1/memo": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "memo"
- ],
- "summary": "Get a list of memos matching optional filters",
- "parameters": [
- {
- "type": "integer",
- "description": "Creator ID",
- "name": "creatorId",
- "in": "query"
- },
- {
- "type": "string",
- "description": "Creator username",
- "name": "creatorUsername",
- "in": "query"
- },
- {
- "enum": [
- "NORMAL",
- "ARCHIVED"
- ],
- "type": "string",
- "description": "Row status",
- "name": "rowStatus",
- "in": "query"
- },
- {
- "type": "boolean",
- "description": "Pinned",
- "name": "pinned",
- "in": "query"
- },
- {
- "type": "string",
- "description": "Search for tag. Do not append #",
- "name": "tag",
- "in": "query"
- },
- {
- "type": "string",
- "description": "Search for content",
- "name": "content",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "Limit",
- "name": "limit",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "Offset",
- "name": "offset",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "description": "Memo list",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/store.Memo"
- }
- }
- },
- "400": {
- "description": "Missing user to find memo"
- },
- "500": {
- "description": "Failed to get memo display with updated ts setting value | Failed to fetch memo list | Failed to compose memo response"
- }
- }
- },
- "post": {
- "description": "Visibility can be PUBLIC, PROTECTED or PRIVATE\n*You should omit fields to use their default values",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "memo"
- ],
- "summary": "Create a memo",
- "parameters": [
- {
- "description": "Request object.",
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/github_com_usememos_memos_api_v1.CreateMemoRequest"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Stored memo",
- "schema": {
- "$ref": "#/definitions/store.Memo"
- }
- },
- "400": {
- "description": "Malformatted post memo request | Content size overflow, up to 1MB"
- },
- "401": {
- "description": "Missing user in session"
- },
- "404": {
- "description": "User not found | Memo not found: %d"
- },
- "500": {
- "description": "Failed to find user setting | Failed to unmarshal user setting value | Failed to find system setting | Failed to unmarshal system setting | Failed to find user | Failed to create memo | Failed to create activity | Failed to upsert memo resource | Failed to upsert memo relation | Failed to compose memo | Failed to compose memo response"
- }
- }
- }
- },
- "/api/v1/memo/all": {
- "get": {
- "description": "This should also list protected memos if the user is logged in\nAuthentication is optional",
- "produces": [
- "application/json"
- ],
- "tags": [
- "memo"
- ],
- "summary": "Get a list of public memos matching optional filters",
- "parameters": [
- {
- "type": "integer",
- "description": "Limit",
- "name": "limit",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "Offset",
- "name": "offset",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "description": "Memo list",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/store.Memo"
- }
- }
- },
- "500": {
- "description": "Failed to get memo display with updated ts setting value | Failed to fetch all memo list | Failed to compose memo response"
- }
- }
- }
- },
- "/api/v1/memo/stats": {
- "get": {
- "description": "Used to generate the heatmap",
- "produces": [
- "application/json"
- ],
- "tags": [
- "memo"
- ],
- "summary": "Get memo stats by creator ID or username",
- "parameters": [
- {
- "type": "integer",
- "description": "Creator ID",
- "name": "creatorId",
- "in": "query"
- },
- {
- "type": "string",
- "description": "Creator username",
- "name": "creatorUsername",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "description": "Memo createdTs list",
- "schema": {
- "type": "array",
- "items": {
- "type": "integer"
- }
- }
- },
- "400": {
- "description": "Missing user id to find memo"
- },
- "500": {
- "description": "Failed to get memo display with updated ts setting value | Failed to find memo list | Failed to compose memo response"
- }
- }
- }
- },
- "/api/v1/memo/{memoId}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "memo"
- ],
- "summary": "Get memo by ID",
- "parameters": [
- {
- "type": "integer",
- "description": "Memo ID",
- "name": "memoId",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "Memo list",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/store.Memo"
- }
- }
- },
- "400": {
- "description": "ID is not a number: %s"
- },
- "401": {
- "description": "Missing user in session"
- },
- "403": {
- "description": "this memo is private only | this memo is protected, missing user in session"
- },
- "404": {
- "description": "Memo not found: %d"
- },
- "500": {
- "description": "Failed to find memo by ID: %v | Failed to compose memo response"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "memo"
- ],
- "summary": "Delete memo by ID",
- "parameters": [
- {
- "type": "integer",
- "description": "Memo ID to delete",
- "name": "memoId",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "Memo deleted",
- "schema": {
- "type": "boolean"
- }
- },
- "400": {
- "description": "ID is not a number: %s"
- },
- "401": {
- "description": "Missing user in session | Unauthorized"
- },
- "404": {
- "description": "Memo not found: %d"
- },
- "500": {
- "description": "Failed to find memo | Failed to delete memo ID: %v"
- }
- }
- },
- "patch": {
- "description": "Visibility can be PUBLIC, PROTECTED or PRIVATE\n*You should omit fields to use their default values",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "memo"
- ],
- "summary": "Update a memo",
- "parameters": [
- {
- "type": "integer",
- "description": "ID of memo to update",
- "name": "memoId",
- "in": "path",
- "required": true
- },
- {
- "description": "Patched object.",
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/github_com_usememos_memos_api_v1.PatchMemoRequest"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Stored memo",
- "schema": {
- "$ref": "#/definitions/store.Memo"
- }
- },
- "400": {
- "description": "ID is not a number: %s | Malformatted patch memo request | Content size overflow, up to 1MB"
- },
- "401": {
- "description": "Missing user in session | Unauthorized"
- },
- "404": {
- "description": "Memo not found: %d"
- },
- "500": {
- "description": "Failed to find memo | Failed to patch memo | Failed to upsert memo resource | Failed to delete memo resource | Failed to compose memo response"
- }
- }
- }
- },
- "/api/v1/memo/{memoId}/organizer": {
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "memo-organizer"
- ],
- "summary": "Organize memo (pin/unpin)",
- "parameters": [
- {
- "type": "integer",
- "description": "ID of memo to organize",
- "name": "memoId",
- "in": "path",
- "required": true
- },
- {
- "description": "Memo organizer object",
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/github_com_usememos_memos_api_v1.UpsertMemoOrganizerRequest"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Memo information",
- "schema": {
- "$ref": "#/definitions/store.Memo"
- }
- },
- "400": {
- "description": "ID is not a number: %s | Malformatted post memo organizer request"
- },
- "401": {
- "description": "Missing user in session | Unauthorized"
- },
- "404": {
- "description": "Memo not found: %v"
- },
- "500": {
- "description": "Failed to find memo | Failed to upsert memo organizer | Failed to find memo by ID: %v | Failed to compose memo response"
- }
- }
- }
- },
- "/api/v1/memo/{memoId}/relation": {
- "get": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "memo-relation"
- ],
- "summary": "Get a list of Memo Relations",
- "parameters": [
- {
- "type": "integer",
- "description": "ID of memo to find relations",
- "name": "memoId",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "Memo relation information list",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/store.MemoRelation"
- }
- }
- },
- "400": {
- "description": "ID is not a number: %s"
- },
- "500": {
- "description": "Failed to list memo relations"
- }
- }
- },
- "post": {
- "description": "Create a relation between two memos",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "memo-relation"
- ],
- "summary": "Create Memo Relation",
- "parameters": [
- {
- "type": "integer",
- "description": "ID of memo to relate",
- "name": "memoId",
- "in": "path",
- "required": true
- },
- {
- "description": "Memo relation object",
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/github_com_usememos_memos_api_v1.UpsertMemoRelationRequest"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Memo relation information",
- "schema": {
- "$ref": "#/definitions/store.MemoRelation"
- }
- },
- "400": {
- "description": "ID is not a number: %s | Malformatted post memo relation request"
- },
- "500": {
- "description": "Failed to upsert memo relation"
- }
- }
- }
- },
- "/api/v1/memo/{memoId}/relation/{relatedMemoId}/type/{relationType}": {
- "delete": {
- "description": "Removes a relation between two memos",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "memo-relation"
- ],
- "summary": "Delete a Memo Relation",
- "parameters": [
- {
- "type": "integer",
- "description": "ID of memo to find relations",
- "name": "memoId",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "ID of memo to remove relation to",
- "name": "relatedMemoId",
- "in": "path",
- "required": true
- },
- {
- "enum": [
- "REFERENCE",
- "COMMENT"
- ],
- "type": "string",
- "description": "Type of relation to remove",
- "name": "relationType",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "Memo relation deleted",
- "schema": {
- "type": "boolean"
- }
- },
- "400": {
- "description": "Memo ID is not a number: %s | Related memo ID is not a number: %s"
- },
- "500": {
- "description": "Failed to delete memo relation"
- }
- }
- }
- },
- "/api/v1/ping": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "system"
- ],
- "summary": "Ping the system",
- "responses": {
- "200": {
- "description": "If succeed to ping the system",
- "schema": {
- "type": "boolean"
- }
- }
- }
- }
- },
- "/api/v1/resource": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "resource"
- ],
- "summary": "Get a list of resources",
- "parameters": [
- {
- "type": "integer",
- "description": "Limit",
- "name": "limit",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "Offset",
- "name": "offset",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "description": "Resource list",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/store.Resource"
- }
- }
- },
- "401": {
- "description": "Missing user in session"
- },
- "500": {
- "description": "Failed to fetch resource list"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "resource"
- ],
- "summary": "Create resource",
- "parameters": [
- {
- "description": "Request object.",
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/api_v1.CreateResourceRequest"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Created resource",
- "schema": {
- "$ref": "#/definitions/store.Resource"
- }
- },
- "400": {
- "description": "Malformatted post resource request | Invalid external link | Invalid external link scheme | Failed to request %s | Failed to read %s | Failed to read mime from %s"
- },
- "401": {
- "description": "Missing user in session"
- },
- "500": {
- "description": "Failed to save resource | Failed to create resource | Failed to create activity"
- }
- }
- }
- },
- "/api/v1/resource/blob": {
- "post": {
- "consumes": [
- "multipart/form-data"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "resource"
- ],
- "summary": "Upload resource",
- "parameters": [
- {
- "type": "file",
- "description": "File to upload",
- "name": "file",
- "in": "formData",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "Created resource",
- "schema": {
- "$ref": "#/definitions/store.Resource"
- }
- },
- "400": {
- "description": "Upload file not found | File size exceeds allowed limit of %d MiB | Failed to parse upload data"
- },
- "401": {
- "description": "Missing user in session"
- },
- "500": {
- "description": "Failed to get uploading file | Failed to open file | Failed to save resource | Failed to create resource | Failed to create activity"
- }
- }
- }
- },
- "/api/v1/resource/{resourceId}": {
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "resource"
- ],
- "summary": "Delete a resource",
- "parameters": [
- {
- "type": "integer",
- "description": "Resource ID",
- "name": "resourceId",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "Resource deleted",
- "schema": {
- "type": "boolean"
- }
- },
- "400": {
- "description": "ID is not a number: %s"
- },
- "401": {
- "description": "Missing user in session"
- },
- "404": {
- "description": "Resource not found: %d"
- },
- "500": {
- "description": "Failed to find resource | Failed to delete resource"
- }
- }
- },
- "patch": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "resource"
- ],
- "summary": "Update a resource",
- "parameters": [
- {
- "type": "integer",
- "description": "Resource ID",
- "name": "resourceId",
- "in": "path",
- "required": true
- },
- {
- "description": "Patch resource request",
- "name": "patch",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/api_v1.UpdateResourceRequest"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Updated resource",
- "schema": {
- "$ref": "#/definitions/store.Resource"
- }
- },
- "400": {
- "description": "ID is not a number: %s | Malformatted patch resource request"
- },
- "401": {
- "description": "Missing user in session | Unauthorized"
- },
- "404": {
- "description": "Resource not found: %d"
- },
- "500": {
- "description": "Failed to find resource | Failed to patch resource"
- }
- }
- }
- },
- "/api/v1/status": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "system"
- ],
- "summary": "Get system GetSystemStatus",
- "responses": {
- "200": {
- "description": "System GetSystemStatus",
- "schema": {
- "$ref": "#/definitions/api_v1.SystemStatus"
- }
- },
- "401": {
- "description": "Missing user in session | Unauthorized"
- },
- "500": {
- "description": "Failed to find host user | Failed to find system setting list | Failed to unmarshal system setting customized profile value"
- }
- }
- }
- },
- "/api/v1/storage": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "storage"
- ],
- "summary": "Get a list of storages",
- "responses": {
- "200": {
- "description": "List of storages",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/store.Storage"
- }
- }
- },
- "401": {
- "description": "Missing user in session | Unauthorized"
- },
- "500": {
- "description": "Failed to find user | Failed to convert storage"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "storage"
- ],
- "summary": "Create storage",
- "parameters": [
- {
- "description": "Request object.",
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/github_com_usememos_memos_api_v1.CreateStorageRequest"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Created storage",
- "schema": {
- "$ref": "#/definitions/store.Storage"
- }
- },
- "400": {
- "description": "Malformatted post storage request"
- },
- "401": {
- "description": "Missing user in session"
- },
- "500": {
- "description": "Failed to find user | Failed to create storage | Failed to convert storage"
- }
- }
- }
- },
- "/api/v1/storage/{storageId}": {
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "storage"
- ],
- "summary": "Delete a storage",
- "parameters": [
- {
- "type": "integer",
- "description": "Storage ID",
- "name": "storageId",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "Storage deleted",
- "schema": {
- "type": "boolean"
- }
- },
- "400": {
- "description": "ID is not a number: %s | Storage service %d is using"
- },
- "401": {
- "description": "Missing user in session | Unauthorized"
- },
- "500": {
- "description": "Failed to find user | Failed to find storage | Failed to unmarshal storage service id | Failed to delete storage"
- }
- }
- },
- "patch": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "storage"
- ],
- "summary": "Update a storage",
- "parameters": [
- {
- "type": "integer",
- "description": "Storage ID",
- "name": "storageId",
- "in": "path",
- "required": true
- },
- {
- "description": "Patch request",
- "name": "patch",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/github_com_usememos_memos_api_v1.UpdateStorageRequest"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Updated resource",
- "schema": {
- "$ref": "#/definitions/store.Storage"
- }
- },
- "400": {
- "description": "ID is not a number: %s | Malformatted patch storage request | Malformatted post storage request"
- },
- "401": {
- "description": "Missing user in session | Unauthorized"
- },
- "500": {
- "description": "Failed to find user | Failed to patch storage | Failed to convert storage"
- }
- }
- }
- },
- "/api/v1/system/setting": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "system-setting"
- ],
- "summary": "Get a list of system settings",
- "responses": {
- "200": {
- "description": "System setting list",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/api_v1.SystemSetting"
- }
- }
- },
- "401": {
- "description": "Missing user in session | Unauthorized"
- },
- "500": {
- "description": "Failed to find user | Failed to find system setting list"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "system-setting"
- ],
- "summary": "Create system setting",
- "parameters": [
- {
- "description": "Request object.",
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/api_v1.UpsertSystemSettingRequest"
- }
- }
- ],
- "responses": {
- "400": {
- "description": "Malformatted post system setting request | invalid system setting"
- },
- "401": {
- "description": "Missing user in session | Unauthorized"
- },
- "403": {
- "description": "Cannot disable passwords if no SSO identity provider is configured."
- },
- "500": {
- "description": "Failed to find user | Failed to upsert system setting"
- }
- }
- }
- },
- "/api/v1/system/vacuum": {
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "system"
- ],
- "summary": "Vacuum the database",
- "responses": {
- "200": {
- "description": "Database vacuumed",
- "schema": {
- "type": "boolean"
- }
- },
- "401": {
- "description": "Missing user in session | Unauthorized"
- },
- "500": {
- "description": "Failed to find user | Failed to ExecVacuum database"
- }
- }
- }
- },
- "/api/v1/tag": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "tag"
- ],
- "summary": "Get a list of tags",
- "responses": {
- "200": {
- "description": "Tag list",
- "schema": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "400": {
- "description": "Missing user id to find tag"
- },
- "500": {
- "description": "Failed to find tag list"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "tag"
- ],
- "summary": "Create a tag",
- "parameters": [
- {
- "description": "Request object.",
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/github_com_usememos_memos_api_v1.UpsertTagRequest"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Created tag name",
- "schema": {
- "type": "string"
- }
- },
- "400": {
- "description": "Malformatted post tag request | Tag name shouldn't be empty"
- },
- "401": {
- "description": "Missing user in session"
- },
- "500": {
- "description": "Failed to upsert tag | Failed to create activity"
- }
- }
- }
- },
- "/api/v1/tag/delete": {
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "tag"
- ],
- "summary": "Delete a tag",
- "parameters": [
- {
- "description": "Request object.",
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/github_com_usememos_memos_api_v1.DeleteTagRequest"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Tag deleted",
- "schema": {
- "type": "boolean"
- }
- },
- "400": {
- "description": "Malformatted post tag request | Tag name shouldn't be empty"
- },
- "401": {
- "description": "Missing user in session"
- },
- "500": {
- "description": "Failed to delete tag name: %v"
- }
- }
- }
- },
- "/api/v1/tag/suggestion": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "tag"
- ],
- "summary": "Get a list of tags suggested from other memos contents",
- "responses": {
- "200": {
- "description": "Tag list",
- "schema": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "400": {
- "description": "Missing user session"
- },
- "500": {
- "description": "Failed to find memo list | Failed to find tag list"
- }
- }
- }
- },
- "/api/v1/user": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Get a list of users",
- "responses": {
- "200": {
- "description": "User list",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/store.User"
- }
- }
- },
- "500": {
- "description": "Failed to fetch user list"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Create a user",
- "parameters": [
- {
- "description": "Request object",
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/api_v1.CreateUserRequest"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Created user",
- "schema": {
- "$ref": "#/definitions/store.User"
- }
- },
- "400": {
- "description": "Malformatted post user request | Invalid user create format"
- },
- "401": {
- "description": "Missing auth session | Unauthorized to create user"
- },
- "403": {
- "description": "Could not create host user"
- },
- "500": {
- "description": "Failed to find user by id | Failed to generate password hash | Failed to create user | Failed to create activity"
- }
- }
- }
- },
- "/api/v1/user/me": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Get current user",
- "responses": {
- "200": {
- "description": "Current user",
- "schema": {
- "$ref": "#/definitions/store.User"
- }
- },
- "401": {
- "description": "Missing auth session"
- },
- "500": {
- "description": "Failed to find user | Failed to find userSettingList"
- }
- }
- }
- },
- "/api/v1/user/name/{username}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Get user by username",
- "parameters": [
- {
- "type": "string",
- "description": "Username",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "Requested user",
- "schema": {
- "$ref": "#/definitions/store.User"
- }
- },
- "404": {
- "description": "User not found"
- },
- "500": {
- "description": "Failed to find user"
- }
- }
- }
- },
- "/api/v1/user/{id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Get user by id",
- "parameters": [
- {
- "type": "integer",
- "description": "User ID",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "Requested user",
- "schema": {
- "$ref": "#/definitions/store.User"
- }
- },
- "400": {
- "description": "Malformatted user id"
- },
- "404": {
- "description": "User not found"
- },
- "500": {
- "description": "Failed to find user"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Delete a user",
- "parameters": [
- {
- "type": "string",
- "description": "User ID",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "User deleted",
- "schema": {
- "type": "boolean"
- }
- },
- "400": {
- "description": "ID is not a number: %s | Current session user not found with ID: %d"
- },
- "401": {
- "description": "Missing user in session"
- },
- "403": {
- "description": "Unauthorized to delete user"
- },
- "500": {
- "description": "Failed to find user | Failed to delete user"
- }
- }
- },
- "patch": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Update a user",
- "parameters": [
- {
- "type": "string",
- "description": "User ID",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "description": "Patch request",
- "name": "patch",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/api_v1.UpdateUserRequest"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Updated user",
- "schema": {
- "$ref": "#/definitions/store.User"
- }
- },
- "400": {
- "description": "ID is not a number: %s | Current session user not found with ID: %d | Malformatted patch user request | Invalid update user request"
- },
- "401": {
- "description": "Missing user in session"
- },
- "403": {
- "description": "Unauthorized to update user"
- },
- "500": {
- "description": "Failed to find user | Failed to generate password hash | Failed to patch user | Failed to find userSettingList"
- }
- }
- }
- },
- "/o/get/GetImage": {
- "get": {
- "produces": [
- "GetImage/*"
- ],
- "tags": [
- "image-url"
- ],
- "summary": "Get GetImage from URL",
- "parameters": [
- {
- "type": "string",
- "description": "Image url",
- "name": "url",
- "in": "query",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "Image"
- },
- "400": {
- "description": "Missing GetImage url | Wrong url | Failed to get GetImage url: %s"
- },
- "500": {
- "description": "Failed to write GetImage blob"
- }
- }
- }
- }
- },
- "definitions": {
- "api_v1.CreateIdentityProviderRequest": {
- "type": "object",
- "properties": {
- "config": {
- "$ref": "#/definitions/api_v1.IdentityProviderConfig"
- },
- "identifierFilter": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "type": {
- "$ref": "#/definitions/api_v1.IdentityProviderType"
- }
- }
- },
- "api_v1.CreateMemoRequest": {
- "type": "object",
- "properties": {
- "content": {
- "type": "string"
- },
- "createdTs": {
- "type": "integer"
- },
- "relationList": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/api_v1.UpsertMemoRelationRequest"
- }
- },
- "resourceIdList": {
- "description": "Related fields",
- "type": "array",
- "items": {
- "type": "integer"
- }
- },
- "visibility": {
- "description": "Domain specific fields",
- "allOf": [
- {
- "$ref": "#/definitions/api_v1.Visibility"
- }
- ]
- }
- }
- },
- "api_v1.CreateResourceRequest": {
- "type": "object",
- "properties": {
- "externalLink": {
- "type": "string"
- },
- "filename": {
- "type": "string"
- },
- "type": {
- "type": "string"
- }
- }
- },
- "api_v1.CreateStorageRequest": {
- "type": "object",
- "properties": {
- "config": {
- "$ref": "#/definitions/api_v1.StorageConfig"
- },
- "name": {
- "type": "string"
- },
- "type": {
- "$ref": "#/definitions/api_v1.StorageType"
- }
- }
- },
- "api_v1.CreateUserRequest": {
- "type": "object",
- "properties": {
- "email": {
- "type": "string"
- },
- "nickname": {
- "type": "string"
- },
- "password": {
- "type": "string"
- },
- "role": {
- "$ref": "#/definitions/api_v1.Role"
- },
- "username": {
- "type": "string"
- }
- }
- },
- "api_v1.CustomizedProfile": {
- "type": "object",
- "properties": {
- "appearance": {
- "description": "Appearance is the server default appearance.",
- "type": "string"
- },
- "description": {
- "description": "Description is the server description.",
- "type": "string"
- },
- "locale": {
- "description": "Locale is the server default locale.",
- "type": "string"
- },
- "logoUrl": {
- "description": "LogoURL is the url of logo image.",
- "type": "string"
- },
- "name": {
- "description": "Name is the server name, default is ` + "`" + `memos` + "`" + `",
- "type": "string"
- }
- }
- },
- "api_v1.DeleteTagRequest": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- }
- }
- },
- "api_v1.FieldMapping": {
- "type": "object",
- "properties": {
- "displayName": {
- "type": "string"
- },
- "email": {
- "type": "string"
- },
- "identifier": {
- "type": "string"
- }
- }
- },
- "api_v1.IdentityProvider": {
- "type": "object",
- "properties": {
- "config": {
- "$ref": "#/definitions/api_v1.IdentityProviderConfig"
- },
- "id": {
- "type": "integer"
- },
- "identifierFilter": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "type": {
- "$ref": "#/definitions/api_v1.IdentityProviderType"
- }
- }
- },
- "api_v1.IdentityProviderConfig": {
- "type": "object",
- "properties": {
- "oauth2Config": {
- "$ref": "#/definitions/api_v1.IdentityProviderOAuth2Config"
- }
- }
- },
- "api_v1.IdentityProviderOAuth2Config": {
- "type": "object",
- "properties": {
- "authUrl": {
- "type": "string"
- },
- "clientId": {
- "type": "string"
- },
- "clientSecret": {
- "type": "string"
- },
- "fieldMapping": {
- "$ref": "#/definitions/api_v1.FieldMapping"
- },
- "scopes": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "tokenUrl": {
- "type": "string"
- },
- "userInfoUrl": {
- "type": "string"
- }
- }
- },
- "api_v1.IdentityProviderType": {
- "type": "string",
- "enum": [
- "OAUTH2"
- ],
- "x-enum-varnames": [
- "IdentityProviderOAuth2Type"
- ]
- },
- "api_v1.MemoRelationType": {
- "type": "string",
- "enum": [
- "REFERENCE",
- "COMMENT"
- ],
- "x-enum-varnames": [
- "MemoRelationReference",
- "MemoRelationComment"
- ]
- },
- "api_v1.PatchMemoRequest": {
- "type": "object",
- "properties": {
- "content": {
- "description": "Domain specific fields",
- "type": "string"
- },
- "createdTs": {
- "description": "Standard fields",
- "type": "integer"
- },
- "relationList": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/api_v1.UpsertMemoRelationRequest"
- }
- },
- "resourceIdList": {
- "description": "Related fields",
- "type": "array",
- "items": {
- "type": "integer"
- }
- },
- "rowStatus": {
- "$ref": "#/definitions/api_v1.RowStatus"
- },
- "updatedTs": {
- "type": "integer"
- },
- "visibility": {
- "$ref": "#/definitions/api_v1.Visibility"
- }
- }
- },
- "api_v1.Role": {
- "type": "string",
- "enum": [
- "HOST",
- "ADMIN",
- "USER"
- ],
- "x-enum-varnames": [
- "RoleHost",
- "RoleAdmin",
- "RoleUser"
- ]
- },
- "api_v1.RowStatus": {
- "type": "string",
- "enum": [
- "NORMAL",
- "ARCHIVED"
- ],
- "x-enum-varnames": [
- "Normal",
- "Archived"
- ]
- },
- "api_v1.SSOSignIn": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string"
- },
- "identityProviderId": {
- "type": "integer"
- },
- "redirectUri": {
- "type": "string"
- }
- }
- },
- "api_v1.SignIn": {
- "type": "object",
- "properties": {
- "password": {
- "type": "string"
- },
- "remember": {
- "type": "boolean"
- },
- "username": {
- "type": "string"
- }
- }
- },
- "api_v1.SignUp": {
- "type": "object",
- "properties": {
- "password": {
- "type": "string"
- },
- "username": {
- "type": "string"
- }
- }
- },
- "api_v1.StorageConfig": {
- "type": "object",
- "properties": {
- "s3Config": {
- "$ref": "#/definitions/api_v1.StorageS3Config"
- }
- }
- },
- "api_v1.StorageS3Config": {
- "type": "object",
- "properties": {
- "accessKey": {
- "type": "string"
- },
- "bucket": {
- "type": "string"
- },
- "endPoint": {
- "type": "string"
- },
- "path": {
- "type": "string"
- },
- "presign": {
- "type": "boolean"
- },
- "region": {
- "type": "string"
- },
- "secretKey": {
- "type": "string"
- },
- "urlPrefix": {
- "type": "string"
- },
- "urlSuffix": {
- "type": "string"
- }
- }
- },
- "api_v1.StorageType": {
- "type": "string",
- "enum": [
- "S3"
- ],
- "x-enum-varnames": [
- "StorageS3"
- ]
- },
- "api_v1.SystemSetting": {
- "type": "object",
- "properties": {
- "description": {
- "type": "string"
- },
- "name": {
- "$ref": "#/definitions/api_v1.SystemSettingName"
- },
- "value": {
- "description": "Value is a JSON string with basic value.",
- "type": "string"
- }
- }
- },
- "api_v1.SystemSettingName": {
- "type": "string",
- "enum": [
- "server-id",
- "secret-session",
- "disable-public-memos",
- "max-upload-size-mib",
- "customized-profile",
- "storage-service-id",
- "local-storage-path",
- "telegram-bot-token",
- "memo-display-with-updated-ts"
- ],
- "x-enum-varnames": [
- "SystemSettingServerIDName",
- "SystemSettingSecretSessionName",
- "SystemSettingDisablePublicMemosName",
- "SystemSettingMaxUploadSizeMiBName",
- "SystemSettingCustomizedProfileName",
- "SystemSettingStorageServiceIDName",
- "SystemSettingLocalStoragePathName",
- "SystemSettingTelegramBotTokenName",
- "SystemSettingMemoDisplayWithUpdatedTsName"
- ]
- },
- "api_v1.SystemStatus": {
- "type": "object",
- "properties": {
- "additionalScript": {
- "description": "Additional script.",
- "type": "string"
- },
- "additionalStyle": {
- "description": "Additional style.",
- "type": "string"
- },
- "allowSignUp": {
- "description": "System settings\nAllow sign up.",
- "type": "boolean"
- },
- "customizedProfile": {
- "description": "Customized server profile, including server name and external url.",
- "allOf": [
- {
- "$ref": "#/definitions/api_v1.CustomizedProfile"
- }
- ]
- },
- "dbSize": {
- "type": "integer"
- },
- "disablePasswordLogin": {
- "description": "Disable password login.",
- "type": "boolean"
- },
- "disablePublicMemos": {
- "description": "Disable public memos.",
- "type": "boolean"
- },
- "host": {
- "$ref": "#/definitions/api_v1.User"
- },
- "localStoragePath": {
- "description": "Local storage path.",
- "type": "string"
- },
- "maxUploadSizeMiB": {
- "description": "Max upload size.",
- "type": "integer"
- },
- "memoDisplayWithUpdatedTs": {
- "description": "Memo display with updated timestamp.",
- "type": "boolean"
- },
- "profile": {
- "$ref": "#/definitions/profile.Profile"
- },
- "storageServiceId": {
- "description": "Storage service ID.",
- "type": "integer"
- }
- }
- },
- "api_v1.UpdateIdentityProviderRequest": {
- "type": "object",
- "properties": {
- "config": {
- "$ref": "#/definitions/api_v1.IdentityProviderConfig"
- },
- "identifierFilter": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "type": {
- "$ref": "#/definitions/api_v1.IdentityProviderType"
- }
- }
- },
- "api_v1.UpdateResourceRequest": {
- "type": "object",
- "properties": {
- "filename": {
- "type": "string"
- }
- }
- },
- "api_v1.UpdateStorageRequest": {
- "type": "object",
- "properties": {
- "config": {
- "$ref": "#/definitions/api_v1.StorageConfig"
- },
- "name": {
- "type": "string"
- },
- "type": {
- "$ref": "#/definitions/api_v1.StorageType"
- }
- }
- },
- "api_v1.UpdateUserRequest": {
- "type": "object",
- "properties": {
- "avatarUrl": {
- "type": "string"
- },
- "email": {
- "type": "string"
- },
- "nickname": {
- "type": "string"
- },
- "password": {
- "type": "string"
- },
- "rowStatus": {
- "$ref": "#/definitions/api_v1.RowStatus"
- },
- "username": {
- "type": "string"
- }
- }
- },
- "api_v1.UpsertMemoOrganizerRequest": {
- "type": "object",
- "properties": {
- "pinned": {
- "type": "boolean"
- }
- }
- },
- "api_v1.UpsertMemoRelationRequest": {
- "type": "object",
- "properties": {
- "relatedMemoId": {
- "type": "integer"
- },
- "type": {
- "$ref": "#/definitions/api_v1.MemoRelationType"
- }
- }
- },
- "api_v1.UpsertSystemSettingRequest": {
- "type": "object",
- "properties": {
- "description": {
- "type": "string"
- },
- "name": {
- "$ref": "#/definitions/api_v1.SystemSettingName"
- },
- "value": {
- "type": "string"
- }
- }
- },
- "api_v1.UpsertTagRequest": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- }
- }
- },
- "api_v1.User": {
- "type": "object",
- "properties": {
- "avatarUrl": {
- "type": "string"
- },
- "createdTs": {
- "type": "integer"
- },
- "email": {
- "type": "string"
- },
- "id": {
- "type": "integer"
- },
- "nickname": {
- "type": "string"
- },
- "role": {
- "$ref": "#/definitions/api_v1.Role"
- },
- "rowStatus": {
- "description": "Standard fields",
- "allOf": [
- {
- "$ref": "#/definitions/api_v1.RowStatus"
- }
- ]
- },
- "updatedTs": {
- "type": "integer"
- },
- "username": {
- "description": "Domain specific fields",
- "type": "string"
- }
- }
- },
- "api_v1.Visibility": {
- "type": "string",
- "enum": [
- "PUBLIC",
- "PROTECTED",
- "PRIVATE"
- ],
- "x-enum-varnames": [
- "Public",
- "Protected",
- "Private"
- ]
- },
- "github_com_usememos_memos_api_v1.CreateIdentityProviderRequest": {
- "type": "object",
- "properties": {
- "config": {
- "$ref": "#/definitions/github_com_usememos_memos_api_v1.IdentityProviderConfig"
- },
- "identifierFilter": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "type": {
- "$ref": "#/definitions/github_com_usememos_memos_api_v1.IdentityProviderType"
- }
- }
- },
- "github_com_usememos_memos_api_v1.CreateMemoRequest": {
- "type": "object",
- "properties": {
- "content": {
- "type": "string"
- },
- "createdTs": {
- "type": "integer"
- },
- "relationList": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/github_com_usememos_memos_api_v1.UpsertMemoRelationRequest"
- }
- },
- "resourceIdList": {
- "description": "Related fields",
- "type": "array",
- "items": {
- "type": "integer"
- }
- },
- "visibility": {
- "description": "Domain specific fields",
- "allOf": [
- {
- "$ref": "#/definitions/github_com_usememos_memos_api_v1.Visibility"
- }
- ]
- }
- }
- },
- "github_com_usememos_memos_api_v1.CreateResourceRequest": {
- "type": "object",
- "properties": {
- "externalLink": {
- "type": "string"
- },
- "filename": {
- "type": "string"
- },
- "type": {
- "type": "string"
- }
- }
- },
- "github_com_usememos_memos_api_v1.CreateStorageRequest": {
- "type": "object",
- "properties": {
- "config": {
- "$ref": "#/definitions/github_com_usememos_memos_api_v1.StorageConfig"
- },
- "name": {
- "type": "string"
- },
- "type": {
- "$ref": "#/definitions/github_com_usememos_memos_api_v1.StorageType"
- }
- }
- },
- "github_com_usememos_memos_api_v1.CreateUserRequest": {
- "type": "object",
- "properties": {
- "email": {
- "type": "string"
- },
- "nickname": {
- "type": "string"
- },
- "password": {
- "type": "string"
- },
- "role": {
- "$ref": "#/definitions/github_com_usememos_memos_api_v1.Role"
- },
- "username": {
- "type": "string"
- }
- }
- },
- "github_com_usememos_memos_api_v1.CustomizedProfile": {
- "type": "object",
- "properties": {
- "appearance": {
- "description": "Appearance is the server default appearance.",
- "type": "string"
- },
- "description": {
- "description": "Description is the server description.",
- "type": "string"
- },
- "locale": {
- "description": "Locale is the server default locale.",
- "type": "string"
- },
- "logoUrl": {
- "description": "LogoURL is the url of logo image.",
- "type": "string"
- },
- "name": {
- "description": "Name is the server name, default is ` + "`" + `memos` + "`" + `",
- "type": "string"
- }
- }
- },
- "github_com_usememos_memos_api_v1.DeleteTagRequest": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- }
- }
- },
- "github_com_usememos_memos_api_v1.FieldMapping": {
- "type": "object",
- "properties": {
- "displayName": {
- "type": "string"
- },
- "email": {
- "type": "string"
- },
- "identifier": {
- "type": "string"
- }
- }
- },
- "github_com_usememos_memos_api_v1.IdentityProvider": {
- "type": "object",
- "properties": {
- "config": {
- "$ref": "#/definitions/github_com_usememos_memos_api_v1.IdentityProviderConfig"
- },
- "id": {
- "type": "integer"
- },
- "identifierFilter": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "type": {
- "$ref": "#/definitions/github_com_usememos_memos_api_v1.IdentityProviderType"
- }
- }
- },
- "github_com_usememos_memos_api_v1.IdentityProviderConfig": {
- "type": "object",
- "properties": {
- "oauth2Config": {
- "$ref": "#/definitions/github_com_usememos_memos_api_v1.IdentityProviderOAuth2Config"
- }
- }
- },
- "github_com_usememos_memos_api_v1.IdentityProviderOAuth2Config": {
- "type": "object",
- "properties": {
- "authUrl": {
- "type": "string"
- },
- "clientId": {
- "type": "string"
- },
- "clientSecret": {
- "type": "string"
- },
- "fieldMapping": {
- "$ref": "#/definitions/github_com_usememos_memos_api_v1.FieldMapping"
- },
- "scopes": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "tokenUrl": {
- "type": "string"
- },
- "userInfoUrl": {
- "type": "string"
- }
- }
- },
- "github_com_usememos_memos_api_v1.IdentityProviderType": {
- "type": "string",
- "enum": [
- "OAUTH2"
- ],
- "x-enum-varnames": [
- "IdentityProviderOAuth2Type"
- ]
- },
- "github_com_usememos_memos_api_v1.MemoRelationType": {
- "type": "string",
- "enum": [
- "REFERENCE",
- "COMMENT"
- ],
- "x-enum-varnames": [
- "MemoRelationReference",
- "MemoRelationComment"
- ]
- },
- "github_com_usememos_memos_api_v1.PatchMemoRequest": {
- "type": "object",
- "properties": {
- "content": {
- "description": "Domain specific fields",
- "type": "string"
- },
- "createdTs": {
- "description": "Standard fields",
- "type": "integer"
- },
- "relationList": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/github_com_usememos_memos_api_v1.UpsertMemoRelationRequest"
- }
- },
- "resourceIdList": {
- "description": "Related fields",
- "type": "array",
- "items": {
- "type": "integer"
- }
- },
- "rowStatus": {
- "$ref": "#/definitions/github_com_usememos_memos_api_v1.RowStatus"
- },
- "updatedTs": {
- "type": "integer"
- },
- "visibility": {
- "$ref": "#/definitions/github_com_usememos_memos_api_v1.Visibility"
- }
- }
- },
- "github_com_usememos_memos_api_v1.Role": {
- "type": "string",
- "enum": [
- "HOST",
- "ADMIN",
- "USER"
- ],
- "x-enum-varnames": [
- "RoleHost",
- "RoleAdmin",
- "RoleUser"
- ]
- },
- "github_com_usememos_memos_api_v1.RowStatus": {
- "type": "string",
- "enum": [
- "NORMAL",
- "ARCHIVED"
- ],
- "x-enum-varnames": [
- "Normal",
- "Archived"
- ]
- },
- "github_com_usememos_memos_api_v1.SSOSignIn": {
- "type": "object",
- "properties": {
- "code": {
- "type": "string"
- },
- "identityProviderId": {
- "type": "integer"
- },
- "redirectUri": {
- "type": "string"
- }
- }
- },
- "github_com_usememos_memos_api_v1.SignIn": {
- "type": "object",
- "properties": {
- "password": {
- "type": "string"
- },
- "remember": {
- "type": "boolean"
- },
- "username": {
- "type": "string"
- }
- }
- },
- "github_com_usememos_memos_api_v1.SignUp": {
- "type": "object",
- "properties": {
- "password": {
- "type": "string"
- },
- "username": {
- "type": "string"
- }
- }
- },
- "github_com_usememos_memos_api_v1.StorageConfig": {
- "type": "object",
- "properties": {
- "s3Config": {
- "$ref": "#/definitions/github_com_usememos_memos_api_v1.StorageS3Config"
- }
- }
- },
- "github_com_usememos_memos_api_v1.StorageS3Config": {
- "type": "object",
- "properties": {
- "accessKey": {
- "type": "string"
- },
- "bucket": {
- "type": "string"
- },
- "endPoint": {
- "type": "string"
- },
- "path": {
- "type": "string"
- },
- "presign": {
- "type": "boolean"
- },
- "region": {
- "type": "string"
- },
- "secretKey": {
- "type": "string"
- },
- "urlPrefix": {
- "type": "string"
- },
- "urlSuffix": {
- "type": "string"
- }
- }
- },
- "github_com_usememos_memos_api_v1.StorageType": {
- "type": "string",
- "enum": [
- "S3"
- ],
- "x-enum-varnames": [
- "StorageS3"
- ]
- },
- "github_com_usememos_memos_api_v1.SystemSetting": {
- "type": "object",
- "properties": {
- "description": {
- "type": "string"
- },
- "name": {
- "$ref": "#/definitions/github_com_usememos_memos_api_v1.SystemSettingName"
- },
- "value": {
- "description": "Value is a JSON string with basic value.",
- "type": "string"
- }
- }
- },
- "github_com_usememos_memos_api_v1.SystemSettingName": {
- "type": "string",
- "enum": [
- "server-id",
- "secret-session",
- "disable-public-memos",
- "max-upload-size-mib",
- "customized-profile",
- "storage-service-id",
- "local-storage-path",
- "telegram-bot-token",
- "memo-display-with-updated-ts"
- ],
- "x-enum-varnames": [
- "SystemSettingServerIDName",
- "SystemSettingSecretSessionName",
- "SystemSettingDisablePublicMemosName",
- "SystemSettingMaxUploadSizeMiBName",
- "SystemSettingCustomizedProfileName",
- "SystemSettingStorageServiceIDName",
- "SystemSettingLocalStoragePathName",
- "SystemSettingTelegramBotTokenName",
- "SystemSettingMemoDisplayWithUpdatedTsName"
- ]
- },
- "github_com_usememos_memos_api_v1.SystemStatus": {
- "type": "object",
- "properties": {
- "additionalScript": {
- "description": "Additional script.",
- "type": "string"
- },
- "additionalStyle": {
- "description": "Additional style.",
- "type": "string"
- },
- "allowSignUp": {
- "description": "System settings\nAllow sign up.",
- "type": "boolean"
- },
- "customizedProfile": {
- "description": "Customized server profile, including server name and external url.",
- "allOf": [
- {
- "$ref": "#/definitions/github_com_usememos_memos_api_v1.CustomizedProfile"
- }
- ]
- },
- "dbSize": {
- "type": "integer"
- },
- "disablePasswordLogin": {
- "description": "Disable password login.",
- "type": "boolean"
- },
- "disablePublicMemos": {
- "description": "Disable public memos.",
- "type": "boolean"
- },
- "host": {
- "$ref": "#/definitions/github_com_usememos_memos_api_v1.User"
- },
- "localStoragePath": {
- "description": "Local storage path.",
- "type": "string"
- },
- "maxUploadSizeMiB": {
- "description": "Max upload size.",
- "type": "integer"
- },
- "memoDisplayWithUpdatedTs": {
- "description": "Memo display with updated timestamp.",
- "type": "boolean"
- },
- "profile": {
- "$ref": "#/definitions/profile.Profile"
- },
- "storageServiceId": {
- "description": "Storage service ID.",
- "type": "integer"
- }
- }
- },
- "github_com_usememos_memos_api_v1.UpdateIdentityProviderRequest": {
- "type": "object",
- "properties": {
- "config": {
- "$ref": "#/definitions/github_com_usememos_memos_api_v1.IdentityProviderConfig"
- },
- "identifierFilter": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "type": {
- "$ref": "#/definitions/github_com_usememos_memos_api_v1.IdentityProviderType"
- }
- }
- },
- "github_com_usememos_memos_api_v1.UpdateResourceRequest": {
- "type": "object",
- "properties": {
- "filename": {
- "type": "string"
- }
- }
- },
- "github_com_usememos_memos_api_v1.UpdateStorageRequest": {
- "type": "object",
- "properties": {
- "config": {
- "$ref": "#/definitions/github_com_usememos_memos_api_v1.StorageConfig"
- },
- "name": {
- "type": "string"
- },
- "type": {
- "$ref": "#/definitions/github_com_usememos_memos_api_v1.StorageType"
- }
- }
- },
- "github_com_usememos_memos_api_v1.UpdateUserRequest": {
- "type": "object",
- "properties": {
- "avatarUrl": {
- "type": "string"
- },
- "email": {
- "type": "string"
- },
- "nickname": {
- "type": "string"
- },
- "password": {
- "type": "string"
- },
- "rowStatus": {
- "$ref": "#/definitions/github_com_usememos_memos_api_v1.RowStatus"
- },
- "username": {
- "type": "string"
- }
- }
- },
- "github_com_usememos_memos_api_v1.UpsertMemoOrganizerRequest": {
- "type": "object",
- "properties": {
- "pinned": {
- "type": "boolean"
- }
- }
- },
- "github_com_usememos_memos_api_v1.UpsertMemoRelationRequest": {
- "type": "object",
- "properties": {
- "relatedMemoId": {
- "type": "integer"
- },
- "type": {
- "$ref": "#/definitions/github_com_usememos_memos_api_v1.MemoRelationType"
- }
- }
- },
- "github_com_usememos_memos_api_v1.UpsertSystemSettingRequest": {
- "type": "object",
- "properties": {
- "description": {
- "type": "string"
- },
- "name": {
- "$ref": "#/definitions/github_com_usememos_memos_api_v1.SystemSettingName"
- },
- "value": {
- "type": "string"
- }
- }
- },
- "github_com_usememos_memos_api_v1.UpsertTagRequest": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- }
- }
- },
- "github_com_usememos_memos_api_v1.User": {
- "type": "object",
- "properties": {
- "avatarUrl": {
- "type": "string"
- },
- "createdTs": {
- "type": "integer"
- },
- "email": {
- "type": "string"
- },
- "id": {
- "type": "integer"
- },
- "nickname": {
- "type": "string"
- },
- "role": {
- "$ref": "#/definitions/github_com_usememos_memos_api_v1.Role"
- },
- "rowStatus": {
- "description": "Standard fields",
- "allOf": [
- {
- "$ref": "#/definitions/github_com_usememos_memos_api_v1.RowStatus"
- }
- ]
- },
- "updatedTs": {
- "type": "integer"
- },
- "username": {
- "description": "Domain specific fields",
- "type": "string"
- }
- }
- },
- "github_com_usememos_memos_api_v1.Visibility": {
- "type": "string",
- "enum": [
- "PUBLIC",
- "PROTECTED",
- "PRIVATE"
- ],
- "x-enum-varnames": [
- "Public",
- "Protected",
- "Private"
- ]
- },
- "profile.Profile": {
- "type": "object",
- "properties": {
- "mode": {
- "description": "Mode can be \"prod\" or \"dev\" or \"demo\"",
- "type": "string"
- },
- "version": {
- "description": "Version is the current version of server",
- "type": "string"
- }
- }
- },
- "store.FieldMapping": {
- "type": "object",
- "properties": {
- "displayName": {
- "type": "string"
- },
- "email": {
- "type": "string"
- },
- "identifier": {
- "type": "string"
- }
- }
- },
- "store.IdentityProvider": {
- "type": "object",
- "properties": {
- "config": {
- "$ref": "#/definitions/store.IdentityProviderConfig"
- },
- "id": {
- "type": "integer"
- },
- "identifierFilter": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "type": {
- "$ref": "#/definitions/store.IdentityProviderType"
- }
- }
- },
- "store.IdentityProviderConfig": {
- "type": "object",
- "properties": {
- "oauth2Config": {
- "$ref": "#/definitions/store.IdentityProviderOAuth2Config"
- }
- }
- },
- "store.IdentityProviderOAuth2Config": {
- "type": "object",
- "properties": {
- "authUrl": {
- "type": "string"
- },
- "clientId": {
- "type": "string"
- },
- "clientSecret": {
- "type": "string"
- },
- "fieldMapping": {
- "$ref": "#/definitions/store.FieldMapping"
- },
- "scopes": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "tokenUrl": {
- "type": "string"
- },
- "userInfoUrl": {
- "type": "string"
- }
- }
- },
- "store.IdentityProviderType": {
- "type": "string",
- "enum": [
- "OAUTH2"
- ],
- "x-enum-varnames": [
- "IdentityProviderOAuth2Type"
- ]
- },
- "store.Memo": {
- "type": "object",
- "properties": {
- "content": {
- "description": "Domain specific fields",
- "type": "string"
- },
- "createdTs": {
- "type": "integer"
- },
- "creatorID": {
- "type": "integer"
- },
- "id": {
- "type": "integer"
- },
- "parentID": {
- "type": "integer"
- },
- "pinned": {
- "description": "Composed fields",
- "type": "boolean"
- },
- "resourceName": {
- "type": "string"
- },
- "rowStatus": {
- "description": "Standard fields",
- "allOf": [
- {
- "$ref": "#/definitions/store.RowStatus"
- }
- ]
- },
- "updatedTs": {
- "type": "integer"
- },
- "visibility": {
- "$ref": "#/definitions/store.Visibility"
- }
- }
- },
- "store.MemoRelation": {
- "type": "object",
- "properties": {
- "memoID": {
- "type": "integer"
- },
- "relatedMemoID": {
- "type": "integer"
- },
- "type": {
- "$ref": "#/definitions/store.MemoRelationType"
- }
- }
- },
- "store.MemoRelationType": {
- "type": "string",
- "enum": [
- "REFERENCE",
- "COMMENT"
- ],
- "x-enum-varnames": [
- "MemoRelationReference",
- "MemoRelationComment"
- ]
- },
- "store.Resource": {
- "type": "object",
- "properties": {
- "blob": {
- "type": "array",
- "items": {
- "type": "integer"
- }
- },
- "createdTs": {
- "type": "integer"
- },
- "creatorID": {
- "description": "Standard fields",
- "type": "integer"
- },
- "externalLink": {
- "type": "string"
- },
- "filename": {
- "description": "Domain specific fields",
- "type": "string"
- },
- "id": {
- "type": "integer"
- },
- "internalPath": {
- "type": "string"
- },
- "memoID": {
- "type": "integer"
- },
- "resourceName": {
- "type": "string"
- },
- "size": {
- "type": "integer"
- },
- "type": {
- "type": "string"
- },
- "updatedTs": {
- "type": "integer"
- }
- }
- },
- "store.Role": {
- "type": "string",
- "enum": [
- "HOST",
- "ADMIN",
- "USER"
- ],
- "x-enum-varnames": [
- "RoleHost",
- "RoleAdmin",
- "RoleUser"
- ]
- },
- "store.RowStatus": {
- "type": "string",
- "enum": [
- "NORMAL",
- "ARCHIVED"
- ],
- "x-enum-varnames": [
- "Normal",
- "Archived"
- ]
- },
- "store.Storage": {
- "type": "object",
- "properties": {
- "config": {
- "type": "string"
- },
- "id": {
- "type": "integer"
- },
- "name": {
- "type": "string"
- },
- "type": {
- "type": "string"
- }
- }
- },
- "store.User": {
- "type": "object",
- "properties": {
- "avatarURL": {
- "type": "string"
- },
- "createdTs": {
- "type": "integer"
- },
- "email": {
- "type": "string"
- },
- "id": {
- "type": "integer"
- },
- "nickname": {
- "type": "string"
- },
- "passwordHash": {
- "type": "string"
- },
- "role": {
- "$ref": "#/definitions/store.Role"
- },
- "rowStatus": {
- "description": "Standard fields",
- "allOf": [
- {
- "$ref": "#/definitions/store.RowStatus"
- }
- ]
- },
- "updatedTs": {
- "type": "integer"
- },
- "username": {
- "description": "Domain specific fields",
- "type": "string"
- }
- }
- },
- "store.Visibility": {
- "type": "string",
- "enum": [
- "PUBLIC",
- "PROTECTED",
- "PRIVATE"
- ],
- "x-enum-varnames": [
- "Public",
- "Protected",
- "Private"
- ]
- }
- },
- "externalDocs": {
- "description": "Find out more about Memos.",
- "url": "https://usememos.com/"
- }
- }`
- // SwaggerInfo holds exported Swagger Info so clients can modify it
- var SwaggerInfo = &swag.Spec{
- Version: "1.0",
- Host: "",
- BasePath: "/",
- Schemes: []string{},
- Title: "memos API",
- Description: "A privacy-first, lightweight note-taking service.",
- InfoInstanceName: "swagger",
- SwaggerTemplate: docTemplate,
- LeftDelim: "{{",
- RightDelim: "}}",
- }
- func init() {
- swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo)
- }
|