|
| 1 | +// Copyright 2023 Buf Technologies, Inc. |
| 2 | +// |
| 3 | +// Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +// you may not use this file except in compliance with the License. |
| 5 | +// You may obtain a copy of the License at |
| 6 | +// |
| 7 | +// http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +// |
| 9 | +// Unless required by applicable law or agreed to in writing, software |
| 10 | +// distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | +// See the License for the specific language governing permissions and |
| 13 | +// limitations under the License. |
| 14 | + |
| 15 | +syntax = "proto3"; |
| 16 | + |
| 17 | +package buf.validate; |
| 18 | + |
| 19 | +option go_package = "buf.build/gen/go/bufbuild/protovalidate/protocolbuffers/go/buf/validate"; |
| 20 | + |
| 21 | +// `Constraint` represents a validation rule written in the Common Expression |
| 22 | +// Language (CEL) syntax. Each Constraint includes a unique identifier, an |
| 23 | +// optional error message, and the CEL expression to evaluate. For more |
| 24 | +// information on CEL, [see our documentation](https://github.com/bufbuild/protovalidate/blob/main/docs/cel.md). |
| 25 | +// |
| 26 | +// ```proto |
| 27 | +// message Foo { |
| 28 | +// option (buf.validate.message).cel = { |
| 29 | +// id: "foo.bar" |
| 30 | +// message: "bar must be greater than 0" |
| 31 | +// expression: "this.bar > 0" |
| 32 | +// }; |
| 33 | +// int32 bar = 1; |
| 34 | +// } |
| 35 | +// ``` |
| 36 | +message Constraint { |
| 37 | + // `id` is a string that serves as a machine-readable name for this Constraint. |
| 38 | + // It should be unique within its scope, which could be either a message or a field. |
| 39 | + string id = 1; |
| 40 | + |
| 41 | + // `message` is an optional field that provides a human-readable error message |
| 42 | + // for this Constraint when the CEL expression evaluates to false. If a |
| 43 | + // non-empty message is provided, any strings resulting from the CEL |
| 44 | + // expression evaluation are ignored. |
| 45 | + string message = 2; |
| 46 | + |
| 47 | + // `expression` is the actual CEL expression that will be evaluated for |
| 48 | + // validation. This string must resolve to either a boolean or a string |
| 49 | + // value. If the expression evaluates to false or a non-empty string, the |
| 50 | + // validation is considered failed, and the message is rejected. |
| 51 | + string expression = 3; |
| 52 | +} |
| 53 | + |
| 54 | +// `Violations` is a collection of `Violation` messages. This message type is returned by |
| 55 | +// protovalidate when a proto message fails to meet the requirements set by the `Constraint` validation rules. |
| 56 | +// Each individual violation is represented by a `Violation` message. |
| 57 | +message Violations { |
| 58 | + // `violations` is a repeated field that contains all the `Violation` messages corresponding to the violations detected. |
| 59 | + repeated Violation violations = 1; |
| 60 | +} |
| 61 | + |
| 62 | +// `Violation` represents a single instance where a validation rule, expressed |
| 63 | +// as a `Constraint`, was not met. It provides information about the field that |
| 64 | +// caused the violation, the specific constraint that wasn't fulfilled, and a |
| 65 | +// human-readable error message. |
| 66 | +// |
| 67 | +// ```json |
| 68 | +// { |
| 69 | +// "fieldPath": "bar", |
| 70 | +// "constraintId": "foo.bar", |
| 71 | +// "message": "bar must be greater than 0" |
| 72 | +// } |
| 73 | +// ``` |
| 74 | +message Violation { |
| 75 | + // `field_path` is a machine-readable identifier that points to the specific field that failed the validation. |
| 76 | + // This could be a nested field, in which case the path will include all the parent fields leading to the actual field that caused the violation. |
| 77 | + string field_path = 1; |
| 78 | + |
| 79 | + // `constraint_id` is the unique identifier of the `Constraint` that was not fulfilled. |
| 80 | + // This is the same `id` that was specified in the `Constraint` message, allowing easy tracing of which rule was violated. |
| 81 | + string constraint_id = 2; |
| 82 | + |
| 83 | + // `message` is a human-readable error message that describes the nature of the violation. |
| 84 | + // This can be the default error message from the violated `Constraint`, or it can be a custom message that gives more context about the violation. |
| 85 | + string message = 3; |
| 86 | + |
| 87 | + // `for_key` indicates whether the violation was caused by a map key, rather than a value. |
| 88 | + bool for_key = 4; |
| 89 | +} |
![app-token-modules[bot]](https://avatars.githubusercontent.com/in/295926?v=4&size=40){kind=avatar}
0 commit comments