You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: policy/README.md
+12-14Lines changed: 12 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -267,7 +267,7 @@ An individual `Policy` object is defined by the following fields:
267
267
|`policy_id`| UUID | Required | Unique ID of policy |
268
268
|`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). |
269
269
|`description`| String | Required | Description of policy |
270
-
|`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`.|
270
+
|`currency`| String | Optional | An ISO 4217 Alphabetic Currency Code representing the [currency](../general-information.md#costs-and-currencies) of all Rules with a `rate_amount`.|
271
271
|`start_date`|[timestamp][ts]| Required | Beginning date/time of policy enforcement. In order to give providers sufficient time to poll, `start_date` must be at least 20 minutes after `published_date`. |
272
272
|`end_date`|[timestamp][ts]| Optional | End date/time of policy enforcement |
273
273
|`published_date`|[timestamp][ts]| Required | Timestamp that the policy was published |
@@ -313,23 +313,21 @@ An individual `Rule` object is defined by the following fields:
313
313
|`count`| Fleet counts based on regions. Rule `minimum`/`maximum` refers to number of devices in [Rule Units](#rule-units). |
314
314
|`time`| Individual limitations or fees based upon time spent in one or more vehicle states. Rule `minimum`/`maximum` refers to increments of time in [Rule Units](#rule-units). |
315
315
|`speed`| Global or local speed limits. Rule `minimum`/`maximum` refers to speed in [Rule Units](#rule-units). |
316
-
|`rate`|**[Beta feature](/general-information.md#beta-features):***Yes (as of 1.0.0)*. Fees or subsidies based on regions and time spent in one or more vehicle states. Rule `rate_amount` refers to the rate charged according to the [Rate Recurrences](#rate_recurrences) and the [currency requirements](/general-information.md#costs-and-currencies) in [Rule Units](#rule-units). *Prior to implementation agencies should consult with providers to discuss how the `rate` rule will be used. Most agencies do this as a matter of course, but it is particularly important to communicate in advance how frequently and in what ways rates might change over time.*|
317
316
|`user`| Information for users, e.g. about helmet laws. Generally can't be enforced via events and telemetry. |
[Rule type](#rule-types)`user` has no associated Rule units; `rule_units` is not required when the Rule type is `user`.
335
333
@@ -352,9 +350,9 @@ An individual `Rule` object is defined by the following fields:
352
350
[Top][toc]
353
351
354
352
### Rates
355
-
Rate-related properties can currently be specified on `rate` and `time` Rules. Note: A future MDS version will likely support rates for `count` and `speed` rules, but their behavior is currently undefined.
353
+
Rate-related properties can currently be specified on all rule types except `user`, i.e. any rule that can be measured.
356
354
357
-
**[Beta feature](/general-information.md#beta-features)**: *Yes (as of 1.0.0)*. [Leave feedback](https://github.com/openmobilityfoundation/mobility-data-specification/issues/674)
355
+
**[Beta feature](/general-information.md#beta-features)**: *No (as of 2.0.0)*. [Leave feedback](https://github.com/openmobilityfoundation/mobility-data-specification/issues/674)
358
356
359
357
#### Rate Amounts
360
358
The amount of a rate applied when this rule applies, if applicable (default zero). A positive integer rate amount represents a fee, while a negative integer represents a subsidy. Rate amounts are given in the `currency` defined in the [Policy](#policy).
0 commit comments