data-server-docs

API docs for the REST server

Install

npm install apidoc -g
composer install

Build docs

apidoc -i vendor/chartblocks/data-server/ -o apidoc/

Push docs to github pages

git subtree push --prefix apidoc origin gh-pages

Generate developer doc copy of api_data.json

php bin/convertForDeveloperDocs.php --data-target="/path/to/developer-docs/_data/rest/apidoc.json"