From 26e1c10f963a586e40ea9dcb46a87b0107c97b7c Mon Sep 17 00:00:00 2001 From: Peter Amstutz Date: Thu, 3 Nov 2016 16:00:46 -0400 Subject: [PATCH] 10346: Add storage to sidebar. Tweak headings. --- doc/_config.yml | 1 + doc/api/index.html.textile.liquid | 4 ++++ doc/api/storage.html.textile.liquid | 4 ++-- 3 files changed, 7 insertions(+), 2 deletions(-) diff --git a/doc/_config.yml b/doc/_config.yml index 2f66fcd6c1..96aea34d36 100644 --- a/doc/_config.yml +++ b/doc/_config.yml @@ -107,6 +107,7 @@ navbar: - api/methods.html.textile.liquid - api/resources.html.textile.liquid - api/permission-model.html.textile.liquid + - api/storage.html.textile.liquid - api/execution.html.textile.liquid - Permission and authentication: - api/methods/api_client_authorizations.html.textile.liquid diff --git a/doc/api/index.html.textile.liquid b/doc/api/index.html.textile.liquid index 9eff786f8b..d90a35efa4 100644 --- a/doc/api/index.html.textile.liquid +++ b/doc/api/index.html.textile.liquid @@ -7,6 +7,10 @@ title: API Reference This reference describes the semantics of Arvados resources and how to programatically access Arvados via its REST API. Each resource listed in this section is exposed on the Arvados API server under the @/arvados/v1/@ path prefix, for example, @https://{{ site.arvados_api_host }}/arvados/v1/collections@. +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. Workbench examples + Many Arvados Workbench pages, under the the *Advanced* tab, provide examples of API and SDK use for accessing the current resource . diff --git a/doc/api/storage.html.textile.liquid b/doc/api/storage.html.textile.liquid index f70ecc2fdf..c03a456b67 100644 --- a/doc/api/storage.html.textile.liquid +++ b/doc/api/storage.html.textile.liquid @@ -29,11 +29,11 @@ h2. Keep server API The Keep server is accessed via a simple HTTP REST API. -*GET /blockidentifier+size+A@token* +*GET /blocklocator+size+A@token* Fetch the data block, if the token is valid. -*PUT /blockidentifier* +*PUT /blocklocator* Returns the md5 sum of the data along with the signed token. -- 2.30.2