diff --git a/docs/dev/model/Deposit.md b/docs/dev/model/Deposit.md index 12dfae29..5bd1ce35 100644 --- a/docs/dev/model/Deposit.md +++ b/docs/dev/model/Deposit.md @@ -2,18 +2,19 @@ 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). -| Field | Type | Description +| Attribute | Type | Description | ---------------- | ------ | ------------- -| __id*__ | URI | Unique Deposit URI (autogenerated) +| __id*__ | String | Unique Deposit URI (autogenerated) | 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)) -| submission* | URI | URI of [Submission](Submission.md) this Deposit is a part of -| repository* | URI | URI of the [Repository](Repository.md) being deposited to -| repositoryCopy | URI | URI of the [Repository Copy](RepositoryCopy.md) representing the copy that is reltaed to this Deposit. The value is null if there is no copy - -*required -*Properties automatically generated by the system are documented in [System Properties](SystemProperties.md). These are not available to client tools by default.* +| 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 + +*required ## Deposit status options