From c2158b90ffff32653196539d694e4b5a48dd01ae Mon Sep 17 00:00:00 2001 From: Lucas Di Pentima Date: Wed, 23 Feb 2022 15:40:12 -0300 Subject: [PATCH] 18574: Adds vocabulary endpoint section to the API documentation. Arvados-DCO-1.1-Signed-off-by: Lucas Di Pentima --- doc/api/index.html.textile.liquid | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/api/index.html.textile.liquid b/doc/api/index.html.textile.liquid index 8586a166d3..3d69d02ea9 100644 --- a/doc/api/index.html.textile.liquid +++ b/doc/api/index.html.textile.liquid @@ -20,6 +20,10 @@ 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. Exported vocabulary definition + +When configured, the Controller also exports the "metadata vocabulary definition":{{site.baseurl}}/admin/metadata-vocabulary.html in JSON format. This functionality is useful for clients like Workbench2 and the Python SDK to provide "identifier to human-readable labels" translations facilities for reading and writing objects on the system. This is available at @/arvados/v1/vocabulary@, for example @https://{{ site.arvados_api_host }}/arvados/v1/vocabulary@. + h2. Workbench examples Many Arvados Workbench pages, under the *Advanced* tab, provide examples of API and SDK use for accessing the current resource . -- 2.30.2