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.

Sign up for GitHub

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

Jump to bottom

Publish API documentation #11

Closed
Tracked by #7
msimerson opened this issue Feb 28, 2024 · 0 comments · Fixed by #3
Closed
Tracked by #7

Publish API documentation #11

msimerson opened this issue Feb 28, 2024 · 0 comments · Fixed by #3
Assignees
@msimerson
Milestone
3.0

Comments

@msimerson
Copy link
Contributor

msimerson commented Feb 28, 2024 •
edited
Loading

API documentation is generated in real time by the API by visiting the service at the /documentation/ url. Each of the HTTP routes inputs and outputs are tested and validated against the specifications published in NicTool/validate.

Examples of using the API via curl are in the README.
This was referenced Feb 28, 2024
Open
Merged
@msimerson msimerson moved this to In progress in NicTool v3 Feb 28, 2024
@msimerson msimerson added this to the 3.0 milestone Feb 28, 2024
@msimerson msimerson self-assigned this Feb 28, 2024
@msimerson msimerson mentioned this issue Feb 28, 2024
Merged
@msimerson msimerson moved this from In progress to Done in NicTool v3 Feb 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@msimerson msimerson

Labels
None yet
Projects
NicTool v3
Status: Done
Milestone
3.0
Development

Successfully merging a pull request may close this issue.

Sessions NicTool/api
1 participant
@msimerson