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

Open api docs #61

Merged
merged 12 commits into from
Feb 14, 2023
Merged

Open api docs #61

merged 12 commits into from
Feb 14, 2023

Conversation

chriswk
Copy link
Member

@chriswk chriswk commented Feb 13, 2023

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.

Copy link
Member

@nunogois nunogois left a 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.

server/src/client_api.rs Outdated Show resolved Hide resolved
@@ -11,8 +11,21 @@ use unleash_yggdrasil::{Context, EngineState};

use crate::types::{EdgeJsonResult, EdgeSource, EdgeToken};

///
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Extra line perhaps?

Suggested change
///

Copy link
Member Author

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.

server/src/frontend_api.rs Outdated Show resolved Hide resolved
server/src/frontend_api.rs Outdated Show resolved Hide resolved
server/src/frontend_api.rs Outdated Show resolved Hide resolved
server/src/frontend_api.rs Outdated Show resolved Hide resolved
Christopher Kolstad and others added 5 commits February 14, 2023 08:28
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>
@chriswk chriswk merged commit 49d7129 into main Feb 14, 2023
@chriswk chriswk deleted the openApiDocs branch February 14, 2023 07:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants