diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d8f3bc5..2dc7736 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -451,6 +451,49 @@ ### examples.http +Si le fichier n'existe pas, utiliser ce modèle pour l'entête: + +```ini +# These examples can be used directly in VSCode, using REST Client extension +# (humao.rest-client) or httpYac (anweber.vscode-httpyac) + +# To test locally, replace with +#@host = http://localhost:31976 +@host = https://instance-name.services.inist.fr +#@host = http://instance-name.tdmservices.intra.inist.fr + +### +``` + +Puis, ajouter au moins autant d'exemples de requêtes que de routes. + +```http +# @name v1Cnrsunit +# @description Informations sur une adresse cnrs +POST {{host}}/v1/cnrsunit/cnrsunit?indent=true HTTP/1.1 +Content-Type: application/json + +[ +{"id":1, "value":"université sciences et technologies bordeaux 1 institut national de physique nucléaire et de physique des particules du cnrs in2p3 umr5797"}, +{"id":3,"value":"centre de recherches sur la géologie des matières premières minérales et énergétiques cregu université de lorraine ul umr7359 centre national de la recherche scientifique"}, +{"id":4,"value":"umr_d161 institut de recherche pour le développement ird um34 aix marseille université amu umr7330 collège de france cdf institution institut national des sciences de l'univers insu cnrs umr7330 centre national de la recherche scientifique cnrs umr1410 institut national de recherche pour l'agriculture l'alimentation et l'environnement inrae centre européen de recherche et d'enseignement des géosciences de l'environnement cerege europôle méditerranéen de l'arbois"} +] + +### +``` + +Le `###` sur une ligne est un séparateur de requêtes. + +La partie `@name` permet d'identifier la requête (utile à l'étape de [génération +des métadonnées d'exemple](README.md#exemples)). + +Ce fichier est un pivot pour: + +- générer les métadonnées d'exemples pour OpenAPI +- créer des tests automatiques (à venir) + +Il est donc très important. + ## Déploiement ### Tester sur la vi @@ -491,8 +534,8 @@ #### Cas d'une nouvelle instance -1. ajouter l'instance dans `internal-proxy` À COMPLÉTER -2. ajouter l'instance dans `internal-monitoring` À COMPLÉTER +1. publier l'instance dans `internal-proxy` et `internal-monitoring` via `make publish` À COMPLÉTER +2. créer un fichier `instance-conf.json` à la racine du dépôt À COMPLÉTER 3. changer le `title` dans la configuration À COMPLÉTER ## Après le déploiement