Skip to content

Commit

Permalink
Merge pull request #334 from technosophos/fix/309-pending
Browse files Browse the repository at this point in the history
change 'underway' to 'pending' in the claims spec
  • Loading branch information
technosophos authored Feb 25, 2020
2 parents 62b647e + 0b01a45 commit 3623c69
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 5 deletions.
4 changes: 2 additions & 2 deletions 400-claims.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ The fields above are defined as follows:
- `message` (OPTIONAL): A human-readable string that communicates the outcome. Error messages MAY be included in `failure` conditions.
- `status` (REQUIRED): Indicates the status of the last phase transition. Valid statuses are:
- `failure`: failed before completion
- `underway`: in progress. This should only be used if the invocation container MUST exit before it can determine whether all operations are complete. Note that `underway` is a _long term status_ that indicates that the installation's final state cannot be determined by the system. For this reason, it should be avoided. When used, `underway` should be considered a temporary status, and the runtime SHOULD work to resolve this to either `failure` or `success`.
- `pending`: in progress. This should only be used if the invocation container MUST exit before it can determine whether all operations are complete. Note that `pending` is a _long term status_ that indicates that the installation's final state cannot be determined by the system. For this reason, it should be avoided. When used, `pending` should be considered a temporary status, and the runtime SHOULD work to resolve this to either `failure` or `success`.
- `unknown`: the state is unknown. This is an error condition.
- `success`: completed successfully
- `revision` (REQUIRED): An [ULID](https://github.com/ulid/spec) that MUST change each time the claim is modified. It MUST NOT change when a [non-modifying operation](https://github.com/cnabio/cnab-spec/blob/master/101-bundle-json.md#custom-actions) is performed on an installation.
Expand Down Expand Up @@ -257,7 +257,7 @@ If both commands exit with code `0`, then the resulting claim will look like thi
"result": {
"message": "yay!", // From STDOUT (echo)
"action": "install", // Determined by the action
"status": "success" // success (exit == 0), failure (exit > 0), or underway (connection terminated before exit code was received)
"status": "success" // success (exit == 0), failure (exit > 0), or pending (connection terminated before exit code was received)
},
"revision": "01CN530TF9Q095VTRYP1M8797C"
}
Expand Down
5 changes: 2 additions & 3 deletions schema/claim.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"enum": [
"failure",
"success",
"underway",
"pending",
"unknown"
],
"type": "string"
Expand Down Expand Up @@ -78,5 +78,4 @@
],
"title": "CNAB Claims json schema",
"type": "object"
}

}

0 comments on commit 3623c69

Please sign in to comment.