Changeset View
Changeset View
Standalone View
Standalone View
docs/endpoints/collection.rst
Show First 20 Lines • Show All 45 Lines • ▼ Show 20 Lines | .. code:: http | ||||
Vary: Accept, Cookie | Vary: Accept, Cookie | ||||
Allow: GET, POST, PUT, DELETE, HEAD, OPTIONS | Allow: GET, POST, PUT, DELETE, HEAD, OPTIONS | ||||
Location: /1/hal/10/metadata/ | Location: /1/hal/10/metadata/ | ||||
X-Frame-Options: SAMEORIGIN | X-Frame-Options: SAMEORIGIN | ||||
Content-Type: application/xml | Content-Type: application/xml | ||||
<entry xmlns="http://www.w3.org/2005/Atom" | <entry xmlns="http://www.w3.org/2005/Atom" | ||||
xmlns:sword="http://purl.org/net/sword/" | xmlns:sword="http://purl.org/net/sword/" | ||||
xmlns:dcterms="http://purl.org/dc/terms/"> | xmlns:dcterms="http://purl.org/dc/terms/" | ||||
<deposit_id>10</deposit_id> | xmlns:swhdeposit="https://www.softwareheritage.org/schema/2018/deposit" | ||||
<deposit_date>Sept. 26, 2017, 10:32 a.m.</deposit_date> | > | ||||
<deposit_archive>None</deposit_archive> | <swhdeposit:deposit_id>10</swhdeposit:deposit_id> | ||||
<deposit_status>deposited</deposit_status> | <swhdeposit:deposit_date>Sept. 26, 2017, 10:32 a.m.</swhdeposit:deposit_date> | ||||
<swhdeposit:deposit_archive>None</swhdeposit:deposit_archive> | |||||
<swhdeposit:deposit_status>deposited</swhdeposit:deposit_status> | |||||
<!-- Edit-IRI --> | <!-- Edit-IRI --> | ||||
<link rel="edit" href="/1/hal/10/metadata/" /> | <link rel="edit" href="/1/hal/10/metadata/" /> | ||||
<!-- EM-IRI --> | <!-- EM-IRI --> | ||||
<link rel="edit-media" href="/1/hal/10/media/"/> | <link rel="edit-media" href="/1/hal/10/media/"/> | ||||
<!-- SE-IRI --> | <!-- SE-IRI --> | ||||
<link rel="http://purl.org/net/sword/terms/add" href="/1/hal/10/metadata/" /> | <link rel="http://purl.org/net/sword/terms/add" href="/1/hal/10/metadata/" /> | ||||
<!-- State-IRI --> | <!-- State-IRI --> | ||||
<link rel="alternate" href="/1/hal/10/status/"/> | <link rel="alternate" href="/1/hal/10/status/"/> | ||||
<sword:packaging>http://purl.org/net/sword/package/SimpleZip</sword:packaging> | <sword:packaging>http://purl.org/net/sword/package/SimpleZip</sword:packaging> | ||||
</entry> | </entry> | ||||
Note: older versions of the deposit used the ``http://www.w3.org/2005/Atom`` | |||||
namespace instead of ``https://www.softwareheritage.org/schema/2018/deposit``. | |||||
Tags in the Atom namespace are still provided for backward compatibility, but | |||||
are deprecated. | |||||
:reqheader Authorization: Basic authentication token | :reqheader Authorization: Basic authentication token | ||||
:reqheader Content-Type: accepted mimetype | :reqheader Content-Type: accepted mimetype | ||||
:reqheader Content-Length: tarball size | :reqheader Content-Length: tarball size | ||||
:reqheader Content-MD5: md5 checksum hex encoded of the tarball | :reqheader Content-MD5: md5 checksum hex encoded of the tarball | ||||
:reqheader Content-Disposition: attachment; filename=[filename]; the filename | :reqheader Content-Disposition: attachment; filename=[filename]; the filename | ||||
parameter must be text (ascii); for the metadata file set name parameter | parameter must be text (ascii); for the metadata file set name parameter | ||||
to 'atom'. | to 'atom'. | ||||
:reqheader In-progress: `true` if not final; `false` when final request. | :reqheader In-progress: `true` if not final; `false` when final request. | ||||
:statuscode 201: success for deposit on POST | :statuscode 201: success for deposit on POST | ||||
:statuscode 401: Unauthorized | :statuscode 401: Unauthorized | ||||
:statuscode 404: access to an unknown collection | :statuscode 404: access to an unknown collection | ||||
:statuscode 415: unsupported media type | :statuscode 415: unsupported media type |