modoboa icon indicating copy to clipboard operation
modoboa copied to clipboard

API docs missing

Open faphdev opened this issue 3 years ago • 6 comments

Following the documentation to look at the API you get an error. I was not able to see API documentation of the API anywhere else other than the demo server which again is not there.

Thanks for fixing this!

faphdev avatar Jun 23 '22 17:06 faphdev

Hello, thanks for your report.

Please look at the edits in the following PR: https://github.com/modoboa/modoboa/pull/2538

The API was moved to another route in v2. But was not added to docs. The demo server has not enabled that API. Regular installations have.

https://yourdomain/api/schema-v2/swagger/

#Closed @tonioo

ksaadDE avatar Jun 27 '22 17:06 ksaadDE

Hmm, I would like to see the API documentation before installing. Forgive me if that is not a reasonable expectation.

faphdev avatar Jun 27 '22 17:06 faphdev

Hmm, I would like to see the API documentation before installing. Forgive me if that is not a reasonable expectation.

I fully agree to your point but I can't change that and if you see in the issues tab, @tonioo has a lot to do. Keep in mind this is a Open Source Project.

The installation takes a few minutes (max 5), do it in a local VM if you are not sure

If you have no further questions, I would say this can be closed.

Regards

ksaadDE avatar Jun 27 '22 22:06 ksaadDE

https://demo.modoboa.org/api/schema-v2/swagger/

esuk avatar Jul 20 '22 14:07 esuk

https://github.com/modoboa/modoboa/pull/2538

ksaadDE avatar Jul 25 '22 21:07 ksaadDE

i think my message in a other issue is more related here.

see: https://github.com/modoboa/modoboa/issues/2543#issuecomment-1253459860

cremesk avatar Sep 22 '22 09:09 cremesk

@tonioo regarding your comment about the /v2 route.

ksaadDE avatar Sep 28 '22 21:09 ksaadDE

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] avatar Nov 28 '22 05:11 stale[bot]