[ARVADOS] updated: 2.1.0-1356-gbc146037e
Git user
git at public.arvados.org
Mon Sep 20 13:46:22 UTC 2021
Summary of changes:
doc/api/methods.html.textile.liquid | 2 +-
doc/api/methods/collections.html.textile.liquid | 4 ++--
.../api/app/controllers/application_controller.rb | 24 ++++++++++++++++++----
3 files changed, 23 insertions(+), 7 deletions(-)
via bc146037e1aa617739c0a3859727066c9304829a (commit)
via 39dfcf8276631692c696578f6667d5e36006784d (commit)
via 2f077222cb7ba575817a1bcfbbeb6916d3de109a (commit)
from 7563e6276baade41eb3faa3ff167abab1cb0f890 (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
commit bc146037e1aa617739c0a3859727066c9304829a
Author: Tom Clegg <tom at curii.com>
Date: Mon Sep 20 09:44:58 2021 -0400
18122: Clarify select param behavior in "get collection by pdh" API.
Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tom at curii.com>
diff --git a/doc/api/methods/collections.html.textile.liquid b/doc/api/methods/collections.html.textile.liquid
index 6c1cc691c..01efda2b0 100644
--- a/doc/api/methods/collections.html.textile.liquid
+++ b/doc/api/methods/collections.html.textile.liquid
@@ -85,13 +85,13 @@ table(table table-bordered table-condensed).
h3. get
-Gets a Collection's metadata by UUID or portable data hash. When making a request by portable data hash, the returned record will only have the @portable_data_hash@ and @manifest_text at .
+Gets a Collection's metadata by UUID or portable data hash. When making a request by portable data hash, attributes other than @portable_data_hash@ and @manifest_text@ are not returned, even when requested explicitly using the @select@ parameter.
Arguments:
table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
-{background:#ccffcc}.|uuid|string|The UUID of the Collection in question.|path||
+{background:#ccffcc}.|uuid|string|The UUID or portable data hash of the Collection in question.|path||
h3. list
commit 39dfcf8276631692c696578f6667d5e36006784d
Author: Tom Clegg <tom at curii.com>
Date: Mon Sep 20 09:37:53 2021 -0400
18122: Add descriptions for select params in discovery doc.
Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tom at curii.com>
diff --git a/services/api/app/controllers/application_controller.rb b/services/api/app/controllers/application_controller.rb
index f986e88cd..ff4cb88ae 100644
--- a/services/api/app/controllers/application_controller.rb
+++ b/services/api/app/controllers/application_controller.rb
@@ -619,7 +619,11 @@ class ApplicationController < ActionController::Base
def self._create_requires_parameters
{
- select: { type: 'array', required: false },
+ select: {
+ type: 'array',
+ description: "Attributes of the new object to return in the response.",
+ required: false,
+ },
ensure_unique_name: {
type: "boolean",
description: "Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.",
@@ -638,13 +642,21 @@ class ApplicationController < ActionController::Base
def self._update_requires_parameters
{
- select: { type: 'array', required: false },
+ select: {
+ type: 'array',
+ description: "Attributes of the updated object to return in the response.",
+ required: false,
+ },
}
end
def self._show_requires_parameters
{
- select: { type: 'array', required: false },
+ select: {
+ type: 'array',
+ description: "Attributes of the object to return in the response.",
+ required: false,
+ },
}
end
@@ -653,7 +665,11 @@ class ApplicationController < ActionController::Base
filters: { type: 'array', required: false },
where: { type: 'object', required: false },
order: { type: 'array', required: false },
- select: { type: 'array', required: false },
+ select: {
+ type: 'array',
+ description: "Attributes of each object to return in the response.",
+ required: false,
+ },
distinct: { type: 'boolean', required: false, default: false },
limit: { type: 'integer', required: false, default: DEFAULT_LIMIT },
offset: { type: 'integer', required: false, default: 0 },
commit 2f077222cb7ba575817a1bcfbbeb6916d3de109a
Author: Tom Clegg <tom at curii.com>
Date: Mon Sep 20 09:34:35 2021 -0400
18122: Fix stutter in docs.
Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tom at curii.com>
diff --git a/doc/api/methods.html.textile.liquid b/doc/api/methods.html.textile.liquid
index dea80fea8..7f05142db 100644
--- a/doc/api/methods.html.textile.liquid
+++ b/doc/api/methods.html.textile.liquid
@@ -84,7 +84,7 @@ Example: @["head_uuid asc","modified_at desc"]@
Default: @["modified_at desc", "uuid asc"]@|query|
|select |array |Attributes of each object to return in the response (by default, all available attributes are returned, except collections, which do not return @manifest_text@ unless explicitly selected).
Example: @["uuid","name","modified_at"]@|query|
-|distinct|boolean|When returning multiple records whose whose selected attributes (see @select@) are equal, return them as a single response entry.
+|distinct|boolean|When returning multiple records whose selected attributes (see @select@) are equal, return them as a single response entry.
Default is @false at .|query|
|count|string|@"exact"@ (default): Include an @items_available@ response field giving the number of distinct matching items that can be retrieved (irrespective of @limit@ and @offset@ arguments).
@"none"@: Omit the @items_available@ response field. This option will produce a faster response.|query|
-----------------------------------------------------------------------
hooks/post-receive
--
More information about the arvados-commits
mailing list