Add Compliance API draft #333

marie-x · 2019-06-29T03:01:28Z

Explain pull request

This API describes a Compliance service that takes as inputs Events and Telemetry (received via Agency) and measures against Policy and Geography documents to produce a measurement of policy compliance or non-compliance.

Is this a breaking change

A breaking change would require consumers or implementors of the API to modify their code for it to continue to function (ex: renaming of a required field or the change in data type of an existing field). A non-breaking change would allow existing code to continue to function (ex: addition of an optional field or the creation of a new optional endpoint).

No, not breaking

`Provider` or `Agency`

Which API(s) will this pull request impact:

neither

Additional context

This is a branch off of the Policy PR, so that file is also included. That PR is a prerequisite.

Incorporate Blue feedback

last minute trims

…ion into dev # Conflicts: # policy/README.md

marie-x · 2019-06-29T03:07:47Z

Feedback solicited. I've got a couple of additional explanatory diagrams in the works. This doc is a little thin on verbiage, so please ask for clarification where you think it's needed.

A prototype of this service is currently running in LA, and is part of the code-drop in CityOfLosAngeles/mds-core.

* Add optional event_type specification to rule statuses * Add JSONSchema Draft 7 for Geography and Policy endpoints/types.

Update markdown so it renders a table properly

hunterowens · 2019-10-11T17:21:43Z

moving milestone.

bors-ltd · 2019-10-15T08:30:34Z

compliance/README.md

+| Name          | Type | R/O | Description                   |
+| ------------- | ---- | --- | ----------------------------- |
+| `provider_id` | UUID | O   | If not provided in the JWT.   |
+| `end_date`    | UUID | O   | Take snapshot at a given time |


Hi, I guess the UUID type is a typo, and it's a timestamp in milliseconds as usual.

It was indeed -- the spec has been updated.

CLAassistant · 2019-11-06T22:10:36Z

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
2 out of 3 committers have signed the CLA.

✅ karcass
✅ avatarneil
❌ evansiroky
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

jfh01 · 2020-04-09T18:29:04Z

Should we consider for the 1.0.0 release?

…apshot response, tweak formatting

schnuerle · 2020-06-08T17:20:18Z

Hello @evansiroky can please you sign the OMF CLA for this commit you made in this PR?

marie-x · 2020-08-13T18:19:20Z

This is going to get re-written based on what we've learned in LA from the micro-mobility pilot.

schnuerle · 2021-01-15T21:43:16Z

See the notes from the last WG call.

Only for one provider
Allows enforcement by device id
Some metrics could be compliance metrics
Be "Metrics sensitive" now that Metrics exists as it is rebuilt and submitted in a new PR
In use in LA but good time for feedback
Vianova has a compliance API - providers use it now to see what’s out of compliance
Louisville and Baltimore would like realtime notifications this could provide
Bill Dirk ride report thinks it could be needed
Seems useful for next release

Realize this PR is closed but wanted to capture this year for the new re-written version.

Mark Maxham and others added 23 commits May 20, 2019 10:59

add policy draft

dda6bd9

Incorporate Blue feedback

cc4b336

typo

76b9e49

units

78d7f20

Fix policy examples to match spec, and add street parking example

c819d97

Merge pull request #1 from ellis-assoc/max/blue-feedback

cbff8af

Incorporate Blue feedback

last minute trims

62560f4

Merge pull request #4 from ellis-assoc/max/example-nits

ed63d62

last minute trims

add policy draft

b476adf

WIP

eda6354

WIP

0f29a2b

cleaned up some formatting

28005ff

Added provider_id to ViolationVehicle and rule_id to Rule

a8f1728

Merge branch 'dev' of github.com:ellis-assoc/mobility-data-specificat…

bc0f4e1

…ion into dev # Conflicts: # policy/README.md

Added rule_id field to Rule schema.

7094931

compliance readme WIP

2f3b5f6

some renames, wording

4ed65e2

Formatting, additional snapshot endpoint, moved geography_id to matches

a774788

Updated examples

3fe93fe

convert to spaces. word nits.

f6ea716

consistency with Policy README

48de0c1

Sean feedback

e46ddd3

wording nits

546a56c

marie-x requested review from hunterowens, thekaveman and a team as code owners June 29, 2019 03:01

marie-x changed the title ~~Add Compliance~~ Add Compliance API draft Jun 29, 2019

Mark Maxham added 2 commits July 8, 2019 16:10

add /count

bba4d13

Merge branch 'dev' into neil/compliance-draft

368fee7

avatarneil and others added 9 commits July 15, 2019 16:40

Add optional event_type specification to rule statuses (#10)

bd9bab8

* Add optional event_type specification to rule statuses * Add JSONSchema Draft 7 for Geography and Policy endpoints/types.

Update markdown so it renders a table properly

1de4d5d

Merge pull request #13 from evansiroky/patch-1

3dc7260

Update markdown so it renders a table properly

Update examples and add published_date field to Policy

6fb3efb

Remove excessive reporting from compliance output

9867aca

Merge branch 'dev' into neil/compliance-draft

7f1f339

Update count violation example, remove time violation example (for now)

eae3090

Parameter cleanup, addition of end_date to query historical compliance

a46bee3

Update type to include of first matched violation.

8118673

hunterowens added this to the Future milestone Oct 11, 2019

bors-ltd reviewed Oct 15, 2019

View reviewed changes

sarob added the enhancement New feature or request label Dec 19, 2019

jfh01 modified the milestones: Future, 1.0.0 Apr 9, 2020

Retzoh mentioned this pull request May 4, 2020

Complilance API #489

Closed

Move vehicle_in_violation and total_violations from rule output to sn…

0c45da0

…apshot response, tweak formatting

marie-x requested a review from a team May 8, 2020 14:09

marie-x requested a review from a team as a code owner May 8, 2020 14:09

Fix end_date typo (a type typo)

40f220c

schnuerle modified the milestones: 1.0.0, 1.1.0 Jun 11, 2020

marie-x closed this Aug 13, 2020

schnuerle removed this from the 1.1.0 milestone Sep 1, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Compliance API draft #333

Add Compliance API draft #333

marie-x commented Jun 29, 2019 •

edited

Loading

marie-x commented Jun 29, 2019

hunterowens commented Oct 11, 2019

bors-ltd Oct 15, 2019

avatarneil May 8, 2020

CLAassistant commented Nov 6, 2019 •

edited

Loading

jfh01 commented Apr 9, 2020

schnuerle commented Jun 8, 2020

marie-x commented Aug 13, 2020

schnuerle commented Jan 15, 2021

Add Compliance API draft #333

Add Compliance API draft #333

Conversation

marie-x commented Jun 29, 2019 • edited Loading

Explain pull request

Is this a breaking change

Provider or Agency

Additional context

marie-x commented Jun 29, 2019

hunterowens commented Oct 11, 2019

bors-ltd Oct 15, 2019

Choose a reason for hiding this comment

avatarneil May 8, 2020

Choose a reason for hiding this comment

CLAassistant commented Nov 6, 2019 • edited Loading

jfh01 commented Apr 9, 2020

schnuerle commented Jun 8, 2020

marie-x commented Aug 13, 2020

schnuerle commented Jan 15, 2021

marie-x commented Jun 29, 2019 •

edited

Loading

`Provider` or `Agency`

CLAassistant commented Nov 6, 2019 •

edited

Loading