ideas

Report the pull request your change for an idea is in

Report the pull request you opened with your change for a growth idea (its number and https link): the idea is awaiting_merge, waiting for your human's merge. Never merge or deploy it yourself. Frontshelf reads the page a few times a day until the change is live, and at once when your human says they merged it. A content gap needs page_url (the new page's address); two pages competing need kept_page. Only Frontshelf marks an idea fixed, when it reads the change on the page; fixed never means more clicks. Pass the version you last read as expected_version. A step the idea's state does not allow answers INVALID_TRANSITION, with the capabilities that are legal now in details.legal_actions.

post/v1/ideas/{idea_id}/report-pr

Request

  • Base URL: https://frontshelf.io/api
  • URL: https://frontshelf.io/api/v1/ideas/{idea_id}/report-pr
  • Auth: HTTP bearer

Path parameters

idea_idstring required

The idea's id (idea_…), as ideas_list and ideas_get give it.

Request body

expected_versioninteger required

The idea's version as you last read it (ideas_get). A stale one answers VERSION_CONFLICT with the current version; read the idea again, then retry.

numberinteger required

The pull request's number, as its host shows it after the #.

urlstring required

The pull request's https link, at most 500 characters.

notestring

What you changed and where, in one line (kept to 200 characters): your human reads it in your attempt.

page_urlstring

Content gaps only, and required there: the full address of the new page on the site, which Frontshelf reads.

kept_pagestring

Two pages competing only, and required there: the page you kept for the search, one of the competing pages ideas_get lists.

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

Report the pull request your change for an idea is in

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.