Extract Geography API from the Policy API #499

janedotx · 2020-05-16T01:40:40Z

Originally the Policy API included the Geography API, because Policy needed Geography objects.
As other proposed services (e.g. Jurisdiction API) are introduced, Geography really should be its own thing.

UPDATE

PR #499 is merged to a 'feature branch' in the MDS repo so we can see how it fits into the larger spec, allow the community and staff to do PRs against it, merge other related PRs into it, and see how it will fit into dev when it's ready with PR #582.

See the 'feature-geography' branch for details.

…oning.

…thor.

CLAassistant · 2020-05-16T01:40:46Z

All committers have signed the CLA.

…tion/release-1.0.0 Release 1.0.0 - Tech Council Review

add [ts] linkages

schnuerle · 2020-09-10T20:43:19Z

From the Working Group call today. Slides from today.

/geographies use cases. Is it needed?
- Caching - so providers and third parties can download it all at once.
- Searching - so you can see all geographies at once and how they relate before asking for details on the one you need from another API.
- Adding geoJSON fields would make it too unwieldy.
- Agreed for now it's useful and keep as is.
Previous Geographies
- this is written now so these never become 'inactive', they just may not be referenced any more.
- Warrants a new section that elaborates on the nuance and implementation here.
- Need to check on city capacity to implement this and update
  - noted that Geography is already in Policy, so if a city is implementing Policy, they can handle the new Geography endpoint.
  - complexity comes from the prev_geographies - could be hard to keep things up to date
  - WGSC and OMF can do some outreach to cities and Policy Webinar attendees to ask about challenges
  - third parties can alleviate these concerns. Eg, in Louisville one employee just managed existing GIS files and one spreadsheet, and Stae took care of translating and publishing to Policy API.
Type of Geography field
- Currently is meant to just be the definition of an area to be used elsewhere
- Use can always be found elsewhere in other APIs
- Use cases could be to pass in a variable and return just those on /geographies, find specific geographies like city boundaries or parking spots, Metrics to get relevant areas
- Discussion if it exists to make an enumerated list of value, or maybe some kind of tagging system, or freeform.
- For now leave it out, but could be added later if other endpoints need it
Public feed
- Could be made public (non-authenticated) since there is no sensitive info here
- Along with Policy, could be very useful for third party apps, new operators in a city
- Needs to be accurate and stay up to date

# Conflicts: # README.md

schnuerle · 2020-09-16T20:37:25Z

geography/README.md

