Changeset View
Changeset View
Standalone View
Standalone View
docs/specs/spec-meta-deposit.rst
| The metadata-deposit | The metadata-deposit | ||||
| ==================== | ==================== | ||||
| Goal | Goal | ||||
| ---- | ---- | ||||
| A client wishes to deposit only metadata about an origin or object in the | |||||
| Software Heritage archive. | A client wishes to deposit only metadata about an origin or object already | ||||
| present in the Software Heritage archive. | |||||
| The metadata-deposit is a special deposit where no content is | The metadata-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. :ref:`Create a metadata-only deposit through a POST request<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 xml metadata file | ||||
| 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 | ||||
| - directory | - directory | ||||
| - content | - content | ||||
| 7. The SWHID MAY be a `core identifier`_ with or without `qualifiers`_ | 7. The SWHID MAY be a `core identifier`_ with or without `qualifiers`_ | ||||
| 8. The SWHID MUST NOT reference a fragment of code with the classifier `lines` | 8. The SWHID MUST NOT reference a fragment of code with the classifier `lines` | ||||
| .. _core identifier: https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html#core-identifiers | .. _core identifier: https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html#core-identifiers | ||||
| .. _qualifiers: https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html#qualifiers | .. _qualifiers: https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html#qualifiers | ||||
| A complete metadata example | A complete metadata example | ||||
| --------------------------- | --------------------------- | ||||
| ▲ Show 20 Lines • Show All 105 Lines • Show Last 20 Lines | |||||