Design rule save

POST/v1/design/rules

Signed-in sessionLaunch key product.designOperation design_rule_save

An internal tool for the components agents build and the rules they follow.

Body

projectIdstring
scopeKind"base" | "component" | "family" | "organization" | "project"
expectedAuthorizationVersionstring
familyKeystring
componentIdstring
examplesstring[]
antiExamplesstring[]
changeSetstring
changeSummarystring
kind"accessibility" | "functional" | "principle" | "taste"Required
textstringRequired
idempotencyKeystringRequired

Returns

ruleobjectRequired
changestringRequired

Errors

400, 401, 403, 404, 409, 429 and 503 return {"error": {"code", "message", "correlationId"}}.

curl "$SPECIFY_API_ORIGIN/v1/design/rules" \ -X POST \ -H "Authorization: Bearer $SPECIFY_SESSION_TOKEN" \ -H "X-Specify-Account-Id: <accountId>" \ -H "X-Specify-Service-Tenancy-Id: <serviceTenancyId>" \ -H "Content-Type: application/json" \ -d '{"kind":"accessibility","text":"<text>","idempotencyKey":"retry-1"}'

{ "result": { "rule": { "text": "<text>", "kind": "accessibility", "scope": { "kind": "base" }, "scopeLabel": "<scopeLabel>", "examples": [ "<example>" ], "antiExamples": [ "<antiExample>" ], "status": "deleted", "version": 1, "number": 1, "updatedAt": 1, "updatedBy": { "kind": "agent", "name": "<name>" } }, "change": "<change>" } }

Design rule save

Headers

Body

Returns

Errors