memos/proto/gen/api/v2/README.md

Protocol Documentation

Table of Contents

• api/v2/common.proto

  • RowStatus

• api/v2/memo_service.proto

  • CreateMemoCommentRequest

  • CreateMemoCommentResponse

  • CreateMemoRequest

  • CreateMemoResponse

  • GetMemoRequest

  • GetMemoResponse

  • ListMemoCommentsRequest

  • ListMemoCommentsResponse

  • ListMemosRequest

  • ListMemosResponse

  • Memo

  • Visibility

  • MemoService

• api/v2/resource_service.proto

  • CreateResourceRequest

  • CreateResourceResponse

  • DeleteResourceRequest

  • DeleteResourceResponse

  • ListResourcesRequest

  • ListResourcesResponse

  • Resource

  • UpdateResourceRequest

  • UpdateResourceResponse

  • ResourceService

• api/v2/system_service.proto

  • GetSystemInfoRequest

  • GetSystemInfoResponse

  • SystemInfo

  • UpdateSystemInfoRequest

  • UpdateSystemInfoResponse

  • SystemService

• api/v2/tag_service.proto

  • DeleteTagRequest

  • DeleteTagResponse

  • ListTagsRequest

  • ListTagsResponse

  • Tag

  • UpsertTagRequest

  • UpsertTagResponse

  • TagService

• api/v2/user_service.proto

  • CreateUserAccessTokenRequest

  • CreateUserAccessTokenResponse

  • CreateUserRequest

  • CreateUserResponse

  • DeleteUserAccessTokenRequest

  • DeleteUserAccessTokenResponse

  • GetUserRequest

  • GetUserResponse

  • ListUserAccessTokensRequest

  • ListUserAccessTokensResponse

  • UpdateUserRequest

  • UpdateUserResponse

  • User

  • UserAccessToken

  • User.Role

  • UserService

• Scalar Value Types

Top

api/v2/common.proto

RowStatus

Name	Number	Description
ROW_STATUS_UNSPECIFIED	0
ACTIVE	1
ARCHIVED	2

Top

api/v2/memo_service.proto

CreateMemoCommentRequest

Field	Type	Label	Description
id	int32		id is the memo id to create comment for.
create	CreateMemoRequest

CreateMemoCommentResponse

Field	Type	Label	Description
memo	Memo

CreateMemoRequest

Field	Type	Label	Description
content	string
visibility	Visibility

CreateMemoResponse

Field	Type	Label	Description
memo	Memo

GetMemoRequest

Field	Type	Label	Description
id	int32

GetMemoResponse

Field	Type	Label	Description
memo	Memo

ListMemoCommentsRequest

Field	Type	Label	Description
id	int32

ListMemoCommentsResponse

Field	Type	Label	Description
memos	Memo	repeated

ListMemosRequest

Field	Type	Label	Description
page	int32
page_size	int32
filter	string		Filter is used to filter memos returned in the list.

ListMemosResponse

Field	Type	Label	Description
memos	Memo	repeated

Memo

Field	Type	Label	Description
id	int32
row_status	RowStatus
creator_id	int32
created_ts	int64
updated_ts	int64
content	string
visibility	Visibility
pinned	bool

Visibility

Name	Number	Description
VISIBILITY_UNSPECIFIED	0
PRIVATE	1
PROTECTED	2
PUBLIC	3

MemoService

Method Name	Request Type	Response Type	Description
CreateMemo	CreateMemoRequest	CreateMemoResponse
ListMemos	ListMemosRequest	ListMemosResponse
GetMemo	GetMemoRequest	GetMemoResponse
CreateMemoComment	CreateMemoCommentRequest	CreateMemoCommentResponse
ListMemoComments	ListMemoCommentsRequest	ListMemoCommentsResponse

Top

api/v2/resource_service.proto

CreateResourceRequest

Field	Type	Label	Description
filename	string
external_link	string
type	string
memo_id	int32	optional

CreateResourceResponse

Field	Type	Label	Description
resource	Resource

DeleteResourceRequest

Field	Type	Label	Description
id	int32

DeleteResourceResponse

ListResourcesRequest

ListResourcesResponse

Field	Type	Label	Description
resources	Resource	repeated

Resource

Field	Type	Label	Description
id	int32
created_ts	google.protobuf.Timestamp
filename	string
external_link	string
type	string
size	int64
memo_id	int32	optional

UpdateResourceRequest

