Skip to content

Tool registration format

Rene Ranzinger edited this page May 25, 2019 · 3 revisions

Each developer has to register his tool in the glic tool registration file. All developers that are collaborators on the repository can do so themselves. Other tool providers can create a request issue in this repository. There are two essential pieces of information required for a registry entry:

  • The URL to the JSON file with the Tool information
  • A contact email in case the retrieval of the tool information fails

JSON format

[  
    { /* Tool information entry */ }  
    ...  
]

On the top level the JSON consists of a list of tool information entries.

Tool information entry

...
{
    "info_url":"https://www.glygen.org/glic.info.json",
    "email":"[email protected]"
},
...
  • The info_url property specifies the location of the JSON file with the tool information. This file must be freely accessible and follow the the tool information format. The filename can be freely chosen.
    The info_url property is mandatory.

  • The email property provides a contact address in case the retrieval of tool information by the provided URL fails (e.g. server down, invalid format).
    The email property is mandatory.

Clone this wiki locally