Merge branch '1943-client-sdk-config-files'

[arvados.git] / services / api / app / controllers / arvados / v1 / schema_controller.rb

diff --git a/services/api/app/controllers/arvados/v1/schema_controller.rb b/services/api/app/controllers/arvados/v1/schema_controller.rb
index 96e432388739531b47680447e286dfd3fc5912a7..e57ca52081969ed31aaf07109eafd83e9bfe455d 100644 (file)
--- a/services/api/app/controllers/arvados/v1/schema_controller.rb
+++ b/services/api/app/controllers/arvados/v1/schema_controller.rb
@@ -189,7 +189,28 @@ class Arvados::V1::SchemaController < ApplicationController
               id: "arvados.#{k.to_s.underscore.pluralize}.list",
               path: k.to_s.underscore.pluralize,
               httpMethod: "GET",
-              description: "List #{k.to_s.underscore.pluralize}.",
+              description:
+                 %|List #{k.to_s.pluralize}.
+
+                   The <code>list</code> method returns a 
+                   <a href="/api/resources.html">resource list</a> of
+                   matching #{k.to_s.pluralize}. For example:
+
+                   <pre>
+                   {
+                    "kind":"arvados##{k.to_s.camelcase(:lower)}List",
+                    "etag":"",
+                    "self_link":"",
+                    "next_page_token":"",
+                    "next_link":"",
+                    "items":[
+                       ...
+                    ],
+                    "items_available":745,
+                    "_profile":{
+                     "request_time":0.157236317
+                    }
+                    </pre>|,
               parameters: {
                 limit: {
                   type: "integer",
@@ -197,17 +218,7 @@ class Arvados::V1::SchemaController < ApplicationController
                   default: 100,
                   format: "int32",
                   minimum: 0,
-                  location: "query"
-                },
-                pageToken: {
-                  type: "string",
-                  description: "Page token.",
-                  location: "query"
-                },
-                q: {
-                  type: "string",
-                  description: "Query string for searching #{k.to_s.underscore.pluralize}.",
-                  location: "query"
+                  location: "query",
                 },
                 where: {
                   type: "object",