api

README

Generated API docs are at rules-core-http-api.md.

All of this API documentation is generated from files in this directory. The tool rulesapi (see below) hits a live rulessys process to get example output, which is automatically included in the generated documentation.

If you change the API, update api.json.

Then make sure you have an engine running at http://localhost:8001/.

Then:

go build -o rulesapi rulesapi.go
./rulesapi -format raml > rules-core-http-api.raml
./rulesapi -format markdown > rules-core-http-api.md
pandoc -o rules-core-http-api.html rules-core-http-api.md