moredoc/docs/api/comment.md

Protocol Documentation

Table of Contents

• api/v1/comment.proto

  • CheckCommentRequest

  • Comment

  • CreateCommentRequest

  • DeleteCommentRequest

  • GetCommentRequest

  • ListCommentReply

  • ListCommentRequest

  • CommentAPI

• Scalar Value Types

Top

api/v1/comment.proto

CheckCommentRequest

Field	Type	Label	Description
id	int64	repeated
status	int32

Comment

Field	Type	Label	Description
created_at	google.protobuf.Timestamp
updated_at	google.protobuf.Timestamp
id	int64
parent_id	int64
content	string
document_id	int64
status	int32
comment_count	int32
user_id	int64
user	User
document_title	string

CreateCommentRequest

Field	Type	Label	Description
document_id	int64
parent_id	int64
content	string
captcha_id	string
captcha	string

DeleteCommentRequest

Field	Type	Label	Description
id	int64	repeated

GetCommentRequest

Field	Type	Label	Description
id	int64

ListCommentReply

Field	Type	Label	Description
total	int64
comment	Comment	repeated

ListCommentRequest

Field	Type	Label	Description
page	int64
size	int64
wd	string
field	string	repeated
order	string
status	int32	repeated
document_id	int64
user_id	int64
parent_id	int64	repeated
with_document_title	bool

CommentAPI

Method Name	Request Type	Response Type	Description
CreateComment	CreateCommentRequest	.google.protobuf.Empty
UpdateComment	Comment	.google.protobuf.Empty	更新评论，仅限管理员操作
DeleteComment	DeleteCommentRequest	.google.protobuf.Empty	管理员或用户自己删除自己的评论
GetComment	GetCommentRequest	Comment	获取单个评论
ListComment	ListCommentRequest	ListCommentReply	获取评论列表
CheckComment	CheckCommentRequest	.google.protobuf.Empty	审核评论

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)