Feedback

Apply suggested edits: swap in the exact wording reviewers proposed, as text, and resolve them.

Owner only. Each suggested edit (a feedback item with suggested_text) is applied only inside the element it was left in, only when its words occur there exactly once, and escaped as plain text. The page keeps its URL and the content it had is kept as a version first (GET /sites/{idOrSlug}/versions), so the returned version id restores it. Suggestions that cannot be applied come back in not_applied with a reason, and the rest are applied anyway. Retrying the same ids changes nothing more: the first call resolved them. On a page with several files only suggestions on its main page (index.html) are applied.

post/sites/{idOrSlug}/feedback/apply

Request

  • Base URL: https://api.stacktr.ee
  • URL: https://api.stacktr.ee/sites/{idOrSlug}/feedback/apply
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.stacktr.ee/oauth/authorize, token URL https://api.stacktr.ee/oauth/token, scopes: sites:write, sites:read)

Request body

idsstring[] required

Feedback ids of the suggested edits to apply.

notestring

What each reviewer sees next to their applied suggestion. Default "Applied as suggested."

change_notestring

A sentence on what changed, for readers coming back to the page (the same field PUT takes).

quietboolean

A correction readers should not be told about (the same field PUT takes).

expected_updated_atinteger

Refuse with 409 content_changed if the page was updated after this.

Response

Applied what could be applied. Nothing is written when nothing applies.

okboolean
idstring
urlstring
versionstring nullable

The snapshot of the page before this change: POST /sites/{idOrSlug}/versions/{version}/restore undoes it.

updated_atinteger nullable
open_leftinteger
nextstring

Changes

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