Skip to content

Commit fef35d4

Browse files
Google APIscopybara-github
authored andcommitted
docs: explicitly document empty list and search responses
PiperOrigin-RevId: 439957204
1 parent 1a8770e commit fef35d4

1 file changed

Lines changed: 10 additions & 2 deletions

File tree

google/maps/fleetengine/delivery/v1/delivery_api.proto

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -222,6 +222,9 @@ message ListDeliveryVehiclesRequest {
222222
// The `ListDeliveryVehicles` response message.
223223
message ListDeliveryVehiclesResponse {
224224
// The set of delivery vehicles that meet the requested filtering criteria.
225+
// When no filter is specified, the request returns all delivery vehicles. A
226+
// successful response can also be empty. An empty response indicates that no
227+
// delivery vehicles were found meeting the requested filter criteria.
225228
repeated DeliveryVehicle delivery_vehicles = 1;
226229

227230
// You can pass this token in the `ListDeliveryVehiclesRequest` to continue to
@@ -329,7 +332,9 @@ message SearchTasksRequest {
329332
// The `SearchTasks` response. It contains the set of Tasks that meet the search
330333
// criteria in the `SearchTasksRequest`.
331334
message SearchTasksResponse {
332-
// The set of Tasks for the requested `tracking_id`.
335+
// The set of Tasks for the requested `tracking_id`. A successful response can
336+
// also be empty. An empty response indicates that no Tasks are associated
337+
// with the supplied `tracking_id`.
333338
repeated Task tasks = 1;
334339

335340
// Pass this token in the `SearchTasksRequest` to continue to
@@ -405,7 +410,10 @@ message ListTasksRequest {
405410
// The `ListTasks` response that contains the set of Tasks that meet the filter
406411
// criteria in the `ListTasksRequest`.
407412
message ListTasksResponse {
408-
// The set of Tasks that meet the requested filtering criteria.
413+
// The set of Tasks that meet the requested filtering criteria. When no filter
414+
// is specified, the request returns all tasks. A successful response can also
415+
// be empty. An empty response indicates that no Tasks were found meeting the
416+
// requested filter criteria.
409417
repeated Task tasks = 1;
410418

411419
// Pass this token in the `ListTasksRequest` to continue to list results.

0 commit comments

Comments
 (0)