moving currency definition to common for reuse

Author: thekaveman

policy/README.md

@@ -208,7 +208,7 @@ An individual `Policy` object is defined by the following fields:
 | `policy_id`      | UUID            | Required   | Unique ID of policy                                                                 |
 | `provider_ids`   | UUID[]          | Optional    | Providers for whom this policy is applicable; empty arrays and `null`/absent implies all Providers. See MDS [provider list](/providers.csv). |
 | `description`    | String          | Required   | Description of policy                                                               |
-| `currency`       | String          | Optional   | An ISO 4217 Alphabetic Currency Code representing the [currency](../provider#costs--currencies) of all Rules of [type](#rule-types) `rate`.|
+| `currency`       | String          | Optional   | An ISO 4217 Alphabetic Currency Code representing the [currency](../general-information.md#costs-and-currencies) of all Rules of [type](#rule-types) `rate`.|
 | `start_date`     | [timestamp][ts] | Required   | Beginning date/time of policy enforcement                                           |
 | `end_date`       | [timestamp][ts] | Optional    | End date/time of policy enforcement                                                 |
 | `published_date` | [timestamp][ts] | Required   | Timestamp that the policy was published                                             |

schema/policy.py

@@ -14,6 +14,7 @@ def policy_schema():
     # load schema template and insert definitions
     schema = common.load_json("./templates/policy/policy.json")
     definitions = common.load_definitions(
+        "currency",
         "day",
         "days",
         "iso_time",

schema/provider.py

@@ -87,7 +87,10 @@ def trips_schema():
         # 2. There must be *at least* two Features in the FeatureCollection.
         features = { "items": { "$ref": common.definition_id("MDS_Feature_Point") }, "minItems": 2 }
     )
-    trips_definitions = { "MDS_FeatureCollection_Route": mds_feature_collection_route }
+    trips_definitions = {
+        "currency": common.load_definitions("currency"),
+        "MDS_FeatureCollection_Route": mds_feature_collection_route
+    }
 
     # create the trips schema
     schema = endpoint_schema("trips", trips_definitions)

schema/templates/common.json

@@ -14,6 +14,21 @@
         "preferred_drop_off"
       ]
     },
+    "currency": {
+      "$id": "#/definitions/currency",
+      "type": [
+        "string",
+        "null"
+      ],
+      "pattern": "^[A-Z]{3}$",
+      "default": "USD",
+      "description": "An ISO 4217 Alphabetic Currency Code representing currency of the payee. If null, USD cents is implied.",
+      "examples": [
+        "USD",
+        "EUR",
+        "GBP"
+      ]
+    },
     "day": {
       "$id": "#/definitions/day",
       "type": "string",

schema/templates/policy/policy.json

@@ -33,6 +33,10 @@
           "$ref": "#/definitions/string",
           "description": "Description of policy"
         },
+        "currency": {
+          "$id": "#/definitions/policy/properties/currency",
+          "$ref": "#/definitions/currency"
+        },
         "start_date":{
           "$id": "#/definitions/policy/properties/start_date",
           "$ref": "#/definitions/timestamp",

schema/templates/provider/trips.json

@@ -106,18 +106,7 @@
         },
         "currency": {
           "$id": "#/properties/data/properties/trips/items/properties/currency",
-          "type": [
-            "string",
-            "null"
-          ],
-          "pattern": "^[A-Z]{3}$",
-          "default": "USD",
-          "description": "An ISO 4217 Alphabetic Currency Code representing the currency of the payee. If null, USD cents is implied.",
-          "examples": [
-            "USD",
-            "EUR",
-            "GBP"
-          ]
+          "$ref": "#/definitions/currency"
         }
       }
     }