Skip to content
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

v1: update permission services docstrings #32

Merged
merged 3 commits into from
May 6, 2022

Conversation

jzelinskie
Copy link
Member

This clarifies the atomicity of WriteRelationships and runs the other comments through a grammar check.

@jzelinskie jzelinskie requested a review from josephschorr May 6, 2022 21:30
// with an optional set of precondition relationships that must exist before
// the operation can commit.
// WriteRelationships atomically writes and/or deletes a set of specified
// relationships with an optional set of precondition relationships that
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add a comma before with

// the operation can commit.
// WriteRelationships atomically writes and/or deletes a set of specified
// relationships with an optional set of precondition relationships that
// must be satisfied before the operation can commit.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for the operation to commit

// DeleteRelationships deletes relationships matching one or more filters, in
// bulk.
// DeleteRelationships atomically bulk deletes relationships matching one or
// more filters with an optional set of preconditions that must be satisfied
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

comma before with

@@ -43,8 +44,8 @@ service PermissionsService {
};
}

// CheckPermission checks whether a subject has a particular permission or is
// a member of a particular relation, on a given resource.
// CheckPermission determines for a given reason whether a subject computes
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

given resource

// CheckPermission checks whether a subject has a particular permission or is
// a member of a particular relation, on a given resource.
// CheckPermission determines for a given reason whether a subject computes
// to having permission or is a direct member of a particular relation.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

having a permission

This clarifies the atomicity of WriteRelationships and runs the other
comments through a grammar check.
Copy link
Member

@josephschorr josephschorr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jzelinskie jzelinskie merged commit 414df81 into authzed:main May 6, 2022
@jzelinskie jzelinskie deleted the atomic-write branch May 6, 2022 21:49
@github-actions github-actions bot locked and limited conversation to collaborators May 6, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants