Reconciliation API specifications
This repository hosts the specifications of the reconciliation API, which can be viewed at:
https://reconciliation-api.github.io/specs/latest/
General discussion about this protocol can be held on the [email protected] mailing list.
Initially, the aim is to document the existing state of the API, as witnessed by the existing clients and servers, and the original documentation on OpenRefine's wiki. Once the existing API is documented to a satisfactory level, we will incorporate improvements discussed in the Community Group in further versions of the document.
Feel free to contribute to this documentation effort by editing latest/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.
Local setup
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.
Testing
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