Update OpenAPI specifications for datastore API in English and Spanish

OpenDataGIS · Oct 25, 2024 · c31470e · c31470e
1 parent 7119c36
commit c31470e
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 7 deletions.
diff --git a/ckanext/miteco/public/static/openapi/datastore-en.yaml b/ckanext/miteco/public/static/openapi/datastore-en.yaml
@@ -17,16 +17,25 @@ info:
   license:
     name: CC BY 4.0
     url: https://creativecommons.org/licenses/by/4.0/
-  version: '0.1'
+  version: 0.1
 security:
   - default: []
+basePath: /v1
+tags:
+  - name: datastore
+    description: The Data API
+    externalDocs:
+      description: Find out more
+      url: https://docs.ckan.org/en/2.10/maintaining/datastore.html#the-data-api
 paths:
   /action/datastore_search:
     post:
+      tags:
+        - datastore
       summary: Search a datastore resource
       description: >
         The datastore_search action allows you to search data in a resource.
-        Well-formatted CSV files that are uploaded (not linked) are automatically loaded into the datastore.
+        Well-formatted CSV/TSV files that are uploaded or linked are automatically loaded into the datastore.
       requestBody:
         required: true
         content:
@@ -106,8 +115,6 @@ paths:
                 value:
                   resource_id: d22d2aca-155b-4978-b5c1-1d39837e1993
                   sort: '"Date and Time Deleted/Fecha y hora de eliminación" desc'
-      tags:
-      - action
       responses:
         '200':
           description: List of packages (datasets) including all metadata available.
diff --git a/ckanext/miteco/public/static/openapi/datastore-es.yaml b/ckanext/miteco/public/static/openapi/datastore-es.yaml
@@ -20,13 +20,22 @@ info:
   version: '0.1'
 security:
   - default: []
+basePath: /v1
+tags:
+  - name: datastore
+    description: La API de datos
+    externalDocs:
+      description: Más información
+      url: https://docs.ckan.org/en/2.10/maintaining/datastore.html#the-data-api
 paths:
   /action/datastore_search:
     post:
+      tags:
+        - datastore
       summary: "Buscar un recurso en el datastore"
       description: >
         La acción datastore_search permite buscar datos en un recurso.
-        Los archivos CSV bien formateados que se suben (no enlazados) se cargan automáticamente en el datastore.
+        Los archivos CSV/TSV bien formateados que se suben o se enlazan se cargan automáticamente en el datastore.
       requestBody:
         required: true
         content:
@@ -106,8 +115,6 @@ paths:
                 value:
                   resource_id: d22d2aca-155b-4978-b5c1-1d39837e1993
                   sort: '"Date and Time Deleted/Fecha y hora de eliminación" desc'
-      tags:
-      - action
       responses:
         '200':
           description: "Lista de paquetes (conjuntos de datos) incluyendo todos los metadatos disponibles."