From 61ddcaf192e3f39ed8a1242f35bf1b28ff1fe121 Mon Sep 17 00:00:00 2001 From: Tom Clegg Date: Fri, 18 Apr 2014 21:16:36 -0400 Subject: [PATCH] Use "filters" instead of "where" in examples and docs. Remove references to unsupported "q" and "pageToken" parameters. --- doc/api/methods.html.textile.liquid | 9 +++--- ..._client_authorizations.html.textile.liquid | 15 +--------- .../methods/api_clients.html.textile.liquid | 15 +--------- .../authorized_keys.html.textile.liquid | 15 +--------- .../methods/collections.html.textile.liquid | 15 +--------- doc/api/methods/groups.html.textile.liquid | 15 +--------- doc/api/methods/humans.html.textile.liquid | 15 +--------- doc/api/methods/job_tasks.html.textile.liquid | 15 +--------- doc/api/methods/jobs.html.textile.liquid | 17 ++--------- .../methods/keep_disks.html.textile.liquid | 15 +--------- doc/api/methods/links.html.textile.liquid | 16 +---------- doc/api/methods/logs.html.textile.liquid | 15 +--------- doc/api/methods/nodes.html.textile.liquid | 15 +--------- .../pipeline_instances.html.textile.liquid | 15 +--------- .../pipeline_templates.html.textile.liquid | 15 +--------- .../methods/repositories.html.textile.liquid | 15 +--------- doc/api/methods/specimens.html.textile.liquid | 15 +--------- doc/api/methods/traits.html.textile.liquid | 15 +--------- doc/api/methods/users.html.textile.liquid | 15 +--------- .../virtual_machines.html.textile.liquid | 15 +--------- doc/api/schema/Job.html.textile.liquid | 2 +- .../tutorial-trait-search.html.textile.liquid | 28 +++++++++---------- 22 files changed, 39 insertions(+), 288 deletions(-) diff --git a/doc/api/methods.html.textile.liquid b/doc/api/methods.html.textile.liquid index 0110ebbcd7..187ca2640c 100644 --- a/doc/api/methods.html.textile.liquid +++ b/doc/api/methods.html.textile.liquid @@ -13,20 +13,19 @@ title: REST methods h2(#index). Index, list, search 
-GET https://{{ site.arvados_api_host }}/arvados/v1/groups?where[owner_uuid]=xyzzy-tpzed-a4lcehql0dv2u25
+GET https://{{ site.arvados_api_host }}/arvados/v1/groups?filters=[["owner_uuid","=","xyzzy-tpzed-a4lcehql0dv2u25"]]
  
 POST https://{{ site.arvados_api_host }}/arvados/v1/groups
 _method=GET
-where[owner_uuid]=xyzzy-tpzed-a4lcehql0dv2u25
+filters=[["owner_uuid","=","xyzzy-tpzed-a4lcehql0dv2u25"]]
→ Group resource list table(table table-bordered table-condensed). |*Parameter name*|*Value*|*Description*| -|max_results|integer|Maximum number of resources to return| -|page_token|string|| -|where{}|list|Attribute values to search for| +|limit|integer|Maximum number of resources to return| +|filters|array|Conditions for selecting resources to return| h2. Create diff --git a/doc/api/methods/api_client_authorizations.html.textile.liquid b/doc/api/methods/api_client_authorizations.html.textile.liquid index 75ffd3ffbe..b79ba7805c 100644 --- a/doc/api/methods/api_client_authorizations.html.textile.liquid +++ b/doc/api/methods/api_client_authorizations.html.textile.liquid @@ -62,17 +62,6 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | {background:#ccffcc}.|uuid|string|The UUID of the ApiClientAuthorization in question.|path|| -h2. index - -index api_client_authorizations - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -|order|string||query|| -|where|object||query|| - h2. list List api_client_authorizations. @@ -83,9 +72,7 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | |limit|integer (default 100)|Maximum number of api_client_authorizations to return.|query|| |order|string|Order in which to return matching api_client_authorizations.|query|| -|pageToken|string|Page token.|query|| -|q|string|Query string for searching api_client_authorizations.|query|| -|where|object|Conditions for filtering api_client_authorizations.|query|| +|filters|array|Conditions for filtering api_client_authorizations.|query|| h2. show diff --git a/doc/api/methods/api_clients.html.textile.liquid b/doc/api/methods/api_clients.html.textile.liquid index c6b784482c..72c29437cd 100644 --- a/doc/api/methods/api_clients.html.textile.liquid +++ b/doc/api/methods/api_clients.html.textile.liquid @@ -51,17 +51,6 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | {background:#ccffcc}.|uuid|string|The UUID of the ApiClient in question.|path|| -h2. index - -index api_clients - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -|order|string||query|| -|where|object||query|| - h2. list List api_clients. @@ -72,9 +61,7 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | |limit|integer (default 100)|Maximum number of api_clients to return.|query|| |order|string|Order in which to return matching api_clients.|query|| -|pageToken|string|Page token.|query|| -|q|string|Query string for searching api_clients.|query|| -|where|object|Conditions for filtering api_clients.|query|| +|filters|array|Conditions for filtering api_clients.|query|| h2. show diff --git a/doc/api/methods/authorized_keys.html.textile.liquid b/doc/api/methods/authorized_keys.html.textile.liquid index a3cc9e5afa..6f9fb5a40d 100644 --- a/doc/api/methods/authorized_keys.html.textile.liquid +++ b/doc/api/methods/authorized_keys.html.textile.liquid @@ -51,17 +51,6 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | {background:#ccffcc}.|uuid|string|The UUID of the AuthorizedKey in question.|path|| -h2. index - -index authorized_keys - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -|order|string||query|| -|where|object||query|| - h2. list List authorized_keys. @@ -72,9 +61,7 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | |limit|integer (default 100)|Maximum number of authorized_keys to return.|query|| |order|string|Order in which to return matching authorized_keys.|query|| -|pageToken|string|Page token.|query|| -|q|string|Query string for searching authorized_keys.|query|| -|where|object|Conditions for filtering authorized_keys.|query|| +|filters|array|Conditions for filtering authorized_keys.|query|| h2. show diff --git a/doc/api/methods/collections.html.textile.liquid b/doc/api/methods/collections.html.textile.liquid index 6f9d142a47..7f522c9639 100644 --- a/doc/api/methods/collections.html.textile.liquid +++ b/doc/api/methods/collections.html.textile.liquid @@ -51,17 +51,6 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | {background:#ccffcc}.|uuid|string|The UUID of the Collection in question.|path|| -h2. index - -index collections - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -|order|string||query|| -|where|object||query|| - h2. list List collections. @@ -72,9 +61,7 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | |limit|integer (default 100)|Maximum number of collections to return.|query|| |order|string|Order in which to return matching collections.|query|| -|pageToken|string|Page token.|query|| -|q|string|Query string for searching collections.|query|| -|where|object|Conditions for filtering collections.|query|| +|filters|array|Conditions for filtering collections.|query|| h2. show diff --git a/doc/api/methods/groups.html.textile.liquid b/doc/api/methods/groups.html.textile.liquid index e09b8177d5..9aa664d869 100644 --- a/doc/api/methods/groups.html.textile.liquid +++ b/doc/api/methods/groups.html.textile.liquid @@ -51,17 +51,6 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | {background:#ccffcc}.|uuid|string|The UUID of the Group in question.|path|| -h2. index - -index groups - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -|order|string||query|| -|where|object||query|| - h2. list List groups. @@ -72,9 +61,7 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | |limit|integer (default 100)|Maximum number of groups to return.|query|| |order|string|Order in which to return matching groups.|query|| -|pageToken|string|Page token.|query|| -|q|string|Query string for searching groups.|query|| -|where|object|Conditions for filtering groups.|query|| +|filters|array|Conditions for filtering groups.|query|| h2. show diff --git a/doc/api/methods/humans.html.textile.liquid b/doc/api/methods/humans.html.textile.liquid index dd3fcedb83..22cd7fedc9 100644 --- a/doc/api/methods/humans.html.textile.liquid +++ b/doc/api/methods/humans.html.textile.liquid @@ -51,17 +51,6 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | {background:#ccffcc}.|uuid|string|The UUID of the Human in question.|path|| -h2. index - -index humans - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -|order|string||query|| -|where|object||query|| - h2. list List humans. @@ -72,9 +61,7 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | |limit|integer (default 100)|Maximum number of humans to return.|query|| |order|string|Order in which to return matching humans.|query|| -|pageToken|string|Page token.|query|| -|q|string|Query string for searching humans.|query|| -|where|object|Conditions for filtering humans.|query|| +|filters|array|Conditions for filtering humans.|query|| h2. show diff --git a/doc/api/methods/job_tasks.html.textile.liquid b/doc/api/methods/job_tasks.html.textile.liquid index ed3fcfab68..2b2b111a2f 100644 --- a/doc/api/methods/job_tasks.html.textile.liquid +++ b/doc/api/methods/job_tasks.html.textile.liquid @@ -51,17 +51,6 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | {background:#ccffcc}.|uuid|string|The UUID of the JobTask in question.|path|| -h2. index - -index job_tasks - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -|order|string||query|| -|where|object||query|| - h2. list List job_tasks. @@ -72,9 +61,7 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | |limit|integer (default 100)|Maximum number of job_tasks to return.|query|| |order|string|Order in which to return matching job_tasks.|query|| -|pageToken|string|Page token.|query|| -|q|string|Query string for searching job_tasks.|query|| -|where|object|Conditions for filtering job_tasks.|query|| +|filters|array|Conditions for filtering job_tasks.|query|| h2. show diff --git a/doc/api/methods/jobs.html.textile.liquid b/doc/api/methods/jobs.html.textile.liquid index a5a3b475ed..cc2aa2d1d3 100644 --- a/doc/api/methods/jobs.html.textile.liquid +++ b/doc/api/methods/jobs.html.textile.liquid @@ -153,17 +153,6 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | {background:#ccffcc}.|uuid|string|The UUID of the Job in question.|path|| -h2. index - -index jobs - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -|order|string||query|| -|where|object||query|| - h2. list List jobs. @@ -174,9 +163,7 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | |limit|integer (default 100)|Maximum number of jobs to return.|query|| |order|string|Order in which to return matching jobs.|query|| -|pageToken|string|Page token.|query|| -|q|string|Query string for searching jobs.|query|| -|where|object|Conditions for filtering jobs.|query|| +|filters|array|Conditions for filtering jobs.|query|| h2. log_tail_follow @@ -198,7 +185,7 @@ Arguments: table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | |order|string||query|| -|where|object||query|| +|filters|array||query|| h2. show diff --git a/doc/api/methods/keep_disks.html.textile.liquid b/doc/api/methods/keep_disks.html.textile.liquid index 8fa04f544d..15551d2d74 100644 --- a/doc/api/methods/keep_disks.html.textile.liquid +++ b/doc/api/methods/keep_disks.html.textile.liquid @@ -51,17 +51,6 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | {background:#ccffcc}.|uuid|string|The UUID of the KeepDisk in question.|path|| -h2. index - -index keep_disks - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -|order|string||query|| -|where|object||query|| - h2. list List keep_disks. @@ -72,9 +61,7 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | |limit|integer (default 100)|Maximum number of keep_disks to return.|query|| |order|string|Order in which to return matching keep_disks.|query|| -|pageToken|string|Page token.|query|| -|q|string|Query string for searching keep_disks.|query|| -|where|object|Conditions for filtering keep_disks.|query|| +|filters|array|Conditions for filtering keep_disks.|query|| h2. ping diff --git a/doc/api/methods/links.html.textile.liquid b/doc/api/methods/links.html.textile.liquid index 0490bf9bd6..7f04bafd70 100644 --- a/doc/api/methods/links.html.textile.liquid +++ b/doc/api/methods/links.html.textile.liquid @@ -51,18 +51,6 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | {background:#ccffcc}.|uuid|string|The UUID of the Link in question.|path|| -h2. index - -index links - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -{background:#ccffcc}.|tail_uuid|string||path|| -|order|string||query|| -|where|object||query|| - h2. list List links. @@ -73,9 +61,7 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | |limit|integer (default 100)|Maximum number of links to return.|query|| |order|string|Order in which to return matching links.|query|| -|pageToken|string|Page token.|query|| -|q|string|Query string for searching links.|query|| -|where|object|Conditions for filtering links.|query|| +|filters|array|Conditions for filtering links.|query|| h2. render_not_found diff --git a/doc/api/methods/logs.html.textile.liquid b/doc/api/methods/logs.html.textile.liquid index 2a19853755..cdc9f6138e 100644 --- a/doc/api/methods/logs.html.textile.liquid +++ b/doc/api/methods/logs.html.textile.liquid @@ -51,17 +51,6 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | {background:#ccffcc}.|uuid|string|The UUID of the Log in question.|path|| -h2. index - -index logs - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -|order|string||query|| -|where|object||query|| - h2. list List logs. @@ -72,9 +61,7 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | |limit|integer (default 100)|Maximum number of logs to return.|query|| |order|string|Order in which to return matching logs.|query|| -|pageToken|string|Page token.|query|| -|q|string|Query string for searching logs.|query|| -|where|object|Conditions for filtering logs.|query|| +|filters|array|Conditions for filtering logs.|query|| h2. show diff --git a/doc/api/methods/nodes.html.textile.liquid b/doc/api/methods/nodes.html.textile.liquid index f02d50c660..8dc896c47c 100644 --- a/doc/api/methods/nodes.html.textile.liquid +++ b/doc/api/methods/nodes.html.textile.liquid @@ -51,17 +51,6 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | {background:#ccffcc}.|uuid|string|The UUID of the Node in question.|path|| -h2. index - -index nodes - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -|order|string||query|| -|where|object||query|| - h2. list List nodes. @@ -72,9 +61,7 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | |limit|integer (default 100)|Maximum number of nodes to return.|query|| |order|string|Order in which to return matching nodes.|query|| -|pageToken|string|Page token.|query|| -|q|string|Query string for searching nodes.|query|| -|where|object|Conditions for filtering nodes.|query|| +|filters|array|Conditions for filtering nodes.|query|| h2. ping diff --git a/doc/api/methods/pipeline_instances.html.textile.liquid b/doc/api/methods/pipeline_instances.html.textile.liquid index b8431f185e..eb0574a0c6 100644 --- a/doc/api/methods/pipeline_instances.html.textile.liquid +++ b/doc/api/methods/pipeline_instances.html.textile.liquid @@ -51,17 +51,6 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | {background:#ccffcc}.|uuid|string|The UUID of the PipelineInstance in question.|path|| -h2. index - -index pipeline_instances - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -|order|string||query|| -|where|object||query|| - h2. list List pipeline_instances. @@ -72,9 +61,7 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | |limit|integer (default 100)|Maximum number of pipeline_instances to return.|query|| |order|string|Order in which to return matching pipeline_instances.|query|| -|pageToken|string|Page token.|query|| -|q|string|Query string for searching pipeline_instances.|query|| -|where|object|Conditions for filtering pipeline_instances.|query|| +|filters|array|Conditions for filtering pipeline_instances.|query|| h2. show diff --git a/doc/api/methods/pipeline_templates.html.textile.liquid b/doc/api/methods/pipeline_templates.html.textile.liquid index e8ead2433b..5d3c45e7c8 100644 --- a/doc/api/methods/pipeline_templates.html.textile.liquid +++ b/doc/api/methods/pipeline_templates.html.textile.liquid @@ -51,17 +51,6 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | {background:#ccffcc}.|uuid|string|The UUID of the PipelineTemplate in question.|path|| -h2. index - -index pipeline_templates - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -|order|string||query|| -|where|object||query|| - h2. list List pipeline_templates. @@ -72,9 +61,7 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | |limit|integer (default 100)|Maximum number of pipeline_templates to return.|query|| |order|string|Order in which to return matching pipeline_templates.|query|| -|pageToken|string|Page token.|query|| -|q|string|Query string for searching pipeline_templates.|query|| -|where|object|Conditions for filtering pipeline_templates.|query|| +|filters|array|Conditions for filtering pipeline_templates.|query|| h2. show diff --git a/doc/api/methods/repositories.html.textile.liquid b/doc/api/methods/repositories.html.textile.liquid index 501bce7bb6..b5af665412 100644 --- a/doc/api/methods/repositories.html.textile.liquid +++ b/doc/api/methods/repositories.html.textile.liquid @@ -60,17 +60,6 @@ Arguments: table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | -h2. index - -index repositories - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -|order|string||query|| -|where|object||query|| - h2. list List repositories. @@ -81,9 +70,7 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | |limit|integer (default 100)|Maximum number of repositories to return.|query|| |order|string|Order in which to return matching repositories.|query|| -|pageToken|string|Page token.|query|| -|q|string|Query string for searching repositories.|query|| -|where|object|Conditions for filtering repositories.|query|| +|filters|array|Conditions for filtering repositories.|query|| h2. show diff --git a/doc/api/methods/specimens.html.textile.liquid b/doc/api/methods/specimens.html.textile.liquid index 2d7d3c3958..46cbefef8f 100644 --- a/doc/api/methods/specimens.html.textile.liquid +++ b/doc/api/methods/specimens.html.textile.liquid @@ -51,17 +51,6 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | {background:#ccffcc}.|uuid|string|The UUID of the Specimen in question.|path|| -h2. index - -index specimens - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -|order|string||query|| -|where|object||query|| - h2. list List specimens. @@ -72,9 +61,7 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | |limit|integer (default 100)|Maximum number of specimens to return.|query|| |order|string|Order in which to return matching specimens.|query|| -|pageToken|string|Page token.|query|| -|q|string|Query string for searching specimens.|query|| -|where|object|Conditions for filtering specimens.|query|| +|filters|array|Conditions for filtering specimens.|query|| h2. show diff --git a/doc/api/methods/traits.html.textile.liquid b/doc/api/methods/traits.html.textile.liquid index 9b7cb92fd3..968cfb6964 100644 --- a/doc/api/methods/traits.html.textile.liquid +++ b/doc/api/methods/traits.html.textile.liquid @@ -51,17 +51,6 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | {background:#ccffcc}.|uuid|string|The UUID of the Trait in question.|path|| -h2. index - -index traits - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -|order|string||query|| -|where|object||query|| - h2. list List traits. @@ -72,9 +61,7 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | |limit|integer (default 100)|Maximum number of traits to return.|query|| |order|string|Order in which to return matching traits.|query|| -|pageToken|string|Page token.|query|| -|q|string|Query string for searching traits.|query|| -|where|object|Conditions for filtering traits.|query|| +|filters|array|Conditions for filtering traits.|query|| h2. show diff --git a/doc/api/methods/users.html.textile.liquid b/doc/api/methods/users.html.textile.liquid index 649b3685f0..19b7a6c67e 100644 --- a/doc/api/methods/users.html.textile.liquid +++ b/doc/api/methods/users.html.textile.liquid @@ -70,17 +70,6 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | {background:#ccffcc}.|uuid|string|The UUID of the User in question.|path|| -h2. index - -index users - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -|order|string||query|| -|where|object||query|| - h2. list List users. @@ -91,9 +80,7 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | |limit|integer (default 100)|Maximum number of users to return.|query|| |order|string|Order in which to return matching users.|query|| -|pageToken|string|Page token.|query|| -|q|string|Query string for searching users.|query|| -|where|object|Conditions for filtering users.|query|| +|filters|array|Conditions for filtering users.|query|| h2. show diff --git a/doc/api/methods/virtual_machines.html.textile.liquid b/doc/api/methods/virtual_machines.html.textile.liquid index 790519be79..2c3c37d343 100644 --- a/doc/api/methods/virtual_machines.html.textile.liquid +++ b/doc/api/methods/virtual_machines.html.textile.liquid @@ -60,17 +60,6 @@ Arguments: table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | -h2. index - -index virtual_machines - -Arguments: - -table(table table-bordered table-condensed). -|_. Argument |_. Type |_. Description |_. Location |_. Example | -|order|string||query|| -|where|object||query|| - h2. list List virtual_machines. @@ -81,9 +70,7 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | |limit|integer (default 100)|Maximum number of virtual_machines to return.|query|| |order|string|Order in which to return matching virtual_machines.|query|| -|pageToken|string|Page token.|query|| -|q|string|Query string for searching virtual_machines.|query|| -|where|object|Conditions for filtering virtual_machines.|query|| +|filters|array|Conditions for filtering virtual_machines.|query|| h2. logins diff --git a/doc/api/schema/Job.html.textile.liquid b/doc/api/schema/Job.html.textile.liquid index 6d895f9e6f..14ed975f87 100644 --- a/doc/api/schema/Job.html.textile.liquid +++ b/doc/api/schema/Job.html.textile.liquid @@ -26,7 +26,7 @@ GET https://{{ site.arvados_api_host }}/arvados/v1/jobs/queue POST https://{{ site.arvados_api_host }}/arvados/v1/jobs/queue _method=GET -where[owner_uuid]=xyzzy-tpzed-a4lcehql0dv2u25 +filters=[["owner_uuid","=","xyzzy-tpzed-a4lcehql0dv2u25"]] → Job resource list diff --git a/doc/user/topics/tutorial-trait-search.html.textile.liquid b/doc/user/topics/tutorial-trait-search.html.textile.liquid index a79495e377..976f16e3a5 100644 --- a/doc/user/topics/tutorial-trait-search.html.textile.liquid +++ b/doc/user/topics/tutorial-trait-search.html.textile.liquid @@ -88,7 +88,7 @@ The query will return links that match all three conditions. * @arvados.api()@ gets an object that provides access to the Arvados API server * @.links()@ gets an object that provides access to the "links" resource on the Arvados API server -* @.list(limit=1000, where=query)@ constructs a query to elements of the "links" resource that match the criteria discussed above, with a limit of 1000 entries returned +* @.list(limit=1000, filters=trait_filter)@ constructs a query to elements of the "links" resource that match the criteria discussed above, with a limit of 1000 entries returned * @.execute()@ executes the query and returns the result, which we assign to "trait_links" @@ -120,11 +120,11 @@ u'1h9kt-7a9it-t1v8sjz6dm9jmjf', u'1h9kt-7a9it-qe8wrbyvuqs5jew'] h2. Find Personal Genome Project identifiers from Arvados UUIDs -
>>> human_query = {
-    "link_class": "identifier",
-    "head_uuid": human_uuids
-  }
->>> pgpid_links = arvados.api('v1').links().list(limit=1000, where=human_query).execute()
+
>>> human_filters = [
+    ["link_class", "=", "identifier"],
+    ["head_uuid", "in", human_uuids]
+  ]
+>>> pgpid_links = arvados.api('v1').links().list(limit=1000, filters=human_filters).execute()
 >>> map(lambda l: l['name'], pgpid_links['items'])
 [u'hu01024B', u'hu11603C', u'hu15402B', u'hu174334', u'hu1BD549', u'hu237A50',
  u'hu34A921', u'hu397733', u'hu414115', u'hu43860C', u'hu474789', u'hu553620',
@@ -146,11 +146,11 @@ h2. Find genomic data from specific humans
 Now we want to find collections in Keep that were provided by these humans.  We search the "links" resource for "provenance" links that point to subjects in list of humans with the non-melanoma skin cancer trait:
 
 
-
>>> provenance_links = arvados.api().links().list(limit=1000, where={
-    "link_class": "provenance",
-    "name": "provided",
-    "tail_uuid": human_uuids
-  }).execute()
+
>>> provenance_links = arvados.api().links().list(limit=1000, filters=[
+    ["link_class", "=", "provenance"],
+    ["name", "=", "provided"],
+    ["tail_uuid", "in", human_uuids]
+  ]).execute()
 collection_uuids = map(lambda l: l['head_uuid'], provenance_links['items'])
 
 # build map of human uuid -> PGP ID
@@ -163,9 +163,9 @@ for p_link in provenance_links['items']:
   pgpid[p_link['head_uuid']] = pgpid[p_link['tail_uuid']]
 
 # get details (e.g., list of files) of each collection
-collections = arvados.api('v1').collections().list(where={
-    "uuid": collection_uuids
-  }).execute()
+collections = arvados.api('v1').collections().list(filters=[
+    ["uuid", "in", collection_uuids]
+  ]).execute()
 
 # print PGP public profile links with file locators
 for c in collections['items']:
-- 
2.30.2