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

Documentation for the API #87

Closed
crimsonknave opened this issue Jul 13, 2020 · 1 comment
Closed

Documentation for the API #87

crimsonknave opened this issue Jul 13, 2020 · 1 comment
Assignees
Labels
📚 documentation Request for documentation osctrl-api osctrl-api related changes
Milestone

Comments

@crimsonknave
Copy link

I would love to see some docs on API endpoints. At a minimum a list of the urls, a list of parameters and a summary of the responses would be great. Right now it's pretty difficult to try and use the api as I don't write go, so digging into the code for the api is 😬

@javuto javuto added this to the v0.2.4 milestone Jul 13, 2020
@javuto javuto self-assigned this Jul 13, 2020
@javuto javuto added 📚 documentation Request for documentation osctrl-api osctrl-api related changes labels Jul 13, 2020
@javuto
Copy link
Collaborator

javuto commented Nov 11, 2020

Here is the documentation for all the supported endpoints in osctrl-api with the types and the format expected. Let me know if you want something else added to the API!

https://app.swaggerhub.com/apis-docs/jmpsec/osctrl-api/0.2.3

@javuto javuto closed this as completed Nov 11, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 documentation Request for documentation osctrl-api osctrl-api related changes
Projects
None yet
Development

No branches or pull requests

2 participants