https://github.com/reconciliation-api/specs

Specifications of the reconciliation API
https://github.com/reconciliation-api/specs

reconciliation reconciliation-api reconciliation-service

Last synced: about 2 months ago
JSON representation

Specifications of the reconciliation API

• Host: GitHub
• URL: https://github.com/reconciliation-api/specs
• Owner: reconciliation-api
• Created: 2019-09-16T13:36:17.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-09-16T17:15:14.000Z (3 months ago)
• Last Synced: 2024-09-16T21:16:23.467Z (3 months ago)
• Topics: reconciliation, reconciliation-api, reconciliation-service
• Language: HTML
• Homepage: https://reconciliation-api.github.io/specs/draft/
• Size: 539 KB
• Stars: 31
• Watchers: 13
• Forks: 9
• Open Issues: 43
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Reconciliation API specifications

=================================

[![Continuous integration](https://github.com/reconciliation-api/specs/actions/workflows/ci.yml/badge.svg)](https://github.com/reconciliation-api/specs/actions/workflows/ci.yml)

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](https://lists.w3.org/Archives/Public/public-reconciliation/).

Anyone can join our [W3C Entity Reconciliation Community Group](https://www.w3.org/community/reconciliation/) 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](https://github.com/w3c/respec/wiki/person)

for editor metadata).

This specification is developed using [ReSpec](https://github.com/w3c/respec) and help about

its markup can be found in its [user guide](https://github.com/w3c/respec/wiki/ReSpec-Editor's-Guide).

Deploy previews on pull requests are provided by [Netlify](https://www.netlify.com/).

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`](https://github.com/w3c/respec/wiki/ReSpec-Editor's-Guide#inclusions--transformations) support):

`python3 -m http.server`

You can then view the specs at [http://localhost:8000](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`