Link Canonical To Suite — POST /api/v1/canonical-test-cases/{canonical_id}/link
Link Canonical To Suite
Move a canonical test case to a different suite within the same project. Refuses cross-project moves (different project’s suites are isolated by design).
Endpoint: POST /api/v1/canonical-test-cases/{canonical_id}/link
Authentication: Send a signed-in user’s access token in Authorization: Bearer <access token>, or an API key in X-API-Key: <API key>.
- A minimum role applies. The source code names it.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Default | Description |
|---|---|---|---|---|---|
canonical_id | path | yes | string (uuid) | ||
X-API-Key | header | no | string or null | API key, as an alternative to the access token (see Authentication). |
Request body
Section titled “Request body”| Content type | Body | Required |
|---|---|---|
application/json | CanonicalTestCaseLinkRequest | yes |
Responses
Section titled “Responses”| Status | Meaning | Body |
|---|---|---|
200 | Successful Response | CanonicalTestCaseResponse (application/json) |
422 | Validation Error | HTTPValidationError (application/json) |
It can also return 401 if your credential is missing or expired, 403 if your credential does not allow this request, and 404 if the item does not exist or you cannot see it. Your role, your project membership and the key’s scope decide what a credential allows. See Errors and retries.
More details
Section titled “More details”- Group: Test Suites
- Operation ID:
link_canonical_to_suite_api_v1_canonical_test_cases__canonical_id__link_post - Source code:
backend/app/routers/suites.py, line 575 - Specification: OpenAPI JSON