Specific minimal subset of JSKOS API

gbv / jskos-server

Web service to access JSKOS data

https://coli-conc.gbv.de/api/

MIT License

6 stars 4 forks source link

Specific minimal subset of JSKOS API #171

Open nichtich opened 2 years ago

nichtich commented 2 years ago

Which endpoints and query parameters must be supported to

provide a vocabulary
provide mappings

In addition to wikidata-jskos there will be an implementation of subset of JSKOS API for Konstanz Systematics so definition of what to expect would be helpful.

nichtich commented 1 year ago

The subset for vocabularies and concepts ist most relevant. To do so add API endpoints:

alias /narrower as /voc/narrower and make the second the primary, the first deprecated
alias /ancestors as/voc/ancestors and make the second the primary, the first deprecated

And then specify a subset of API endpoints /voc* as JSKOS Vocabulary API. API perameters should be reduced too, e.g. make support of properties optional.

stefandesu commented 1 year ago

I just noticed that /voc/narrower//voc/ancestors are not consistent with other endpoints, considering your suggestions in #189. From my point of view, it should be /voc/concepts/narrower//voc/concepts/ancestors, right? Maybe it would be better to have vocabulary data under /voc*, but concept data under /concepts*? We also have /search and /suggest which are concept endpoints, so we would have /concepts/search for concept search and /voc/search for vocabulary search.

stefandesu commented 1 year ago

With #193, the endpoints were made more consistent. See this comment for more details. These changes will be released in an upcoming version 2.0.