Correction api doc

IGNF · May 10, 2021 · 4a7c995 · 4a7c995
1 parent 211c6a6
commit 4a7c995
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 28 deletions.
diff --git a/doc/aoc.yml b/doc/aoc.yml
@@ -3,7 +3,7 @@ swagger: '2.0'
 info:
   title: API Carto Appellations viticoles
   description: >
-    Le module AOC permet de récupérer les AOC viticoles de l’INAO intersectant une géométrie GeoJSON.
+    Le module appellations viticoles permet de récupérer les zones intersectant une géométrie GeoJSON.
 
     Le module utilise une base de données entretenue par FranceAgriMer. Cette base de données regroupe :
     

diff --git a/doc/cadastre.yml b/doc/cadastre.yml
@@ -58,15 +58,15 @@ info:
   
     Exemple de géométrie : (référentiel EPSG:4326)
 
-      * Point : 
+      * Point: 
         
         `{"type": "Point","coordinates":[-1.691634,48.104237]}`
 
-      * MultiPolygon : 
+      * MultiPolygon: 
         
         `{"type":"MultiPolygon","coordinates":[[[[-0.288863182067871,48.963666607295977],[-0.299592018127441,48.959299208576141],[-0.296330451965332,48.955325952385039],[-0.282125473022461,48.950675995388366],[-0.279722213745117,48.967019382922331],[-0.288863182067871,48.963666607295977]]]]}`
       
-      * Surface trouée : 
+      * Surface trouée: 
           
         `{"type":"Polygon","coordinates":[[[1.2,48.85],[1.3,48.85],[1.3,48.9],[1.2,48.9],[1.2,48.85]],[[1.23,48.86],[1.23,48.88],[1.26,48.88],[1.26,48.86],[1.23,48.86]]]}`
   
@@ -132,7 +132,7 @@ paths:
 
         - name: source_ign
           in: query
-          description: Mettre PCI pour utiliser la couche PCI Express au lieu de la couche BDPARCELLAIRE
+          description: « PCI » pour la ressource Parcellaire Express ou « BDP » pour la ressource BD Parcellaire
           type: string
           required: false
 
@@ -364,7 +364,7 @@ paths:
 
         - name: source_ign
           in: query
-          description: Mettre PCI pour utiliser la couche PCI Express au lieu de la couche BDPARCELLAIRE
+          description: « PCI » pour la ressource Parcellaire Express ou « BDP » pour la ressource BD Parcellaire
           type: string
           required: false
 
@@ -440,7 +440,7 @@ paths:
 
         - name: source_ign
           in: query
-          description: Mettre PCI pour utiliser la couche PCI Express au lieu de la couche BDPARCELLAIRE
+          description: « PCI » pour la ressource Parcellaire Express ou « BDP » pour la ressource BD Parcellaire
           type: string
           required: false
 

