Project

General

Profile

Actions

Feature #5863

closed

API documentation updates

Added by Abram Connelly almost 9 years ago. Updated about 4 years ago.

Status:
Closed
Priority:
Normal
Assigned To:
-
Category:
-
Target version:
-
Story points:
-

Description

The Arvados API documentation is difficult to understand. Here are a two points that I think would help things:

  • Give an example usage for each of the API methods, directly under each of the operations (create, delete, get, etc.). Just as a random example, the jq documentation has the operation along with a collapsible 'example' directly under it giving a concrete example of how it's used, what it's input is and what it's output is expected to be.
  • Clearly differentiate between the 'index', 'list', 'search', and 'get' functions. From the REST methods section the first three ('index', 'list' and 'search') are lumped together. Are they synonyms? Or should they specifically be passed into the query? Why do some API methods have a 'get'? Is this another synonym for 'search'?
Actions #1

Updated by Peter Amstutz about 4 years ago

  • Status changed from New to Closed
Actions

Also available in: Atom PDF