Docmaps-Project / docmaps

Extensible protocol for document history metadata exchange, to enable trustworthy, rapid, open science, by and for preprint science communities.
MIT License
15 stars 1 forks source link

Standard interop and discovery protocol #67

Open ships opened 1 year ago

ships commented 1 year ago

Protocol semantics improvement

Description

Both for browser and server-side use-cases, it is widely desired to be able to retrieve docmaps from a variety of sources that conform to the same basic API contract so that you can get rich data about a document/DOI. This issue is about defining the core interoperability contract of a server that issues docmaps, and building a reference implementation of that protocol that serves some interesting docmaps.

Use case

Widget - we can have a widget that is pre-configured with one or more URLs, and that can then construct a reasonable history/graph of information based on a diversity of sources that have statements regarding an input DOI.

Server - by adding features like pagination and read-forward streaming, we can allow catch-up indexing between trusted parties if any server needs to do batch processing of a docmapsy dataset.

Proposed solution

The proposal is one half of the output of this ticket. The other half is a server that we can run that serves a standard docmap endpoint.

Additional information

One place that Knowledge Futures might begin with this is to serve Docmaps for PubPub pubs.