Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Policy: UUID specification for Geographies is unspecified #433

Closed
ascherkus opened this issue Jan 24, 2020 · 6 comments · Fixed by #533
Closed

Policy: UUID specification for Geographies is unspecified #433

ascherkus opened this issue Jan 24, 2020 · 6 comments · Fixed by #533
Assignees
Labels
enhancement New feature or request Policy Specific to the Policy API
Milestone

Comments

@ascherkus
Copy link

Describe the bug
Neither the README.md nor the examples.md contains a specification / example of how / where to specify the UUID for a GeoJSON feature.

For example, in the Flat Files example the policy objects in policies.json reference UUIDs that should be contained in geographies.json, but there is no description nor example of where that UUID is stored (at least that I could find!).

To Reproduce
Steps to reproduce the behavior: N/A

Expected behavior
A specification with an example of geographies associated with policies should be present for the specification to be easily implementable by others.

If I totally missed where this is specified (a possibility I'm willing to admit) - then I'm happy to take a crack adding some appropriate links / references.

Additional context
Came across this while prototyping a tool for #423.

@avatarneil
Copy link
Contributor

@ascherkus I'm pretty sure you didn't miss anything -- it looks like there's not actually a definition of the structure of Geography in the spec. The reason we didn't initially include this in the Policy PR is because we intend to have the Geography type used elsewhere in the future, and wanted it to be a shared type between multiple services (e.g Agency, Policy, whatever is coming next). For now, I think it makes sense to add it to the Policy spec, as well as an example or two. The rough structure to get you started is: { geography_id: UUID, geography_json: GeoJson<FeatureCollection> }. We'll cut a PR to resolve this, thanks for pointing it out!

@sarob sarob added enhancement New feature or request Policy Specific to the Policy API labels Jan 27, 2020
@sarob sarob added this to the Future milestone Feb 1, 2020
@jfh01 jfh01 modified the milestones: Future, 1.0.0 Apr 9, 2020
@marie-x marie-x self-assigned this Apr 16, 2020
@schnuerle
Copy link
Member

@Karcass since you assigned this to yourself, how do you think this can be addressed for 1.0.0?

@janedotx
Copy link
Contributor

janedotx commented Jun 26, 2020

@ascherkus @schnuerle The schema outlined in the Geography PR does include the uuid: https://github.com/openmobilityfoundation/mobility-data-specification/pull/499/files

So I think merging that in should cover the problem in 1.0.0.

@schnuerle
Copy link
Member

PR #499 is not scheduled for this 1.0.0 release so if we want it sooner, it would have to be done in a smaller PR now.

@janedotx
Copy link
Contributor

@schnuerle Ok, I can cut a PR to flesh out the schema in Policy and we can merge it in

@schnuerle schnuerle linked a pull request Jun 26, 2020 that will close this issue
@schnuerle
Copy link
Member

Resolved with #533 thank you @janedotx for the quick work! Larger solution in #499 coming later.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request Policy Specific to the Policy API
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants