User Stories

Edit a user story

Changed on

Bearer atc:write (or cookie session). Member-only. Title / description / Jira key. The Jira key is immutable once set (409 on change).

patch/api/v1/user-stories/{id}

Request

  • Base URL: http://localhost:3000
  • URL: http://localhost:3000/api/v1/user-stories/{id}
  • Auth: one of:
    • API key in cookie sb-fmbpikzpkafptqximhxn-auth-token
    • HTTP bearer

Path parameters

idstring uuid required

Request body

titlestring

3–200 chars.

descriptionstring nullable

Markdown, up to 50 KB; null clears it.

external_idstring nullable

Jira key, e.g. BK-42. Immutable once set: after a story carries an external_id, ANY differing value returns 409 conflict (details.reason = "external_id_immutable") — including null and an empty string. A set Jira link cannot be cleared or relinked through this endpoint; only re-sending the identical key is accepted, as a no-op. While the story has no link yet, the key must read as LETTERS-NUMBER or the request is 422.

status'draft' | 'ready_to_test'

Ready-to-test gate: moving to ready_to_test with zero active acceptance criteria returns 409 (BK-15).

Response

Updated.

Changes

  • 4528999528c6Revision changes
    • warning

      added the new test_outside_plan_project enum value to the / response property for the response status

    • warning

      added the new test_outside_plan_project enum value to the / response property for the response status

    • warning

      added the new test_outside_plan_project enum value to the / response property for the response status

    • warning

      added the new test_outside_plan_project enum value to the / response property for the response status

    • warning

      added the new test_outside_plan_project enum value to the / response property for the response status

    • warning

      added the new test_outside_plan_project enum value to the / response property for the response status

  • 2ca74ff5fec5Revision changes
    • info

      removed the test_outside_plan_project enum value from the / response property for the response status

    • info

      removed the test_outside_plan_project enum value from the / response property for the response status

    • info

      removed the test_outside_plan_project enum value from the / response property for the response status

    • info

      removed the test_outside_plan_project enum value from the / response property for the response status

    • info

      removed the test_outside_plan_project enum value from the / response property for the response status

    • info

      removed the test_outside_plan_project enum value from the / response property for the response status