fix: also add description for continuation token

openfga · Jul 10, 2023 · bca39aa · bca39aa
1 parent 220189b
commit bca39aa
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 8 deletions.
diff --git a/docs/openapiv2/apidocs.swagger.json b/docs/openapiv2/apidocs.swagger.json
@@ -1316,7 +1316,8 @@
  },
  "continuation_token": {
  "type": "string",
- "example": "eyJwayI6IkxBVEVTVF9OU0NPTkZJR19hdXRoMHN0b3JlIiwic2siOiIxem1qbXF3MWZLZExTcUoyN01MdTdqTjh0cWgifQ=="
+ "example": "eyJwayI6IkxBVEVTVF9OU0NPTkZJR19hdXRoMHN0b3JlIiwic2siOiIxem1qbXF3MWZLZExTcUoyN01MdTdqTjh0cWgifQ==",
+ "description": "The continuation token will be empty if there are no more stores."
  }
  }
  },
@@ -1432,7 +1433,8 @@
  },
  "continuation_token": {
  "type": "string",
- "example": "eyJwayI6IkxBVEVTVF9OU0NPTkZJR19hdXRoMHN0b3JlIiwic2siOiIxem1qbXF3MWZLZExTcUoyN01MdTdqTjh0cWgifQ=="
+ "example": "eyJwayI6IkxBVEVTVF9OU0NPTkZJR19hdXRoMHN0b3JlIiwic2siOiIxem1qbXF3MWZLZExTcUoyN01MdTdqTjh0cWgifQ==",
+ "description": "The continuation token will be empty if there are no more models."
  }
  }
  },
@@ -1447,7 +1449,8 @@
  },
  "continuation_token": {
  "type": "string",
- "example": "eyJwayI6IkxBVEVTVF9OU0NPTkZJR19hdXRoMHN0b3JlIiwic2siOiIxem1qbXF3MWZLZExTcUoyN01MdTdqTjh0cWgifQ=="
+ "example": "eyJwayI6IkxBVEVTVF9OU0NPTkZJR19hdXRoMHN0b3JlIiwic2siOiIxem1qbXF3MWZLZExTcUoyN01MdTdqTjh0cWgifQ==",
+ "description": "The continuation token will be identical if there are no new changes."
  }
  }
  },
@@ -1462,7 +1465,8 @@
  },
  "continuation_token": {
  "type": "string",
- "example": "eyJwayI6IkxBVEVTVF9OU0NPTkZJR19hdXRoMHN0b3JlIiwic2siOiIxem1qbXF3MWZLZExTcUoyN01MdTdqTjh0cWgifQ=="
+ "example": "eyJwayI6IkxBVEVTVF9OU0NPTkZJR19hdXRoMHN0b3JlIiwic2siOiIxem1qbXF3MWZLZExTcUoyN01MdTdqTjh0cWgifQ==",
+ "description": "The continuation token will be empty if there are no more tuples."
  }
  }
  },

diff --git a/openfga/v1/openfga_service.proto b/openfga/v1/openfga_service.proto
@@ -809,7 +809,10 @@ message ReadResponse {
  string continuation_token = 2 [
  json_name = "continuation_token",
  (validate.rules).string.max_bytes = 5120,
- (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {example: "\"eyJwayI6IkxBVEVTVF9OU0NPTkZJR19hdXRoMHN0b3JlIiwic2siOiIxem1qbXF3MWZLZExTcUoyN01MdTdqTjh0cWgifQ==\""}
+ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
+ description: "The continuation token will be empty if there are no more tuples.",
+ example: "\"eyJwayI6IkxBVEVTVF9OU0NPTkZJR19hdXRoMHN0b3JlIiwic2siOiIxem1qbXF3MWZLZExTcUoyN01MdTdqTjh0cWgifQ==\""
+ }
  ];
 }
 
@@ -984,7 +987,10 @@ message ReadAuthorizationModelsResponse {
  string continuation_token = 2 [
  json_name = "continuation_token",
  (validate.rules).string.max_bytes = 5120,
- (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {example: "\"eyJwayI6IkxBVEVTVF9OU0NPTkZJR19hdXRoMHN0b3JlIiwic2siOiIxem1qbXF3MWZLZExTcUoyN01MdTdqTjh0cWgifQ==\""}
+ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
+ description: "The continuation token will be empty if there are no more models.",
+ example: "\"eyJwayI6IkxBVEVTVF9OU0NPTkZJR19hdXRoMHN0b3JlIiwic2siOiIxem1qbXF3MWZLZExTcUoyN01MdTdqTjh0cWgifQ==\""
+ }
  ];
 }
 
@@ -1078,7 +1084,10 @@ message ReadChangesResponse {
  string continuation_token = 2 [
  json_name = "continuation_token",
  (validate.rules).string.max_bytes = 5120,
- (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {example: "\"eyJwayI6IkxBVEVTVF9OU0NPTkZJR19hdXRoMHN0b3JlIiwic2siOiIxem1qbXF3MWZLZExTcUoyN01MdTdqTjh0cWgifQ==\""}
+ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
+ description: "The continuation token will be identical if there are no new changes."
+ example: "\"eyJwayI6IkxBVEVTVF9OU0NPTkZJR19hdXRoMHN0b3JlIiwic2siOiIxem1qbXF3MWZLZExTcUoyN01MdTdqTjh0cWgifQ==\""
+ }
  ];
 }
 
@@ -1166,6 +1175,9 @@ message ListStoresResponse {
  string continuation_token = 2 [
  json_name = "continuation_token",
  (validate.rules).string.max_bytes = 5120,
- (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {example: "\"eyJwayI6IkxBVEVTVF9OU0NPTkZJR19hdXRoMHN0b3JlIiwic2siOiIxem1qbXF3MWZLZExTcUoyN01MdTdqTjh0cWgifQ==\""}
+ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
+ description: "The continuation token will be empty if there are no more stores.",
+ example: "\"eyJwayI6IkxBVEVTVF9OU0NPTkZJR19hdXRoMHN0b3JlIiwic2siOiIxem1qbXF3MWZLZExTcUoyN01MdTdqTjh0cWgifQ==\""
+ }
  ];
 }