Skip to content

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

chore: regenerate swagger docs

parent e0cacfc6
Hide 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 = `{
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.SignIn"
"$ref": "#/definitions/github_com_usememos_memos_api_v1.SignIn"
}
}
],
......@@ -87,7 +87,7 @@ const docTemplate = `{
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.SSOSignIn"
"$ref": "#/definitions/github_com_usememos_memos_api_v1.SSOSignIn"
}
}
],
......@@ -154,7 +154,7 @@ const docTemplate = `{
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.SignUp"
"$ref": "#/definitions/github_com_usememos_memos_api_v1.SignUp"
}
}
],
......@@ -199,7 +199,7 @@ const docTemplate = `{
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.IdentityProvider"
"$ref": "#/definitions/github_com_usememos_memos_api_v1.IdentityProvider"
}
}
},
......@@ -226,7 +226,7 @@ const docTemplate = `{
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.CreateIdentityProviderRequest"
"$ref": "#/definitions/github_com_usememos_memos_api_v1.CreateIdentityProviderRequest"
}
}
],
......@@ -354,7 +354,7 @@ const docTemplate = `{
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.UpdateIdentityProviderRequest"
"$ref": "#/definitions/github_com_usememos_memos_api_v1.UpdateIdentityProviderRequest"
}
}
],
......@@ -477,7 +477,7 @@ const docTemplate = `{
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.CreateMemoRequest"
"$ref": "#/definitions/github_com_usememos_memos_api_v1.CreateMemoRequest"
}
}
],
......@@ -695,7 +695,7 @@ const docTemplate = `{
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.PatchMemoRequest"
"$ref": "#/definitions/github_com_usememos_memos_api_v1.PatchMemoRequest"
}
}
],
......@@ -747,7 +747,7 @@ const docTemplate = `{
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.UpsertMemoOrganizerRequest"
"$ref": "#/definitions/github_com_usememos_memos_api_v1.UpsertMemoOrganizerRequest"
}
}
],
......@@ -838,7 +838,7 @@ const docTemplate = `{
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.UpsertMemoRelationRequest"
"$ref": "#/definitions/api_v1.UpsertMemoRelationRequest"
}
}
],
......@@ -889,7 +889,7 @@ const docTemplate = `{
{
"enum": [
"REFERENCE",
"ADDITIONAL"
"COMMENT"
],
"type": "string",
"description": "Type of relation to remove",
......@@ -992,7 +992,7 @@ const docTemplate = `{
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.CreateResourceRequest"
"$ref": "#/definitions/github_com_usememos_memos_api_v1.CreateResourceRequest"
}
}
],
......@@ -1116,7 +1116,7 @@ const docTemplate = `{
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.UpdateResourceRequest"
"$ref": "#/definitions/github_com_usememos_memos_api_v1.UpdateResourceRequest"
}
}
],
......@@ -1155,7 +1155,7 @@ const docTemplate = `{
"200": {
"description": "System GetSystemStatus",
"schema": {
"$ref": "#/definitions/v1.SystemStatus"
"$ref": "#/definitions/github_com_usememos_memos_api_v1.SystemStatus"
}
},
"401": {
......@@ -1212,7 +1212,7 @@ const docTemplate = `{
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.CreateStorageRequest"
"$ref": "#/definitions/github_com_usememos_memos_api_v1.CreateStorageRequest"
}
}
],
......@@ -1293,7 +1293,7 @@ const docTemplate = `{
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.UpdateStorageRequest"
"$ref": "#/definitions/github_com_usememos_memos_api_v1.UpdateStorageRequest"
}
}
],
......@@ -1331,7 +1331,7 @@ const docTemplate = `{
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.SystemSetting"
"$ref": "#/definitions/api_v1.SystemSetting"
}
}
},
......@@ -1361,7 +1361,7 @@ const docTemplate = `{
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.UpsertSystemSettingRequest"
"$ref": "#/definitions/api_v1.UpsertSystemSettingRequest"
}
}
],
......@@ -1457,7 +1457,7 @@ const docTemplate = `{
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.UpsertTagRequest"
"$ref": "#/definitions/github_com_usememos_memos_api_v1.UpsertTagRequest"
}
}
],
......@@ -1499,7 +1499,7 @@ const docTemplate = `{
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.DeleteTagRequest"
"$ref": "#/definitions/github_com_usememos_memos_api_v1.DeleteTagRequest"
}
}
],
......@@ -1592,7 +1592,7 @@ const docTemplate = `{
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.CreateUserRequest"
"$ref": "#/definitions/github_com_usememos_memos_api_v1.CreateUserRequest"
}
}
],
......@@ -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}": {
"get": {
"produces": [
......@@ -1815,7 +1773,7 @@ const docTemplate = `{
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.UpdateUserRequest"
"$ref": "#/definitions/github_com_usememos_memos_api_v1.UpdateUserRequest"
}
}
],
......@@ -1866,7 +1824,7 @@ const docTemplate = `{
"GetImage/*"
],
"tags": [
"get"
"image-url"
],
"summary": "Get GetImage from URL",
"parameters": [
......@@ -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": {
"get": {
"produces": [
......@@ -1968,42 +1882,141 @@ const docTemplate = `{
}
},
"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",
"properties": {
"key": {
"content": {
"type": "string"
},
"userID": {
"createdTs": {
"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"
}
}
},
"profile.Profile": {
"api_v1.CreateStorageRequest": {
"type": "object",
"properties": {
"driver": {
"description": "Driver is the database driver\nsqlite, mysql",
"config": {
"$ref": "#/definitions/api_v1.StorageConfig"
},
"name": {
"type": "string"
},
"dsn": {
"description": "DSN points to where Memos stores its own data",
"type": {
"$ref": "#/definitions/api_v1.StorageType"
}
}
},
"api_v1.CreateUserRequest": {
"type": "object",
"properties": {
"email": {
"type": "string"
},
"mode": {
"description": "Mode can be \"prod\" or \"dev\" or \"demo\"",
"nickname": {
"type": "string"
},
"version": {
"description": "Version is the current version of server",
"password": {
"type": "string"
},
"role": {
"$ref": "#/definitions/api_v1.Role"
},
"username": {
"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",
"properties": {
"displayName": {
......@@ -2017,11 +2030,11 @@ const docTemplate = `{
}
}
},
"store.IdentityProvider": {
"api_v1.IdentityProvider": {
"type": "object",
"properties": {
"config": {
"$ref": "#/definitions/store.IdentityProviderConfig"
"$ref": "#/definitions/api_v1.IdentityProviderConfig"
},
"id": {
"type": "integer"
......@@ -2033,19 +2046,19 @@ const docTemplate = `{
"type": "string"
},
"type": {
"$ref": "#/definitions/store.IdentityProviderType"
"$ref": "#/definitions/api_v1.IdentityProviderType"
}
}
},
"store.IdentityProviderConfig": {
"api_v1.IdentityProviderConfig": {
"type": "object",
"properties": {
"oauth2Config": {
"$ref": "#/definitions/store.IdentityProviderOAuth2Config"
"$ref": "#/definitions/api_v1.IdentityProviderOAuth2Config"
}
}
},
"store.IdentityProviderOAuth2Config": {
"api_v1.IdentityProviderOAuth2Config": {
"type": "object",
"properties": {
"authUrl": {
......@@ -2058,7 +2071,7 @@ const docTemplate = `{
"type": "string"
},
"fieldMapping": {
"$ref": "#/definitions/store.FieldMapping"
"$ref": "#/definitions/api_v1.FieldMapping"
},
"scopes": {
"type": "array",
......@@ -2074,7 +2087,7 @@ const docTemplate = `{
}
}
},
"store.IdentityProviderType": {
"api_v1.IdentityProviderType": {
"type": "string",
"enum": [
"OAUTH2"
......@@ -2083,7 +2096,18 @@ const docTemplate = `{
"IdentityProviderOAuth2Type"
]
},
"store.Memo": {
"api_v1.MemoRelationType": {
"type": "string",
"enum": [
"REFERENCE",
"COMMENT"
],
"x-enum-varnames": [
"MemoRelationReference",
"MemoRelationComment"
]
},
"api_v1.PatchMemoRequest": {
"type": "object",
"properties": {
"content": {
......@@ -2091,176 +2115,357 @@ const docTemplate = `{
"type": "string"
},
"createdTs": {
"description": "Standard fields",
"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": {
"type": "array",
"items": {
"$ref": "#/definitions/store.MemoRelation"
"$ref": "#/definitions/api_v1.UpsertMemoRelationRequest"
}
},
"resourceIDList": {
"resourceIdList": {
"description": "Related fields",
"type": "array",
"items": {
"type": "integer"
}
},
"rowStatus": {
"description": "Standard fields",
"allOf": [
{
"$ref": "#/definitions/store.RowStatus"
}
]
"$ref": "#/definitions/api_v1.RowStatus"
},
"updatedTs": {
"type": "integer"
},
"visibility": {
"$ref": "#/definitions/store.Visibility"
"$ref": "#/definitions/api_v1.Visibility"
}
}
},
"store.MemoRelation": {
"type": "object",
"properties": {
"memoID": {
"type": "integer"
},
"relatedMemoID": {
"type": "integer"
},
"type": {
"$ref": "#/definitions/store.MemoRelationType"
}
}
"api_v1.Role": {
"type": "string",
"enum": [
"HOST",
"ADMIN",
"USER"
],
"x-enum-varnames": [
"RoleHost",
"RoleAdmin",
"RoleUser"
]
},
"store.MemoRelationType": {
"api_v1.RowStatus": {
"type": "string",
"enum": [
"REFERENCE",
"COMMENT"
"NORMAL",
"ARCHIVED"
],
"x-enum-varnames": [
"MemoRelationReference",
"MemoRelationComment"
"Normal",
"Archived"
]
},
"store.Resource": {
"api_v1.SSOSignIn": {
"type": "object",
"properties": {
"blob": {
"type": "array",
"items": {
"type": "integer"
}
"code": {
"type": "string"
},
"createdTs": {
"identityProviderId": {
"type": "integer"
},
"creatorID": {
"description": "Standard fields",
"type": "integer"
"redirectUri": {
"type": "string"
}
}
},
"api_v1.SignIn": {
"type": "object",
"properties": {
"password": {
"type": "string"
},
"externalLink": {
"remember": {
"type": "boolean"
},
"username": {
"type": "string"
}
}
},
"api_v1.SignUp": {
"type": "object",
"properties": {
"password": {
"type": "string"
},
"filename": {
"description": "Domain specific fields",
"username": {
"type": "string"
}
}
},
"api_v1.StorageConfig": {
"type": "object",
"properties": {
"s3Config": {
"$ref": "#/definitions/api_v1.StorageS3Config"
}
}
},
"api_v1.StorageS3Config": {
"type": "object",
"properties": {
"accessKey": {
"type": "string"
},
"id": {
"type": "integer"
"bucket": {
"type": "string"
},
"internalPath": {
"endPoint": {
"type": "string"
},
"memoID": {
"type": "integer"
"path": {
"type": "string"
},
"size": {
"type": "integer"
"region": {
"type": "string"
},
"type": {
"secretKey": {
"type": "string"
},
"updatedTs": {
"type": "integer"
"urlPrefix": {
"type": "string"
},
"urlSuffix": {
"type": "string"
}
}
},
"store.Role": {
"api_v1.StorageType": {
"type": "string",
"enum": [
"HOST",
"ADMIN",
"USER"
"S3"
],
"x-enum-varnames": [
"RoleHost",
"RoleAdmin",
"RoleUser"
"StorageS3"
]
},
"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",
"enum": [
"NORMAL",
"ARCHIVED"
"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"
],
"x-enum-varnames": [
"Normal",
"Archived"
"SystemSettingServerIDName",
"SystemSettingSecretSessionName",
"SystemSettingAllowSignUpName",
"SystemSettingDisablePasswordLoginName",
"SystemSettingDisablePublicMemosName",
"SystemSettingMaxUploadSizeMiBName",
"SystemSettingAdditionalStyleName",
"SystemSettingAdditionalScriptName",
"SystemSettingCustomizedProfileName",
"SystemSettingStorageServiceIDName",
"SystemSettingLocalStoragePathName",
"SystemSettingTelegramBotTokenName",
"SystemSettingMemoDisplayWithUpdatedTsName",
"SystemSettingInstanceURLName"
]
},
"store.Storage": {
"api_v1.SystemStatus": {
"type": "object",
"properties": {
"config": {
"additionalScript": {
"description": "Additional script.",
"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"
}
}
},
"api_v1.UpdateIdentityProviderRequest": {
"type": "object",
"properties": {
"config": {
"$ref": "#/definitions/api_v1.IdentityProviderConfig"
},
"identifierFilter": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"$ref": "#/definitions/api_v1.IdentityProviderType"
}
}
},
"api_v1.UpdateResourceRequest": {
"type": "object",
"properties": {
"filename": {
"type": "string"
}
}
},
"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",
"properties": {
"description": {
"type": "string"
},
"name": {
"type": "string"
"$ref": "#/definitions/api_v1.SystemSettingName"
},
"value": {
"type": "string"
}
}
},
"store.User": {
"api_v1.UpsertTagRequest": {
"type": "object",
"properties": {
"avatarURL": {
"name": {
"type": "string"
}
}
},
"api_v1.User": {
"type": "object",
"properties": {
"avatarUrl": {
"type": "string"
},
"createdTs": {
......@@ -2275,17 +2480,14 @@ const docTemplate = `{
"nickname": {
"type": "string"
},
"passwordHash": {
"type": "string"
},
"role": {
"$ref": "#/definitions/store.Role"
"$ref": "#/definitions/api_v1.Role"
},
"rowStatus": {
"description": "Standard fields",
"allOf": [
{
"$ref": "#/definitions/store.RowStatus"
"$ref": "#/definitions/api_v1.RowStatus"
}
]
},
......@@ -2298,7 +2500,7 @@ const docTemplate = `{
}
}
},
"store.Visibility": {
"api_v1.Visibility": {
"type": "string",
"enum": [
"PUBLIC",
......@@ -2311,11 +2513,11 @@ const docTemplate = `{
"Private"
]
},
"v1.CreateIdentityProviderRequest": {
"github_com_usememos_memos_api_v1.CreateIdentityProviderRequest": {
"type": "object",
"properties": {
"config": {
"$ref": "#/definitions/v1.IdentityProviderConfig"
"$ref": "#/definitions/github_com_usememos_memos_api_v1.IdentityProviderConfig"
},
"identifierFilter": {
"type": "string"
......@@ -2324,11 +2526,11 @@ const docTemplate = `{
"type": "string"
},
"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",
"properties": {
"content": {
......@@ -2340,7 +2542,7 @@ const docTemplate = `{
"relationList": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.UpsertMemoRelationRequest"
"$ref": "#/definitions/github_com_usememos_memos_api_v1.UpsertMemoRelationRequest"
}
},
"resourceIdList": {
......@@ -2354,13 +2556,13 @@ const docTemplate = `{
"description": "Domain specific fields",
"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",
"properties": {
"externalLink": {
......@@ -2374,21 +2576,21 @@ const docTemplate = `{
}
}
},
"v1.CreateStorageRequest": {
"github_com_usememos_memos_api_v1.CreateStorageRequest": {
"type": "object",
"properties": {
"config": {
"$ref": "#/definitions/v1.StorageConfig"
"$ref": "#/definitions/github_com_usememos_memos_api_v1.StorageConfig"
},
"name": {
"type": "string"
},
"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",
"properties": {
"email": {
......@@ -2401,14 +2603,14 @@ const docTemplate = `{
"type": "string"
},
"role": {
"$ref": "#/definitions/v1.Role"
"$ref": "#/definitions/github_com_usememos_memos_api_v1.Role"
},
"username": {
"type": "string"
}
}
},
"v1.CustomizedProfile": {
"github_com_usememos_memos_api_v1.CustomizedProfile": {
"type": "object",
"properties": {
"appearance": {
......@@ -2437,7 +2639,7 @@ const docTemplate = `{
}
}
},
"v1.DeleteTagRequest": {
"github_com_usememos_memos_api_v1.DeleteTagRequest": {
"type": "object",
"properties": {
"name": {
......@@ -2445,7 +2647,7 @@ const docTemplate = `{
}
}
},
"v1.FieldMapping": {
"github_com_usememos_memos_api_v1.FieldMapping": {
"type": "object",
"properties": {
"displayName": {
......@@ -2459,11 +2661,11 @@ const docTemplate = `{
}
}
},
"v1.IdentityProvider": {
"github_com_usememos_memos_api_v1.IdentityProvider": {
"type": "object",
"properties": {
"config": {
"$ref": "#/definitions/v1.IdentityProviderConfig"
"$ref": "#/definitions/github_com_usememos_memos_api_v1.IdentityProviderConfig"
},
"id": {
"type": "integer"
......@@ -2475,19 +2677,19 @@ const docTemplate = `{
"type": "string"
},
"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",
"properties": {
"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",
"properties": {
"authUrl": {
......@@ -2500,7 +2702,7 @@ const docTemplate = `{
"type": "string"
},
"fieldMapping": {
"$ref": "#/definitions/v1.FieldMapping"
"$ref": "#/definitions/github_com_usememos_memos_api_v1.FieldMapping"
},
"scopes": {
"type": "array",
......@@ -2516,7 +2718,7 @@ const docTemplate = `{
}
}
},
"v1.IdentityProviderType": {
"github_com_usememos_memos_api_v1.IdentityProviderType": {
"type": "string",
"enum": [
"OAUTH2"
......@@ -2525,18 +2727,18 @@ const docTemplate = `{
"IdentityProviderOAuth2Type"
]
},
"v1.MemoRelationType": {
"github_com_usememos_memos_api_v1.MemoRelationType": {
"type": "string",
"enum": [
"REFERENCE",
"ADDITIONAL"
"COMMENT"
],
"x-enum-varnames": [
"MemoRelationReference",
"MemoRelationAdditional"
"MemoRelationComment"
]
},
"v1.PatchMemoRequest": {
"github_com_usememos_memos_api_v1.PatchMemoRequest": {
"type": "object",
"properties": {
"content": {
......@@ -2550,7 +2752,7 @@ const docTemplate = `{
"relationList": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.UpsertMemoRelationRequest"
"$ref": "#/definitions/github_com_usememos_memos_api_v1.UpsertMemoRelationRequest"
}
},
"resourceIdList": {
......@@ -2561,17 +2763,17 @@ const docTemplate = `{
}
},
"rowStatus": {
"$ref": "#/definitions/v1.RowStatus"
"$ref": "#/definitions/github_com_usememos_memos_api_v1.RowStatus"
},
"updatedTs": {
"type": "integer"
},
"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",
"enum": [
"HOST",
......@@ -2584,7 +2786,7 @@ const docTemplate = `{
"RoleUser"
]
},
"v1.RowStatus": {
"github_com_usememos_memos_api_v1.RowStatus": {
"type": "string",
"enum": [
"NORMAL",
......@@ -2595,7 +2797,7 @@ const docTemplate = `{
"Archived"
]
},
"v1.SSOSignIn": {
"github_com_usememos_memos_api_v1.SSOSignIn": {
"type": "object",
"properties": {
"code": {
......@@ -2609,18 +2811,21 @@ const docTemplate = `{
}
}
},
"v1.SignIn": {
"github_com_usememos_memos_api_v1.SignIn": {
"type": "object",
"properties": {
"password": {
"type": "string"
},
"remember": {
"type": "boolean"
},
"username": {
"type": "string"
}
}
},
"v1.SignUp": {
"github_com_usememos_memos_api_v1.SignUp": {
"type": "object",
"properties": {
"password": {
......@@ -2631,15 +2836,15 @@ const docTemplate = `{
}
}
},
"v1.StorageConfig": {
"github_com_usememos_memos_api_v1.StorageConfig": {
"type": "object",
"properties": {
"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",
"properties": {
"accessKey": {
......@@ -2668,7 +2873,7 @@ const docTemplate = `{
}
}
},
"v1.StorageType": {
"github_com_usememos_memos_api_v1.StorageType": {
"type": "string",
"enum": [
"S3"
......@@ -2677,14 +2882,14 @@ const docTemplate = `{
"StorageS3"
]
},
"v1.SystemSetting": {
"github_com_usememos_memos_api_v1.SystemSetting": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"name": {
"$ref": "#/definitions/v1.SystemSettingName"
"$ref": "#/definitions/github_com_usememos_memos_api_v1.SystemSettingName"
},
"value": {
"description": "Value is a JSON string with basic value.",
......@@ -2692,7 +2897,7 @@ const docTemplate = `{
}
}
},
"v1.SystemSettingName": {
"github_com_usememos_memos_api_v1.SystemSettingName": {
"type": "string",
"enum": [
"server-id",
......@@ -2708,7 +2913,7 @@ const docTemplate = `{
"local-storage-path",
"telegram-bot-token",
"memo-display-with-updated-ts",
"auto-backup-interval"
"instance-url"
],
"x-enum-varnames": [
"SystemSettingServerIDName",
......@@ -2724,10 +2929,10 @@ const docTemplate = `{
"SystemSettingLocalStoragePathName",
"SystemSettingTelegramBotTokenName",
"SystemSettingMemoDisplayWithUpdatedTsName",
"SystemSettingAutoBackupIntervalName"
"SystemSettingInstanceURLName"
]
},
"v1.SystemStatus": {
"github_com_usememos_memos_api_v1.SystemStatus": {
"type": "object",
"properties": {
"additionalScript": {
......@@ -2742,15 +2947,11 @@ const docTemplate = `{
"description": "System settings\nAllow sign up.",
"type": "boolean"
},
"autoBackupInterval": {
"description": "Auto Backup Interval.",
"type": "integer"
},
"customizedProfile": {
"description": "Customized server profile, including server name and external url.",
"allOf": [
{
"$ref": "#/definitions/v1.CustomizedProfile"
"$ref": "#/definitions/github_com_usememos_memos_api_v1.CustomizedProfile"
}
]
},
......@@ -2766,7 +2967,7 @@ const docTemplate = `{
"type": "boolean"
},
"host": {
"$ref": "#/definitions/v1.User"
"$ref": "#/definitions/github_com_usememos_memos_api_v1.User"
},
"localStoragePath": {
"description": "Local storage path.",
......@@ -2789,11 +2990,11 @@ const docTemplate = `{
}
}
},
"v1.UpdateIdentityProviderRequest": {
"github_com_usememos_memos_api_v1.UpdateIdentityProviderRequest": {
"type": "object",
"properties": {
"config": {
"$ref": "#/definitions/v1.IdentityProviderConfig"
"$ref": "#/definitions/github_com_usememos_memos_api_v1.IdentityProviderConfig"
},
"identifierFilter": {
"type": "string"
......@@ -2802,11 +3003,11 @@ const docTemplate = `{
"type": "string"
},
"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",
"properties": {
"filename": {
......@@ -2814,21 +3015,21 @@ const docTemplate = `{
}
}
},
"v1.UpdateStorageRequest": {
"github_com_usememos_memos_api_v1.UpdateStorageRequest": {
"type": "object",
"properties": {
"config": {
"$ref": "#/definitions/v1.StorageConfig"
"$ref": "#/definitions/github_com_usememos_memos_api_v1.StorageConfig"
},
"name": {
"type": "string"
},
"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",
"properties": {
"avatarUrl": {
......@@ -2844,14 +3045,14 @@ const docTemplate = `{
"type": "string"
},
"rowStatus": {
"$ref": "#/definitions/v1.RowStatus"
"$ref": "#/definitions/github_com_usememos_memos_api_v1.RowStatus"
},
"username": {
"type": "string"
}
}
},
"v1.UpsertMemoOrganizerRequest": {
"github_com_usememos_memos_api_v1.UpsertMemoOrganizerRequest": {
"type": "object",
"properties": {
"pinned": {
......@@ -2859,32 +3060,32 @@ const docTemplate = `{
}
}
},
"v1.UpsertMemoRelationRequest": {
"github_com_usememos_memos_api_v1.UpsertMemoRelationRequest": {
"type": "object",
"properties": {
"relatedMemoId": {
"type": "integer"
},
"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",
"properties": {
"description": {
"type": "string"
},
"name": {
"$ref": "#/definitions/v1.SystemSettingName"
"$ref": "#/definitions/github_com_usememos_memos_api_v1.SystemSettingName"
},
"value": {
"type": "string"
}
}
},
"v1.UpsertTagRequest": {
"github_com_usememos_memos_api_v1.UpsertTagRequest": {
"type": "object",
"properties": {
"name": {
......@@ -2892,21 +3093,10 @@ const docTemplate = `{
}
}
},
"v1.UpsertUserSettingRequest": {
"github_com_usememos_memos_api_v1.User": {
"type": "object",
"properties": {
"key": {
"$ref": "#/definitions/v1.UserSettingKey"
},
"value": {
"type": "string"
}
}
},
"v1.User": {
"type": "object",
"properties": {
"avatarUrl": {
"avatarUrl": {
"type": "string"
},
"createdTs": {
......@@ -2922,61 +3112,332 @@ const docTemplate = `{
"type": "string"
},
"role": {
"$ref": "#/definitions/v1.Role"
"$ref": "#/definitions/github_com_usememos_memos_api_v1.Role"
},
"rowStatus": {
"description": "Standard fields",
"allOf": [
{
"$ref": "#/definitions/v1.RowStatus"
"$ref": "#/definitions/github_com_usememos_memos_api_v1.RowStatus"
}
]
},
"updatedTs": {
"type": "integer"
},
"userSettingList": {
"username": {
"description": "Domain specific fields",
"type": "string"
}
}
},
"github_com_usememos_memos_api_v1.Visibility": {
"type": "string",
"enum": [
"PUBLIC",
"PROTECTED",
"PRIVATE"
],
"x-enum-varnames": [
"Public",
"Protected",
"Private"
]
},
"profile.Profile": {
"type": "object",
"properties": {
"mode": {
"description": "Mode can be \"prod\" or \"dev\" or \"demo\"",
"type": "string"
},
"version": {
"description": "Version is the current version of server",
"type": "string"
}
}
},
"store.FieldMapping": {
"type": "object",
"properties": {
"displayName": {
"type": "string"
},
"email": {
"type": "string"
},
"identifier": {
"type": "string"
}
}
},
"store.IdentityProvider": {
"type": "object",
"properties": {
"config": {
"$ref": "#/definitions/store.IdentityProviderConfig"
},
"id": {
"type": "integer"
},
"identifierFilter": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"$ref": "#/definitions/store.IdentityProviderType"
}
}
},
"store.IdentityProviderConfig": {
"type": "object",
"properties": {
"oauth2Config": {
"$ref": "#/definitions/store.IdentityProviderOAuth2Config"
}
}
},
"store.IdentityProviderOAuth2Config": {
"type": "object",
"properties": {
"authUrl": {
"type": "string"
},
"clientId": {
"type": "string"
},
"clientSecret": {
"type": "string"
},
"fieldMapping": {
"$ref": "#/definitions/store.FieldMapping"
},
"scopes": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.UserSetting"
"type": "string"
}
},
"username": {
"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": {
"description": "Standard fields",
"allOf": [
{
"$ref": "#/definitions/store.RowStatus"
}
]
},
"updatedTs": {
"type": "integer"
},
"visibility": {
"$ref": "#/definitions/store.Visibility"
}
}
},
"v1.UserSetting": {
"store.MemoRelation": {
"type": "object",
"properties": {
"key": {
"$ref": "#/definitions/v1.UserSettingKey"
"memoID": {
"type": "integer"
},
"userId": {
"relatedMemoID": {
"type": "integer"
},
"value": {
"type": {
"$ref": "#/definitions/store.MemoRelationType"
}
}
},
"store.MemoRelationType": {
"type": "string",
"enum": [
"REFERENCE",
"COMMENT"
],
"x-enum-varnames": [
"MemoRelationReference",
"MemoRelationComment"
]
},
"store.Resource": {
"type": "object",
"properties": {
"blob": {
"type": "array",
"items": {
"type": "integer"
}
},
"createdTs": {
"type": "integer"
},
"creatorID": {
"description": "Standard fields",
"type": "integer"
},
"externalLink": {
"type": "string"
},
"filename": {
"description": "Domain specific fields",
"type": "string"
},
"id": {
"type": "integer"
},
"internalPath": {
"type": "string"
},
"memoID": {
"type": "integer"
},
"size": {
"type": "integer"
},
"type": {
"type": "string"
},
"updatedTs": {
"type": "integer"
}
}
},
"v1.UserSettingKey": {
"store.Role": {
"type": "string",
"enum": [
"HOST",
"ADMIN",
"USER"
],
"x-enum-varnames": [
"RoleHost",
"RoleAdmin",
"RoleUser"
]
},
"store.RowStatus": {
"type": "string",
"enum": [
"locale",
"appearance",
"memo-visibility",
"telegram-user-id"
"NORMAL",
"ARCHIVED"
],
"x-enum-varnames": [
"UserSettingLocaleKey",
"UserSettingAppearanceKey",
"UserSettingMemoVisibilityKey",
"UserSettingTelegramUserIDKey"
"Normal",
"Archived"
]
},
"v1.Visibility": {
"store.Storage": {
"type": "object",
"properties": {
"config": {
"type": "string"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"store.SystemSetting": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"store.User": {
"type": "object",
"properties": {
"avatarURL": {
"type": "string"
},
"createdTs": {
"type": "integer"
},
"email": {
"type": "string"
},
"id": {
"type": "integer"
},
"nickname": {
"type": "string"
},
"passwordHash": {
"type": "string"
},
"role": {
"$ref": "#/definitions/store.Role"
},
"rowStatus": {
"description": "Standard fields",
"allOf": [
{
"$ref": "#/definitions/store.RowStatus"
}
]
},
"updatedTs": {
"type": "integer"
},
"username": {
"description": "Domain specific fields",
"type": "string"
}
}
},
"store.Visibility": {
"type": "string",
"enum": [
"PUBLIC",
......
api/v1/swagger.yaml
View file @ af68cae6
basePath: /
definitions:
github_com_usememos_memos_store.UserSetting:
api_v1.CreateIdentityProviderRequest:
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
userID:
createdTs:
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: object
profile.Profile:
api_v1.CreateStorageRequest:
properties:
driver:
description: |-
Driver is the database driver
sqlite, mysql
config:
$ref: '#/definitions/api_v1.StorageConfig'
name:
type: string
dsn:
description: DSN points to where Memos stores its own data
type:
$ref: '#/definitions/api_v1.StorageType'
type: object
api_v1.CreateUserRequest:
properties:
email:
type: string
mode:
description: Mode can be "prod" or "dev" or "demo"
nickname:
type: string
version:
description: Version is the current version of server
password:
type: string
role:
$ref: '#/definitions/api_v1.Role'
username:
type: string
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:
displayName:
type: string
......@@ -35,10 +97,10 @@ definitions:
identifier:
type: string
type: object
store.IdentityProvider:
api_v1.IdentityProvider:
properties:
config:
$ref: '#/definitions/store.IdentityProviderConfig'
$ref: '#/definitions/api_v1.IdentityProviderConfig'
id:
type: integer
identifierFilter:
......@@ -46,14 +108,14 @@ definitions:
name:
type: string
type:
$ref: '#/definitions/store.IdentityProviderType'
$ref: '#/definitions/api_v1.IdentityProviderType'
type: object
store.IdentityProviderConfig:
api_v1.IdentityProviderConfig:
properties:
oauth2Config:
$ref: '#/definitions/store.IdentityProviderOAuth2Config'
$ref: '#/definitions/api_v1.IdentityProviderOAuth2Config'
type: object
store.IdentityProviderOAuth2Config:
api_v1.IdentityProviderOAuth2Config:
properties:
authUrl:
type: string
......@@ -62,7 +124,7 @@ definitions:
clientSecret:
type: string
fieldMapping:
$ref: '#/definitions/store.FieldMapping'
$ref: '#/definitions/api_v1.FieldMapping'
scopes:
items:
type: string
......@@ -72,95 +134,45 @@ definitions:
userInfoUrl:
type: string
type: object
store.IdentityProviderType:
api_v1.IdentityProviderType:
enum:
- OAUTH2
type: string
x-enum-varnames:
- IdentityProviderOAuth2Type
store.Memo:
api_v1.MemoRelationType:
enum:
- REFERENCE
- COMMENT
type: string
x-enum-varnames:
- MemoRelationReference
- MemoRelationComment
api_v1.PatchMemoRequest:
properties:
content:
description: Domain specific fields
type: string
createdTs:
description: Standard fields
type: integer
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:
items:
$ref: '#/definitions/store.MemoRelation'
$ref: '#/definitions/api_v1.UpsertMemoRelationRequest'
type: array
resourceIDList:
resourceIdList:
description: Related fields
items:
type: integer
type: array
rowStatus:
allOf:
- $ref: '#/definitions/store.RowStatus'
description: Standard fields
$ref: '#/definitions/api_v1.RowStatus'
updatedTs:
type: integer
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
store.Role:
api_v1.Role:
enum:
- HOST
- ADMIN
......@@ -170,7 +182,7 @@ definitions:
- RoleHost
- RoleAdmin
- RoleUser
store.RowStatus:
api_v1.RowStatus:
enum:
- NORMAL
- ARCHIVED
......@@ -178,29 +190,215 @@ definitions:
x-enum-varnames:
- Normal
- Archived
store.Storage:
api_v1.SSOSignIn:
properties:
config:
code:
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
disablePasswordLogin:
description: Disable password login.
type: boolean
disablePublicMemos:
description: Disable public memos.
type: boolean
host:
$ref: '#/definitions/api_v1.User'
localStoragePath:
description: Local storage path.
type: string
maxUploadSizeMiB:
description: Max upload size.
type: integer
memoDisplayWithUpdatedTs:
description: Memo display with updated timestamp.
type: boolean
profile:
$ref: '#/definitions/profile.Profile'
storageServiceId:
description: Storage service ID.
type: integer
type: object
api_v1.UpdateIdentityProviderRequest:
properties:
config:
$ref: '#/definitions/api_v1.IdentityProviderConfig'
identifierFilter:
type: string
name:
type: string
type:
$ref: '#/definitions/api_v1.IdentityProviderType'
type: object
api_v1.UpdateResourceRequest:
properties:
filename:
type: string
type: object
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:
description:
type: string
name:
type: string
$ref: '#/definitions/api_v1.SystemSettingName'
value:
type: string
type: object
store.User:
api_v1.UpsertTagRequest:
properties:
avatarURL:
name:
type: string
type: object
api_v1.User:
properties:
avatarUrl:
type: string
createdTs:
type: integer
......@@ -210,13 +408,11 @@ definitions:
type: integer
nickname:
type: string
passwordHash:
type: string
role:
$ref: '#/definitions/store.Role'
$ref: '#/definitions/api_v1.Role'
rowStatus:
allOf:
- $ref: '#/definitions/store.RowStatus'
- $ref: '#/definitions/api_v1.RowStatus'
description: Standard fields
updatedTs:
type: integer
......@@ -224,7 +420,7 @@ definitions:
description: Domain specific fields
type: string
type: object
store.Visibility:
api_v1.Visibility:
enum:
- PUBLIC
- PROTECTED
......@@ -234,18 +430,18 @@ definitions:
- Public
- Protected
- Private
v1.CreateIdentityProviderRequest:
github_com_usememos_memos_api_v1.CreateIdentityProviderRequest:
properties:
config:
$ref: '#/definitions/v1.IdentityProviderConfig'
$ref: '#/definitions/github_com_usememos_memos_api_v1.IdentityProviderConfig'
identifierFilter:
type: string
name:
type: string
type:
$ref: '#/definitions/v1.IdentityProviderType'
$ref: '#/definitions/github_com_usememos_memos_api_v1.IdentityProviderType'
type: object
v1.CreateMemoRequest:
github_com_usememos_memos_api_v1.CreateMemoRequest:
properties:
content:
type: string
......@@ -253,7 +449,7 @@ definitions:
type: integer
relationList:
items:
$ref: '#/definitions/v1.UpsertMemoRelationRequest'
$ref: '#/definitions/github_com_usememos_memos_api_v1.UpsertMemoRelationRequest'
type: array
resourceIdList:
description: Related fields
......@@ -262,10 +458,10 @@ definitions:
type: array
visibility:
allOf:
- $ref: '#/definitions/v1.Visibility'
- $ref: '#/definitions/github_com_usememos_memos_api_v1.Visibility'
description: Domain specific fields
type: object
v1.CreateResourceRequest:
github_com_usememos_memos_api_v1.CreateResourceRequest:
properties:
externalLink:
type: string
......@@ -274,16 +470,16 @@ definitions:
type:
type: string
type: object
v1.CreateStorageRequest:
github_com_usememos_memos_api_v1.CreateStorageRequest:
properties:
config:
$ref: '#/definitions/v1.StorageConfig'
$ref: '#/definitions/github_com_usememos_memos_api_v1.StorageConfig'
name:
type: string
type:
$ref: '#/definitions/v1.StorageType'
$ref: '#/definitions/github_com_usememos_memos_api_v1.StorageType'
type: object
v1.CreateUserRequest:
github_com_usememos_memos_api_v1.CreateUserRequest:
properties:
email:
type: string
......@@ -292,11 +488,11 @@ definitions:
password:
type: string
role:
$ref: '#/definitions/v1.Role'
$ref: '#/definitions/github_com_usememos_memos_api_v1.Role'
username:
type: string
type: object
v1.CustomizedProfile:
github_com_usememos_memos_api_v1.CustomizedProfile:
properties:
appearance:
description: Appearance is the server default appearance.
......@@ -317,12 +513,12 @@ definitions:
description: Name is the server name, default is `memos`
type: string
type: object
v1.DeleteTagRequest:
github_com_usememos_memos_api_v1.DeleteTagRequest:
properties:
name:
type: string
type: object
v1.FieldMapping:
github_com_usememos_memos_api_v1.FieldMapping:
properties:
displayName:
type: string
......@@ -331,10 +527,10 @@ definitions:
identifier:
type: string
type: object
v1.IdentityProvider:
github_com_usememos_memos_api_v1.IdentityProvider:
properties:
config:
$ref: '#/definitions/v1.IdentityProviderConfig'
$ref: '#/definitions/github_com_usememos_memos_api_v1.IdentityProviderConfig'
id:
type: integer
identifierFilter:
......@@ -342,14 +538,14 @@ definitions:
name:
type: string
type:
$ref: '#/definitions/v1.IdentityProviderType'
$ref: '#/definitions/github_com_usememos_memos_api_v1.IdentityProviderType'
type: object
v1.IdentityProviderConfig:
github_com_usememos_memos_api_v1.IdentityProviderConfig:
properties:
oauth2Config:
$ref: '#/definitions/v1.IdentityProviderOAuth2Config'
$ref: '#/definitions/github_com_usememos_memos_api_v1.IdentityProviderOAuth2Config'
type: object
v1.IdentityProviderOAuth2Config:
github_com_usememos_memos_api_v1.IdentityProviderOAuth2Config:
properties:
authUrl:
type: string
......@@ -358,7 +554,7 @@ definitions:
clientSecret:
type: string
fieldMapping:
$ref: '#/definitions/v1.FieldMapping'
$ref: '#/definitions/github_com_usememos_memos_api_v1.FieldMapping'
scopes:
items:
type: string
......@@ -368,21 +564,21 @@ definitions:
userInfoUrl:
type: string
type: object
v1.IdentityProviderType:
github_com_usememos_memos_api_v1.IdentityProviderType:
enum:
- OAUTH2
type: string
x-enum-varnames:
- IdentityProviderOAuth2Type
v1.MemoRelationType:
github_com_usememos_memos_api_v1.MemoRelationType:
enum:
- REFERENCE
- ADDITIONAL
- COMMENT
type: string
x-enum-varnames:
- MemoRelationReference
- MemoRelationAdditional
v1.PatchMemoRequest:
- MemoRelationComment
github_com_usememos_memos_api_v1.PatchMemoRequest:
properties:
content:
description: Domain specific fields
......@@ -392,7 +588,7 @@ definitions:
type: integer
relationList:
items:
$ref: '#/definitions/v1.UpsertMemoRelationRequest'
$ref: '#/definitions/github_com_usememos_memos_api_v1.UpsertMemoRelationRequest'
type: array
resourceIdList:
description: Related fields
......@@ -400,13 +596,13 @@ definitions:
type: integer
type: array
rowStatus:
$ref: '#/definitions/v1.RowStatus'
$ref: '#/definitions/github_com_usememos_memos_api_v1.RowStatus'
updatedTs:
type: integer
visibility:
$ref: '#/definitions/v1.Visibility'
$ref: '#/definitions/github_com_usememos_memos_api_v1.Visibility'
type: object
v1.Role:
github_com_usememos_memos_api_v1.Role:
enum:
- HOST
- ADMIN
......@@ -416,7 +612,7 @@ definitions:
- RoleHost
- RoleAdmin
- RoleUser
v1.RowStatus:
github_com_usememos_memos_api_v1.RowStatus:
enum:
- NORMAL
- ARCHIVED
......@@ -424,7 +620,7 @@ definitions:
x-enum-varnames:
- Normal
- Archived
v1.SSOSignIn:
github_com_usememos_memos_api_v1.SSOSignIn:
properties:
code:
type: string
......@@ -433,26 +629,28 @@ definitions:
redirectUri:
type: string
type: object
v1.SignIn:
github_com_usememos_memos_api_v1.SignIn:
properties:
password:
type: string
remember:
type: boolean
username:
type: string
type: object
v1.SignUp:
github_com_usememos_memos_api_v1.SignUp:
properties:
password:
type: string
username:
type: string
type: object
v1.StorageConfig:
github_com_usememos_memos_api_v1.StorageConfig:
properties:
s3Config:
$ref: '#/definitions/v1.StorageS3Config'
$ref: '#/definitions/github_com_usememos_memos_api_v1.StorageS3Config'
type: object
v1.StorageS3Config:
github_com_usememos_memos_api_v1.StorageS3Config:
properties:
accessKey:
type: string
......@@ -471,23 +669,23 @@ definitions:
urlSuffix:
type: string
type: object
v1.StorageType:
github_com_usememos_memos_api_v1.StorageType:
enum:
- S3
type: string
x-enum-varnames:
- StorageS3
v1.SystemSetting:
github_com_usememos_memos_api_v1.SystemSetting:
properties:
description:
type: string
name:
$ref: '#/definitions/v1.SystemSettingName'
$ref: '#/definitions/github_com_usememos_memos_api_v1.SystemSettingName'
value:
description: Value is a JSON string with basic value.
type: string
type: object
v1.SystemSettingName:
github_com_usememos_memos_api_v1.SystemSettingName:
enum:
- server-id
- secret-session
......@@ -502,7 +700,7 @@ definitions:
- local-storage-path
- telegram-bot-token
- memo-display-with-updated-ts
- auto-backup-interval
- instance-url
type: string
x-enum-varnames:
- SystemSettingServerIDName
......@@ -518,8 +716,8 @@ definitions:
- SystemSettingLocalStoragePathName
- SystemSettingTelegramBotTokenName
- SystemSettingMemoDisplayWithUpdatedTsName
- SystemSettingAutoBackupIntervalName
v1.SystemStatus:
- SystemSettingInstanceURLName
github_com_usememos_memos_api_v1.SystemStatus:
properties:
additionalScript:
description: Additional script.
......@@ -532,12 +730,9 @@ definitions:
System settings
Allow sign up.
type: boolean
autoBackupInterval:
description: Auto Backup Interval.
type: integer
customizedProfile:
allOf:
- $ref: '#/definitions/v1.CustomizedProfile'
- $ref: '#/definitions/github_com_usememos_memos_api_v1.CustomizedProfile'
description: Customized server profile, including server name and external
url.
dbSize:
......@@ -549,7 +744,7 @@ definitions:
description: Disable public memos.
type: boolean
host:
$ref: '#/definitions/v1.User'
$ref: '#/definitions/github_com_usememos_memos_api_v1.User'
localStoragePath:
description: Local storage path.
type: string
......@@ -565,32 +760,32 @@ definitions:
description: Storage service ID.
type: integer
type: object
v1.UpdateIdentityProviderRequest:
github_com_usememos_memos_api_v1.UpdateIdentityProviderRequest:
properties:
config:
$ref: '#/definitions/v1.IdentityProviderConfig'
$ref: '#/definitions/github_com_usememos_memos_api_v1.IdentityProviderConfig'
identifierFilter:
type: string
name:
type: string
type:
$ref: '#/definitions/v1.IdentityProviderType'
$ref: '#/definitions/github_com_usememos_memos_api_v1.IdentityProviderType'
type: object
v1.UpdateResourceRequest:
github_com_usememos_memos_api_v1.UpdateResourceRequest:
properties:
filename:
type: string
type: object
v1.UpdateStorageRequest:
github_com_usememos_memos_api_v1.UpdateStorageRequest:
properties:
config:
$ref: '#/definitions/v1.StorageConfig'
$ref: '#/definitions/github_com_usememos_memos_api_v1.StorageConfig'
name:
type: string
type:
$ref: '#/definitions/v1.StorageType'
$ref: '#/definitions/github_com_usememos_memos_api_v1.StorageType'
type: object
v1.UpdateUserRequest:
github_com_usememos_memos_api_v1.UpdateUserRequest:
properties:
avatarUrl:
type: string
......@@ -601,44 +796,37 @@ definitions:
password:
type: string
rowStatus:
$ref: '#/definitions/v1.RowStatus'
$ref: '#/definitions/github_com_usememos_memos_api_v1.RowStatus'
username:
type: string
type: object
v1.UpsertMemoOrganizerRequest:
github_com_usememos_memos_api_v1.UpsertMemoOrganizerRequest:
properties:
pinned:
type: boolean
type: object
v1.UpsertMemoRelationRequest:
github_com_usememos_memos_api_v1.UpsertMemoRelationRequest:
properties:
relatedMemoId:
type: integer
type:
$ref: '#/definitions/v1.MemoRelationType'
$ref: '#/definitions/github_com_usememos_memos_api_v1.MemoRelationType'
type: object
v1.UpsertSystemSettingRequest:
github_com_usememos_memos_api_v1.UpsertSystemSettingRequest:
properties:
description:
type: string
name:
$ref: '#/definitions/v1.SystemSettingName'
$ref: '#/definitions/github_com_usememos_memos_api_v1.SystemSettingName'
value:
type: string
type: object
v1.UpsertTagRequest:
github_com_usememos_memos_api_v1.UpsertTagRequest:
properties:
name:
type: string
type: object
v1.UpsertUserSettingRequest:
properties:
key:
$ref: '#/definitions/v1.UserSettingKey'
value:
type: string
type: object
v1.User:
github_com_usememos_memos_api_v1.User:
properties:
avatarUrl:
type: string
......@@ -651,43 +839,222 @@ definitions:
nickname:
type: string
role:
$ref: '#/definitions/v1.Role'
$ref: '#/definitions/github_com_usememos_memos_api_v1.Role'
rowStatus:
allOf:
- $ref: '#/definitions/v1.RowStatus'
- $ref: '#/definitions/github_com_usememos_memos_api_v1.RowStatus'
description: Standard fields
updatedTs:
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:
$ref: '#/definitions/v1.UserSetting'
type: string
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
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
v1.UserSetting:
store.MemoRelation:
properties:
key:
$ref: '#/definitions/v1.UserSettingKey'
userId:
memoID:
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
updatedTs:
type: integer
type: object
v1.UserSettingKey:
store.Role:
enum:
- HOST
- ADMIN
- USER
type: string
x-enum-varnames:
- RoleHost
- RoleAdmin
- RoleUser
store.RowStatus:
enum:
- locale
- appearance
- memo-visibility
- telegram-user-id
- NORMAL
- ARCHIVED
type: string
x-enum-varnames:
- UserSettingLocaleKey
- UserSettingAppearanceKey
- UserSettingMemoVisibilityKey
- UserSettingTelegramUserIDKey
v1.Visibility:
- Normal
- Archived
store.Storage:
properties:
config:
type: string
id:
type: integer
name:
type: string
type:
type: string
type: object
store.SystemSetting:
properties:
description:
type: string
name:
type: string
value:
type: string
type: object
store.User:
properties:
avatarURL:
type: string
createdTs:
type: integer
email:
type: string
id:
type: integer
nickname:
type: string
passwordHash:
type: string
role:
$ref: '#/definitions/store.Role'
rowStatus:
allOf:
- $ref: '#/definitions/store.RowStatus'
description: Standard fields
updatedTs:
type: integer
username:
description: Domain specific fields
type: string
type: object
store.Visibility:
enum:
- PUBLIC
- PROTECTED
......@@ -721,7 +1088,7 @@ paths:
name: body
required: true
schema:
$ref: '#/definitions/v1.SignIn'
$ref: '#/definitions/github_com_usememos_memos_api_v1.SignIn'
produces:
- application/json
responses:
......@@ -753,7 +1120,7 @@ paths:
name: body
required: true
schema:
$ref: '#/definitions/v1.SSOSignIn'
$ref: '#/definitions/github_com_usememos_memos_api_v1.SSOSignIn'
produces:
- application/json
responses:
......@@ -801,7 +1168,7 @@ paths:
name: body
required: true
schema:
$ref: '#/definitions/v1.SignUp'
$ref: '#/definitions/github_com_usememos_memos_api_v1.SignUp'
produces:
- application/json
responses:
......@@ -834,7 +1201,7 @@ paths:
description: List of available identity providers
schema:
items:
$ref: '#/definitions/v1.IdentityProvider'
$ref: '#/definitions/github_com_usememos_memos_api_v1.IdentityProvider'
type: array
"500":
description: Failed to find identity provider list | Failed to find user
......@@ -850,7 +1217,7 @@ paths:
name: body
required: true
schema:
$ref: '#/definitions/v1.CreateIdentityProviderRequest'
$ref: '#/definitions/github_com_usememos_memos_api_v1.CreateIdentityProviderRequest'
produces:
- application/json
responses:
......@@ -935,7 +1302,7 @@ paths:
name: body
required: true
schema:
$ref: '#/definitions/v1.UpdateIdentityProviderRequest'
$ref: '#/definitions/github_com_usememos_memos_api_v1.UpdateIdentityProviderRequest'
produces:
- application/json
responses:
......@@ -1020,7 +1387,7 @@ paths:
name: body
required: true
schema:
$ref: '#/definitions/v1.CreateMemoRequest'
$ref: '#/definitions/github_com_usememos_memos_api_v1.CreateMemoRequest'
produces:
- application/json
responses:
......@@ -1117,7 +1484,7 @@ paths:
name: body
required: true
schema:
$ref: '#/definitions/v1.PatchMemoRequest'
$ref: '#/definitions/github_com_usememos_memos_api_v1.PatchMemoRequest'
produces:
- application/json
responses:
......@@ -1154,7 +1521,7 @@ paths:
name: body
required: true
schema:
$ref: '#/definitions/v1.UpsertMemoOrganizerRequest'
$ref: '#/definitions/github_com_usememos_memos_api_v1.UpsertMemoOrganizerRequest'
produces:
- application/json
responses:
......@@ -1216,7 +1583,7 @@ paths:
name: body
required: true
schema:
$ref: '#/definitions/v1.UpsertMemoRelationRequest'
$ref: '#/definitions/api_v1.UpsertMemoRelationRequest'
produces:
- application/json
responses:
......@@ -1250,7 +1617,7 @@ paths:
- description: Type of relation to remove
enum:
- REFERENCE
- ADDITIONAL
- COMMENT
in: path
name: relationType
required: true
......@@ -1376,7 +1743,7 @@ paths:
name: body
required: true
schema:
$ref: '#/definitions/v1.CreateResourceRequest'
$ref: '#/definitions/github_com_usememos_memos_api_v1.CreateResourceRequest'
produces:
- application/json
responses:
......@@ -1434,7 +1801,7 @@ paths:
name: patch
required: true
schema:
$ref: '#/definitions/v1.UpdateResourceRequest'
$ref: '#/definitions/github_com_usememos_memos_api_v1.UpdateResourceRequest'
produces:
- application/json
responses:
......@@ -1489,7 +1856,7 @@ paths:
"200":
description: System GetSystemStatus
schema:
$ref: '#/definitions/v1.SystemStatus'
$ref: '#/definitions/github_com_usememos_memos_api_v1.SystemStatus'
"401":
description: Missing user in session | Unauthorized
"500":
......@@ -1525,7 +1892,7 @@ paths:
name: body
required: true
schema:
$ref: '#/definitions/v1.CreateStorageRequest'
$ref: '#/definitions/github_com_usememos_memos_api_v1.CreateStorageRequest'
produces:
- application/json
responses:
......@@ -1580,7 +1947,7 @@ paths:
name: patch
required: true
schema:
$ref: '#/definitions/v1.UpdateStorageRequest'
$ref: '#/definitions/github_com_usememos_memos_api_v1.UpdateStorageRequest'
produces:
- application/json
responses:
......@@ -1608,7 +1975,7 @@ paths:
description: System setting list
schema:
items:
$ref: '#/definitions/v1.SystemSetting'
$ref: '#/definitions/api_v1.SystemSetting'
type: array
"401":
description: Missing user in session | Unauthorized
......@@ -1626,7 +1993,7 @@ paths:
name: body
required: true
schema:
$ref: '#/definitions/v1.UpsertSystemSettingRequest'
$ref: '#/definitions/api_v1.UpsertSystemSettingRequest'
produces:
- application/json
responses:
......@@ -1688,7 +2055,7 @@ paths:
name: body
required: true
schema:
$ref: '#/definitions/v1.UpsertTagRequest'
$ref: '#/definitions/github_com_usememos_memos_api_v1.UpsertTagRequest'
produces:
- application/json
responses:
......@@ -1715,7 +2082,7 @@ paths:
name: body
required: true
schema:
$ref: '#/definitions/v1.DeleteTagRequest'
$ref: '#/definitions/github_com_usememos_memos_api_v1.DeleteTagRequest'
produces:
- application/json
responses:
......@@ -1775,7 +2142,7 @@ paths:
name: body
required: true
schema:
$ref: '#/definitions/v1.CreateUserRequest'
$ref: '#/definitions/github_com_usememos_memos_api_v1.CreateUserRequest'
produces:
- application/json
responses:
......@@ -1857,7 +2224,7 @@ paths:
name: patch
required: true
schema:
$ref: '#/definitions/v1.UpdateUserRequest'
$ref: '#/definitions/github_com_usememos_memos_api_v1.UpdateUserRequest'
produces:
- application/json
responses:
......@@ -1916,34 +2283,6 @@ paths:
summary: Get user by username
tags:
- 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:
get:
produces:
......@@ -1977,38 +2316,7 @@ paths:
description: Failed to write GetImage blob
summary: Get GetImage from URL
tags:
- get
/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
- image-url
/u/{id}/rss.xml:
get:
parameters:
......
docs/api/v1.md
View file @ af68cae6
This source diff could not be displayed because it is too large. You can view the blob instead.
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