Issues

Edit a comment

Replaces the body of a comment the caller wrote. People only. The history keeps the old text; editing a guidance comment changes the issue's version.

put/v1/issues/{idOrNumber}/comments/{commentId}

Request

  • Base URL
    https://docs.grepr.ai (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header GREPR-API-KEY
    • or OpenID Connect (https://grepr-prod.us.auth0.com/.well-known/openid-configuration)

Path parameters

idOrNumberstring required
commentIdstring required

Request body

bodystring required

The new markdown body.

versioninteger

The version the edit was written against; a stale one is rejected with 409 and the current issue. Null edits against whatever is current.

Response

Comment edited

bodystring

The markdown body.

channel'REST' | 'MCP' | 'SYSTEM'

How a change reached the server.

createdAtstring date-time

When it was written.

editedAtstring date-time

When its author last changed the body, or null.

guidanceboolean

Whether it is guidance, which agents weigh as advice.

guidanceSetAtstring date-time

When it was marked guidance, or null.

guidanceSetBystring

The user id of the person who marked it guidance, or null.

idstring

The comment id.

issueIdstring

The issue it is on.

lockedFieldProposalstring

The locked field the comment proposes changing, as named in a FIELD_LOCKED error (priority, label:cost), or null.

Changes

No recorded changes to this operation across all 1 revision of this API.