Skip to content

Commit

Permalink
Orthographic correction
Browse files Browse the repository at this point in the history
  • Loading branch information
guillbdx committed Mar 9, 2017
1 parent b3c872b commit 7bf92ca
Show file tree
Hide file tree
Showing 7 changed files with 19 additions and 57 deletions.
4 changes: 2 additions & 2 deletions authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Exemple :
}
```

Le nouvel utilisateur se voit attribuer un identifiant unique et le rôle ROLE_USER, lui permettant d'utiliser les fonctionalités de base de l'API.
Le nouvel utilisateur se voit attribuer un identifiant unique et le rôle ROLE_USER, lui permettant d'utiliser les fonctionnalités de base de l'API.

## Connexion

Expand All @@ -44,7 +44,7 @@ Si les credentials sont reconnus par le serveur, celui-ci retourne un accessToke

## Utilisation du token

La quasi totalité des requêtes à l'API nécessitent que l'utilisateur soit authentifié, c'est à dire qu'il fournisse son accessToken. Le token est envoyé dans l'entête Authorization de la requête, préfixé par Bearer.
La quasi-totalité des requêtes à l'API nécessitent que l'utilisateur soit authentifié, c'est-à-dire qu'il fournisse son accessToken. Le token est envoyé dans l'en-tête Authorization de la requête, préfixé par Bearer.

Par exemple, pour récupérer la liste des feedbacks de l'application com.keyclic.app, un utilisateur utilise le endpoint :

Expand Down
27 changes: 4 additions & 23 deletions feedbacks.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Observations

Une observation est consituée d'une description, d'une position géographique, et optionnellement d'une ou plusieurs photos. Tous les utilisateurs peuvent créer des observations.
Une observation est constituée d'une description, d'une position géographique, et optionnellement d'une ou plusieurs photos. Tous les utilisateurs peuvent créer des observations.

Le plus souvent, l'utilisateur va aussi attacher son observation à une catégorie donnée. Par conséquent, cette observation sera également rattachée à l'organisation à laquelle appartient cette cagorie.
Le plus souvent, l'utilisateur va aussi attacher son observation à une catégorie donnée. Par conséquent, cette observation sera également rattachée à l'organisation à laquelle appartient cette catégorie.

## Création d'une observation

Expand Down Expand Up @@ -109,7 +109,7 @@ POST /feedbacks/issues

La requête ci-dessus créera une observation qui aura automatiquement le statut ACCEPTED, et un rapport sera automatiquement généré.

Si le paramère "organization" n'avait pas été passé, alors cette observation aurait suivi le cycle normal et aurait reçu le statut PENDING_REVIEW.
Si le paramètre "organization" n'avait pas été passé, alors cette observation aurait suivi le cycle normal et aurait reçu le statut PENDING_REVIEW.

**Résumé du cycle de vie d'une observation**

Expand All @@ -125,7 +125,7 @@ GET /feedbacks

Cette requête retourne uniquement les observations dont le statut est ACCEPTED.

Plusieurs critères permettent de filter les observations.
Plusieurs critères permettent de filtrer les observations.

**Par statut : paramètre state**

Expand Down Expand Up @@ -160,25 +160,6 @@ GET /feedbacks?geo_hash[]=ezzx&geo_hash[]=ezzz

retournera les observations comprises dans les geo hash ezzx et ezzz.




















**Sur une période donnée : paramètres before et after**

Exemple :
Expand Down
3 changes: 0 additions & 3 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,3 @@ Swagger file : https://api.keyclic.com/swagger.json
- [Export des rapports](reports.md#export-des-rapports)





4 changes: 2 additions & 2 deletions organizations.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Pour récupérer toutes les organisations de l'application :
GET /organizations
```

