From 545886353f13c2c9bf95b7b84d8fa4aaaf4852f4 Mon Sep 17 00:00:00 2001 From: Stefano Scafiti Date: Fri, 20 Nov 2026 15:20:56 +0100 Subject: [PATCH] docs: over-max LookupResources batch size is rejected, not clamped --- authzed/api/v1/permission_service.proto | 3 +-- docs/apidocs.swagger.json | 2 +- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/authzed/api/v1/permission_service.proto b/authzed/api/v1/permission_service.proto index 960dd29..0013186 100644 --- a/authzed/api/v1/permission_service.proto +++ b/authzed/api/v1/permission_service.proto @@ -783,8 +783,7 @@ message LookupResourcesRequest { // returns initial results sooner. A value around 1000 is a good default. // // The maximum batch size is bounded by a server-side configuration flag; - // requesting more than the server allows is clamped to that maximum rather - // than rejected. + // requesting more than the server allows is rejected. uint32 optional_response_batch_size = 9; } diff --git a/docs/apidocs.swagger.json b/docs/apidocs.swagger.json index 922436f..52a21ac 100644 --- a/docs/apidocs.swagger.json +++ b/docs/apidocs.swagger.json @@ -2319,7 +2319,7 @@ "optionalResponseBatchSize": { "type": "integer", "format": "int64", - "description": "optional_response_batch_size, if non-zero, requests that the server return\nmultiple resources per response message (up to this many) in\nLookupResourcesResponse.batched, instead of a single resource per message.\nZero (the default) preserves one-resource-per-message streaming for\nbackward compatibility.\n\nThe batch size trades time-to-first-result against overall throughput: a\nlarger batch size increases throughput (fewer, larger messages, less\nper-message overhead) but delays the first results, since the server\naccumulates more of them before sending a message; a smaller batch size\nreturns initial results sooner. A value around 1000 is a good default.\n\nThe maximum batch size is bounded by a server-side configuration flag;\nrequesting more than the server allows is clamped to that maximum rather\nthan rejected." + "description": "optional_response_batch_size, if non-zero, requests that the server return\nmultiple resources per response message (up to this many) in\nLookupResourcesResponse.batched, instead of a single resource per message.\nZero (the default) preserves one-resource-per-message streaming for\nbackward compatibility.\n\nThe batch size trades time-to-first-result against overall throughput: a\nlarger batch size increases throughput (fewer, larger messages, less\nper-message overhead) but delays the first results, since the server\naccumulates more of them before sending a message; a smaller batch size\nreturns initial results sooner. A value around 1000 is a good default.\n\nThe maximum batch size is bounded by a server-side configuration flag;\nrequesting more than the server allows is rejected." } }, "description": "LookupResourcesRequest performs a lookup of all resources of a particular\nkind on which the subject has the specified permission or the relation in\nwhich the subject exists, streaming back the IDs of those resources."