Issues

Mark a comment as guidance

Makes a person's comment guidance, advice agents weigh, or stops it being guidance. People only; an agent's comment can never be guidance.

patch/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

guidanceboolean required

Whether the comment is guidance, which agents weigh as advice.

Response

Comment updated

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.