Requirements

Create a requirement

Changed on

Create a requirement, optionally with tags (by name) and linked tests. Requires requirement:create. Unknown body fields are rejected with 400. Linked tests are checked before anything is written, so a failed request leaves nothing behind.

post/api/requirements

Request

  • Base URL
    https://demo.supercheck.dev
  • Auth
    HTTP bearer

Request body

titlestring required
descriptionstring nullable
priority'low' | 'medium' | 'high' nullable
tagsstring[]

Tag names. Matched case-insensitively; missing tags are created. Duplicates (ignoring case) are collapsed. On update, replaces the whole tag set.

externalIdstring nullable
externalUrlstring nullable

http or https URL. An empty string is treated as no URL.

testIdsstring[]

Tests to link. Must belong to the current project. On update, replaces the whole set of linked tests.

Example request

{
  "title": "Users can reset their password"
}

Response

Created requirement

Changes