Skip to content

Commit

Permalink
Clarify what happens to a job when dismissed.
Browse files Browse the repository at this point in the history
  • Loading branch information
pvretano committed Mar 4, 2024
1 parent c04b2e2 commit 7c8a114
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 1 deletion.
18 changes: 18 additions & 0 deletions core/requirements/dismiss/REQ_job-dismiss-status.adoc
Original file line number Diff line number Diff line change
@@ -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.
3 changes: 2 additions & 1 deletion core/sections/clause_14_dismiss.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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[]

Expand All @@ -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

Expand Down

0 comments on commit 7c8a114

Please sign in to comment.