hapi-server / data-specification

HAPI Data Access Specification
https://hapi-server.org
22 stars 7 forks source link

Reconsider adding light spec for servers.{txt,json} #31

Closed rweigel closed 7 years ago

rweigel commented 7 years ago

I think that we put off the discussion of servers.txt previously.

From developing the MATLAB client, it seems clear that we need a specification for this (or at least to document why not here - perhaps it is in the Telecon notes). Minimal requirements would be

servers.json: JSON array with elements

{ 
"id": "Required ID. Could be SPASE ID for a service if space physics data",
"name": "Required name",
"url": "Required URL ending in /hapi/",
"description": "Optional description"
}

The tricky part is with the ID. We would need to maintain a controlled list of IDs for non-SPASE data servers. We would also probably need to allow for subsetting of the servers by adding another controlled list.

toddking commented 7 years ago

Hi all -

How about adopting the SPASE Service description for this purpose? The minimum set of information is very similar to what Bob proposes. If we'd prefer JSON (over the XML that SPASE currently supports) we can create a JSON version that follows the same schema. I've wanted to do this for SPASE anyway.

-Todd-

On 5/26/2017 3:42 AM, Bob Weigel wrote:

I think that we put off the discussion of servers.txt previously.

From developing the MATLAB client, it seems clear that we need a specification for this (or at least to document why not here - perhaps it is in the Telecon notes). Minimal requirements would be

servers.json: JSON array with elements

{ "id": "Required ID. Could be SPASE ID for a service if space physics data", "name": "Required name", "url": "Required URL ending in /hapi/", "description": "Optional description" }

The tricky part is with the ID. We would need to maintain a controlled list of IDs for non-SPASE data servers. We would also probably need to allow for subsetting of the servers by adding another controlled list.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/hapi-server/data-specification/issues/31, or mute the thread https://github.com/notifications/unsubscribe-auth/ACC8zRlqS-s-gXT9hct40eXB52t73lYeks5r9qyVgaJpZM4Nncm6.

rweigel commented 7 years ago

This should work.

On Fri, May 26, 2017 at 4:08 PM, Todd King notifications@github.com wrote:

Hi all -

How about adopting the SPASE Service description for this purpose? The minimum set of information is very similar to what Bob proposes. If we'd prefer JSON (over the XML that SPASE currently supports) we can create a JSON version that follows the same schema. I've wanted to do this for SPASE anyway.

-Todd-

On 5/26/2017 3:42 AM, Bob Weigel wrote:

I think that we put off the discussion of servers.txt previously.

From developing the MATLAB client, it seems clear that we need a specification for this (or at least to document why not here - perhaps it is in the Telecon notes). Minimal requirements would be

servers.json: JSON array with elements

{ "id": "Required ID. Could be SPASE ID for a service if space physics data", "name": "Required name", "url": "Required URL ending in /hapi/", "description": "Optional description" }

The tricky part is with the ID. We would need to maintain a controlled list of IDs for non-SPASE data servers. We would also probably need to allow for subsetting of the servers by adding another controlled list.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/hapi-server/data-specification/issues/31, or mute the thread https://github.com/notifications/unsubscribe-auth/ACC8zRlqS-s- gXT9hct40eXB52t73lYeks5r9qyVgaJpZM4Nncm6.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/hapi-server/data-specification/issues/31#issuecomment-304377119, or mute the thread https://github.com/notifications/unsubscribe-auth/ACkO_nHzn8__P_RMYqhiPiQhigxF8BsAks5r9zFGgaJpZM4Nncm6 .

jvandegriff commented 7 years ago

From telecon:

update list of servers -new top level project "servers" -JSON format for servers.txt -put in URL like: https://github.com/hapi-server/servers/all.json -use minimal SPASE elements from the SPASE service description -need place for people to add servers outside of our telecon group -for Heliophysics, maybe use HDEE web site -need mechanism that works outside Heliophysics -for now, stick with membership in GitHub project as basis for new servers, then worry about global expansion later

rweigel commented 7 years ago

This is complete: https://github.com/hapi-server/servers