Skip to content

Commit

Permalink
feat: add a quick start section in swagger description
Browse files Browse the repository at this point in the history
  • Loading branch information
sbedeau committed Mar 8, 2024
1 parent 1c87b9e commit 247ae32
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions src/api/swagger/swagger.service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,13 @@ export class SwaggerService {
<ul>
<li>Une valeur <b>"INDISPONIBLE"</b> signifie que nous n’avons pas encore la donnée et qu’elle arrivera par la suite ;</li>
<li>Les données sont mises à jour toutes les nuits à 6 heures du matin.</li>
</ul>
<p>Quick start:</p>
<ul>
<li>Déplier la section "/R4/ResearchStudy"</li>
<li>Cliquer sur "Try it out"</li>
<li>Utiliser les champs pour filtrer. On peut, par exemple, utiliser les champs "_text" ou "_content" avec les mots clef "CTIS", "JARDE", "DM", etc.</li>
<li>Cliquer sur "Exécuter" pour voir le résultat au format JSON</li>
</ul>`)
.setExternalDoc('Notre documentation FHIR est disponible via notre guide d’implémentation (R4).', 'https://interop.esante.gouv.fr/ig/fhir/eclaire/index.html')
.setVersion('0.1')
Expand Down

0 comments on commit 247ae32

Please sign in to comment.