Project

General

Profile

Actions

Feature #12917

closed

Support ?include=container_uuid for group contents

Added by Bryan Cosca over 6 years ago. Updated 18 days ago.

Status:
Resolved
Priority:
Normal
Assigned To:
Category:
API
Story points:
-

Description

Users should be able to see the exit code or state=[“Queued”, “Locked”, “Running”, “Cancelled” and “Complete”] from the container_request api method, rather than having to go another layer deeper to the container api method.

Proposed solution

Expand the existing "include" option to the group contents method to support "container_uuid".

include=container_uuid includes the contents of the record associated with container_uuid in the "includes" list.

A query like this would return:

?include=container_uuid

{
  "items": [
    {
      "kind": "arvados#container_request",
      "uuid": "abc-123",
      "container_uuid": "xyz-123" 
      ...
    }
  ],
  "includes": [
    {
      "uuid": "xyz-123",
      "state": "Completed",
      "exit_code": 0,
      ...
    }
  ]
}

This should support field selection similarly to how it works for group contents, e.g. select=["containers.uuid", "containers.state"]

The "include" query parameter needs to support either a string (for a single thing being included) or a json list (if there are multiple things being included, e.g. include=["owner_uuid", "container_uuid"])


Subtasks 1 (0 open1 closed)

Task #13355: Review 12917-group-contents-include-containerResolvedStephen Smith05/24/2024Actions

Related issues

Related to Arvados Workbench 2 - Bug #15672: List of subprocesses limited in process viewResolvedLucas Di PentimaActions
Has duplicate Arvados - Idea #13145: Include container status & exit code in container request responseDuplicateActions
Blocks Arvados - Feature #13327: More responsive page loads with API ?include=container_uuidNewStephen SmithActions
Actions

Also available in: Atom PDF