Web Annotation Data Model

[Graham Leach-Krouse]

Hi!

I've been reading some of the documents produced by the web annotation working group, and I was wondering if there's any information available anywhere about the extent to which Hypothes.is currently implements that group's recommendations.

I've found this:

https://w3c.github.io/test-results/annotation-model/all.html

But I'm not sure how to generate the JSON serializations that Hypothes.is used in running those tests. (Looking at the test results, they seem like they must have been different from what you can GET out of the v1 Hypothes.is API, though maybe I'm mistaken about that.)

Thanks for any help anyone is able to offer.

Best,
-Graham

[Robert Knight]

Hello,

Alignment of Hypothesis with the Web Annotations specs can be considered at several levels:

- The data model (entities and relationships between them)

- Serialization of the data model (in the JSON-LD based format)

- Protocol for CRUD operations on annotations and collections of annotations

Roughly speaking, the extent of Hypothesis's current support is that it implements a subset of the data model [1] and its API can return a serialization of individual annotations in the JSON-LD format defined by the specs. A `GET https://hypothes.is/api/annotations/{id}.jsonld` request will return an annotation in this format.

Kind regards,

Robert.

[1] Annotations can refer to a single target identified by a URI and zero or more _selectors_. The Hypothesis _client_ currently supports a subset of the selector types defined in the Web Annotations Data Model (text quote, text position, XPath), but the backend can store arbitrary selectors. Annotations have an optional text body and zero or more string tags.

--
You received this message because you are subscribed to the Google Groups "dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to dev+uns...@list.hypothes.is.
To view this discussion on the web visit https://groups.google.com/a/list.hypothes.is/d/msgid/dev/ea6a5746-ca6c-4f10-bf36-53060ebaf00an%40list.hypothes.is.

[Graham Leach-Krouse]

Hi Robert,

Thank you, that's very helpful. Are the jsonld endpoints officially
documented anywhere? I can't seem to find anything in the API reference.

Thanks!

Best,
-Graham

On Mon Jan 10, 2022 at 2:43 AM CST, Robert Knight wrote:
> Hello,
>
> Alignment of Hypothesis with the Web Annotations specs can be considered
> at several levels:
>
> - The data model (entities and relationships between them)
> - Serialization of the data model (in the JSON-LD based format)
> - Protocol for CRUD operations on annotations and collections of
> annotations
>
> Roughly speaking, the extent of Hypothesis's current support is that it
> implements a subset of the data model [1] and its API can return a
> serialization of individual annotations in the JSON-LD format defined by
> the specs. A `GET https://hypothes.is/api/annotations/{id}.jsonld`

> <https://hypothes.is/api/annotations/%7Bid%7D.jsonld%60> request will

> return an annotation in this format.
>
> Kind regards,
> Robert.
>
> [1] Annotations can refer to a single target identified by a URI and
> zero or more _selectors_. The Hypothesis _client_ currently supports a
> subset of the selector types defined in the Web Annotations Data Model
> (text quote, text position, XPath), but the backend can store arbitrary
> selectors. Annotations have an optional text body and zero or more
> string tags.
>
> > On 9 Jan 2022, at 20:35, Graham Leach-Krouse <glea...@gmail.com> wrote:
> >
> > Hi!
> >
> > I've been reading some of the documents produced by the web annotation working group, and I was wondering if there's any information available anywhere about the extent to which Hypothes.is currently implements that group's recommendations.
> >
> > I've found this:
> >
> > https://w3c.github.io/test-results/annotation-model/all.html
> >
> > But I'm not sure how to generate the JSON serializations that Hypothes.is used in running those tests. (Looking at the test results, they seem like they must have been different from what you can GET out of the v1 Hypothes.is API, though maybe I'm mistaken about that.)
> >
> > Thanks for any help anyone is able to offer.
> >
> > Best,
> > -Graham
> >
> > --
> > You received this message because you are subscribed to the Google Groups "dev" group.

> > To unsubscribe from this group and stop receiving emails from it, send an email to dev+uns...@list.hypothes.is <mailto:dev+uns...@list.hypothes.is>.
> > To view this discussion on the web visit https://groups.google.com/a/list.hypothes.is/d/msgid/dev/ea6a5746-ca6c-4f10-bf36-53060ebaf00an%40list.hypothes.is <https://groups.google.com/a/list.hypothes.is/d/msgid/dev/ea6a5746-ca6c-4f10-bf36-53060ebaf00an%40list.hypothes.is?utm_medium=email&utm_source=footer>.