[GH-ISSUE #494] swagger api doc not in sync #319

New issue

Closed

opened 2026-03-15 13:52:14 +03:00 by kerem · 4 comments

kerem commented

2026-03-15 13:52:14 +03:00

Owner

Originally created by @BrechtBD on GitHub (May 12, 2025).
Original GitHub issue: https://github.com/axllent/mailpit/issues/494

Hi,

Could it be that the swagger api doc is not in sync with the actual api?
https://raw.githubusercontent.com/axllent/mailpit/master/server/ui/api/v1/swagger.json

for instance ListUnsubscribe is not available in the Message ref

Thank you in advance!

Originally created by @BrechtBD on GitHub (May 12, 2025). Original GitHub issue: https://github.com/axllent/mailpit/issues/494 Hi, Could it be that the swagger api doc is not in sync with the actual api? https://raw.githubusercontent.com/axllent/mailpit/master/server/ui/api/v1/swagger.json for instance ListUnsubscribe is not available in the Message ref Thank you in advance!

kerem closed this issue

2026-03-15 13:52:19 +03:00

kerem commented

2026-03-15 13:52:25 +03:00

Author

Owner

@axllent commented on GitHub (May 13, 2025):

Hi @BrechtBD. The API docs are in sync, however the ListUnsubscribe was specifically excluded after the functionality was initially released pending testing and feedback. Unfortunately I overlooked adding it to the swagger/API docs. I will release a new version of Mailpit in the coming days. Thanks for reporting this.

@axllent commented on GitHub (May 13, 2025): Hi @BrechtBD. The API docs are in sync, however the `ListUnsubscribe` was specifically excluded after the functionality was initially released pending testing and feedback. Unfortunately I overlooked adding it to the swagger/API docs. I will release a new version of Mailpit in the coming days. Thanks for reporting this.

kerem commented

2026-03-15 13:52:30 +03:00

Author

Owner

@BrechtBD commented on GitHub (May 14, 2025):

@axllent The same applies for the field client in MessagesSummary, that also appears to be missing

@BrechtBD commented on GitHub (May 14, 2025): @axllent The same applies for the field `client` in `MessagesSummary`, that also appears to be missing

kerem commented

2026-03-15 13:52:35 +03:00

Author

Owner

@axllent commented on GitHub (May 15, 2025):

I believe you mean count - This was a legacy field which was deprecated in 2023. It was left in to prevent breakage. It's excluded from the docs for that very reason.

@axllent commented on GitHub (May 15, 2025): I believe you mean `count` - This was a legacy field which was deprecated in 2023. It was left in to prevent breakage. It's excluded from the docs for that very reason.

kerem commented

2026-03-15 13:52:40 +03:00

Author

Owner

@axllent commented on GitHub (May 17, 2025):

The ListUnsubscribe information is now included in the API docs / swagger & latest Mailpit release. Thanks for reporting this.

@axllent commented on GitHub (May 17, 2025): The `ListUnsubscribe` information is now included in the API docs / swagger & latest [Mailpit release](https://github.com/axllent/mailpit/releases/tag/v1.25.0). Thanks for reporting this.