--- title: "Update an issue" method: PATCH path: "/v1/issues/{idOrNumber}" tags: ["Issues"] --- # Update an issue `PATCH /v1/issues/{idOrNumber}` ## Request - Base URL: `https://docs.grepr.ai` (the document declares no server; this is the origin it was published from) - URL: `https://docs.grepr.ai/v1/issues/{idOrNumber}` - Auth: one of: - API key in header `GREPR-API-KEY` - OpenID Connect (`https://grepr-prod.us.auth0.com/.well-known/openid-configuration`) Changes the given fields and leaves the rest. A person's change to priority, entities or teams locks that field against agents. A stale version is rejected with the current issue, so the caller can reapply its change. ## Path parameters - `idOrNumber` string, required ## Request body - UpdateIssueRequest: A partial update. An absent field is left unchanged, a present one is set, and an optional field named in `clear` is emptied. State, resolution and `duplicateOf` change only through transitions. - `clear` string[]: Optional fields to empty. - `confidence` 'CONFIRMED' | 'LIKELY' | 'UNVERIFIED': A new confidence. - `description` string: A new description, replacing the old one. - `entities` object: New entity tags, replacing the old ones; a person's change locks them. - `evidence` IssueEvidence[]: New evidence, replacing the old list. - `from` string, date-time: Start of a log query's time range, or null. - `kind` 'LOG_QUERY' | 'EVENT' | 'URL', required: What the evidence points at. - `label` string: A short description of what it shows, or null. - `target` string, required: The Grepr log query for LOG_QUERY, the event id for EVENT, or an http(s) URL for URL. - `to` string, date-time: End of a log query's time range, or null. - `expiresAt` string, date-time: A new expiry. - `fingerprint` string: A new fingerprint. - `labels` string[]: New labels, replacing the old list; a person's additions and removals lock those labels. - `links` IssueLink[]: New links, replacing the old list. - `hidden` boolean, nullable: True for a link to an issue the reader can't see. Set only in responses. - `kind` 'PIPELINE' | 'INVESTIGATION' | 'MEMORY' | 'AGENT_SUGGESTION' | 'EXTERNAL' | 'ISSUE', required: What the link points at. - `label` string: A short description, or null. - `target` string, nullable: Null only for a hidden issue link in a response. - `nextStep` string: A new next step. - `priority` 'P0' | 'P1' | 'P2' | 'P3': A new priority; a person's change locks it against agents. - `revisitAt` string, date-time: A new revisit time. - `teamIds` string[]: New teams; people only, adding or removing only teams they can edit issues of. - `title` string: A new title. - `version` integer, required: The version the change was made against; a stale one is rejected with 409 and the current issue. ## Response `200` Issue updated - Issue: One durable problem or task on the organization's issue board. - `closedAt` string, date-time: When it closed, or null while open. - `confidence` 'CONFIRMED' | 'LIKELY' | 'UNVERIFIED': How sure the reporter is that the problem is real. - `createdAt` string, date-time: When it was filed. - `description` string: The current understanding, in markdown, kept current rather than appended to. - `duplicateOf` string: The surviving issue, set exactly when resolved as `DUPLICATE`; null in a response when the reader can't see the survivor. - `duplicateOfHidden` boolean: True in a response whose reader can't see the surviving issue. - `entities` object: The `entity:*` tags it concerns, the same vocabulary as memory tags, keys in lower case, sorted by key. - `evidence` IssueEvidence[]: Things a person can open to check the claim. - `from` string, date-time: Start of a log query's time range, or null. - `kind` 'LOG_QUERY' | 'EVENT' | 'URL', required: What the evidence points at. - `label` string: A short description of what it shows, or null. - `target` string, required: The Grepr log query for LOG_QUERY, the event id for EVENT, or an http(s) URL for URL. - `to` string, date-time: End of a log query's time range, or null. - `expiresAt` string, date-time: When the issue stops applying and closes as `EXPIRED`, or null. - `fingerprint` string: An optional free-form key for exact-match search, or null. - `firstSeenAt` string, date-time: The first sighting, or null before any. - `id` string: The issue id. - `labels` string[]: Categories, such as `cost`, sorted. - `lastSeenAt` string, date-time: The latest sighting, or when it was filed. - `links` IssueLink[]: Related pipelines, investigations, memories, suggestions and external tickets. - `hidden` boolean, nullable: True for a link to an issue the reader can't see. Set only in responses. - `kind` 'PIPELINE' | 'INVESTIGATION' | 'MEMORY' | 'AGENT_SUGGESTION' | 'EXTERNAL' | 'ISSUE', required: What the link points at. - `label` string: A short description, or null. - `target` string, nullable: Null only for a hidden issue link in a response. - `locks` IssueLocks: The fields and labels people have locked against agent changes. `state` never locks. - `fields` object: The locked fields, each with who locked it and when. - `labels` object: The locked labels, keyed by label. - `nextStep` string: The concrete next action and who it waits on, or null. - `number` integer: The short per-organization handle, shown as `#142`. - `occurrenceCount` integer: How many investigations sighted it. - `priority` 'P0' | 'P1' | 'P2' | 'P3': How soon someone should act. - `regressed` boolean: Whether it reopened on a new sighting after being fixed; cleared on its next close. - `reporter` IssueActor: Who made a change to an issue. An agent is named by its own id and the investigation it acted in, never by the service account it authenticated as, since several agents may share one. - `agentId` string: The agent, for an agent actor; null otherwise. - `id` string: The person's user id, the agent's execution principal (its service account's token subject), or `system` for the server. - `investigationId` string: The investigation the agent acted in, for an agent actor; null otherwise. - `kind` 'PERSON' | 'AGENT' | 'SYSTEM': A person, an agent, or the server. - `resolution` 'FIXED' | 'DUPLICATE' | 'NOT_A_PROBLEM' | 'IGNORED' | 'OBSOLETE' | 'EXPIRED': Why it closed; set exactly when `state` is `CLOSED`. - `revisitAt` string, date-time: When someone should check back, or null. Then a Monitoring issue's watcher is started on it, or, with no watcher, it goes back to `READY`. - `state` 'TRIAGE' | 'READY' | 'IN_PROGRESS' | 'WAITING' | 'MONITORING' | 'CLOSED': Where the issue is in its lifecycle. - `stateChangedAt` string, date-time: When the state last changed. - `teamIds` string[]: The teams that may see the issue, sorted. - `title` string: One line naming the problem. - `updatedAt` string, date-time: When it last changed. - `version` integer: Bumped by every change to a field, the state, an assignment, a lock or the teams. - `watchedBy` string: The agent watching it in `MONITORING`: the one that moved it there, started on it again when a sighting comes in or its revisit time passes. Null outside Monitoring. ## Other responses - `400`: Invalid update, or a field only people may set - `401`: Unauthorized - `403`: No permission to edit the issue - `404`: Issue not found - `409`: Stale version, or a field a person locked --- [API](https://skmtc.dev/grepr/apis/grepr-api.md) - [All operations](https://skmtc.dev/grepr/apis/grepr-api/llms.txt) - [OpenAPI document](https://skmtc.dev/grepr/apis/grepr-api/revisions/2a5ce03a0bf0?raw)