ckan / ideas

[DEPRECATED] Use the main CKAN repo Discussions instead:
https://github.com/ckan/ckan/discussions
40 stars 2 forks source link

Define a link to discover API #233

Open evert opened 4 years ago

evert commented 4 years ago

In order to make it easier for users to use CKAN api's, it might be nice if a standard link would be defined, that can appear on portal homepages.

2 examples:

<link rel="https://ckan.org/rel/api-root" href="https://ckan0.cf.opendata.inter.prod-toronto.ca/api/3" />
<link rel="ckan-api-root" href="https://ckan0.cf.opendata.inter.prod-toronto.ca/api/3" />

Such a link could allow an application to ask a user for a CKAN url, and that application could automatically discover where the related API is.

It also allows people to add the same link on other, related open data pages so that the CKAN api root can be discovered from a wide variety of urls.

My specific use-case is a google sheets add-on. I want users to be able to add their CKAN instances, but asking them what the API root is might be quite difficult for the target audience.

If they give me (some) url, and this url is either: 1) The API root or 2) contains a link to the API root, I can reduce the friction quite a bit in adding new instances.