Links in summary

index.md

@@ -2,59 +2,54 @@
 
 Swagger file : https://api.keyclic.com/swagger.json
 
-## Apperçu 
-- Intro
-- Vocabulaire (français et anglais)
-- Fonctionnement général
-
-## Considérations techniques
-- Intro
-- Domaines applicatifs
-- Requêtes
-- Envoi de fichiers
-- Pagination
-- Modification de ressources avec la méthode PATCH
-- Retours d'erreurs
-- changements de statut
-
-## Authentification / Connexion
-- Création d'un compte utilisateur
-- Connexion
-- Utilisation du token
-- Modification du mot de passe
-- Modification des données utilisateur
-
-## Utilisateurs et Rôles
-- Intro
-- Utilisateur de base
-- Administrateur d'organisation
-- Administrateur d'application
-- Membres d'organisation
-- Ressource utilisateur
-- Récupération des membres
-
-## Organisations
-- Intro
-- Création d'une organisation
-- Gestion des membres
-- Gestion des zones géographiques
-- Gestion des catégories
-- Gestion des partenariats
-
-## Observations
-- Intro
-- Création d'une observation
-- Modération et cycle de vie d'une observation
-- Récupération des observations
-- Commentaires
-- Soutiens
+## [Apperçu](overview.md)
+- [Fonctionnement général](overview.md#fonctionnement-général)
+- [Vocabulaire](overview.md#vocabulaire)
+
+## [Considérations techniques](technical.md)
+- [Applications et clés d'applications](technical.md#applications-et-clés-dapplications)
+- [Requêtes](technical.md#requêtes)
+- [Format des requêtes et réponses](technical.md#format-des-requêtes-et-réponses)
+- [Envoi de fichiers](technical.md#envoi-de-fichiers)
+- [Pagination](technical.md#pagination)
+- [Modification de ressources avec la méthode PATCH](technical.md#modification-de-ressources-avec-la-méthode-patch)
+- [Retours d'erreurs](technical.md#retours-derreurs)
+- [changements de statut](technical.md#changements-de-statut)
+
+## [Authentification / Connexion](authentication.md)
+- [Création d'un compte utilisateur](authentication.md#création-dun-compte-utilisateur)
+- [Connexion](authentication.md#connexion)
+- [Utilisation du token](authentication.md#utilisation-du-token)
+- [Modification du mot de passe](authentication.md#modification-du-mot-de-passe)
+- [Modification des données utilisateur](authentication.md#modification-des-données-utilisateur)
+
+## [Utilisateurs et Rôles](users.md)
+- [Utilisateur de base](users.md#utilisateur-de-base-rôle-role_user)
+- [Administrateur d'organisation](users.md#administrateur-dorganisation-rôle-organizationadmin)
+- [Administrateur d'application](users.md#administrateur-dapplication-rôle-applicationadmin)
+- [Membres d'organisation](users.md#membres-dorganisation)
+- [Ressource utilisateur](users.md#exemple-de-ressource-utilisateur)
+- [Récupération des membres](users.md#récupération-des-membres)
+
+## [Organisations](organizations.md)
+- [Création d'une organisation](organizations.md#création-dune-organisation)
+- [Gestion des membres](organizations.md#gestion-des-membres)
+- [Gestion des zones géographiques](organizations.md#gestion-des-zones-géographiques)
+- [Gestion des catégories](organizations.md#gestion-des-catégories)
+- [Gestion des partenariats](organizations.md#gestion-des-partenariats)
+
+## [Observations](feedbacks.md)
+- [Création d'une observation](feedbacks.md#création-dune-observation)
+- [Modération et cycle de vie d'une observation](feedbacks.md#modération-et-cycle-de-vie-dune-observation)
+- [Récupération des observations](feedbacks.md#récupération-des-observations)
+- [Commentaires](feedbacks.md#commentaires)
+- [Soutiens](feedbacks.md#soutiens)
 
-## Rapports
-- Intro
-- Cycle de vie d'un rapport
-- Opérations
-- Délégation de rapports
-- Export des rapports
+## [Rapports](reports.md)
+- [Cycle de vie d'un rapport](reports.md#cycle-de-vie-dun-rapport)
+- [Opérations](reports.md#opérations)
+- [Délégation de rapports](reports.md#délégation-de-rapports)
+- [Export des rapports](reports.md#export-des-rapports)
 
 
 

overview.md

@@ -6,7 +6,7 @@ Keyclic est une application de remontée et de traitement d'observations. Elle p
 
 L'application Keyclic est librement ouverte aux inscriptions. Une fois inscrit, tout utilisateur peut créer des observations. Une observation est toujours liée à une position géographique et comporte éventuellement une ou plusieurs photos.
 
-Certains utilisateurs peuvent également être regroupés au seins d'organisations. Une organisation est donc un groupe d'utilisateurs membres de la même entreprise, association, corporation, école, etc. Tout utilisateur est libre de créer sa propre organisation et d'inviter d'autres utilisateurs à en devenir membres.
+Certains utilisateurs peuvent également être regroupés au sein d'organisations. Une organisation est donc un groupe d'utilisateurs membres de la même entreprise, association, corporation, école, etc. Tout utilisateur est libre de créer sa propre organisation et d'inviter d'autres utilisateurs à en devenir membres.
 
 Les administrateurs d'organisation définissent des zones géographiques sur lesquelles leur organisation peut intervenir, et des catégories d'intervention (exemples : voirie, animal perdu, propreté, etc...) Ainsi, quand un utilisateur crée une observation, la position géographique de cette observation permet de lui proposer les catégories et organisations qui sont en mesure de traiter son signalement et de le laisser choisir celle qui lui semble la plus apte à traiter son problème.
 
@@ -16,32 +16,76 @@ Un administrateur d'organisation a donc accès à l'ensemble des rapports concer
 
 ## Vocabulaire
 
-**Observation** : Remarque effectuée sur le terrain par un utilisateur, pouvant porter sur un dysfonctionnement, un problème technique, une nuisance, etc. Toute observation est forcément faite en une position géographique donnée. Elle peut éventuellement comporter des photos, et être commentée et/ou soutenue par les autres utilisateurs.
+Dans cette section, nous allons définir les principaux concepts utilisés par l'API Keyclic. Pour chacun d'entre eux nous donnerons le terme technique correspondant. Nous donnons aussi un lien vers chaque section correspondante de la documentation pour plus d'informations sur chaque notion.
 
-**Rapport** : Toute observation, une fois validée par un administrateur du domaine applicatif, entraîne la génération d'un rapport. Un rapport reprend donc toutes les informations de l'observation dont il est issu, et n'est visible et manipulable que par l'organisation concernée par l'observation initiale. Le rapport est donc le pendant professionnel de l'observation. C'est sur ce rapport que l'organisation travaille : création d'opérations, suivi, délégation, etc.
+### Observation
 
-**Organisation** : Groupe d'utilisateurs pouvant être une entreprise, une école, une association, etc... 
+Remarque effectuée sur le terrain par un utilisateur, pouvant porter sur un dysfonctionnement, un problème technique, une nuisance, etc. Toute observation est forcément faite en une position géographique donnée. Elle peut éventuellement comporter des photos, et être commentée et/ou soutenue par les autres utilisateurs.
 
-**Application** : Un client de l'API travaille toujours sur une application particulière de Keyclic, correspondant à un domaine applicatif. Chaque application possède ses propres administrateurs, dont la principale mission est de modérer les observations avant que celles-ci ne soient transmises sous forme de rapport aux organisations concernées.
+Terme technique : feedback.
 
+LIEN
 
+### Rapport
 
+Toute observation, une fois validée par un administrateur du domaine applicatif, entraîne la génération d'un rapport. Un rapport reprend donc toutes les informations de l'observation dont il est issu, et n'est visible et manipulable que par l'organisation concernée par l'observation initiale. Le rapport est donc le pendant professionnel de l'observation. C'est sur ce rapport que l'organisation travaille : création d'opérations, suivi, délégation, etc.
 
+Terme technique : report.
 
+LIEN
 
+### Organisation
 
+Groupe d'utilisateurs pouvant être une entreprise, une école, une association, etc... 
 
+Terme technique : organization
 
+LIEN
 
+### Zone
 
+Aire géographique sur laquelle une organisation peut intervenir.
 
+Terme technique : place
 
+LIEN
 
+### Catégorie
 
+Secteur d'activité d'une organisation
 
+Terme technique : category
 
+LIEN
 
+### Application
 
+Un client de l'API travaille toujours sur une application particulière de Keyclic, correspondant à un domaine applicatif. Chaque application possède ses propres administrateurs, dont la principale mission est de modérer les observations avant que celles-ci ne soient transmises sous forme de rapport aux organisations concernées.
 
+LIEN
+
+### Soutien
+
+Une observation peut être soutenue par les utilisateurs de la communauté, afin de leur donner plus de poids.
+
+Terme technique : contribution
+
+LIEN
+
+### Opération
+
+Une opération est une tâche créée par un administrateur d'organisation sur un rapport donné. Cette tâche est assignée à un membre de l'organisation. Un rapport ne peut être clôturé que si toutes les opérations qui lui sont liées ont été accomplies.
+
+Terme technique : operation
+
+LIEN
+
+### Partenaires
+
+Un administrateur d'organisation peut définir des organisations partenaires, qui sont d'autres organisations auxquelles il poura déléguer des rapports.
+
+Terme technique : relationship
+
+LIEN