From 3abeecef92958614d04e217e86fc07cc500a4422 Mon Sep 17 00:00:00 2001 From: Orka Arnest CRUZE Date: Wed, 8 Jan 2025 16:21:40 +0100 Subject: [PATCH] docs: styles dans extra --- docs/developer/entrepot/README.md | 1 + docs/developer/entrepot/annexes.md | 77 +--------------------------- docs/developer/entrepot/extra.md | 80 ++++++++++++++++++++++++++++++ docs/developer/entrepot/labels.md | 2 +- 4 files changed, 84 insertions(+), 76 deletions(-) create mode 100644 docs/developer/entrepot/extra.md diff --git a/docs/developer/entrepot/README.md b/docs/developer/entrepot/README.md index b12b4951..6fb000aa 100644 --- a/docs/developer/entrepot/README.md +++ b/docs/developer/entrepot/README.md @@ -8,5 +8,6 @@ Voici les liens de sa documentation en [production](https://geoplateforme.github - Utilisation des : - [tags](./tags.md) - [labels](./labels.md) + - [extra](./extra.md) - [annexes](./annexes.md) - [fichiers statiques](./statics.md) diff --git a/docs/developer/entrepot/annexes.md b/docs/developer/entrepot/annexes.md index 204255b2..bfd76cda 100644 --- a/docs/developer/entrepot/annexes.md +++ b/docs/developer/entrepot/annexes.md @@ -4,87 +4,14 @@ Il s'agit d'une [entité](https://geoplateforme.github.io/entrepot/production/co ## un ensemble de fichiers de style associés à une configuration -Syntaxe du path : - -``` -/configuration/[configuration_id]/styles.json -``` - -| variable | description | | -| ------------------ | --------------------------------- | ------ | -| `configuration_id` | identifiant de la `configuration` | uuidv4 | - -Structure de cet annexe json : - -```ts -export type Styles = { - name: string; - current?: boolean; - layers: { - name?: string; - annexe_id: string; - url: string; - }[]; -}[]; -``` - -- `SLD` ou `QML` pour une configuration du type `WFS` - -```json -[ - { - "name": "nom du style 1", - "current": true, - "layers": [ - { - "name": "nom de la table 1", - "annexe_id": "identifant de l'annexe", - "url": "url complète de l'annexe" - }, - { - "name": "nom de la table 2", - "annexe_id": "identifant de l'annexe", - "url": "url complète de l'annexe" - } - ] - }, - { - "name": "nom du style 2", - "layers": ["..."] - } -] -``` - -> Il y a un fichier de style SLD par table. Donc pour chaque table il y a un annexe qui contient le style. Et cette structure json globale répertorie tous les styles associés à une configuration WFS. - -- `Mapbox` pour une configuration du type `WMTS-TMS` (pyramide de tuiles vectorielles) - -```json -[ - { - "name": "nom du style 1", - "current": true, - "layers": [ - { - // une seule layer et pas de name parce qu'il y a une seule couche en TMS - "annexe_id": "identifant de l'annexe", - "url": "url complète de l'annexe" - } - ] - }, - { - "name": "nom du style 2", - "layers": ["..."] - } -] -``` +Migré vers [extra](./extra.md#un-ensemble-de-fichiers-de-style-associés-à-une-configuration). ## un ensemble de documents liés à une fiche de donnée Syntaxe du path : ``` -/documents/[datasheet_name]/styles.json +/documents/[datasheet_name].json ``` | variable | description | | diff --git a/docs/developer/entrepot/extra.md b/docs/developer/entrepot/extra.md new file mode 100644 index 00000000..3a0e0b7f --- /dev/null +++ b/docs/developer/entrepot/extra.md @@ -0,0 +1,80 @@ +# Utilisation des `extra` + +Il s'agit d'une propriété nommée `extra` qui sont présentes dans certaines [entités](https://geoplateforme.github.io/entrepot/production/concepts/) de l'API qui permet de stocker des informations supplémentaires. + +## un ensemble de fichiers de style associés à une configuration + +Chemin dans extra : "styles" + +```json +{ + "extra": { + "styles": [] + } +} +``` + +Structure json : + +```ts +export type Styles = { + name: string; + current?: boolean; + layers: { + name?: string; + annexe_id: string; + url: string; + }[]; +}[]; +``` + +- `SLD` ou `QML` pour une configuration du type `WFS` + +```json +[ + { + "name": "nom du style 1", + "current": true, + "layers": [ + { + "name": "nom de la table 1", + "annexe_id": "identifant de l'annexe", + "url": "url complète de l'annexe" + }, + { + "name": "nom de la table 2", + "annexe_id": "identifant de l'annexe", + "url": "url complète de l'annexe" + } + ] + }, + { + "name": "nom du style 2", + "layers": ["..."] + } +] +``` + +> Il y a un fichier de style SLD par table. Donc pour chaque table il y a un annexe qui contient le style. Et cette structure json globale répertorie tous les styles associés à une configuration WFS. + +- `Mapbox` pour une configuration du type `WMTS-TMS` (pyramide de tuiles vectorielles) + +```json +[ + { + "name": "nom du style 1", + "current": true, + "layers": [ + { + // une seule layer et pas de name parce qu'il y a une seule couche en TMS + "annexe_id": "identifant de l'annexe", + "url": "url complète de l'annexe" + } + ] + }, + { + "name": "nom du style 2", + "layers": ["..."] + } +] +``` diff --git a/docs/developer/entrepot/labels.md b/docs/developer/entrepot/labels.md index 4e88e472..9728ce9c 100644 --- a/docs/developer/entrepot/labels.md +++ b/docs/developer/entrepot/labels.md @@ -17,7 +17,7 @@ Exemple : datasheet_name=Ma donnée ### fichier de style individuel (par ex. contenu du SLD, QML etc) -Un fichier de style déposé via cartes.gouv.fr est stocké d'abord dans un annexe avant d'être référencé dans l'annexe "chapeau" décrit [ici](./annexes.md) +Un fichier de style déposé via cartes.gouv.fr est stocké d'abord dans un annexe avant d'être référencé dans la propriété `extra` de la configuration décrite [ici](./extra.md) | label | description | | | ---------------- | ------------------------- | ------ |