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

Update documentation on the V1 API protos #1

Merged
merged 1 commit into from
Sep 17, 2021

Conversation

josephschorr
Copy link
Member

No description provided.

@jzelinskie jzelinskie added area/docs Affects docs or metadata (e.g. README) area/tooling Affects the dev or user toolchain labels Sep 17, 2021
@@ -8,22 +8,34 @@ import "validate/validate.proto";

Copy link
Member

Choose a reason for hiding this comment

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

Can we rename this file, too? It should be permission_service.proto and not acl_service.proto

Copy link
Member Author

Choose a reason for hiding this comment

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

Will renaming have any effects on the generated code (besides their filenames too)?

Copy link
Member

Choose a reason for hiding this comment

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

no

@@ -48,7 +46,7 @@ message ObjectReference {
}

// ZedToken is used to provide causality metadata between Write and Check
// requests.
// requests. See the Consistency message in acl_service.proto for more information.
Copy link
Member

Choose a reason for hiding this comment

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

I'd move this last sentence onto a separate line and use the fully qualified name:

// ZedToken is used to provide causality metadata between Write and Check
// requests.
//
// See the authzed.api.v1.Consistency message for more information.

authzed/api/v1/acl_service.proto Outdated Show resolved Hide resolved
authzed/api/v1/acl_service.proto Outdated Show resolved Hide resolved
authzed/api/v1/acl_service.proto Outdated Show resolved Hide resolved
authzed/api/v1/acl_service.proto Outdated Show resolved Hide resolved
authzed/api/v1/acl_service.proto Show resolved Hide resolved
@josephschorr
Copy link
Member Author

Updated

Signed-off-by: Joseph Schorr <josephschorr@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Affects docs or metadata (e.g. README) area/tooling Affects the dev or user toolchain
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants