isamplesorg/metadata

Collection API documentation

Opened this issue · 0 comments

Gather documentation and example code for interacting with collection APIs

Basic requirements include:

  • API introspection. Is there a mechanism for discovering the service endpoints and mechanisms for interacting with the API?
  • List available records. Is there an API that enables a complete listing of the identifiers for all records in the collection?
  • Get record. Is there an API that enables access to an individual record given an identifier?
  • Do records reference a schema or other structure control document?

Generally:

  • Is content negotiation via redirect or link headers supported?
  • Are there limits on API interaction (call, bandwidth, security)?