From 52059aab9c65a9cbdff0b8d379ab8b0a25f62880 Mon Sep 17 00:00:00 2001 From: Tom Clegg Date: Tue, 12 Mar 2024 17:48:18 -0400 Subject: [PATCH] 21123: Clarify empty means empty string. Arvados-DCO-1.1-Signed-off-by: Tom Clegg --- doc/api/dispatch.html.textile.liquid | 2 +- doc/api/methods/container_requests.html.textile.liquid | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/api/dispatch.html.textile.liquid b/doc/api/dispatch.html.textile.liquid index 488545c7d4..7a916f0646 100644 --- a/doc/api/dispatch.html.textile.liquid +++ b/doc/api/dispatch.html.textile.liquid @@ -32,7 +32,7 @@ Return a list of containers that are either ready to dispatch, or being started/ Each entry in the returned list of @items@ includes: * an @instance_type@ entry with the name and attributes of the instance type that will be used to schedule the container (chosen from the @InstanceTypes@ section of your cluster config file); and * a @container@ entry with selected attributes of the container itself, including @uuid@, @priority@, @runtime_constraints@, and @state@. Other fields of the container records are not loaded by the dispatcher, and will have empty/zero values here (e.g., @{...,"created_at":"0001-01-01T00:00:00Z","command":[],...}@). -* a @scheduling_status@ entry: a brief explanation of the container's status in the dispatch queue, or empty if scheduling is not applicable, e.g., the container has already started running. +* a @scheduling_status@ field with a brief explanation of the container's status in the dispatch queue, or the empty string if scheduling is not applicable, e.g., the container has already started running. Example response: diff --git a/doc/api/methods/container_requests.html.textile.liquid b/doc/api/methods/container_requests.html.textile.liquid index 770b56b697..130aa73c05 100644 --- a/doc/api/methods/container_requests.html.textile.liquid +++ b/doc/api/methods/container_requests.html.textile.liquid @@ -240,7 +240,7 @@ table(table table-bordered table-condensed). |_. Attribute|_. Type|_. Description|_. Examples| |uuid|string|The UUID of the container assigned to this request.|| |state|string|The state of the container assigned to this request (see "container resource attributes":containers.html).|| -|scheduling_status|string|A brief explanation of the container's status in the dispatch queue. Empty if scheduling is not applicable, e.g., the container is running or finished.|@waiting for cloud resources: queue position 3@ +|scheduling_status|string|A brief explanation of the container's status in the dispatch queue, or the empty string if scheduling is not applicable, e.g., the container is running or finished.|@waiting for cloud resources: queue position 3@ @creating new instance@ @preparing runtime environment@| -- 2.30.2