diff --git a/doc/gpu.yml b/doc/gpu.yml
@@ -16,10 +16,14 @@ info:
     Consultez la [documentation utilisateur](https://apicarto.ign.fr/api/doc/pdf/docUser_moduleUrbanisme.pdf) pour plus d’informations sur les paramètres d’appel disponibles et le format des résultats.
 
     
-    Exemple de géométrie : (référentiel EPSG:4326)
+    Exemple de géométrie: (référentiel EPSG:4326)
 
-      * Centre de Rennes : `{"type": "Point","coordinates":[-1.691634,48.104237]}`
-      * Parcelle : `{"type":"MultiPolygon","coordinates":[[[[-0.4781433,44.745308],[-0.4782708,44.74523],[-0.4783436,44.7451852],[-0.4783998,44.7451462],[-0.4784414,44.7451099],[-0.4784924,44.7450598],[-0.4785333,44.7450223],[-0.4785783,44.7449774],[-0.4786326,44.7449217],[-0.4786341,44.7449202],[-0.4795499,44.7457302],[-0.4789179,44.7461035],[-0.4781433,44.745308]]]]}`
+      * Centre de Rennes: 
+
+        `{"type": "Point","coordinates":[-1.691634,48.104237]}`
+      * Parcelle: 
+      
+        `{"type":"MultiPolygon","coordinates":[[[[-0.4781433,44.745308],[-0.4782708,44.74523],[-0.4783436,44.7451852],[-0.4783998,44.7451462],[-0.4784414,44.7451099],[-0.4784924,44.7450598],[-0.4785333,44.7450223],[-0.4785783,44.7449774],[-0.4786326,44.7449217],[-0.4786341,44.7449202],[-0.4795499,44.7457302],[-0.4789179,44.7461035],[-0.4781433,44.745308]]]]}`
 
 
   contact:
@@ -44,7 +48,7 @@ paths:
 
         - in: query
           name: geom
-          type: object
+          type: string
           required: false
           description: Géométrie GeoJSON utilisée pour la recherche
 
@@ -72,7 +76,7 @@ paths:
       parameters:
         - in: query
           name: geom
-          type: object
+          type: string
           required: false
           description: Géométrie GeoJSON utilisée pour la recherche
 
@@ -99,7 +103,7 @@ paths:
       parameters:
         - in: query
           name: geom
-          type: object
+          type: string
           required: false
           description: Géométrie GeoJSON utilisée pour la recherche
 
@@ -126,7 +130,7 @@ paths:
       parameters:
         - in: query
           name: geom
-          type: object
+          type: string
           required: false
           description: Géométrie GeoJSON utilisée pour la recherche
 
@@ -154,7 +158,7 @@ paths:
       parameters:
         - in: query
           name: geom
-          type: object
+          type: string
           required: false
           description: Géométrie GeoJSON utilisée pour la recherche
 
@@ -181,7 +185,7 @@ paths:
       parameters:
         - in: query
           name: geom
-          type: object
+          type: string
           required: false
           description: Géométrie GeoJSON utilisée pour la recherche
 
@@ -208,7 +212,7 @@ paths:
       parameters:
         - in: query
           name: geom
-          type: object
+          type: string
           required: false
           description: Géométrie GeoJSON utilisée pour la recherche 
 
@@ -235,7 +239,7 @@ paths:
       parameters:
         - in: query
           name: geom
-          type: object
+          type: string
           required: false
           description: Géométrie GeoJSON utilisée pour la recherche   
 
@@ -262,7 +266,7 @@ paths:
       parameters:
         - in: query
           name: geom
-          type: object
+          type: string
           required: false
           description: Géométrie GeoJSON utilisée pour la recherche
 
@@ -289,7 +293,7 @@ paths:
       parameters:
         - in: query
           name: geom
-          type: object
+          type: string
           required: false
           description: Géométrie GeoJSON utilisée pour la recherche
 
@@ -317,7 +321,7 @@ paths:
       parameters:
         - in: query
           name: geom
-          type: object
+          type: string
           required: false
           description: Géométrie GeoJSON utilisée pour la recherche
 
@@ -344,7 +348,7 @@ paths:
       parameters:
         - in: query
           name: geom
-          type: object
+          type: string
           required: false
           description: Géométrie GeoJSON utilisée pour la recherche
 
@@ -377,7 +381,7 @@ paths:
       parameters:
         - in: query
           name: geom
-          type: object
+          type: string
           required: false
           description: Géométrie GeoJSON utilisée pour la recherche
 
@@ -410,7 +414,7 @@ paths:
       parameters:
         - in: query
           name: geom
-          type: object
+          type: string
           required: false
           description: Géométrie GeoJSON utilisée pour la recherche
 
@@ -444,7 +448,7 @@ paths:
       parameters:
         - in: query
           name: geom
-          type: object
+          type: string
           required: false
           description: Géométrie GeoJSON utilisée pour la recherche
 
@@ -477,7 +481,7 @@ paths:
       parameters:
         - in: query
           name: geom
-          type: object
+          type: string
           required: false
           description: Géométrie GeoJSON utilisée pour la recherche
 
@@ -509,7 +513,7 @@ paths:
       parameters:
         - in: query
           name: geom
-          type: object
+          type: string
           required: false
           description: Géométrie GeoJSON utilisée pour la recherche 
 

diff --git a/doc/rpg.yml b/doc/rpg.yml
@@ -26,7 +26,10 @@ info:
       
       Lors de votre demande de clé IGN, vous devez commander les flux "Ressources WFS Géoportail - RPG" ci-dessous suivant l'année désirée:
           
-      * RPG.2010:rpg_2010, RPG.2011:rpg_2011, RPG.2012:rpg_2012, RPG.2013:rpg_2013
+      * RPG.2010:rpg_2010
+      * RPG.2011:rpg_2011
+      * RPG.2012:rpg_2012
+      * RPG.2013:rpg_2013
       * RPG.2014:ilots_anonymes
       * RPG.2015:parcelles_graphiques
       * RPG.2016:parcelles_graphiques