tree: 395de34706132948996ddfd2fe25b3d6f5764eef [path history] [tgz]
  1. .gitignore
  2. README.md
  3. apiary.apib
  4. dredd.yml
  5. gulpfile.js
  6. helpers/
  7. hooks.py
  8. package.json
  9. source/
xos/tests/api/README.md

xos-api-docs

These folder contain the XOS API definition and specs. To run tests visit configurations/test-standalone folder.

To document new API:

  • run npm install
  • run npm start
  • add the appropriate endpont under source folder.

API are documented using (Api BluePrint)[https://apiblueprint.org/] syntax and the documentation is published on (Apiary)[http://docs.xos.apiary.io/#]