Changeset View
Changeset View
Standalone View
Standalone View
docs/api.rst
.. _vault-api-ref: | .. _vault-api-ref: | ||||
Vault API Reference | Vault API Reference | ||||
=================== | =================== | ||||
Software source code **objects**---e.g., individual files, directories, | Software source code **objects**---e.g., individual files, directories, | ||||
commits, tagged releases, etc.---are stored in the Software Heritage (SWH) | commits, tagged releases, etc.---are stored in the Software Heritage (SWH) | ||||
Archive in fully deduplicated form. That allows direct access to individual | Archive in fully deduplicated form. That allows direct access to individual | ||||
artifacts, but require some preparation ("cooking") when fast access to a large | artifacts, but require some preparation ("cooking") when fast access to a large | ||||
set of related objects (e.g., an entire repository) is required. | set of related objects (e.g., an entire repository) is required. | ||||
The **Software Heritage Vault** takes care of that preparation by | The **Software Heritage Vault** takes care of that preparation by | ||||
asynchronously assembling **bundles** of related source code objects, caching, | asynchronously assembling **bundles** of related source code objects, caching, | ||||
and garbage collecting them as needed. | and garbage collecting them as needed. | ||||
The Vault is accessible via a RESTful API documented below. | The Vault is accessible via a RPC API documented below. | ||||
All endpoints are mounted at API root, which is currently at | All endpoints are mounted at API root, which is currently at | ||||
https://archive.softwareheritage.org/api/1/. | https://archive.softwareheritage.org/api/1/. | ||||
Unless otherwise stated, API endpoints respond to HTTP GET method. | Unless otherwise stated, API endpoints respond to HTTP GET method. | ||||
Object identification | Object identification | ||||
▲ Show 20 Lines • Show All 155 Lines • Show Last 20 Lines |