Add swagger definitions for jim APIs and document the APIs #368
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
this looks great - I hope to get more time soon to go through it better 👏 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I recently started using MailHog as an SMTP test server and found Jim to be useful. I needed to configure Jim to reject all auth requests, but I had set up MailHog via docker. I noticed that Jim can be enabled and disabled from the UI, so I dug a little deeper and reverse engineered what the UI was doing.
I found that an API was introduced for controlling Jim a while back:
mailhog/MailHog-Server@1094ce8
This API accepts a configuration for Jim. I found that using the API is more flexible than passing in flags when starting MailHog. Since I found the API useful I decided to document my findings and open a pull request so that other people are aware of this functionality.