-
Notifications
You must be signed in to change notification settings - Fork 11
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
Open api docs #61
Open api docs #61
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pretty cool, don't mind my comments too much, just stuff that caught my eye when reading through and we can always get back to this at a later stage.
@@ -11,8 +11,21 @@ use unleash_yggdrasil::{Context, EngineState}; | |||
|
|||
use crate::types::{EdgeJsonResult, EdgeSource, EdgeToken}; | |||
|
|||
/// |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Extra line perhaps?
/// |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, but we should add a proper comment here, it will be parsed and added to the description of the call.
Co-authored-by: Nuno Góis <github@nunogois.com>
Co-authored-by: Nuno Góis <github@nunogois.com>
Co-authored-by: Nuno Góis <github@nunogois.com>
Co-authored-by: Nuno Góis <github@nunogois.com>
Co-authored-by: Nuno Góis <github@nunogois.com>
What happens here
This PR adds OpenAPI documentation for all client facing endpoints.
It does not complete description tasks and probably needs some more details in the doc for the endpoints.