symbiota-tooltips

An open API to help document Symbiota tools and terms

This repository contains API endpoints where one can fetch short explanations about Symbiota pages or terms in a portal. The short explanations provided here (along with optional links when available) are integrated with Symbiota code, so that tooltips are available dynamically, on demand, in pages and terms throughout the interface.

Endpoints include language tags, so that the content can be delivered in the idiom used by the interface.

There are also links directing users to related resources, such as help guides and tutorials made available at the Symbiota Docs website.

Created with the Open Static API Kit.

Usage

Get a term tooltip:

curl -G https://biokic.github.io/symbiota-tooltips/api/v<version number>/terms/<term_id>.json

For instance, get Catalog Number tooltip:

curl -G https://biokic.github.io/symbiota-tooltips/api/v1_0/terms/catalogNumber.json

Get a page tooltip:

curl -G https://biokic.github.io/symbiota-tooltips/api/v<version number>/<path_to_page_file>/<pagefilename.php>.json

For instance, get Taxonomic Tree Viewer tooltip:

curl -G https://biokic.github.io/symbiota-tooltips/api/v1_0/taxa/taxonomy/taxonomydisplay.php.json

Data

JSON endpoints are generated based on CSV files in the data folder.