api icon indicating copy to clipboard operation
api copied to clipboard

API description

Open mixterj opened this issue 7 years ago • 4 comments

The Discovery API specs out how to describe OrderedCollection for AS descriptions but do we want to include a way to describe the organization Discovery API in general? Similar to Schema.org's pending WebAPI class - https://pending.schema.org/WebAPI

We are using this approach for our prototyping so we can provide a high-level description of the Discovery service.

mixterj avatar Oct 31 '18 16:10 mixterj

Consensus on IIIF Discovery Call: 6th Feb 2019

Defer pending more implementation experience and output of W3C working group re: DCAT, etc.

mattmcgrattan avatar Feb 06 '19 18:02 mattmcgrattan

expanding on the initial issue. The use case is that OCLC would like to host AS feeds for all 1000+ CONTENTdm Users - hosting and serving up the API code as well as the AS data. Additionally, we would like to host AS feeds for every collection across users. That would be ~16,000 AS API endpoints.

to deliver all of these services, it would be nice to have a IIIF Discovery landing page description that can:

  • navigate users or machines to each of the User AS API endpoints and subsequently the Collection AS API endpoints.

  • link to/reference IIIF Discovery API documentation,

  • describe usage agreements (hit rate/limit for example)

  • describe general usage rights (CC0 for example).

Outside of our potentially unique use case of hosting thousands of AS API endpoints, the rest of the use cases seem pretty universal.

mixterj avatar Mar 06 '19 18:03 mixterj

Propose defer until 1.1

azaroth42 avatar Feb 04 '21 18:02 azaroth42

Propose transfer to iiif/api, keeping it marked as defer

azaroth42 avatar Oct 12 '22 16:10 azaroth42