This repository hosts the specifications of the reconciliation API, which can be viewed at:
https://reconciliation-api.github.io/specs/draft/
General discussion about this protocol can be held on the [email protected] mailing list.
Anyone can join our W3C Entity Reconciliation Community Group or read our past announcements.
Feel free to contribute to this documentation effort by editing draft/index.html. Add yourself
to the list of editors in the preamble of the document (see the available options
for editor metadata).
This specification is developed using ReSpec and help about its markup can be found in its user guide.
Deploy previews on pull requests are provided by Netlify.
To edit and preview the index.html file locally, clone the repo and change into the specs directory:
git clone https://github.com/reconciliation-api/specs.git ; cd specs
Run a web server in the specs directory (for data-include support):
python3 -m http.server
You can then view the specs at http://localhost:8000.
You can check the JSON schemas used in the specifications against a set of valid and invalid examples. This relies on the ajv schema validator that can be installed with npm install -g [email protected] (this requires the Node package manager npm). You can then run the tests with:
./test.sh