<commit_before>API REST : Vue d'ensemble
=========================

Le serveur Regovar expose une API Rest via aioHTTP. Tout le code concernant l'API se trouve dans le répertoire `/regovar/web`. L'API permet d'accéder et de gérer les resources de Regovar ainsi que de réaliser toutes les fonctionnalités proposées par le serveur via une interface web. 

Pour connaître les détails concernant les resources et fonctionnalités de Regovar, lire la [section concernant le `core`]()



Principaux points d'entrée
==========================
Les points d'entrée principaux de l'API sont les suivants :
    * [`/users`]() : pour la manipulation des utilisateurs de Regovar
    * [`/projects`]() : pour la manipulation des projets de Regovar
    * _... à venir ..._


Règles générales
================

CRUD
----
```
	GET 	Read
	POST	Create
	PUT 	Update
	DELETE	Delete
```




Réponses et prise en charge des erreurs
---------------------------------------
Les seuls codes d'erreur HTTP retournés par le server sont :

Code | Description
---- | -----------
`200` | *"OK"*, le server fonctionne bien et vous a répondu (ce qui ne veut pas dire qu'il n'y a pas eu d'erreur)
`404` | *"request not found"*, l'url saisie n'existe pas
`403` |*"authentication required"*, l'utilisateur doit être identifié pour accéder au service, ou bien l'authentification a échoué (mauvais login/mot de passe saisis)
`5XX` | *"server errors"*, une erreur non gérée côté server est survenue et a "cassé" le server... ça craint.<commit_msg>Update restapi.md<commit_after>API REST : Vue d'ensemble
=========================

Le serveur Regovar expose une API Rest via aioHTTP. Tout le code concernant l'API se trouve dans le répertoire `/regovar/web`. L'API permet d'accéder et de gérer les resources de Regovar ainsi que de réaliser toutes les fonctionnalités proposées par le serveur via une interface web. 

Pour connaître les détails concernant les resources et fonctionnalités de Regovar, lire la [section concernant le `core`]()



Principaux points d'entrée
==========================
Les points d'entrée principaux de l'API sont les suivants :<br/>
  * [`/users`]() : pour la manipulation des utilisateurs de Regovar
  * [`/projects`]() : pour la manipulation des projets de Regovar
  * _... à venir ..._


Règles générales
================

CRUD
----
```
	GET 	Read
	POST	Create
	PUT 	Update
	DELETE	Delete
```




Réponses et prise en charge des erreurs
---------------------------------------
Les seuls codes d'erreur HTTP retournés par le server sont :

Code | Description
---- | -----------
`200` | *"OK"*, le server fonctionne bien et vous a répondu (ce qui ne veut pas dire qu'il n'y a pas eu d'erreur)
`404` | *"request not found"*, l'url saisie n'existe pas
`403` |*"authentication required"*, l'utilisateur doit être identifié pour accéder au service, ou bien l'authentification a échoué (mauvais login/mot de passe saisis)
`5XX` | *"server errors"*, une erreur non gérée côté server est survenue et a "cassé" le server... ça craint.
{'fraction_non_alphanumeric': 0.158435531985416, 'fraction_numerical': 0.006629101756711966, 'mean_word_length': 3.643076923076923, 'pattern_counts': {'":': 0, '<': 4, '<?xml version=': 0, '>': 4, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1512578', 'n_tokens_mistral': 975, 'n_tokens_neox': 950, 'n_words': 391}