memos/api/memo.go

83 lines
1.6 KiB
Go
Raw Normal View History

2021-12-08 23:43:14 +08:00
package api
// Visibility is the type of a visibility.
type Visibility string
const (
// Public is the PUBLIC visibility.
Public Visibility = "PUBLIC"
// Protected is the PROTECTED visibility.
Protected Visibility = "PROTECTED"
// Privite is the PRIVATE visibility.
Privite Visibility = "PRIVATE"
)
func (e Visibility) String() string {
switch e {
case Public:
return "PUBLIC"
case Protected:
return "PROTECTED"
case Privite:
return "PRIVATE"
}
return "PRIVATE"
}
2022-02-03 15:32:03 +08:00
type Memo struct {
2022-05-03 11:49:10 +08:00
ID int `json:"id"`
// Standard fields
2022-05-19 18:32:04 +08:00
RowStatus RowStatus `json:"rowStatus"`
CreatorID int `json:"creatorId"`
CreatedTs int64 `json:"createdTs"`
UpdatedTs int64 `json:"updatedTs"`
2022-02-03 15:32:03 +08:00
2022-05-03 11:49:10 +08:00
// Domain specific fields
Content string `json:"content"`
Visibility Visibility `json:"visibility"`
Pinned bool `json:"pinned"`
2021-12-08 23:43:14 +08:00
}
2022-02-03 15:32:03 +08:00
type MemoCreate struct {
2022-05-03 11:49:10 +08:00
// Standard fields
2022-05-03 02:05:43 +08:00
CreatorID int
2022-02-18 22:21:10 +08:00
2022-05-03 11:49:10 +08:00
// Domain specific fields
2022-08-25 22:02:32 +08:00
Visibility Visibility `json:"visibility"`
Content string `json:"content"`
2021-12-08 23:43:14 +08:00
}
2022-02-03 15:32:03 +08:00
type MemoPatch struct {
2022-05-03 02:05:43 +08:00
ID int
2021-12-08 23:43:14 +08:00
2022-05-03 11:49:10 +08:00
// Standard fields
2022-08-25 22:02:32 +08:00
CreatedTs *int64 `json:"createdTs"`
2022-05-19 18:32:04 +08:00
RowStatus *RowStatus `json:"rowStatus"`
2022-05-03 11:49:10 +08:00
// Domain specific fields
Content *string `json:"content"`
Visibility *Visibility `json:"visibility"`
2021-12-09 22:02:57 +08:00
}
2022-02-03 15:32:03 +08:00
type MemoFind struct {
2022-05-03 11:49:10 +08:00
ID *int `json:"id"`
// Standard fields
2022-05-19 18:32:04 +08:00
RowStatus *RowStatus `json:"rowStatus"`
CreatorID *int `json:"creatorId"`
// Domain specific fields
Pinned *bool
ContentSearch *string
VisibilityList []Visibility
2022-06-21 21:58:33 +08:00
// Pagination
Limit int
Offset int
2021-12-08 23:43:14 +08:00
}
2022-02-03 15:32:03 +08:00
type MemoDelete struct {
2022-05-17 21:21:13 +08:00
ID int `json:"id"`
2022-02-03 15:32:03 +08:00
}