articles

Say where a finished article is live on the site

Say where a finished article is live, once the page is public on the production site: Frontshelf records the address and lists the article as live. It is your claim, not a check: call it after the deploy, never for a pull request still waiting for its merge. Nothing is fetched now; Frontshelf's crawl reads the page later. url is the article's own page (never the home page): https when the site is, on the site's host or one under it, at the site's port. The same address again changes nothing (recorded: false); a new one replaces it (the article moved). A sample cannot be reported. If Frontshelf's WordPress publishing of it has not called the site yet, the report stops it, so the site has it once; once WordPress is posting it, the report is INVALID_TRANSITION, records nothing, and says what to tell your human. dry_run: true says what it would do.

post/v1/sites/{site}/articles/{article_id}/report-live

Request

  • Base URL: https://frontshelf.io/api
  • URL: https://frontshelf.io/api/v1/sites/{site}/articles/{article_id}/report-live
  • Auth: HTTP bearer

Path parameters

sitestring required

Site ID (site_…), origin (https://example.com), or bare domain, resolved server-side; the response carries the canonical ID.

article_idstring required

A finished article's id (cart_…), from articles_list.

Request body

urlstring required

The full address of the article's page: https when the site is, on the site's own host or a host under it, at the site's port, never the home page.

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 where a finished article is live on the site

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.

site_idstring required

The site's canonical id.

article_idstring required
recordedboolean required

False: this address was already on record, and nothing changed.

previous_urlstring nullable required

The address on record before this call; null for the first report.

Changes

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