SpecifyDocs

Update design rule

/v1/design/rules/{id}

Signed-in sessionLaunch key product.designOperation design_rule_update

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

Path parameters

idstringRequired

Body

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

Returns

ruleobjectRequired
changestringRequired

Errors

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