Commit 5f00aebe authored by Lucas Seguinot's avatar Lucas Seguinot

Merge branch 'fix/doc-pbehavior-small-improvements' into 'develop'

Fix: pbehavior small doc improvements

See merge request !649
parents 26470aca b8c5ca6d
Pipeline #4495 passed with stage
in 1 minute and 38 seconds
......@@ -24,6 +24,7 @@ Par exemple, le comportement ci-dessous commence à 11 heures et se termine une
**Lorsque l'évènement est récurrent, la date de la dernière occurrence est stockée dans l'attribut `UNTIL` de l' évènement.rrule**
## Créer un pbehavior
#### URL
......@@ -38,7 +39,7 @@ JSON :
{
"name": "imagine",
"author": "lennon",
"filter_": {"_id": "all_the_people"},
"filter": {"_id": "all_the_people"},
"rrule": "",
"tstart": 0,
"tstop": 1000
......@@ -61,9 +62,9 @@ Les attributs du corps sont les suivants :
| rrule | string | yes | Rrule (récurrence) |
| tstart | integer | No | Timestamp de la date de départ |
| tstop | integer | No | Timestamp de la date de fin |
| \_id | string | No | indentifiant du Pbehavior |
| \_id | string | No | identifiant du Pbehavior |
| eids | array | No | tableau du \_ids pour les entités impactées. |
| timezone | string | yes | La timezone à utilisé pour le calcul des dates |
| timezone | string | yes | La timezone à utiliser pour le calcul des dates |
Réponse : UID de l'élément inséré
......@@ -129,7 +130,7 @@ Les attributs de réponse sont les suivants :
| \_id | string | No | Pbehavior identifier |
| eids | array | No | Array of \_ids for the impacted entities. |
| isActive | boolean | No | is the pbehavior currently active |
| timeszone | string | yes | La timezone à utilisé pour le calcul des dates |
| timezone | string | yes | La timezone à utiliser pour le calcul des dates |
## Supprimer un pbehavior
......@@ -160,11 +161,11 @@ Cette route impose un nouveau calcul pour tous les comportements.
#### URL
GET / api / v2 / compute-pbehaviors
`GET /api/v2/compute-pbehaviors`
#### GET exemple
/ api / v2 / compute-pbehaviors
/api/v2/compute-pbehaviors
Réponse: les calculs ont-ils été traités ?
......
......@@ -15,7 +15,7 @@ Un pbehavior se caractérise par les informations suivantes.
| `tstop` | int | Timestamp fournissant la date de fin du pbehavior, recalculée à partir de la `rrule` si présente. |
| `type_` | string | Optionnel. Type de pbehavior (pause, maintenance…). |
| `reason` | string | Optionnel. Raison pour laquelle ce pbehavior a été posé. |
| `timezone` | string | Timezone dans laquelle le pbehavior doit s'exécuter.
| `timezone` | string | Timezone dans laquelle le pbehavior doit s'exécuter. |
Un exemple d'évènement pbehavior brut :
```js
......@@ -56,9 +56,9 @@ Event de type pbehavior : créé à partir des champs cités en introduction
## Timezone
L'exécution de chaque pbehavior se fait dans une timezone particulière.
Lorsqu'un pbehavior ne contient pas de champ timezone, la timezone utilisé
Lorsqu'un pbehavior ne contient pas de champ timezone, la timezone utilisée
sera celle définie dans le fichier de configuration `etc/pbehavior/manager.conf`
sous le champ `default_timezone`.
Si le fichier de configuration n'existe pas ou si le champ `default_timezone`
n'existe pas, la timezone `Europe/Paris` sera utilisé.
n'existe pas, la timezone `Europe/Paris` sera utilisée.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment