findings

Set some of an issue's findings aside

Set some of an issue's findings aside as deliberate won't-fixes, by url_hash, with a reason and an expires_at (30 days or 90 days from now, or a date at most 365 days ahead). A finding is one page the issue's rule fired on; the issue is the group. The issue's own state and version do not move: the count beside it does (open = affected - ignored). An ignored finding still counts as affected, is shown to your human, is undone with findings_unignore, and never counts as fixed. Hashes that are not findings of the issue's last crawl, or already ignored, are refused by name; the rest apply. It asks for confirmation: call it with dry_run: true to see what it would do, then with confirm: true. To set the whole issue aside, use issues_ignore.

post/v1/issues/{issue_id}/findings/ignore

Request

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

Path parameters

issue_idstring required

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

Request body

url_hashesstring[] required

The findings, by url_hash (findings_list names them), 1 to 200. Each must be a finding of the issue in the crawl that last saw it; any other is refused by name and the rest apply.

reasonstring required

Why these pages are not worth fixing, 1 to 200 characters. Your human reads it.

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 some of an issue's findings aside

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.

crawl_seqinteger required

The crawl the hashes were checked against: the one that last saw the issue.

ignoredinteger required

Findings set aside by this call.

Changes

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