Execution

Create an engineering rule

Creates a workspace-scoped engineering rule. Deactivate or update it through the id-specific endpoint; rules are never deleted from the engineering history.

post/api/v1/engineering-rules

Request

  • Base URL: https://www.specky.space
  • URL: https://www.specky.space/api/v1/engineering-rules
  • Auth: HTTP bearer

Request body

statementstring required

Rule statement. Start with MUST, SHOULD, or MAY when possible.

level'mandatory' | 'recommended' | 'optional'
collectionstring
tagsstring[]
languagesstring[]
frameworksstring[]
keywordsstring[]
must_include_filesstring[]
must_not_include_filesstring[]
provenancestring
enabledboolean

Response

Successful response. Always includes summary (string) and ok: true; mutating endpoints additionally include the created resource id under a tool-specific key.

oktrue
summarystring

Human-readable result text.

Changes

No recorded changes to this operation across all 1 revision of this API.