Add policy author spec #3
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
avatarneil
previously requested changes
Apr 23, 2020
.gitignore
Outdated
| .venv/ | ||
| *.swp |
There was a problem hiding this comment.
Shouldn't be modifying the .gitignore
policy-author/README.md
Outdated
| Parameters: | ||
| | Name | Type | R/O | Description | | ||
| | ------------ | --------- | --- | ---------------------------------------------- | | ||
| | `id` | UUID | Optional | If provided, returns one policy object with the matching UUID; default is to return all policy objects. | |
There was a problem hiding this comment.
This seems wrong, it should definitely be a policy_id parameter (which is what it is in the reference impl)
policy-author/README.md
Outdated
|
|
||
| Payload: a new Policy object, without a `policy_id` | ||
|
|
||
| ; a failure explanation on failure |
policy-author/README.md
Outdated
| - 401 - Unauthorized (if any auth issue) | ||
| - 500 - Server error (hopefully doesn’t happen) | ||
|
|
||
| ### PUT /policies/{id} |
policy-author/README.md
Outdated
| - 409 - conflict (if immutable) | ||
| - 500 - server error | ||
|
|
||
| ### POST /policies/{id}/publish |
policy-author/README.md
Outdated
| - 500 - server error | ||
|
|
||
|
|
||
| ### GET /policies/{id}/meta |
policy-author/README.md
Outdated
| - 500 - server error | ||
|
|
||
|
|
||
| ### PUT /policies/{id}/meta |
policy/README.md
Outdated
| @@ -22,6 +22,12 @@ The goal of this specification is to enable Agencies to create, revise, and publ | |||
|
|
|||
| The machine-readable format allows Providers to obtain policies and compute compliance where it can be determined entirely by data obtained internally. | |||
|
|
|||
| Policies will typically be linked to one or more associated geographies. Geography descriptions (e.g. geofences or lists of street segments) must also be maintained by the Agency indefinitely. Policies without specific geographies (global policies) are assumed to apply to the entire service area managed by the Agency. | |||
There was a problem hiding this comment.
Shouldn't mention service areas, no longer a thing. Perhaps better to say something like "assumed to apply to all jurisdictions managed by the Agency".
policy/README.md
Outdated
| @@ -22,6 +22,12 @@ The goal of this specification is to enable Agencies to create, revise, and publ | |||
|
|
|||
| The machine-readable format allows Providers to obtain policies and compute compliance where it can be determined entirely by data obtained internally. | |||
|
|
|||
| Policies will typically be linked to one or more associated geographies. Geography descriptions (e.g. geofences or lists of street segments) must also be maintained by the Agency indefinitely. Policies without specific geographies (global policies) are assumed to apply to the entire service area managed by the Agency. | |||
|
|
|||
| Geographical data will be stored as immutable GeoJSON, referenced by UUID. See the Geography and Geography Author specs for information on the Geography schema, and how Agencies are expected to create and maintain Geographies and serve them to Providers. In a future revision of Agency, we will deprecate the existing `/service_areas` endpoint. `/service_areas` currently only handles GeoJSON MultiPolygon and Polygon objects, and Policy documents might prefer Points for locations such as drop-zones. Policy may be used for a variety of enforcement actions, so it's important for the Agency to persist and keep immutable both Policy and Geography data. | |||
There was a problem hiding this comment.
GeoJSON FeatureCollection instead of just GeoJSON.
/service_areas has already been deprecated.
|
Sidebar to note -- even after these are approved you shouldn't merge to dev, we want to keep them as isolated branches to cut distinct PRs into OMF |
avatarneil
reviewed
May 14, 2020
| Response codes: | ||
|
|
||
| - 201 - Created. Returns: the Policy object on success, including a `policy_id` and a `version` indicating the current API version. | ||
| - 400 - Policy does not conform to schema |
There was a problem hiding this comment.
We can also send a 409 upon a conflict
There was a problem hiding this comment.
Which I suppose doesn't make sense considering we auto-fill a policy_id, I'll remove that error handling
avatarneil
reviewed
May 14, 2020
| - 500 - server error | ||
|
|
||
|
|
||
| ### GET /policies/{policy_id}/meta |
There was a problem hiding this comment.
Should also have a 400 bad params error
avatarneil
reviewed
May 14, 2020
| - 200 - success | ||
| - 401 - unauthorized | ||
| - 404 - not found | ||
| - 409 - conflict (if already published) |
There was a problem hiding this comment.
Should add 424 for a missing dependency
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Explain pull request
This adds the Policy Author spec and removes the Geography related stuff in Policy, which is necessary now that Geographies will be covered in their own specs.
Is this a breaking change
None of the changes to Policy made here should affect any current implementations.