Path parameters

• 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.

• comment_id string Required

  Id of a Comment

Query parameters

• 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)

Responses

• 200 application/json

  Comment updated successfully.

  Hide headers attributes Show headers attributes

  • x-cloud-resource-version string

    The resource version, which is used to avoid update conflicts with concurrent operations

  • x-cloud-resource-created string

    The date-time when the resource was created (ISO format relative to UTC)

  • x-cloud-resource-last-modified string

    The date-time when the resource was last modified (ISO format relative to UTC)

  Hide response attributes Show response attributes object

  • 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 application/json
  • 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)
  Hide headers attribute Show headers attribute

  • x-cloud-error-codes string

    The error codes associated with the response

    Values are comments.unauthorised or comments.no_user_id.

  Hide response attribute Show response attribute object

  • errors array[object] Required

    A list of errors that occurred in the failing request

    Hide errors attributes Show errors attributes object

    • 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 array[string]

      If the error can be tied to a specific field or fields in the user request, this lists those fields

• 404 application/json

  The Comment you want does not exist. (code: comments.comment_does_not_exist)

  Hide headers attribute Show headers attribute

  • x-cloud-error-codes string

    The error codes associated with the response

    Value is comments.comment_does_not_exist.

  Hide response attribute Show response attribute object

  • errors array[object] Required

    A list of errors that occurred in the failing request

    Hide errors attributes Show errors attributes object

    • 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 array[string]

      If the error can be tied to a specific field or fields in the user request, this lists those fields

• 409 application/json

  The version you sent does not match the persisted version. (code: comments.version_conflict)

  Hide headers attribute Show headers attribute

  • x-cloud-error-codes string

    The error codes associated with the response

    Value is comments.version_conflict.

  Hide response attribute Show response attribute object

  • errors array[object] Required

    A list of errors that occurred in the failing request

    Hide errors attributes Show errors attributes object

    • 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 array[string]

      If the error can be tied to a specific field or fields in the user request, this lists those fields