Add documentation for using contextual tuples in Expand API #209
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
sujitha-av
force-pushed
the
documentation-expand-api
branch
from
c683e13
to
027c2c2
Compare
4 tasks
|
@sujitha-av please |
miparnisari
reviewed
Nov 4, 2024
openfga/v1/openfga_service.proto
Outdated
| @@ -390,6 +391,116 @@ service OpenFGAService { | |||
| "}\n" | |||
| "```\n" | |||
| "The caller can then call expand API for the `writer` relationship for the `document:2021-budget`." | |||
There was a problem hiding this comment.
Suggested change
| "The caller can then call expand API for the `writer` relationship for the `document:2021-budget`." | |
| "The caller can then call expand API for the `writer` relationship for the `document:2021-budget`.\n" |
otherwise, formatting is incorrect:
miparnisari
reviewed
Nov 4, 2024
openfga/v1/openfga_service.proto
Outdated
| " \"object\": \"folder:1\",\n" | ||
| " \"relation\": \"owner\"\n" | ||
| " },\n" | ||
| " \"authorization_model_id\": \"model_id\"\n" |
miparnisari
reviewed
Nov 4, 2024
openfga/v1/openfga_service.proto
Outdated
| " }\n" | ||
| " ]\n" | ||
| " },\n" | ||
| " \"authorization_model_id\": \"model_id\"\n" |
sujitha-av
force-pushed
the
documentation-expand-api
branch
from
027c2c2
to
b5e432b
Compare
|
Is a separate documentation PR needed for openfga.dev? As far as I checked there is not particular documentation for usage of contextual tuples with each of the request types. I can proceed if it is required. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adds documentation on use of contextual tuples with Expand API
References
#951 in openfga
Review Checklist
main