diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 42a5673..ef8a30c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,16 +4,16 @@ - [Développement](#développement) - [Avant de programmer](#avant-de-programmer) - [Cloner le dépôt](#cloner-le-dépôt) - - [Se mettre dans le répertoire `web-services`](#se-mettre-dans-le-répertoire-web-services) + - [Se mettre dans le répertoire web-services](#se-mettre-dans-le-répertoire-web-services) - [Synchronisation](#synchronisation) - [Nouvelle branche](#nouvelle-branche) - [Pull Request](#pull-request) - [Nouvelle instance ?](#nouvelle-instance-) - [Vérifier si une instance existante serait réutilisable](#vérifier-si-une-instance-existante-serait-réutilisable) - [Si aucune instance n'est réutilisable](#si-aucune-instance-nest-réutilisable) - - [Création du `.ini`](#création-du-ini) - - [`swagger.json` de base](#swaggerjson-de-base) + - [swagger.json de base](#swaggerjson-de-base) - [Dans tous les cas](#dans-tous-les-cas) + - [Création du `.ini`: `v1/service.ini`](#création-du-ini-v1serviceini) - [Python](#python) - [version de python](#version-de-python) - [Utiliser un environnement virtuel](#utiliser-un-environnement-virtuel) @@ -35,6 +35,7 @@ - [Faire une version](#faire-une-version) - [Vérifier l'utilisation (grafana)](#vérifier-lutilisation-grafana) - [Déployer sur la vp](#déployer-sur-la-vp) + - [Cas d'une nouvelle instance](#cas-dune-nouvelle-instance) - [Après le déploiement](#après-le-déploiement) - [Vérifier que le swagger fonctionne](#vérifier-que-le-swagger-fonctionne) - [catalogues LODEX](#catalogues-lodex) @@ -55,7 +56,7 @@ Cette étape n'est nécessaire qu'une seule fois. -#### Se mettre dans le répertoire `web-services` +#### Se mettre dans le répertoire web-services On réutilise *toujours le même répertoire de travail* (normalement nommé par la commande précédente `web-services`). @@ -186,13 +187,7 @@ - création de `swagger.json`, contenant le numéro de version de l'instance (`0.0.0`) - création de `examples.http` -##### Création du `.ini` - -Avec les métadonnées de base: description, summary, tags... - -À COMPLÉTER - -##### `swagger.json` de base +##### swagger.json de base Le champ `info.version` doit contenir `0.0.0`, car il sera modifié lors de la [création de version](#faire-une-version). @@ -227,7 +222,12 @@ #### Dans tous les cas -- création du .ini v1/service.ini +##### Création du .ini: v1/service.ini + +Chemin du .ini détermine la route du service. +Avec les métadonnées de base: description, summary, tags... +Modèle de base en ezs pur / avec python. +À COMPLÉTER ### Python @@ -277,10 +277,25 @@ ### Vérifier l'utilisation (grafana) +S'assurer, via le tableau de bord de Grafana, que l'instance en question n'est +pas sollicitée. +Le but est de ne pas casser une série de requêtes en cours. + +![Suivi d'utilisation via Grafana](images/vp-grafana.png) + ### Déployer sur la vp La version générée `instance@version`. +Utiliser les dépendances de la vi pour mettre à jour celles de la vp. + +![Configuration de la vi](images/vi-configuration.png) + +#### Cas d'une nouvelle instance + +1. ajouter l'instance dans `internal-proxy` À COMPLÉTER +2. ajouter l'instance dans `internal-monitoring` À COMPLÉTER + ## Après le déploiement ### Vérifier que le swagger fonctionne @@ -290,6 +305,23 @@ automatiquement toutes les demi-heures (pendant les heures de bureau, les jours de semaine). +Une fois que affiche les routes que vous venez de développer / corriger / documenter, utilisez le bouton `Try it out` sur cette/ces route/s: + +![bouton try it out](images/openapi-try-it-out.png) + +Puis, le bouton `Execute`. + +![bouton Exeute de l'OpenAPI](images/openapi-execute.png) + +Le résultat doit correspondre à l'exemple (avec un code 200). + +![le résutat de l'exécution via OpenAPI](images/openapi-result.png) + ### catalogues LODEX +Signaler dans le canal mattermost `#TDM` les nouvelles routes, pour qu'elles +puissent être ajoutées au catalogues de LODEX. + +![signalement dans mattermost](images/mattermost-tdm-signalement.png) + ### Objectif TDM diff --git a/images/mattermost-tdm-signalement.png b/images/mattermost-tdm-signalement.png new file mode 100644 index 0000000..f287110 --- /dev/null +++ b/images/mattermost-tdm-signalement.png Binary files differ diff --git a/images/openapi-execute.png b/images/openapi-execute.png new file mode 100644 index 0000000..ea677c8 --- /dev/null +++ b/images/openapi-execute.png Binary files differ diff --git a/images/openapi-result.png b/images/openapi-result.png new file mode 100644 index 0000000..7596408 --- /dev/null +++ b/images/openapi-result.png Binary files differ diff --git a/images/openapi-try-it-out.png b/images/openapi-try-it-out.png new file mode 100644 index 0000000..b0d2d49 --- /dev/null +++ b/images/openapi-try-it-out.png Binary files differ diff --git a/images/vi-configuration.png b/images/vi-configuration.png new file mode 100644 index 0000000..d23979a --- /dev/null +++ b/images/vi-configuration.png Binary files differ diff --git a/images/vp-grafana.png b/images/vp-grafana.png new file mode 100644 index 0000000..dbec2bb --- /dev/null +++ b/images/vp-grafana.png Binary files differ