Field	Type	Label	Description
id	int32
resource	Resource
update_mask	string	repeated

UpdateResourceResponse

Field	Type	Label	Description
resource	Resource

ResourceService

Method Name	Request Type	Response Type	Description
CreateResource	CreateResourceRequest	CreateResourceResponse
ListResources	ListResourcesRequest	ListResourcesResponse
UpdateResource	UpdateResourceRequest	UpdateResourceResponse
DeleteResource	DeleteResourceRequest	DeleteResourceResponse

Top

api/v2/system_service.proto

GetSystemInfoRequest

GetSystemInfoResponse

Field	Type	Label	Description
system_info	SystemInfo

SystemInfo

Field	Type	Label	Description
version	string
mode	string
allow_registration	bool
disable_password_login	bool
additional_script	string
additional_style	string
db_size	int64

UpdateSystemInfoRequest

Field	Type	Label	Description
system_info	SystemInfo		System info is the updated data.
update_mask	string	repeated	Update mask is the array of paths.

UpdateSystemInfoResponse

Field	Type	Label	Description
system_info	SystemInfo

SystemService

Method Name	Request Type	Response Type	Description
GetSystemInfo	GetSystemInfoRequest	GetSystemInfoResponse
UpdateSystemInfo	UpdateSystemInfoRequest	UpdateSystemInfoResponse

Top

api/v2/tag_service.proto

DeleteTagRequest

Field	Type	Label	Description
tag	Tag

DeleteTagResponse

ListTagsRequest

Field	Type	Label	Description
creator_id	int32

ListTagsResponse

Field	Type	Label	Description
tags	Tag	repeated

Tag

Field	Type	Label	Description
name	string
creator_id	int32

UpsertTagRequest

Field	Type	Label	Description
name	string

UpsertTagResponse

Field	Type	Label	Description
tag	Tag

TagService

Method Name	Request Type	Response Type	Description
UpsertTag	UpsertTagRequest	UpsertTagResponse
ListTags	ListTagsRequest	ListTagsResponse
DeleteTag	DeleteTagRequest	DeleteTagResponse

Top

api/v2/user_service.proto

CreateUserAccessTokenRequest

Field	Type	Label	Description
username	string
description	string
expires_at	google.protobuf.Timestamp	optional

CreateUserAccessTokenResponse

Field	Type	Label	Description
access_token	UserAccessToken

CreateUserRequest

Field	Type	Label	Description
user	User

CreateUserResponse

Field	Type	Label	Description
user	User

DeleteUserAccessTokenRequest

Field	Type	Label	Description
username	string
access_token	string		access_token is the access token to delete.

DeleteUserAccessTokenResponse

GetUserRequest

Field	Type	Label	Description
username	string

GetUserResponse

Field	Type	Label	Description
user	User

ListUserAccessTokensRequest

Field	Type	Label	Description
username	string

ListUserAccessTokensResponse

Field	Type	Label	Description
access_tokens	UserAccessToken	repeated

UpdateUserRequest

Field	Type	Label	Description
user	User
update_mask	google.protobuf.FieldMask

UpdateUserResponse

Field	Type	Label	Description
user	User

User

Field	Type	Label	Description
id	int32
username	string
role	User.Role
email	string
nickname	string
avatar_url	string
password	string
row_status	RowStatus
create_time	google.protobuf.Timestamp
update_time	google.protobuf.Timestamp

UserAccessToken

Field	Type	Label	Description
access_token	string
description	string
issued_at	google.protobuf.Timestamp
expires_at	google.protobuf.Timestamp

User.Role

Name	Number	Description
ROLE_UNSPECIFIED	0
HOST	1
ADMIN	2
USER	3

UserService

Method Name	Request Type	Response Type	Description
GetUser	GetUserRequest	GetUserResponse
CreateUser	CreateUserRequest	CreateUserResponse
UpdateUser	UpdateUserRequest	UpdateUserResponse
ListUserAccessTokens	ListUserAccessTokensRequest	ListUserAccessTokensResponse	ListUserAccessTokens returns a list of access tokens for a user.
CreateUserAccessToken	CreateUserAccessTokenRequest	CreateUserAccessTokenResponse	CreateUserAccessToken creates a new access token for a user.
DeleteUserAccessToken	DeleteUserAccessTokenRequest	DeleteUserAccessTokenResponse	DeleteUserAccessToken deletes an access token for a user.

Scalar Value Types

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	float	float	Float
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)
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
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
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)
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
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)
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
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)