From 7c8a114994baa767f48a80650a2ea7c25f2d710b Mon Sep 17 00:00:00 2001 From: Panagiotis Vretanos Date: Mon, 4 Mar 2024 02:52:10 -0500 Subject: [PATCH] Clarify what happens to a job when dismissed. --- .../dismiss/REQ_job-dismiss-status.adoc | 18 ++++++++++++++++++ core/sections/clause_14_dismiss.adoc | 3 ++- 2 files changed, 20 insertions(+), 1 deletion(-) create mode 100644 core/requirements/dismiss/REQ_job-dismiss-status.adoc diff --git a/core/requirements/dismiss/REQ_job-dismiss-status.adoc b/core/requirements/dismiss/REQ_job-dismiss-status.adoc new file mode 100644 index 00000000..a1213633 --- /dev/null +++ b/core/requirements/dismiss/REQ_job-dismiss-status.adoc @@ -0,0 +1,18 @@ +[[req_dismiss_job-dismiss-status]] +[requirement] +==== +[%metadata] +identifier:: /req/dismiss/job-dismiss-status + +.part +-- +If the job is currently in the `accepted` or `running` state, then the server SHALL set the status of the job to `dismissed`. +-- + +.part +-- +If the job is currently in the `sucessful`, `failed` or `dismissed` state, the the server SHALL remove the job and it SHALL not longer be accessible via the Processes API. +-- +==== + +NOTE: This standard makes no statments regarding the dispoisition of artifacts created by a job once a job has been removed and is no longer accessible via the Processes API. diff --git a/core/sections/clause_14_dismiss.adoc b/core/sections/clause_14_dismiss.adoc index bd2edb01..3e44a666 100644 --- a/core/sections/clause_14_dismiss.adoc +++ b/core/sections/clause_14_dismiss.adoc @@ -2,7 +2,7 @@ [[Dismiss]] == Requirements Class "Dismiss" -The Dismiss requirement class specifies how to dismiss a job. Dismiss can be seen as cancelling a running job or removing artifacts of a finished job. +The Dismiss requirement class specifies how to dismiss a job. include::../requirements/requirements_class_dismiss.adoc[] @@ -11,6 +11,7 @@ include::../requirements/requirements_class_dismiss.adoc[] include::../requirements/dismiss/REQ_job-dismiss-op.adoc[] +include::../requirements/dismiss/REQ_job-dismiss-status.adoc[] === Response