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

API Doc using Swagger #23

Closed
gregsymons opened this issue Sep 27, 2016 · 2 comments
Closed

API Doc using Swagger #23

gregsymons opened this issue Sep 27, 2016 · 2 comments
Assignees
@stripthis
Labels
enhancement help wanted

Comments

@gregsymons
Copy link

I can't seem to find any API documentation other than the code itself (which given my unfamiliarity with cake, doesn't really jump out at me:). Am I missing something?
@stripthis
Copy link
Member

Hi Greg,

We started working on documenting the API with Swagger. So if you navigate to https://yourdomain/api/swagger.json you'll see that the models are "done". We still need to go through the controllers, and then we'll be able to generate live docs like http://petstore.swagger.io/ . Bear with us, we'll get it done in some time!

Cheers,

ref. PASSBOLT-1561

@stripthis stripthis self-assigned this Sep 28, 2016
@stripthis stripthis changed the title API Docs? API Doc using Swagger Sep 28, 2016
@stripthis
Copy link
Member

Moved to: https://community.passbolt.com/t/as-a-developper-i-can-browse-the-api-documentation/75

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@stripthis stripthis

Labels
enhancement help wanted
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@stripthis @gregsymons