10346: Add storage to sidebar. Tweak headings.
authorPeter Amstutz <peter.amstutz@curoverse.com>
Thu, 3 Nov 2016 20:00:46 +0000 (16:00 -0400)
committerPeter Amstutz <peter.amstutz@curoverse.com>
Thu, 3 Nov 2016 20:00:46 +0000 (16:00 -0400)
doc/_config.yml
doc/api/index.html.textile.liquid
doc/api/storage.html.textile.liquid

index 2f66fcd6c1129f9ff420b1463e63e88d9050896c..96aea34d36173a07c7952480d1fd59dcf3f90409 100644 (file)
@@ -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
index 9eff786f8b45c863c74bb2e1a3ef7482c657d49a..d90a35efa40d30ae9abdc17611434c42a1c710a4 100644 (file)
@@ -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 .
index f70ecc2fdf7aef504478fc14644457906c13a985..c03a456b6723c392fccc51f83d1b5f5eb9e7f4a4 100644 (file)
@@ -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.