Open jbrown-xentity opened 1 month ago
In order to have a well documented API, data.gov admins want an OpenAPI spec document describing the Flask API for harvesting.
[ACs should be clearly demoable/verifiable whenever possible. Try specifying them using BDD.]
Some of our routes are already defined, but the code should be the final decider of what is implemented (and use tests where possible). https://docs.google.com/document/d/1XQFmHDtpCEPwM1JsvgOmeKKmxcUwr7EvP4EWowWnq6U/edit#bookmark=id.s20mfruog1ta
None
There are many tools to create and manage this spec file. I would start with the generators, but feel free to explore further.
User Story
In order to have a well documented API, data.gov admins want an OpenAPI spec document describing the Flask API for harvesting.
Acceptance Criteria
[ACs should be clearly demoable/verifiable whenever possible. Try specifying them using BDD.]
Background
Some of our routes are already defined, but the code should be the final decider of what is implemented (and use tests where possible). https://docs.google.com/document/d/1XQFmHDtpCEPwM1JsvgOmeKKmxcUwr7EvP4EWowWnq6U/edit#bookmark=id.s20mfruog1ta
Security Considerations (required)
None
Sketch
There are many tools to create and manage this spec file. I would start with the generators, but feel free to explore further.