This project is community maintained. We welcome contributions for feature requests and bug reports, as well as for docs and code changes.
If you would want to see something added or changed, or encountered a bug. Please open an issue on GitHub.
Saw a typo or want to make other changes to the Docs? Please have a look at the documentation's README.
If your changes affect the API section,
then you'll need to make the changes to the openapi.yaml file,
and regenerate the Docs.
Making changes manually to the docs/docs/api
is not supported, since those files are generated from the OpenAPI specification.
We also welcome code changes. If you're thinking of opening a large pull request, please consider opening an issue on GitHub first to discuss it.
This is a maven project.
To build it from source, run the command: mvn clean install -DskipTests in the root folder.
Note All Kotlin code in this repo is built and tested with JDK 17.
The resulting build artifact can be found in the folder target, i.e.
target/camunda-platform-rest-api-X-Y-Z-SNAPSHOT.jar
The distribution can be containerized with Docker automatically in maven by running:
mvn jib:dockerBuild.