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
+16-12Lines changed: 16 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,7 +37,7 @@ Versioning must be implemented as specified in the [Versioning section][versioni
37
37
38
38
## Background
39
39
40
-
The goal of this specification is to enable Agencies to create, revise, and publish machine-readable policies, as sets of rules for individual and collective device behavior exhibited by both _mobility as a service_ Providers and riders / users. Examples of policies include:
40
+
The goal of this specification is to enable Agencies to create, revise, and publish machine-readable policies, as sets of rules for individual and collective device behavior exhibited by both _mobility as a service_ Providers and riders / users. [Examples](examples.md) of policies include:
41
41
42
42
- City-wide and localized caps (e.g. "Minimum 500 and maximum 3000 scooters within city boundaries")
43
43
- Exclusion zones (e.g. "No scooters are permitted in this district on weekends")
@@ -48,6 +48,8 @@ The goal of this specification is to enable Agencies to create, revise, and publ
48
48
49
49
The machine-readable format allows Providers to obtain policies and compute compliance where it can be determined entirely by data obtained internally.
50
50
51
+
**See the [Policy Examples](examples.md) for ways these can be implemented.**
52
+
51
53
[Top][toc]
52
54
53
55
## Distribution
@@ -224,7 +226,7 @@ An individual `Rule` object is defined by the following fields:
224
226
|`rule_type`| enum | Required | Type of policy (see [Rule Types](#rule-types)) |
225
227
|`geographies`| UUID[]| Required | List of Geography UUIDs (non-overlapping) specifying the covered geography |
226
228
|`states`|`{ state: event[] }`| Required |[Vehicle state][vehicle-states] to which this rule applies. Optionally provide a list of specific [vehicle events][#vehicle-events] as a subset of a given status for the rule to apply to. An empty list or `null`/absent defaults to "all". |
227
-
|`rule_units`| enum |Optional| Measured units of policy (see [Rule Units](#rule-units)) |
229
+
|`rule_units`| enum |Required| Measured units of policy (see [Rule Units](#rule-units)) |
|`count`| Fleet counts based on regions. Rule `max`/`min` refers to number of devices. |
248
+
|`count`| Fleet counts based on regions. Rule `max`/`min` refers to number of devices in [Rule Units](#rule-units). |
247
249
|`time`| Individual limitations on time spent in one or more vehicle-states. Rule `max`/`min` refers to increments of time in [Rule Units](#rule-units). |
248
250
|`speed`| Global or local speed limits. Rule `max`/`min` refers to speed in [Rule Units](#rule-units). |
249
-
|`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 Recurrence](#rate_recurrence). Agencies and Providers must agree on terms of use prior to utilizing the `rate` rule type. |
251
+
|`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). As this is a beta feature, agencies are strongly advised to consult with providers about how they intended to use the `rate` rule prior to implementation.|
250
252
|`user`| Information for users, e.g. about helmet laws. Generally can't be enforced via events and telemetry. |
0 commit comments