X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/0eb72b526bf8bbb011551ecf019f604e17a534f1..4ce3a9012eb959cea8c784ff5efe9d44cefa2543:/doc/api/index.html.textile.liquid diff --git a/doc/api/index.html.textile.liquid b/doc/api/index.html.textile.liquid index 2cc5871d73..8586a166d3 100644 --- a/doc/api/index.html.textile.liquid +++ b/doc/api/index.html.textile.liquid @@ -16,6 +16,10 @@ h2. Discovery document The API server publishes a machine-readable description of its endpoints and some additional site configuration values via a JSON-formatted discovery document. This is available at @/discovery/v1/apis/arvados/v1/rest@, for example @https://{{ site.arvados_api_host }}/discovery/v1/apis/arvados/v1/rest@. Some Arvados SDKs use the discovery document to generate language bindings. +h2. Exported configuration + +The Controller exposes a subset of the cluster's configuration and makes it available to clients in JSON format. This public config includes valuable information like several service's URLs, timeout settings, etc. and it is available at @/arvados/v1/config@, for example @https://{{ site.arvados_api_host }}/arvados/v1/config@. The new Workbench is one example of a client using this information, as it's a client-side application and doesn't have access to the cluster's config file. + h2. Workbench examples -Many Arvados Workbench pages, under the the *Advanced* tab, provide examples of API and SDK use for accessing the current resource . +Many Arvados Workbench pages, under the *Advanced* tab, provide examples of API and SDK use for accessing the current resource .