+}
+```
+
+_Note: A simple tool to validate `geographies.json` will be contributed to the Open Mobility Foundation._


Should this note be included now? How close to being ready is this tool? It may take some time to contribute to a tool to the OMF.

We should discuss. I don't have a good answer. Perhaps it's trivial now that @thekaveman made a schema?

I think just cut it for now so we can get this into the feature branch in OMF. The schema helps, and I'm not sure what this simple tool would be otherwise.

schnuerle · 2020-09-16T20:39:39Z

geography/README.md

@@ -0,0 +1,150 @@
+# Mobility Data Specification: Geography
+
+This specification contains a collection of RESTful APIs used to read Geographies (descriptions of geographical information, e.g. multi-polygons, currently represented via GeoJSON).


Are geographies always single or multi polygons? They will never be a line or point right? Either way we should clarify this somewhere in the spec. For an example, #480 assumes only polygons.

FeatureCollection is the highest-level concept. You can include lines and points but they are no-ops because they can't contain points. We will revisit once we have a curb spec.

jschirrmacher · 2020-09-25T06:33:22Z

README.md

@@ -31,6 +31,8 @@ The Mobility Data Specification (**MDS**), a project of the [Open Mobility Found

 * The [`policy`][policy] API endpoints are intended to be implemented by regulatory agencies and consumed by mobility providers. Providers query the Policy API to get information about local rules that may affect the operation of their mobility service or which may be used to determine compliance. It was first released in October 2019. Development takes place under the guidance of the OMF's City Services Working Group.

+* The [`geography`][geography] API endpoints are intended to be implemented by regulatory agencies and consumed by mobility providers. Providers query the Policy API to get information about geographical regions for regulatory and other purposes. It was first released in October 2019, originally included as part of the Policy specification. Development takes place under the guidance of the OMF's City Services Working Group.


With the new endpoint, the title line should now be "MDS is currently comprised of four distinct components"

Yes. Good catch. Fixed.

schnuerle · 2020-09-29T16:58:56Z

Merging this to the feature branch so we can look at it holistically, make edits and suggestions, and incorporate other related issues/PRs before we agree on the spec and merge to dev.

schnuerle · 2020-09-30T14:00:38Z

PR #499 is merged to a 'feature branch' in the MDS repo so we can see how it fits into the larger spec, allow the community and staff to do PRs against it, merge other related PRs into it, and see how it will fit into dev when it's ready with PR #582.

See the 'feature-geography' branch for details.

janedotx added 6 commits March 12, 2020 00:42

Adding read-only geography service.

b7f0076

Adding minor note for expected response body and content header versi…

c333f83

…oning.

More explicit examples of response bodies.

d353c1d

Removing metadata references, since they can go into the Geography Au…

cef968b

…thor.

Describing publishing.

bf8bd5c

minor fixes

aaae630

janedotx requested a review from a team as a code owner May 16, 2020 01:40

thekaveman changed the base branch from master to dev May 21, 2020 23:23

heatherbuletti mentioned this pull request Jun 11, 2020

Provider/Agency reconciliation #506

Merged

schnuerle mentioned this pull request Jun 26, 2020

Policy: UUID specification for Geographies is unspecified #433

Closed

Merge pull request openmobilityfoundation#562 from openmobilityfounda…

902d848

…tion/release-1.0.0 Release 1.0.0 - Tech Council Review

marie-x changed the title ~~Add geography service~~ Extract Geography API from the Policy API Aug 13, 2020

schnuerle linked an issue Aug 26, 2020 that may be closed by this pull request

Extract Geography API from Policy API #500

Closed

marie-x added 2 commits September 2, 2020 21:53

Merge branch 'dev' into add_geography_service

27867cf

cleanup on aisle 3

1ea50c4

janedotx requested a review from a team September 3, 2020 05:14

marie-x added 5 commits September 2, 2020 22:14

nit

8703469

spec updates per feedback

17c43ab

first cut on verbiage for Geography

e6b1c13

fix more required/optional

74338f0

add [ts] linkages

formatting and omission

855cd2d

schnuerle changed the base branch from dev to feature-geography September 10, 2020 20:54

Merge branch 'dev' into add_geography_service

a96d210

# Conflicts: # README.md

schnuerle reviewed Sep 16, 2020

View reviewed changes

well, eventually ....

7f8eb49

schnuerle added this to the 1.1.0 milestone Sep 22, 2020

jschirrmacher reviewed Sep 25, 2020

View reviewed changes

s/three/four/

0e19ea4

schnuerle merged commit 3cfe0cc into openmobilityfoundation:feature-geography Sep 29, 2020

This was referenced Sep 30, 2020

Geography - Feature Branch #582

Merged

Extract Geography API from Policy API #500

Closed

thekaveman mentioned this pull request Oct 28, 2021

1.2.0 schemas: geography #718

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Extract Geography API from the Policy API #499

Extract Geography API from the Policy API #499

janedotx commented May 16, 2020 •

edited by schnuerle

Loading

CLAassistant commented May 16, 2020 •

edited

Loading

schnuerle commented Sep 10, 2020 •

edited

Loading

schnuerle Sep 16, 2020

marie-x Sep 17, 2020

schnuerle Sep 17, 2020

schnuerle Sep 16, 2020

marie-x Sep 17, 2020

jschirrmacher Sep 25, 2020

marie-x Sep 25, 2020 •

edited

Loading

schnuerle commented Sep 29, 2020

schnuerle commented Sep 30, 2020

		@@ -0,0 +1,150 @@
		# Mobility Data Specification: Geography

		This specification contains a collection of RESTful APIs used to read Geographies (descriptions of geographical information, e.g. multi-polygons, currently represented via GeoJSON).

		@@ -31,6 +31,8 @@ The Mobility Data Specification (MDS), a project of the [Open Mobility Found

		* The [`policy`][policy] API endpoints are intended to be implemented by regulatory agencies and consumed by mobility providers. Providers query the Policy API to get information about local rules that may affect the operation of their mobility service or which may be used to determine compliance. It was first released in October 2019. Development takes place under the guidance of the OMF's City Services Working Group.

		* The [`geography`][geography] API endpoints are intended to be implemented by regulatory agencies and consumed by mobility providers. Providers query the Policy API to get information about geographical regions for regulatory and other purposes. It was first released in October 2019, originally included as part of the Policy specification. Development takes place under the guidance of the OMF's City Services Working Group.

Extract Geography API from the Policy API #499

Extract Geography API from the Policy API #499

Conversation

janedotx commented May 16, 2020 • edited by schnuerle Loading

UPDATE

CLAassistant commented May 16, 2020 • edited Loading

schnuerle commented Sep 10, 2020 • edited Loading

schnuerle Sep 16, 2020

Choose a reason for hiding this comment

marie-x Sep 17, 2020

Choose a reason for hiding this comment

schnuerle Sep 17, 2020

Choose a reason for hiding this comment

schnuerle Sep 16, 2020

Choose a reason for hiding this comment

marie-x Sep 17, 2020

Choose a reason for hiding this comment

jschirrmacher Sep 25, 2020

Choose a reason for hiding this comment

marie-x Sep 25, 2020 • edited Loading

Choose a reason for hiding this comment

schnuerle commented Sep 29, 2020

schnuerle commented Sep 30, 2020

janedotx commented May 16, 2020 •

edited by schnuerle

Loading

CLAassistant commented May 16, 2020 •

edited

Loading

schnuerle commented Sep 10, 2020 •

edited

Loading

marie-x Sep 25, 2020 •

edited

Loading