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

OpenAPI spec implementation #4732

Open
1 task
jbrown-xentity opened this issue May 6, 2024 · 0 comments
Open
1 task

OpenAPI spec implementation #4732

jbrown-xentity opened this issue May 6, 2024 · 0 comments
Labels
H2.0/Flask Admin app for harvest source & organizations

Comments

@jbrown-xentity
Copy link
Contributor

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.

@jbrown-xentity jbrown-xentity added the H2.0/Flask Admin app for harvest source & organizations label May 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
H2.0/Flask Admin app for harvest source & organizations
Projects
Status: H2.0 Backlog
Development

No branches or pull requests

1 participant