API - replace 'Activity' with 'Workout' - #58

This commit is contained in:
Sam
2021-01-10 11:16:43 +01:00
parent 24ee5bbcfa
commit 3a80e01cc2
70 changed files with 2746 additions and 2511 deletions

View File

@ -80,13 +80,13 @@
<li><a class="reference internal" href="#list">List</a><ul>
<li><a class="reference internal" href="#administration">Administration</a></li>
<li><a class="reference internal" href="#account">Account</a></li>
<li><a class="reference internal" href="#activities-workouts">Activities/Workouts</a></li>
<li><a class="reference internal" href="#workouts">Workouts</a></li>
<li><a class="reference internal" href="#translations">Translations</a></li>
</ul>
</li>
<li><a class="reference internal" href="#dashboard">Dashboard</a></li>
<li><a class="reference internal" href="#activity-workout-detail">Activity/workout detail</a></li>
<li><a class="reference internal" href="#activities-workouts-list">Activities/workouts list</a></li>
<li><a class="reference internal" href="#workout-detail">Workout detail</a></li>
<li><a class="reference internal" href="#workouts-list">Workouts list</a></li>
<li><a class="reference internal" href="#statistics">Statistics</a></li>
<li><a class="reference internal" href="#id1">Administration</a></li>
</ul>
@ -164,7 +164,7 @@
</li>
<li><p><strong>Sports</strong></p>
<ul class="simple">
<li><p>enable or disable a sport (a sport can be disabled even if activity with this sport exists)</p></li>
<li><p>enable or disable a sport (a sport can be disabled even if workout with this sport exists)</p></li>
</ul>
</li>
</ul>
@ -176,11 +176,11 @@
<li><p>A user can reset his password (<em>new in 0.3.0</em>)</p></li>
</ul>
</div>
<div class="section" id="activities-workouts">
<h3>Activities/Workouts<a class="headerlink" href="#activities-workouts" title="Permalink to this headline"></a></h3>
<div class="section" id="workouts">
<h3>Workouts<a class="headerlink" href="#workouts" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><dl class="simple">
<dt>6 sports supported:</dt><dd><ul>
<dt>6 sports are supported:</dt><dd><ul>
<li><p>Cycling (Sport)</p></li>
<li><p>Cycling (Transport)</p></li>
<li><p>Hiking</p></li>
@ -191,10 +191,10 @@
</dd>
</dl>
</li>
<li><p>Dashboard with month calendar displaying activities and record. The week can start on Sunday or Monday (which can be changed in the user settings)</p></li>
<li><p>Activity creation by uploading a gpx file. An activity can even be created without gpx (the user must enter date, time, duration and distance)</p></li>
<li><p>An activity with a gpx file can be displayed with map, weather (if the DarkSky API key is provided) and charts (speed and elevation). Segments can be displayed</p></li>
<li><p>Activity edition and deletion. User can add a note</p></li>
<li><p>Dashboard with month calendar displaying workouts and record. The week can start on Sunday or Monday (which can be changed in the user settings)</p></li>
<li><p>Workout creation by uploading a gpx file. A workout can even be created without gpx (the user must enter date, time, duration and distance)</p></li>
<li><p>A workout with a gpx file can be displayed with map, weather (if the DarkSky API key is provided) and charts (speed and elevation). Segments can be displayed</p></li>
<li><p>Workout edition and deletion. User can add a note</p></li>
<li><p>User statistics</p></li>
<li><dl class="simple">
<dt>User records by sports:</dt><dd><ul>
@ -206,11 +206,11 @@
</dd>
</dl>
</li>
<li><p>Activities list and filter</p></li>
<li><p>Workours list and filter</p></li>
</ul>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>for now, only the owner of the activity can see the activity.</p>
<p>for now, only the owner of the workout can see it.</p>
</div>
</div>
<div class="section" id="translations">
@ -224,16 +224,16 @@
<img alt="FitTrackee Dashboard" src="_images/fittrackee_screenshot-01.png" />
</div>
</div>
<div class="section" id="activity-workout-detail">
<h2>Activity/workout detail<a class="headerlink" href="#activity-workout-detail" title="Permalink to this headline"></a></h2>
<div class="section" id="workout-detail">
<h2>Workout detail<a class="headerlink" href="#workout-detail" title="Permalink to this headline"></a></h2>
<div class="figure align-default">
<img alt="FitTrackee Activity" src="_images/fittrackee_screenshot-02.png" />
<img alt="FitTrackee Workout" src="_images/fittrackee_screenshot-02.png" />
</div>
</div>
<div class="section" id="activities-workouts-list">
<h2>Activities/workouts list<a class="headerlink" href="#activities-workouts-list" title="Permalink to this headline"></a></h2>
<div class="section" id="workouts-list">
<h2>Workouts list<a class="headerlink" href="#workouts-list" title="Permalink to this headline"></a></h2>
<div class="figure align-default">
<img alt="FitTrackee Activities" src="_images/fittrackee_screenshot-03.png" />
<img alt="FitTrackee Workouts" src="_images/fittrackee_screenshot-03.png" />
</div>
</div>
<div class="section" id="statistics">