add extras

extras is a key-value map to add additional informations on a dataset
etalab · Oct 26, 2020 · b7cd657 · b7cd657
1 parent 2fd7d3d
commit b7cd657
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 1 deletion.
diff --git a/example_configuration_file.yml b/example_configuration_file.yml
@@ -4,3 +4,5 @@ datasets:
     gtfs: https://www.metromobilite.fr/data/Horaires/SEM-GTFS.zip
     gtfs-rt-urls: 
       - https://data.metromobilite.fr/api/gtfs-rt/GAM/trip-update
+    extras:
+      datagouv_id: 5af03701b595081c1880a8a4
diff --git a/src/datasets.rs b/src/datasets.rs
@@ -108,6 +108,8 @@ pub struct DatasetInfo {
     pub id: String,
     pub gtfs: String,
     pub gtfs_rt_urls: Vec<String>,
+    #[serde(default)]
+    pub extras: std::collections::BTreeMap<String, String>,
 }
 
 impl DatasetInfo {
@@ -117,6 +119,7 @@ impl DatasetInfo {
             name: "default name".into(),
             gtfs: gtfs.to_owned(),
             gtfs_rt_urls: gtfs_rt_urls.to_vec(),
+            extras: std::collections::BTreeMap::default(),
         }
     }
 }

diff --git a/src/routes/exposed_dataset.rs b/src/routes/exposed_dataset.rs
@@ -7,6 +7,7 @@ pub struct ExposedDataset {
     pub name: String,
     pub id: String,
     pub gtfs: String,
+    pub extras: std::collections::BTreeMap<String, String>,
     // we do not expose the gtfs-rt sources since the information can contains api key
     // so we add links to the gtfs-rt routes instead
     #[serde(flatten)]
@@ -19,6 +20,7 @@ impl From<&DatasetInfo> for ExposedDataset {
             name: d.name.clone(),
             id: d.id.clone(),
             gtfs: d.gtfs.clone(),
+            extras: d.extras.clone(),
             links: Links::default(),
         }
     }

diff --git a/tests/entry_point_test.rs b/tests/entry_point_test.rs
@@ -34,7 +34,8 @@ async fn test_entrypoint(srv: &mut actix_web::test::TestServer) {
                         },
                         "gtfs": "fixtures/gtfs.zip",
                         "id": "default",
-                        "name": "default name"
+                        "name": "default name",
+                        "extras": {},
                     }
                 ]
             }
@@ -55,6 +56,7 @@ async fn test_dataset_entrypoint(srv: &mut actix_web::test::TestServer) {
                 "id": "default",
                 "gtfs": "fixtures/gtfs.zip",
                 "loaded_at": "2019-06-20T10:00:00Z",
+                "extras": {},
                 "_links": {
                     "general-message": {
                         "href": &srv.url("/default/siri/2.0/general-message.json")