Expand all
resource_type
string
required
The kind of Resource that a Comment belongs to. Should be one of [elasticsearch, kibana, apm, appsearch, enterprise_search, integrations_server, allocator, constructor, runner, proxy].
resource_id
string
required
Id of the Resource that a Comment belongs to.
version
string
If specified then checks for conflicts against the version stored in the persistent store (returned in 'x-cloud-resource-version' of the GET request)
{
}
The Comment update data.
message
string
required
The message for the Comment.
200
Comment updated successfully.
application/json
id
string
required
The id of this Comment
user_id
string
required
The user id of the user who wrote this Comment
message
string
required
The message content of this Comment
401
The Comment does not belong to you. (code: comments.unauthorised)
Your current session does not have a user id associated with it. (code: comments.no_user_id)
application/json
errors
object []
required
A list of errors that occurred in the failing request
−
Hide 3 properties
code
string
required
A structured code representing the error type that occurred
message
string
required
A human readable message describing the error that occurred
fields
string []
If the error can be tied to a specific field or fields in the user request, this lists those fields
404
The Comment you want does not exist. (code: comments.comment_does_not_exist)
application/json
errors
object []
required
A list of errors that occurred in the failing request
−
Hide 3 properties
code
string
required
A structured code representing the error type that occurred
message
string
required
A human readable message describing the error that occurred
fields
string []
If the error can be tied to a specific field or fields in the user request, this lists those fields
409
The version you sent does not match the persisted version. (code: comments.version_conflict)
application/json
errors
object []
required
A list of errors that occurred in the failing request
−
Hide 3 properties
code
string
required
A structured code representing the error type that occurred
message
string
required
A human readable message describing the error that occurred
fields
string []
If the error can be tied to a specific field or fields in the user request, this lists those fields
Thank you for your feedback.