issues

Say you are looking at an issue

Mark an issue as being looked at: open, verification_failed and regression_detected become acknowledged. It claims nothing about a fix; it tells your human someone is on it, and opens your attempt on the issue (attempt), keeping the work order as it is now. 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. Next: read the work order with issues_get, fix the issue in the code, then hand it over as its agent_contract says: open a pull request and call issues_report_pr, or deploy and call issues_report_deployed.

post/v1/issues/{issue_id}/acknowledge

Request

  • Base URL: https://frontshelf.io/api
  • URL: https://frontshelf.io/api/v1/issues/{issue_id}/acknowledge
  • 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.

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

Say you are looking at an issue

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.