From b0b1276f65b4e80e2556c83348dd9410105dffa0 Mon Sep 17 00:00:00 2001 From: Olivier Date: Sat, 23 Mar 2024 23:21:33 +0100 Subject: [PATCH] Ajout de l'API Papillon --- docs/development/api/papillon.md | 18 ++++++++++++++++++ mkdocs.yml | 1 + 2 files changed, 19 insertions(+) create mode 100644 docs/development/api/papillon.md diff --git a/docs/development/api/papillon.md b/docs/development/api/papillon.md new file mode 100644 index 0000000..2f1b088 --- /dev/null +++ b/docs/development/api/papillon.md @@ -0,0 +1,18 @@ +# API Papillon + +!!!info + L'api Papillon permet de récupérer la liste des contributeurs, les disclaimers, les messages d'alerte ainsi que les informations de la dernière version de l'application. + +Elle est accessible à tous [ici](https://api.getpapillon.xyz) + +Son [repo GitHub](https://github.com/PapillonApp/PapiAPI) est public + +Elle est disponible sur [Docker Hub](https://hub.docker.com/repository/docker/vilerio/papillon-api/general) + + +## Endpoints + +- GET /api : Version de l'api +- GET /team : Liste des membres de l'équipe +- GET /messages : Liste de tous les messages de l'app +- GET /latestVersion/plateforme : Dernière version de l'application pour la plateforme en question \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 28ffb2a..857d090 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -29,6 +29,7 @@ nav: - Turboself: - API : 'development/api/ts/api.md' - papillon-turboself-core : 'development/api/ts/papillon.md' + - API Papillon: 'development/api/papillon.md' - Contribuer : - Introduction : 'contribute/intro.md' - Tester les nouveautés :