Docs - update and fix

This commit is contained in:
Sam
2023-06-24 08:48:15 +02:00
parent a32c8a1925
commit 86d3e5756c
41 changed files with 359 additions and 361 deletions

View File

@ -236,12 +236,12 @@
<span class="sig-name descname"><span class="pre">POST</span> </span><span class="sig-name descname"><span class="pre">/api/auth/register</span></span><a class="headerlink" href="#post--api-auth-register" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Enregistrer un utilisateur et envoyer un courriel de confirmation.</p>
<p>Le compte nouvellement créé est inactif. Lutilisateur doit confirmer son adresse électronique pour lactiver.</p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">POST</span> <span class="nn">/api/auth/register</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponses</strong> :</p>
<ul class="simple">
<li><p>success:</p></li>
</ul>
@ -300,12 +300,12 @@
<dt class="sig sig-object http" id="post--api-auth-account-confirm">
<span class="sig-name descname"><span class="pre">POST</span> </span><span class="sig-name descname"><span class="pre">/api/auth/account/confirm</span></span><a class="headerlink" href="#post--api-auth-account-confirm" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Activer le compte utilisateur après linscription.</p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">POST</span> <span class="nn">/api/auth/account/confirm</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
@ -337,12 +337,12 @@
<span class="sig-name descname"><span class="pre">POST</span> </span><span class="sig-name descname"><span class="pre">/api/auth/account/resend-confirmation</span></span><a class="headerlink" href="#post--api-auth-account-resend-confirmation" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Renvoyer le courriel avec les instructions pour confirmer le compte.</p>
<p>Si lenvoi des courriels est désactivé, ce point daccès nest pas disponible.</p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">POST</span> <span class="nn">/api/auth/account/resend-confirmation</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
@ -372,14 +372,14 @@
<dl class="http post">
<dt class="sig sig-object http" id="post--api-auth-login">
<span class="sig-name descname"><span class="pre">POST</span> </span><span class="sig-name descname"><span class="pre">/api/auth/login</span></span><a class="headerlink" href="#post--api-auth-login" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Connexion de lutilisateur</p>
<dd><p>Connexion de lutilisateur.</p>
<p>Seuls les utilisateurs disposant dun compte actif peuvent se connecter.</p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">POST</span> <span class="nn">/api/auth/login</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponses</strong> :</p>
<ul class="simple">
<li><p>connexion avec succès :</p></li>
</ul>
@ -427,13 +427,13 @@
<dt class="sig sig-object http" id="get--api-auth-profile">
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/api/auth/profile</span></span><a class="headerlink" href="#get--api-auth-profile" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Obtenir des informations sur lutilisateur authentifié (profil, compte, préférences).</p>
<p><strong>Scope</strong>: <code class="docutils literal notranslate"><span class="pre">profile:read</span></code></p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Scope</strong> : <code class="docutils literal notranslate"><span class="pre">profile:read</span></code></p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">GET</span> <span class="nn">/api/auth/profile</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
@ -546,13 +546,13 @@
<dt class="sig sig-object http" id="post--api-auth-profile-edit">
<span class="sig-name descname"><span class="pre">POST</span> </span><span class="sig-name descname"><span class="pre">/api/auth/profile/edit</span></span><a class="headerlink" href="#post--api-auth-profile-edit" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Modifier le profil de lutilisateur authentifié.</p>
<p><strong>Scope</strong>: <code class="docutils literal notranslate"><span class="pre">profile:write</span></code></p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Scope</strong> : <code class="docutils literal notranslate"><span class="pre">profile:write</span></code></p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">POST</span> <span class="nn">/api/auth/profile/edit</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
@ -646,10 +646,10 @@
<dt class="field-odd">Objet JSON de requête<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>first_name</strong> (<em>string</em>) prénom de lutilisateur</p></li>
<li><p><strong>last_name</strong> (<em>string</em>) nom de lutilisateur</p></li>
<li><p><strong>last_name</strong> (<em>string</em>) nom de famille de lutilisateur</p></li>
<li><p><strong>location</strong> (<em>string</em>) localisation de lutilisateur</p></li>
<li><p><strong>bio</strong> (<em>string</em>) biographie de lutilisateur</p></li>
<li><p><strong>birth_date</strong> (<em>string</em>) date de naissance de lutilisateur (format: <code class="docutils literal notranslate"><span class="pre">%Y-%m-%d</span></code>)</p></li>
<li><p><strong>birth_date</strong> (<em>string</em>) date de naissance de lutilisateur (format : <code class="docutils literal notranslate"><span class="pre">%Y-%m-%d</span></code>)</p></li>
</ul>
</dd>
<dt class="field-even">En-têtes de requête<span class="colon">:</span></dt>
@ -690,13 +690,13 @@
</ul>
</li>
</ul>
<p><strong>Scope</strong>: <code class="docutils literal notranslate"><span class="pre">profile:write</span></code></p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Scope</strong> : <code class="docutils literal notranslate"><span class="pre">profile:write</span></code></p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">POST</span> <span class="nn">/api/auth/profile/edit/preferences</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
@ -828,13 +828,13 @@
<dt class="sig sig-object http" id="post--api-auth-profile-edit-sports">
<span class="sig-name descname"><span class="pre">POST</span> </span><span class="sig-name descname"><span class="pre">/api/auth/profile/edit/sports</span></span><a class="headerlink" href="#post--api-auth-profile-edit-sports" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Modifier les préférences des sports de lutilisateur authentifié.</p>
<p><strong>Scope</strong>: <code class="docutils literal notranslate"><span class="pre">profile:write</span></code></p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Scope</strong> : <code class="docutils literal notranslate"><span class="pre">profile:write</span></code></p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">POST</span> <span class="nn">/api/auth/profile/edit/sports</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
@ -889,13 +889,13 @@
<dt class="sig sig-object http" id="delete--api-auth-profile-reset-sports-(sport_id)">
<span class="sig-name descname"><span class="pre">DELETE</span> </span><span class="sig-name descname"><span class="pre">/api/auth/profile/reset/sports/</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">sport_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#delete--api-auth-profile-reset-sports-(sport_id)" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Réinitialiser les préférences de lutilisateur authentifié pour un sport donné.</p>
<p><strong>Scope</strong>: <code class="docutils literal notranslate"><span class="pre">profile:write</span></code></p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Scope</strong> : <code class="docutils literal notranslate"><span class="pre">profile:write</span></code></p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">DELETE</span> <span class="nn">/api/auth/profile/reset/sports/1</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">204</span> <span class="ne">OK</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
@ -931,13 +931,13 @@
<dt class="sig sig-object http" id="post--api-auth-picture">
<span class="sig-name descname"><span class="pre">POST</span> </span><span class="sig-name descname"><span class="pre">/api/auth/picture</span></span><a class="headerlink" href="#post--api-auth-picture" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Mise à jour de limage de lutilisateur authentifié.</p>
<p><strong>Scope</strong>: <code class="docutils literal notranslate"><span class="pre">profile:write</span></code></p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Scope</strong> : <code class="docutils literal notranslate"><span class="pre">profile:write</span></code></p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">POST</span> <span class="nn">/api/auth/picture</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">multipart/form-data</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
@ -985,13 +985,13 @@
<dt class="sig sig-object http" id="delete--api-auth-picture">
<span class="sig-name descname"><span class="pre">DELETE</span> </span><span class="sig-name descname"><span class="pre">/api/auth/picture</span></span><a class="headerlink" href="#delete--api-auth-picture" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Supprimer limage de lutilisateur authentifié.</p>
<p><strong>Scope</strong>: <code class="docutils literal notranslate"><span class="pre">profile:write</span></code></p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Scope</strong> : <code class="docutils literal notranslate"><span class="pre">profile:write</span></code></p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">DELETE</span> <span class="nn">/api/auth/picture</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">204</span> <span class="ne">NO CONTENT</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
@ -1021,13 +1021,13 @@
<dt class="sig sig-object http" id="post--api-auth-password-reset-request">
<span class="sig-name descname"><span class="pre">POST</span> </span><span class="sig-name descname"><span class="pre">/api/auth/password/reset-request</span></span><a class="headerlink" href="#post--api-auth-password-reset-request" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Traiter les demandes de réinitialisation de mot de passe.</p>
<p>Si lenvoi de courriels est désactivé, ce point daccès nest pas disponible.</p>
<p><strong>Exemple de requête</strong>:</p>
<p>Si lenvoi des courriels est désactivé, ce point daccès nest pas disponible.</p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">POST</span> <span class="nn">/api/auth/password/reset-request</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
@ -1060,20 +1060,20 @@
<p>Les courriels suivants sont envoyés si lenvoi est activé :</p>
<ul class="simple">
<li><p>Modification de mot de passe</p></li>
<li><p>Changement dadresse électronique</p>
<li><p>Changement dadresse électronique :</p>
<ul>
<li><p>un à ladresse actuelle pour informer lutilisateur</p></li>
<li><p>un autre à la nouvelle adresse pour la confirmer.</p></li>
</ul>
</li>
</ul>
<p><strong>Scope</strong>: <code class="docutils literal notranslate"><span class="pre">profile:write</span></code></p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Scope</strong> : <code class="docutils literal notranslate"><span class="pre">profile:write</span></code></p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">PATCH</span> <span class="nn">/api/auth/profile/edit/account</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
@ -1205,12 +1205,12 @@
<span class="sig-name descname"><span class="pre">POST</span> </span><span class="sig-name descname"><span class="pre">/api/auth/password/update</span></span><a class="headerlink" href="#post--api-auth-password-update" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Mise à jour du mot de passe de lutilisateur après une demande de réinitialisation du mot de passe.</p>
<p>Uniquement si lenvoi est activé.</p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">POST</span> <span class="nn">/api/auth/password/update</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
@ -1242,12 +1242,12 @@
<dt class="sig sig-object http" id="post--api-auth-email-update">
<span class="sig-name descname"><span class="pre">POST</span> </span><span class="sig-name descname"><span class="pre">/api/auth/email/update</span></span><a class="headerlink" href="#post--api-auth-email-update" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Mise à jour de ladresse électronique de lutilisateur après confirmation.</p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">POST</span> <span class="nn">/api/auth/email/update</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
@ -1277,12 +1277,12 @@
<dt class="sig sig-object http" id="post--api-auth-logout">
<span class="sig-name descname"><span class="pre">POST</span> </span><span class="sig-name descname"><span class="pre">/api/auth/logout</span></span><a class="headerlink" href="#post--api-auth-logout" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Déconnexion de lutilisateur. Si un jeton valide est fourni, il sera invalidé.</p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">POST</span> <span class="nn">/api/auth/logout</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponses</strong> :</p>
<ul class="simple">
<li><p>déconnexion avec succès :</p></li>
</ul>
@ -1332,12 +1332,12 @@
<dt class="sig sig-object http" id="post--api-auth-account-privacy-policy">
<span class="sig-name descname"><span class="pre">POST</span> </span><span class="sig-name descname"><span class="pre">/api/auth/account/privacy-policy</span></span><a class="headerlink" href="#post--api-auth-account-privacy-policy" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Lutilisateur authentifié accepte la politique de confidentialité.</p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">POST</span> <span class="nn">/auth/account/privacy-policy</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
@ -1383,14 +1383,14 @@
<li><p>état de lexport (<code class="docutils literal notranslate"><span class="pre">in_progress</span></code>, <code class="docutils literal notranslate"><span class="pre">successful</span></code> and <code class="docutils literal notranslate"><span class="pre">errored</span></code>)</p></li>
<li><p>nom du fichier et sa taille (en octets) lorsque lexport est réussi</p></li>
</ul>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">GET</span> <span class="nn">/auth/account/export</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<ul class="simple">
<li><p>si une requête existe</p></li>
<li><p>si une requête existe :</p></li>
</ul>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
@ -1442,12 +1442,12 @@
<dt class="sig sig-object http" id="post--api-auth-account-export-request">
<span class="sig-name descname"><span class="pre">POST</span> </span><span class="sig-name descname"><span class="pre">/api/auth/account/export/request</span></span><a class="headerlink" href="#post--api-auth-account-export-request" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Demande dexport de données pour un utilisateur authentifié.</p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">POST</span> <span class="nn">/auth/account/export/request</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
@ -1492,12 +1492,12 @@
<dt class="sig sig-object http" id="get--api-auth-account-export-(string-file_name)">
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/api/auth/account/export/</span></span><span class="sig-paren">(</span><em class="property"><span class="pre">string:</span> </em><em class="sig-param"><span class="pre">file_name</span></em><span class="sig-paren">)</span><a class="headerlink" href="#get--api-auth-account-export-(string-file_name)" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Télécharger une archive dexport de données</p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">GET</span> <span class="nn">/auth/account/export/download/archive_rgjsR3fHr5Yp.zip</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/x-gzip</span>
</pre></div>

