Skip to content

Commit

Permalink
Update Deposit documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
markpatton committed Nov 8, 2023
1 parent e52c283 commit ccf306f
Showing 1 changed file with 11 additions and 15 deletions.
26 changes: 11 additions & 15 deletions docs/dev/model/Deposit.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,17 @@

A [Submission](Submission.md) can have multiple Deposits, each to a different [Repository](Repository.md). This entity describes the interaction of PASS with a target [Repository](Repository.md) for an individual [Submission](Submission.md) with the purpose of satisfying one or more [Policies](Policy.md).

*Attributes:*

| Attribute | Type | Description |
| ---------------- | ------ | -------------
| __id*__ | String | Unique Deposit URI (autogenerated) |
| __id*__ | String | Long identifier of object
| depositStatusRef | String | A URL or some kind of reference that can be dereferenced, entity body parsed, and used to determine the status of Deposit |
| depositStatus* | Enum | Status of deposit ([_see list below_](#deposit-status-options)) |

*Relationships:*
| depositStatus* | String | Status of deposit ([_see list below_](#deposit-status-options)) |

| Relationship | Type | Target | Description |
| ---------------- | ------ | --------- | ----------- |
| submission* | To one | String | [Submission](Submission.md) this Deposit is a part of |
| repository* | To one | String | [Repository](Repository.md) being deposited to |
| repositoryCopy | To one | String | [Repository Copy](RepositoryCopy.md) representing the copy that is reltaed to this Deposit. The value is null if there is no copy |
| submission* | To one | [Submission](Submission.md) | Submission this Deposit is a part of |
| repository* | To one | [Repository](Repository.md) | Repository being deposited to |
| repositoryCopy | To one | [Repository Copy](RepositoryCopy.md) | Repository Copy for this Deposit |

*required

Expand All @@ -35,9 +31,9 @@ These are the possible statuses for a Deposit in the order they could occur. Not
</dd>
</dl>

| Value | State | Description
| --------- | ----- | ---
| submitted | Intermediate | PASS has sent a package to the target [Repository](Repository.md) and is waiting for an update on the status
| rejected | Terminal | The target [Repository](Repository.md) has rejected the Deposit
| failed | Intermediate | A failure occurred while performing the deposit, it may be re-tried later.
| accepted | Terminal | The target [Repository](Repository.md) has accepted the [Files](File.md) into the repository and they are pending publication if not published already
| Value | State | Description |
| --------- | ----- | --- |
| submitted | Intermediate | PASS has sent a package to the target [Repository](Repository.md) and is waiting for an update on the status |
| rejected | Terminal | The target [Repository](Repository.md) has rejected the Deposit |
| failed | Intermediate | A failure occurred while performing the deposit, it may be re-tried later. |
| accepted | Terminal | The target [Repository](Repository.md) has accepted the [Files](File.md) into the repository and they are pending publication if not published already |

0 comments on commit ccf306f

Please sign in to comment.