Page MenuHomeSoftware Heritage
Files F9337297

endpoints.html
No OneTemporary
Actions

endpoints.html
View Options

{% extends "layout.html" %}
{% comment %}
Copyright (C) 2015-2019 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 swh_templatetags %}
{% block title %} Endpoints – Software Heritage API {% endblock %}
{% block navbar-content %}
<div class="bread-crumbs">
<ul>
<li><a href="/api/"><h4>Web API</h4></a></li>
<li class="bc-no-root"><i class="mdi mdi-menu-right mdi-fw" aria-hidden="true"></i></li>
<li class="bc-no-root">endpoints</li>
</ul>
</div>
{% endblock %}
{% block content %}
<div class="swh-api-1-doc">
<p>
Below you can find a list of the available endpoints for version 1 of the
Software Heritage API. For a more general introduction please refer to
the <a href="/api/">API overview</a>.
</p>
<p>
Endpoints marked "available" are considered stable for the current version
of the API; endpoints marked "upcoming" are work in progress that will be
stabilized in the near future.
</p>
</div>
<div class="swh-api-1-doc table-responsive">
<table class="table table-striped search-res swh-table" width="100%">
<col width="200">
<thead class="thead-default">
<th>Endpoint</th>
<th class="d-none d-sm-table-cell">Description</th>
</thead>
<tbody>
{% for route, doc in doc_routes %}
<tr class="swh-api-1-doc-route swh-tr-hover-highlight {% for tag in doc.tags %} swh-api-1-doc-route-{{ tag }} {% endfor %}">
{% if "upcoming" in doc.tags %}
<td id="{{ route }}">
{% url doc.route_view_name %}
</td>
{% else %}
<td id="{{ route }}">
<a href="{% url doc.route_view_name %}">
{{ doc.route }}
</a>
{% if "deprecated" in doc.tags %}(deprecated){% endif %}
</td>
{% endif %}
<td class="d-none d-sm-table-cell">
<a href="{% url doc.route_view_name %}">
{{ doc.doc_intro | docstring_display | safe }}
</a>
</td>
</tr>
{% endfor %}
</tbody>
</table>
</div>
<script type="text/javascript">
swh.webapp.initPage('api');
swh.webapp.highlightCode(false);
$(document).ready(function() {
$('table.swh-table').DataTable({
"paging": false,
"info": false,
"order": [[0, "asc"]]
});
});
</script>
{% endblock %}

File Metadata

Mime Type
text/html
Expires
Jul 4 2025, 7:59 AM (10 w, 1 d ago)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
3340666

Event Timeline

About · Developer information · Legal