Changeset View
Changeset View
Standalone View
Standalone View
docs/specs/spec-meta-deposit.rst
| .. _spec-metadata-deposit: | .. _spec-metadata-deposit: | ||||
| The metadata-deposit | The metadata-only deposit | ||||
| ^^^^^^^^^^^^^^^^^^^^ | ^^^^^^^^^^^^^^^^^^^^^^^^^ | ||||
| Goal | Goal | ||||
| ==== | ==== | ||||
| A client wishes to deposit only metadata about an origin or object already | A client may wish to deposit only metadata about an origin or object already | ||||
| present in the Software Heritage archive. | present in the Software Heritage archive. | ||||
| The metadata-deposit is a special deposit where no content is | The metadata-only deposit is a special deposit where no content is | ||||
| provided and the data transferred to Software Heritage is only | provided and the data transferred to Software Heritage is only | ||||
| the metadata about an object in the archive. | the metadata about an object in the archive. | ||||
| Requirements | Requirements | ||||
| ============ | ============ | ||||
| 1. Create a metadata-only deposit through a :ref:`POST request<API-create-deposit>` | 1. Create a metadata-only deposit through a :ref:`POST request<API-create-deposit>` | ||||
| 2. It is composed of ONLY one xml metadata file | 2. It is composed of ONLY one Atom XML document | ||||
| 3. It MUST comply with :ref:`the metadata requirements<metadata-requirements>` | 3. It MUST comply with :ref:`the metadata requirements<metadata-requirements>` | ||||
| 4. It MUST reference an **object** or an **origin** in a deposit tag | 4. It MUST reference an **object** or an **origin** in a deposit tag | ||||
| 5. The reference SHOULD exist in the SWH archive | 5. The reference SHOULD exist in the SWH archive | ||||
| 6. The **object** reference MUST be a SWHID on one of the following artifact types: | 6. The **object** reference MUST be a SWHID on one of the following artifact types: | ||||
| - origin | - origin | ||||
| - snapshot | - snapshot | ||||
| - release | - release | ||||
| - revision | - revision | ||||
| ▲ Show 20 Lines • Show All 107 Lines • Show Last 20 Lines | |||||