ui/client/features/tests/services/StepsApi

The step document's three calls on ui/server's /api/tests (behind the session).

Cockpit client (features), v0.8. Source: ui/client/features/tests/services/StepsApi.ts.

Functions#

fetchSteps()#

fetchSteps(feature, name): Promise<StepDocResult>

Defined in: ui/client/features/tests/services/StepsApi.ts:10

Parameters#

feature

string

name

string

Returns#

Promise<StepDocResult>

---

previewSteps()#

previewSteps(feature, name, baseHash, steps): Promise<StepPreviewResult>

Defined in: ui/client/features/tests/services/StepsApi.ts:20

Validate an edit and get the diff of what would change. Writes nothing.

Parameters#

feature

string

name

string

baseHash

string

steps

StepFields[]

Returns#

Promise<StepPreviewResult>

---

saveSteps()#

saveSteps(feature, name, baseHash, resultSha, steps): Promise<StepSaveResult>

Defined in: ui/client/features/tests/services/StepsApi.ts:30

Write the previewed edit. resultSha is the hash of the diff the user reviewed.

Parameters#

feature

string

name

string

baseHash

string

resultSha

string

steps

StepFields[]

Returns#

Promise<StepSaveResult>