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

Draft a formal api spec (Swagger spec) #225

Closed
0xdade opened this issue Nov 7, 2019 · 0 comments · Fixed by #241
Closed

Draft a formal api spec (Swagger spec) #225

0xdade opened this issue Nov 7, 2019 · 0 comments · Fixed by #241
Labels
documentation Issues involving not enough or incorrect documentation enhancement New feature or request server affecting natlas-server

Comments

@0xdade
Copy link
Member

0xdade commented Nov 7, 2019

Is your feature request related to a problem?
The API is a mess right now. Who knows what goes in! Who knows what comes out! I wrote it and I don't even know all the code paths.

Describe the feature you'd like
Use a swagger spec to define the behavior of the API and then adhere to that swagger spec.

Have you considered alternative ways to get this feature
I originally started writing a wiki page on the topic, but that was kind of silly as a swagger spec is literally meant for this.

Additional context
This is part of building a stronger focus on engineering excellence. The act of creating the spec itself doesn't introduce immediate functional value, but it provides a lot of value to building and maintaining the API.

@0xdade 0xdade added enhancement New feature or request server affecting natlas-server documentation Issues involving not enough or incorrect documentation labels Nov 7, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues involving not enough or incorrect documentation enhancement New feature or request server affecting natlas-server
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant