-
Notifications
You must be signed in to change notification settings - Fork 45
fix grammar #328
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
fix grammar #328
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,8 +4,6 @@ import { Callout } from 'nextra/components' | |
|
|
||
| Within a Permissions System, a [CheckPermission] call is always made between an object representing the *resource* and an object representing a *subject*: The API call returns whether the *subject* has the specified permission on the *resource*. | ||
|
|
||
| The choice of how to represent subjects can have large downstream effects on the design of a permissions system. | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This message is repeated in line 21 |
||
|
|
||
| [CheckPermission]: https://buf.build/authzed/api/docs/main:authzed.api.v1#CheckPermission | ||
|
|
||
| ## Representing users as subjects | ||
|
|
@@ -34,7 +32,7 @@ As the `sub` field is **guaranteed** to be stable for that particular user (if a | |
|
|
||
| <Callout type="info"> | ||
|
|
||
| If you have *multiple* authentication provides, then the recommendation is to define a subject type for *each* provider, to ensure a clean namespace: | ||
| If you have *multiple* authentication providers, then the recommendation is to define a subject type for *each* provider, to ensure a clean namespace: | ||
|
|
||
| ```zed | ||
| /** githubuser represents a user from GitHub */ | ||
|
|
@@ -67,7 +65,7 @@ Some databases allow various sequences to reuse IDs. | |
|
|
||
| <Callout type="warning"> | ||
|
|
||
| It is typically **not recommended** to use an e-mail address to represent a user as as a subject in SpiceDB. | ||
| It is typically **not recommended** to use an e-mail address to represent a user as a subject in SpiceDB. | ||
|
|
||
| </Callout> | ||
|
|
||
|
|
||
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -60,7 +60,7 @@ assertFalse: [] | |
| #### Caveat Context In Assertions | ||
|
|
||
| <Callout type="info"> | ||
| In order to escape JSON representation of the caveat context in an assertion you should use single-quotes | ||
| In order to escape JSON representation of the caveat context in an assertion you should use single-quotes. | ||
| </Callout> | ||
|
|
||
| You can provide caveat context as part of an assertion: | ||
|
|
@@ -155,9 +155,7 @@ Request tracing information by setting `with_tracing: true` in the request messa | |
|
|
||
| <Callout type="warning"> | ||
| **Warning:** | ||
| Versions older than v1.31.0 | ||
|
|
||
| Request tracing information via a header and the information will be found in the response footer as JSON. | ||
| In versions older than v1.31.0, request tracing information via a header and the information will be found in the response footer as JSON. | ||
| </Callout> | ||
|
|
||
| ## Zed | ||
|
|
@@ -242,7 +240,9 @@ true | |
| └── [38;5;99muser:fred [0m | ||
| ``` | ||
|
|
||
| This command will also highlight which parts of the traversal were cached and if a cycle is detected. | ||
| This command will also highlight which parts of the traversal were cached and if a [cycle] is detected. | ||
|
|
||
| [cycle]: ./recursion-and-max-depth#recursion-in-relationships | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 👍 |
||
|
|
||
| [tracing header]: #checkpermission-tracing-header | ||
|
|
||
|
|
||
This file contains hidden or 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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've never seen inlined-triple-backtick. does it differ from single backtick?
I guess you're cribbing from what's around it 🤔