chore: update swag docs (#2178)

* chore: update swag docs

* chore: update

api/v1/v1.go

@@ -12,6 +12,25 @@ type APIV1Service struct {
 	Store   *store.Store
 }
 
+// @title						memos API
+// @version					1.0
+// @description				A privacy-first, lightweight note-taking service.
+//
+// @contact.name				API Support
+// @contact.url				https://github.com/orgs/usememos/discussions
+//
+// @license.name				MIT License
+// @license.url				https://github.com/usememos/memos/blob/main/LICENSE
+//
+// @BasePath					/
+//
+// @externalDocs.url			https://usememos.com/
+// @externalDocs.description	Find out more about Memos
+//
+// @securitydefinitions.apikey	ApiKeyAuth
+// @in							query
+// @name						openId
+// @description				Insert your Open ID API Key here.
 func NewAPIV1Service(secret string, profile *profile.Profile, store *store.Store) *APIV1Service {
 	return &APIV1Service{
 		Secret:  secret,
@@ -50,4 +69,7 @@ func (s *APIV1Service) Register(rootGroup *echo.Group) {
 	})
 	s.registerGetterPublicRoutes(publicGroup)
 	s.registerResourcePublicRoutes(publicGroup)
+
+	// programmatically set API version same as the server version
+	SwaggerInfo.Version = s.Profile.Version
 }

docs/documenting-the-api.md

@@ -6,7 +6,7 @@
 
 - Documentation is written using [Declarative Comments Format](https://github.com/swaggo/swag#declarative-comments-format).
 
-- The documentation is generated in the `./api` folder as `docs.go`.
+- The documentation is generated in the `./api/v1` folder as `docs.go`.
 
 - [echo-swagger](https://github.com/swaggo/echo-swagger) is used to integrate with Echo framework and serve the documentation with [Swagger-UI](https://swagger.io/tools/swagger-ui/) at `http://memos.host:5230/api/index.html`
 
@@ -107,7 +107,7 @@ If `$HOME/go/bin` is not in your `PATH`, you can call `swag` directly at `$HOME/
 
    ```bash
    cd <project-root>
-   swag init --output api --generalInfo ./server/server.go --dir ./,./api/v1
+   swag init --output ./api/v1 --generalInfo ./api/v1/v1.go --dir ./,./api/v1
    ```
 
 > If the API gets a new version, you'll need to add the file system path to swag's `--dir` parameter.

proto/gen/store/README.md

@@ -0,0 +1,96 @@
+# Protocol Documentation
+<a name="top"></a>
+
+## Table of Contents
+
+- [store/common.proto](#store_common-proto)
+- [store/system_setting.proto](#store_system_setting-proto)
+    - [BackupConfig](#memos-store-BackupConfig)
+  
+    - [SystemSettingKey](#memos-store-SystemSettingKey)
+  
+- [Scalar Value Types](#scalar-value-types)
+
+
+
+<a name="store_common-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+
+## store/common.proto
+
+
+ 
+
+ 
+
+ 
+
+ 
+
+
+
+<a name="store_system_setting-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+
+## store/system_setting.proto
+
+
+
+<a name="memos-store-BackupConfig"></a>
+
+### BackupConfig
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| enabled | [bool](#bool) |  | enabled indicates whether backup is enabled. |
+| cron | [string](#string) |  | cron is the cron expression for backup. See https://godoc.org/github.com/robfig/cron#hdr-CRON_Expression_Format |
+| max_keep | [int32](#int32) |  | max_keep is the maximum number of backups to keep. |
+
+
+
+
+
+ 
+
+
+<a name="memos-store-SystemSettingKey"></a>
+
+### SystemSettingKey
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| SYSTEM_SETTING_KEY_UNSPECIFIED | 0 |  |
+| BACKUP_CONFIG | 1 | BackupConfig is the key for auto-backup configuration. |
+
+
+ 
+
+ 
+
+ 
+
+
+
+## Scalar Value Types
+
+| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
+| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- |
+| <a name="double" /> double |  | double | double | float | float64 | double | float | Float |
+| <a name="float" /> float |  | float | float | float | float32 | float | float | Float |
+| <a name="int32" /> int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
+| <a name="int64" /> int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum |
+| <a name="uint32" /> uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) |
+| <a name="uint64" /> uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) |
+| <a name="sint32" /> sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
+| <a name="sint64" /> sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum |
+| <a name="fixed32" /> fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) |
+| <a name="fixed64" /> fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum |
+| <a name="sfixed32" /> sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
+| <a name="sfixed64" /> sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum |
+| <a name="bool" /> bool |  | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass |
+| <a name="string" /> string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) |
+| <a name="bytes" /> bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) |
+

proto/gen/store/common.pb.go

@@ -0,0 +1,71 @@
+// Code generated by protoc-gen-go. DO NOT EDIT.
+// versions:
+// 	protoc-gen-go v1.31.0
+// 	protoc        (unknown)
+// source: store/common.proto
+
+package store
+
+import (
+	protoreflect "google.golang.org/protobuf/reflect/protoreflect"
+	protoimpl "google.golang.org/protobuf/runtime/protoimpl"
+	reflect "reflect"
+)
+
+const (
+	// Verify that this generated code is sufficiently up-to-date.
+	_ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion)
+	// Verify that runtime/protoimpl is sufficiently up-to-date.
+	_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
+)
+
+var File_store_common_proto protoreflect.FileDescriptor
+
+var file_store_common_proto_rawDesc = []byte{
+	0x0a, 0x12, 0x73, 0x74, 0x6f, 0x72, 0x65, 0x2f, 0x63, 0x6f, 0x6d, 0x6d, 0x6f, 0x6e, 0x2e, 0x70,
+	0x72, 0x6f, 0x74, 0x6f, 0x12, 0x0b, 0x6d, 0x65, 0x6d, 0x6f, 0x73, 0x2e, 0x73, 0x74, 0x6f, 0x72,
+	0x65, 0x42, 0x96, 0x01, 0x0a, 0x0f, 0x63, 0x6f, 0x6d, 0x2e, 0x6d, 0x65, 0x6d, 0x6f, 0x73, 0x2e,
+	0x73, 0x74, 0x6f, 0x72, 0x65, 0x42, 0x0b, 0x43, 0x6f, 0x6d, 0x6d, 0x6f, 0x6e, 0x50, 0x72, 0x6f,
+	0x74, 0x6f, 0x50, 0x01, 0x5a, 0x29, 0x67, 0x69, 0x74, 0x68, 0x75, 0x62, 0x2e, 0x63, 0x6f, 0x6d,
+	0x2f, 0x75, 0x73, 0x65, 0x6d, 0x65, 0x6d, 0x6f, 0x73, 0x2f, 0x6d, 0x65, 0x6d, 0x6f, 0x73, 0x2f,
+	0x70, 0x72, 0x6f, 0x74, 0x6f, 0x2f, 0x67, 0x65, 0x6e, 0x2f, 0x73, 0x74, 0x6f, 0x72, 0x65, 0xa2,
+	0x02, 0x03, 0x4d, 0x53, 0x58, 0xaa, 0x02, 0x0b, 0x4d, 0x65, 0x6d, 0x6f, 0x73, 0x2e, 0x53, 0x74,
+	0x6f, 0x72, 0x65, 0xca, 0x02, 0x0b, 0x4d, 0x65, 0x6d, 0x6f, 0x73, 0x5c, 0x53, 0x74, 0x6f, 0x72,
+	0x65, 0xe2, 0x02, 0x17, 0x4d, 0x65, 0x6d, 0x6f, 0x73, 0x5c, 0x53, 0x74, 0x6f, 0x72, 0x65, 0x5c,
+	0x47, 0x50, 0x42, 0x4d, 0x65, 0x74, 0x61, 0x64, 0x61, 0x74, 0x61, 0xea, 0x02, 0x0c, 0x4d, 0x65,
+	0x6d, 0x6f, 0x73, 0x3a, 0x3a, 0x53, 0x74, 0x6f, 0x72, 0x65, 0x62, 0x06, 0x70, 0x72, 0x6f, 0x74,
+	0x6f, 0x33,
+}
+
+var file_store_common_proto_goTypes = []interface{}{}
+var file_store_common_proto_depIdxs = []int32{
+	0, // [0:0] is the sub-list for method output_type
+	0, // [0:0] is the sub-list for method input_type
+	0, // [0:0] is the sub-list for extension type_name
+	0, // [0:0] is the sub-list for extension extendee
+	0, // [0:0] is the sub-list for field type_name
+}
+
+func init() { file_store_common_proto_init() }
+func file_store_common_proto_init() {
+	if File_store_common_proto != nil {
+		return
+	}
+	type x struct{}
+	out := protoimpl.TypeBuilder{
+		File: protoimpl.DescBuilder{
+			GoPackagePath: reflect.TypeOf(x{}).PkgPath(),
+			RawDescriptor: file_store_common_proto_rawDesc,
+			NumEnums:      0,
+			NumMessages:   0,
+			NumExtensions: 0,
+			NumServices:   0,
+		},
+		GoTypes:           file_store_common_proto_goTypes,
+		DependencyIndexes: file_store_common_proto_depIdxs,
+	}.Build()
+	File_store_common_proto = out.File
+	file_store_common_proto_rawDesc = nil
+	file_store_common_proto_goTypes = nil
+	file_store_common_proto_depIdxs = nil
+}

proto/gen/store/system_setting.pb.go

@@ -0,0 +1,229 @@
+// Code generated by protoc-gen-go. DO NOT EDIT.
+// versions:
+// 	protoc-gen-go v1.31.0
+// 	protoc        (unknown)
+// source: store/system_setting.proto
+
+package store
+
+import (
+	protoreflect "google.golang.org/protobuf/reflect/protoreflect"
+	protoimpl "google.golang.org/protobuf/runtime/protoimpl"
+	reflect "reflect"
+	sync "sync"
+)
+
+const (
+	// Verify that this generated code is sufficiently up-to-date.
+	_ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion)
+	// Verify that runtime/protoimpl is sufficiently up-to-date.
+	_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
+)
+
+type SystemSettingKey int32
+
+const (
+	SystemSettingKey_SYSTEM_SETTING_KEY_UNSPECIFIED SystemSettingKey = 0
+	// BackupConfig is the key for auto-backup configuration.
+	SystemSettingKey_BACKUP_CONFIG SystemSettingKey = 1
+)
+
+// Enum value maps for SystemSettingKey.
+var (
+	SystemSettingKey_name = map[int32]string{
+		0: "SYSTEM_SETTING_KEY_UNSPECIFIED",
+		1: "BACKUP_CONFIG",
+	}
+	SystemSettingKey_value = map[string]int32{
+		"SYSTEM_SETTING_KEY_UNSPECIFIED": 0,
+		"BACKUP_CONFIG":                  1,
+	}
+)
+
+func (x SystemSettingKey) Enum() *SystemSettingKey {
+	p := new(SystemSettingKey)
+	*p = x
+	return p
+}
+
+func (x SystemSettingKey) String() string {
+	return protoimpl.X.EnumStringOf(x.Descriptor(), protoreflect.EnumNumber(x))
+}
+
+func (SystemSettingKey) Descriptor() protoreflect.EnumDescriptor {
+	return file_store_system_setting_proto_enumTypes[0].Descriptor()
+}
+
+func (SystemSettingKey) Type() protoreflect.EnumType {
+	return &file_store_system_setting_proto_enumTypes[0]
+}
+
+func (x SystemSettingKey) Number() protoreflect.EnumNumber {
+	return protoreflect.EnumNumber(x)
+}
+
+// Deprecated: Use SystemSettingKey.Descriptor instead.
+func (SystemSettingKey) EnumDescriptor() ([]byte, []int) {
+	return file_store_system_setting_proto_rawDescGZIP(), []int{0}
+}
+
+type BackupConfig struct {
+	state         protoimpl.MessageState
+	sizeCache     protoimpl.SizeCache
+	unknownFields protoimpl.UnknownFields
+
+	// enabled indicates whether backup is enabled.
+	Enabled bool `protobuf:"varint,1,opt,name=enabled,proto3" json:"enabled,omitempty"`
+	// cron is the cron expression for backup. See https://godoc.org/github.com/robfig/cron#hdr-CRON_Expression_Format
+	Cron string `protobuf:"bytes,2,opt,name=cron,proto3" json:"cron,omitempty"`
+	// max_keep is the maximum number of backups to keep.
+	MaxKeep int32 `protobuf:"varint,3,opt,name=max_keep,json=maxKeep,proto3" json:"max_keep,omitempty"`
+}
+
+func (x *BackupConfig) Reset() {
+	*x = BackupConfig{}
+	if protoimpl.UnsafeEnabled {
+		mi := &file_store_system_setting_proto_msgTypes[0]
+		ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+		ms.StoreMessageInfo(mi)
+	}
+}
+
+func (x *BackupConfig) String() string {
+	return protoimpl.X.MessageStringOf(x)
+}
+
+func (*BackupConfig) ProtoMessage() {}
+
+func (x *BackupConfig) ProtoReflect() protoreflect.Message {
+	mi := &file_store_system_setting_proto_msgTypes[0]
+	if protoimpl.UnsafeEnabled && x != nil {
+		ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+		if ms.LoadMessageInfo() == nil {
+			ms.StoreMessageInfo(mi)
+		}
+		return ms
+	}
+	return mi.MessageOf(x)
+}
+
+// Deprecated: Use BackupConfig.ProtoReflect.Descriptor instead.
+func (*BackupConfig) Descriptor() ([]byte, []int) {
+	return file_store_system_setting_proto_rawDescGZIP(), []int{0}
+}
+
+func (x *BackupConfig) GetEnabled() bool {
+	if x != nil {
+		return x.Enabled
+	}
+	return false
+}
+
+func (x *BackupConfig) GetCron() string {
+	if x != nil {
+		return x.Cron
+	}
+	return ""
+}
+
+func (x *BackupConfig) GetMaxKeep() int32 {
+	if x != nil {
+		return x.MaxKeep
+	}
+	return 0
+}
+
+var File_store_system_setting_proto protoreflect.FileDescriptor
+
+var file_store_system_setting_proto_rawDesc = []byte{
+	0x0a, 0x1a, 0x73, 0x74, 0x6f, 0x72, 0x65, 0x2f, 0x73, 0x79, 0x73, 0x74, 0x65, 0x6d, 0x5f, 0x73,
+	0x65, 0x74, 0x74, 0x69, 0x6e, 0x67, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x12, 0x0b, 0x6d, 0x65,
+	0x6d, 0x6f, 0x73, 0x2e, 0x73, 0x74, 0x6f, 0x72, 0x65, 0x22, 0x57, 0x0a, 0x0c, 0x42, 0x61, 0x63,
+	0x6b, 0x75, 0x70, 0x43, 0x6f, 0x6e, 0x66, 0x69, 0x67, 0x12, 0x18, 0x0a, 0x07, 0x65, 0x6e, 0x61,
+	0x62, 0x6c, 0x65, 0x64, 0x18, 0x01, 0x20, 0x01, 0x28, 0x08, 0x52, 0x07, 0x65, 0x6e, 0x61, 0x62,
+	0x6c, 0x65, 0x64, 0x12, 0x12, 0x0a, 0x04, 0x63, 0x72, 0x6f, 0x6e, 0x18, 0x02, 0x20, 0x01, 0x28,
+	0x09, 0x52, 0x04, 0x63, 0x72, 0x6f, 0x6e, 0x12, 0x19, 0x0a, 0x08, 0x6d, 0x61, 0x78, 0x5f, 0x6b,
+	0x65, 0x65, 0x70, 0x18, 0x03, 0x20, 0x01, 0x28, 0x05, 0x52, 0x07, 0x6d, 0x61, 0x78, 0x4b, 0x65,
+	0x65, 0x70, 0x2a, 0x49, 0x0a, 0x10, 0x53, 0x79, 0x73, 0x74, 0x65, 0x6d, 0x53, 0x65, 0x74, 0x74,
+	0x69, 0x6e, 0x67, 0x4b, 0x65, 0x79, 0x12, 0x22, 0x0a, 0x1e, 0x53, 0x59, 0x53, 0x54, 0x45, 0x4d,
+	0x5f, 0x53, 0x45, 0x54, 0x54, 0x49, 0x4e, 0x47, 0x5f, 0x4b, 0x45, 0x59, 0x5f, 0x55, 0x4e, 0x53,
+	0x50, 0x45, 0x43, 0x49, 0x46, 0x49, 0x45, 0x44, 0x10, 0x00, 0x12, 0x11, 0x0a, 0x0d, 0x42, 0x41,
+	0x43, 0x4b, 0x55, 0x50, 0x5f, 0x43, 0x4f, 0x4e, 0x46, 0x49, 0x47, 0x10, 0x01, 0x42, 0x9d, 0x01,
+	0x0a, 0x0f, 0x63, 0x6f, 0x6d, 0x2e, 0x6d, 0x65, 0x6d, 0x6f, 0x73, 0x2e, 0x73, 0x74, 0x6f, 0x72,
+	0x65, 0x42, 0x12, 0x53, 0x79, 0x73, 0x74, 0x65, 0x6d, 0x53, 0x65, 0x74, 0x74, 0x69, 0x6e, 0x67,
+	0x50, 0x72, 0x6f, 0x74, 0x6f, 0x50, 0x01, 0x5a, 0x29, 0x67, 0x69, 0x74, 0x68, 0x75, 0x62, 0x2e,
+	0x63, 0x6f, 0x6d, 0x2f, 0x75, 0x73, 0x65, 0x6d, 0x65, 0x6d, 0x6f, 0x73, 0x2f, 0x6d, 0x65, 0x6d,
+	0x6f, 0x73, 0x2f, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x2f, 0x67, 0x65, 0x6e, 0x2f, 0x73, 0x74, 0x6f,
+	0x72, 0x65, 0xa2, 0x02, 0x03, 0x4d, 0x53, 0x58, 0xaa, 0x02, 0x0b, 0x4d, 0x65, 0x6d, 0x6f, 0x73,
+	0x2e, 0x53, 0x74, 0x6f, 0x72, 0x65, 0xca, 0x02, 0x0b, 0x4d, 0x65, 0x6d, 0x6f, 0x73, 0x5c, 0x53,
+	0x74, 0x6f, 0x72, 0x65, 0xe2, 0x02, 0x17, 0x4d, 0x65, 0x6d, 0x6f, 0x73, 0x5c, 0x53, 0x74, 0x6f,
+	0x72, 0x65, 0x5c, 0x47, 0x50, 0x42, 0x4d, 0x65, 0x74, 0x61, 0x64, 0x61, 0x74, 0x61, 0xea, 0x02,
+	0x0c, 0x4d, 0x65, 0x6d, 0x6f, 0x73, 0x3a, 0x3a, 0x53, 0x74, 0x6f, 0x72, 0x65, 0x62, 0x06, 0x70,
+	0x72, 0x6f, 0x74, 0x6f, 0x33,
+}
+
+var (
+	file_store_system_setting_proto_rawDescOnce sync.Once
+	file_store_system_setting_proto_rawDescData = file_store_system_setting_proto_rawDesc
+)
+
+func file_store_system_setting_proto_rawDescGZIP() []byte {
+	file_store_system_setting_proto_rawDescOnce.Do(func() {
+		file_store_system_setting_proto_rawDescData = protoimpl.X.CompressGZIP(file_store_system_setting_proto_rawDescData)
+	})
+	return file_store_system_setting_proto_rawDescData
+}
+
+var file_store_system_setting_proto_enumTypes = make([]protoimpl.EnumInfo, 1)
+var file_store_system_setting_proto_msgTypes = make([]protoimpl.MessageInfo, 1)
+var file_store_system_setting_proto_goTypes = []interface{}{
+	(SystemSettingKey)(0), // 0: memos.store.SystemSettingKey
+	(*BackupConfig)(nil),  // 1: memos.store.BackupConfig
+}
+var file_store_system_setting_proto_depIdxs = []int32{
+	0, // [0:0] is the sub-list for method output_type
+	0, // [0:0] is the sub-list for method input_type
+	0, // [0:0] is the sub-list for extension type_name
+	0, // [0:0] is the sub-list for extension extendee
+	0, // [0:0] is the sub-list for field type_name
+}
+
+func init() { file_store_system_setting_proto_init() }
+func file_store_system_setting_proto_init() {
+	if File_store_system_setting_proto != nil {
+		return
+	}
+	if !protoimpl.UnsafeEnabled {
+		file_store_system_setting_proto_msgTypes[0].Exporter = func(v interface{}, i int) interface{} {
+			switch v := v.(*BackupConfig); i {
+			case 0:
+				return &v.state
+			case 1:
+				return &v.sizeCache
+			case 2:
+				return &v.unknownFields
+			default:
+				return nil
+			}
+		}
+	}
+	type x struct{}
+	out := protoimpl.TypeBuilder{
+		File: protoimpl.DescBuilder{
+			GoPackagePath: reflect.TypeOf(x{}).PkgPath(),
+			RawDescriptor: file_store_system_setting_proto_rawDesc,
+			NumEnums:      1,
+			NumMessages:   1,
+			NumExtensions: 0,
+			NumServices:   0,
+		},
+		GoTypes:           file_store_system_setting_proto_goTypes,
+		DependencyIndexes: file_store_system_setting_proto_depIdxs,
+		EnumInfos:         file_store_system_setting_proto_enumTypes,
+		MessageInfos:      file_store_system_setting_proto_msgTypes,
+	}.Build()
+	File_store_system_setting_proto = out.File
+	file_store_system_setting_proto_rawDesc = nil
+	file_store_system_setting_proto_goTypes = nil
+	file_store_system_setting_proto_depIdxs = nil
+}

proto/store/common.proto

@@ -0,0 +1,5 @@
+syntax = "proto3";
+
+package memos.store;
+
+option go_package = "gen/store";

proto/store/system_setting.proto

@@ -0,0 +1,21 @@
+syntax = "proto3";
+
+package memos.store;
+
+option go_package = "gen/store";
+
+enum SystemSettingKey {
+  SYSTEM_SETTING_KEY_UNSPECIFIED = 0;
+
+  // BackupConfig is the key for auto-backup configuration.
+  BACKUP_CONFIG = 1;
+}
+
+message BackupConfig {
+  // enabled indicates whether backup is enabled.
+  bool enabled = 1;
+  // cron is the cron expression for backup. See https://godoc.org/github.com/robfig/cron#hdr-CRON_Expression_Format
+  string cron = 2;
+  // max_keep is the maximum number of backups to keep.
+  int32 max_keep = 3;
+}

scripts/gen-api-v1-docs.cfg

@@ -4,7 +4,7 @@
 SWAG_API_DIRS=./api/v1
 
 # Where general API info is documented
-SWAG_GENERAL_INFO=./server/server.go
+SWAG_GENERAL_INFO=./api/v1/v1.go
 
 # Possible output files: go (docs.go), json (swagger.json), yaml (swagger.yaml)
 SWAG_OUTPUT_TYPES=go,yaml

server/server.go

@@ -19,6 +19,7 @@ import (
 	"github.com/usememos/memos/common/util"
 	"github.com/usememos/memos/plugin/telegram"
 	"github.com/usememos/memos/server/profile"
+	"github.com/usememos/memos/server/service"
 	"github.com/usememos/memos/store"
 	"go.uber.org/zap"
 )
@@ -35,29 +36,10 @@ type Server struct {
 	apiV2Service *apiv2.APIV2Service
 
 	// Asynchronous runners.
-	backupRunner *BackupRunner
+	backupRunner *service.BackupRunner
 	telegramBot  *telegram.Bot
 }
 
-// @title						memos API
-// @version					1.0
-// @description				A privacy-first, lightweight note-taking service.
-//
-// @contact.name				API Support
-// @contact.url				https://github.com/orgs/usememos/discussions
-//
-// @license.name				MIT License
-// @license.url				https://github.com/usememos/memos/blob/main/LICENSE
-//
-// @BasePath					/
-//
-// @externalDocs.url			https://usememos.com/
-// @externalDocs.description	Find out more about Memos
-//
-// @securitydefinitions.apikey	ApiKeyAuth
-// @in							query
-// @name						openId
-// @description				Insert your Open ID API Key here.
 func NewServer(ctx context.Context, profile *profile.Profile, store *store.Store) (*Server, error) {
 	e := echo.New()
 	e.Debug = true
@@ -70,7 +52,7 @@ func NewServer(ctx context.Context, profile *profile.Profile, store *store.Store
 		Profile: profile,
 
 		// Asynchronous runners.
-		backupRunner: NewBackupRunner(store),
+		backupRunner: service.NewBackupRunner(store),
 		telegramBot:  telegram.NewBotWithHandler(newTelegramHandler(store)),
 	}
 
@@ -149,9 +131,6 @@ func (s *Server) Start(ctx context.Context) error {
 		}
 	}()
 
-	// programmatically set API version same as the server version
-	apiv1.SwaggerInfo.Version = s.Profile.Version
-
 	return s.e.Start(fmt.Sprintf("%s:%d", s.Profile.Addr, s.Profile.Port))
 }
 

server/service/backup.go

@@ -1,4 +1,4 @@
-package server
+package service
 
 import (
 	"context"

web/src/types/proto/store/system_setting_pb.d.ts

@@ -0,0 +1,65 @@
+// @generated by protoc-gen-es v1.3.0
+// @generated from file store/system_setting.proto (package memos.store, syntax proto3)
+/* eslint-disable */
+// @ts-nocheck
+
+import type { BinaryReadOptions, FieldList, JsonReadOptions, JsonValue, PartialMessage, PlainMessage } from "@bufbuild/protobuf";
+import { Message, proto3 } from "@bufbuild/protobuf";
+
+/**
+ * @generated from enum memos.store.SystemSettingKey
+ */
+export declare enum SystemSettingKey {
+  /**
+   * @generated from enum value: SYSTEM_SETTING_KEY_UNSPECIFIED = 0;
+   */
+  SYSTEM_SETTING_KEY_UNSPECIFIED = 0,
+
+  /**
+   * BackupConfig is the key for auto-backup configuration.
+   *
+   * @generated from enum value: BACKUP_CONFIG = 1;
+   */
+  BACKUP_CONFIG = 1,
+}
+
+/**
+ * @generated from message memos.store.BackupConfig
+ */
+export declare class BackupConfig extends Message<BackupConfig> {
+  /**
+   * enabled indicates whether backup is enabled.
+   *
+   * @generated from field: bool enabled = 1;
+   */
+  enabled: boolean;
+
+  /**
+   * cron is the cron expression for backup. See https://godoc.org/github.com/robfig/cron#hdr-CRON_Expression_Format
+   *
+   * @generated from field: string cron = 2;
+   */
+  cron: string;
+
+  /**
+   * max_keep is the maximum number of backups to keep.
+   *
+   * @generated from field: int32 max_keep = 3;
+   */
+  maxKeep: number;
+
+  constructor(data?: PartialMessage<BackupConfig>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "memos.store.BackupConfig";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): BackupConfig;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): BackupConfig;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): BackupConfig;
+
+  static equals(a: BackupConfig | PlainMessage<BackupConfig> | undefined, b: BackupConfig | PlainMessage<BackupConfig> | undefined): boolean;
+}
+

web/src/types/proto/store/system_setting_pb.js

@@ -0,0 +1,30 @@
+// @generated by protoc-gen-es v1.3.0
+// @generated from file store/system_setting.proto (package memos.store, syntax proto3)
+/* eslint-disable */
+// @ts-nocheck
+
+import { proto3 } from "@bufbuild/protobuf";
+
+/**
+ * @generated from enum memos.store.SystemSettingKey
+ */
+export const SystemSettingKey = proto3.makeEnum(
+  "memos.store.SystemSettingKey",
+  [
+    {no: 0, name: "SYSTEM_SETTING_KEY_UNSPECIFIED"},
+    {no: 1, name: "BACKUP_CONFIG"},
+  ],
+);
+
+/**
+ * @generated from message memos.store.BackupConfig
+ */
+export const BackupConfig = proto3.makeMessageType(
+  "memos.store.BackupConfig",
+  () => [
+    { no: 1, name: "enabled", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
+    { no: 2, name: "cron", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 3, name: "max_keep", kind: "scalar", T: 5 /* ScalarType.INT32 */ },
+  ],
+);
+