starred/modoboa-modoboa
1
0
Fork 0
mirror of https://github.com/modoboa/modoboa.git synced 2026-04-25 17:06:01 +03:00
Code Issues 60 Projects Releases 10 Packages Wiki Activity

[GH-ISSUE #2548] API docs missing #1629

New issue
Closed
opened 2026-02-27 11:18:12 +03:00 by kerem · 8 comments
kerem commented 2026-02-27 11:18:12 +03:00
Owner
Copy link

Originally created by @faphdev on GitHub (Jun 23, 2022).
Original GitHub issue: https://github.com/modoboa/modoboa/issues/2548

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!

Originally created by @faphdev on GitHub (Jun 23, 2022). Original GitHub issue: https://github.com/modoboa/modoboa/issues/2548 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!
kerem 2026-02-27 11:18:12 +03:00
  • closed this issue
  • added the
    stale
         label
kerem commented 2026-02-27 11:18:13 +03:00
Author
Owner
Copy link

@ksaadDE commented on GitHub (Jun 27, 2022):

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

<!-- gh-comment-id:1167656098 --> @ksaadDE commented on GitHub (Jun 27, 2022): 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
kerem commented 2026-02-27 11:18:13 +03:00
Author
Owner
Copy link

@faphdev commented on GitHub (Jun 27, 2022):

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

<!-- gh-comment-id:1167681799 --> @faphdev commented on GitHub (Jun 27, 2022): Hmm, I would like to see the API documentation before installing. Forgive me if that is not a reasonable expectation.
kerem commented 2026-02-27 11:18:13 +03:00
Author
Owner
Copy link

@ksaadDE commented on GitHub (Jun 27, 2022):

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

<!-- gh-comment-id:1167962036 --> @ksaadDE commented on GitHub (Jun 27, 2022): > 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
kerem commented 2026-02-27 11:18:13 +03:00
Author
Owner
Copy link

@mattias-twedmark2 commented on GitHub (Jul 20, 2022):

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

<!-- gh-comment-id:1190337310 --> @mattias-twedmark2 commented on GitHub (Jul 20, 2022): https://demo.modoboa.org/api/schema-v2/swagger/
kerem commented 2026-02-27 11:18:13 +03:00
Author
Owner
Copy link

@ksaadDE commented on GitHub (Jul 25, 2022):

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

<!-- gh-comment-id:1194628864 --> @ksaadDE commented on GitHub (Jul 25, 2022): https://github.com/modoboa/modoboa/pull/2538
kerem commented 2026-02-27 11:18:13 +03:00
Author
Owner
Copy link

@cremesk commented on GitHub (Sep 22, 2022):

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

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

<!-- gh-comment-id:1254742767 --> @cremesk commented on GitHub (Sep 22, 2022): i think my message in a other issue is more related here. see: https://github.com/modoboa/modoboa/issues/2543#issuecomment-1253459860
kerem commented 2026-02-27 11:18:13 +03:00
Author
Owner
Copy link

@ksaadDE commented on GitHub (Sep 28, 2022):

@tonioo regarding your comment about the /v2 route.

<!-- gh-comment-id:1261476687 --> @ksaadDE commented on GitHub (Sep 28, 2022): @tonioo regarding your comment about the /v2 route.
kerem commented 2026-02-27 11:18:13 +03:00
Author
Owner
Copy link

@stale[bot] commented on GitHub (Nov 28, 2022):

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.

<!-- gh-comment-id:1328567139 --> @stale[bot] commented on GitHub (Nov 28, 2022): 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.
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
master
fix/sievefilters-allow-email-in-rule-name
dependabot/npm_and_yarn/frontend/axios-1.15.0
translations_04c0b653215cb5fa48ab101eae1a1917_ja_JP
translations_5d93982e9fd6dab991db4faf93ce9ded_ja_JP
fix/login-issue-3995
fix/sievefilters-issues
add-vitepress-openapi
2974-dmarc-empty-email
2.3.x
updated-doc-2.3.0
feature/OIDC
delete-all-alarms
translations_modoboa-admin-locale-en-lc-messages-djangojs-po--master_af_ZA
translations_modoboa-admin-locale-en-lc-messages-djangojs-po--master_ar
translations_modoboa-admin-locale-en-lc-messages-djangojs-po--master_ca
1.x
translations_modoboa-admin-locale-en-lc-messages-djangojs-po--master_sk
translations_modoboa-admin-locale-en-lc-messages-djangojs-po--master_tr
translations_modoboa-admin-locale-en-lc-messages-djangojs-po--master_es_ES
translations_modoboa-admin-locale-en-lc-messages-djangojs-po--master_uk
translations_modoboa-admin-locale-en-lc-messages-djangojs-po--master_zh_CN
translations_modoboa-admin-locale-en-lc-messages-djangojs-po--master_de_DE
translations_modoboa-admin-locale-en-lc-messages-djangojs-po--master_da_DK
1.8.x
1.7.x
1.6.x
1.4.x
1.3.x
1.2.x
2.8.2
2.8.1
2.8.0
2.7.2
2.7.1
2.7.0
2.6.5
2.6.4
2.6.3
2.6.2
2.6.1
2.6.0
2.5.1
2.5.0
2.4.11
2.4.10
2.4.9
2.4.8
2.4.7
2.4.6
2.4.5
2.4.4
2.4.3
2.4.2
2.4.1
2.4.0
2.3.6
2.3.5
2.3.4
2.3.3
2.3.2
2.3.1
2.3.0
2.3.0-beta.4
2.3.0-beta.3
2.3.0-beta.2
2.3.0-beta.1
2.2.4
2.2.3
2.2.2
2.2.1
2.2.0
2.1.2
2.1.1
2.1.0
2.0.5
2.0.4
2.0.3
2.0.2
2.0.1
2.0.0
2.0.0-beta.3
2.0.0-beta.2
2.0.0-beta.1
1.17.0
1.16.1
1.16.0
1.15.0
1.14.0
1.13.1
1.13.0
1.12.2
1.12.1
1.12.0
1.11.1
1.11.0
1.10.7
1.10.6
1.10.5
1.10.4
1.10.3
1.10.2
1.10.1
1.10.0
1.9.1
1.9.0
1.8.3
1.8.2
1.8.1
1.8.0
1.7.4
1.7.3
1.7.2
1.7.1
1.7.0
1.6.3
1.6.2
1.6.1
1.6.0
1.5.3
1.5.2
1.5.1
1.5.0
1.4.5
1.4.4
1.4.3
1.4.2
1.4.1
1.4.0
1.3.5
1.3.4
1.2.2
1.3.3
1.3.2
1.3.1
1.3.0
1.2.1
1.2.0
1.2.0-rc2
1.2.0-rc1
1.1.7
1.1.6
1.1.5
1.1.4
1.1.3
1.1.2
1.1.1
1.1.0
1.0.1
1.0.0
0.9.5
0.9.4
0.9.3
0.9.2
0.9.1
0.9
0.8.8
0.8.7
0.8.6.1
0.8.6
0.8.5
0.8.4
0.8.3
0.8.3-rc1
0.8.2
0.8.1
0.8
0.8-rc2
0.8-rc1
0.7.2
0.7.1
0.7
0.6.1
0.6
0.5
0.3
0.2
0.1
Labels
Clear labels   
bug

   
bug

   
dependencies

   
design

   
documentation

   
duplicate

   
enhancement

   
enhancement

   
enhancement

   
feedback-needed

   
help-needed

   
help-needed

   
installer

   
invalid

   
looking-for-sponsors

   
modoboa-contacts

   
new-ui

   
new-ui

   
pr

   
pull-request

Mirrored from GitHub Pull Request

  
pyconfr

   
python

   
question

   
security

   
stale

   
webmail

   
wontfix
No labels
bug
bug
dependencies
design
documentation
duplicate
enhancement
enhancement
enhancement
feedback-needed
help-needed
help-needed
installer
invalid
looking-for-sponsors
modoboa-contacts
new-ui
new-ui
pr
pull-request
pyconfr
python
question
security
stale
webmail
wontfix
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/modoboa-modoboa#1629
No description provided.