View File

@ -235,12 +235,12 @@
<dt class="sig sig-object http" id="get--api-config">
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/api/config</span></span><a class="headerlink" href="#get--api-config" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Obtenir la configuration de lapplication.</p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">GET</span> <span class="nn">/api/config</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
@ -278,14 +278,14 @@
<dt class="sig sig-object http" id="patch--api-config">
<span class="sig-name descname"><span class="pre">PATCH</span> </span><span class="sig-name descname"><span class="pre">/api/config</span></span><a class="headerlink" href="#patch--api-config" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Mettre à jour de la configuration de lapplication.</p>
<p>Lutilisateur authentifié doit avoir des droits dadministration</p>
<p><strong>Scope</strong>: <code class="docutils literal notranslate"><span class="pre">application:write</span></code></p>
<p><strong>Exemple de requête</strong>:</p>
<p>Lutilisateur authentifié doit avoir des droits dadministration.</p>
<p><strong>Scope</strong> : <code class="docutils literal notranslate"><span class="pre">application:write</span></code></p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">GET</span> <span class="nn">/api/config</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
@ -349,12 +349,12 @@
<dt class="sig sig-object http" id="get--api-ping">
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/api/ping</span></span><a class="headerlink" href="#get--api-ping" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>point daccès de contrôle</p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">GET</span> <span class="nn">/api/ping</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>

