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

[WIP] Cleaned Up Policy API #382

Merged
merged 35 commits into from
Oct 31, 2019
Merged

[WIP] Cleaned Up Policy API #382

merged 35 commits into from
Oct 31, 2019

Conversation

hunterowens
Copy link
Collaborator

@hunterowens hunterowens commented Oct 16, 2019

Explain pull request

Since the #322 has changed so much, here is a new working PR with a number of edits on my account.

Before merge, still needs to fix

  • Fix JSON Schema Generation
  • Remove agency / service areas code.

Is this a breaking change

  • Yes, breaking

Additional context

If I haven't addressed your question about #322, please LMK

Mark Maxham and others added 28 commits May 20, 2019 10:59
* 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 hunterowens requested review from thekaveman and a team as code owners October 16, 2019 22:43
@hunterowens
Copy link
Collaborator Author

pinging @antrim

@hunterowens hunterowens added this to the 0.4.0 milestone Oct 16, 2019
@avatarneil
Copy link
Contributor

I think that the changes needed for schema generation should be pretty simple, because for Policy we're using a tool that directly generates the schemas from type definitions in mds-core. All we should need to do is move the schemas from the Policy spec folder to a templates/policy folder, and then update the python schema generator to basically just copy-paste them into the Policy spec folder.

@hunterowens
Copy link
Collaborator Author

@avatarneil

all JSON Schemas need to be generated by running the script in generate_schemas.py, this is how we ensure consistency in common datatypes.

In the interest of getting this merged, I'd like the JSON schemas to follow in 0.4.1, I've removed them from the Spec in this PR and create a new issue for that.

* remove all references to 'under development', 'alpha', 'feedback requested', etc.
* streamline, combine, and re-order content under relevant subsections
* normalize payload wrapper format with Provider
* normalize endpoint specification format with Provider
* additional clarity on some data types
Copy link
Collaborator

@thekaveman thekaveman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made a few cleanups of the language and overall content structure, and did my best not to change any of the intent or data structure. A summary of my edits:

  • remove all references to 'under development', 'alpha', 'feedback requested', etc.
  • streamline, combine, and re-order content under relevant subsections
  • normalize payload wrapper format with Provider
  • normalize endpoint specification format with Provider
  • additional clarity on some data types

@marie-x
Copy link
Collaborator

marie-x commented Oct 31, 2019

Looks great @thekaveman, thanks for those improvements!

@hunterowens hunterowens merged commit 7973b6d into dev Oct 31, 2019
"geographies": [
"12b3fcf5-22af-4b0d-a169-ac7ac903d3b9"
],
"statuses": [
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"statuses": [
"statuses": {
"unavailable": [],
"trip": []
},

@thekaveman thekaveman deleted the hunter-policy-api branch February 13, 2020 17:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants