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

Roll Swagger for API documentation #133

Closed
jaredbriskman opened this issue Apr 12, 2018 · 2 comments
Closed

Roll Swagger for API documentation #133

jaredbriskman opened this issue Apr 12, 2018 · 2 comments
Assignees
Labels
api Issues that affect the ABE API clients
Projects

Comments

@jaredbriskman
Copy link
Contributor

No description provided.

@jaredbriskman jaredbriskman created this issue from a note in Roadmap (Sprint Backlog) Apr 12, 2018
@jaredbriskman jaredbriskman self-assigned this Apr 12, 2018
@newsch newsch added this to the Pre-Launch Sprint 1 milestone Apr 13, 2018
@osteele osteele added the api Issues that affect the ABE API clients label Apr 23, 2018
@jaredbriskman
Copy link
Contributor Author

This is now in place with 1b1d65f. It could certainly use a little more TLC, specifically more descriptions and good example values, but it seems quite serviceable now.

Open questions include whether this should be enabled in prod, and what the version scheme of the API should be, like in #142. Currently, the version is specified as 0.1.

Also, moving the API resources to separate namespaces seems to have broken most of the travis tests, need to investigate more. It looks like the flask self.get is 404ing on endpoints which work when actually deployed.

Besides that, ready to open a PR, I think.

@jaredbriskman jaredbriskman moved this from Sprint Backlog to Doing in Roadmap Apr 25, 2018
@jaredbriskman
Copy link
Contributor Author

Turns out tests were broken due to case sensitive URL mismatch, fixed in 7335ca6.

Upon further inspection of the flask-restplus framework, it looks like we can't easily use the resource models to serialize to mongo, meaning this creates near duplication of document models and resource models. The resulting interactive documentation is quite excellent though.

Roadmap automation moved this from Doing to Done Apr 26, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api Issues that affect the ABE API clients
Projects
Roadmap
  
Done
Development

No branches or pull requests

3 participants