Improve description field in Policy to require more human readable details #786

jyeo17 · 2022-09-12T14:36:15Z

New examples for Policy with agreed upon rule types - updated by Justin Yeo after discussion with Jean Kao

name: Improve description field description in Policy to require more human readable details
about: Suggest changes to MDS
title: Improve description field description in Policy to require more human readable details

MDS Pull Request

Thank you for your contribution! Please review our OMF contributing page to understand guidelines and policies for participation, and our Code of Conduct page.

To avoid complications and help make the Review process as smooth as possible, make sure to:

Target dev branch. Please ensure you are targeting dev, not main.
Keep the "Allow edits from maintainers" button checked to help us resolve some issues for you.
Be ready to resolve any merge conflicts before we approve your Pull Request.
Have an up to date profile, per our Github community profile guildance.

Explain pull request

Improve description field description in Policy to require more human readable details

Is this a breaking change

No, not breaking

Impacted Spec

Which spec(s) will this pull request impact?

policy

Additional context

Issue from #764
Decided upon in https://github.com/openmobilityfoundation/mobility-data-specification/wiki/Web-conference-notes,-2022.06.23-(MDS-Working-Group)

New examples for Policy with agreed upon rule types - updated by Justin Yeo after discussion with Jean Kao

CLAassistant · 2022-09-12T14:36:25Z

All committers have signed the CLA.

schnuerle · 2022-09-13T14:18:58Z

Thanks @jyeo17 ! Could you resolve the conflicts with policy/examples/README.md and click here to sign the CLA: https://cla-assistant.io/openmobilityfoundation/mobility-data-specification?pullRequest=786

jyeo17 · 2022-09-13T14:59:16Z

@schnuerle thanks for going through it! I have completed them.
I am not sure who added the 3 examples at the bottom but I have left them there.

schnuerle · 2022-10-06T17:02:33Z

policy/examples/README.md

-  ]
-}
+
+ Still to be decided upon


Could you write this "No Riding" policy example based on what you and @jean-populus think is best?

yes we will do @schnuerle

schnuerle · 2022-10-07T15:32:49Z

Currently the PR has these examples defined:

Operating Area
No Riding
No Parking
Parking
Parking Time Limit
Speed Limit
Distribution Policies
Tiered Parking Fees
Provider Caps or Minimums

and in the planning doc we collectively listed these use cases:

Operating Area
No Riding
No Parking
Provider Caps or Minimums
Distribution Policies
Parking Time Limit
Speed Limits
Per Trip Fees
Vehicle Right of Way Fees
Metered Parking Fees
Required Parking
Preferred Parking
Tiered Parking Fees
Tiered Parking Fees Total
Pick-up and Drop-off Fees
Emergency Guidance
Publish Event Areas
Periodic maintenance enforcement
Required parking centroid
Registration fee

Which leaves these use cases not yet addressed.

Per Trip Fees
Vehicle Right of Way Fees
Metered Parking Fees
Tiered Parking Fees Total
Pick-up and Drop-off Fees
Emergency Guidance
Publish Event Areas
Periodic maintenance enforcement
Required parking centroid
Registration fee

And these two which I don't think are covered by just 'Parking':

Required Parking (this might be what Parking is in the PR now)
Preferred Parking

Do you think you could add these now? @jyeo17 @S-eb @jean-populus

If not we could do it in a future pull request, and I'd like to capture that in issue #764 as a comment.

S-eb · 2022-10-12T16:56:07Z

Currently the PR has these examples defined:

Operating Area

No Riding

No Parking

Parking

Parking Time Limit

Speed Limit

Distribution Policies

Tiered Parking Fees

Provider Caps or Minim

@schnuerle

The decision was taken at the task force level to tackle only the policies where
1- automation brings efficiency
2- policy rules are likely to change a lot

Therefore the short list for the following policies:

Operating Area

No Riding

No Parking

Parking

Parking Time Limit

Speed Limit

Distribution Policies

Tiered Parking Fees

Provider Caps or Minim

This has been validated by the WG steering committee.

The decision was also taken to not consider fees as part of the policy taskforce.
the consensus being that fees is probably a different object that should be treated separately from policies.

Thanks

Seb

jyeo17 · 2022-10-12T17:10:03Z

Just a note, Tiered Parking Fees was not part of the discussion and so has been removed.

We have:

Operating Area

No Riding

No Parking

Parking

Parking Time Limit

Speed Limit

Distribution Policies

Provider Caps or Minimums

mrsimpson · 2022-10-13T11:52:49Z

policy/examples/README.md

+    "available": [], 
+    "non_operational": [], 
+    "reserved": [], 


@jyeo17 as per how I understood your comment, no riding should not be restricted to the state on_trip, shouldn't it?

You can count vehicles that are on_trip to count the process of riding. This works in most cases as trip telemetry and speed isn't usually measured in real-time.

Is the"on_trip": [] state listed here needed, or should it be removed @jyeo17 @jean-populus @S-eb?

jyeo17 · 2022-10-26T16:04:19Z

After the discussion in the working group,
I propose that we keep the definitions of the 2 main definitions of use cases that were discussed:

