issues

Set an issue aside as a deliberate won't-fix

Set an issue aside as a deliberate won't-fix, with a reason and an expires_at (30 days or 90 days from now, or a date at most 365 days ahead); the issue reopens then. An ignore is shown to your human, undone with issues_unignore, and never counts as fixed. Use it only when the issue is not worth fixing, never to empty the queue; when you fixed it, call issues_report_deployed instead. It asks for confirmation: call it with dry_run: true to see what it would do, then with confirm: true. Pass the version you last read as expected_version. A step the issue's state does not allow answers INVALID_TRANSITION, with the capabilities that are legal now in details.legal_actions.

post/v1/issues/{issue_id}/ignore

Request

  • Base URL: https://frontshelf.io/api
  • URL: https://frontshelf.io/api/v1/issues/{issue_id}/ignore
  • Auth: HTTP bearer

Path parameters

issue_idstring required

The issue's id (iss_…), as issues_list and issues_get give it.

Request body

expected_versioninteger required

The issue's version as you last read it: read the issue with issues_get to get it. A stale one answers STALE_ISSUE_STATE with the current version; read the issue again, then retry.

reasonstring required

Why the issue is not worth fixing, 1 to 200 characters. Your human reads it beside the issue and in the audit log.

expires_atstring date-time required

Required: the ignore lifts itself at this instant (ISO 8601, in the future): 30 days or 90 days from now, or a date at most 365 days ahead. Every ignore ends.

dry_runboolean

true: check the call and say what it would do, without doing it.

confirmboolean

true: go ahead with a change that asks for confirmation.

Response

Set an issue aside as a deliberate won't-fix

summarystring required

The answer in one or two sentences, with the numbers it rests on.

warningsstring[] required

What limits this answer (a cap, a read that was cut short). Empty when nothing does.

Changes

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