Description for start_time attribute improved

openfga · Oct 16, 2024 · 68b614c · 68b614c
1 parent 8a98f94
commit 68b614c
Show file tree

Hide file tree

Showing 3 changed files with 1,752 additions and 1,738 deletions.
diff --git a/docs/openapiv2/apidocs.swagger.json b/docs/openapiv2/apidocs.swagger.json
diff --git a/openfga/v1/openfga_service.proto b/openfga/v1/openfga_service.proto
@@ -1423,7 +1423,10 @@ message ReadChangesRequest {
     json_name = "start_time",
     (validate.rules).timestamp.lt_now = true,
     (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
-      description: "The start time of the changes to read."
+      description:
+        "Start date and time of changes to read.\n"
+        "Format: ISO 8601 timestamp (e.g., 2022-01-01T00:00:00Z)\n"
+        "If a continuation token is provided, its value will be used in case it's timestamp is greater than the specified start time."
       example: "2021-01-01T00:00:00.000Z"
     }
   ];