Operating area: The vehicle should stay within the areas of operation defined (Riding area).
Reasoning: It would be the city's decision if they want to enforce such a policy or allow scooters to ride out of the city. If they allow so, no policy is required. If they want to enforce a boundary around the city, the operating area policy defines the riding area (except for no riding zones within).
No parking: The vehicle should not be parked in one of these defined areas in the statuses Available, Reserved and Non-operational.
Reasoning: In the working group call there was a discussion over whether or not the word 'must' or 'should' should be used. I stand by 'should' as the user should still be able to end a trip outside of a parking bay, triggering a violation. Perhaps some cities might want to implement it so that vehicles cannot be locked unless in parking bays, but it seems like a rare decision made so far.

schnuerle · 2022-12-06T16:06:46Z

For each of the 8 examples, could you either 1) update the full JSON file examples that appear in this directory or 2) remove the link to the full file for each example and delete the JSON files in the directory?

cc @S-eb @jean-populus

marie-x · 2022-12-07T19:59:57Z

looks good to me (once @schnuerle's ask is addressed)

jyeo17 · 2022-12-08T17:49:02Z

Done @schnuerle @marie-x @jean-populus

schnuerle · 2022-12-15T13:08:48Z

Merging this to dev so we can consolidate all the work from task forces and other open PRs.

Update README.md

2c46606

New examples for Policy with agreed upon rule types - updated by Justin Yeo after discussion with Jean Kao

jyeo17 requested a review from a team as a code owner September 12, 2022 14:36

jyeo17 changed the title ~~Update README.md~~ Improve description field in Policy to require more human readable details Sep 12, 2022

Merge branch 'dev' into patch-1

97963d2

schnuerle added the Policy Specific to the Policy API label Oct 6, 2022

schnuerle linked an issue Oct 6, 2022 that may be closed by this pull request

Different rule types used for policies #764

Closed

schnuerle added this to the 2.0.0 milestone Oct 6, 2022

Update README.md

ee48b4b

schnuerle reviewed Oct 6, 2022

View reviewed changes

jyeo17 added 5 commits October 10, 2022 16:20

Update README.md

821bb49

Update README.md

9c2fd99

Update README.md

7159db2

Update README.md

9ade89a

Update README.md

d53412b

mrsimpson reviewed Oct 13, 2022

View reviewed changes

jyeo17 added 6 commits December 8, 2022 18:45

Update README.md

82f76bf

Delete idle-time.json

a58198e

Delete metered-parking-fees.json

d7d9c58

Delete per-trip-fees.json

74cc5bb

Delete prohibited-zone.json

0469aec

Delete provider-cap.json

152dfe7

jyeo17 added 6 commits December 8, 2022 18:47

Delete required-parking.json

7992459

Delete speed-limits.json

3bc4d5b

Delete tiered-parking-fees-per-hour-in-bounds.json

47ccfd0

Delete tiered-parking-fees-per-hour.json

1dab22a

Delete tiered-parking-fees-total.json

6ba539f

Delete vehicle-row-fees.json

fc255ef

Adding back in the JSON formatting

a4c251f

schnuerle merged commit 6a67471 into openmobilityfoundation:dev Dec 15, 2022

schnuerle mentioned this pull request Dec 19, 2022

Different rule types used for policies #764

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve description field in Policy to require more human readable details #786

Improve description field in Policy to require more human readable details #786

jyeo17 commented Sep 12, 2022 •

edited

Loading

CLAassistant commented Sep 12, 2022 •

edited

Loading

schnuerle commented Sep 13, 2022

jyeo17 commented Sep 13, 2022

schnuerle Oct 6, 2022

S-eb Oct 12, 2022 •

edited

Loading

schnuerle commented Oct 7, 2022 •

edited

Loading

S-eb commented Oct 12, 2022

jyeo17 commented Oct 12, 2022 •

edited

Loading

mrsimpson Oct 13, 2022

schnuerle Dec 6, 2022

jyeo17 commented Oct 26, 2022 •

edited

Loading

schnuerle commented Dec 6, 2022

marie-x commented Dec 7, 2022 •

edited

Loading

jyeo17 commented Dec 8, 2022

schnuerle commented Dec 15, 2022

Improve description field in Policy to require more human readable details #786

Improve description field in Policy to require more human readable details #786

Conversation

jyeo17 commented Sep 12, 2022 • edited Loading

MDS Pull Request

Explain pull request

Is this a breaking change

Impacted Spec

Additional context

CLAassistant commented Sep 12, 2022 • edited Loading

schnuerle commented Sep 13, 2022

jyeo17 commented Sep 13, 2022

schnuerle Oct 6, 2022

Choose a reason for hiding this comment

S-eb Oct 12, 2022 • edited Loading

Choose a reason for hiding this comment

schnuerle commented Oct 7, 2022 • edited Loading

S-eb commented Oct 12, 2022

jyeo17 commented Oct 12, 2022 • edited Loading

mrsimpson Oct 13, 2022

Choose a reason for hiding this comment

schnuerle Dec 6, 2022

Choose a reason for hiding this comment

jyeo17 commented Oct 26, 2022 • edited Loading

schnuerle commented Dec 6, 2022

marie-x commented Dec 7, 2022 • edited Loading

jyeo17 commented Dec 8, 2022

schnuerle commented Dec 15, 2022

jyeo17 commented Sep 12, 2022 •

edited

Loading

CLAassistant commented Sep 12, 2022 •

edited

Loading

S-eb Oct 12, 2022 •

edited

Loading

schnuerle commented Oct 7, 2022 •

edited

Loading

jyeo17 commented Oct 12, 2022 •

edited

Loading

jyeo17 commented Oct 26, 2022 •

edited

Loading

marie-x commented Dec 7, 2022 •

edited

Loading