atomic-data-docs icon indicating copy to clipboard operation
atomic-data-docs copied to clipboard

Service description - discovering endpoints / other functionality

Open joepio opened this issue 4 years ago • 0 comments

Currently, there only exists one implementation of an Atomic Data Server. However, in the future, there might be different, and each one might have different features enabled.

Most of these features are described as endpoints, such as a path endpoint, or an all-versions endpoint. Ideally, the client would check this collection, and depending on these, will render different action in a context menu.

But how would the client know where to find these endpoints?

Some ideas:

  • Using HTTP header(s) from the server (lots of repeated information)
  • Adding links to resources (highly discoverable, but also redundant and expensive)
  • Using paths (see below)

Using paths

Atomic Paths can make it easy to traverse a graph. We could have a common starting point (the drive? the root URL of the server? something else?) that describes these.

joepio avatar Jul 07 '21 11:07 joepio