Review /dictionary/info endpoint

Signbank / Global-signbank

An online sign dictionary and sign database management system for research purposes. Developed originally by Steve Cassidy/ This repo is a fork for the Dutch version, previously called 'NGT-Signbank'.

http://signbank.cls.ru.nl

BSD 3-Clause "New" or "Revised" License

19 stars 12 forks source link

Review /dictionary/info endpoint #1130

Open vanlummelhuizen opened 9 months ago

vanlummelhuizen commented 9 months ago

The /dictionary/info endpoint returns a json with a list of datasets the user has change_dataset permission for. When there is no dataset for which the user has change_dataset permission, a json with settings.LANGUAGE_NAME and settings.COUNTRY_NAME is returned.

This endpoint is used by the Signbank extension in ELAN. The second json as describe above is unusable in ELAN.

We could/should do two things:

Make the necessary permission view_dataset.
Return an empty list if there is no dataset to choose from.

Any thoughts, @Jetske @Woseseltops @susanodd ?

susanodd commented 9 months ago

New users only are given view permission (it used to be to NGT) and put in group Guest.

I just tried it not logged in. Yeah, it looks totally useless for anonymous users.

Do they need to be able to change things when they use ELAN?

There are zillions of permissions that exist but aren't being tested for. Can a permission specific to ELAN be made and granted (to who? to group Guest? to Anonymous users?)

susanodd commented 9 months ago

view_dataset seems the most fitting, since anonymous users can also view glosses that are public.

But maybe a second option for users that need advanced info about the glosses in the datasets? (Is a distinction between view and change sufficient?)

Jetske commented 9 months ago

I don't really know how this extension works but if users can make changes to the Signbank datasets through this extension in ELAN, option 2 sounds as the most logical/safest solution. Otherwise, option 1 would be ok I think.

susanodd commented 9 months ago

@vanlummelhuizen see #1149 (scroll down a lot to the end where the most recent is shown)

I made it so if the user is anonymous, it provides in NGT glosses that are public.

I revised the fields returned in glosses.json

There were some bugs in the original fields. Also the API setting is obsolete. I made it so the fields of Public View / Gloss List View are available. I made the Translations be Senses (language name). Do we need the Lemma fields too?

Should the info command of this issue also show the available fields? Should they be available in Dutch as an option?

The package command is deployed on the development server as well as on signbank-dev. (But dev has no videos, so the zip output on signbank-dev is probably dodgy for images and videos.)

susanodd commented 7 months ago

I added some info to the wiki about this endpoint.

This endpoint probably needs to be expanded to show the available corpora for the dataset.

The dataset ID and corpora ID should also be provided to allow seamless integration with the new API routines. Alternatively, the "acronym" can be provided in the urls as is implemented for the Dataset Details urls. (@vanlummelhuizen implemented this feature.)

The original package routine also needs to specify from what corpus the zip files are needed and the others extended to retrieve from a particular corpus.

susanodd commented 7 hours ago

Does this work on the empty database? Maybe some general information for anonymous users?