tree: 731fa12914b9563b2ae76fde6b275fe991d7e3c6 [path history] [tgz]
  1. README.md
  2. apiary.apib
  3. dredd.yml
  4. gulpfile.js
  5. helpers/
  6. hooks.py
  7. package.json
  8. 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/#]