ui/client/features/requirement/services/ProofApi

The proof of a generated screen over ui/server's POST /api/requirement/proof/{status,run,skip}.

Cockpit client (features), next. Source: ui/client/features/requirement/services/ProofApi.ts.

Functions#

proofStatusOnServer()#

proofStatusOnServer(feature, plan): Promise<ApiResult<ProofStatusReply>>

Defined in: ui/client/features/requirement/services/ProofApi.ts:24

Is the plan applied (its proof file is in the project)? The options are the closed ones of a proof that has not run.

Parameters#

feature

string

plan

PlanDoc

Returns#

Promise<ApiResult<ProofStatusReply>>

---

runProofOnServer()#

runProofOnServer(feature, plan): Promise<ApiResult<ProofRun> & object>

Defined in: ui/client/features/requirement/services/ProofApi.ts:30

Run the proof. A refusal (NOT_APPLIED, RUN_IN_PROGRESS) comes back as the error with its code.

Parameters#

feature

string

plan

PlanDoc

Returns#

Promise<ApiResult<ProofRun> & object>

---

skipProofOnServer()#

skipProofOnServer(feature, plan, reason): Promise<ApiResult<{ reason: string; }>>

Defined in: ui/client/features/requirement/services/ProofApi.ts:37

Skip the proof, with a reason the server records.

Parameters#

feature

string

plan

PlanDoc

reason

string

Returns#

Promise<ApiResult<{ reason: string; }>>