package authzed.api.v0

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc EditCheck (EditCheckRequest, EditCheckResponse)

  developer.proto:10

  message EditCheckRequest

  developer.proto:72

  • optional RequestContext context = 1

  • repeated RelationTuple check_relationships = 2

  message EditCheckResponse

  developer.proto:83

  • repeated DeveloperError request_errors = 1

  • repeated EditCheckResult check_results = 2

• rpc FormatSchema (FormatSchemaRequest, FormatSchemaResponse)

  developer.proto:15

  message FormatSchemaRequest

  developer.proto:18

  • string schema = 1

  message FormatSchemaResponse

  developer.proto:22

  • optional DeveloperError error = 1

  • string formatted_schema = 2

• rpc LookupShared (LookupShareRequest, LookupShareResponse)

  developer.proto:13

  message LookupShareRequest

  developer.proto:47

  • string share_reference = 1

  message LookupShareResponse

  developer.proto:51

  • LookupShareResponse.LookupStatus status = 1

  • string schema = 2

  • string relationships_yaml = 3

  • string validation_yaml = 4

  • string assertions_yaml = 5

• rpc Share (ShareRequest, ShareResponse)

  developer.proto:12

  message ShareRequest

  developer.proto:36

  • string schema = 1

  • string relationships_yaml = 2

  • string validation_yaml = 3

  • string assertions_yaml = 4

  message ShareResponse

  developer.proto:43

  • string share_reference = 1

• rpc UpgradeSchema (UpgradeSchemaRequest, UpgradeSchemaResponse)

  developer.proto:14

  message UpgradeSchemaRequest

  developer.proto:27

  • repeated string namespace_configs = 1

  message UpgradeSchemaResponse

  developer.proto:31

  • optional DeveloperError error = 1

  • string upgraded_schema = 2

• rpc Validate (ValidateRequest, ValidateResponse)

  developer.proto:11

  message ValidateRequest

  developer.proto:88

  • optional RequestContext context = 1

  • string validation_yaml = 3

  • bool update_validation_yaml = 4

  • string assertions_yaml = 5

  message ValidateResponse

  developer.proto:95

  • repeated DeveloperError request_errors = 1

  • repeated DeveloperError validation_errors = 2

  • string updated_validation_yaml = 3

Used in: EditCheckResponse, EditCheckResult, FormatSchemaResponse, UpgradeSchemaResponse, ValidateResponse

• string message = 1

• uint32 line = 2

• uint32 column = 3

• DeveloperError.Source source = 4

• DeveloperError.ErrorKind kind = 5

• repeated string path = 6

• string context = 7

  context holds the context for the error. For schema issues, this will be the name of the object type. For relationship issues, the full relationship string.

Used in: DeveloperError

• UNKNOWN_KIND = 0

• PARSE_ERROR = 1

• SCHEMA_ISSUE = 2

• DUPLICATE_RELATIONSHIP = 3

• MISSING_EXPECTED_RELATIONSHIP = 4

• EXTRA_RELATIONSHIP_FOUND = 5

• UNKNOWN_OBJECT_TYPE = 6

• UNKNOWN_RELATION = 7

• MAXIMUM_RECURSION = 8

• ASSERTION_FAILED = 9

Used in: DeveloperError

• UNKNOWN_SOURCE = 0

• SCHEMA = 1

• RELATIONSHIP = 2

• VALIDATION_YAML = 3

• CHECK_WATCH = 4

• ASSERTION = 5

Used in: EditCheckResponse

• optional RelationTuple relationship = 1

• bool is_member = 2

• optional DeveloperError error = 3

Used in: LookupShareResponse

• UNKNOWN_REFERENCE = 0

• FAILED_TO_LOOKUP = 1

• VALID_REFERENCE = 2

• UPGRADED_REFERENCE = 3

Used in: RelationTuple, User

• string namespace = 1

• string object_id = 2

• string relation = 3

• string namespace = 1

• string relation = 3

Used in: EditCheckRequest, EditCheckResult, RequestContext

• optional ObjectAndRelation object_and_relation = 1

  Each tupleset specifies keys of a set of relation tuples. The set can include a single tuple key, or all tuples with a given object ID or userset in a namespace, optionally constrained by a relation name. examples: doc:readme#viewer@group:eng#member (fully specified) doc:*#*#group:eng#member (all tuples that this userset relates to) doc:12345#*#* (all tuples with a direct relationship to a document) doc:12345#writer#* (all tuples with direct write relationship with the document) doc:#writer#group:eng#member (all tuples that eng group has write relationship)

• optional User user = 2

Used in: EditCheckRequest, ValidateRequest

• string schema = 1

• repeated RelationTuple relationships = 2

Used in: RelationTuple

• oneof user_oneof

  • ObjectAndRelation userset = 2