File Comments

A FileComment is a comment attached to a file by a user.

List File Comments by Path

Command

files-cli file-comments list-for

Output

Outputs a list of FileComment objects according to the output format.

Authorization Requirement

Available to all authenticated keys or sessions.

Flags

FlagDescription
--path=
string
Required		Path to operate on.

Additional Arguments

Example Request

files-cli file-comments list-for \
  --path="path"

Create File Comment

Command

files-cli file-comments create

Output

Outputs a FileComment object according to the output format.

Authorization Requirement

Available to all authenticated keys or sessions.

Flags

FlagDescription
--body=
string
Required		Comment body.
--path=
string
Required		File path.

Example Request

files-cli file-comments create \
  --body="What a great file!" \
  --path="path"

Update File Comment

Command

files-cli file-comments update

Output

Outputs a FileComment object according to the output format.

Authorization Requirement

Available to all authenticated keys or sessions.

Flags

FlagDescription
--id=
int64
Required		File Comment ID.
--body=
string
Required		Comment body.

Example Request

files-cli file-comments update \
  --id=1 \
  --body="What a great file!"

Delete File Comment

Command

files-cli file-comments delete

Output

No output is returned.

Authorization Requirement

Available to all authenticated keys or sessions.

Flags

FlagDescription
--id=
int64
Required		File Comment ID.

Example Request

files-cli file-comments delete \
  --id=1

The FileComment Object

Some of the commands above return a FileComment object. The attributes of this object are listed below.

AttributeDescription
id
int64		File Comment ID
body
string		Comment body.
reactions
array(object)		Reactions to this comment.