View File

@ -232,7 +232,7 @@
<section id="api-documentation">
<h1>Documentation de lAPI<a class="headerlink" href="#api-documentation" title="Lien permanent vers cette rubrique">#</a></h1>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Points d'accès</span></p>
<p class="caption" role="heading"><span class="caption-text">Points d'accès :</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="auth.html">Authentification et compte</a></li>
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>

View File

@ -236,7 +236,7 @@
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/api/oauth/apps</span></span><a class="headerlink" href="#get--api-oauth-apps" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Obtenir les clients OAuth2 pour lutilisateur authentifié avec pagination (5 clients/page).</p>
<p>Ce point daccès nest accessible que par le client web FitTrackee client.</p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Exemple de requête</strong> :</p>
<ul class="simple">
<li><p>sans paramètres :</p></li>
</ul>
@ -251,7 +251,7 @@
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">SUCCESS</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
@ -313,12 +313,12 @@
<span class="sig-name descname"><span class="pre">POST</span> </span><span class="sig-name descname"><span class="pre">/api/oauth/apps</span></span><a class="headerlink" href="#post--api-oauth-apps" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Créer un client OAuth2 pour lutilisateur authentifié.</p>
<p>Ce point daccès nest accessible que par le client web FitTrackee client.</p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">POST</span> <span class="nn">/api/oauth/apps</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">SUCCESS</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
@ -377,12 +377,12 @@
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/api/oauth/apps/</span></span><span class="sig-paren">(</span><em class="property"><span class="pre">string:</span> </em><em class="sig-param"><span class="pre">client_client_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#get--api-oauth-apps-(string-client_client_id)" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Obtenir un client OAuth2 avec le “client_id”.</p>
<p>Ce point daccès nest accessible que par le client web FitTrackee client.</p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">GET</span> <span class="nn">/api/oauth/apps/o22a27s2aBPUoxJbxV3UjDOx</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponses</strong> :</p>
<ul class="simple">
<li><p>success:</p></li>
</ul>
@ -451,12 +451,12 @@
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/api/oauth/apps/</span></span><span class="sig-paren">(</span><em class="property"><span class="pre">int:</span> </em><em class="sig-param"><span class="pre">client_id</span></em><span class="sig-paren">)</span><span class="sig-name descname"><span class="pre">/by_id</span></span><a class="headerlink" href="#get--api-oauth-apps-(int-client_id)-by_id" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Obtenir un client OAuth2 avec lidentifiant (entier).</p>
<p>Ce point daccès nest accessible que par le client web FitTrackee client.</p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">GET</span> <span class="nn">/api/oauth/apps/1/by_id</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponses</strong> :</p>
<ul class="simple">
<li><p>success:</p></li>
</ul>
@ -525,12 +525,12 @@
<span class="sig-name descname"><span class="pre">DELETE</span> </span><span class="sig-name descname"><span class="pre">/api/oauth/apps/</span></span><span class="sig-paren">(</span><em class="property"><span class="pre">int:</span> </em><em class="sig-param"><span class="pre">client_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#delete--api-oauth-apps-(int-client_id)" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Delete an OAuth2 client (app).</p>
<p>Ce point daccès nest accessible que par le client web FitTrackee client.</p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">DELETE</span> <span class="nn">/api/oauth/apps/1</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">204</span> <span class="ne">NO CONTENT</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
@ -564,14 +564,14 @@
<dl class="http post">
<dt class="sig sig-object http" id="post--api-oauth-apps-(int-client_id)-revoke">
<span class="sig-name descname"><span class="pre">POST</span> </span><span class="sig-name descname"><span class="pre">/api/oauth/apps/</span></span><span class="sig-paren">(</span><em class="property"><span class="pre">int:</span> </em><em class="sig-param"><span class="pre">client_id</span></em><span class="sig-paren">)</span><span class="sig-name descname"><span class="pre">/revoke</span></span><a class="headerlink" href="#post--api-oauth-apps-(int-client_id)-revoke" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Révoquer tous les tokens associés à un client OAuth2</p>
<dd><p>Révoquer tous les tokens associés à un client OAuth2.</p>
<p>Ce point daccès nest accessible que par le client web FitTrackee client.</p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">POST</span> <span class="nn">/api/oauth/apps/1/revoke</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">SUCCESS</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
@ -611,12 +611,12 @@
<span class="sig-name descname"><span class="pre">POST</span> </span><span class="sig-name descname"><span class="pre">/api/oauth/authorize</span></span><a class="headerlink" href="#post--api-oauth-authorize" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Autoriser un client OAuth2 (app). En cas de succès, il redirige vers lURL de redirection du client avec le code pour émettre un jeton.</p>
<p>Ce point daccès nest accessible que par le client web FitTrackee client.</p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">POST</span> <span class="nn">/api/oauth/authorize</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">multipart/form-data</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">SUCCESS</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
@ -664,13 +664,13 @@
<dl class="http post">
<dt class="sig sig-object http" id="post--api-oauth-token">
<span class="sig-name descname"><span class="pre">POST</span> </span><span class="sig-name descname"><span class="pre">/api/oauth/token</span></span><a class="headerlink" href="#post--api-oauth-token" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Délivrer ou rafraîchir un jeton pour un client OAuth2 donné</p>
<p><strong>Exemple de requête</strong>:</p>
<dd><p>Délivrer ou rafraîchir un jeton pour un client OAuth2 donné.</p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">POST</span> <span class="nn">/api/oauth/token</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">multipart/form-data</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">SUCCESS</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
@ -713,13 +713,13 @@
<dl class="http post">
<dt class="sig sig-object http" id="post--api-oauth-revoke">
<span class="sig-name descname"><span class="pre">POST</span> </span><span class="sig-name descname"><span class="pre">/api/oauth/revoke</span></span><a class="headerlink" href="#post--api-oauth-revoke" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Révoquer un jeton pour un client OAuth2 donné</p>
<p><strong>Exemple de requête</strong>:</p>
<dd><p>Révoquer un jeton pour un client OAuth2 donné.</p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">POST</span> <span class="nn">/api/oauth/revoke</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">multipart/form-data</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">SUCCESS</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>

View File

@ -237,21 +237,21 @@
<dd><p>Obtenir tous les records pour lutilisateur authentifié.</p>
<dl class="simple">
<dt>Les types de records suivants sont disponibles :</dt><dd><ul class="simple">
<li><p>vitesse moyenne (record_type: <code class="docutils literal notranslate"><span class="pre">AS</span></code>)</p></li>
<li><p>distance la plus elevée (record_type: <code class="docutils literal notranslate"><span class="pre">FD</span></code>)</p></li>
<li><p>dénivelé le plus élevé (record_type: <code class="docutils literal notranslate"><span class="pre">HA</span></code>)</p></li>
<li><p>durée la plus longue (record_type: <code class="docutils literal notranslate"><span class="pre">LD</span></code>)</p></li>
<li><p>vitesse maximale (record_type: <code class="docutils literal notranslate"><span class="pre">MS</span></code>)</p></li>
<li><p>vitesse moyenne (record_type : <code class="docutils literal notranslate"><span class="pre">AS</span></code>)</p></li>
<li><p>distance la plus elevée (record_type : <code class="docutils literal notranslate"><span class="pre">FD</span></code>)</p></li>
<li><p>dénivelé le plus élevé (record_type : <code class="docutils literal notranslate"><span class="pre">HA</span></code>)</p></li>
<li><p>durée la plus longue (record_type : <code class="docutils literal notranslate"><span class="pre">LD</span></code>)</p></li>
<li><p>vitesse maximale (record_type : <code class="docutils literal notranslate"><span class="pre">MS</span></code>)</p></li>
</ul>
</dd>
</dl>
<p><strong>Scope</strong>: <code class="docutils literal notranslate"><span class="pre">workouts:read</span></code></p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Scope</strong> : <code class="docutils literal notranslate"><span class="pre">workouts:read</span></code></p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">GET</span> <span class="nn">/api/records</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponses</strong> :</p>
<ul class="simple">
<li><p>retournant des records</p></li>
</ul>

View File

@ -235,15 +235,15 @@
<dt class="sig sig-object http" id="get--api-sports">
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/api/sports</span></span><a class="headerlink" href="#get--api-sports" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Obtenir tous les sports</p>
<p><strong>Scope</strong>: <code class="docutils literal notranslate"><span class="pre">workouts:read</span></code></p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Scope</strong> : <code class="docutils literal notranslate"><span class="pre">workouts:read</span></code></p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">GET</span> <span class="nn">/api/sports</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<ul class="simple">
<li><p>pour un utilisateur non admin</p></li>
<li><p>pour un utilisateur non admin :</p></li>
</ul>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
@ -306,7 +306,7 @@
</pre></div>
</div>
<ul class="simple">
<li><p>pour un administrateur</p></li>
<li><p>pour un administrateur :</p></li>
</ul>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
@ -398,15 +398,15 @@
<dt class="sig sig-object http" id="get--api-sports-(int-sport_id)">
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/api/sports/</span></span><span class="sig-paren">(</span><em class="property"><span class="pre">int:</span> </em><em class="sig-param"><span class="pre">sport_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#get--api-sports-(int-sport_id)" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Obtenir un sport</p>
<p><strong>Scope</strong>: <code class="docutils literal notranslate"><span class="pre">workouts:read</span></code></p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Scope</strong> : <code class="docutils literal notranslate"><span class="pre">workouts:read</span></code></p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">GET</span> <span class="nn">/api/sports/1</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<ul class="simple">
<li><p>succès pour un utilisateur non admin:</p></li>
<li><p>succès pour un utilisateur non admin :</p></li>
</ul>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
@ -429,7 +429,7 @@
</pre></div>
</div>
<ul class="simple">
<li><p>succès pour un administrateur</p></li>
<li><p>succès pour un administrateur :</p></li>
</ul>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
@ -495,15 +495,15 @@
<dl class="http patch">
<dt class="sig sig-object http" id="patch--api-sports-(int-sport_id)">
<span class="sig-name descname"><span class="pre">PATCH</span> </span><span class="sig-name descname"><span class="pre">/api/sports/</span></span><span class="sig-paren">(</span><em class="property"><span class="pre">int:</span> </em><em class="sig-param"><span class="pre">sport_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#patch--api-sports-(int-sport_id)" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Modifier un sport</p>
<p>Lutilisateur authentifié doit avoir des droits dadministration</p>
<p><strong>Scope</strong>: <code class="docutils literal notranslate"><span class="pre">workouts:write</span></code></p>
<p><strong>Exemple de requête</strong>:</p>
<dd><p>Modifier un sport.</p>
<p>Lutilisateur authentifié doit avoir des droits dadministration.</p>
<p><strong>Scope</strong> : <code class="docutils literal notranslate"><span class="pre">workouts:write</span></code></p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">PATCH</span> <span class="nn">/api/sports/1</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponses</strong> :</p>
<ul class="simple">
<li><p>success:</p></li>
</ul>

View File

@ -234,9 +234,9 @@
<dl class="http get">
<dt class="sig sig-object http" id="get--api-stats-(user_name)-by_time">
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/api/stats/</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">user_name</span></em><span class="sig-paren">)</span><span class="sig-name descname"><span class="pre">/by_time</span></span><a class="headerlink" href="#get--api-stats-(user_name)-by_time" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Obtenir des statistiques sur les séances dentraînement pour un utilisateur par durée</p>
<p><strong>Scope</strong>: <code class="docutils literal notranslate"><span class="pre">workouts:read</span></code></p>
<p><strong>Exemple de requêtes</strong>:</p>
<dd><p>Obtenir des statistiques sur les séances dentraînement pour un utilisateur par durée.</p>
<p><strong>Scope</strong> : <code class="docutils literal notranslate"><span class="pre">workouts:read</span></code></p>
<p><strong>Exemple de requêtes</strong> :</p>
<ul class="simple">
<li><p>sans paramètres :</p></li>
</ul>
@ -244,13 +244,13 @@
</pre></div>
</div>
<ul class="simple">
<li><p>avec des paramètres</p></li>
<li><p>avec des paramètres :</p></li>
</ul>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">GET</span> <span class="nn">/api/stats/admin/by_time?from=2018-01-01&amp;to=2018-06-30&amp;time=week</span>
<span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponses</strong> :</p>
<ul class="simple">
<li><p>success:</p></li>
</ul>
@ -316,9 +316,9 @@
</dd>
<dt class="field-even">Paramètres de requête<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>from</strong> (<em>string</em>) date de début (format: <code class="docutils literal notranslate"><span class="pre">%Y-%m-%d</span></code>)</p></li>
<li><p><strong>to</strong> (<em>string</em>) date de fin (format: <code class="docutils literal notranslate"><span class="pre">%Y-%m-%d</span></code>)</p></li>
<li><p><strong>time</strong> (<em>string</em>) période de temps : - <code class="docutils literal notranslate"><span class="pre">week</span></code>: semaine commençant le dimanche - <code class="docutils literal notranslate"><span class="pre">weekm</span></code>: semaine commençant le lundi - <code class="docutils literal notranslate"><span class="pre">month</span></code>: mois - <code class="docutils literal notranslate"><span class="pre">year</span></code>: année (default)</p></li>
<li><p><strong>from</strong> (<em>string</em>) date de début (format : <code class="docutils literal notranslate"><span class="pre">%Y-%m-%d</span></code>)</p></li>
<li><p><strong>to</strong> (<em>string</em>) date de fin (format : <code class="docutils literal notranslate"><span class="pre">%Y-%m-%d</span></code>)</p></li>
<li><p><strong>time</strong> (<em>string</em>) période de temps : - <code class="docutils literal notranslate"><span class="pre">week</span></code> : semaine commençant le dimanche - <code class="docutils literal notranslate"><span class="pre">weekm</span></code> : semaine commençant le lundi - <code class="docutils literal notranslate"><span class="pre">month</span></code> : mois - <code class="docutils literal notranslate"><span class="pre">year</span></code> : année (default)</p></li>
</ul>
</dd>
<dt class="field-odd">En-têtes de requête<span class="colon">:</span></dt>
@ -345,8 +345,8 @@
<dt class="sig sig-object http" id="get--api-stats-(user_name)-by_sport">
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/api/stats/</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">user_name</span></em><span class="sig-paren">)</span><span class="sig-name descname"><span class="pre">/by_sport</span></span><a class="headerlink" href="#get--api-stats-(user_name)-by_sport" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Obtenir les statistiques des séances pour un utilisateur par sport.</p>
<p><strong>Scope</strong>: <code class="docutils literal notranslate"><span class="pre">workouts:read</span></code></p>
<p><strong>Exemple de requêtes</strong>:</p>
<p><strong>Scope</strong> : <code class="docutils literal notranslate"><span class="pre">workouts:read</span></code></p>
<p><strong>Exemple de requêtes</strong> :</p>
<ul class="simple">
<li><p>without parameters (get stats for all sports with workouts):</p></li>
</ul>
@ -354,12 +354,12 @@
</pre></div>
</div>
<ul class="simple">
<li><p>avec lidentifiant du sport</p></li>
<li><p>avec lidentifiant du sport :</p></li>
</ul>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">GET</span> <span class="nn">/api/stats/admin/by_sport?sport_id=1</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponses</strong> :</p>
<ul class="simple">
<li><p>success:</p></li>
</ul>
@ -452,12 +452,12 @@
<dt class="sig sig-object http" id="get--api-stats-all">
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/api/stats/all</span></span><a class="headerlink" href="#get--api-stats-all" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Obtenir toutes les statistiques de lapplication.</p>
<p><strong>Scope</strong>: <code class="docutils literal notranslate"><span class="pre">workouts:read</span></code></p>
<p><strong>Exemple de requêtes</strong>:</p>
<p><strong>Scope</strong> : <code class="docutils literal notranslate"><span class="pre">workouts:read</span></code></p>
<p><strong>Exemple de requêtes</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">GET</span> <span class="nn">/api/stats/all</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponses</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>

View File

@ -236,8 +236,8 @@
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/api/users</span></span><a class="headerlink" href="#get--api-users" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Obtenir tous les utilisateurs (quel que soit le statut de leur compte), si lutilisateur authentifié a des droits dadministration.</p>
<p>Ne renvoie les préférences de lutilisateur que pour lutilisateur authentifié.</p>
<p><strong>Scope</strong>: <code class="docutils literal notranslate"><span class="pre">users:read</span></code></p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Scope</strong> : <code class="docutils literal notranslate"><span class="pre">users:read</span></code></p>
<p><strong>Exemple de requête</strong> :</p>
<ul class="simple">
<li><p>sans paramètres :</p></li>
</ul>
@ -252,7 +252,7 @@
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
@ -393,13 +393,13 @@
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/api/users/</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">user_name</span></em><span class="sig-paren">)</span><a class="headerlink" href="#get--api-users-(user_name)" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Obtenir les information dun utilisateur. Seul lutilisateur disposant des droits dadministrateur peut obtenir les informations des autres utilisateurs.</p>
<p>Ne renvoie les préférences de lutilisateur que pour lutilisateur authentifié.</p>
<p><strong>Scope</strong>: <code class="docutils literal notranslate"><span class="pre">users:read</span></code></p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Scope</strong> : <code class="docutils literal notranslate"><span class="pre">users:read</span></code></p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">GET</span> <span class="nn">/api/users/admin</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
@ -515,12 +515,12 @@
<dt class="sig sig-object http" id="get--api-users-(user_name)-picture">
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/api/users/</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">user_name</span></em><span class="sig-paren">)</span><span class="sig-name descname"><span class="pre">/picture</span></span><a class="headerlink" href="#get--api-users-(user_name)-picture" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>obtenir limage de lutilisateur</p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">GET</span> <span class="nn">/api/users/admin/picture</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">image/jpeg</span>
</pre></div>
@ -555,13 +555,13 @@
<li><p>activer le compte dun utilisateur inactif</p></li>
</ul>
<p>Seul lutilisateur ayant des droits dadministration peut modifier un autre utilisateur.</p>
<p><strong>Scope</strong>: <code class="docutils literal notranslate"><span class="pre">users:write</span></code></p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Scope</strong> : <code class="docutils literal notranslate"><span class="pre">users:write</span></code></p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">PATCH</span> <span class="nn">/api/users/&lt;user_name&gt;</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
@ -653,7 +653,7 @@
<dt class="field-even">Objet JSON de requête<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>activate</strong> (<em>boolean</em>) activer le compte utilisateur</p></li>
<li><p><strong>admin</strong> (<em>boolean</em>) lutilisateur dispose-t-il de droits dadministration ?</p></li>
<li><p><strong>admin</strong> (<em>boolean</em>) lutilisateur dispose-t-il de droits dadministration</p></li>
<li><p><strong>new_email</strong> (<em>boolean</em>) nouvelle adresse électronique de lutilisateur</p></li>
<li><p><strong>reset_password</strong> (<em>boolean</em>) réinitialiser le mot de passe de lutilisateur</p></li>
</ul>
@ -692,13 +692,13 @@
<dd><p>Supprimer un compte utilisateur.</p>
<p>Un utilisateur ne peut supprimer que son propre compte.</p>
<p>Un administrateur peut supprimer tous les comptes sauf le sien sil est le seul administrateur.</p>
<p><strong>Scope</strong>: <code class="docutils literal notranslate"><span class="pre">users:write</span></code></p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Scope</strong> : <code class="docutils literal notranslate"><span class="pre">users:write</span></code></p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">DELETE</span> <span class="nn">/api/users/john_doe</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">204</span> <span class="ne">NO CONTENT</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>

View File

@ -235,8 +235,8 @@
<dt class="sig sig-object http" id="get--api-workouts">
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/api/workouts</span></span><a class="headerlink" href="#get--api-workouts" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Obtenir les séances de lutilisateur authentifié.</p>
<p><strong>Scope</strong>: <code class="docutils literal notranslate"><span class="pre">workouts:read</span></code></p>
<p><strong>Exemple de requêtes</strong>:</p>
<p><strong>Scope</strong> : <code class="docutils literal notranslate"><span class="pre">workouts:read</span></code></p>
<p><strong>Exemple de requêtes</strong> :</p>
<ul class="simple">
<li><p>sans paramètres :</p></li>
</ul>
@ -249,7 +249,7 @@
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">GET</span> <span class="nn">/api/workouts?from=2019-07-02&amp;to=2019-07-31&amp;sport_id=1</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponses</strong> :</p>
<ul class="simple">
<li><p>renvoyant au moins une séance :</p></li>
</ul>
@ -361,12 +361,12 @@
<li><p><strong>per_page</strong> (<em>integer</em>) nombre dentraînements par page (par défaut : 5, max : 100)</p></li>
<li><p><strong>sport_id</strong> (<em>integer</em>) identifiant du sport</p></li>
<li><p><strong>title</strong> (<em>string</em>) une partie (ou la totalité) du titre de la séance, la correspondance entre les titres ne tient pas compte des majuscules et des minuscules</p></li>
<li><p><strong>from</strong> (<em>string</em>) date de début (format: <code class="docutils literal notranslate"><span class="pre">%Y-%m-%d</span></code>)</p></li>
<li><p><strong>to</strong> (<em>string</em>) date de fin (format: <code class="docutils literal notranslate"><span class="pre">%Y-%m-%d</span></code>)</p></li>
<li><p><strong>from</strong> (<em>string</em>) date de début (format : <code class="docutils literal notranslate"><span class="pre">%Y-%m-%d</span></code>)</p></li>
<li><p><strong>to</strong> (<em>string</em>) date de fin (format : <code class="docutils literal notranslate"><span class="pre">%Y-%m-%d</span></code>)</p></li>
<li><p><strong>distance_from</strong> (<em>float</em>) distance minimale</p></li>
<li><p><strong>distance_to</strong> (<em>float</em>) distance maximale</p></li>
<li><p><strong>duration_from</strong> (<em>string</em>) durée minimale (format: <code class="docutils literal notranslate"><span class="pre">%H:%M</span></code>)</p></li>
<li><p><strong>duration_to</strong> (<em>string</em>) distance maximale (format: <code class="docutils literal notranslate"><span class="pre">%H:%M</span></code>)</p></li>
<li><p><strong>duration_from</strong> (<em>string</em>) durée minimale (format : <code class="docutils literal notranslate"><span class="pre">%H:%M</span></code>)</p></li>
<li><p><strong>duration_to</strong> (<em>string</em>) distance maximale (format : <code class="docutils literal notranslate"><span class="pre">%H:%M</span></code>)</p></li>
<li><p><strong>ave_speed_from</strong> (<em>float</em>) vitesse moyenne minimale</p></li>
<li><p><strong>ave_speed_to</strong> (<em>float</em>) vitesse moyenne maximale</p></li>
<li><p><strong>max_speed_from</strong> (<em>float</em>) vitesse max. minimale</p></li>
@ -401,12 +401,12 @@
<dt class="sig sig-object http" id="get--api-workouts-(string-workout_short_id)">
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/api/workouts/</span></span><span class="sig-paren">(</span><em class="property"><span class="pre">string:</span> </em><em class="sig-param"><span class="pre">workout_short_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#get--api-workouts-(string-workout_short_id)" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Obtenir une séance.</p>
<p><strong>Scope</strong>: <code class="docutils literal notranslate"><span class="pre">workouts:read</span></code></p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Scope</strong> : <code class="docutils literal notranslate"><span class="pre">workouts:read</span></code></p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">GET</span> <span class="nn">/api/workouts/kjxavSTUrJvoAh2wvCeGEF</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponses</strong> :</p>
<ul class="simple">
<li><p>success:</p></li>
</ul>
@ -496,13 +496,13 @@
<dt class="sig sig-object http" id="get--api-workouts-(string-workout_short_id)-gpx">
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/api/workouts/</span></span><span class="sig-paren">(</span><em class="property"><span class="pre">string:</span> </em><em class="sig-param"><span class="pre">workout_short_id</span></em><span class="sig-paren">)</span><span class="sig-name descname"><span class="pre">/gpx</span></span><a class="headerlink" href="#get--api-workouts-(string-workout_short_id)-gpx" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Obtenir un fichier gpx pour une séance affichée sur une carte avec Leaflet.</p>
<p><strong>Scope</strong>: <code class="docutils literal notranslate"><span class="pre">workouts:read</span></code></p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Scope</strong> : <code class="docutils literal notranslate"><span class="pre">workouts:read</span></code></p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">GET</span> <span class="nn">/api/workouts/kjxavSTUrJvoAh2wvCeGEF/gpx</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
@ -549,14 +549,14 @@
<dl class="http get">
<dt class="sig sig-object http" id="get--api-workouts-(string-workout_short_id)-chart_data">
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/api/workouts/</span></span><span class="sig-paren">(</span><em class="property"><span class="pre">string:</span> </em><em class="sig-param"><span class="pre">workout_short_id</span></em><span class="sig-paren">)</span><span class="sig-name descname"><span class="pre">/chart_data</span></span><a class="headerlink" href="#get--api-workouts-(string-workout_short_id)-chart_data" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Récupérer les données dune séance avec gpx pour les afficher avec Chart.js</p>
<p><strong>Scope</strong>: <code class="docutils literal notranslate"><span class="pre">workouts:read</span></code></p>
<p><strong>Exemple de requête</strong>:</p>
<dd><p>Récupérer les données dune séance avec gpx pour les afficher avec Chart.js.</p>
<p><strong>Scope</strong> : <code class="docutils literal notranslate"><span class="pre">workouts:read</span></code></p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">GET</span> <span class="nn">/api/workouts/kjxavSTUrJvoAh2wvCeGEF/chart</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
@ -622,14 +622,14 @@
<dl class="http get">
<dt class="sig sig-object http" id="get--api-workouts-(string-workout_short_id)-chart_data-segment-(int-segment_id)">
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/api/workouts/</span></span><span class="sig-paren">(</span><em class="property"><span class="pre">string:</span> </em><em class="sig-param"><span class="pre">workout_short_id</span></em><span class="sig-paren">)</span><span class="sig-name descname"><span class="pre">/chart_data/segment/</span></span><span class="sig-paren">(</span><em class="property"><span class="pre">int:</span> </em><em class="sig-param"><span class="pre">segment_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#get--api-workouts-(string-workout_short_id)-chart_data-segment-(int-segment_id)" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Récupérer les données dune séance avec gpx pour les afficher avec Chart.js</p>
<p><strong>Scope</strong>: <code class="docutils literal notranslate"><span class="pre">workouts:read</span></code></p>
<p><strong>Exemple de requête</strong>:</p>
<dd><p>Récupérer les données dune séance avec gpx pour les afficher avec Chart.js.</p>
<p><strong>Scope</strong> : <code class="docutils literal notranslate"><span class="pre">workouts:read</span></code></p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">GET</span> <span class="nn">/api/workouts/kjxavSTUrJvoAh2wvCeGEF/chart/segment/0</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
@ -694,13 +694,13 @@
<dt class="sig sig-object http" id="get--api-workouts-(string-workout_short_id)-gpx-segment-(int-segment_id)">
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/api/workouts/</span></span><span class="sig-paren">(</span><em class="property"><span class="pre">string:</span> </em><em class="sig-param"><span class="pre">workout_short_id</span></em><span class="sig-paren">)</span><span class="sig-name descname"><span class="pre">/gpx/segment/</span></span><span class="sig-paren">(</span><em class="property"><span class="pre">int:</span> </em><em class="sig-param"><span class="pre">segment_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#get--api-workouts-(string-workout_short_id)-gpx-segment-(int-segment_id)" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Obtenir un fichier gpx pour le segment dune séance pour lafficher sur la carte avec Leaflet.</p>
<p><strong>Scope</strong>: <code class="docutils literal notranslate"><span class="pre">workouts:read</span></code></p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Scope</strong> : <code class="docutils literal notranslate"><span class="pre">workouts:read</span></code></p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">GET</span> <span class="nn">/api/workouts/kjxavSTUrJvoAh2wvCeGEF/gpx/segment/0</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
@ -746,12 +746,12 @@
<dt class="sig sig-object http" id="get--api-workouts-map-(map_id)">
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/api/workouts/map/</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">map_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#get--api-workouts-map-(map_id)" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Obtenir limage de la carte pour les séances avec gpx.</p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">GET</span> <span class="nn">/api/workouts/map/fa33f4d996844a5c73ecd1ae24456ab8?1563529507772</span>
<span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">image/png</span>
</pre></div>
@ -782,11 +782,11 @@
<dt class="sig sig-object http" id="get--api-workouts-map_tile-(s)-(z)-(x)-(y).png">
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/api/workouts/map_tile/</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">s</span></em><span class="sig-paren">)</span><span class="sig-name descname"><span class="pre">/</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">z</span></em><span class="sig-paren">)</span><span class="sig-name descname"><span class="pre">/</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">x</span></em><span class="sig-paren">)</span><span class="sig-name descname"><span class="pre">/</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">y</span></em><span class="sig-paren">)</span><span class="sig-name descname"><span class="pre">.png</span></span><a class="headerlink" href="#get--api-workouts-map_tile-(s)-(z)-(x)-(y).png" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Obtenir une tuile de la carte à partir du serveur de tuiles.</p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">GET</span> <span class="nn">/api/workouts/map_tile/c/13/4109/2930.png</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">image/png</span>
</pre></div>
@ -801,19 +801,19 @@
</ul>
</dd>
</dl>
<p>Les codes détat sont des codes détat renvoyés par le serveur de tuiles.</p>
<p>Les codes détat sont des codes détat renvoyés par le serveur de tuiles</p>
</dd></dl>
<dl class="http get">
<dt class="sig sig-object http" id="get--api-workouts-(string-workout_short_id)-gpx-download">
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/api/workouts/</span></span><span class="sig-paren">(</span><em class="property"><span class="pre">string:</span> </em><em class="sig-param"><span class="pre">workout_short_id</span></em><span class="sig-paren">)</span><span class="sig-name descname"><span class="pre">/gpx/download</span></span><a class="headerlink" href="#get--api-workouts-(string-workout_short_id)-gpx-download" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Télécharger le fichier gpx.</p>
<p><strong>Scope</strong>: <code class="docutils literal notranslate"><span class="pre">workouts:read</span></code></p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Scope</strong> : <code class="docutils literal notranslate"><span class="pre">workouts:read</span></code></p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">GET</span> <span class="nn">/api/workouts/kjxavSTUrJvoAh2wvCeGEF/gpx/download</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/gpx+xml</span>
</pre></div>
@ -847,13 +847,13 @@
<dt class="sig sig-object http" id="post--api-workouts">
<span class="sig-name descname"><span class="pre">POST</span> </span><span class="sig-name descname"><span class="pre">/api/workouts</span></span><a class="headerlink" href="#post--api-workouts" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Créer une séance à partir dun fichier gpx.</p>
<p><strong>Scope</strong>: <code class="docutils literal notranslate"><span class="pre">workouts:write</span></code></p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Scope</strong> : <code class="docutils literal notranslate"><span class="pre">workouts:write</span></code></p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">POST</span> <span class="nn">/api/workouts/</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">multipart/form-data</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">201</span> <span class="ne">CREATED</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
@ -936,7 +936,7 @@
<dt class="field-odd">Paramètres de la forme<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>file</strong> fichier gpx (extensions autorisées : .gpx, .zip)</p></li>
<li><p><strong>data</strong> lidentifiant du sport et les notes (exemple : <code class="docutils literal notranslate"><span class="pre">{&quot;sport_id&quot;:</span> <span class="pre">1,</span> <span class="pre">&quot;notes&quot;:</span> <span class="pre">&quot;&quot;}</span></code>). Les guillemets doubles dans les notes doivent être échappés.</p></li>
<li><p><strong>data</strong> identifiant du sport et notes (exemple : <code class="docutils literal notranslate"><span class="pre">{&quot;sport_id&quot;:</span> <span class="pre">1,</span> <span class="pre">&quot;notes&quot;:</span> <span class="pre">&quot;&quot;}</span></code>). Les guillemets doubles dans les notes doivent être échappés.</p></li>
</ul>
</dd>
<dt class="field-even">En-têtes de requête<span class="colon">:</span></dt>
@ -971,13 +971,13 @@
<dt class="sig sig-object http" id="post--api-workouts-no_gpx">
<span class="sig-name descname"><span class="pre">POST</span> </span><span class="sig-name descname"><span class="pre">/api/workouts/no_gpx</span></span><a class="headerlink" href="#post--api-workouts-no_gpx" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Créer une séance sans fichier gpx.</p>
<p><strong>Scope</strong>: <code class="docutils literal notranslate"><span class="pre">workouts:write</span></code></p>
<p><strong>Exemple de requête</strong>:</p>
<p><strong>Scope</strong> : <code class="docutils literal notranslate"><span class="pre">workouts:write</span></code></p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">POST</span> <span class="nn">/api/workouts/no_gpx</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">201</span> <span class="ne">CREATED</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
@ -1067,7 +1067,7 @@ must be provided with descent)</p></li>
<li><p><strong>notes</strong> (<em>string</em>) notes (non obligatoire)</p></li>
<li><p><strong>sport_id</strong> (<em>integer</em>) identifiant du sport de la séance</p></li>
<li><p><strong>title</strong> (<em>string</em>) titre de la séance (non obligatoire)</p></li>
<li><p><strong>workout_date</strong> (<em>string</em>) date de la séance, dans le fuseau horaire de lutilisateur (format: <code class="docutils literal notranslate"><span class="pre">%Y-%m-%d</span> <span class="pre">%H:%M</span></code>)</p></li>
<li><p><strong>workout_date</strong> (<em>string</em>) date de la séance, dans le fuseau horaire de lutilisateur (format : <code class="docutils literal notranslate"><span class="pre">%Y-%m-%d</span> <span class="pre">%H:%M</span></code>)</p></li>
</ul>
</dd>
<dt class="field-even">En-têtes de requête<span class="colon">:</span></dt>
@ -1094,14 +1094,14 @@ must be provided with descent)</p></li>
<dl class="http patch">
<dt class="sig sig-object http" id="patch--api-workouts-(string-workout_short_id)">
<span class="sig-name descname"><span class="pre">PATCH</span> </span><span class="sig-name descname"><span class="pre">/api/workouts/</span></span><span class="sig-paren">(</span><em class="property"><span class="pre">string:</span> </em><em class="sig-param"><span class="pre">workout_short_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#patch--api-workouts-(string-workout_short_id)" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Mettre à jour une séance</p>
<p><strong>Scope</strong>: <code class="docutils literal notranslate"><span class="pre">workouts:write</span></code></p>
<p><strong>Exemple de requête</strong>:</p>
<dd><p>Mettre à jour une séance.</p>
<p><strong>Scope</strong> : <code class="docutils literal notranslate"><span class="pre">workouts:write</span></code></p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">PATCH</span> <span class="nn">/api/workouts/1</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
@ -1195,7 +1195,7 @@ must be provided with descent)</p></li>
<li><p><strong>notes</strong> (<em>string</em>) notes</p></li>
<li><p><strong>sport_id</strong> (<em>integer</em>) identifiant du sport de la séance</p></li>
<li><p><strong>title</strong> (<em>string</em>) titre de la séance</p></li>
<li><p><strong>workout_date</strong> (<em>string</em>) date de la séance dans le fuseau horaire de lutilisateur (format: <code class="docutils literal notranslate"><span class="pre">%Y-%m-%d</span> <span class="pre">%H:%M</span></code>) (seulement pour les séances sans gpx)</p></li>
<li><p><strong>workout_date</strong> (<em>string</em>) date de la séance dans le fuseau horaire de lutilisateur (format : <code class="docutils literal notranslate"><span class="pre">%Y-%m-%d</span> <span class="pre">%H:%M</span></code>) (seulement pour les séances sans gpx)</p></li>
</ul>
</dd>
<dt class="field-odd">En-têtes de requête<span class="colon">:</span></dt>
@ -1223,14 +1223,14 @@ must be provided with descent)</p></li>
<dl class="http delete">
<dt class="sig sig-object http" id="delete--api-workouts-(string-workout_short_id)">
<span class="sig-name descname"><span class="pre">DELETE</span> </span><span class="sig-name descname"><span class="pre">/api/workouts/</span></span><span class="sig-paren">(</span><em class="property"><span class="pre">string:</span> </em><em class="sig-param"><span class="pre">workout_short_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#delete--api-workouts-(string-workout_short_id)" title="Lien permanent vers cette définition">#</a></dt>
<dd><p>Supprimer la séance</p>
<p><strong>Scope</strong>: <code class="docutils literal notranslate"><span class="pre">workouts:write</span></code></p>
<p><strong>Exemple de requête</strong>:</p>
<dd><p>Supprimer la séance.</p>
<p><strong>Scope</strong> : <code class="docutils literal notranslate"><span class="pre">workouts:write</span></code></p>
<p><strong>Exemple de requête</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">DELETE</span> <span class="nn">/api/workouts/kjxavSTUrJvoAh2wvCeGEF</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>
</div>
<p><strong>Exemple de réponse</strong>:</p>
<p><strong>Exemple de réponse</strong> :</p>
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">204</span> <span class="ne">NO CONTENT</span>
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
</pre></div>