ui/client/features/rules/services/RulesApi
Reuses /api/validate (ui/server/src/validateApi.mjs) exactly as the Diagnostics tab does — the Rules composer does not reinvent validation (docs/design/rules-envelopes.md section 0), it only reads body.summary, th...
Cockpit client (features), next. Source: ui/client/features/rules/services/RulesApi.ts.
Type Aliases#
ExceptionsResult#
ExceptionsResult = {
ok:true;rows:ExceptionRow[]; } | {error:string;ok:false; }
Defined in: ui/client/features/rules/services/RulesApi.ts:63
GlobListResult#
GlobListResult = {
ok:true;rows:string[]; } | {error:string;ok:false; }
Defined in: ui/client/features/rules/services/RulesApi.ts:112
PresetDiff#
PresetDiff = {
after:string;before:string;changes:PresetChange[];contentHash:string;ok:true; } | {error:string;ok:false; }
Defined in: ui/client/features/rules/services/RulesApi.ts:202
ProjectSettingsResult#
ProjectSettingsResult = {
ok:true;value:ProjectSettings; } | {error:string;ok:false; }
Defined in: ui/client/features/rules/services/RulesApi.ts:157
RuleSeverityDiff#
RuleSeverityDiff = {
after:string;before:string;contentHash:string;ok:true; } | {error:string;ok:false; }
Defined in: ui/client/features/rules/services/RulesApi.ts:29
RuleSeveritySaved#
RuleSeveritySaved = {
ok:true; } | {error:string;ok:false; }
Defined in: ui/client/features/rules/services/RulesApi.ts:30
RulesResult#
RulesResult = {
ok:true;rows:RuleRow[]; } | {error:string;ok:false; }
Defined in: ui/client/features/rules/services/RulesApi.ts:7
Functions#
fetchExceptions()#
fetchExceptions():
Promise<ExceptionsResult>
Defined in: ui/client/features/rules/services/RulesApi.ts:66
Every exception in the project's architecture.yml (GET /api/rules, ui/server/src/rulesApi.mjs).
Returns#
Promise<ExceptionsResult>
fetchGlobs()#
fetchGlobs(
field):Promise<GlobListResult>
Defined in: ui/client/features/rules/services/RulesApi.ts:115
field's glob list from the current project's architecture.yml (GET /api/rules).
Parameters#
field
Returns#
Promise<GlobListResult>
fetchProjectSettings()#
fetchProjectSettings():
Promise<ProjectSettingsResult>
Defined in: ui/client/features/rules/services/RulesApi.ts:160
The current project's framework and features.root (GET /api/rules, body.project).
Returns#
Promise<ProjectSettingsResult>
fetchRules()#
fetchRules():
Promise<RulesResult>
Defined in: ui/client/features/rules/services/RulesApi.ts:15
Every rule for the current project, with its severity, plain-words "why" and live violation count.
Returns#
Promise<RulesResult>
previewException()#
previewException(
action,input):Promise<RuleSeverityDiff>
Defined in: ui/client/features/rules/services/RulesApi.ts:87
The diff adding or removing one exception would make, computed but not written (commit: false).
Parameters#
action
"add" | "remove"
input
number | NewException
Returns#
Promise<RuleSeverityDiff>
previewGlob()#
previewGlob(
field,action,input):Promise<RuleSeverityDiff>
Defined in: ui/client/features/rules/services/RulesApi.ts:132
The diff adding or removing one glob would make, computed but not written (commit: false).
Parameters#
field
action
"add" | "remove"
input
string | number
Returns#
Promise<RuleSeverityDiff>
previewPreset()#
previewPreset(
preset):Promise<PresetDiff>
Defined in: ui/client/features/rules/services/RulesApi.ts:207
The per-rule severity diff switching to preset would make, computed but not written (commit: false).
Parameters#
preset
string
Returns#
Promise<PresetDiff>
previewProjectSetting()#
previewProjectSetting(
field,value):Promise<RuleSeverityDiff>
Defined in: ui/client/features/rules/services/RulesApi.ts:177
The diff changing one project setting would make, computed but not written (commit: false).
Parameters#
field
value
string
Returns#
Promise<RuleSeverityDiff>
previewRuleSeverity()#
previewRuleSeverity(
ruleId,severity):Promise<RuleSeverityDiff>
Defined in: ui/client/features/rules/services/RulesApi.ts:36
slice B -- the diff a severity change would make to architecture.yml, computed but not written
(POST /api/rules/severity with commit: false).
Parameters#
ruleId
string
severity
Returns#
Promise<RuleSeverityDiff>
saveException()#
saveException(
action,input,contentHash):Promise<RuleSeveritySaved>
Defined in: ui/client/features/rules/services/RulesApi.ts:100
Commits an add/remove previewed via previewException; same staleness guard as saveRuleSeverity.
Parameters#
action
"add" | "remove"
input
number | NewException
contentHash
string
Returns#
Promise<RuleSeveritySaved>
saveGlob()#
saveGlob(
field,action,input,contentHash):Promise<RuleSeveritySaved>
Defined in: ui/client/features/rules/services/RulesApi.ts:145
Commits an add/remove previewed via previewGlob; same staleness guard as saveRuleSeverity.
Parameters#
field
action
"add" | "remove"
input
string | number
contentHash
string
Returns#
Promise<RuleSeveritySaved>
savePreset()#
savePreset(
preset,contentHash):Promise<RuleSeveritySaved>
Defined in: ui/client/features/rules/services/RulesApi.ts:220
Commits a preset switch previewed via previewPreset; same staleness guard as saveRuleSeverity.
Parameters#
preset
string
contentHash
string
Returns#
Promise<RuleSeveritySaved>
saveProjectSetting()#
saveProjectSetting(
field,value,contentHash):Promise<RuleSeveritySaved>
Defined in: ui/client/features/rules/services/RulesApi.ts:190
Commits a setting change previewed via previewProjectSetting; same staleness guard as saveRuleSeverity.
Parameters#
field
value
string
contentHash
string
Returns#
Promise<RuleSeveritySaved>
saveRuleSeverity()#
saveRuleSeverity(
ruleId,severity,contentHash):Promise<RuleSeveritySaved>
Defined in: ui/client/features/rules/services/RulesApi.ts:51
Commits a severity change previewed via previewRuleSeverity; contentHash is the one that preview returned, so
a change to architecture.yml on disk in between (another tab, the CLI, an agent) is refused (409) instead of
silently overwritten.
Parameters#
ruleId
string
severity
contentHash
string
Returns#
Promise<RuleSeveritySaved>