1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341 |
- basePath: /
- definitions:
- api_v1.CreateIdentityProviderRequest:
- properties:
- config:
- $ref: '#/definitions/api_v1.IdentityProviderConfig'
- identifierFilter:
- type: string
- name:
- type: string
- type:
- $ref: '#/definitions/api_v1.IdentityProviderType'
- type: object
- api_v1.CreateMemoRequest:
- properties:
- content:
- type: string
- createdTs:
- type: integer
- relationList:
- items:
- $ref: '#/definitions/api_v1.UpsertMemoRelationRequest'
- type: array
- resourceIdList:
- description: Related fields
- items:
- type: integer
- type: array
- visibility:
- allOf:
- - $ref: '#/definitions/api_v1.Visibility'
- description: Domain specific fields
- type: object
- api_v1.CreateResourceRequest:
- properties:
- externalLink:
- type: string
- filename:
- type: string
- type:
- type: string
- type: object
- api_v1.CreateStorageRequest:
- properties:
- config:
- $ref: '#/definitions/api_v1.StorageConfig'
- name:
- type: string
- type:
- $ref: '#/definitions/api_v1.StorageType'
- type: object
- api_v1.CreateUserRequest:
- properties:
- email:
- type: string
- nickname:
- type: string
- password:
- type: string
- role:
- $ref: '#/definitions/api_v1.Role'
- username:
- type: string
- type: object
- api_v1.CustomizedProfile:
- properties:
- appearance:
- description: Appearance is the server default appearance.
- type: string
- description:
- description: Description is the server description.
- type: string
- externalUrl:
- description: ExternalURL is the external url of server. e.g. https://usermemos.com
- 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
- type: object
- api_v1.DeleteTagRequest:
- properties:
- name:
- type: string
- type: object
- api_v1.FieldMapping:
- properties:
- displayName:
- type: string
- email:
- type: string
- identifier:
- type: string
- type: object
- api_v1.IdentityProvider:
- properties:
- config:
- $ref: '#/definitions/api_v1.IdentityProviderConfig'
- id:
- type: integer
- identifierFilter:
- type: string
- name:
- type: string
- type:
- $ref: '#/definitions/api_v1.IdentityProviderType'
- type: object
- api_v1.IdentityProviderConfig:
- properties:
- oauth2Config:
- $ref: '#/definitions/api_v1.IdentityProviderOAuth2Config'
- type: object
- api_v1.IdentityProviderOAuth2Config:
- properties:
- authUrl:
- type: string
- clientId:
- type: string
- clientSecret:
- type: string
- fieldMapping:
- $ref: '#/definitions/api_v1.FieldMapping'
- scopes:
- items:
- type: string
- type: array
- tokenUrl:
- type: string
- userInfoUrl:
- type: string
- type: object
- api_v1.IdentityProviderType:
- enum:
- - OAUTH2
- type: string
- x-enum-varnames:
- - IdentityProviderOAuth2Type
- api_v1.MemoRelationType:
- enum:
- - REFERENCE
- - COMMENT
- type: string
- x-enum-varnames:
- - MemoRelationReference
- - MemoRelationComment
- api_v1.PatchMemoRequest:
- properties:
- content:
- description: Domain specific fields
- type: string
- createdTs:
- description: Standard fields
- type: integer
- relationList:
- items:
- $ref: '#/definitions/api_v1.UpsertMemoRelationRequest'
- type: array
- resourceIdList:
- description: Related fields
- items:
- type: integer
- type: array
- rowStatus:
- $ref: '#/definitions/api_v1.RowStatus'
- updatedTs:
- type: integer
- visibility:
- $ref: '#/definitions/api_v1.Visibility'
- type: object
- api_v1.Role:
- enum:
- - HOST
- - ADMIN
- - USER
- type: string
- x-enum-varnames:
- - RoleHost
- - RoleAdmin
- - RoleUser
- api_v1.RowStatus:
- enum:
- - NORMAL
- - ARCHIVED
- type: string
- x-enum-varnames:
- - Normal
- - Archived
- api_v1.SSOSignIn:
- properties:
- code:
- type: string
- identityProviderId:
- type: integer
- redirectUri:
- type: string
- type: object
- api_v1.SignIn:
- properties:
- password:
- type: string
- remember:
- type: boolean
- username:
- type: string
- type: object
- api_v1.SignUp:
- properties:
- password:
- type: string
- username:
- type: string
- type: object
- api_v1.StorageConfig:
- properties:
- s3Config:
- $ref: '#/definitions/api_v1.StorageS3Config'
- type: object
- api_v1.StorageS3Config:
- properties:
- accessKey:
- type: string
- bucket:
- type: string
- endPoint:
- type: string
- path:
- type: string
- region:
- type: string
- secretKey:
- type: string
- urlPrefix:
- type: string
- urlSuffix:
- type: string
- type: object
- api_v1.StorageType:
- enum:
- - S3
- type: string
- x-enum-varnames:
- - StorageS3
- api_v1.SystemSetting:
- properties:
- description:
- type: string
- name:
- $ref: '#/definitions/api_v1.SystemSettingName'
- value:
- description: Value is a JSON string with basic value.
- type: string
- type: object
- api_v1.SystemSettingName:
- enum:
- - server-id
- - secret-session
- - allow-signup
- - disable-password-login
- - disable-public-memos
- - max-upload-size-mib
- - additional-style
- - additional-script
- - customized-profile
- - storage-service-id
- - local-storage-path
- - telegram-bot-token
- - memo-display-with-updated-ts
- - instance-url
- type: string
- x-enum-varnames:
- - SystemSettingServerIDName
- - SystemSettingSecretSessionName
- - SystemSettingAllowSignUpName
- - SystemSettingDisablePasswordLoginName
- - SystemSettingDisablePublicMemosName
- - SystemSettingMaxUploadSizeMiBName
- - SystemSettingAdditionalStyleName
- - SystemSettingAdditionalScriptName
- - SystemSettingCustomizedProfileName
- - SystemSettingStorageServiceIDName
- - SystemSettingLocalStoragePathName
- - SystemSettingTelegramBotTokenName
- - SystemSettingMemoDisplayWithUpdatedTsName
- - SystemSettingInstanceURLName
- api_v1.SystemStatus:
- properties:
- additionalScript:
- description: Additional script.
- type: string
- additionalStyle:
- description: Additional style.
- type: string
- allowSignUp:
- description: |-
- System settings
- Allow sign up.
- type: boolean
- customizedProfile:
- allOf:
- - $ref: '#/definitions/api_v1.CustomizedProfile'
- description: Customized server profile, including server name and external
- url.
- 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
- type: object
- api_v1.UpdateIdentityProviderRequest:
- properties:
- config:
- $ref: '#/definitions/api_v1.IdentityProviderConfig'
- identifierFilter:
- type: string
- name:
- type: string
- type:
- $ref: '#/definitions/api_v1.IdentityProviderType'
- type: object
- api_v1.UpdateResourceRequest:
- properties:
- filename:
- type: string
- type: object
- api_v1.UpdateStorageRequest:
- properties:
- config:
- $ref: '#/definitions/api_v1.StorageConfig'
- name:
- type: string
- type:
- $ref: '#/definitions/api_v1.StorageType'
- type: object
- api_v1.UpdateUserRequest:
- properties:
- avatarUrl:
- type: string
- email:
- type: string
- nickname:
- type: string
- password:
- type: string
- rowStatus:
- $ref: '#/definitions/api_v1.RowStatus'
- username:
- type: string
- type: object
- api_v1.UpsertMemoOrganizerRequest:
- properties:
- pinned:
- type: boolean
- type: object
- api_v1.UpsertMemoRelationRequest:
- properties:
- relatedMemoId:
- type: integer
- type:
- $ref: '#/definitions/api_v1.MemoRelationType'
- type: object
- api_v1.UpsertSystemSettingRequest:
- properties:
- description:
- type: string
- name:
- $ref: '#/definitions/api_v1.SystemSettingName'
- value:
- type: string
- type: object
- api_v1.UpsertTagRequest:
- properties:
- name:
- type: string
- type: object
- api_v1.User:
- properties:
- avatarUrl:
- type: string
- createdTs:
- type: integer
- email:
- type: string
- id:
- type: integer
- nickname:
- type: string
- role:
- $ref: '#/definitions/api_v1.Role'
- rowStatus:
- allOf:
- - $ref: '#/definitions/api_v1.RowStatus'
- description: Standard fields
- updatedTs:
- type: integer
- username:
- description: Domain specific fields
- type: string
- type: object
- api_v1.Visibility:
- enum:
- - PUBLIC
- - PROTECTED
- - PRIVATE
- type: string
- x-enum-varnames:
- - Public
- - Protected
- - Private
- github_com_usememos_memos_api_v1.CreateIdentityProviderRequest:
- 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'
- type: object
- github_com_usememos_memos_api_v1.CreateMemoRequest:
- properties:
- content:
- type: string
- createdTs:
- type: integer
- relationList:
- items:
- $ref: '#/definitions/github_com_usememos_memos_api_v1.UpsertMemoRelationRequest'
- type: array
- resourceIdList:
- description: Related fields
- items:
- type: integer
- type: array
- visibility:
- allOf:
- - $ref: '#/definitions/github_com_usememos_memos_api_v1.Visibility'
- description: Domain specific fields
- type: object
- github_com_usememos_memos_api_v1.CreateResourceRequest:
- properties:
- externalLink:
- type: string
- filename:
- type: string
- type:
- type: string
- type: object
- github_com_usememos_memos_api_v1.CreateStorageRequest:
- properties:
- config:
- $ref: '#/definitions/github_com_usememos_memos_api_v1.StorageConfig'
- name:
- type: string
- type:
- $ref: '#/definitions/github_com_usememos_memos_api_v1.StorageType'
- type: object
- github_com_usememos_memos_api_v1.CreateUserRequest:
- properties:
- email:
- type: string
- nickname:
- type: string
- password:
- type: string
- role:
- $ref: '#/definitions/github_com_usememos_memos_api_v1.Role'
- username:
- type: string
- type: object
- github_com_usememos_memos_api_v1.CustomizedProfile:
- properties:
- appearance:
- description: Appearance is the server default appearance.
- type: string
- description:
- description: Description is the server description.
- type: string
- externalUrl:
- description: ExternalURL is the external url of server. e.g. https://usermemos.com
- 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
- type: object
- github_com_usememos_memos_api_v1.DeleteTagRequest:
- properties:
- name:
- type: string
- type: object
- github_com_usememos_memos_api_v1.FieldMapping:
- properties:
- displayName:
- type: string
- email:
- type: string
- identifier:
- type: string
- type: object
- github_com_usememos_memos_api_v1.IdentityProvider:
- 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'
- type: object
- github_com_usememos_memos_api_v1.IdentityProviderConfig:
- properties:
- oauth2Config:
- $ref: '#/definitions/github_com_usememos_memos_api_v1.IdentityProviderOAuth2Config'
- type: object
- github_com_usememos_memos_api_v1.IdentityProviderOAuth2Config:
- properties:
- authUrl:
- type: string
- clientId:
- type: string
- clientSecret:
- type: string
- fieldMapping:
- $ref: '#/definitions/github_com_usememos_memos_api_v1.FieldMapping'
- scopes:
- items:
- type: string
- type: array
- tokenUrl:
- type: string
- userInfoUrl:
- type: string
- type: object
- github_com_usememos_memos_api_v1.IdentityProviderType:
- enum:
- - OAUTH2
- type: string
- x-enum-varnames:
- - IdentityProviderOAuth2Type
- github_com_usememos_memos_api_v1.MemoRelationType:
- enum:
- - REFERENCE
- - COMMENT
- type: string
- x-enum-varnames:
- - MemoRelationReference
- - MemoRelationComment
- github_com_usememos_memos_api_v1.PatchMemoRequest:
- properties:
- content:
- description: Domain specific fields
- type: string
- createdTs:
- description: Standard fields
- type: integer
- relationList:
- items:
- $ref: '#/definitions/github_com_usememos_memos_api_v1.UpsertMemoRelationRequest'
- type: array
- resourceIdList:
- description: Related fields
- items:
- type: integer
- type: array
- rowStatus:
- $ref: '#/definitions/github_com_usememos_memos_api_v1.RowStatus'
- updatedTs:
- type: integer
- visibility:
- $ref: '#/definitions/github_com_usememos_memos_api_v1.Visibility'
- type: object
- github_com_usememos_memos_api_v1.Role:
- enum:
- - HOST
- - ADMIN
- - USER
- type: string
- x-enum-varnames:
- - RoleHost
- - RoleAdmin
- - RoleUser
- github_com_usememos_memos_api_v1.RowStatus:
- enum:
- - NORMAL
- - ARCHIVED
- type: string
- x-enum-varnames:
- - Normal
- - Archived
- github_com_usememos_memos_api_v1.SSOSignIn:
- properties:
- code:
- type: string
- identityProviderId:
- type: integer
- redirectUri:
- type: string
- type: object
- github_com_usememos_memos_api_v1.SignIn:
- properties:
- password:
- type: string
- remember:
- type: boolean
- username:
- type: string
- type: object
- github_com_usememos_memos_api_v1.SignUp:
- properties:
- password:
- type: string
- username:
- type: string
- type: object
- github_com_usememos_memos_api_v1.StorageConfig:
- properties:
- s3Config:
- $ref: '#/definitions/github_com_usememos_memos_api_v1.StorageS3Config'
- type: object
- github_com_usememos_memos_api_v1.StorageS3Config:
- properties:
- accessKey:
- type: string
- bucket:
- type: string
- endPoint:
- type: string
- path:
- type: string
- region:
- type: string
- secretKey:
- type: string
- urlPrefix:
- type: string
- urlSuffix:
- type: string
- type: object
- github_com_usememos_memos_api_v1.StorageType:
- enum:
- - S3
- type: string
- x-enum-varnames:
- - StorageS3
- github_com_usememos_memos_api_v1.SystemSetting:
- 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
- type: object
- github_com_usememos_memos_api_v1.SystemSettingName:
- enum:
- - server-id
- - secret-session
- - allow-signup
- - disable-password-login
- - disable-public-memos
- - max-upload-size-mib
- - additional-style
- - additional-script
- - customized-profile
- - storage-service-id
- - local-storage-path
- - telegram-bot-token
- - memo-display-with-updated-ts
- - instance-url
- type: string
- x-enum-varnames:
- - SystemSettingServerIDName
- - SystemSettingSecretSessionName
- - SystemSettingAllowSignUpName
- - SystemSettingDisablePasswordLoginName
- - SystemSettingDisablePublicMemosName
- - SystemSettingMaxUploadSizeMiBName
- - SystemSettingAdditionalStyleName
- - SystemSettingAdditionalScriptName
- - SystemSettingCustomizedProfileName
- - SystemSettingStorageServiceIDName
- - SystemSettingLocalStoragePathName
- - SystemSettingTelegramBotTokenName
- - SystemSettingMemoDisplayWithUpdatedTsName
- - SystemSettingInstanceURLName
- github_com_usememos_memos_api_v1.SystemStatus:
- properties:
- additionalScript:
- description: Additional script.
- type: string
- additionalStyle:
- description: Additional style.
- type: string
- allowSignUp:
- description: |-
- System settings
- Allow sign up.
- type: boolean
- customizedProfile:
- allOf:
- - $ref: '#/definitions/github_com_usememos_memos_api_v1.CustomizedProfile'
- description: Customized server profile, including server name and external
- url.
- 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
- type: object
- github_com_usememos_memos_api_v1.UpdateIdentityProviderRequest:
- 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'
- type: object
- github_com_usememos_memos_api_v1.UpdateResourceRequest:
- properties:
- filename:
- type: string
- type: object
- github_com_usememos_memos_api_v1.UpdateStorageRequest:
- properties:
- config:
- $ref: '#/definitions/github_com_usememos_memos_api_v1.StorageConfig'
- name:
- type: string
- type:
- $ref: '#/definitions/github_com_usememos_memos_api_v1.StorageType'
- type: object
- github_com_usememos_memos_api_v1.UpdateUserRequest:
- 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
- type: object
- github_com_usememos_memos_api_v1.UpsertMemoOrganizerRequest:
- properties:
- pinned:
- type: boolean
- type: object
- github_com_usememos_memos_api_v1.UpsertMemoRelationRequest:
- properties:
- relatedMemoId:
- type: integer
- type:
- $ref: '#/definitions/github_com_usememos_memos_api_v1.MemoRelationType'
- type: object
- github_com_usememos_memos_api_v1.UpsertSystemSettingRequest:
- properties:
- description:
- type: string
- name:
- $ref: '#/definitions/github_com_usememos_memos_api_v1.SystemSettingName'
- value:
- type: string
- type: object
- github_com_usememos_memos_api_v1.UpsertTagRequest:
- properties:
- name:
- type: string
- type: object
- github_com_usememos_memos_api_v1.User:
- 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:
- allOf:
- - $ref: '#/definitions/github_com_usememos_memos_api_v1.RowStatus'
- description: Standard fields
- updatedTs:
- type: integer
- username:
- description: Domain specific fields
- type: string
- type: object
- github_com_usememos_memos_api_v1.Visibility:
- enum:
- - PUBLIC
- - PROTECTED
- - PRIVATE
- type: string
- x-enum-varnames:
- - Public
- - Protected
- - Private
- profile.Profile:
- properties:
- mode:
- description: Mode can be "prod" or "dev" or "demo"
- type: string
- version:
- description: Version is the current version of server
- type: string
- type: object
- store.FieldMapping:
- properties:
- displayName:
- type: string
- email:
- type: string
- identifier:
- type: string
- type: object
- store.IdentityProvider:
- properties:
- config:
- $ref: '#/definitions/store.IdentityProviderConfig'
- id:
- type: integer
- identifierFilter:
- type: string
- name:
- type: string
- type:
- $ref: '#/definitions/store.IdentityProviderType'
- type: object
- store.IdentityProviderConfig:
- properties:
- oauth2Config:
- $ref: '#/definitions/store.IdentityProviderOAuth2Config'
- type: object
- store.IdentityProviderOAuth2Config:
- properties:
- authUrl:
- type: string
- clientId:
- type: string
- clientSecret:
- type: string
- fieldMapping:
- $ref: '#/definitions/store.FieldMapping'
- scopes:
- items:
- type: string
- type: array
- tokenUrl:
- type: string
- userInfoUrl:
- type: string
- type: object
- store.IdentityProviderType:
- enum:
- - OAUTH2
- type: string
- x-enum-varnames:
- - IdentityProviderOAuth2Type
- store.Memo:
- properties:
- content:
- description: Domain specific fields
- type: string
- createdTs:
- type: integer
- creatorID:
- type: integer
- id:
- type: integer
- pinned:
- description: Composed fields
- type: boolean
- rowStatus:
- allOf:
- - $ref: '#/definitions/store.RowStatus'
- description: Standard fields
- updatedTs:
- type: integer
- visibility:
- $ref: '#/definitions/store.Visibility'
- type: object
- store.MemoRelation:
- properties:
- memoID:
- type: integer
- relatedMemoID:
- type: integer
- type:
- $ref: '#/definitions/store.MemoRelationType'
- type: object
- store.MemoRelationType:
- enum:
- - REFERENCE
- - COMMENT
- type: string
- x-enum-varnames:
- - MemoRelationReference
- - MemoRelationComment
- store.Resource:
- properties:
- blob:
- items:
- type: integer
- type: array
- 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
- size:
- type: integer
- type:
- type: string
- updatedTs:
- type: integer
- type: object
- store.Role:
- enum:
- - HOST
- - ADMIN
- - USER
- type: string
- x-enum-varnames:
- - RoleHost
- - RoleAdmin
- - RoleUser
- store.RowStatus:
- enum:
- - NORMAL
- - ARCHIVED
- type: string
- x-enum-varnames:
- - Normal
- - Archived
- store.Storage:
- properties:
- config:
- type: string
- id:
- type: integer
- name:
- type: string
- type:
- type: string
- type: object
- store.SystemSetting:
- properties:
- description:
- type: string
- name:
- type: string
- value:
- type: string
- type: object
- store.User:
- 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:
- allOf:
- - $ref: '#/definitions/store.RowStatus'
- description: Standard fields
- updatedTs:
- type: integer
- username:
- description: Domain specific fields
- type: string
- type: object
- store.Visibility:
- enum:
- - PUBLIC
- - PROTECTED
- - PRIVATE
- type: string
- x-enum-varnames:
- - Public
- - Protected
- - Private
- externalDocs:
- description: Find out more about Memos.
- url: https://usememos.com/
- info:
- contact:
- name: API Support
- url: https://github.com/orgs/usememos/discussions
- description: A privacy-first, lightweight note-taking service.
- license:
- name: MIT License
- url: https://github.com/usememos/memos/blob/main/LICENSE
- title: memos API
- version: "1.0"
- paths:
- /api/v1/auth/signin:
- post:
- consumes:
- - application/json
- parameters:
- - description: Sign-in object
- in: body
- name: body
- required: true
- schema:
- $ref: '#/definitions/github_com_usememos_memos_api_v1.SignIn'
- produces:
- - application/json
- 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
- summary: Sign-in to memos.
- tags:
- - auth
- /api/v1/auth/signin/sso:
- post:
- consumes:
- - application/json
- parameters:
- - description: SSO sign-in object
- in: body
- name: body
- required: true
- schema:
- $ref: '#/definitions/github_com_usememos_memos_api_v1.SSOSignIn'
- produces:
- - application/json
- 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
- summary: Sign-in to memos using SSO.
- tags:
- - auth
- /api/v1/auth/signout:
- post:
- produces:
- - application/json
- responses:
- "200":
- description: Sign-out success
- schema:
- type: boolean
- summary: Sign-out from memos.
- tags:
- - auth
- /api/v1/auth/signup:
- post:
- consumes:
- - application/json
- parameters:
- - description: Sign-up object
- in: body
- name: body
- required: true
- schema:
- $ref: '#/definitions/github_com_usememos_memos_api_v1.SignUp'
- produces:
- - application/json
- 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
- summary: Sign-up to memos.
- tags:
- - auth
- /api/v1/idp:
- get:
- description: '*clientSecret is only available for host user'
- produces:
- - application/json
- responses:
- "200":
- description: List of available identity providers
- schema:
- items:
- $ref: '#/definitions/github_com_usememos_memos_api_v1.IdentityProvider'
- type: array
- "500":
- description: Failed to find identity provider list | Failed to find user
- summary: Get a list of identity providers
- tags:
- - idp
- post:
- consumes:
- - application/json
- parameters:
- - description: Identity provider information
- in: body
- name: body
- required: true
- schema:
- $ref: '#/definitions/github_com_usememos_memos_api_v1.CreateIdentityProviderRequest'
- produces:
- - application/json
- 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
- summary: Create Identity Provider
- tags:
- - idp
- /api/v1/idp/{idpId}:
- delete:
- consumes:
- - application/json
- parameters:
- - description: Identity Provider ID
- in: path
- name: idpId
- required: true
- type: integer
- produces:
- - application/json
- 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
- summary: Delete an identity provider by ID
- tags:
- - idp
- get:
- consumes:
- - application/json
- parameters:
- - description: Identity provider ID
- in: path
- name: idpId
- required: true
- type: integer
- produces:
- - application/json
- 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
- summary: Get an identity provider by ID
- tags:
- - idp
- patch:
- consumes:
- - application/json
- parameters:
- - description: Identity Provider ID
- in: path
- name: idpId
- required: true
- type: integer
- - description: Patched identity provider information
- in: body
- name: body
- required: true
- schema:
- $ref: '#/definitions/github_com_usememos_memos_api_v1.UpdateIdentityProviderRequest'
- produces:
- - application/json
- 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
- summary: Update an identity provider by ID
- tags:
- - idp
- /api/v1/memo:
- get:
- parameters:
- - description: Creator ID
- in: query
- name: creatorId
- type: integer
- - description: Creator username
- in: query
- name: creatorUsername
- type: string
- - description: Row status
- enum:
- - NORMAL
- - ARCHIVED
- in: query
- name: rowStatus
- type: string
- - description: Pinned
- in: query
- name: pinned
- type: boolean
- - description: 'Search for tag. Do not append #'
- in: query
- name: tag
- type: string
- - description: Search for content
- in: query
- name: content
- type: string
- - description: Limit
- in: query
- name: limit
- type: integer
- - description: Offset
- in: query
- name: offset
- type: integer
- produces:
- - application/json
- responses:
- "200":
- description: Memo list
- schema:
- items:
- $ref: '#/definitions/store.Memo'
- type: array
- "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
- summary: Get a list of memos matching optional filters
- tags:
- - memo
- post:
- consumes:
- - application/json
- description: |-
- Visibility can be PUBLIC, PROTECTED or PRIVATE
- *You should omit fields to use their default values
- parameters:
- - description: Request object.
- in: body
- name: body
- required: true
- schema:
- $ref: '#/definitions/github_com_usememos_memos_api_v1.CreateMemoRequest'
- produces:
- - application/json
- 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
- summary: Create a memo
- tags:
- - memo
- /api/v1/memo/{memoId}:
- delete:
- parameters:
- - description: Memo ID to delete
- in: path
- name: memoId
- required: true
- type: integer
- produces:
- - application/json
- 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'
- summary: Delete memo by ID
- tags:
- - memo
- get:
- parameters:
- - description: Memo ID
- in: path
- name: memoId
- required: true
- type: integer
- produces:
- - application/json
- responses:
- "200":
- description: Memo list
- schema:
- items:
- $ref: '#/definitions/store.Memo'
- type: array
- "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'
- summary: Get memo by ID
- tags:
- - memo
- patch:
- consumes:
- - application/json
- description: |-
- Visibility can be PUBLIC, PROTECTED or PRIVATE
- *You should omit fields to use their default values
- parameters:
- - description: ID of memo to update
- in: path
- name: memoId
- required: true
- type: integer
- - description: Patched object.
- in: body
- name: body
- required: true
- schema:
- $ref: '#/definitions/github_com_usememos_memos_api_v1.PatchMemoRequest'
- produces:
- - application/json
- 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
- summary: Update a memo
- tags:
- - memo
- /api/v1/memo/{memoId}/organizer:
- post:
- consumes:
- - application/json
- parameters:
- - description: ID of memo to organize
- in: path
- name: memoId
- required: true
- type: integer
- - description: Memo organizer object
- in: body
- name: body
- required: true
- schema:
- $ref: '#/definitions/github_com_usememos_memos_api_v1.UpsertMemoOrganizerRequest'
- produces:
- - application/json
- 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'
- summary: Organize memo (pin/unpin)
- tags:
- - memo-organizer
- /api/v1/memo/{memoId}/relation:
- get:
- consumes:
- - application/json
- parameters:
- - description: ID of memo to find relations
- in: path
- name: memoId
- required: true
- type: integer
- produces:
- - application/json
- responses:
- "200":
- description: Memo relation information list
- schema:
- items:
- $ref: '#/definitions/store.MemoRelation'
- type: array
- "400":
- description: 'ID is not a number: %s'
- "500":
- description: Failed to list memo relations
- summary: Get a list of Memo Relations
- tags:
- - memo-relation
- post:
- consumes:
- - application/json
- description: Create a relation between two memos
- parameters:
- - description: ID of memo to relate
- in: path
- name: memoId
- required: true
- type: integer
- - description: Memo relation object
- in: body
- name: body
- required: true
- schema:
- $ref: '#/definitions/api_v1.UpsertMemoRelationRequest'
- produces:
- - application/json
- 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
- summary: Create Memo Relation
- tags:
- - memo-relation
- /api/v1/memo/{memoId}/relation/{relatedMemoId}/type/{relationType}:
- delete:
- consumes:
- - application/json
- description: Removes a relation between two memos
- parameters:
- - description: ID of memo to find relations
- in: path
- name: memoId
- required: true
- type: integer
- - description: ID of memo to remove relation to
- in: path
- name: relatedMemoId
- required: true
- type: integer
- - description: Type of relation to remove
- enum:
- - REFERENCE
- - COMMENT
- in: path
- name: relationType
- required: true
- type: string
- produces:
- - application/json
- 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
- summary: Delete a Memo Relation
- tags:
- - memo-relation
- /api/v1/memo/all:
- get:
- description: |-
- This should also list protected memos if the user is logged in
- Authentication is optional
- parameters:
- - description: Limit
- in: query
- name: limit
- type: integer
- - description: Offset
- in: query
- name: offset
- type: integer
- produces:
- - application/json
- responses:
- "200":
- description: Memo list
- schema:
- items:
- $ref: '#/definitions/store.Memo'
- type: array
- "500":
- description: Failed to get memo display with updated ts setting value |
- Failed to fetch all memo list | Failed to compose memo response
- summary: Get a list of public memos matching optional filters
- tags:
- - memo
- /api/v1/memo/stats:
- get:
- description: Used to generate the heatmap
- parameters:
- - description: Creator ID
- in: query
- name: creatorId
- type: integer
- - description: Creator username
- in: query
- name: creatorUsername
- type: string
- produces:
- - application/json
- responses:
- "200":
- description: Memo createdTs list
- schema:
- items:
- type: integer
- type: array
- "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
- summary: Get memo stats by creator ID or username
- tags:
- - memo
- /api/v1/ping:
- get:
- produces:
- - application/json
- responses:
- "200":
- description: If succeed to ping the system
- schema:
- type: boolean
- summary: Ping the system
- tags:
- - system
- /api/v1/resource:
- get:
- parameters:
- - description: Limit
- in: query
- name: limit
- type: integer
- - description: Offset
- in: query
- name: offset
- type: integer
- produces:
- - application/json
- responses:
- "200":
- description: Resource list
- schema:
- items:
- $ref: '#/definitions/store.Resource'
- type: array
- "401":
- description: Missing user in session
- "500":
- description: Failed to fetch resource list
- summary: Get a list of resources
- tags:
- - resource
- post:
- consumes:
- - application/json
- parameters:
- - description: Request object.
- in: body
- name: body
- required: true
- schema:
- $ref: '#/definitions/github_com_usememos_memos_api_v1.CreateResourceRequest'
- produces:
- - application/json
- 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
- summary: Create resource
- tags:
- - resource
- /api/v1/resource/{resourceId}:
- delete:
- parameters:
- - description: Resource ID
- in: path
- name: resourceId
- required: true
- type: integer
- produces:
- - application/json
- 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
- summary: Delete a resource
- tags:
- - resource
- patch:
- parameters:
- - description: Resource ID
- in: path
- name: resourceId
- required: true
- type: integer
- - description: Patch resource request
- in: body
- name: patch
- required: true
- schema:
- $ref: '#/definitions/github_com_usememos_memos_api_v1.UpdateResourceRequest'
- produces:
- - application/json
- 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
- summary: Update a resource
- tags:
- - resource
- /api/v1/resource/blob:
- post:
- consumes:
- - multipart/form-data
- parameters:
- - description: File to upload
- in: formData
- name: file
- required: true
- type: file
- produces:
- - application/json
- 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
- summary: Upload resource
- tags:
- - resource
- /api/v1/status:
- get:
- produces:
- - application/json
- responses:
- "200":
- description: System GetSystemStatus
- schema:
- $ref: '#/definitions/github_com_usememos_memos_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
- summary: Get system GetSystemStatus
- tags:
- - system
- /api/v1/storage:
- get:
- produces:
- - application/json
- responses:
- "200":
- description: List of storages
- schema:
- items:
- $ref: '#/definitions/store.Storage'
- type: array
- "401":
- description: Missing user in session | Unauthorized
- "500":
- description: Failed to find user | Failed to convert storage
- summary: Get a list of storages
- tags:
- - storage
- post:
- consumes:
- - application/json
- parameters:
- - description: Request object.
- in: body
- name: body
- required: true
- schema:
- $ref: '#/definitions/github_com_usememos_memos_api_v1.CreateStorageRequest'
- produces:
- - application/json
- 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
- summary: Create storage
- tags:
- - storage
- /api/v1/storage/{storageId}:
- delete:
- parameters:
- - description: Storage ID
- in: path
- name: storageId
- required: true
- type: integer
- produces:
- - application/json
- 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
- summary: Delete a storage
- tags:
- - storage
- patch:
- parameters:
- - description: Storage ID
- in: path
- name: storageId
- required: true
- type: integer
- - description: Patch request
- in: body
- name: patch
- required: true
- schema:
- $ref: '#/definitions/github_com_usememos_memos_api_v1.UpdateStorageRequest'
- produces:
- - application/json
- 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
- summary: Update a storage
- tags:
- - storage
- /api/v1/system/setting:
- get:
- produces:
- - application/json
- responses:
- "200":
- description: System setting list
- schema:
- items:
- $ref: '#/definitions/api_v1.SystemSetting'
- type: array
- "401":
- description: Missing user in session | Unauthorized
- "500":
- description: Failed to find user | Failed to find system setting list
- summary: Get a list of system settings
- tags:
- - system-setting
- post:
- consumes:
- - application/json
- parameters:
- - description: Request object.
- in: body
- name: body
- required: true
- schema:
- $ref: '#/definitions/api_v1.UpsertSystemSettingRequest'
- produces:
- - application/json
- responses:
- "200":
- description: Created system setting
- schema:
- $ref: '#/definitions/store.SystemSetting'
- "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
- summary: Create system setting
- tags:
- - system-setting
- /api/v1/system/vacuum:
- post:
- produces:
- - application/json
- 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
- summary: Vacuum the database
- tags:
- - system
- /api/v1/tag:
- get:
- produces:
- - application/json
- responses:
- "200":
- description: Tag list
- schema:
- items:
- type: string
- type: array
- "400":
- description: Missing user id to find tag
- "500":
- description: Failed to find tag list
- summary: Get a list of tags
- tags:
- - tag
- post:
- consumes:
- - application/json
- parameters:
- - description: Request object.
- in: body
- name: body
- required: true
- schema:
- $ref: '#/definitions/github_com_usememos_memos_api_v1.UpsertTagRequest'
- produces:
- - application/json
- 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
- summary: Create a tag
- tags:
- - tag
- /api/v1/tag/delete:
- post:
- consumes:
- - application/json
- parameters:
- - description: Request object.
- in: body
- name: body
- required: true
- schema:
- $ref: '#/definitions/github_com_usememos_memos_api_v1.DeleteTagRequest'
- produces:
- - application/json
- 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'
- summary: Delete a tag
- tags:
- - tag
- /api/v1/tag/suggestion:
- get:
- produces:
- - application/json
- responses:
- "200":
- description: Tag list
- schema:
- items:
- type: string
- type: array
- "400":
- description: Missing user session
- "500":
- description: Failed to find memo list | Failed to find tag list
- summary: Get a list of tags suggested from other memos contents
- tags:
- - tag
- /api/v1/user:
- get:
- produces:
- - application/json
- responses:
- "200":
- description: User list
- schema:
- items:
- $ref: '#/definitions/store.User'
- type: array
- "500":
- description: Failed to fetch user list
- summary: Get a list of users
- tags:
- - user
- post:
- consumes:
- - application/json
- parameters:
- - description: Request object
- in: body
- name: body
- required: true
- schema:
- $ref: '#/definitions/github_com_usememos_memos_api_v1.CreateUserRequest'
- produces:
- - application/json
- 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
- summary: Create a user
- tags:
- - user
- /api/v1/user/{id}:
- delete:
- parameters:
- - description: User ID
- in: path
- name: id
- required: true
- type: string
- produces:
- - application/json
- 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
- summary: Delete a user
- tags:
- - user
- get:
- parameters:
- - description: User ID
- in: path
- name: id
- required: true
- type: integer
- produces:
- - application/json
- 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
- summary: Get user by id
- tags:
- - user
- patch:
- parameters:
- - description: User ID
- in: path
- name: id
- required: true
- type: string
- - description: Patch request
- in: body
- name: patch
- required: true
- schema:
- $ref: '#/definitions/github_com_usememos_memos_api_v1.UpdateUserRequest'
- produces:
- - application/json
- 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
- summary: Update a user
- tags:
- - user
- /api/v1/user/me:
- get:
- produces:
- - application/json
- 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
- summary: Get current user
- tags:
- - user
- /api/v1/user/name/{username}:
- get:
- parameters:
- - description: Username
- in: path
- name: username
- required: true
- type: string
- produces:
- - application/json
- responses:
- "200":
- description: Requested user
- schema:
- $ref: '#/definitions/store.User'
- "404":
- description: User not found
- "500":
- description: Failed to find user
- summary: Get user by username
- tags:
- - user
- /explore/rss.xml:
- get:
- produces:
- - text/xml
- responses:
- "200":
- description: RSS
- "500":
- description: Failed to get system customized profile | Failed to find memo
- list | Failed to generate rss
- summary: Get RSS
- tags:
- - rss
- /o/get/GetImage:
- get:
- parameters:
- - description: Image url
- in: query
- name: url
- required: true
- type: string
- produces:
- - GetImage/*
- responses:
- "200":
- description: Image
- "400":
- description: 'Missing GetImage url | Wrong url | Failed to get GetImage
- url: %s'
- "500":
- description: Failed to write GetImage blob
- summary: Get GetImage from URL
- tags:
- - image-url
- /u/{id}/rss.xml:
- get:
- parameters:
- - description: User ID
- in: path
- name: id
- required: true
- type: integer
- produces:
- - text/xml
- responses:
- "200":
- description: RSS
- "400":
- description: User id is not a number
- "500":
- description: Failed to get system customized profile | Failed to find memo
- list | Failed to generate rss
- summary: Get RSS for a user
- tags:
- - rss
- swagger: "2.0"
|