Skip to content

Commit

Permalink
BatchCheck description update
Browse files Browse the repository at this point in the history
  • Loading branch information
justincoh committed Oct 10, 2024
1 parent 2093098 commit 268cf8c
Show file tree
Hide file tree
Showing 3 changed files with 913 additions and 908 deletions.
4 changes: 2 additions & 2 deletions docs/openapiv2/apidocs.swagger.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 6 additions & 5 deletions openfga/v1/openfga_service.proto
Original file line number Diff line number Diff line change
Expand Up @@ -334,17 +334,18 @@ service OpenFGAService {
};

option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
summary: "Send multiple `check` operations in a single request"
summary: "Send a list of `check` operations in a single request"
tags: ["Relationship Queries"]
operation_id: "BatchCheck"
description:
"The `BatchCheck` API functions nearly identically to `Check`, but instead of checking a single "
"user-object relationship BatchCheck accepts a list of relationships to check, and returns a list with an "
"individual response for each check it received.\n\n"
"user-object relationship BatchCheck accepts a list of relationships to check and returns a list containing responses "
"for each check it received.\n\n"
"Like `Check`, you can specify `contextual_tuples` and `context` with each individual tuple to be checked. Unlike check, however, "
"`BatchCheck` also accepts `contextual_tuples` and `context` at the request level. If `contextual_tuples` or `context` are received "
"at the request level, those contexts will be used when evaluating each check in the batch. If an individual check within the batch "
"has its own `contextual_tuples` or `context`, they will be applied **in addition to** the request-level values."
"at the request level, those contexts will taken into account when evaluating each check in the batch. If an individual check within the batch "
"has its own `contextual_tuples` or `context`, they will be applied **in addition to** the request-level values.\n\n"
"For more details on how `Check` functions, see the docs for `/check`."
};
}

Expand Down
Loading

0 comments on commit 268cf8c

Please sign in to comment.