implementing data dictionary for siibra-api

[xgui3783]

Following on from the zoom meeting on 2024 08 22, one of the promises we made was a data dictionary, which (for now) would at least provide a text description of the JSON objects returned.

For the immediate future, we have started to experiment with adding some text description to (in swaggerui ) :

• BoundingBoxModel:

BoundingBoxModel. Describes an axis aligned boundingbox. As a result, only the most left-posterior-inferior and most right-anterior-superior points are needed to define all eight vertices of the bounding box.

We are still learning and experimenting with what is the best way to document such data dictionary. If you have any comments and suggesstions, we would be very receptive to them.

In the medium/long term (~2 or so months), we will be looking into developing v4 of siibra-api. It would be an opportunity for us to restructure the APIs to incorporate such data dictionaries. We will look at existing standards, such as jsonld. If you have suggestions on relevant existing jsonld (or any other relevant standards), please also feel free to leave them here.