The repository contains the JSON standard for Animal Data Exchange (ADE) produced by the International Committee for Animal Recording (ICAR).
The content of this repository is licenced using the Apache 2.0 Licence. You are encouraged to use it in your data exchanges and other applications, and also to contribute to the further development of the standard.
You can find the documentation for this project in the Wiki.
There you will find:
- Information about ICAR and the ADE working group
- The design principles considered by the ADE working group when developing the standard
- How to understand the data model
- Tips for implementing a client application using the standard
- Tips for implementing a service using the standard
Developers may wish to start by reading the \url-schemes\exampleUrlScheme.json file in their favourite OpenAPI specification editor. You can also see a preview using the free Redoc tool. Or (by using the swagger editor : https://editor.swagger.io/?url=https://raw.githubusercontent.com/adewg/ICAR/ADE-1/url-schemes/exampleUrlScheme.json
Version 1.0 of this standard was based on previous work of:
- The ICAR ADE working group XML standard
- DataLinker
- JoinData
- And many other contributors
The Animal Data Exchange Working Group welcome contributions
- Read and make suggestions using the Issues List
- The default branch is set to ADE-1 which is the current release. This is to make it easier for organisations to clone and use the specifications. If you expect to contribute you will need to work on the Develop branch instead.
- Propose changes by logging an issue, then creating your own fork of the Develop branch and proposing a Pull Request that will be reviewed by the maintainers.