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.

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

[Feature Request] White label option for swagger documentation #305

Closed
Himanshu1234556 opened this issue Apr 22, 2024 · 1 comment
Closed
Labels
enhancement New feature or request patron:PLUS

Comments

@Himanshu1234556
Copy link

Himanshu1234556 commented Apr 22, 2024

I want to show my own branding on Swagger documentation

patron:PLUS

@allburov allburov added the enhancement New feature or request label Apr 23, 2024
@devlikepro
Copy link
Contributor

devlikepro commented May 8, 2024

Added in 2024.5.4!

https://waha.devlike.pro/docs/how-to/swagger/


White label

You can show your own brand in the Swagger documentation.

image

👉 Swagger White Label is available in WAHA Plus version.

Use the following environment variables to customize the Swagger documentation:

  • WHATSAPP_SWAGGER_TITLE - the title of the Swagger documentation and some other places.
  • WHATSAPP_SWAGGER_DESCRIPTION - Markdown formatted description of your API.
  • WHATSAPP_SWAGGER_EXTERNAL_DOC_URL - URL to the external documentation.

Example (consider using docker-compose or other methods to store these settings):

docker run -it -p 3000:3000 -e WHATSAPP_SWAGGER_TITLE="AwesomeCRM" -e 'WHATSAPP_SWAGGER_DESCRIPTION=<p>FantasticFindz - Discover unique treasures from around the world at unbelievable prices!<br/> <a href='https://google.com'>Read more about us!</a></p>' -e "WHATSAPP_SWAGGER_EXTERNAL_DOC_URL=https://google.com" devlikeapro/whatsapp-http-api-plus

patron:PRO

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request patron:PLUS
Projects
None yet
Development

No branches or pull requests

3 participants