OpenAPI documentation for the WhatsApp Business API.

URLs

Do you want to improve this page? Please edit it on GitHub.

Description

This project contains an OpenAPI specification for the WhatsApp Business API.

The original work comes from the Postman collection from the WhatsApp Business API - Postman Collection project. The initial conversion to OpenAPI was made with the apimatic online tool. The spec was then reworked using Apicurio Studio and KaiZen OpenAPI Editor for Eclipse.

The style and the OpenAPI extensions used in the project are compatible with OpenAPI Generator.

Source Code

The OpenAPI specification can be found on GitHub: openapi.yaml.

Documentation can be found in the docs/ folder.

Build

This project is using gradle (to build the documentation page).

Command to build the documentation page:

./gradlew asciidoctor

The output of this command is an HTML page located at <git repo root>/build/docs/html5/index.html.

For project maintainers

Command to upload the documentation page on GitHub pages:

./gradlew gitPublishPush

Using ssh-agent

Some tasks requires pushing into the distant git repository (release task or updating the gh-pages branch). If they are failing with errors like this:

org.eclipse.jgit.api.errors.TransportException: ... Permission denied (publickey).

Then ssh-agent can be used.

eval `ssh-agent -s`
ssh-add ~/.ssh/id_rsa

(source for this approach)

Get in touch

Use the issue tracker on GitHub.

License

Code is under Eclipse Public License - v 2.0.