Skip to content

Commit c1b238d

Browse files
committed
Merge branch 'dev' into feature-agency-provider-api-alignment
2 parents 1f4d197 + 8a83e1f commit c1b238d

4 files changed

Lines changed: 394 additions & 37 deletions

File tree

policy/README.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,7 @@ An individual `Policy` object is defined by the following fields:
267267
| `policy_id` | UUID | Required | Unique ID of policy |
268268
| `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). |
269269
| `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`.|
271271
| `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`. |
272272
| `end_date` | [timestamp][ts] | Optional | End date/time of policy enforcement |
273273
| `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:
313313
| `count` | Fleet counts based on regions. Rule `minimum`/`maximum` refers to number of devices in [Rule Units](#rule-units). |
314314
| `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). |
315315
| `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.* |
317316
| `user` | Information for users, e.g. about helmet laws. Generally can't be enforced via events and telemetry. |
318317

319318
[Top][toc]
320319

321320
### Rule Units
322321

323-
| Name | Rule Types | Description |
324-
| --------- | ---------------------- | ------------------- |
325-
| `seconds` | `rate`, `time` | Seconds |
326-
| `minutes` | `rate`, `time` | Minutes |
327-
| `hours` | `rate`, `time` | Hours |
328-
| `days` | `rate`, `time` | Days |
329-
| `amount` | `rate` | Cost (in [local currency](/general-information.md#costs-and-currencies)) |
330-
| `mph` | `speed` | Miles per hour |
331-
| `kph` | `speed` | Kilometers per hour |
332-
| `devices` | `count` | Devices |
322+
| Name | Rule Types | Description |
323+
| --------- | -------------- | ------------------- |
324+
| `seconds` | `time` | Seconds |
325+
| `minutes` | `time` | Minutes |
326+
| `hours` | `time` | Hours |
327+
| `days` | `time` | Days |
328+
| `mph` | `speed` | Miles per hour |
329+
| `kph` | `speed` | Kilometers per hour |
330+
| `devices` | `count` | Devices |
333331

334332
[Rule type](#rule-types) `user` has no associated Rule units; `rule_units` is not required when the Rule type is `user`.
335333

@@ -352,9 +350,9 @@ An individual `Rule` object is defined by the following fields:
352350
[Top][toc]
353351

354352
### 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.
356354

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)
358356

359357
#### Rate Amounts
360358
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

Comments
 (0)