Il est possible de filtrer la requête ci-dessus sur un point géographique (voir ci-dessous : zones géographiques) :
Il est possible de filtrer la requête ci-dessus sur un point géographique (voir ci-dessous : [zones géographiques(#gestion-des-zones-géographiques)]) :

```
GET /organizations?geo_coordinates=+44.851404209987386-0.5762618780136108
Expand Down Expand Up @@ -166,7 +166,7 @@ GET /categories?geo_coordinates=+44.851404209987386-0.5762618780136108&organizat

## Gestion des partenariats

Une organisation peut avoir des partenaires, c'est à dire des organisations qui lui sont rattachées et à qui l'administrateur de l'organisation pourra déléguer des rapports. La relation de partenariat est unilatérale : si une organisation A est partenaire d'une organisation B, B n'est pas forcément partenaire de A.
Une organisation peut avoir des partenaires, c'est-à-dire des organisations qui lui sont rattachées et à qui l'administrateur de l'organisation pourra déléguer des rapports. La relation de partenariat est unilatérale : si une organisation A est partenaire d'une organisation B, B n'est pas forcément partenaire de A.

Pour ajouter un nouveau partenaire à l'organisation, un administrateur de l'organisation exécutera le endpoint :

Expand Down
8 changes: 4 additions & 4 deletions overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ Certains utilisateurs peuvent également être regroupés au sein d'organisation

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.

Quand un utilisateur crée une observation, celle-ci doit tout d'abord être validée par un administrateur de l'application, [sauf dans certains cas où la validation est automatique](LIEN_PAGE_FEEDBACKS)). Une fois validée, cette observation est visble par la communauté : ainsi les autres utilisateurs peuvent la commenter et/ou la soutenir. De plus, au moment où l'observation est validée, un rapport est généré et transmis à l'organisation concernée.
Quand un utilisateur crée une observation, celle-ci doit tout d'abord être validée par un administrateur de l'application, [sauf dans certains cas où la validation est automatique](LIEN_PAGE_FEEDBACKS)). Une fois validée, cette observation est visible par la communauté : ainsi, les autres utilisateurs peuvent la commenter et/ou la soutenir. De plus, au moment où l'observation est validée, un rapport est généré et transmis à l'organisation concernée.

Un administrateur d'organisation a donc accès à l'ensemble des rapports concernant son organisation, chaque rapport correspondant à une observation. Pour chaque rapport, il peut créer une ou plusieurs opérations, et affecter ces opérations aux utilisateurs membres de son organisation. Une fois que toutes les opérations ont été accomplies, il pourra considérer que le traitement est terminé et clôturer le rapport. Une autre possibilité est de déléguer ce rapport à une organisation partenaire.

## Vocabulaire

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.
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.

### Observation

Expand All @@ -36,7 +36,7 @@ LIEN

### Organisation

Groupe d'utilisateurs pouvant être une entreprise, une école, une association, etc...
Groupe d'utilisateurs pouvant être une entreprise, une école, une association, etc.

Terme technique : organization

Expand Down Expand Up @@ -82,7 +82,7 @@ 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.
Un administrateur d'organisation peut définir des organisations partenaires, qui sont d'autres organisations auxquelles il pourra déléguer des rapports.

Terme technique : relationship

Expand Down
4 changes: 2 additions & 2 deletions reports.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ GET /reports/{report}

Quand un nouveau rapport est généré à partir d'une observation, il possède le statut NEW.

Le schémas ci-dessous montre l'évolution du statut d'un rapport en fonction des actions qui sont effectuées sur ce rapport.
Le schéma ci-dessous montre l'évolution du statut d'un rapport en fonction des actions qui sont effectuées sur ce rapport.

![Cycle de vie d'un rapport](images/report_workflow.png "Cycle de vie d'un rapport")

Expand Down Expand Up @@ -139,7 +139,7 @@ PATCH /operations/{operation}/state

**Opération en cours et clôture**

Une fois acceptée, l'opération peut-être passée "en cours" puis "cloturée", soit par la personne à qui l'opération a été assignée, soit par un administrateur de l'organisation.
Une fois acceptée, l'opération peut-être passée "en cours" puis "clôturée", soit par la personne à qui l'opération a été assignée, soit par un administrateur de l'organisation.

**Résumé du cycle de vie d'une opération**

Expand Down
26 changes: 5 additions & 21 deletions users.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Tout utilisateur nouvellement inscrit possède automatiquement le rôle ROLE_USE
- consulter et modifier son profil
- consulter les observations faites par les autres utilisateurs
- soutenir une observation
- commenter une observeration
- commenter une observation
- créer une nouvelle observation

LIEN : rubrique observations
Expand All @@ -21,9 +21,9 @@ LIEN : rubrique observations

Tout utilisateur a la possibilité de créer une nouvelle organisation.

L'utilisateur qui crée une nouvelle organisation en devient automatiquement membre et administrateur, c'est à dire qu'il se voit attribuer le rôle ORGANIZATION:ADMIN. Une organisation peut posséder plusieurs administrateurs, mais un utilisateur ne peut être membre, et par conséquent administrateur, que d'une seule organisation.
L'utilisateur qui crée une nouvelle organisation en devient automatiquement membre et administrateur, c'est-à-dire qu'il se voit attribuer le rôle ORGANIZATION:ADMIN. Une organisation peut posséder plusieurs administrateurs, mais un utilisateur ne peut être membre, et par conséquent administrateur, que d'une seule organisation.

**Attention** : Si un utilisateur est déjà membre d'une organisation et qu'il en crée une nouvelle, étant donné qu'il sera automatiquement rattaché à cette nouvelle organisation, il sera de fait retiré de la liste des membres de l'organisation à laquelle il appartenait auparavant.
**Attention** : si un utilisateur est déjà membre d'une organisation et qu'il en crée une nouvelle, étant donné qu'il sera automatiquement rattaché à cette nouvelle organisation, il sera, de fait, retiré de la liste des membres de l'organisation à laquelle il appartenait auparavant.

L'administrateur d'une organisation peut :
- Ajouter de nouveaux membres à son organisation
Expand All @@ -42,11 +42,11 @@ LIEN : Feedbacks / modération

## Membres d'organisation

Quand un utilisateur est membre d'une organisation, celui ne lui confère par un rôle particulier, mais cette appartenance à l'organisation lui donne la possibilité de créer une nouvelle observation de façon à ce que celle-ci soit aussitôt visible par la communauté, sans passer par l'étape de modération.
Quand un utilisateur est membre d'une organisation, cela ne lui confère par un rôle particulier, mais cette appartenance à l'organisation lui donne la possibilité de créer une nouvelle observation de façon à ce que celle-ci soit aussitôt visible par la communauté, sans passer par l'étape de modération.

LIEN : Observations / Création d'une observation sans modération

Note : dans l'appli cliente Keyclic, ce fonctionnement est obtenu par l'activation du mode Pro.
Note : dans l'application cliente Keyclic, ce fonctionnement est obtenu par l'activation du mode Pro.

## Exemple de ressource utilisateur

Expand Down Expand Up @@ -122,19 +122,3 @@ Pour filtrer les membres d'une organisation :
GET /people?organization={organization}
```

















0 comments on commit 7bf92ca

Please sign in to comment.