FitTrackee/docs/http-routingtable.html

441 lines
17 KiB
HTML
Raw Normal View History

2020-12-30 11:12:35 +01:00
<!DOCTYPE html>
2022-06-22 20:22:26 +02:00
<html lang="en">
2020-12-30 11:12:35 +01:00
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
2023-04-12 17:32:08 +02:00
<title>HTTP Routing Table &#8212; FitTrackee 0.7.15
2020-12-30 11:12:35 +01:00
documentation</title>
2021-11-06 21:26:02 +01:00
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/bootstrap-sphinx.css" />
2022-11-27 12:06:42 +01:00
<link rel="stylesheet" type="text/css" href="_static/css/fork-awesome.min.css" />
<link rel="stylesheet" type="text/css" href="_static/css/custom.css" />
2021-11-06 21:26:02 +01:00
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
2020-12-30 11:12:35 +01:00
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
2022-06-22 20:22:26 +02:00
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
2020-12-30 11:12:35 +01:00
<script src="_static/doctools.js"></script>
2022-11-01 19:58:12 +01:00
<script src="_static/sphinx_highlight.js"></script>
2020-12-30 11:12:35 +01:00
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<meta charset='utf-8'>
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
<meta name="apple-mobile-web-app-capable" content="yes">
2022-02-05 22:09:17 +01:00
<script type="text/javascript" src="_static/js/jquery-1.12.4.min.js"></script>
<script type="text/javascript" src="_static/js/jquery-fix.js"></script>
<script type="text/javascript" src="_static/bootstrap-3.4.1/js/bootstrap.min.js"></script>
<script type="text/javascript" src="_static/bootstrap-sphinx.js"></script>
2020-12-30 11:12:35 +01:00
<script>
DOCUMENTATION_OPTIONS.COLLAPSE_INDEX = true;
</script>
</head><body>
<div id="navbar" class="navbar navbar-default navbar-fixed-top">
<div class="container">
<div class="navbar-header">
<!-- .btn-navbar is used as the toggle for collapsed navbar content -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">
FitTrackee</a>
2023-04-12 17:32:08 +02:00
<span class="navbar-text navbar-version pull-left"><b>0.7.15
2020-12-30 11:12:35 +01:00
</b></span>
</div>
<div class="collapse navbar-collapse nav-collapse">
<ul class="nav navbar-nav">
<li><a href="https://github.com/SamR1/FitTrackee">GitHub</a></li>
<li class="dropdown globaltoc-container">
<a role="button"
id="dLabelGlobalToc"
data-toggle="dropdown"
data-target="#"
href="index.html">Docs <b class="caret"></b></a>
<ul class="dropdown-menu globaltoc"
role="menu"
aria-labelledby="dLabelGlobalToc"><ul>
<li class="toctree-l1"><a class="reference internal" href="features.html">Features</a></li>
2023-04-12 17:32:08 +02:00
<li class="toctree-l1"><a class="reference internal" href="oauth.html">OAuth 2.0</a></li>
2021-11-29 18:24:22 +01:00
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
2022-04-24 13:17:38 +02:00
<li class="toctree-l1"><a class="reference internal" href="cli.html">Command line interface</a></li>
2023-04-12 17:32:08 +02:00
<li class="toctree-l1"><a class="reference internal" href="third_party_tools.html">Third-party tools</a></li>
2020-12-30 11:12:35 +01:00
<li class="toctree-l1"><a class="reference internal" href="api/index.html">API documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="troubleshooting/index.html">Troubleshooting</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Change log</a></li>
</ul>
</ul>
</li>
<li class="dropdown">
<a role="button"
id="dLabelLocalToc"
data-toggle="dropdown"
data-target="#"
href="#">Page <b class="caret"></b></a>
<ul class="dropdown-menu localtoc"
role="menu"
aria-labelledby="dLabelLocalToc"></ul>
</li>
<li class="hidden-sm"></li>
</ul>
<form class="navbar-form navbar-right" action="search.html" method="get">
<div class="form-group">
<input type="text" name="q" class="form-control" placeholder="Search" />
</div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
</div>
<div class="container">
<div class="row">
<div class="body col-md-12 content" role="main">
<h1>HTTP Routing Table</h1>
<div class="modindex-jumpbox">
<a href="#cap-/api"><strong>/api</strong></a>
</div>
<table class="indextable modindextable">
<tr class="pcap"><td></td><td>&#160;</td><td></td></tr>
<tr class="cap" id="cap-/api"><td></td><td>
<strong>/api</strong></td><td></td></tr>
2023-03-05 14:26:31 +01:00
<tr>
<td></td>
<td>
<a href="api/auth.html#get--api-auth-account-export"><code class="xref">GET /api/auth/account/export</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="api/auth.html#get--api-auth-account-export-(string-file_name)"><code class="xref">GET /api/auth/account/export/(string:file_name)</code></a></td><td>
<em></em></td></tr>
2020-12-30 11:12:35 +01:00
<tr>
<td></td>
<td>
<a href="api/auth.html#get--api-auth-profile"><code class="xref">GET /api/auth/profile</code></a></td><td>
2020-12-30 11:12:35 +01:00
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="api/configuration.html#get--api-config"><code class="xref">GET /api/config</code></a></td><td>
2020-12-30 11:12:35 +01:00
<em></em></td></tr>
2022-08-27 16:50:29 +02:00
<tr>
<td></td>
<td>
<a href="api/oauth2.html#get--api-oauth-apps"><code class="xref">GET /api/oauth/apps</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="api/oauth2.html#get--api-oauth-apps-(int-client_id)-by_id"><code class="xref">GET /api/oauth/apps/(int:client_id)/by_id</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="api/oauth2.html#get--api-oauth-apps-(string-client_client_id)"><code class="xref">GET /api/oauth/apps/(string:client_client_id)</code></a></td><td>
<em></em></td></tr>
2020-12-30 11:12:35 +01:00
<tr>
<td></td>
<td>
<a href="api/configuration.html#get--api-ping"><code class="xref">GET /api/ping</code></a></td><td>
2020-12-30 11:12:35 +01:00
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="api/records.html#get--api-records"><code class="xref">GET /api/records</code></a></td><td>
2020-12-30 11:12:35 +01:00
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="api/sports.html#get--api-sports"><code class="xref">GET /api/sports</code></a></td><td>
2020-12-30 11:12:35 +01:00
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="api/sports.html#get--api-sports-(int-sport_id)"><code class="xref">GET /api/sports/(int:sport_id)</code></a></td><td>
2020-12-30 11:12:35 +01:00
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="api/stats.html#get--api-stats-(user_name)-by_sport"><code class="xref">GET /api/stats/(user_name)/by_sport</code></a></td><td>
2020-12-30 11:12:35 +01:00
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="api/stats.html#get--api-stats-(user_name)-by_time"><code class="xref">GET /api/stats/(user_name)/by_time</code></a></td><td>
2020-12-30 11:12:35 +01:00
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="api/stats.html#get--api-stats-all"><code class="xref">GET /api/stats/all</code></a></td><td>
2020-12-30 11:12:35 +01:00
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="api/users.html#get--api-users"><code class="xref">GET /api/users</code></a></td><td>
2020-12-30 11:12:35 +01:00
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="api/users.html#get--api-users-(user_name)"><code class="xref">GET /api/users/(user_name)</code></a></td><td>
2020-12-30 11:12:35 +01:00
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="api/users.html#get--api-users-(user_name)-picture"><code class="xref">GET /api/users/(user_name)/picture</code></a></td><td>
2020-12-30 11:12:35 +01:00
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="api/workouts.html#get--api-workouts"><code class="xref">GET /api/workouts</code></a></td><td>
2020-12-30 11:12:35 +01:00
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="api/workouts.html#get--api-workouts-(string-workout_short_id)"><code class="xref">GET /api/workouts/(string:workout_short_id)</code></a></td><td>
2020-12-30 11:12:35 +01:00
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="api/workouts.html#get--api-workouts-(string-workout_short_id)-chart_data"><code class="xref">GET /api/workouts/(string:workout_short_id)/chart_data</code></a></td><td>
2020-12-30 11:12:35 +01:00
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="api/workouts.html#get--api-workouts-(string-workout_short_id)-chart_data-segment-(int-segment_id)"><code class="xref">GET /api/workouts/(string:workout_short_id)/chart_data/segment/(int:segment_id)</code></a></td><td>
2020-12-30 11:12:35 +01:00
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="api/workouts.html#get--api-workouts-(string-workout_short_id)-gpx"><code class="xref">GET /api/workouts/(string:workout_short_id)/gpx</code></a></td><td>
2020-12-30 11:12:35 +01:00
<em></em></td></tr>
2021-11-29 18:24:22 +01:00
<tr>
<td></td>
<td>
<a href="api/workouts.html#get--api-workouts-(string-workout_short_id)-gpx-download"><code class="xref">GET /api/workouts/(string:workout_short_id)/gpx/download</code></a></td><td>
<em></em></td></tr>
2020-12-30 11:12:35 +01:00
<tr>
<td></td>
<td>
<a href="api/workouts.html#get--api-workouts-(string-workout_short_id)-gpx-segment-(int-segment_id)"><code class="xref">GET /api/workouts/(string:workout_short_id)/gpx/segment/(int:segment_id)</code></a></td><td>
2020-12-30 11:12:35 +01:00
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="api/workouts.html#get--api-workouts-map-(map_id)"><code class="xref">GET /api/workouts/map/(map_id)</code></a></td><td>
2020-12-30 11:12:35 +01:00
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="api/workouts.html#get--api-workouts-map_tile-(s)-(z)-(x)-(y).png"><code class="xref">GET /api/workouts/map_tile/(s)/(z)/(x)/(y).png</code></a></td><td>
2020-12-30 11:12:35 +01:00
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="api/auth.html#post--api-auth-account-confirm"><code class="xref">POST /api/auth/account/confirm</code></a></td><td>
<em></em></td></tr>
2023-03-05 14:26:31 +01:00
<tr>
<td></td>
<td>
<a href="api/auth.html#post--api-auth-account-export-request"><code class="xref">POST /api/auth/account/export/request</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="api/auth.html#post--api-auth-account-privacy-policy"><code class="xref">POST /api/auth/account/privacy-policy</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="api/auth.html#post--api-auth-account-resend-confirmation"><code class="xref">POST /api/auth/account/resend-confirmation</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="api/auth.html#post--api-auth-email-update"><code class="xref">POST /api/auth/email/update</code></a></td><td>
<em></em></td></tr>
2020-12-30 11:12:35 +01:00
<tr>
<td></td>
<td>
<a href="api/auth.html#post--api-auth-login"><code class="xref">POST /api/auth/login</code></a></td><td>
<em></em></td></tr>
2022-09-15 16:11:13 +02:00
<tr>
<td></td>
<td>
<a href="api/auth.html#post--api-auth-logout"><code class="xref">POST /api/auth/logout</code></a></td><td>
<em></em></td></tr>
2020-12-30 11:12:35 +01:00
<tr>
<td></td>
<td>
<a href="api/auth.html#post--api-auth-password-reset-request"><code class="xref">POST /api/auth/password/reset-request</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="api/auth.html#post--api-auth-password-update"><code class="xref">POST /api/auth/password/update</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="api/auth.html#post--api-auth-picture"><code class="xref">POST /api/auth/picture</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="api/auth.html#post--api-auth-profile-edit"><code class="xref">POST /api/auth/profile/edit</code></a></td><td>
<em></em></td></tr>
2021-11-12 12:22:07 +01:00
<tr>
<td></td>
<td>
<a href="api/auth.html#post--api-auth-profile-edit-preferences"><code class="xref">POST /api/auth/profile/edit/preferences</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="api/auth.html#post--api-auth-profile-edit-sports"><code class="xref">POST /api/auth/profile/edit/sports</code></a></td><td>
<em></em></td></tr>
2020-12-30 11:12:35 +01:00
<tr>
<td></td>
<td>
<a href="api/auth.html#post--api-auth-register"><code class="xref">POST /api/auth/register</code></a></td><td>
<em></em></td></tr>
2022-08-27 16:50:29 +02:00
<tr>
<td></td>
<td>
<a href="api/oauth2.html#post--api-oauth-apps"><code class="xref">POST /api/oauth/apps</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="api/oauth2.html#post--api-oauth-apps-(int-client_id)-revoke"><code class="xref">POST /api/oauth/apps/(int:client_id)/revoke</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="api/oauth2.html#post--api-oauth-authorize"><code class="xref">POST /api/oauth/authorize</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="api/oauth2.html#post--api-oauth-revoke"><code class="xref">POST /api/oauth/revoke</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="api/oauth2.html#post--api-oauth-token"><code class="xref">POST /api/oauth/token</code></a></td><td>
<em></em></td></tr>
2020-12-30 11:12:35 +01:00
<tr>
<td></td>
<td>
<a href="api/workouts.html#post--api-workouts"><code class="xref">POST /api/workouts</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="api/workouts.html#post--api-workouts-no_gpx"><code class="xref">POST /api/workouts/no_gpx</code></a></td><td>
2020-12-30 11:12:35 +01:00
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="api/auth.html#delete--api-auth-picture"><code class="xref">DELETE /api/auth/picture</code></a></td><td>
<em></em></td></tr>
2021-12-19 12:37:05 +01:00
<tr>
<td></td>
<td>
<a href="api/auth.html#delete--api-auth-profile-reset-sports-(sport_id)"><code class="xref">DELETE /api/auth/profile/reset/sports/(sport_id)</code></a></td><td>
<em></em></td></tr>
2022-08-27 16:50:29 +02:00
<tr>
<td></td>
<td>
<a href="api/oauth2.html#delete--api-oauth-apps-(int-client_id)"><code class="xref">DELETE /api/oauth/apps/(int:client_id)</code></a></td><td>
<em></em></td></tr>
2020-12-30 11:12:35 +01:00
<tr>
<td></td>
<td>
<a href="api/users.html#delete--api-users-(user_name)"><code class="xref">DELETE /api/users/(user_name)</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="api/workouts.html#delete--api-workouts-(string-workout_short_id)"><code class="xref">DELETE /api/workouts/(string:workout_short_id)</code></a></td><td>
2020-12-30 11:12:35 +01:00
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="api/auth.html#patch--api-auth-profile-edit-account"><code class="xref">PATCH /api/auth/profile/edit/account</code></a></td><td>
<em></em></td></tr>
2020-12-30 11:12:35 +01:00
<tr>
<td></td>
<td>
<a href="api/configuration.html#patch--api-config"><code class="xref">PATCH /api/config</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="api/sports.html#patch--api-sports-(int-sport_id)"><code class="xref">PATCH /api/sports/(int:sport_id)</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="api/users.html#patch--api-users-(user_name)"><code class="xref">PATCH /api/users/(user_name)</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="api/workouts.html#patch--api-workouts-(string-workout_short_id)"><code class="xref">PATCH /api/workouts/(string:workout_short_id)</code></a></td><td>
<em></em></td></tr>
2020-12-30 11:12:35 +01:00
</table>
</div>
</div>
</div>
<footer class="footer">
<div class="container">
<p class="pull-right">
<a href="#">Back to top</a>
</p>
<p>
2023-04-12 17:32:08 +02:00
&copy; Copyright 2018 - 2023, SamR1 <a rel="me" href="https://fosstodon.org/@FitTrackee"><i class="fa fa-mastodon" aria-hidden="true"></i></a>.
Last updated on Apr 12, 2023.<br/>
2022-11-01 19:58:12 +01:00
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 5.3.0.<br/>
2020-12-30 11:12:35 +01:00
</p>
</div>
</footer>
2022-11-27 12:06:42 +01:00
2020-12-30 11:12:35 +01:00
</body>
</html>