You can contribute to extend the content of the Software Heritage archive by submitting an origin
save request. To do so, fill the required info in the form below:
Origin type: the type of version control system the software origin is using.
Currently, the only supported type is git, for origins using Git.
Soon, the following origin types will also be available to save into the archive:
Origin url: the url of the remote repository for the software origin.
+
Origin url: the url of the remote repository for the software origin.
+ In order to avoid saving errors from Software Heritage, you should provide the clone/checkout url
+ as given by the provider hosting the software origin. It can easily be found in the
+ web interface used to browse the software origin.
+
Once submitted, your save request can either be:
accepted: a visit to the provided origin will then be scheduled by Software Heritage in order to
load its content into the archive as soon as possible
rejected: the provided origin url is blacklisted and no visit will be scheduled
put in pending state: a manual review will then be performed in order to determine if the
origin can be safely loaded or not into the archive
{% endblock %}
\ No newline at end of file
diff --git a/swh/web/templates/browse/search.html b/swh/web/templates/browse/search.html
index bfd1653e..fd4627c1 100644
--- a/swh/web/templates/browse/search.html
+++ b/swh/web/templates/browse/search.html
@@ -1,66 +1,66 @@
{% extends "./layout.html" %}
{% comment %}
Copyright (C) 2017-2018 The Software Heritage developers
See the AUTHORS file at the top-level directory of this distribution
License: GNU Affero General Public License version 3, or any later version
See top-level LICENSE file for more information
{% endcomment %}
{% load static %}
{% block navbar-content %}
Search archived software
{% endblock %}
{% block browse-content %}
-
Origin type
Origin browse url
Visit status
Searching origins ...
No origins matching the search criteria were found.
{% endblock %}
diff --git a/swh/web/templates/includes/apidoc-header.html b/swh/web/templates/includes/apidoc-header.html
index c45644ef..60028c27 100644
--- a/swh/web/templates/includes/apidoc-header.html
+++ b/swh/web/templates/includes/apidoc-header.html
@@ -1,187 +1,187 @@
{% comment %}
Copyright (C) 2015-2018 The Software Heritage developers
See the AUTHORS file at the top-level directory of this distribution
License: GNU Affero General Public License version 3, or any later version
See top-level LICENSE file for more information
{% endcomment %}
You can jump directly to the
endpoint index, which lists all available API functionalities, or read on for more general information about the API.
Data model
The
Software Heritage project harvests publicly available source code by tracking software distribution channels such as
version control systems, tarball releases, and distribution packages.
All retrieved source code and related metadata are stored in the Software Heritage archive, that is conceptually a
Merkle DAG. All nodes in the graph are content-addressable, i.e., their node identifiers are computed by hashing their
content and, transitively, that of all nodes reachable from them; and no node or edge is ever removed from the graph: the
Software Heritage archive is an append-only data structure.
The following types of objects (i.e., graph nodes) can be found in the Software Heritage archive
(for more information see the
Software Heritage glossary):
Content: a specific version of a file stored in the archive, identified by its cryptographic hashes (currently:
SHA1, Git-like "salted" SHA1, SHA256). Note that content objects are nameless; their names are context-dependent
and stored as part of directory entries (see below).
Also known as: "blob"
Directory: a list of directory entries, where each entry can point to content objects ("file entries"),
revisions ("revision entries"), or transitively to other directories ("directory entries"). All entries
are associated to the local name of the entry (i.e., a relative path without any path separator) and permission metadata
(e.g., chmod value or equivalent).
Revision: a point in time snapshot of the content of a directory, together with associated development metadata
(e.g., author, timestamp, log message, etc).
Also known as: "commit".
Release: a revision that has been marked as noteworthy with a specific name (e.g., a version number), together
with associated development metadata (e.g., author, timestamp, etc).
Also known as: "tag"
Origin: an Internet-based location from which a coherent set of objects (contents, revisions, releases, etc.)
archived by Software Heritage has been obtained. Origins are currently identified by URLs.
Visit: the passage of Software Heritage on a given origin, to retrieve all source code and metadata available
there at the time. A visit object stores the state of all visible branches (if any) available at the origin at visit
time; each of them points to a revision object in the archive. Future visits of the same origin will create new visit
objects, without removing previous ones.
Person: an entity referenced by a revision as either the author or the committer of the corresponding change.
A person is associated to a full name and/or an email address.
Version
The current version of the API is
v1.
Warning: this version of the API is not to be considered stable yet. Non-backward compatible changes might happen
even without changing the API version number.
The response format can be overridden using the
Accept request header. In particular,
Accept: text/html (that web browsers send by default) requests HTML pretty-printing, whereas
Accept: application/yaml requests YAML-encoded responses.
Some API endpoints can be tweaked by passing optional parameters. For GET requests, optional parameters can be passed as
an HTTP query string.
The optional parameter
fields is accepted by all endpoints that return dictionaries and can be used to restrict the list of fields returned
by the API, in case you are not interested in all of them. By default, all available fields are returned.
Unavailability of the underlying storage backend will result in a
503 Service Unavailable HTTP response.
Pagination
Requests that might potentially return many items will be paginated.
Page size is set to a default (usually: 10 items), but might be overridden with the
per_page query parameter up to a maximum (usually: 50 items). Example:
Due to limited resource availability on the back end side, API usage is currently rate limited. Furthermore, as API usage
is currently entirely anonymous (i.e., without any authentication), API "users" are currently identified by their
origin IP address.
Three HTTP response fields will inform you about the current state of limits that apply to your current rate limiting bucket:
X-RateLimit-Limit: maximum number of permitted requests per hour
X-RateLimit-Remaining: number of permitted requests remaining before the next reset
X-RateLimit-Reset: the time (expressed in
Unix time seconds) at which the current rate limiting will expire, resetting to a fresh
X-RateLimit-Limit
\ No newline at end of file
diff --git a/swh/web/templates/layout.html b/swh/web/templates/layout.html
index 2bac2cd4..981f3d79 100644
--- a/swh/web/templates/layout.html
+++ b/swh/web/templates/layout.html
@@ -1,175 +1,175 @@
{% comment %}
Copyright (C) 2015-2018 The Software Heritage developers
See the AUTHORS file at the top-level directory of this distribution
License: GNU Affero General Public License version 3, or any later version
See top-level LICENSE file for more information
{% endcomment %}
{% load static %}
{% load render_bundle from webpack_loader %}
{% block title %}{% endblock %}
{% render_bundle 'vendors' %}
{% render_bundle 'webapp' %}
{% block header %}{% endblock %}
