Les configurations

Les configurations permettent de stocker des informations quant à la diffusion de données stockés sur un géoservice. Elles précisent les configurations à diffuser, dans quelles conditions (niveaux, styles à appliquer), le nom de la couche. Les informations diffèrent selon le type de configuration (et donc type de diffusion).

D'un point de vue modèle, une configuration appartient à un datastore.

Les types de configuration

Le type de la configuration détermine les types de configurations utilisables, et les points d'accès (le type doit être le même) sur lesquels on pourra publier la configuration.

En gras les parammètres obligatoires.

Quel que soit le type de configuration, il faut préciser un nom (information interne) et un nom de couche. Ce dernier sert d'identifiant de diffusion , doit donc être URL compliant et unique pour un type de configuration.

Type de diffusion	Types de donnée stockée diffusable
DOWNLOAD	ARCHIVE
WMTS-TMS	ROK4-PYRAMID-RASTER et ROK4-PYRAMID-VECTOR
WMS-RASTER	ROK4-PYRAMID-RASTER
WMS-VECTOR	VECTOR-DB et VECTOR-DB-DYNAMIC
WFS	VECTOR-DB et VECTOR-DB-DYNAMIC
WFS-T	VECTOR-DB-DYNAMIC
WFS-INSPIRE	VECTOR-DB
DEMATERIALIZED	DEMATERIALIZED
ITINERARY	GRAPH-DB, GRAPH-VALHALLA et GRAPH-OSRM
ISOCHRONOUS	GRAPH-DB, GRAPH-VALHALLA et GRAPH-OSRM
GEOCODING	GEOCODING-REDIS, GEOCODING-SEARCHENGINE et GEOCODING-DB
CACHE	CACHE

La création se fait via l'appel POST /datastore/{id}/configurations.

Modification de la configuration par un traitement

Il est possible de modifier les informations d'une configuration lorsqu'elle est en statut UNPUBLISHED. Le nom de couche et le type de la configuration ne sont pas modifiable.

Suppression d'une configuration

Une configuration en statut PUBLISHED peut être supprimée via l'appel DELETE /datastore/{id}/configurations/{id}. Les informations sont totalement supprimées du référentiel.

Documentation d'une configuration

Il y a deux possibilités pour ajouter des informations sur une configuration : les étiquettes et les commentaires.

Les étiquettes de configuration

Une étiquette est un couple clé - valeur. Il y a une liberté complète sur les clés utilisables (dans la limite d'une taille de 64 caractère) et les valeurs (dans la limite d'une taille de 128 caractère) :

les étiquettes d'une configuration sont consultables avec ses informations : GET /datastore/{id}/configurations/{id}
ajouter des étiquettes se fait via l'API POST /datastore/{id}/configurations/{id}/tags. Si une étiquette à ajouter reprend une clé déjà présente, la valeur est mise à jour.
supprimer des étiquettes se fait via l'API DELETE /datastore/{id}/configurations/{id}/tags?tags=[liste des clés à supprimer]. Si une clé à supprimer n'existe pas, il n'y a pas d'erreur.

Les commentaires de configuration

Les commentaires permettent d'ajouter des détails sur les configuations et d'avoir une discussion autour. Un commentaire est une entité avec identifiant, dont l'auteur du commentaire est connu :

consulter les commentaires sur la configuration se fait via GET /datastore/{id}/configurations/{id}/comments
ajouter un commentaire se fait via POST /datastore/{id}/configurations/{id}/comments, avec le texte du commentaire.
modifier un commentaire se fait via PUT /datastore/{id}/configurations/{id}/comments/{id}, avec le nouveau texte du commentaire. La date de la modification est enregistrée. Seul l'auteur du commentaire peut le modifier.
supprimer un commentaire se fait via DELETE /datastore/{id}/configurations/{id}/comments/{id}. Seul l'auteur du commentaire ou le resmonsable de l'entrepôt peut le supprimer.

Les événements d'une configuration

Les événements permettent de mémoriser les actions ayant été faites sur une configuration, avec une datation. Ils sont accessibles via l'appel GET /datastore/{id}/configurations/{id}/events et peuvent être les suivants :

Titre	Texte	Action à l'origine de l'événement	Utilisateur à l'origine
Publication	Identifiant du point d'accès	Appel à l'API de création de l'exécution de traitement créant la configuration	oui
Dépublication	Identifiant du point d'accès	Appel à l'API de lancement de l'exécution de traitement créant la configuration	oui

Les transitions entre les différents statuts sont détaillées ici

Parcours des configurations

Récupérer une liste de configurations

L'API GET /datastore/{id}/configurations permet de récupérer l'ensemble des configurations (avec pagination) disponibles dans l'entrepôt. Pour cibler plus précisément les configurations voulues, plusieurs filtres, qui se cumulent, sont possibles :

type=[type de configuration] : permet de préciser le type voulu. Tous les types par défaut.
tags=clé1:valeur1;clé2:valeur2 : liste les étiquettes exacte (clé+valeur) des configurations voulues.
name=%chaîne% : nom complet ou partiel (% remplace au moins un caractère) des configurations voulues.
layer_name=%chaîne% : nom de couche complet ou partiel (% remplace au moins un caractère) des configurations voulues.
status=[statut de configuration] : permet de préciser le statut voulu. Tous les statuts par défaut.

Voir les informations d'une configuration

Pour obtenir toutes les informations disponibles sur une configuration, on utilise l'API GET /datastore/{id}/configurations/{id}.