REST API Specifications
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs regenerate docs Dec 16, 2018
src fixing wrong words on definitions/template Dec 16, 2018
tools cleaning up tools file structure; updating readme with latest build p… Dec 7, 2018
.gitignore fixing gitignore Nov 14, 2018
Dockerfile cleaning up tools file structure; updating readme with latest build p… Dec 7, 2018
LICENSE
README.adoc

README.adoc

specifications-ITS-REST

REST APIs Specifications. See working baseline of current openEHR specifications.

Specifications are written in API Blueprint format. Latest version is rendered as HTML pages at https://openehr.github.io/specifications-ITS-REST.

Building Documentation

The HTML pages are building using aglio in a Docker container.

  1. Build the docker image using:

$ docker build -t rest-api-doc .
  1. Build the whole documentation running:

$ docker run -v "$(pwd):/project" -t rest-api-doc
  1. Or build a single HTML page, supplying all necessary parameters to aglio:

$ docker run --rm -v "$(pwd):/project" rest-api-doc aglio --theme-template triple \
                --theme-full-width \
                --theme-style default \
                --theme-style /project/src/styles/layout-openEHR.less \
                --theme-variables flatly \
                -i /project/src/query.apib \
                -o /project/docs/query.html
  1. (See more usage info on https://github.com/danielgtaylor/aglio#executable)

  2. View the rendered docs in the docs/ folder.