Requirements

List requirements

Changed on

List requirements in the current project, newest first. Requires requirement:view. Each item includes the linked test IDs (testIds) and tag names (tagNames) so clients do not need a per-row detail request. The response also repeats the items under requirements for backward compatibility.

get/api/requirements

Request

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

Query parameters

pageinteger

Page number. Out-of-range values are clamped.

pageSizeinteger

Items per page. Values outside 1..500 are clamped; the default is 500.

searchstring

Match against title or description (substring).

priority'low' | 'medium' | 'high'

Filter by priority.

status'covered' | 'failing' | 'missing'

Filter by coverage status. Requirements with no computed coverage count as missing.

Response

Requirements page

totalinteger
pageinteger
pageSizeinteger

Changes

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      endpoint added