Skip to content

C
canifa_note
Commit af68cae6 authored by Steven's avatar Steven
Browse files
Options

chore: regenerate swagger docs

parent e0cacfc6
Show whitespace changes
Inline Side-by-side
Showing with 2016 additions and 1041 deletions
api/v1/docs.go
View file @ af68cae6
...@@ -42,7 +42,7 @@ const docTemplate = `{ ...@@ -42,7 +42,7 @@ const docTemplate = `{
"in": "body", "in": "body",
"required": true, "required": true,
"schema": { "schema": {
"$ref": "#/definitions/v1.SignIn" "$ref": "#/definitions/github_com_usememos_memos_api_v1.SignIn"
} }
} }
], ],
...@@ -87,7 +87,7 @@ const docTemplate = `{ ...@@ -87,7 +87,7 @@ const docTemplate = `{
"in": "body", "in": "body",
"required": true, "required": true,
"schema": { "schema": {
"$ref": "#/definitions/v1.SSOSignIn" "$ref": "#/definitions/github_com_usememos_memos_api_v1.SSOSignIn"
} }
} }
], ],
...@@ -154,7 +154,7 @@ const docTemplate = `{ ...@@ -154,7 +154,7 @@ const docTemplate = `{
"in": "body", "in": "body",
"required": true, "required": true,
"schema": { "schema": {
"$ref": "#/definitions/v1.SignUp" "$ref": "#/definitions/github_com_usememos_memos_api_v1.SignUp"
} }
} }
], ],
...@@ -199,7 +199,7 @@ const docTemplate = `{ ...@@ -199,7 +199,7 @@ const docTemplate = `{
"schema": { "schema": {
"type": "array", "type": "array",
"items": { "items": {
"$ref": "#/definitions/v1.IdentityProvider" "$ref": "#/definitions/github_com_usememos_memos_api_v1.IdentityProvider"
} }
} }
}, },
...@@ -226,7 +226,7 @@ const docTemplate = `{ ...@@ -226,7 +226,7 @@ const docTemplate = `{
"in": "body", "in": "body",
"required": true, "required": true,
"schema": { "schema": {
"$ref": "#/definitions/v1.CreateIdentityProviderRequest" "$ref": "#/definitions/github_com_usememos_memos_api_v1.CreateIdentityProviderRequest"
} }
} }
], ],
...@@ -354,7 +354,7 @@ const docTemplate = `{ ...@@ -354,7 +354,7 @@ const docTemplate = `{
"in": "body", "in": "body",
"required": true, "required": true,
"schema": { "schema": {
"$ref": "#/definitions/v1.UpdateIdentityProviderRequest" "$ref": "#/definitions/github_com_usememos_memos_api_v1.UpdateIdentityProviderRequest"
} }
} }
], ],
...@@ -477,7 +477,7 @@ const docTemplate = `{ ...@@ -477,7 +477,7 @@ const docTemplate = `{
"in": "body", "in": "body",
"required": true, "required": true,
"schema": { "schema": {
"$ref": "#/definitions/v1.CreateMemoRequest" "$ref": "#/definitions/github_com_usememos_memos_api_v1.CreateMemoRequest"
} }
} }
], ],
...@@ -695,7 +695,7 @@ const docTemplate = `{ ...@@ -695,7 +695,7 @@ const docTemplate = `{
"in": "body", "in": "body",
"required": true, "required": true,
"schema": { "schema": {
"$ref": "#/definitions/v1.PatchMemoRequest" "$ref": "#/definitions/github_com_usememos_memos_api_v1.PatchMemoRequest"
} }
} }
], ],
...@@ -747,7 +747,7 @@ const docTemplate = `{ ...@@ -747,7 +747,7 @@ const docTemplate = `{
"in": "body", "in": "body",
"required": true, "required": true,
"schema": { "schema": {
"$ref": "#/definitions/v1.UpsertMemoOrganizerRequest" "$ref": "#/definitions/github_com_usememos_memos_api_v1.UpsertMemoOrganizerRequest"
} }
} }
], ],
...@@ -838,7 +838,7 @@ const docTemplate = `{ ...@@ -838,7 +838,7 @@ const docTemplate = `{
"in": "body", "in": "body",
"required": true, "required": true,
"schema": { "schema": {
"$ref": "#/definitions/v1.UpsertMemoRelationRequest" "$ref": "#/definitions/api_v1.UpsertMemoRelationRequest"
} }
} }
], ],
...@@ -889,7 +889,7 @@ const docTemplate = `{ ...@@ -889,7 +889,7 @@ const docTemplate = `{
{ {
"enum": [ "enum": [
"REFERENCE", "REFERENCE",
"ADDITIONAL" "COMMENT"
], ],
"type": "string", "type": "string",
"description": "Type of relation to remove", "description": "Type of relation to remove",
...@@ -992,7 +992,7 @@ const docTemplate = `{ ...@@ -992,7 +992,7 @@ const docTemplate = `{
"in": "body", "in": "body",
"required": true, "required": true,
"schema": { "schema": {
"$ref": "#/definitions/v1.CreateResourceRequest" "$ref": "#/definitions/github_com_usememos_memos_api_v1.CreateResourceRequest"
} }
} }
], ],
...@@ -1116,7 +1116,7 @@ const docTemplate = `{ ...@@ -1116,7 +1116,7 @@ const docTemplate = `{
"in": "body", "in": "body",
"required": true, "required": true,
"schema": { "schema": {
"$ref": "#/definitions/v1.UpdateResourceRequest" "$ref": "#/definitions/github_com_usememos_memos_api_v1.UpdateResourceRequest"
} }
} }
], ],
...@@ -1155,7 +1155,7 @@ const docTemplate = `{ ...@@ -1155,7 +1155,7 @@ const docTemplate = `{
"200": { "200": {
"description": "System GetSystemStatus", "description": "System GetSystemStatus",
"schema": { "schema": {
"$ref": "#/definitions/v1.SystemStatus" "$ref": "#/definitions/github_com_usememos_memos_api_v1.SystemStatus"
} }
}, },
"401": { "401": {
...@@ -1212,7 +1212,7 @@ const docTemplate = `{ ...@@ -1212,7 +1212,7 @@ const docTemplate = `{
"in": "body", "in": "body",
"required": true, "required": true,
"schema": { "schema": {
"$ref": "#/definitions/v1.CreateStorageRequest" "$ref": "#/definitions/github_com_usememos_memos_api_v1.CreateStorageRequest"
} }
} }
], ],
...@@ -1293,7 +1293,7 @@ const docTemplate = `{ ...@@ -1293,7 +1293,7 @@ const docTemplate = `{
"in": "body", "in": "body",
"required": true, "required": true,
"schema": { "schema": {
"$ref": "#/definitions/v1.UpdateStorageRequest" "$ref": "#/definitions/github_com_usememos_memos_api_v1.UpdateStorageRequest"
} }
} }
], ],
...@@ -1331,7 +1331,7 @@ const docTemplate = `{ ...@@ -1331,7 +1331,7 @@ const docTemplate = `{
"schema": { "schema": {
"type": "array", "type": "array",
"items": { "items": {
"$ref": "#/definitions/v1.SystemSetting" "$ref": "#/definitions/api_v1.SystemSetting"
} }
} }
}, },
...@@ -1361,7 +1361,7 @@ const docTemplate = `{ ...@@ -1361,7 +1361,7 @@ const docTemplate = `{
"in": "body", "in": "body",
"required": true, "required": true,
"schema": { "schema": {
"$ref": "#/definitions/v1.UpsertSystemSettingRequest" "$ref": "#/definitions/api_v1.UpsertSystemSettingRequest"
} }
} }
], ],
...@@ -1457,7 +1457,7 @@ const docTemplate = `{ ...@@ -1457,7 +1457,7 @@ const docTemplate = `{
"in": "body", "in": "body",
"required": true, "required": true,
"schema": { "schema": {
"$ref": "#/definitions/v1.UpsertTagRequest" "$ref": "#/definitions/github_com_usememos_memos_api_v1.UpsertTagRequest"
} }
} }
], ],
...@@ -1499,7 +1499,7 @@ const docTemplate = `{ ...@@ -1499,7 +1499,7 @@ const docTemplate = `{
"in": "body", "in": "body",
"required": true, "required": true,
"schema": { "schema": {
"$ref": "#/definitions/v1.DeleteTagRequest" "$ref": "#/definitions/github_com_usememos_memos_api_v1.DeleteTagRequest"
} }
} }
], ],
...@@ -1592,7 +1592,7 @@ const docTemplate = `{ ...@@ -1592,7 +1592,7 @@ const docTemplate = `{
"in": "body", "in": "body",
"required": true, "required": true,
"schema": { "schema": {
"$ref": "#/definitions/v1.CreateUserRequest" "$ref": "#/definitions/github_com_usememos_memos_api_v1.CreateUserRequest"
} }
} }
], ],
...@@ -1677,48 +1677,6 @@ const docTemplate = `{ ...@@ -1677,48 +1677,6 @@ const docTemplate = `{
} }
} }
}, },
"/api/v1/user/setting": {
"post": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"user-setting"
],
"summary": "Upsert user setting",
"parameters": [
{
"description": "Request object.",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.UpsertUserSettingRequest"
}
}
],
"responses": {
"200": {
"description": "Created user setting",
"schema": {
"$ref": "#/definitions/github_com_usememos_memos_store.UserSetting"
}
},
"400": {
"description": "Malformatted post user setting upsert request | Invalid user setting format"
},
"401": {
"description": "Missing auth session"
},
"500": {
"description": "Failed to upsert user setting"
}
}
}
},
"/api/v1/user/{id}": { "/api/v1/user/{id}": {
"get": { "get": {
"produces": [ "produces": [
...@@ -1815,7 +1773,7 @@ const docTemplate = `{ ...@@ -1815,7 +1773,7 @@ const docTemplate = `{
"in": "body", "in": "body",
"required": true, "required": true,
"schema": { "schema": {
"$ref": "#/definitions/v1.UpdateUserRequest" "$ref": "#/definitions/github_com_usememos_memos_api_v1.UpdateUserRequest"
} }
} }
], ],
...@@ -1866,7 +1824,7 @@ const docTemplate = `{ ...@@ -1866,7 +1824,7 @@ const docTemplate = `{
"GetImage/*" "GetImage/*"
], ],
"tags": [ "tags": [
"get" "image-url"
], ],
"summary": "Get GetImage from URL", "summary": "Get GetImage from URL",
"parameters": [ "parameters": [
...@@ -1891,50 +1849,6 @@ const docTemplate = `{ ...@@ -1891,50 +1849,6 @@ const docTemplate = `{
} }
} }
}, },
"/o/r/{resourceId}": {
"get": {
"description": "*Swagger UI may have problems displaying other file types than images",
"produces": [
"application/octet-stream"
],
"tags": [
"resource"
],
"summary": "Stream a resource",
"parameters": [
{
"type": "integer",
"description": "Resource ID",
"name": "resourceId",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "Thumbnail",
"name": "thumbnail",
"in": "query"
}
],
"responses": {
"200": {
"description": "Requested resource"
},
"400": {
"description": "ID is not a number: %s | Failed to get resource visibility"
},
"401": {
"description": "Resource visibility not match"
},
"404": {
"description": "Resource not found: %d"
},
"500": {
"description": "Failed to find resource by ID: %v | Failed to open the local resource: %s | Failed to read the local resource: %s"
}
}
}
},
"/u/{id}/rss.xml": { "/u/{id}/rss.xml": {
"get": { "get": {
"produces": [ "produces": [
...@@ -1968,42 +1882,141 @@ const docTemplate = `{ ...@@ -1968,42 +1882,141 @@ const docTemplate = `{
} }
}, },
"definitions": { "definitions": {
"github_com_usememos_memos_store.UserSetting": { "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", "type": "object",
"properties": { "properties": {
"key": { "content": {
"type": "string" "type": "string"
}, },
"userID": { "createdTs": {
"type": "integer" "type": "integer"
}, },
"value": { "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" "type": "string"
} }
} }
}, },
"profile.Profile": { "api_v1.CreateStorageRequest": {
"type": "object", "type": "object",
"properties": { "properties": {
"driver": { "config": {
"description": "Driver is the database driver\nsqlite, mysql", "$ref": "#/definitions/api_v1.StorageConfig"
},
"name": {
"type": "string" "type": "string"
}, },
"dsn": { "type": {
"description": "DSN points to where Memos stores its own data", "$ref": "#/definitions/api_v1.StorageType"
}
}
},
"api_v1.CreateUserRequest": {
"type": "object",
"properties": {
"email": {
"type": "string" "type": "string"
}, },
"mode": { "nickname": {
"description": "Mode can be \"prod\" or \"dev\" or \"demo\"",
"type": "string" "type": "string"
}, },
"version": { "password": {
"description": "Version is the current version of server", "type": "string"
},
"role": {
"$ref": "#/definitions/api_v1.Role"
},
"username": {
"type": "string" "type": "string"
} }
} }
}, },
"store.FieldMapping": { "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"
},
"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"
}
}
},
"api_v1.DeleteTagRequest": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
},
"api_v1.FieldMapping": {
"type": "object", "type": "object",
"properties": { "properties": {
"displayName": { "displayName": {
...@@ -2017,11 +2030,11 @@ const docTemplate = `{ ...@@ -2017,11 +2030,11 @@ const docTemplate = `{
} }
} }
}, },
"store.IdentityProvider": { "api_v1.IdentityProvider": {
"type": "object", "type": "object",
"properties": { "properties": {
"config": { "config": {
"$ref": "#/definitions/store.IdentityProviderConfig" "$ref": "#/definitions/api_v1.IdentityProviderConfig"
}, },
"id": { "id": {
"type": "integer" "type": "integer"
...@@ -2033,19 +2046,19 @@ const docTemplate = `{ ...@@ -2033,19 +2046,19 @@ const docTemplate = `{
"type": "string" "type": "string"
}, },
"type": { "type": {
"$ref": "#/definitions/store.IdentityProviderType" "$ref": "#/definitions/api_v1.IdentityProviderType"
} }
} }
}, },
"store.IdentityProviderConfig": { "api_v1.IdentityProviderConfig": {
"type": "object", "type": "object",
"properties": { "properties": {
"oauth2Config": { "oauth2Config": {
"$ref": "#/definitions/store.IdentityProviderOAuth2Config" "$ref": "#/definitions/api_v1.IdentityProviderOAuth2Config"
} }
} }
}, },
"store.IdentityProviderOAuth2Config": { "api_v1.IdentityProviderOAuth2Config": {
"type": "object", "type": "object",
"properties": { "properties": {
"authUrl": { "authUrl": {
...@@ -2058,7 +2071,7 @@ const docTemplate = `{ ...@@ -2058,7 +2071,7 @@ const docTemplate = `{
"type": "string" "type": "string"
}, },
"fieldMapping": { "fieldMapping": {
"$ref": "#/definitions/store.FieldMapping" "$ref": "#/definitions/api_v1.FieldMapping"
}, },
"scopes": { "scopes": {
"type": "array", "type": "array",
...@@ -2074,7 +2087,7 @@ const docTemplate = `{ ...@@ -2074,7 +2087,7 @@ const docTemplate = `{
} }
} }
}, },
"store.IdentityProviderType": { "api_v1.IdentityProviderType": {
"type": "string", "type": "string",
"enum": [ "enum": [
"OAUTH2" "OAUTH2"
...@@ -2083,7 +2096,18 @@ const docTemplate = `{ ...@@ -2083,7 +2096,18 @@ const docTemplate = `{
"IdentityProviderOAuth2Type" "IdentityProviderOAuth2Type"
] ]
}, },
"store.Memo": { "api_v1.MemoRelationType": {
"type": "string",
"enum": [
"REFERENCE",
"COMMENT"
],
"x-enum-varnames": [
"MemoRelationReference",
"MemoRelationComment"
]
},
"api_v1.PatchMemoRequest": {
"type": "object", "type": "object",
"properties": { "properties": {
"content": { "content": {
...@@ -2091,176 +2115,357 @@ const docTemplate = `{ ...@@ -2091,176 +2115,357 @@ const docTemplate = `{
"type": "string" "type": "string"
}, },
"createdTs": { "createdTs": {
"description": "Standard fields",
"type": "integer" "type": "integer"
}, },
"creatorID": {
"type": "integer"
},
"id": {
"type": "integer"
},
"parentID": {
"description": "Composed fields\nFor those comment memos, the parent ID is the memo ID of the memo being commented.\nIf the parent ID is nil, then this memo is not a comment.",
"type": "integer"
},
"pinned": {
"type": "boolean"
},
"relationList": { "relationList": {
"type": "array", "type": "array",
"items": { "items": {
"$ref": "#/definitions/store.MemoRelation" "$ref": "#/definitions/api_v1.UpsertMemoRelationRequest"
} }
}, },
"resourceIDList": { "resourceIdList": {
"description": "Related fields",
"type": "array", "type": "array",
"items": { "items": {
"type": "integer" "type": "integer"
} }
}, },
"rowStatus": { "rowStatus": {
"description": "Standard fields", "$ref": "#/definitions/api_v1.RowStatus"
"allOf": [
{
"$ref": "#/definitions/store.RowStatus"
}
]
}, },
"updatedTs": { "updatedTs": {
"type": "integer" "type": "integer"
}, },
"visibility": { "visibility": {
"$ref": "#/definitions/store.Visibility" "$ref": "#/definitions/api_v1.Visibility"
} }
} }
}, },
"store.MemoRelation": { "api_v1.Role": {
"type": "object", "type": "string",
"properties": { "enum": [
"memoID": { "HOST",
"type": "integer" "ADMIN",
}, "USER"
"relatedMemoID": { ],
"type": "integer" "x-enum-varnames": [
}, "RoleHost",
"type": { "RoleAdmin",
"$ref": "#/definitions/store.MemoRelationType" "RoleUser"
} ]
}
}, },
"store.MemoRelationType": { "api_v1.RowStatus": {
"type": "string", "type": "string",
"enum": [ "enum": [
"REFERENCE", "NORMAL",
"COMMENT" "ARCHIVED"
], ],
"x-enum-varnames": [ "x-enum-varnames": [
"MemoRelationReference", "Normal",
"MemoRelationComment" "Archived"
] ]
}, },
"store.Resource": { "api_v1.SSOSignIn": {
"type": "object", "type": "object",
"properties": { "properties": {
"blob": { "code": {
"type": "array", "type": "string"
"items": {
"type": "integer"
}
}, },
"createdTs": { "identityProviderId": {
"type": "integer" "type": "integer"
}, },
"creatorID": { "redirectUri": {
"description": "Standard fields", "type": "string"
"type": "integer" }
}
}, },
"externalLink": { "api_v1.SignIn": {
"type": "object",
"properties": {
"password": {
"type": "string" "type": "string"
}, },
"filename": { "remember": {
"description": "Domain specific fields", "type": "boolean"
},
"username": {
"type": "string" "type": "string"
}
}
}, },
"id": { "api_v1.SignUp": {
"type": "integer" "type": "object",
"properties": {
"password": {
"type": "string"
}, },
"internalPath": { "username": {
"type": "string" "type": "string"
}
}
}, },
"memoID": { "api_v1.StorageConfig": {
"type": "integer" "type": "object",
"properties": {
"s3Config": {
"$ref": "#/definitions/api_v1.StorageS3Config"
}
}
}, },
"size": { "api_v1.StorageS3Config": {
"type": "integer" "type": "object",
"properties": {
"accessKey": {
"type": "string"
}, },
"type": { "bucket": {
"type": "string" "type": "string"
}, },
"updatedTs": { "endPoint": {
"type": "integer" "type": "string"
},
"path": {
"type": "string"
},
"region": {
"type": "string"
},
"secretKey": {
"type": "string"
},
"urlPrefix": {
"type": "string"
},
"urlSuffix": {
"type": "string"
} }
} }
}, },
"store.Role": { "api_v1.StorageType": {
"type": "string", "type": "string",
"enum": [ "enum": [
"HOST", "S3"
"ADMIN",
"USER"
], ],
"x-enum-varnames": [ "x-enum-varnames": [
"RoleHost", "StorageS3"
"RoleAdmin",
"RoleUser"
] ]
}, },
"store.RowStatus": { "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", "type": "string",
"enum": [ "enum": [
"NORMAL", "server-id",
"ARCHIVED" "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"
], ],
"x-enum-varnames": [ "x-enum-varnames": [
"Normal", "SystemSettingServerIDName",
"Archived" "SystemSettingSecretSessionName",
"SystemSettingAllowSignUpName",
"SystemSettingDisablePasswordLoginName",
"SystemSettingDisablePublicMemosName",
"SystemSettingMaxUploadSizeMiBName",
"SystemSettingAdditionalStyleName",
"SystemSettingAdditionalScriptName",
"SystemSettingCustomizedProfileName",
"SystemSettingStorageServiceIDName",
"SystemSettingLocalStoragePathName",
"SystemSettingTelegramBotTokenName",
"SystemSettingMemoDisplayWithUpdatedTsName",
"SystemSettingInstanceURLName"
] ]
}, },
"store.Storage": { "api_v1.SystemStatus": {
"type": "object", "type": "object",
"properties": { "properties": {
"config": { "additionalScript": {
"description": "Additional script.",
"type": "string" "type": "string"
}, },
"id": { "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" "type": "integer"
}
}
},
"api_v1.UpdateIdentityProviderRequest": {
"type": "object",
"properties": {
"config": {
"$ref": "#/definitions/api_v1.IdentityProviderConfig"
},
"identifierFilter": {
"type": "string"
}, },
"name": { "name": {
"type": "string" "type": "string"
}, },
"type": { "type": {
"$ref": "#/definitions/api_v1.IdentityProviderType"
}
}
},
"api_v1.UpdateResourceRequest": {
"type": "object",
"properties": {
"filename": {
"type": "string" "type": "string"
} }
} }
}, },
"store.SystemSetting": { "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", "type": "object",
"properties": { "properties": {
"description": { "description": {
"type": "string" "type": "string"
}, },
"name": { "name": {
"type": "string" "$ref": "#/definitions/api_v1.SystemSettingName"
}, },
"value": { "value": {
"type": "string" "type": "string"
} }
} }
}, },
"store.User": { "api_v1.UpsertTagRequest": {
"type": "object", "type": "object",
"properties": { "properties": {
"avatarURL": { "name": {
"type": "string"
}
}
},
"api_v1.User": {
"type": "object",
"properties": {
"avatarUrl": {
"type": "string" "type": "string"
}, },
"createdTs": { "createdTs": {
...@@ -2275,17 +2480,14 @@ const docTemplate = `{ ...@@ -2275,17 +2480,14 @@ const docTemplate = `{
"nickname": { "nickname": {
"type": "string" "type": "string"
}, },
"passwordHash": {
"type": "string"
},
"role": { "role": {
"$ref": "#/definitions/store.Role" "$ref": "#/definitions/api_v1.Role"
}, },
"rowStatus": { "rowStatus": {
"description": "Standard fields", "description": "Standard fields",
"allOf": [ "allOf": [
{ {
"$ref": "#/definitions/store.RowStatus" "$ref": "#/definitions/api_v1.RowStatus"
} }
] ]
}, },
...@@ -2298,7 +2500,7 @@ const docTemplate = `{ ...@@ -2298,7 +2500,7 @@ const docTemplate = `{
} }
} }
}, },
"store.Visibility": { "api_v1.Visibility": {
"type": "string", "type": "string",
"enum": [ "enum": [
"PUBLIC", "PUBLIC",
...@@ -2311,11 +2513,11 @@ const docTemplate = `{ ...@@ -2311,11 +2513,11 @@ const docTemplate = `{
"Private" "Private"
] ]
}, },
"v1.CreateIdentityProviderRequest": { "github_com_usememos_memos_api_v1.CreateIdentityProviderRequest": {
"type": "object", "type": "object",
"properties": { "properties": {
"config": { "config": {
"$ref": "#/definitions/v1.IdentityProviderConfig" "$ref": "#/definitions/github_com_usememos_memos_api_v1.IdentityProviderConfig"
}, },
"identifierFilter": { "identifierFilter": {
"type": "string" "type": "string"
...@@ -2324,11 +2526,11 @@ const docTemplate = `{ ...@@ -2324,11 +2526,11 @@ const docTemplate = `{
"type": "string" "type": "string"
}, },
"type": { "type": {
"$ref": "#/definitions/v1.IdentityProviderType" "$ref": "#/definitions/github_com_usememos_memos_api_v1.IdentityProviderType"
} }
} }
}, },
"v1.CreateMemoRequest": { "github_com_usememos_memos_api_v1.CreateMemoRequest": {
"type": "object", "type": "object",
"properties": { "properties": {
"content": { "content": {
...@@ -2340,7 +2542,7 @@ const docTemplate = `{ ...@@ -2340,7 +2542,7 @@ const docTemplate = `{
"relationList": { "relationList": {
"type": "array", "type": "array",
"items": { "items": {
"$ref": "#/definitions/v1.UpsertMemoRelationRequest" "$ref": "#/definitions/github_com_usememos_memos_api_v1.UpsertMemoRelationRequest"
} }
}, },
"resourceIdList": { "resourceIdList": {
...@@ -2354,13 +2556,13 @@ const docTemplate = `{ ...@@ -2354,13 +2556,13 @@ const docTemplate = `{
"description": "Domain specific fields", "description": "Domain specific fields",
"allOf": [ "allOf": [
{ {
"$ref": "#/definitions/v1.Visibility" "$ref": "#/definitions/github_com_usememos_memos_api_v1.Visibility"
} }
] ]
} }
} }
}, },
"v1.CreateResourceRequest": { "github_com_usememos_memos_api_v1.CreateResourceRequest": {
"type": "object", "type": "object",
"properties": { "properties": {
"externalLink": { "externalLink": {
...@@ -2374,21 +2576,21 @@ const docTemplate = `{ ...@@ -2374,21 +2576,21 @@ const docTemplate = `{
} }
} }
}, },
"v1.CreateStorageRequest": { "github_com_usememos_memos_api_v1.CreateStorageRequest": {
"type": "object", "type": "object",
"properties": { "properties": {
"config": { "config": {
"$ref": "#/definitions/v1.StorageConfig" "$ref": "#/definitions/github_com_usememos_memos_api_v1.StorageConfig"
}, },
"name": { "name": {
"type": "string" "type": "string"
}, },
"type": { "type": {
"$ref": "#/definitions/v1.StorageType" "$ref": "#/definitions/github_com_usememos_memos_api_v1.StorageType"
} }
} }
}, },
"v1.CreateUserRequest": { "github_com_usememos_memos_api_v1.CreateUserRequest": {
"type": "object", "type": "object",
"properties": { "properties": {
"email": { "email": {
...@@ -2401,14 +2603,14 @@ const docTemplate = `{ ...@@ -2401,14 +2603,14 @@ const docTemplate = `{
"type": "string" "type": "string"
}, },
"role": { "role": {
"$ref": "#/definitions/v1.Role" "$ref": "#/definitions/github_com_usememos_memos_api_v1.Role"
}, },
"username": { "username": {
"type": "string" "type": "string"
} }
} }
}, },
"v1.CustomizedProfile": { "github_com_usememos_memos_api_v1.CustomizedProfile": {
"type": "object", "type": "object",
"properties": { "properties": {
"appearance": { "appearance": {
...@@ -2437,7 +2639,7 @@ const docTemplate = `{ ...@@ -2437,7 +2639,7 @@ const docTemplate = `{
} }
} }
}, },
"v1.DeleteTagRequest": { "github_com_usememos_memos_api_v1.DeleteTagRequest": {
"type": "object", "type": "object",
"properties": { "properties": {
"name": { "name": {
...@@ -2445,7 +2647,7 @@ const docTemplate = `{ ...@@ -2445,7 +2647,7 @@ const docTemplate = `{
} }
} }
}, },
"v1.FieldMapping": { "github_com_usememos_memos_api_v1.FieldMapping": {
"type": "object", "type": "object",
"properties": { "properties": {
"displayName": { "displayName": {
...@@ -2459,11 +2661,11 @@ const docTemplate = `{ ...@@ -2459,11 +2661,11 @@ const docTemplate = `{
} }
} }
}, },
"v1.IdentityProvider": { "github_com_usememos_memos_api_v1.IdentityProvider": {
"type": "object", "type": "object",
"properties": { "properties": {
"config": { "config": {
"$ref": "#/definitions/v1.IdentityProviderConfig" "$ref": "#/definitions/github_com_usememos_memos_api_v1.IdentityProviderConfig"
}, },
"id": { "id": {
"type": "integer" "type": "integer"
...@@ -2475,19 +2677,19 @@ const docTemplate = `{ ...@@ -2475,19 +2677,19 @@ const docTemplate = `{
"type": "string" "type": "string"
}, },
"type": { "type": {
"$ref": "#/definitions/v1.IdentityProviderType" "$ref": "#/definitions/github_com_usememos_memos_api_v1.IdentityProviderType"
} }
} }
}, },
"v1.IdentityProviderConfig": { "github_com_usememos_memos_api_v1.IdentityProviderConfig": {
"type": "object", "type": "object",
"properties": { "properties": {
"oauth2Config": { "oauth2Config": {
"$ref": "#/definitions/v1.IdentityProviderOAuth2Config" "$ref": "#/definitions/github_com_usememos_memos_api_v1.IdentityProviderOAuth2Config"
} }
} }
}, },
"v1.IdentityProviderOAuth2Config": { "github_com_usememos_memos_api_v1.IdentityProviderOAuth2Config": {
"type": "object", "type": "object",
"properties": { "properties": {
"authUrl": { "authUrl": {
...@@ -2500,7 +2702,7 @@ const docTemplate = `{ ...@@ -2500,7 +2702,7 @@ const docTemplate = `{
"type": "string" "type": "string"
}, },
"fieldMapping": { "fieldMapping": {
"$ref": "#/definitions/v1.FieldMapping" "$ref": "#/definitions/github_com_usememos_memos_api_v1.FieldMapping"
}, },
"scopes": { "scopes": {
"type": "array", "type": "array",
...@@ -2516,7 +2718,7 @@ const docTemplate = `{ ...@@ -2516,7 +2718,7 @@ const docTemplate = `{
} }
} }
}, },
"v1.IdentityProviderType": { "github_com_usememos_memos_api_v1.IdentityProviderType": {
"type": "string", "type": "string",
"enum": [ "enum": [
"OAUTH2" "OAUTH2"
...@@ -2525,18 +2727,18 @@ const docTemplate = `{ ...@@ -2525,18 +2727,18 @@ const docTemplate = `{
"IdentityProviderOAuth2Type" "IdentityProviderOAuth2Type"
] ]
}, },
"v1.MemoRelationType": { "github_com_usememos_memos_api_v1.MemoRelationType": {
"type": "string", "type": "string",
"enum": [ "enum": [
"REFERENCE", "REFERENCE",
"ADDITIONAL" "COMMENT"
], ],
"x-enum-varnames": [ "x-enum-varnames": [
"MemoRelationReference", "MemoRelationReference",
"MemoRelationAdditional" "MemoRelationComment"
] ]
}, },
"v1.PatchMemoRequest": { "github_com_usememos_memos_api_v1.PatchMemoRequest": {
"type": "object", "type": "object",
"properties": { "properties": {
"content": { "content": {
...@@ -2550,7 +2752,7 @@ const docTemplate = `{ ...@@ -2550,7 +2752,7 @@ const docTemplate = `{
"relationList": { "relationList": {
"type": "array", "type": "array",
"items": { "items": {
"$ref": "#/definitions/v1.UpsertMemoRelationRequest" "$ref": "#/definitions/github_com_usememos_memos_api_v1.UpsertMemoRelationRequest"
} }
}, },
"resourceIdList": { "resourceIdList": {
...@@ -2561,17 +2763,17 @@ const docTemplate = `{ ...@@ -2561,17 +2763,17 @@ const docTemplate = `{
} }
}, },
"rowStatus": { "rowStatus": {
"$ref": "#/definitions/v1.RowStatus" "$ref": "#/definitions/github_com_usememos_memos_api_v1.RowStatus"
}, },
"updatedTs": { "updatedTs": {
"type": "integer" "type": "integer"
}, },
"visibility": { "visibility": {
"$ref": "#/definitions/v1.Visibility" "$ref": "#/definitions/github_com_usememos_memos_api_v1.Visibility"
} }
} }
}, },
"v1.Role": { "github_com_usememos_memos_api_v1.Role": {
"type": "string", "type": "string",
"enum": [ "enum": [
"HOST", "HOST",
...@@ -2584,7 +2786,7 @@ const docTemplate = `{ ...@@ -2584,7 +2786,7 @@ const docTemplate = `{
"RoleUser" "RoleUser"
] ]
}, },
"v1.RowStatus": { "github_com_usememos_memos_api_v1.RowStatus": {
"type": "string", "type": "string",
"enum": [ "enum": [
"NORMAL", "NORMAL",
...@@ -2595,7 +2797,7 @@ const docTemplate = `{ ...@@ -2595,7 +2797,7 @@ const docTemplate = `{
"Archived" "Archived"
] ]
}, },
"v1.SSOSignIn": { "github_com_usememos_memos_api_v1.SSOSignIn": {
"type": "object", "type": "object",
"properties": { "properties": {
"code": { "code": {
...@@ -2609,18 +2811,21 @@ const docTemplate = `{ ...@@ -2609,18 +2811,21 @@ const docTemplate = `{
} }
} }
}, },
"v1.SignIn": { "github_com_usememos_memos_api_v1.SignIn": {
"type": "object", "type": "object",
"properties": { "properties": {
"password": { "password": {
"type": "string" "type": "string"
}, },
"remember": {
"type": "boolean"
},
"username": { "username": {
"type": "string" "type": "string"
} }
} }
}, },
"v1.SignUp": { "github_com_usememos_memos_api_v1.SignUp": {
"type": "object", "type": "object",
"properties": { "properties": {
"password": { "password": {
...@@ -2631,15 +2836,15 @@ const docTemplate = `{ ...@@ -2631,15 +2836,15 @@ const docTemplate = `{
} }
} }
}, },
"v1.StorageConfig": { "github_com_usememos_memos_api_v1.StorageConfig": {
"type": "object", "type": "object",
"properties": { "properties": {
"s3Config": { "s3Config": {
"$ref": "#/definitions/v1.StorageS3Config" "$ref": "#/definitions/github_com_usememos_memos_api_v1.StorageS3Config"
} }
} }
}, },
"v1.StorageS3Config": { "github_com_usememos_memos_api_v1.StorageS3Config": {
"type": "object", "type": "object",
"properties": { "properties": {
"accessKey": { "accessKey": {
...@@ -2668,7 +2873,7 @@ const docTemplate = `{ ...@@ -2668,7 +2873,7 @@ const docTemplate = `{
} }
} }
}, },
"v1.StorageType": { "github_com_usememos_memos_api_v1.StorageType": {
"type": "string", "type": "string",
"enum": [ "enum": [
"S3" "S3"
...@@ -2677,14 +2882,14 @@ const docTemplate = `{ ...@@ -2677,14 +2882,14 @@ const docTemplate = `{
"StorageS3" "StorageS3"
] ]
}, },
"v1.SystemSetting": { "github_com_usememos_memos_api_v1.SystemSetting": {
"type": "object", "type": "object",
"properties": { "properties": {
"description": { "description": {
"type": "string" "type": "string"
}, },
"name": { "name": {
"$ref": "#/definitions/v1.SystemSettingName" "$ref": "#/definitions/github_com_usememos_memos_api_v1.SystemSettingName"
}, },
"value": { "value": {
"description": "Value is a JSON string with basic value.", "description": "Value is a JSON string with basic value.",
...@@ -2692,7 +2897,7 @@ const docTemplate = `{ ...@@ -2692,7 +2897,7 @@ const docTemplate = `{
} }
} }
}, },
"v1.SystemSettingName": { "github_com_usememos_memos_api_v1.SystemSettingName": {
"type": "string", "type": "string",
"enum": [ "enum": [
"server-id", "server-id",
...@@ -2708,7 +2913,7 @@ const docTemplate = `{ ...@@ -2708,7 +2913,7 @@ const docTemplate = `{
"local-storage-path", "local-storage-path",
"telegram-bot-token", "telegram-bot-token",
"memo-display-with-updated-ts", "memo-display-with-updated-ts",
"auto-backup-interval" "instance-url"
], ],
"x-enum-varnames": [ "x-enum-varnames": [
"SystemSettingServerIDName", "SystemSettingServerIDName",
...@@ -2724,10 +2929,10 @@ const docTemplate = `{ ...@@ -2724,10 +2929,10 @@ const docTemplate = `{
"SystemSettingLocalStoragePathName", "SystemSettingLocalStoragePathName",
"SystemSettingTelegramBotTokenName", "SystemSettingTelegramBotTokenName",
"SystemSettingMemoDisplayWithUpdatedTsName", "SystemSettingMemoDisplayWithUpdatedTsName",
"SystemSettingAutoBackupIntervalName" "SystemSettingInstanceURLName"
] ]
}, },
"v1.SystemStatus": { "github_com_usememos_memos_api_v1.SystemStatus": {
"type": "object", "type": "object",
"properties": { "properties": {
"additionalScript": { "additionalScript": {
...@@ -2742,15 +2947,11 @@ const docTemplate = `{ ...@@ -2742,15 +2947,11 @@ const docTemplate = `{
"description": "System settings\nAllow sign up.", "description": "System settings\nAllow sign up.",
"type": "boolean" "type": "boolean"
}, },
"autoBackupInterval": {
"description": "Auto Backup Interval.",
"type": "integer"
},
"customizedProfile": { "customizedProfile": {
"description": "Customized server profile, including server name and external url.", "description": "Customized server profile, including server name and external url.",
"allOf": [ "allOf": [
{ {
"$ref": "#/definitions/v1.CustomizedProfile" "$ref": "#/definitions/github_com_usememos_memos_api_v1.CustomizedProfile"
} }
] ]
}, },
...@@ -2766,7 +2967,7 @@ const docTemplate = `{ ...@@ -2766,7 +2967,7 @@ const docTemplate = `{
"type": "boolean" "type": "boolean"
}, },
"host": { "host": {
"$ref": "#/definitions/v1.User" "$ref": "#/definitions/github_com_usememos_memos_api_v1.User"
}, },
"localStoragePath": { "localStoragePath": {
"description": "Local storage path.", "description": "Local storage path.",
...@@ -2789,11 +2990,11 @@ const docTemplate = `{ ...@@ -2789,11 +2990,11 @@ const docTemplate = `{
} }
} }
}, },
"v1.UpdateIdentityProviderRequest": { "github_com_usememos_memos_api_v1.UpdateIdentityProviderRequest": {
"type": "object", "type": "object",
"properties": { "properties": {
"config": { "config": {
"$ref": "#/definitions/v1.IdentityProviderConfig" "$ref": "#/definitions/github_com_usememos_memos_api_v1.IdentityProviderConfig"
}, },
"identifierFilter": { "identifierFilter": {
"type": "string" "type": "string"
...@@ -2802,11 +3003,11 @@ const docTemplate = `{ ...@@ -2802,11 +3003,11 @@ const docTemplate = `{
"type": "string" "type": "string"
}, },
"type": { "type": {
"$ref": "#/definitions/v1.IdentityProviderType" "$ref": "#/definitions/github_com_usememos_memos_api_v1.IdentityProviderType"
} }
} }
}, },
"v1.UpdateResourceRequest": { "github_com_usememos_memos_api_v1.UpdateResourceRequest": {
"type": "object", "type": "object",
"properties": { "properties": {
"filename": { "filename": {
...@@ -2814,21 +3015,21 @@ const docTemplate = `{ ...@@ -2814,21 +3015,21 @@ const docTemplate = `{
} }
} }
}, },
"v1.UpdateStorageRequest": { "github_com_usememos_memos_api_v1.UpdateStorageRequest": {
"type": "object", "type": "object",
"properties": { "properties": {
"config": { "config": {
"$ref": "#/definitions/v1.StorageConfig" "$ref": "#/definitions/github_com_usememos_memos_api_v1.StorageConfig"
}, },
"name": { "name": {
"type": "string" "type": "string"
}, },
"type": { "type": {
"$ref": "#/definitions/v1.StorageType" "$ref": "#/definitions/github_com_usememos_memos_api_v1.StorageType"
} }
} }
}, },
"v1.UpdateUserRequest": { "github_com_usememos_memos_api_v1.UpdateUserRequest": {
"type": "object", "type": "object",
"properties": { "properties": {
"avatarUrl": { "avatarUrl": {
...@@ -2844,14 +3045,14 @@ const docTemplate = `{ ...@@ -2844,14 +3045,14 @@ const docTemplate = `{
"type": "string" "type": "string"
}, },
"rowStatus": { "rowStatus": {
"$ref": "#/definitions/v1.RowStatus" "$ref": "#/definitions/github_com_usememos_memos_api_v1.RowStatus"
}, },
"username": { "username": {
"type": "string" "type": "string"
} }
} }
}, },
"v1.UpsertMemoOrganizerRequest": { "github_com_usememos_memos_api_v1.UpsertMemoOrganizerRequest": {
"type": "object", "type": "object",
"properties": { "properties": {
"pinned": { "pinned": {
...@@ -2859,32 +3060,32 @@ const docTemplate = `{ ...@@ -2859,32 +3060,32 @@ const docTemplate = `{
} }
} }
}, },
"v1.UpsertMemoRelationRequest": { "github_com_usememos_memos_api_v1.UpsertMemoRelationRequest": {
"type": "object", "type": "object",
"properties": { "properties": {
"relatedMemoId": { "relatedMemoId": {
"type": "integer" "type": "integer"
}, },
"type": { "type": {
"$ref": "#/definitions/v1.MemoRelationType" "$ref": "#/definitions/github_com_usememos_memos_api_v1.MemoRelationType"
} }
} }
}, },
"v1.UpsertSystemSettingRequest": { "github_com_usememos_memos_api_v1.UpsertSystemSettingRequest": {
"type": "object", "type": "object",
"properties": { "properties": {
"description": { "description": {
"type": "string" "type": "string"
}, },
"name": { "name": {
"$ref": "#/definitions/v1.SystemSettingName" "$ref": "#/definitions/github_com_usememos_memos_api_v1.SystemSettingName"
}, },
"value": { "value": {
"type": "string" "type": "string"
} }
} }
}, },
"v1.UpsertTagRequest": { "github_com_usememos_memos_api_v1.UpsertTagRequest": {
"type": "object", "type": "object",
"properties": { "properties": {
"name": { "name": {
...@@ -2892,91 +3093,351 @@ const docTemplate = `{ ...@@ -2892,91 +3093,351 @@ const docTemplate = `{
} }
} }
}, },
"v1.UpsertUserSettingRequest": { "github_com_usememos_memos_api_v1.User": {
"type": "object", "type": "object",
"properties": { "properties": {
"key": { "avatarUrl": {
"$ref": "#/definitions/v1.UserSettingKey" "type": "string"
}, },
"value": { "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" "type": "string"
} }
} }
}, },
"v1.User": { "github_com_usememos_memos_api_v1.Visibility": {
"type": "string",
"enum": [
"PUBLIC",
"PROTECTED",
"PRIVATE"
],
"x-enum-varnames": [
"Public",
"Protected",
"Private"
]
},
"profile.Profile": {
"type": "object", "type": "object",
"properties": { "properties": {
"avatarUrl": { "mode": {
"description": "Mode can be \"prod\" or \"dev\" or \"demo\"",
"type": "string" "type": "string"
}, },
"createdTs": { "version": {
"type": "integer" "description": "Version is the current version of server",
"type": "string"
}
}
},
"store.FieldMapping": {
"type": "object",
"properties": {
"displayName": {
"type": "string"
}, },
"email": { "email": {
"type": "string" "type": "string"
}, },
"identifier": {
"type": "string"
}
}
},
"store.IdentityProvider": {
"type": "object",
"properties": {
"config": {
"$ref": "#/definitions/store.IdentityProviderConfig"
},
"id": { "id": {
"type": "integer" "type": "integer"
}, },
"nickname": { "identifierFilter": {
"type": "string" "type": "string"
}, },
"role": { "name": {
"$ref": "#/definitions/v1.Role" "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"
},
"pinned": {
"description": "Composed fields",
"type": "boolean"
}, },
"rowStatus": { "rowStatus": {
"description": "Standard fields", "description": "Standard fields",
"allOf": [ "allOf": [
{ {
"$ref": "#/definitions/v1.RowStatus" "$ref": "#/definitions/store.RowStatus"
} }
] ]
}, },
"updatedTs": { "updatedTs": {
"type": "integer" "type": "integer"
}, },
"userSettingList": { "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", "type": "array",
"items": { "items": {
"$ref": "#/definitions/v1.UserSetting" "type": "integer"
} }
}, },
"username": { "createdTs": {
"type": "integer"
},
"creatorID": {
"description": "Standard fields",
"type": "integer"
},
"externalLink": {
"type": "string"
},
"filename": {
"description": "Domain specific fields", "description": "Domain specific fields",
"type": "string" "type": "string"
},
"id": {
"type": "integer"
},
"internalPath": {
"type": "string"
},
"memoID": {
"type": "integer"
},
"size": {
"type": "integer"
},
"type": {
"type": "string"
},
"updatedTs": {
"type": "integer"
} }
} }
}, },
"v1.UserSetting": { "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", "type": "object",
"properties": { "properties": {
"key": { "config": {
"$ref": "#/definitions/v1.UserSettingKey" "type": "string"
}, },
"userId": { "id": {
"type": "integer" "type": "integer"
}, },
"name": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"store.SystemSetting": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"value": { "value": {
"type": "string" "type": "string"
} }
} }
}, },
"v1.UserSettingKey": { "store.User": {
"type": "string", "type": "object",
"enum": [ "properties": {
"locale", "avatarURL": {
"appearance", "type": "string"
"memo-visibility", },
"telegram-user-id" "createdTs": {
], "type": "integer"
"x-enum-varnames": [ },
"UserSettingLocaleKey", "email": {
"UserSettingAppearanceKey", "type": "string"
"UserSettingMemoVisibilityKey", },
"UserSettingTelegramUserIDKey" "id": {
"type": "integer"
},
"nickname": {
"type": "string"
},
"passwordHash": {
"type": "string"
},
"role": {
"$ref": "#/definitions/store.Role"
},
"rowStatus": {
"description": "Standard fields",
"allOf": [
{
"$ref": "#/definitions/store.RowStatus"
}
] ]
}, },
"v1.Visibility": { "updatedTs": {
"type": "integer"
},
"username": {
"description": "Domain specific fields",
"type": "string"
}
}
},
"store.Visibility": {
"type": "string", "type": "string",
"enum": [ "enum": [
"PUBLIC", "PUBLIC",
......
api/v1/swagger.yaml
View file @ af68cae6
basePath: / basePath: /
definitions: definitions:
github_com_usememos_memos_store.UserSetting: api_v1.CreateIdentityProviderRequest:
properties: properties:
key: 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 type: string
userID: createdTs:
type: integer type: integer
value: 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: string
type: object type: object
profile.Profile: api_v1.CreateStorageRequest:
properties: properties:
driver: config:
description: |- $ref: '#/definitions/api_v1.StorageConfig'
Driver is the database driver name:
sqlite, mysql
type: string type: string
dsn: type:
description: DSN points to where Memos stores its own data $ref: '#/definitions/api_v1.StorageType'
type: object
api_v1.CreateUserRequest:
properties:
email:
type: string type: string
mode: nickname:
description: Mode can be "prod" or "dev" or "demo"
type: string type: string
version: password:
description: Version is the current version of server type: string
role:
$ref: '#/definitions/api_v1.Role'
username:
type: string type: string
type: object type: object
store.FieldMapping: 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: properties:
displayName: displayName:
type: string type: string
...@@ -35,10 +97,10 @@ definitions: ...@@ -35,10 +97,10 @@ definitions:
identifier: identifier:
type: string type: string
type: object type: object
store.IdentityProvider: api_v1.IdentityProvider:
properties: properties:
config: config:
$ref: '#/definitions/store.IdentityProviderConfig' $ref: '#/definitions/api_v1.IdentityProviderConfig'
id: id:
type: integer type: integer
identifierFilter: identifierFilter:
...@@ -46,14 +108,14 @@ definitions: ...@@ -46,14 +108,14 @@ definitions:
name: name:
type: string type: string
type: type:
$ref: '#/definitions/store.IdentityProviderType' $ref: '#/definitions/api_v1.IdentityProviderType'
type: object type: object
store.IdentityProviderConfig: api_v1.IdentityProviderConfig:
properties: properties:
oauth2Config: oauth2Config:
$ref: '#/definitions/store.IdentityProviderOAuth2Config' $ref: '#/definitions/api_v1.IdentityProviderOAuth2Config'
type: object type: object
store.IdentityProviderOAuth2Config: api_v1.IdentityProviderOAuth2Config:
properties: properties:
authUrl: authUrl:
type: string type: string
...@@ -62,7 +124,7 @@ definitions: ...@@ -62,7 +124,7 @@ definitions:
clientSecret: clientSecret:
type: string type: string
fieldMapping: fieldMapping:
$ref: '#/definitions/store.FieldMapping' $ref: '#/definitions/api_v1.FieldMapping'
scopes: scopes:
items: items:
type: string type: string
...@@ -72,95 +134,45 @@ definitions: ...@@ -72,95 +134,45 @@ definitions:
userInfoUrl: userInfoUrl:
type: string type: string
type: object type: object
store.IdentityProviderType: api_v1.IdentityProviderType:
enum: enum:
- OAUTH2 - OAUTH2
type: string type: string
x-enum-varnames: x-enum-varnames:
- IdentityProviderOAuth2Type - IdentityProviderOAuth2Type
store.Memo: api_v1.MemoRelationType:
enum:
- REFERENCE
- COMMENT
type: string
x-enum-varnames:
- MemoRelationReference
- MemoRelationComment
api_v1.PatchMemoRequest:
properties: properties:
content: content:
description: Domain specific fields description: Domain specific fields
type: string type: string
createdTs: createdTs:
description: Standard fields
type: integer type: integer
creatorID:
type: integer
id:
type: integer
parentID:
description: |-
Composed fields
For those comment memos, the parent ID is the memo ID of the memo being commented.
If the parent ID is nil, then this memo is not a comment.
type: integer
pinned:
type: boolean
relationList: relationList:
items: items:
$ref: '#/definitions/store.MemoRelation' $ref: '#/definitions/api_v1.UpsertMemoRelationRequest'
type: array type: array
resourceIDList: resourceIdList:
description: Related fields
items: items:
type: integer type: integer
type: array type: array
rowStatus: rowStatus:
allOf: $ref: '#/definitions/api_v1.RowStatus'
- $ref: '#/definitions/store.RowStatus'
description: Standard fields
updatedTs: updatedTs:
type: integer type: integer
visibility: visibility:
$ref: '#/definitions/store.Visibility' $ref: '#/definitions/api_v1.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 type: object
store.Role: api_v1.Role:
enum: enum:
- HOST - HOST
- ADMIN - ADMIN
...@@ -170,7 +182,7 @@ definitions: ...@@ -170,7 +182,7 @@ definitions:
- RoleHost - RoleHost
- RoleAdmin - RoleAdmin
- RoleUser - RoleUser
store.RowStatus: api_v1.RowStatus:
enum: enum:
- NORMAL - NORMAL
- ARCHIVED - ARCHIVED
...@@ -178,29 +190,215 @@ definitions: ...@@ -178,29 +190,215 @@ definitions:
x-enum-varnames: x-enum-varnames:
- Normal - Normal
- Archived - Archived
store.Storage: api_v1.SSOSignIn:
properties: properties:
config: code:
type: string type: string
id: 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 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: name:
type: string type: string
type: type:
$ref: '#/definitions/api_v1.IdentityProviderType'
type: object
api_v1.UpdateResourceRequest:
properties:
filename:
type: string type: string
type: object type: object
store.SystemSetting: 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: properties:
description: description:
type: string type: string
name:
$ref: '#/definitions/api_v1.SystemSettingName'
value:
type: string
type: object
api_v1.UpsertTagRequest:
properties:
name: name:
type: string type: string
value:
type: string
type: object type: object
store.User: api_v1.User:
properties: properties:
avatarURL: avatarUrl:
type: string type: string
createdTs: createdTs:
type: integer type: integer
...@@ -210,13 +408,11 @@ definitions: ...@@ -210,13 +408,11 @@ definitions:
type: integer type: integer
nickname: nickname:
type: string type: string
passwordHash:
type: string
role: role:
$ref: '#/definitions/store.Role' $ref: '#/definitions/api_v1.Role'
rowStatus: rowStatus:
allOf: allOf:
- $ref: '#/definitions/store.RowStatus' - $ref: '#/definitions/api_v1.RowStatus'
description: Standard fields description: Standard fields
updatedTs: updatedTs:
type: integer type: integer
...@@ -224,7 +420,7 @@ definitions: ...@@ -224,7 +420,7 @@ definitions:
description: Domain specific fields description: Domain specific fields
type: string type: string
type: object type: object
store.Visibility: api_v1.Visibility:
enum: enum:
- PUBLIC - PUBLIC
- PROTECTED - PROTECTED
...@@ -234,18 +430,18 @@ definitions: ...@@ -234,18 +430,18 @@ definitions:
- Public - Public
- Protected - Protected
- Private - Private
v1.CreateIdentityProviderRequest: github_com_usememos_memos_api_v1.CreateIdentityProviderRequest:
properties: properties:
config: config:
$ref: '#/definitions/v1.IdentityProviderConfig' $ref: '#/definitions/github_com_usememos_memos_api_v1.IdentityProviderConfig'
identifierFilter: identifierFilter:
type: string type: string
name: name:
type: string type: string
type: type:
$ref: '#/definitions/v1.IdentityProviderType' $ref: '#/definitions/github_com_usememos_memos_api_v1.IdentityProviderType'
type: object type: object
v1.CreateMemoRequest: github_com_usememos_memos_api_v1.CreateMemoRequest:
properties: properties:
content: content:
type: string type: string
...@@ -253,7 +449,7 @@ definitions: ...@@ -253,7 +449,7 @@ definitions:
type: integer type: integer
relationList: relationList:
items: items:
$ref: '#/definitions/v1.UpsertMemoRelationRequest' $ref: '#/definitions/github_com_usememos_memos_api_v1.UpsertMemoRelationRequest'
type: array type: array
resourceIdList: resourceIdList:
description: Related fields description: Related fields
...@@ -262,10 +458,10 @@ definitions: ...@@ -262,10 +458,10 @@ definitions:
type: array type: array
visibility: visibility:
allOf: allOf:
- $ref: '#/definitions/v1.Visibility' - $ref: '#/definitions/github_com_usememos_memos_api_v1.Visibility'
description: Domain specific fields description: Domain specific fields
type: object type: object
v1.CreateResourceRequest: github_com_usememos_memos_api_v1.CreateResourceRequest:
properties: properties:
externalLink: externalLink:
type: string type: string
...@@ -274,16 +470,16 @@ definitions: ...@@ -274,16 +470,16 @@ definitions:
type: type:
type: string type: string
type: object type: object
v1.CreateStorageRequest: github_com_usememos_memos_api_v1.CreateStorageRequest:
properties: properties:
config: config:
$ref: '#/definitions/v1.StorageConfig' $ref: '#/definitions/github_com_usememos_memos_api_v1.StorageConfig'
name: name:
type: string type: string
type: type:
$ref: '#/definitions/v1.StorageType' $ref: '#/definitions/github_com_usememos_memos_api_v1.StorageType'
type: object type: object
v1.CreateUserRequest: github_com_usememos_memos_api_v1.CreateUserRequest:
properties: properties:
email: email:
type: string type: string
...@@ -292,11 +488,11 @@ definitions: ...@@ -292,11 +488,11 @@ definitions:
password: password:
type: string type: string
role: role:
$ref: '#/definitions/v1.Role' $ref: '#/definitions/github_com_usememos_memos_api_v1.Role'
username: username:
type: string type: string
type: object type: object
v1.CustomizedProfile: github_com_usememos_memos_api_v1.CustomizedProfile:
properties: properties:
appearance: appearance:
description: Appearance is the server default appearance. description: Appearance is the server default appearance.
...@@ -317,12 +513,12 @@ definitions: ...@@ -317,12 +513,12 @@ definitions:
description: Name is the server name, default is `memos` description: Name is the server name, default is `memos`
type: string type: string
type: object type: object
v1.DeleteTagRequest: github_com_usememos_memos_api_v1.DeleteTagRequest:
properties: properties:
name: name:
type: string type: string
type: object type: object
v1.FieldMapping: github_com_usememos_memos_api_v1.FieldMapping:
properties: properties:
displayName: displayName:
type: string type: string
...@@ -331,10 +527,10 @@ definitions: ...@@ -331,10 +527,10 @@ definitions:
identifier: identifier:
type: string type: string
type: object type: object
v1.IdentityProvider: github_com_usememos_memos_api_v1.IdentityProvider:
properties: properties:
config: config:
$ref: '#/definitions/v1.IdentityProviderConfig' $ref: '#/definitions/github_com_usememos_memos_api_v1.IdentityProviderConfig'
id: id:
type: integer type: integer
identifierFilter: identifierFilter:
...@@ -342,14 +538,14 @@ definitions: ...@@ -342,14 +538,14 @@ definitions:
name: name:
type: string type: string
type: type:
$ref: '#/definitions/v1.IdentityProviderType' $ref: '#/definitions/github_com_usememos_memos_api_v1.IdentityProviderType'
type: object type: object
v1.IdentityProviderConfig: github_com_usememos_memos_api_v1.IdentityProviderConfig:
properties: properties:
oauth2Config: oauth2Config:
$ref: '#/definitions/v1.IdentityProviderOAuth2Config' $ref: '#/definitions/github_com_usememos_memos_api_v1.IdentityProviderOAuth2Config'
type: object type: object
v1.IdentityProviderOAuth2Config: github_com_usememos_memos_api_v1.IdentityProviderOAuth2Config:
properties: properties:
authUrl: authUrl:
type: string type: string
...@@ -358,7 +554,7 @@ definitions: ...@@ -358,7 +554,7 @@ definitions:
clientSecret: clientSecret:
type: string type: string
fieldMapping: fieldMapping:
$ref: '#/definitions/v1.FieldMapping' $ref: '#/definitions/github_com_usememos_memos_api_v1.FieldMapping'
scopes: scopes:
items: items:
type: string type: string
...@@ -368,21 +564,21 @@ definitions: ...@@ -368,21 +564,21 @@ definitions:
userInfoUrl: userInfoUrl:
type: string type: string
type: object type: object
v1.IdentityProviderType: github_com_usememos_memos_api_v1.IdentityProviderType:
enum: enum:
- OAUTH2 - OAUTH2
type: string type: string
x-enum-varnames: x-enum-varnames:
- IdentityProviderOAuth2Type - IdentityProviderOAuth2Type
v1.MemoRelationType: github_com_usememos_memos_api_v1.MemoRelationType:
enum: enum:
- REFERENCE - REFERENCE
- ADDITIONAL - COMMENT
type: string type: string
x-enum-varnames: x-enum-varnames:
- MemoRelationReference - MemoRelationReference
- MemoRelationAdditional - MemoRelationComment
v1.PatchMemoRequest: github_com_usememos_memos_api_v1.PatchMemoRequest:
properties: properties:
content: content:
description: Domain specific fields description: Domain specific fields
...@@ -392,7 +588,7 @@ definitions: ...@@ -392,7 +588,7 @@ definitions:
type: integer type: integer
relationList: relationList:
items: items:
$ref: '#/definitions/v1.UpsertMemoRelationRequest' $ref: '#/definitions/github_com_usememos_memos_api_v1.UpsertMemoRelationRequest'
type: array type: array
resourceIdList: resourceIdList:
description: Related fields description: Related fields
...@@ -400,13 +596,13 @@ definitions: ...@@ -400,13 +596,13 @@ definitions:
type: integer type: integer
type: array type: array
rowStatus: rowStatus:
$ref: '#/definitions/v1.RowStatus' $ref: '#/definitions/github_com_usememos_memos_api_v1.RowStatus'
updatedTs: updatedTs:
type: integer type: integer
visibility: visibility:
$ref: '#/definitions/v1.Visibility' $ref: '#/definitions/github_com_usememos_memos_api_v1.Visibility'
type: object type: object
v1.Role: github_com_usememos_memos_api_v1.Role:
enum: enum:
- HOST - HOST
- ADMIN - ADMIN
...@@ -416,7 +612,7 @@ definitions: ...@@ -416,7 +612,7 @@ definitions:
- RoleHost - RoleHost
- RoleAdmin - RoleAdmin
- RoleUser - RoleUser
v1.RowStatus: github_com_usememos_memos_api_v1.RowStatus:
enum: enum:
- NORMAL - NORMAL
- ARCHIVED - ARCHIVED
...@@ -424,7 +620,7 @@ definitions: ...@@ -424,7 +620,7 @@ definitions:
x-enum-varnames: x-enum-varnames:
- Normal - Normal
- Archived - Archived
v1.SSOSignIn: github_com_usememos_memos_api_v1.SSOSignIn:
properties: properties:
code: code:
type: string type: string
...@@ -433,26 +629,28 @@ definitions: ...@@ -433,26 +629,28 @@ definitions:
redirectUri: redirectUri:
type: string type: string
type: object type: object
v1.SignIn: github_com_usememos_memos_api_v1.SignIn:
properties: properties:
password: password:
type: string type: string
remember:
type: boolean
username: username:
type: string type: string
type: object type: object
v1.SignUp: github_com_usememos_memos_api_v1.SignUp:
properties: properties:
password: password:
type: string type: string
username: username:
type: string type: string
type: object type: object
v1.StorageConfig: github_com_usememos_memos_api_v1.StorageConfig:
properties: properties:
s3Config: s3Config:
$ref: '#/definitions/v1.StorageS3Config' $ref: '#/definitions/github_com_usememos_memos_api_v1.StorageS3Config'
type: object type: object
v1.StorageS3Config: github_com_usememos_memos_api_v1.StorageS3Config:
properties: properties:
accessKey: accessKey:
type: string type: string
...@@ -471,23 +669,23 @@ definitions: ...@@ -471,23 +669,23 @@ definitions:
urlSuffix: urlSuffix:
type: string type: string
type: object type: object
v1.StorageType: github_com_usememos_memos_api_v1.StorageType:
enum: enum:
- S3 - S3
type: string type: string
x-enum-varnames: x-enum-varnames:
- StorageS3 - StorageS3
v1.SystemSetting: github_com_usememos_memos_api_v1.SystemSetting:
properties: properties:
description: description:
type: string type: string
name: name:
$ref: '#/definitions/v1.SystemSettingName' $ref: '#/definitions/github_com_usememos_memos_api_v1.SystemSettingName'
value: value:
description: Value is a JSON string with basic value. description: Value is a JSON string with basic value.
type: string type: string
type: object type: object
v1.SystemSettingName: github_com_usememos_memos_api_v1.SystemSettingName:
enum: enum:
- server-id - server-id
- secret-session - secret-session
...@@ -502,7 +700,7 @@ definitions: ...@@ -502,7 +700,7 @@ definitions:
- local-storage-path - local-storage-path
- telegram-bot-token - telegram-bot-token
- memo-display-with-updated-ts - memo-display-with-updated-ts
- auto-backup-interval - instance-url
type: string type: string
x-enum-varnames: x-enum-varnames:
- SystemSettingServerIDName - SystemSettingServerIDName
...@@ -518,8 +716,8 @@ definitions: ...@@ -518,8 +716,8 @@ definitions:
- SystemSettingLocalStoragePathName - SystemSettingLocalStoragePathName
- SystemSettingTelegramBotTokenName - SystemSettingTelegramBotTokenName
- SystemSettingMemoDisplayWithUpdatedTsName - SystemSettingMemoDisplayWithUpdatedTsName
- SystemSettingAutoBackupIntervalName - SystemSettingInstanceURLName
v1.SystemStatus: github_com_usememos_memos_api_v1.SystemStatus:
properties: properties:
additionalScript: additionalScript:
description: Additional script. description: Additional script.
...@@ -532,12 +730,9 @@ definitions: ...@@ -532,12 +730,9 @@ definitions:
System settings System settings
Allow sign up. Allow sign up.
type: boolean type: boolean
autoBackupInterval:
description: Auto Backup Interval.
type: integer
customizedProfile: customizedProfile:
allOf: allOf:
- $ref: '#/definitions/v1.CustomizedProfile' - $ref: '#/definitions/github_com_usememos_memos_api_v1.CustomizedProfile'
description: Customized server profile, including server name and external description: Customized server profile, including server name and external
url. url.
dbSize: dbSize:
...@@ -549,7 +744,7 @@ definitions: ...@@ -549,7 +744,7 @@ definitions:
description: Disable public memos. description: Disable public memos.
type: boolean type: boolean
host: host:
$ref: '#/definitions/v1.User' $ref: '#/definitions/github_com_usememos_memos_api_v1.User'
localStoragePath: localStoragePath:
description: Local storage path. description: Local storage path.
type: string type: string
...@@ -565,32 +760,32 @@ definitions: ...@@ -565,32 +760,32 @@ definitions:
description: Storage service ID. description: Storage service ID.
type: integer type: integer
type: object type: object
v1.UpdateIdentityProviderRequest: github_com_usememos_memos_api_v1.UpdateIdentityProviderRequest:
properties: properties:
config: config:
$ref: '#/definitions/v1.IdentityProviderConfig' $ref: '#/definitions/github_com_usememos_memos_api_v1.IdentityProviderConfig'
identifierFilter: identifierFilter:
type: string type: string
name: name:
type: string type: string
type: type:
$ref: '#/definitions/v1.IdentityProviderType' $ref: '#/definitions/github_com_usememos_memos_api_v1.IdentityProviderType'
type: object type: object
v1.UpdateResourceRequest: github_com_usememos_memos_api_v1.UpdateResourceRequest:
properties: properties:
filename: filename:
type: string type: string
type: object type: object
v1.UpdateStorageRequest: github_com_usememos_memos_api_v1.UpdateStorageRequest:
properties: properties:
config: config:
$ref: '#/definitions/v1.StorageConfig' $ref: '#/definitions/github_com_usememos_memos_api_v1.StorageConfig'
name: name:
type: string type: string
type: type:
$ref: '#/definitions/v1.StorageType' $ref: '#/definitions/github_com_usememos_memos_api_v1.StorageType'
type: object type: object
v1.UpdateUserRequest: github_com_usememos_memos_api_v1.UpdateUserRequest:
properties: properties:
avatarUrl: avatarUrl:
type: string type: string
...@@ -601,44 +796,37 @@ definitions: ...@@ -601,44 +796,37 @@ definitions:
password: password:
type: string type: string
rowStatus: rowStatus:
$ref: '#/definitions/v1.RowStatus' $ref: '#/definitions/github_com_usememos_memos_api_v1.RowStatus'
username: username:
type: string type: string
type: object type: object
v1.UpsertMemoOrganizerRequest: github_com_usememos_memos_api_v1.UpsertMemoOrganizerRequest:
properties: properties:
pinned: pinned:
type: boolean type: boolean
type: object type: object
v1.UpsertMemoRelationRequest: github_com_usememos_memos_api_v1.UpsertMemoRelationRequest:
properties: properties:
relatedMemoId: relatedMemoId:
type: integer type: integer
type: type:
$ref: '#/definitions/v1.MemoRelationType' $ref: '#/definitions/github_com_usememos_memos_api_v1.MemoRelationType'
type: object type: object
v1.UpsertSystemSettingRequest: github_com_usememos_memos_api_v1.UpsertSystemSettingRequest:
properties: properties:
description: description:
type: string type: string
name: name:
$ref: '#/definitions/v1.SystemSettingName' $ref: '#/definitions/github_com_usememos_memos_api_v1.SystemSettingName'
value: value:
type: string type: string
type: object type: object
v1.UpsertTagRequest: github_com_usememos_memos_api_v1.UpsertTagRequest:
properties: properties:
name: name:
type: string type: string
type: object type: object
v1.UpsertUserSettingRequest: github_com_usememos_memos_api_v1.User:
properties:
key:
$ref: '#/definitions/v1.UserSettingKey'
value:
type: string
type: object
v1.User:
properties: properties:
avatarUrl: avatarUrl:
type: string type: string
...@@ -651,43 +839,222 @@ definitions: ...@@ -651,43 +839,222 @@ definitions:
nickname: nickname:
type: string type: string
role: role:
$ref: '#/definitions/v1.Role' $ref: '#/definitions/github_com_usememos_memos_api_v1.Role'
rowStatus: rowStatus:
allOf: allOf:
- $ref: '#/definitions/v1.RowStatus' - $ref: '#/definitions/github_com_usememos_memos_api_v1.RowStatus'
description: Standard fields description: Standard fields
updatedTs: updatedTs:
type: integer type: integer
userSettingList: 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: items:
$ref: '#/definitions/v1.UserSetting' type: string
type: array type: array
username: 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 description: Domain specific fields
type: string 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 type: object
v1.UserSetting: store.MemoRelation:
properties: properties:
key: memoID:
$ref: '#/definitions/v1.UserSettingKey'
userId:
type: integer type: integer
value: 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 type: string
updatedTs:
type: integer
type: object type: object
v1.UserSettingKey: store.Role:
enum:
- HOST
- ADMIN
- USER
type: string
x-enum-varnames:
- RoleHost
- RoleAdmin
- RoleUser
store.RowStatus:
enum: enum:
- locale - NORMAL
- appearance - ARCHIVED
- memo-visibility
- telegram-user-id
type: string type: string
x-enum-varnames: x-enum-varnames:
- UserSettingLocaleKey - Normal
- UserSettingAppearanceKey - Archived
- UserSettingMemoVisibilityKey store.Storage:
- UserSettingTelegramUserIDKey properties:
v1.Visibility: 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: enum:
- PUBLIC - PUBLIC
- PROTECTED - PROTECTED
...@@ -721,7 +1088,7 @@ paths: ...@@ -721,7 +1088,7 @@ paths:
name: body name: body
required: true required: true
schema: schema:
$ref: '#/definitions/v1.SignIn' $ref: '#/definitions/github_com_usememos_memos_api_v1.SignIn'
produces: produces:
- application/json - application/json
responses: responses:
...@@ -753,7 +1120,7 @@ paths: ...@@ -753,7 +1120,7 @@ paths:
name: body name: body
required: true required: true
schema: schema:
$ref: '#/definitions/v1.SSOSignIn' $ref: '#/definitions/github_com_usememos_memos_api_v1.SSOSignIn'
produces: produces:
- application/json - application/json
responses: responses:
...@@ -801,7 +1168,7 @@ paths: ...@@ -801,7 +1168,7 @@ paths:
name: body name: body
required: true required: true
schema: schema:
$ref: '#/definitions/v1.SignUp' $ref: '#/definitions/github_com_usememos_memos_api_v1.SignUp'
produces: produces:
- application/json - application/json
responses: responses:
...@@ -834,7 +1201,7 @@ paths: ...@@ -834,7 +1201,7 @@ paths:
description: List of available identity providers description: List of available identity providers
schema: schema:
items: items:
$ref: '#/definitions/v1.IdentityProvider' $ref: '#/definitions/github_com_usememos_memos_api_v1.IdentityProvider'
type: array type: array
"500": "500":
description: Failed to find identity provider list | Failed to find user description: Failed to find identity provider list | Failed to find user
...@@ -850,7 +1217,7 @@ paths: ...@@ -850,7 +1217,7 @@ paths:
name: body name: body
required: true required: true
schema: schema:
$ref: '#/definitions/v1.CreateIdentityProviderRequest' $ref: '#/definitions/github_com_usememos_memos_api_v1.CreateIdentityProviderRequest'
produces: produces:
- application/json - application/json
responses: responses:
...@@ -935,7 +1302,7 @@ paths: ...@@ -935,7 +1302,7 @@ paths:
name: body name: body
required: true required: true
schema: schema:
$ref: '#/definitions/v1.UpdateIdentityProviderRequest' $ref: '#/definitions/github_com_usememos_memos_api_v1.UpdateIdentityProviderRequest'
produces: produces:
- application/json - application/json
responses: responses:
...@@ -1020,7 +1387,7 @@ paths: ...@@ -1020,7 +1387,7 @@ paths:
name: body name: body
required: true required: true
schema: schema:
$ref: '#/definitions/v1.CreateMemoRequest' $ref: '#/definitions/github_com_usememos_memos_api_v1.CreateMemoRequest'
produces: produces:
- application/json - application/json
responses: responses:
...@@ -1117,7 +1484,7 @@ paths: ...@@ -1117,7 +1484,7 @@ paths:
name: body name: body
required: true required: true
schema: schema:
$ref: '#/definitions/v1.PatchMemoRequest' $ref: '#/definitions/github_com_usememos_memos_api_v1.PatchMemoRequest'
produces: produces:
- application/json - application/json
responses: responses:
...@@ -1154,7 +1521,7 @@ paths: ...@@ -1154,7 +1521,7 @@ paths:
name: body name: body
required: true required: true
schema: schema:
$ref: '#/definitions/v1.UpsertMemoOrganizerRequest' $ref: '#/definitions/github_com_usememos_memos_api_v1.UpsertMemoOrganizerRequest'
produces: produces:
- application/json - application/json
responses: responses:
...@@ -1216,7 +1583,7 @@ paths: ...@@ -1216,7 +1583,7 @@ paths:
name: body name: body
required: true required: true
schema: schema:
$ref: '#/definitions/v1.UpsertMemoRelationRequest' $ref: '#/definitions/api_v1.UpsertMemoRelationRequest'
produces: produces:
- application/json - application/json
responses: responses:
...@@ -1250,7 +1617,7 @@ paths: ...@@ -1250,7 +1617,7 @@ paths:
- description: Type of relation to remove - description: Type of relation to remove
enum: enum:
- REFERENCE - REFERENCE
- ADDITIONAL - COMMENT
in: path in: path
name: relationType name: relationType
required: true required: true
...@@ -1376,7 +1743,7 @@ paths: ...@@ -1376,7 +1743,7 @@ paths:
name: body name: body
required: true required: true
schema: schema:
$ref: '#/definitions/v1.CreateResourceRequest' $ref: '#/definitions/github_com_usememos_memos_api_v1.CreateResourceRequest'
produces: produces:
- application/json - application/json
responses: responses:
...@@ -1434,7 +1801,7 @@ paths: ...@@ -1434,7 +1801,7 @@ paths:
name: patch name: patch
required: true required: true
schema: schema:
$ref: '#/definitions/v1.UpdateResourceRequest' $ref: '#/definitions/github_com_usememos_memos_api_v1.UpdateResourceRequest'
produces: produces:
- application/json - application/json
responses: responses:
...@@ -1489,7 +1856,7 @@ paths: ...@@ -1489,7 +1856,7 @@ paths:
"200": "200":
description: System GetSystemStatus description: System GetSystemStatus
schema: schema:
$ref: '#/definitions/v1.SystemStatus' $ref: '#/definitions/github_com_usememos_memos_api_v1.SystemStatus'
"401": "401":
description: Missing user in session | Unauthorized description: Missing user in session | Unauthorized
"500": "500":
...@@ -1525,7 +1892,7 @@ paths: ...@@ -1525,7 +1892,7 @@ paths:
name: body name: body
required: true required: true
schema: schema:
$ref: '#/definitions/v1.CreateStorageRequest' $ref: '#/definitions/github_com_usememos_memos_api_v1.CreateStorageRequest'
produces: produces:
- application/json - application/json
responses: responses:
...@@ -1580,7 +1947,7 @@ paths: ...@@ -1580,7 +1947,7 @@ paths:
name: patch name: patch
required: true required: true
schema: schema:
$ref: '#/definitions/v1.UpdateStorageRequest' $ref: '#/definitions/github_com_usememos_memos_api_v1.UpdateStorageRequest'
produces: produces:
- application/json - application/json
responses: responses:
...@@ -1608,7 +1975,7 @@ paths: ...@@ -1608,7 +1975,7 @@ paths:
description: System setting list description: System setting list
schema: schema:
items: items:
$ref: '#/definitions/v1.SystemSetting' $ref: '#/definitions/api_v1.SystemSetting'
type: array type: array
"401": "401":
description: Missing user in session | Unauthorized description: Missing user in session | Unauthorized
...@@ -1626,7 +1993,7 @@ paths: ...@@ -1626,7 +1993,7 @@ paths:
name: body name: body
required: true required: true
schema: schema:
$ref: '#/definitions/v1.UpsertSystemSettingRequest' $ref: '#/definitions/api_v1.UpsertSystemSettingRequest'
produces: produces:
- application/json - application/json
responses: responses:
...@@ -1688,7 +2055,7 @@ paths: ...@@ -1688,7 +2055,7 @@ paths:
name: body name: body
required: true required: true
schema: schema:
$ref: '#/definitions/v1.UpsertTagRequest' $ref: '#/definitions/github_com_usememos_memos_api_v1.UpsertTagRequest'
produces: produces:
- application/json - application/json
responses: responses:
...@@ -1715,7 +2082,7 @@ paths: ...@@ -1715,7 +2082,7 @@ paths:
name: body name: body
required: true required: true
schema: schema:
$ref: '#/definitions/v1.DeleteTagRequest' $ref: '#/definitions/github_com_usememos_memos_api_v1.DeleteTagRequest'
produces: produces:
- application/json - application/json
responses: responses:
...@@ -1775,7 +2142,7 @@ paths: ...@@ -1775,7 +2142,7 @@ paths:
name: body name: body
required: true required: true
schema: schema:
$ref: '#/definitions/v1.CreateUserRequest' $ref: '#/definitions/github_com_usememos_memos_api_v1.CreateUserRequest'
produces: produces:
- application/json - application/json
responses: responses:
...@@ -1857,7 +2224,7 @@ paths: ...@@ -1857,7 +2224,7 @@ paths:
name: patch name: patch
required: true required: true
schema: schema:
$ref: '#/definitions/v1.UpdateUserRequest' $ref: '#/definitions/github_com_usememos_memos_api_v1.UpdateUserRequest'
produces: produces:
- application/json - application/json
responses: responses:
...@@ -1916,34 +2283,6 @@ paths: ...@@ -1916,34 +2283,6 @@ paths:
summary: Get user by username summary: Get user by username
tags: tags:
- user - user
/api/v1/user/setting:
post:
consumes:
- application/json
parameters:
- description: Request object.
in: body
name: body
required: true
schema:
$ref: '#/definitions/v1.UpsertUserSettingRequest'
produces:
- application/json
responses:
"200":
description: Created user setting
schema:
$ref: '#/definitions/github_com_usememos_memos_store.UserSetting'
"400":
description: Malformatted post user setting upsert request | Invalid user
setting format
"401":
description: Missing auth session
"500":
description: Failed to upsert user setting
summary: Upsert user setting
tags:
- user-setting
/explore/rss.xml: /explore/rss.xml:
get: get:
produces: produces:
...@@ -1977,38 +2316,7 @@ paths: ...@@ -1977,38 +2316,7 @@ paths:
description: Failed to write GetImage blob description: Failed to write GetImage blob
summary: Get GetImage from URL summary: Get GetImage from URL
tags: tags:
- get - image-url
/o/r/{resourceId}:
get:
description: '*Swagger UI may have problems displaying other file types than
images'
parameters:
- description: Resource ID
in: path
name: resourceId
required: true
type: integer
- description: Thumbnail
in: query
name: thumbnail
type: integer
produces:
- application/octet-stream
responses:
"200":
description: Requested resource
"400":
description: 'ID is not a number: %s | Failed to get resource visibility'
"401":
description: Resource visibility not match
"404":
description: 'Resource not found: %d'
"500":
description: 'Failed to find resource by ID: %v | Failed to open the local
resource: %s | Failed to read the local resource: %s'
summary: Stream a resource
tags:
- resource
/u/{id}/rss.xml: /u/{id}/rss.xml:
get: get:
parameters: parameters:
......
docs/api/v1.md
View file @ af68cae6
...@@ -6,7 +6,7 @@ A privacy-first, lightweight note-taking service. ...@@ -6,7 +6,7 @@ A privacy-first, lightweight note-taking service.
**Contact information:** **Contact information:**
API Support API Support
<https://github.com/orgs/usememos/discussions> https://github.com/orgs/usememos/discussions
**License:** [MIT License](https://github.com/usememos/memos/blob/main/LICENSE) **License:** [MIT License](https://github.com/usememos/memos/blob/main/LICENSE)
...@@ -25,8 +25,8 @@ Sign-in to memos. ...@@ -25,8 +25,8 @@ Sign-in to memos.
##### Parameters ##### Parameters
| Name | Located in | Description | Required | Schema | | Name | Located in | Description | Required | Schema |
| ---- | ---------- | -------------- | -------- | ---------------------- | | ---- | ---------- | -------------- | -------- | ---------------------------------------------------------------------------------- |
| body | body | Sign-in object | Yes | [v1.SignIn](#v1signin) | | body | body | Sign-in object | Yes | [github_com_usememos_memos_api_v1.SignIn](#github_com_usememos_memos_api_v1signin) |
##### Responses ##### Responses
...@@ -49,8 +49,8 @@ Sign-in to memos using SSO. ...@@ -49,8 +49,8 @@ Sign-in to memos using SSO.
##### Parameters ##### Parameters
| Name | Located in | Description | Required | Schema | | Name | Located in | Description | Required | Schema |
| ---- | ---------- | ------------------ | -------- | ---------------------------- | | ---- | ---------- | ------------------ | -------- | ---------------------------------------------------------------------------------------- |
| body | body | SSO sign-in object | Yes | [v1.SSOSignIn](#v1ssosignin) | | body | body | SSO sign-in object | Yes | [github_com_usememos_memos_api_v1.SSOSignIn](#github_com_usememos_memos_api_v1ssosignin) |
##### Responses ##### Responses
...@@ -88,8 +88,8 @@ Sign-up to memos. ...@@ -88,8 +88,8 @@ Sign-up to memos.
##### Parameters ##### Parameters
| Name | Located in | Description | Required | Schema | | Name | Located in | Description | Required | Schema |
| ---- | ---------- | -------------- | -------- | ---------------------- | | ---- | ---------- | -------------- | -------- | ---------------------------------------------------------------------------------- |
| body | body | Sign-up object | Yes | [v1.SignUp](#v1signup) | | body | body | Sign-up object | Yes | [github_com_usememos_memos_api_v1.SignUp](#github_com_usememos_memos_api_v1signup) |
##### Responses ##### Responses
...@@ -119,8 +119,8 @@ Get a list of identity providers ...@@ -119,8 +119,8 @@ Get a list of identity providers
##### Responses ##### Responses
| Code | Description | Schema | | Code | Description | Schema |
| ---- | ------------------------------------------------------------ | ---------------------------------------------- | | ---- | ------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------- |
| 200 | List of available identity providers | [ [v1.IdentityProvider](#v1identityprovider) ] | | 200 | List of available identity providers | [ [github_com_usememos_memos_api_v1.IdentityProvider](#github_com_usememos_memos_api_v1identityprovider) ] |
| 500 | Failed to find identity provider list \| Failed to find user | | | 500 | Failed to find identity provider list \| Failed to find user | |
#### POST #### POST
...@@ -132,8 +132,8 @@ Create Identity Provider ...@@ -132,8 +132,8 @@ Create Identity Provider
##### Parameters ##### Parameters
| Name | Located in | Description | Required | Schema | | Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------------------------- | -------- | -------------------------------------------------------------------- | | ---- | ---------- | ----------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------- |
| body | body | Identity provider information | Yes | [v1.CreateIdentityProviderRequest](#v1createidentityproviderrequest) | | body | body | Identity provider information | Yes | [github_com_usememos_memos_api_v1.CreateIdentityProviderRequest](#github_com_usememos_memos_api_v1createidentityproviderrequest) |
##### Responses ##### Responses
...@@ -198,9 +198,9 @@ Update an identity provider by ID ...@@ -198,9 +198,9 @@ Update an identity provider by ID
##### Parameters ##### Parameters
| Name | Located in | Description | Required | Schema | | Name | Located in | Description | Required | Schema |
| ----- | ---------- | ------------------------------------- | -------- | -------------------------------------------------------------------- | | ----- | ---------- | ------------------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------- |
| idpId | path | Identity Provider ID | Yes | integer | | idpId | path | Identity Provider ID | Yes | integer |
| body | body | Patched identity provider information | Yes | [v1.UpdateIdentityProviderRequest](#v1updateidentityproviderrequest) | | body | body | Patched identity provider information | Yes | [github_com_usememos_memos_api_v1.UpdateIdentityProviderRequest](#github_com_usememos_memos_api_v1updateidentityproviderrequest) |
##### Responses ##### Responses
...@@ -256,8 +256,8 @@ Visibility can be PUBLIC, PROTECTED or PRIVATE ...@@ -256,8 +256,8 @@ Visibility can be PUBLIC, PROTECTED or PRIVATE
##### Parameters ##### Parameters
| Name | Located in | Description | Required | Schema | | Name | Located in | Description | Required | Schema |
| ---- | ---------- | --------------- | -------- | -------------------------------------------- | | ---- | ---------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------- |
| body | body | Request object. | Yes | [v1.CreateMemoRequest](#v1creatememorequest) | | body | body | Request object. | Yes | [github_com_usememos_memos_api_v1.CreateMemoRequest](#github_com_usememos_memos_api_v1creatememorequest) |
##### Responses ##### Responses
...@@ -330,9 +330,9 @@ Visibility can be PUBLIC, PROTECTED or PRIVATE ...@@ -330,9 +330,9 @@ Visibility can be PUBLIC, PROTECTED or PRIVATE
##### Parameters ##### Parameters
| Name | Located in | Description | Required | Schema | | Name | Located in | Description | Required | Schema |
| ------ | ---------- | -------------------- | -------- | ------------------------------------------ | | ------ | ---------- | -------------------- | -------- | ------------------------------------------------------------------------------------------------------ |
| memoId | path | ID of memo to update | Yes | integer | | memoId | path | ID of memo to update | Yes | integer |
| body | body | Patched object. | Yes | [v1.PatchMemoRequest](#v1patchmemorequest) | | body | body | Patched object. | Yes | [github_com_usememos_memos_api_v1.PatchMemoRequest](#github_com_usememos_memos_api_v1patchmemorequest) |
##### Responses ##### Responses
...@@ -411,9 +411,9 @@ Organize memo (pin/unpin) ...@@ -411,9 +411,9 @@ Organize memo (pin/unpin)
##### Parameters ##### Parameters
| Name | Located in | Description | Required | Schema | | Name | Located in | Description | Required | Schema |
| ------ | ---------- | ---------------------- | -------- | -------------------------------------------------------------- | | ------ | ---------- | ---------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------- |
| memoId | path | ID of memo to organize | Yes | integer | | memoId | path | ID of memo to organize | Yes | integer |
| body | body | Memo organizer object | Yes | [v1.UpsertMemoOrganizerRequest](#v1upsertmemoorganizerrequest) | | body | body | Memo organizer object | Yes | [github_com_usememos_memos_api_v1.UpsertMemoOrganizerRequest](#github_com_usememos_memos_api_v1upsertmemoorganizerrequest) |
##### Responses ##### Responses
...@@ -462,9 +462,9 @@ Create a relation between two memos ...@@ -462,9 +462,9 @@ Create a relation between two memos
##### Parameters ##### Parameters
| Name | Located in | Description | Required | Schema | | Name | Located in | Description | Required | Schema |
| ------ | ---------- | -------------------- | -------- | ------------------------------------------------------------ | | ------ | ---------- | -------------------- | -------- | -------------------------------------------------------------------- |
| memoId | path | ID of memo to relate | Yes | integer | | memoId | path | ID of memo to relate | Yes | integer |
| body | body | Memo relation object | Yes | [v1.UpsertMemoRelationRequest](#v1upsertmemorelationrequest) | | body | body | Memo relation object | Yes | [api_v1.UpsertMemoRelationRequest](#api_v1upsertmemorelationrequest) |
##### Responses ##### Responses
...@@ -529,8 +529,8 @@ Get system GetSystemStatus ...@@ -529,8 +529,8 @@ Get system GetSystemStatus
##### Responses ##### Responses
| Code | Description | Schema | | Code | Description | Schema |
| ---- | ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- | | ---- | ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| 200 | System GetSystemStatus | [v1.SystemStatus](#v1systemstatus) | | 200 | System GetSystemStatus | [github_com_usememos_memos_api_v1.SystemStatus](#github_com_usememos_memos_api_v1systemstatus) |
| 401 | Missing user in session \| Unauthorized | | | 401 | Missing user in session \| Unauthorized | |
| 500 | Failed to find host user \| Failed to find system setting list \| Failed to unmarshal system setting customized profile value | | | 500 | Failed to find host user \| Failed to find system setting list \| Failed to unmarshal system setting customized profile value | |
...@@ -584,8 +584,8 @@ Create resource ...@@ -584,8 +584,8 @@ Create resource
##### Parameters ##### Parameters
| Name | Located in | Description | Required | Schema | | Name | Located in | Description | Required | Schema |
| ---- | ---------- | --------------- | -------- | ---------------------------------------------------- | | ---- | ---------- | --------------- | -------- | ---------------------------------------------------------------------------------------------------------------- |
| body | body | Request object. | Yes | [v1.CreateResourceRequest](#v1createresourcerequest) | | body | body | Request object. | Yes | [github_com_usememos_memos_api_v1.CreateResourceRequest](#github_com_usememos_memos_api_v1createresourcerequest) |
##### Responses ##### Responses
...@@ -629,9 +629,9 @@ Update a resource ...@@ -629,9 +629,9 @@ Update a resource
##### Parameters ##### Parameters
| Name | Located in | Description | Required | Schema | | Name | Located in | Description | Required | Schema |
| ---------- | ---------- | ---------------------- | -------- | ---------------------------------------------------- | | ---------- | ---------- | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------- |
| resourceId | path | Resource ID | Yes | integer | | resourceId | path | Resource ID | Yes | integer |
| patch | body | Patch resource request | Yes | [v1.UpdateResourceRequest](#v1updateresourcerequest) | | patch | body | Patch resource request | Yes | [github_com_usememos_memos_api_v1.UpdateResourceRequest](#github_com_usememos_memos_api_v1updateresourcerequest) |
##### Responses ##### Responses
...@@ -666,35 +666,6 @@ Upload resource ...@@ -666,35 +666,6 @@ Upload resource
| 401 | Missing user in session | | | 401 | Missing user in session | |
| 500 | Failed to get uploading file \| Failed to open file \| Failed to save resource \| Failed to create resource \| Failed to create activity | | | 500 | Failed to get uploading file \| Failed to open file \| Failed to save resource \| Failed to create resource \| Failed to create activity | |
### /o/r/{resourceId}
#### GET
##### Summary
Stream a resource
##### Description
\*Swagger UI may have problems displaying other file types than images
##### Parameters
| Name | Located in | Description | Required | Schema |
| ---------- | ---------- | ----------- | -------- | ------- |
| resourceId | path | Resource ID | Yes | integer |
| thumbnail | query | Thumbnail | No | integer |
##### Responses
| Code | Description |
| ---- | ------------------------------------------------------------------------------------------------------------------- |
| 200 | Requested resource |
| 400 | ID is not a number: %s \| Failed to get resource visibility |
| 401 | Resource visibility not match |
| 404 | Resource not found: %d |
| 500 | Failed to find resource by ID: %v \| Failed to open the local resource: %s \| Failed to read the local resource: %s |
--- ---
### /api/v1/storage ### /api/v1/storage
...@@ -722,8 +693,8 @@ Create storage ...@@ -722,8 +693,8 @@ Create storage
##### Parameters ##### Parameters
| Name | Located in | Description | Required | Schema | | Name | Located in | Description | Required | Schema |
| ---- | ---------- | --------------- | -------- | -------------------------------------------------- | | ---- | ---------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------- |
| body | body | Request object. | Yes | [v1.CreateStorageRequest](#v1createstoragerequest) | | body | body | Request object. | Yes | [github_com_usememos_memos_api_v1.CreateStorageRequest](#github_com_usememos_memos_api_v1createstoragerequest) |
##### Responses ##### Responses
...@@ -766,9 +737,9 @@ Update a storage ...@@ -766,9 +737,9 @@ Update a storage
##### Parameters ##### Parameters
| Name | Located in | Description | Required | Schema | | Name | Located in | Description | Required | Schema |
| --------- | ---------- | ------------- | -------- | -------------------------------------------------- | | --------- | ---------- | ------------- | -------- | -------------------------------------------------------------------------------------------------------------- |
| storageId | path | Storage ID | Yes | integer | | storageId | path | Storage ID | Yes | integer |
| patch | body | Patch request | Yes | [v1.UpdateStorageRequest](#v1updatestoragerequest) | | patch | body | Patch request | Yes | [github_com_usememos_memos_api_v1.UpdateStorageRequest](#github_com_usememos_memos_api_v1updatestoragerequest) |
##### Responses ##### Responses
...@@ -792,8 +763,8 @@ Get a list of system settings ...@@ -792,8 +763,8 @@ Get a list of system settings
##### Responses ##### Responses
| Code | Description | Schema | | Code | Description | Schema |
| ---- | --------------------------------------------------------- | ---------------------------------------- | | ---- | --------------------------------------------------------- | ------------------------------------------------ |
| 200 | System setting list | [ [v1.SystemSetting](#v1systemsetting) ] | | 200 | System setting list | [ [api_v1.SystemSetting](#api_v1systemsetting) ] |
| 401 | Missing user in session \| Unauthorized | | | 401 | Missing user in session \| Unauthorized | |
| 500 | Failed to find user \| Failed to find system setting list | | | 500 | Failed to find user \| Failed to find system setting list | |
...@@ -806,8 +777,8 @@ Create system setting ...@@ -806,8 +777,8 @@ Create system setting
##### Parameters ##### Parameters
| Name | Located in | Description | Required | Schema | | Name | Located in | Description | Required | Schema |
| ---- | ---------- | --------------- | -------- | -------------------------------------------------------------- | | ---- | ---------- | --------------- | -------- | ---------------------------------------------------------------------- |
| body | body | Request object. | Yes | [v1.UpsertSystemSettingRequest](#v1upsertsystemsettingrequest) | | body | body | Request object. | Yes | [api_v1.UpsertSystemSettingRequest](#api_v1upsertsystemsettingrequest) |
##### Responses ##### Responses
...@@ -846,8 +817,8 @@ Create a tag ...@@ -846,8 +817,8 @@ Create a tag
##### Parameters ##### Parameters
| Name | Located in | Description | Required | Schema | | Name | Located in | Description | Required | Schema |
| ---- | ---------- | --------------- | -------- | ------------------------------------------ | | ---- | ---------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------ |
| body | body | Request object. | Yes | [v1.UpsertTagRequest](#v1upserttagrequest) | | body | body | Request object. | Yes | [github_com_usememos_memos_api_v1.UpsertTagRequest](#github_com_usememos_memos_api_v1upserttagrequest) |
##### Responses ##### Responses
...@@ -869,8 +840,8 @@ Delete a tag ...@@ -869,8 +840,8 @@ Delete a tag
##### Parameters ##### Parameters
| Name | Located in | Description | Required | Schema | | Name | Located in | Description | Required | Schema |
| ---- | ---------- | --------------- | -------- | ------------------------------------------ | | ---- | ---------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------ |
| body | body | Request object. | Yes | [v1.DeleteTagRequest](#v1deletetagrequest) | | body | body | Request object. | Yes | [github_com_usememos_memos_api_v1.DeleteTagRequest](#github_com_usememos_memos_api_v1deletetagrequest) |
##### Responses ##### Responses
...@@ -923,8 +894,8 @@ Create a user ...@@ -923,8 +894,8 @@ Create a user
##### Parameters ##### Parameters
| Name | Located in | Description | Required | Schema | | Name | Located in | Description | Required | Schema |
| ---- | ---------- | -------------- | -------- | -------------------------------------------- | | ---- | ---------- | -------------- | -------- | -------------------------------------------------------------------------------------------------------- |
| body | body | Request object | Yes | [v1.CreateUserRequest](#v1createuserrequest) | | body | body | Request object | Yes | [github_com_usememos_memos_api_v1.CreateUserRequest](#github_com_usememos_memos_api_v1createuserrequest) |
##### Responses ##### Responses
...@@ -990,9 +961,9 @@ Update a user ...@@ -990,9 +961,9 @@ Update a user
##### Parameters ##### Parameters
| Name | Located in | Description | Required | Schema | | Name | Located in | Description | Required | Schema |
| ----- | ---------- | ------------- | -------- | -------------------------------------------- | | ----- | ---------- | ------------- | -------- | -------------------------------------------------------------------------------------------------------- |
| id | path | User ID | Yes | string | | id | path | User ID | Yes | string |
| patch | body | Patch request | Yes | [v1.UpdateUserRequest](#v1updateuserrequest) | | patch | body | Patch request | Yes | [github_com_usememos_memos_api_v1.UpdateUserRequest](#github_com_usememos_memos_api_v1updateuserrequest) |
##### Responses ##### Responses
...@@ -1044,31 +1015,6 @@ Get user by username ...@@ -1044,31 +1015,6 @@ Get user by username
--- ---
### /api/v1/user/setting
#### POST
##### Summary
Upsert user setting
##### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | --------------- | -------- | ---------------------------------------------------------- |
| body | body | Request object. | Yes | [v1.UpsertUserSettingRequest](#v1upsertusersettingrequest) |
##### Responses
| Code | Description | Schema |
| ---- | ---------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ |
| 200 | Created user setting | [github_com_usememos_memos_store.UserSetting](#github_com_usememos_memos_storeusersetting) |
| 400 | Malformatted post user setting upsert request \| Invalid user setting format | |
| 401 | Missing auth session | |
| 500 | Failed to upsert user setting | |
---
### /explore/rss.xml ### /explore/rss.xml
#### GET #### GET
...@@ -1134,24 +1080,69 @@ Get GetImage from URL ...@@ -1134,24 +1080,69 @@ Get GetImage from URL
### Models ### Models
#### github_com_usememos_memos_store.UserSetting #### api_v1.CreateIdentityProviderRequest
| Name | Type | Description | Required | | Name | Type | Description | Required |
| ------ | ------- | ----------- | -------- | | ---------------- | -------------------------------------------------------------- | ----------- | -------- |
| key | string | | No | | config | [api_v1.IdentityProviderConfig](#api_v1identityproviderconfig) | | No |
| userID | integer | | No | | identifierFilter | string | | No |
| value | string | | No | | name | string | | No |
| type | [api_v1.IdentityProviderType](#api_v1identityprovidertype) | | No |
#### profile.Profile #### api_v1.CreateMemoRequest
| Name | Type | Description | Required | | Name | Type | Description | Required |
| ------- | ------ | --------------------------------------------- | -------- | | -------------- | ------------------------------------------------------------------------ | ---------------------- | -------- |
| driver | string | Driver is the database driver sqlite, mysql | No | | content | string | | No |
| dsn | string | DSN points to where Memos stores its own data | No | | createdTs | integer | | No |
| mode | string | Mode can be "prod" or "dev" or "demo" | No | | relationList | [ [api_v1.UpsertMemoRelationRequest](#api_v1upsertmemorelationrequest) ] | | No |
| version | string | Version is the current version of server | No | | resourceIdList | [ integer ] | Related fields | No |
| visibility | [api_v1.Visibility](#api_v1visibility) | Domain specific fields | No |
#### store.FieldMapping #### api_v1.CreateResourceRequest
| Name | Type | Description | Required |
| ------------ | ------ | ----------- | -------- |
| externalLink | string | | No |
| filename | string | | No |
| type | string | | No |
#### api_v1.CreateStorageRequest
| Name | Type | Description | Required |
| ------ | -------------------------------------------- | ----------- | -------- |
| config | [api_v1.StorageConfig](#api_v1storageconfig) | | No |
| name | string | | No |
| type | [api_v1.StorageType](#api_v1storagetype) | | No |
#### api_v1.CreateUserRequest
| Name | Type | Description | Required |
| -------- | -------------------------- | ----------- | -------- |
| email | string | | No |
| nickname | string | | No |
| password | string | | No |
| role | [api_v1.Role](#api_v1role) | | No |
| username | string | | No |
#### api_v1.CustomizedProfile
| Name | Type | Description | Required |
| ----------- | ------ | --------------------------------------------------------------------- | -------- |
| appearance | string | Appearance is the server default appearance. | No |
| description | string | Description is the server description. | No |
| externalUrl | string | ExternalURL is the external url of server. e.g. https://usermemos.com | No |
| locale | string | Locale is the server default locale. | No |
| logoUrl | string | LogoURL is the url of logo image. | No |
| name | string | Name is the server name, default is `memos` | No |
#### api_v1.DeleteTagRequest
| Name | Type | Description | Required |
| ---- | ------ | ----------- | -------- |
| name | string | | No |
#### api_v1.FieldMapping
| Name | Type | Description | Required | | Name | Type | Description | Required |
| ----------- | ------ | ----------- | -------- | | ----------- | ------ | ----------- | -------- |
...@@ -1159,156 +1150,251 @@ Get GetImage from URL ...@@ -1159,156 +1150,251 @@ Get GetImage from URL
| email | string | | No | | email | string | | No |
| identifier | string | | No | | identifier | string | | No |
#### store.IdentityProvider #### api_v1.IdentityProvider
| Name | Type | Description | Required | | Name | Type | Description | Required |
| ---------------- | ------------------------------------------------------------ | ----------- | -------- | | ---------------- | -------------------------------------------------------------- | ----------- | -------- |
| config | [store.IdentityProviderConfig](#storeidentityproviderconfig) | | No | | config | [api_v1.IdentityProviderConfig](#api_v1identityproviderconfig) | | No |
| id | integer | | No | | id | integer | | No |
| identifierFilter | string | | No | | identifierFilter | string | | No |
| name | string | | No | | name | string | | No |
| type | [store.IdentityProviderType](#storeidentityprovidertype) | | No | | type | [api_v1.IdentityProviderType](#api_v1identityprovidertype) | | No |
#### store.IdentityProviderConfig #### api_v1.IdentityProviderConfig
| Name | Type | Description | Required | | Name | Type | Description | Required |
| ------------ | ------------------------------------------------------------------------ | ----------- | -------- | | ------------ | -------------------------------------------------------------------------- | ----------- | -------- |
| oauth2Config | [store.IdentityProviderOAuth2Config](#storeidentityprovideroauth2config) | | No | | oauth2Config | [api_v1.IdentityProviderOAuth2Config](#api_v1identityprovideroauth2config) | | No |
#### store.IdentityProviderOAuth2Config #### api_v1.IdentityProviderOAuth2Config
| Name | Type | Description | Required | | Name | Type | Description | Required |
| ------------ | ---------------------------------------- | ----------- | -------- | | ------------ | ------------------------------------------ | ----------- | -------- |
| authUrl | string | | No | | authUrl | string | | No |
| clientId | string | | No | | clientId | string | | No |
| clientSecret | string | | No | | clientSecret | string | | No |
| fieldMapping | [store.FieldMapping](#storefieldmapping) | | No | | fieldMapping | [api_v1.FieldMapping](#api_v1fieldmapping) | | No |
| scopes | [ string ] | | No | | scopes | [ string ] | | No |
| tokenUrl | string | | No | | tokenUrl | string | | No |
| userInfoUrl | string | | No | | userInfoUrl | string | | No |
#### store.IdentityProviderType #### api_v1.IdentityProviderType
| Name | Type | Description | Required | | Name | Type | Description | Required |
| -------------------------- | ------ | ----------- | -------- | | --------------------------- | ------ | ----------- | -------- |
| store.IdentityProviderType | string | | | | api_v1.IdentityProviderType | string | | |
#### store.Memo #### api_v1.MemoRelationType
| Name | Type | Description | Required | | Name | Type | Description | Required |
| -------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------- | | ----------------------- | ------ | ----------- | -------- |
| api_v1.MemoRelationType | string | | |
#### api_v1.PatchMemoRequest
| Name | Type | Description | Required |
| -------------- | ------------------------------------------------------------------------ | ---------------------- | -------- |
| content | string | Domain specific fields | No | | content | string | Domain specific fields | No |
| createdTs | integer | | No | | createdTs | integer | Standard fields | No |
| creatorID | integer | | No | | relationList | [ [api_v1.UpsertMemoRelationRequest](#api_v1upsertmemorelationrequest) ] | | No |
| id | integer | | No | | resourceIdList | [ integer ] | Related fields | No |
| parentID | integer | Composed fields For those comment memos, the parent ID is the memo ID of the memo being commented. If the parent ID is nil, then this memo is not a comment. | No | | rowStatus | [api_v1.RowStatus](#api_v1rowstatus) | | No |
| pinned | boolean | | No |
| relationList | [ [store.MemoRelation](#storememorelation) ] | | No |
| resourceIDList | [ integer ] | | No |
| rowStatus | [store.RowStatus](#storerowstatus) | Standard fields | No |
| updatedTs | integer | | No | | updatedTs | integer | | No |
| visibility | [store.Visibility](#storevisibility) | | No | | visibility | [api_v1.Visibility](#api_v1visibility) | | No |
#### store.MemoRelation #### api_v1.Role
| Name | Type | Description | Required | | Name | Type | Description | Required |
| ------------- | ------------------------------------------------ | ----------- | -------- | | ----------- | ------ | ----------- | -------- |
| memoID | integer | | No | | api_v1.Role | string | | |
| relatedMemoID | integer | | No |
| type | [store.MemoRelationType](#storememorelationtype) | | No |
#### store.MemoRelationType #### api_v1.RowStatus
| Name | Type | Description | Required | | Name | Type | Description | Required |
| ---------------------- | ------ | ----------- | -------- | | ---------------- | ------ | ----------- | -------- |
| store.MemoRelationType | string | | | | api_v1.RowStatus | string | | |
#### store.Resource #### api_v1.SSOSignIn
| Name | Type | Description | Required | | Name | Type | Description | Required |
| ------------ | ----------- | ---------------------- | -------- | | ------------------ | ------- | ----------- | -------- |
| blob | [ integer ] | | No | | code | string | | No |
| createdTs | integer | | No | | identityProviderId | integer | | No |
| creatorID | integer | Standard fields | No | | redirectUri | string | | No |
| externalLink | string | | No |
| filename | string | Domain specific fields | No |
| id | integer | | No |
| internalPath | string | | No |
| memoID | integer | | No |
| size | integer | | No |
| type | string | | No |
| updatedTs | integer | | No |
#### store.Role #### api_v1.SignIn
| Name | Type | Description | Required | | Name | Type | Description | Required |
| ---------- | ------ | ----------- | -------- | | -------- | ------- | ----------- | -------- |
| store.Role | string | | | | password | string | | No |
| remember | boolean | | No |
| username | string | | No |
#### store.RowStatus #### api_v1.SignUp
| Name | Type | Description | Required | | Name | Type | Description | Required |
| --------------- | ------ | ----------- | -------- | | -------- | ------ | ----------- | -------- |
| store.RowStatus | string | | | | password | string | | No |
| username | string | | No |
#### store.Storage #### api_v1.StorageConfig
| Name | Type | Description | Required | | Name | Type | Description | Required |
| ------ | ------- | ----------- | -------- | | -------- | ------------------------------------------------ | ----------- | -------- |
| config | string | | No | | s3Config | [api_v1.StorageS3Config](#api_v1storages3config) | | No |
| id | integer | | No |
| name | string | | No |
| type | string | | No |
#### store.SystemSetting #### api_v1.StorageS3Config
| Name | Type | Description | Required | | Name | Type | Description | Required |
| ----------- | ------ | ----------- | -------- | | --------- | ------ | ----------- | -------- |
| accessKey | string | | No |
| bucket | string | | No |
| endPoint | string | | No |
| path | string | | No |
| region | string | | No |
| secretKey | string | | No |
| urlPrefix | string | | No |
| urlSuffix | string | | No |
#### api_v1.StorageType
| Name | Type | Description | Required |
| ------------------ | ------ | ----------- | -------- |
| api_v1.StorageType | string | | |
#### api_v1.SystemSetting
| Name | Type | Description | Required |
| ----------- | ---------------------------------------------------- | ---------------------------------------- | -------- |
| description | string | | No | | description | string | | No |
| name | [api_v1.SystemSettingName](#api_v1systemsettingname) | | No |
| value | string | Value is a JSON string with basic value. | No |
#### api_v1.SystemSettingName
| Name | Type | Description | Required |
| ------------------------ | ------ | ----------- | -------- |
| api_v1.SystemSettingName | string | | |
#### api_v1.SystemStatus
| Name | Type | Description | Required |
| ------------------------ | ---------------------------------------------------- | ------------------------------------------------------------------ | -------- |
| additionalScript | string | Additional script. | No |
| additionalStyle | string | Additional style. | No |
| allowSignUp | boolean | System settings Allow sign up. | No |
| customizedProfile | [api_v1.CustomizedProfile](#api_v1customizedprofile) | Customized server profile, including server name and external url. | No |
| dbSize | integer | | No |
| disablePasswordLogin | boolean | Disable password login. | No |
| disablePublicMemos | boolean | Disable public memos. | No |
| host | [api_v1.User](#api_v1user) | | No |
| localStoragePath | string | Local storage path. | No |
| maxUploadSizeMiB | integer | Max upload size. | No |
| memoDisplayWithUpdatedTs | boolean | Memo display with updated timestamp. | No |
| profile | [profile.Profile](#profileprofile) | | No |
| storageServiceId | integer | Storage service ID. | No |
#### api_v1.UpdateIdentityProviderRequest
| Name | Type | Description | Required |
| ---------------- | -------------------------------------------------------------- | ----------- | -------- |
| config | [api_v1.IdentityProviderConfig](#api_v1identityproviderconfig) | | No |
| identifierFilter | string | | No |
| name | string | | No |
| type | [api_v1.IdentityProviderType](#api_v1identityprovidertype) | | No |
#### api_v1.UpdateResourceRequest
| Name | Type | Description | Required |
| -------- | ------ | ----------- | -------- |
| filename | string | | No |
#### api_v1.UpdateStorageRequest
| Name | Type | Description | Required |
| ------ | -------------------------------------------- | ----------- | -------- |
| config | [api_v1.StorageConfig](#api_v1storageconfig) | | No |
| name | string | | No | | name | string | | No |
| type | [api_v1.StorageType](#api_v1storagetype) | | No |
#### api_v1.UpdateUserRequest
| Name | Type | Description | Required |
| --------- | ------------------------------------ | ----------- | -------- |
| avatarUrl | string | | No |
| email | string | | No |
| nickname | string | | No |
| password | string | | No |
| rowStatus | [api_v1.RowStatus](#api_v1rowstatus) | | No |
| username | string | | No |
#### api_v1.UpsertMemoOrganizerRequest
| Name | Type | Description | Required |
| ------ | ------- | ----------- | -------- |
| pinned | boolean | | No |
#### api_v1.UpsertMemoRelationRequest
| Name | Type | Description | Required |
| ------------- | -------------------------------------------------- | ----------- | -------- |
| relatedMemoId | integer | | No |
| type | [api_v1.MemoRelationType](#api_v1memorelationtype) | | No |
#### api_v1.UpsertSystemSettingRequest
| Name | Type | Description | Required |
| ----------- | ---------------------------------------------------- | ----------- | -------- |
| description | string | | No |
| name | [api_v1.SystemSettingName](#api_v1systemsettingname) | | No |
| value | string | | No | | value | string | | No |
#### store.User #### api_v1.UpsertTagRequest
| Name | Type | Description | Required | | Name | Type | Description | Required |
| ------------ | ---------------------------------- | ---------------------- | -------- | | ---- | ------ | ----------- | -------- |
| avatarURL | string | | No | | name | string | | No |
#### api_v1.User
| Name | Type | Description | Required |
| --------- | ------------------------------------ | ---------------------- | -------- |
| avatarUrl | string | | No |
| createdTs | integer | | No | | createdTs | integer | | No |
| email | string | | No | | email | string | | No |
| id | integer | | No | | id | integer | | No |
| nickname | string | | No | | nickname | string | | No |
| passwordHash | string | | No | | role | [api_v1.Role](#api_v1role) | | No |
| role | [store.Role](#storerole) | | No | | rowStatus | [api_v1.RowStatus](#api_v1rowstatus) | Standard fields | No |
| rowStatus | [store.RowStatus](#storerowstatus) | Standard fields | No |
| updatedTs | integer | | No | | updatedTs | integer | | No |
| username | string | Domain specific fields | No | | username | string | Domain specific fields | No |
#### store.Visibility #### api_v1.Visibility
| Name | Type | Description | Required | | Name | Type | Description | Required |
| ---------------- | ------ | ----------- | -------- | | ----------------- | ------ | ----------- | -------- |
| store.Visibility | string | | | | api_v1.Visibility | string | | |
#### v1.CreateIdentityProviderRequest #### github_com_usememos_memos_api_v1.CreateIdentityProviderRequest
| Name | Type | Description | Required | | Name | Type | Description | Required |
| ---------------- | ------------------------------------------------------ | ----------- | -------- | | ---------------- | ------------------------------------------------------------------------------------------------------------------ | ----------- | -------- |
| config | [v1.IdentityProviderConfig](#v1identityproviderconfig) | | No | | config | [github_com_usememos_memos_api_v1.IdentityProviderConfig](#github_com_usememos_memos_api_v1identityproviderconfig) | | No |
| identifierFilter | string | | No | | identifierFilter | string | | No |
| name | string | | No | | name | string | | No |
| type | [v1.IdentityProviderType](#v1identityprovidertype) | | No | | type | [github_com_usememos_memos_api_v1.IdentityProviderType](#github_com_usememos_memos_api_v1identityprovidertype) | | No |
#### v1.CreateMemoRequest #### github_com_usememos_memos_api_v1.CreateMemoRequest
| Name | Type | Description | Required | | Name | Type | Description | Required |
| -------------- | ---------------------------------------------------------------- | ---------------------- | -------- | | -------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------- | -------- |
| content | string | | No | | content | string | | No |
| createdTs | integer | | No | | createdTs | integer | | No |
| relationList | [ [v1.UpsertMemoRelationRequest](#v1upsertmemorelationrequest) ] | | No | | relationList | [ [github_com_usememos_memos_api_v1.UpsertMemoRelationRequest](#github_com_usememos_memos_api_v1upsertmemorelationrequest) ] | | No |
| resourceIdList | [ integer ] | Related fields | No | | resourceIdList | [ integer ] | Related fields | No |
| visibility | [v1.Visibility](#v1visibility) | Domain specific fields | No | | visibility | [github_com_usememos_memos_api_v1.Visibility](#github_com_usememos_memos_api_v1visibility) | Domain specific fields | No |
#### v1.CreateResourceRequest #### github_com_usememos_memos_api_v1.CreateResourceRequest
| Name | Type | Description | Required | | Name | Type | Description | Required |
| ------------ | ------ | ----------- | -------- | | ------------ | ------ | ----------- | -------- |
...@@ -1316,42 +1402,42 @@ Get GetImage from URL ...@@ -1316,42 +1402,42 @@ Get GetImage from URL
| filename | string | | No | | filename | string | | No |
| type | string | | No | | type | string | | No |
#### v1.CreateStorageRequest #### github_com_usememos_memos_api_v1.CreateStorageRequest
| Name | Type | Description | Required | | Name | Type | Description | Required |
| ------ | ------------------------------------ | ----------- | -------- | | ------ | ------------------------------------------------------------------------------------------------ | ----------- | -------- |
| config | [v1.StorageConfig](#v1storageconfig) | | No | | config | [github_com_usememos_memos_api_v1.StorageConfig](#github_com_usememos_memos_api_v1storageconfig) | | No |
| name | string | | No | | name | string | | No |
| type | [v1.StorageType](#v1storagetype) | | No | | type | [github_com_usememos_memos_api_v1.StorageType](#github_com_usememos_memos_api_v1storagetype) | | No |
#### v1.CreateUserRequest #### github_com_usememos_memos_api_v1.CreateUserRequest
| Name | Type | Description | Required | | Name | Type | Description | Required |
| -------- | ------------------ | ----------- | -------- | | -------- | ------------------------------------------------------------------------------ | ----------- | -------- |
| email | string | | No | | email | string | | No |
| nickname | string | | No | | nickname | string | | No |
| password | string | | No | | password | string | | No |
| role | [v1.Role](#v1role) | | No | | role | [github_com_usememos_memos_api_v1.Role](#github_com_usememos_memos_api_v1role) | | No |
| username | string | | No | | username | string | | No |
#### v1.CustomizedProfile #### github_com_usememos_memos_api_v1.CustomizedProfile
| Name | Type | Description | Required | | Name | Type | Description | Required |
| ----------- | ------ | ----------------------------------------------------------------------- | -------- | | ----------- | ------ | --------------------------------------------------------------------- | -------- |
| appearance | string | Appearance is the server default appearance. | No | | appearance | string | Appearance is the server default appearance. | No |
| description | string | Description is the server description. | No | | description | string | Description is the server description. | No |
| externalUrl | string | ExternalURL is the external url of server. e.g. <https://usermemos.com> | No | | externalUrl | string | ExternalURL is the external url of server. e.g. https://usermemos.com | No |
| locale | string | Locale is the server default locale. | No | | locale | string | Locale is the server default locale. | No |
| logoUrl | string | LogoURL is the url of logo image. | No | | logoUrl | string | LogoURL is the url of logo image. | No |
| name | string | Name is the server name, default is `memos` | No | | name | string | Name is the server name, default is `memos` | No |
#### v1.DeleteTagRequest #### github_com_usememos_memos_api_v1.DeleteTagRequest
| Name | Type | Description | Required | | Name | Type | Description | Required |
| ---- | ------ | ----------- | -------- | | ---- | ------ | ----------- | -------- |
| name | string | | No | | name | string | | No |
#### v1.FieldMapping #### github_com_usememos_memos_api_v1.FieldMapping
| Name | Type | Description | Required | | Name | Type | Description | Required |
| ----------- | ------ | ----------- | -------- | | ----------- | ------ | ----------- | -------- |
...@@ -1359,71 +1445,71 @@ Get GetImage from URL ...@@ -1359,71 +1445,71 @@ Get GetImage from URL
| email | string | | No | | email | string | | No |
| identifier | string | | No | | identifier | string | | No |
#### v1.IdentityProvider #### github_com_usememos_memos_api_v1.IdentityProvider
| Name | Type | Description | Required | | Name | Type | Description | Required |
| ---------------- | ------------------------------------------------------ | ----------- | -------- | | ---------------- | ------------------------------------------------------------------------------------------------------------------ | ----------- | -------- |
| config | [v1.IdentityProviderConfig](#v1identityproviderconfig) | | No | | config | [github_com_usememos_memos_api_v1.IdentityProviderConfig](#github_com_usememos_memos_api_v1identityproviderconfig) | | No |
| id | integer | | No | | id | integer | | No |
| identifierFilter | string | | No | | identifierFilter | string | | No |
| name | string | | No | | name | string | | No |
| type | [v1.IdentityProviderType](#v1identityprovidertype) | | No | | type | [github_com_usememos_memos_api_v1.IdentityProviderType](#github_com_usememos_memos_api_v1identityprovidertype) | | No |
#### v1.IdentityProviderConfig #### github_com_usememos_memos_api_v1.IdentityProviderConfig
| Name | Type | Description | Required | | Name | Type | Description | Required |
| ------------ | ------------------------------------------------------------------ | ----------- | -------- | | ------------ | ------------------------------------------------------------------------------------------------------------------------------ | ----------- | -------- |
| oauth2Config | [v1.IdentityProviderOAuth2Config](#v1identityprovideroauth2config) | | No | | oauth2Config | [github_com_usememos_memos_api_v1.IdentityProviderOAuth2Config](#github_com_usememos_memos_api_v1identityprovideroauth2config) | | No |
#### v1.IdentityProviderOAuth2Config #### github_com_usememos_memos_api_v1.IdentityProviderOAuth2Config
| Name | Type | Description | Required | | Name | Type | Description | Required |
| ------------ | ---------------------------------- | ----------- | -------- | | ------------ | ---------------------------------------------------------------------------------------------- | ----------- | -------- |
| authUrl | string | | No | | authUrl | string | | No |
| clientId | string | | No | | clientId | string | | No |
| clientSecret | string | | No | | clientSecret | string | | No |
| fieldMapping | [v1.FieldMapping](#v1fieldmapping) | | No | | fieldMapping | [github_com_usememos_memos_api_v1.FieldMapping](#github_com_usememos_memos_api_v1fieldmapping) | | No |
| scopes | [ string ] | | No | | scopes | [ string ] | | No |
| tokenUrl | string | | No | | tokenUrl | string | | No |
| userInfoUrl | string | | No | | userInfoUrl | string | | No |
#### v1.IdentityProviderType #### github_com_usememos_memos_api_v1.IdentityProviderType
| Name | Type | Description | Required | | Name | Type | Description | Required |
| ----------------------- | ------ | ----------- | -------- | | ----------------------------------------------------- | ------ | ----------- | -------- |
| v1.IdentityProviderType | string | | | | github_com_usememos_memos_api_v1.IdentityProviderType | string | | |
#### v1.MemoRelationType #### github_com_usememos_memos_api_v1.MemoRelationType
| Name | Type | Description | Required | | Name | Type | Description | Required |
| ------------------- | ------ | ----------- | -------- | | ------------------------------------------------- | ------ | ----------- | -------- |
| v1.MemoRelationType | string | | | | github_com_usememos_memos_api_v1.MemoRelationType | string | | |
#### v1.PatchMemoRequest #### github_com_usememos_memos_api_v1.PatchMemoRequest
| Name | Type | Description | Required | | Name | Type | Description | Required |
| -------------- | ---------------------------------------------------------------- | ---------------------- | -------- | | -------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------- | -------- |
| content | string | Domain specific fields | No | | content | string | Domain specific fields | No |
| createdTs | integer | Standard fields | No | | createdTs | integer | Standard fields | No |
| relationList | [ [v1.UpsertMemoRelationRequest](#v1upsertmemorelationrequest) ] | | No | | relationList | [ [github_com_usememos_memos_api_v1.UpsertMemoRelationRequest](#github_com_usememos_memos_api_v1upsertmemorelationrequest) ] | | No |
| resourceIdList | [ integer ] | Related fields | No | | resourceIdList | [ integer ] | Related fields | No |
| rowStatus | [v1.RowStatus](#v1rowstatus) | | No | | rowStatus | [github_com_usememos_memos_api_v1.RowStatus](#github_com_usememos_memos_api_v1rowstatus) | | No |
| updatedTs | integer | | No | | updatedTs | integer | | No |
| visibility | [v1.Visibility](#v1visibility) | | No | | visibility | [github_com_usememos_memos_api_v1.Visibility](#github_com_usememos_memos_api_v1visibility) | | No |
#### v1.Role #### github_com_usememos_memos_api_v1.Role
| Name | Type | Description | Required | | Name | Type | Description | Required |
| ------- | ------ | ----------- | -------- | | ------------------------------------- | ------ | ----------- | -------- |
| v1.Role | string | | | | github_com_usememos_memos_api_v1.Role | string | | |
#### v1.RowStatus #### github_com_usememos_memos_api_v1.RowStatus
| Name | Type | Description | Required | | Name | Type | Description | Required |
| ------------ | ------ | ----------- | -------- | | ------------------------------------------ | ------ | ----------- | -------- |
| v1.RowStatus | string | | | | github_com_usememos_memos_api_v1.RowStatus | string | | |
#### v1.SSOSignIn #### github_com_usememos_memos_api_v1.SSOSignIn
| Name | Type | Description | Required | | Name | Type | Description | Required |
| ------------------ | ------- | ----------- | -------- | | ------------------ | ------- | ----------- | -------- |
...@@ -1431,27 +1517,28 @@ Get GetImage from URL ...@@ -1431,27 +1517,28 @@ Get GetImage from URL
| identityProviderId | integer | | No | | identityProviderId | integer | | No |
| redirectUri | string | | No | | redirectUri | string | | No |
#### v1.SignIn #### github_com_usememos_memos_api_v1.SignIn
| Name | Type | Description | Required | | Name | Type | Description | Required |
| -------- | ------ | ----------- | -------- | | -------- | ------- | ----------- | -------- |
| password | string | | No | | password | string | | No |
| remember | boolean | | No |
| username | string | | No | | username | string | | No |
#### v1.SignUp #### github_com_usememos_memos_api_v1.SignUp
| Name | Type | Description | Required | | Name | Type | Description | Required |
| -------- | ------ | ----------- | -------- | | -------- | ------ | ----------- | -------- |
| password | string | | No | | password | string | | No |
| username | string | | No | | username | string | | No |
#### v1.StorageConfig #### github_com_usememos_memos_api_v1.StorageConfig
| Name | Type | Description | Required | | Name | Type | Description | Required |
| -------- | ---------------------------------------- | ----------- | -------- | | -------- | ---------------------------------------------------------------------------------------------------- | ----------- | -------- |
| s3Config | [v1.StorageS3Config](#v1storages3config) | | No | | s3Config | [github_com_usememos_memos_api_v1.StorageS3Config](#github_com_usememos_memos_api_v1storages3config) | | No |
#### v1.StorageS3Config #### github_com_usememos_memos_api_v1.StorageS3Config
| Name | Type | Description | Required | | Name | Type | Description | Required |
| --------- | ------ | ----------- | -------- | | --------- | ------ | ----------- | -------- |
...@@ -1464,144 +1551,263 @@ Get GetImage from URL ...@@ -1464,144 +1551,263 @@ Get GetImage from URL
| urlPrefix | string | | No | | urlPrefix | string | | No |
| urlSuffix | string | | No | | urlSuffix | string | | No |
#### v1.StorageType #### github_com_usememos_memos_api_v1.StorageType
| Name | Type | Description | Required | | Name | Type | Description | Required |
| -------------- | ------ | ----------- | -------- | | -------------------------------------------- | ------ | ----------- | -------- |
| v1.StorageType | string | | | | github_com_usememos_memos_api_v1.StorageType | string | | |
#### v1.SystemSetting #### github_com_usememos_memos_api_v1.SystemSetting
| Name | Type | Description | Required | | Name | Type | Description | Required |
| ----------- | -------------------------------------------- | ---------------------------------------- | -------- | | ----------- | -------------------------------------------------------------------------------------------------------- | ---------------------------------------- | -------- |
| description | string | | No | | description | string | | No |
| name | [v1.SystemSettingName](#v1systemsettingname) | | No | | name | [github_com_usememos_memos_api_v1.SystemSettingName](#github_com_usememos_memos_api_v1systemsettingname) | | No |
| value | string | Value is a JSON string with basic value. | No | | value | string | Value is a JSON string with basic value. | No |
#### v1.SystemSettingName #### github_com_usememos_memos_api_v1.SystemSettingName
| Name | Type | Description | Required | | Name | Type | Description | Required |
| -------------------- | ------ | ----------- | -------- | | -------------------------------------------------- | ------ | ----------- | -------- |
| v1.SystemSettingName | string | | | | github_com_usememos_memos_api_v1.SystemSettingName | string | | |
#### v1.SystemStatus #### github_com_usememos_memos_api_v1.SystemStatus
| Name | Type | Description | Required | | Name | Type | Description | Required |
| ------------------------ | -------------------------------------------- | ------------------------------------------------------------------ | -------- | | ------------------------ | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ | -------- |
| additionalScript | string | Additional script. | No | | additionalScript | string | Additional script. | No |
| additionalStyle | string | Additional style. | No | | additionalStyle | string | Additional style. | No |
| allowSignUp | boolean | System settings Allow sign up. | No | | allowSignUp | boolean | System settings Allow sign up. | No |
| autoBackupInterval | integer | Auto Backup Interval. | No | | customizedProfile | [github_com_usememos_memos_api_v1.CustomizedProfile](#github_com_usememos_memos_api_v1customizedprofile) | Customized server profile, including server name and external url. | No |
| customizedProfile | [v1.CustomizedProfile](#v1customizedprofile) | Customized server profile, including server name and external url. | No |
| dbSize | integer | | No | | dbSize | integer | | No |
| disablePasswordLogin | boolean | Disable password login. | No | | disablePasswordLogin | boolean | Disable password login. | No |
| disablePublicMemos | boolean | Disable public memos. | No | | disablePublicMemos | boolean | Disable public memos. | No |
| host | [v1.User](#v1user) | | No | | host | [github_com_usememos_memos_api_v1.User](#github_com_usememos_memos_api_v1user) | | No |
| localStoragePath | string | Local storage path. | No | | localStoragePath | string | Local storage path. | No |
| maxUploadSizeMiB | integer | Max upload size. | No | | maxUploadSizeMiB | integer | Max upload size. | No |
| memoDisplayWithUpdatedTs | boolean | Memo display with updated timestamp. | No | | memoDisplayWithUpdatedTs | boolean | Memo display with updated timestamp. | No |
| profile | [profile.Profile](#profileprofile) | | No | | profile | [profile.Profile](#profileprofile) | | No |
| storageServiceId | integer | Storage service ID. | No | | storageServiceId | integer | Storage service ID. | No |
#### v1.UpdateIdentityProviderRequest #### github_com_usememos_memos_api_v1.UpdateIdentityProviderRequest
| Name | Type | Description | Required | | Name | Type | Description | Required |
| ---------------- | ------------------------------------------------------ | ----------- | -------- | | ---------------- | ------------------------------------------------------------------------------------------------------------------ | ----------- | -------- |
| config | [v1.IdentityProviderConfig](#v1identityproviderconfig) | | No | | config | [github_com_usememos_memos_api_v1.IdentityProviderConfig](#github_com_usememos_memos_api_v1identityproviderconfig) | | No |
| identifierFilter | string | | No | | identifierFilter | string | | No |
| name | string | | No | | name | string | | No |
| type | [v1.IdentityProviderType](#v1identityprovidertype) | | No | | type | [github_com_usememos_memos_api_v1.IdentityProviderType](#github_com_usememos_memos_api_v1identityprovidertype) | | No |
#### v1.UpdateResourceRequest #### github_com_usememos_memos_api_v1.UpdateResourceRequest
| Name | Type | Description | Required | | Name | Type | Description | Required |
| -------- | ------ | ----------- | -------- | | -------- | ------ | ----------- | -------- |
| filename | string | | No | | filename | string | | No |
#### v1.UpdateStorageRequest #### github_com_usememos_memos_api_v1.UpdateStorageRequest
| Name | Type | Description | Required | | Name | Type | Description | Required |
| ------ | ------------------------------------ | ----------- | -------- | | ------ | ------------------------------------------------------------------------------------------------ | ----------- | -------- |
| config | [v1.StorageConfig](#v1storageconfig) | | No | | config | [github_com_usememos_memos_api_v1.StorageConfig](#github_com_usememos_memos_api_v1storageconfig) | | No |
| name | string | | No | | name | string | | No |
| type | [v1.StorageType](#v1storagetype) | | No | | type | [github_com_usememos_memos_api_v1.StorageType](#github_com_usememos_memos_api_v1storagetype) | | No |
#### v1.UpdateUserRequest #### github_com_usememos_memos_api_v1.UpdateUserRequest
| Name | Type | Description | Required | | Name | Type | Description | Required |
| --------- | ---------------------------- | ----------- | -------- | | --------- | ---------------------------------------------------------------------------------------- | ----------- | -------- |
| avatarUrl | string | | No | | avatarUrl | string | | No |
| email | string | | No | | email | string | | No |
| nickname | string | | No | | nickname | string | | No |
| password | string | | No | | password | string | | No |
| rowStatus | [v1.RowStatus](#v1rowstatus) | | No | | rowStatus | [github_com_usememos_memos_api_v1.RowStatus](#github_com_usememos_memos_api_v1rowstatus) | | No |
| username | string | | No | | username | string | | No |
#### v1.UpsertMemoOrganizerRequest #### github_com_usememos_memos_api_v1.UpsertMemoOrganizerRequest
| Name | Type | Description | Required | | Name | Type | Description | Required |
| ------ | ------- | ----------- | -------- | | ------ | ------- | ----------- | -------- |
| pinned | boolean | | No | | pinned | boolean | | No |
#### v1.UpsertMemoRelationRequest #### github_com_usememos_memos_api_v1.UpsertMemoRelationRequest
| Name | Type | Description | Required | | Name | Type | Description | Required |
| ------------- | ------------------------------------------ | ----------- | -------- | | ------------- | ------------------------------------------------------------------------------------------------------ | ----------- | -------- |
| relatedMemoId | integer | | No | | relatedMemoId | integer | | No |
| type | [v1.MemoRelationType](#v1memorelationtype) | | No | | type | [github_com_usememos_memos_api_v1.MemoRelationType](#github_com_usememos_memos_api_v1memorelationtype) | | No |
#### v1.UpsertSystemSettingRequest #### github_com_usememos_memos_api_v1.UpsertSystemSettingRequest
| Name | Type | Description | Required | | Name | Type | Description | Required |
| ----------- | -------------------------------------------- | ----------- | -------- | | ----------- | -------------------------------------------------------------------------------------------------------- | ----------- | -------- |
| description | string | | No | | description | string | | No |
| name | [v1.SystemSettingName](#v1systemsettingname) | | No | | name | [github_com_usememos_memos_api_v1.SystemSettingName](#github_com_usememos_memos_api_v1systemsettingname) | | No |
| value | string | | No | | value | string | | No |
#### v1.UpsertTagRequest #### github_com_usememos_memos_api_v1.UpsertTagRequest
| Name | Type | Description | Required | | Name | Type | Description | Required |
| ---- | ------ | ----------- | -------- | | ---- | ------ | ----------- | -------- |
| name | string | | No | | name | string | | No |
#### v1.UpsertUserSettingRequest #### github_com_usememos_memos_api_v1.User
| Name | Type | Description | Required |
| ----- | -------------------------------------- | ----------- | -------- |
| key | [v1.UserSettingKey](#v1usersettingkey) | | No |
| value | string | | No |
#### v1.User
| Name | Type | Description | Required | | Name | Type | Description | Required |
| --------------- | ------------------------------------ | ---------------------- | -------- | | --------- | ---------------------------------------------------------------------------------------- | ---------------------- | -------- |
| avatarUrl | string | | No | | avatarUrl | string | | No |
| createdTs | integer | | No | | createdTs | integer | | No |
| email | string | | No | | email | string | | No |
| id | integer | | No | | id | integer | | No |
| nickname | string | | No | | nickname | string | | No |
| role | [v1.Role](#v1role) | | No | | role | [github_com_usememos_memos_api_v1.Role](#github_com_usememos_memos_api_v1role) | | No |
| rowStatus | [v1.RowStatus](#v1rowstatus) | Standard fields | No | | rowStatus | [github_com_usememos_memos_api_v1.RowStatus](#github_com_usememos_memos_api_v1rowstatus) | Standard fields | No |
| updatedTs | integer | | No | | updatedTs | integer | | No |
| userSettingList | [ [v1.UserSetting](#v1usersetting) ] | | No |
| username | string | Domain specific fields | No | | username | string | Domain specific fields | No |
#### v1.UserSetting #### github_com_usememos_memos_api_v1.Visibility
| Name | Type | Description | Required |
| ------------------------------------------- | ------ | ----------- | -------- |
| github_com_usememos_memos_api_v1.Visibility | string | | |
#### profile.Profile
| Name | Type | Description | Required |
| ------- | ------ | ---------------------------------------- | -------- |
| mode | string | Mode can be "prod" or "dev" or "demo" | No |
| version | string | Version is the current version of server | No |
#### store.FieldMapping
| Name | Type | Description | Required | | Name | Type | Description | Required |
| ------ | -------------------------------------- | ----------- | -------- | | ----------- | ------ | ----------- | -------- |
| key | [v1.UserSettingKey](#v1usersettingkey) | | No | | displayName | string | | No |
| userId | integer | | No | | email | string | | No |
| identifier | string | | No |
#### store.IdentityProvider
| Name | Type | Description | Required |
| ---------------- | ------------------------------------------------------------ | ----------- | -------- |
| config | [store.IdentityProviderConfig](#storeidentityproviderconfig) | | No |
| id | integer | | No |
| identifierFilter | string | | No |
| name | string | | No |
| type | [store.IdentityProviderType](#storeidentityprovidertype) | | No |
#### store.IdentityProviderConfig
| Name | Type | Description | Required |
| ------------ | ------------------------------------------------------------------------ | ----------- | -------- |
| oauth2Config | [store.IdentityProviderOAuth2Config](#storeidentityprovideroauth2config) | | No |
#### store.IdentityProviderOAuth2Config
| Name | Type | Description | Required |
| ------------ | ---------------------------------------- | ----------- | -------- |
| authUrl | string | | No |
| clientId | string | | No |
| clientSecret | string | | No |
| fieldMapping | [store.FieldMapping](#storefieldmapping) | | No |
| scopes | [ string ] | | No |
| tokenUrl | string | | No |
| userInfoUrl | string | | No |
#### store.IdentityProviderType
| Name | Type | Description | Required |
| -------------------------- | ------ | ----------- | -------- |
| store.IdentityProviderType | string | | |
#### store.Memo
| Name | Type | Description | Required |
| ---------- | ------------------------------------ | ---------------------- | -------- |
| content | string | Domain specific fields | No |
| createdTs | integer | | No |
| creatorID | integer | | No |
| id | integer | | No |
| pinned | boolean | Composed fields | No |
| rowStatus | [store.RowStatus](#storerowstatus) | Standard fields | No |
| updatedTs | integer | | No |
| visibility | [store.Visibility](#storevisibility) | | No |
#### store.MemoRelation
| Name | Type | Description | Required |
| ------------- | ------------------------------------------------ | ----------- | -------- |
| memoID | integer | | No |
| relatedMemoID | integer | | No |
| type | [store.MemoRelationType](#storememorelationtype) | | No |
#### store.MemoRelationType
| Name | Type | Description | Required |
| ---------------------- | ------ | ----------- | -------- |
| store.MemoRelationType | string | | |
#### store.Resource
| Name | Type | Description | Required |
| ------------ | ----------- | ---------------------- | -------- |
| blob | [ integer ] | | No |
| createdTs | integer | | No |
| creatorID | integer | Standard fields | No |
| externalLink | string | | No |
| filename | string | Domain specific fields | No |
| id | integer | | No |
| internalPath | string | | No |
| memoID | integer | | No |
| size | integer | | No |
| type | string | | No |
| updatedTs | integer | | No |
#### store.Role
| Name | Type | Description | Required |
| ---------- | ------ | ----------- | -------- |
| store.Role | string | | |
#### store.RowStatus
| Name | Type | Description | Required |
| --------------- | ------ | ----------- | -------- |
| store.RowStatus | string | | |
#### store.Storage
| Name | Type | Description | Required |
| ------ | ------- | ----------- | -------- |
| config | string | | No |
| id | integer | | No |
| name | string | | No |
| type | string | | No |
#### store.SystemSetting
| Name | Type | Description | Required |
| ----------- | ------ | ----------- | -------- |
| description | string | | No |
| name | string | | No |
| value | string | | No | | value | string | | No |
#### v1.UserSettingKey #### store.User
| Name | Type | Description | Required | | Name | Type | Description | Required |
| ----------------- | ------ | ----------- | -------- | | ------------ | ---------------------------------- | ---------------------- | -------- |
| v1.UserSettingKey | string | | | | avatarURL | string | | No |
| createdTs | integer | | No |
| email | string | | No |
| id | integer | | No |
| nickname | string | | No |
| passwordHash | string | | No |
| role | [store.Role](#storerole) | | No |
| rowStatus | [store.RowStatus](#storerowstatus) | Standard fields | No |
| updatedTs | integer | | No |
| username | string | Domain specific fields | No |
#### v1.Visibility #### store.Visibility
| Name | Type | Description | Required | | Name | Type | Description | Required |
| ------------- | ------ | ----------- | -------- | | ---------------- | ------ | ----------- | -------- |
| v1.Visibility | string | | | | store.Visibility | string | | |
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment