Project description: http://o2r.info

We're a research project, so everything in this API and its documentation is subject to change. We try to use "WORK IN PROGRESS" or "TBD" in headlines to signal things that are not working fully yet.

The "working" state should eventually always be in the master branch, which is published online at http://o2r.info/o2r-web-api, and open pull requests reflect things that are under development.

This specification is written in Markdown and deployed automatically using Travis CI. You can use mkdocs to render it locally, or view the latest master-branch on http://o2r.info/o2r-web-api/. See the MkDocs documentation for details.

# pip install mkdocs
# mkdocs --version
mkdocs serve

mkdocs build

The current master branch is automatically built on Travis CI and deployed to the GitHub Page at http://o2r.info/o2r-web-api/. Our combination of the .travis.yml and .deploy.sh will run the mkdocs command on every direct commit or merge on the master branch and deploy the rendered HTML documents to the gh-pages branch in this repository.

Travis authenticates its push to the gh-pages branch using a personal access token of the user @o2r-user. The access token is encrypted in the .travis.yml using Travis CLI for the repository o2r-project/o2r-web-api:

travis encrypt GH_TOKEN=<token here>

The variable GH_TOKEN is used in the deploy script. The token generated on the GitHub website should not be stored anywhere, simply generate a new one if needed.

This has some security risks, as described here. To mitigate these risks, we have disabled the option "Build pull requests" is on the Travis configuration page for this repo, so that malicious changes to the Travis configuration file will be noticed by the repository maintainer before merging a pull request.

The o2r Web API specification is licensed under Creative Commons CC-BY-4.0 License, see file LICENSE.

Copyright (C) 2017 - o2r project.