GRgrepr
Issues

Update an issue

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.

patch/v1/issues/{idOrNumber}

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

Request body

clearstring[]

Optional fields to empty.

confidence'CONFIRMED' | 'LIKELY' | 'UNVERIFIED'

A new confidence.

descriptionstring

A new description, replacing the old one.

entitiesobject

New entity tags, replacing the old ones; a person's change locks them.

expiresAtstring date-time

A new expiry.

fingerprintstring

A new fingerprint.

labelsstring[]

New labels, replacing the old list; a person's additions and removals lock those labels.

nextStepstring

A new next step.

priority'P0' | 'P1' | 'P2' | 'P3'

A new priority; a person's change locks it against agents.

revisitAtstring date-time

A new revisit time.

teamIdsstring[]

New teams; people only, adding or removing only teams they can edit issues of.

titlestring

A new title.

versioninteger required

The version the change was made against; a stale one is rejected with 409 and the current issue.

Response

Issue updated

closedAtstring date-time

When it closed, or null while open.

confidence'CONFIRMED' | 'LIKELY' | 'UNVERIFIED'

How sure the reporter is that the problem is real.

createdAtstring date-time

When it was filed.

descriptionstring

The current understanding, in markdown, kept current rather than appended to.

duplicateOfstring

The surviving issue, set exactly when resolved as DUPLICATE; null in a response when the reader can't see the survivor.

duplicateOfHiddenboolean

True in a response whose reader can't see the surviving issue.

entitiesobject

The entity:* tags it concerns, the same vocabulary as memory tags, keys in lower case, sorted by key.

expiresAtstring date-time

When the issue stops applying and closes as EXPIRED, or null.

fingerprintstring

An optional free-form key for exact-match search, or null.

firstSeenAtstring date-time

The first sighting, or null before any.

idstring

The issue id.

labelsstring[]

Categories, such as cost, sorted.

lastSeenAtstring date-time

The latest sighting, or when it was filed.

nextStepstring

The concrete next action and who it waits on, or null.

numberinteger

The short per-organization handle, shown as #142.

occurrenceCountinteger

How many investigations sighted it.

priority'P0' | 'P1' | 'P2' | 'P3'

How soon someone should act.

regressedboolean

Whether it reopened on a new sighting after being fixed; cleared on its next close.

resolution'FIXED' | 'DUPLICATE' | 'NOT_A_PROBLEM' | 'IGNORED' | 'OBSOLETE' | 'EXPIRED'

Why it closed; set exactly when state is CLOSED.

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

stateChangedAtstring date-time

When the state last changed.

teamIdsstring[]

The teams that may see the issue, sorted.

titlestring

One line naming the problem.

updatedAtstring date-time

When it last changed.

versioninteger

Bumped by every change to a field, the state, an assignment, a lock or the teams.

watchedBystring

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.

Changes

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