Skip to content

Commit

Permalink
docs: réorganisation et ajout docs capabilities
Browse files Browse the repository at this point in the history
  • Loading branch information
ocruze committed Jan 9, 2025
1 parent 3abeece commit 521fff6
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 47 deletions.
50 changes: 48 additions & 2 deletions docs/developer/entrepot/annexes.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,27 @@

Il s'agit d'une [entité](https://geoplateforme.github.io/entrepot/production/concepts/) de l'API qui représente des fichiers librement déposés et utilisés par les utilisateurs de l'API Entrepôt.

## un ensemble de fichiers de style associés à une configuration
## un fichier de style individuel (par ex. contenu du SLD, QML etc)

Migré vers [extra](./extra.md#un-ensemble-de-fichiers-de-style-associés-à-une-configuration).
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#un-ensemble-de-fichiers-de-style-associés-à-une-configuration)

Labels :

| label | description | |
| ---------------- | ------------------------- | ------ |
| `datasheet_name` | nom de la fiche de donnée | string |
| `type` | valeur fixe : "style" | string |

## un document lié à une fiche de donnée

Un document du type fichier est stocké d'abord dans un annexe avant d'être référencé dans l'annexe "chapeau" décrit ci-dessous.

Labels :

| label | description | |
| ---------------- | ------------------------- | ------ |
| `datasheet_name` | nom de la fiche de donnée | string |
| `type` | valeur fixe : "document" | string |

## un ensemble de documents liés à une fiche de donnée

Expand All @@ -18,6 +36,13 @@ Syntaxe du path :
| ---------------- | ------------------------- | ------ |
| `datasheet_name` | nom de la fiche de donnée | string |

Labels :

| label | description | |
| ---------------- | ----------------------------- | ------ |
| `datasheet_name` | nom de la fiche de donnée | string |
| `type` | valeur fixe : "document-list" | string |

Structure de cet annexe json :

```ts
Expand Down Expand Up @@ -49,3 +74,24 @@ export type DatasheetDocument = {
...
]
```

## la vignette d'une fiche de donnée

Labels :

| label | description | |
| ---------------- | ------------------------- | ------ |
| `datasheet_name` | nom de la fiche de donnée | string |
| `type` | valeur fixe : "thumbnail" | string |

## un fichier GetCapabilities filtré pour chaque endpoint public des flux WFS, WMS (raster et vecteur) et WMTS

Syntaxe du path :

```
/[endpoint_technical_name]/capabilities.xml
```

| label | description | |
| ------ | ---------------------------- | ------ |
| `type` | valeur fixe : "capabilities" | string |
46 changes: 2 additions & 44 deletions docs/developer/entrepot/labels.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,48 +6,6 @@ Mais nous utilisons les labels comme des `tags` de la manière suivante : "[clé

Exemple : datasheet_name=Ma donnée

## `annexe`
Utilisation des labels de :

### vignette d'une fiche de donnée

| label | description | |
| ---------------- | ------------------------- | ------ |
| `datasheet_name` | nom de la fiche de donnée | string |
| `type` | valeur fixe : "thumbnail" | string |

### 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 la propriété `extra` de la configuration décrite [ici](./extra.md)

| label | description | |
| ---------------- | ------------------------- | ------ |
| `datasheet_name` | nom de la fiche de donnée | string |
| `type` | valeur fixe : "style" | string |

### ensemble de documents liés à une fiche de donnée

| label | description | |
| ---------------- | ----------------------------- | ------ |
| `datasheet_name` | nom de la fiche de donnée | string |
| `type` | valeur fixe : "document-list" | string |

### un document lié à une fiche de donnée

Un document du type fichier est stocké d'abord dans un annexe avant d'être référencé dans l'annexe "chapeau" décrit au-dessus et [ici](./annexes.md)

| label | description | |
| ---------------- | ------------------------- | ------ |
| `datasheet_name` | nom de la fiche de donnée | string |
| `type` | valeur fixe : "document" | string |

### fichier GetCapabilities filtrés pour les endpoints WFS, WMS (raster et vecteur) et WMTS

Syntaxe du path :

```
/[endpoint_technical_name]/capabilities.xml
```

| label | description | |
| ------ | ---------------------------- | ------ |
| `type` | valeur fixe : "capabilities" | string |
- [annexes](./annexes.md)
2 changes: 1 addition & 1 deletion docs/developer/entrepot/statics.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Il s'agit d'une [entité](https://geoplateforme.github.io/entrepot/production/concepts/) de l'API qui représente des fichiers de configuration utilisés par l'Entrepôt en arrière plan lors des différents traitements.

Cette entité `static` a seulement une propriété `name`, pas de `tags` ni de `labels`. Donc, afin de pouvoir lier ces fichiers statiques à d'autres entités pour notre usage, nous allons se contenter d'utiliser une nomination particulière.
Cette entité `static` a seulement une propriété `name` pouvant être utilisé pour filtrer, pas de `tags` ni de `labels`. Donc, afin de pouvoir lier ces fichiers statiques à d'autres entités pour notre usage, nous allons se contenter d'utiliser une nomination particulière.

## fichiers de style SLD pour une configuration du type `WMS-VECTOR`

Expand Down

0 comments on commit 521fff6

Please sign in to comment.