search

distributed-text-services / specifications

Specifications for the DTS API
https://w3id.org/dts
28 stars 9 forks source link

API is not completely Hydra compatible #139

Closed PonteIneptique closed 7 months ago

PonteIneptique commented 6 years ago

I looked at the Hydra doc for another API (a service API mostly but I wanted to document correctly each variation of the service...) : it looks like we are missing quite a bit of the Hydra specs, namely the documentation that should be accessible ( http://www.hydra-cg.com/spec/latest/core/#documenting-a-web-api )

It seems necessary, and if we look at the playground using any DTS example, it does not work : http://www.markus-lanthaler.com/hydra/console/?url=http://www.markus-lanthaler.com/hydra/event-api/

PonteIneptique commented 6 years ago

Fixed the typo in the title.

balmas commented 6 years ago

sounds like we need to do this

hcayless commented 5 years ago

(These are my notes from looking into implementing this)

From reading the documentation, it's clear that we'll need a DTS ontology, expressed in JSON-LD, to which https://w3id.org/dts/api# redirects.

All DTS properties will need to be defined, and I strongly suspect we'll want to subclass hydra:Collection to define dts:Collection and dts:Navigation classes. We'll need a dts:Document class too.

We should probably host static JSON-LD documentation resolvable via a w3id URL (https://w3id.org/dts/doc ?) that's globally applicable. Implementations would obviously be free to define their own documentation at their own URI as well. The alternative is to provide a template and insist that implementers do it themselves.

If this all sounds reasonable, I will get to work on it. I'd hoped this was a fairly small task I could knock out in a day or two, but it's medium sized, so it may have to wait until things slow down over the holiday break.

PonteIneptique commented 5 years ago

Sounds good to me :)

balmas commented 5 years ago

Sounds good to me too.

PonteIneptique commented 7 months ago

During the RC Workshop in Duke, and given the current situation of Hydra, it has been decided to move away from their vocabulary, while acknowledging our inspiration from it. As a consequence, this issue does not stand anymore.