#
k8s_openapi/v1_35/apiextensions_apiserver/pkg/apis/apiextensions/v1/
validation_rule.rs

    1// Generated from definition io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.ValidationRule
    2
    3/// ValidationRule describes a validation rule written in the CEL expression language.
    4#[derive(Clone, Debug, Default, PartialEq)]
    5pub struct ValidationRule {
    6    /// fieldPath represents the field path returned when the validation fails. It must be a relative JSON path (i.e. with array notation) scoped to the location of this x-kubernetes-validations extension in the schema and refer to an existing field. e.g. when validation checks if a specific attribute `foo` under a map `testMap`, the fieldPath could be set to `.testMap.foo` If the validation checks two lists must have unique attributes, the fieldPath could be set to either of the list: e.g. `.testList` It does not support list numeric index. It supports child operation to refer to an existing field currently. Refer to \[JSONPath support in Kubernetes\](https://kubernetes.io/docs/reference/kubectl/jsonpath/) for more info. Numeric index of array is not supported. For field name which contains special characters, use `\['specialName'\]` to refer the field name. e.g. for attribute `foo.34$` appears in a list `testList`, the fieldPath could be set to `.testList\['foo.34$'\]`
    7    pub field_path: Option<std::string::String>,
    8
    9    /// Message represents the message displayed when validation fails. The message is required if the Rule contains line breaks. The message must not contain line breaks. If unset, the message is "failed rule: {Rule}". e.g. "must be a URL with the host matching spec.host"
    10    pub message: Option<std::string::String>,
    11
    12    /// MessageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails. Since messageExpression is used as a failure message, it must evaluate to a string. If both message and messageExpression are present on a rule, then messageExpression will be used if validation fails. If messageExpression results in a runtime error, the runtime error is logged, and the validation failure message is produced as if the messageExpression field were unset. If messageExpression evaluates to an empty string, a string with only spaces, or a string that contains line breaks, then the validation failure message will also be produced as if the messageExpression field were unset, and the fact that messageExpression produced an empty string/string with only spaces/string with line breaks will be logged. messageExpression has access to all the same variables as the rule; the only difference is the return type. Example: "x must be less than max ("+string(self.max)+")"
    13    pub message_expression: Option<std::string::String>,
    14
    15    /// optionalOldSelf is used to opt a transition rule into evaluation even when the object is first created, or if the old object is missing the value.
    16    ///
    17    /// When enabled `oldSelf` will be a CEL optional whose value will be `None` if there is no old value, or when the object is initially created.
    18    ///
    19    /// You may check for presence of oldSelf using `oldSelf.hasValue()` and unwrap it after checking using `oldSelf.value()`. Check the CEL documentation for Optional types for more information: https://pkg.go.dev/github.com/google/cel-go/cel#OptionalTypes
    20    ///
    21    /// May not be set unless `oldSelf` is used in `rule`.
    22    pub optional_old_self: Option<bool>,
    23
    24    /// reason provides a machine-readable validation failure reason that is returned to the caller when a request fails this validation rule. The HTTP status code returned to the caller will match the reason of the reason of the first failed validation rule. The currently supported reasons are: "FieldValueInvalid", "FieldValueForbidden", "FieldValueRequired", "FieldValueDuplicate". If not set, default to use "FieldValueInvalid". All future added reasons must be accepted by clients when reading this value and unknown reasons should be treated as FieldValueInvalid.
    25    pub reason: Option<std::string::String>,
    26
    27    /// Rule represents the expression which will be evaluated by CEL. ref: https://github.com/google/cel-spec The Rule is scoped to the location of the x-kubernetes-validations extension in the schema. The `self` variable in the CEL expression is bound to the scoped value. Example: - Rule scoped to the root of a resource with a status subresource: {"rule": "self.status.actual \<= self.spec.maxDesired"}
    28    ///
    29    /// If the Rule is scoped to an object with properties, the accessible properties of the object are field selectable via `self.field` and field presence can be checked via `has(self.field)`. Null valued fields are treated as absent fields in CEL expressions. If the Rule is scoped to an object with additionalProperties (i.e. a map) the value of the map are accessible via `self\[mapKey\]`, map containment can be checked via `mapKey in self` and all entries of the map are accessible via CEL macros and functions such as `self.all(...)`. If the Rule is scoped to an array, the elements of the array are accessible via `self\[i\]` and also by macros and functions. If the Rule is scoped to a scalar, `self` is bound to the scalar value. Examples: - Rule scoped to a map of objects: {"rule": "self.components\['Widget'\].priority \< 10"} - Rule scoped to a list of integers: {"rule": "self.values.all(value, value \>= 0 && value \< 100)"} - Rule scoped to a string value: {"rule": "self.startsWith('kube')"}
    30    ///
    31    /// The `apiVersion`, `kind`, `metadata.name` and `metadata.generateName` are always accessible from the root of the object and from any x-kubernetes-embedded-resource annotated objects. No other metadata properties are accessible.
    32    ///
    33    /// Unknown data preserved in custom resources via x-kubernetes-preserve-unknown-fields is not accessible in CEL expressions. This includes: - Unknown field values that are preserved by object schemas with x-kubernetes-preserve-unknown-fields. - Object properties where the property schema is of an "unknown type". An "unknown type" is recursively defined as:
    34    ///   - A schema with no type and x-kubernetes-preserve-unknown-fields set to true
    35    ///   - An array where the items schema is of an "unknown type"
    36    ///   - An object where the additionalProperties schema is of an "unknown type"
    37    ///
    38    /// Only property names of the form `\[a-zA-Z_.-/\]\[a-zA-Z0-9_.-/\]*` are accessible. Accessible property names are escaped according to the following rules when accessed in the expression: - '__' escapes to '__underscores__' - '.' escapes to '__dot__' - '-' escapes to '__dash__' - '/' escapes to '__slash__' - Property names that exactly match a CEL RESERVED keyword escape to '__{keyword}__'. The keywords are:
    39    ///       "true", "false", "null", "in", "as", "break", "const", "continue", "else", "for", "function", "if",
    40    ///       "import", "let", "loop", "package", "namespace", "return".
    41    /// Examples:
    42    ///   - Rule accessing a property named "namespace": {"rule": "self.__namespace__ \> 0"}
    43    ///   - Rule accessing a property named "x-prop": {"rule": "self.x__dash__prop \> 0"}
    44    ///   - Rule accessing a property named "redact__d": {"rule": "self.redact__underscores__d \> 0"}
    45    ///
    46    /// Equality on arrays with x-kubernetes-list-type of 'set' or 'map' ignores element order, i.e. \[1, 2\] == \[2, 1\]. Concatenation on arrays with x-kubernetes-list-type use the semantics of the list type:
    47    ///   - 'set': `X + Y` performs a union where the array positions of all elements in `X` are preserved and
    48    ///     non-intersecting elements in `Y` are appended, retaining their partial order.
    49    ///   - 'map': `X + Y` performs a merge where the array positions of all keys in `X` are preserved but the values
    50    ///     are overwritten by values in `Y` when the key sets of `X` and `Y` intersect. Elements in `Y` with
    51    ///     non-intersecting keys are appended, retaining their partial order.
    52    ///
    53    /// If `rule` makes use of the `oldSelf` variable it is implicitly a `transition rule`.
    54    ///
    55    /// By default, the `oldSelf` variable is the same type as `self`. When `optionalOldSelf` is true, the `oldSelf` variable is a CEL optional
    56    ///  variable whose value() is the same type as `self`.
    57    /// See the documentation for the `optionalOldSelf` field for details.
    58    ///
    59    /// Transition rules by default are applied only on UPDATE requests and are skipped if an old value could not be found. You can opt a transition rule into unconditional evaluation by setting `optionalOldSelf` to true.
    60    pub rule: std::string::String,
    61}
    62
    63impl crate::DeepMerge for ValidationRule {
    64    fn merge_from(&mut self, other: Self) {
    65        crate::DeepMerge::merge_from(&mut self.field_path, other.field_path);
    66        crate::DeepMerge::merge_from(&mut self.message, other.message);
    67        crate::DeepMerge::merge_from(&mut self.message_expression, other.message_expression);
    68        crate::DeepMerge::merge_from(&mut self.optional_old_self, other.optional_old_self);
    69        crate::DeepMerge::merge_from(&mut self.reason, other.reason);
    70        crate::DeepMerge::merge_from(&mut self.rule, other.rule);
    71    }
    72}
    73
    74impl<'de> crate::serde::Deserialize<'de> for ValidationRule {
    75    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where D: crate::serde::Deserializer<'de> {
    76        #[allow(non_camel_case_types)]
    77        enum Field {
    78            Key_field_path,
    79            Key_message,
    80            Key_message_expression,
    81            Key_optional_old_self,
    82            Key_reason,
    83            Key_rule,
    84            Other,
    85        }
    86
    87        impl<'de> crate::serde::Deserialize<'de> for Field {
    88            fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where D: crate::serde::Deserializer<'de> {
    89                struct Visitor;
    90
    91                impl crate::serde::de::Visitor<'_> for Visitor {
    92                    type Value = Field;
    93
    94                    fn expecting(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
    95                        f.write_str("field identifier")
    96                    }
    97
    98                    fn visit_str<E>(self, v: &str) -> Result<Self::Value, E> where E: crate::serde::de::Error {
    99                        Ok(match v {
    100                            "fieldPath" => Field::Key_field_path,
    101                            "message" => Field::Key_message,
    102                            "messageExpression" => Field::Key_message_expression,
    103                            "optionalOldSelf" => Field::Key_optional_old_self,
    104                            "reason" => Field::Key_reason,
    105                            "rule" => Field::Key_rule,
    106                            _ => Field::Other,
    107                        })
    108                    }
    109                }
    110
    111                deserializer.deserialize_identifier(Visitor)
    112            }
    113        }
    114
    115        struct Visitor;
    116
    117        impl<'de> crate::serde::de::Visitor<'de> for Visitor {
    118            type Value = ValidationRule;
    119
    120            fn expecting(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
    121                f.write_str("ValidationRule")
    122            }
    123
    124            fn visit_map<A>(self, mut map: A) -> Result<Self::Value, A::Error> where A: crate::serde::de::MapAccess<'de> {
    125                let mut value_field_path: Option<std::string::String> = None;
    126                let mut value_message: Option<std::string::String> = None;
    127                let mut value_message_expression: Option<std::string::String> = None;
    128                let mut value_optional_old_self: Option<bool> = None;
    129                let mut value_reason: Option<std::string::String> = None;
    130                let mut value_rule: Option<std::string::String> = None;
    131
    132                while let Some(key) = crate::serde::de::MapAccess::next_key::<Field>(&mut map)? {
    133                    match key {
    134                        Field::Key_field_path => value_field_path = crate::serde::de::MapAccess::next_value(&mut map)?,
    135                        Field::Key_message => value_message = crate::serde::de::MapAccess::next_value(&mut map)?,
    136                        Field::Key_message_expression => value_message_expression = crate::serde::de::MapAccess::next_value(&mut map)?,
    137                        Field::Key_optional_old_self => value_optional_old_self = crate::serde::de::MapAccess::next_value(&mut map)?,
    138                        Field::Key_reason => value_reason = crate::serde::de::MapAccess::next_value(&mut map)?,
    139                        Field::Key_rule => value_rule = crate::serde::de::MapAccess::next_value(&mut map)?,
    140                        Field::Other => { let _: crate::serde::de::IgnoredAny = crate::serde::de::MapAccess::next_value(&mut map)?; },
    141                    }
    142                }
    143
    144                Ok(ValidationRule {
    145                    field_path: value_field_path,
    146                    message: value_message,
    147                    message_expression: value_message_expression,
    148                    optional_old_self: value_optional_old_self,
    149                    reason: value_reason,
    150                    rule: value_rule.unwrap_or_default(),
    151                })
    152            }
    153        }
    154
    155        deserializer.deserialize_struct(
    156            "ValidationRule",
    157            &[
    158                "fieldPath",
    159                "message",
    160                "messageExpression",
    161                "optionalOldSelf",
    162                "reason",
    163                "rule",
    164            ],
    165            Visitor,
    166        )
    167    }
    168}
    169
    170impl crate::serde::Serialize for ValidationRule {
    171    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where S: crate::serde::Serializer {
    172        let mut state = serializer.serialize_struct(
    173            "ValidationRule",
    174            1 +
    175            self.field_path.as_ref().map_or(0, |_| 1) +
    176            self.message.as_ref().map_or(0, |_| 1) +
    177            self.message_expression.as_ref().map_or(0, |_| 1) +
    178            self.optional_old_self.as_ref().map_or(0, |_| 1) +
    179            self.reason.as_ref().map_or(0, |_| 1),
    180        )?;
    181        if let Some(value) = &self.field_path {
    182            crate::serde::ser::SerializeStruct::serialize_field(&mut state, "fieldPath", value)?;
    183        }
    184        if let Some(value) = &self.message {
    185            crate::serde::ser::SerializeStruct::serialize_field(&mut state, "message", value)?;
    186        }
    187        if let Some(value) = &self.message_expression {
    188            crate::serde::ser::SerializeStruct::serialize_field(&mut state, "messageExpression", value)?;
    189        }
    190        if let Some(value) = &self.optional_old_self {
    191            crate::serde::ser::SerializeStruct::serialize_field(&mut state, "optionalOldSelf", value)?;
    192        }
    193        if let Some(value) = &self.reason {
    194            crate::serde::ser::SerializeStruct::serialize_field(&mut state, "reason", value)?;
    195        }
    196        crate::serde::ser::SerializeStruct::serialize_field(&mut state, "rule", &self.rule)?;
    197        crate::serde::ser::SerializeStruct::end(state)
    198    }
    199}
    200
    201#[cfg(feature = "schemars")]
    202impl crate::schemars::JsonSchema for ValidationRule {
    203    fn schema_name() -> std::borrow::Cow<'static, str> {
    204        "io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.ValidationRule".into()
    205    }
    206
    207    fn json_schema(__gen: &mut crate::schemars::SchemaGenerator) -> crate::schemars::Schema {
    208        crate::schemars::json_schema!({
    209            "description": "ValidationRule describes a validation rule written in the CEL expression language.",
    210            "type": "object",
    211            "properties": {
    212                "fieldPath": {
    213                    "description": "fieldPath represents the field path returned when the validation fails. It must be a relative JSON path (i.e. with array notation) scoped to the location of this x-kubernetes-validations extension in the schema and refer to an existing field. e.g. when validation checks if a specific attribute `foo` under a map `testMap`, the fieldPath could be set to `.testMap.foo` If the validation checks two lists must have unique attributes, the fieldPath could be set to either of the list: e.g. `.testList` It does not support list numeric index. It supports child operation to refer to an existing field currently. Refer to [JSONPath support in Kubernetes](https://kubernetes.io/docs/reference/kubectl/jsonpath/) for more info. Numeric index of array is not supported. For field name which contains special characters, use `['specialName']` to refer the field name. e.g. for attribute `foo.34$` appears in a list `testList`, the fieldPath could be set to `.testList['foo.34$']`",
    214                    "type": "string",
    215                },
    216                "message": {
    217                    "description": "Message represents the message displayed when validation fails. The message is required if the Rule contains line breaks. The message must not contain line breaks. If unset, the message is \"failed rule: {Rule}\". e.g. \"must be a URL with the host matching spec.host\"",
    218                    "type": "string",
    219                },
    220                "messageExpression": {
    221                    "description": "MessageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails. Since messageExpression is used as a failure message, it must evaluate to a string. If both message and messageExpression are present on a rule, then messageExpression will be used if validation fails. If messageExpression results in a runtime error, the runtime error is logged, and the validation failure message is produced as if the messageExpression field were unset. If messageExpression evaluates to an empty string, a string with only spaces, or a string that contains line breaks, then the validation failure message will also be produced as if the messageExpression field were unset, and the fact that messageExpression produced an empty string/string with only spaces/string with line breaks will be logged. messageExpression has access to all the same variables as the rule; the only difference is the return type. Example: \"x must be less than max (\"+string(self.max)+\")\"",
    222                    "type": "string",
    223                },
    224                "optionalOldSelf": {
    225                    "description": "optionalOldSelf is used to opt a transition rule into evaluation even when the object is first created, or if the old object is missing the value.\n\nWhen enabled `oldSelf` will be a CEL optional whose value will be `None` if there is no old value, or when the object is initially created.\n\nYou may check for presence of oldSelf using `oldSelf.hasValue()` and unwrap it after checking using `oldSelf.value()`. Check the CEL documentation for Optional types for more information: https://pkg.go.dev/github.com/google/cel-go/cel#OptionalTypes\n\nMay not be set unless `oldSelf` is used in `rule`.",
    226                    "type": "boolean",
    227                },
    228                "reason": {
    229                    "description": "reason provides a machine-readable validation failure reason that is returned to the caller when a request fails this validation rule. The HTTP status code returned to the caller will match the reason of the reason of the first failed validation rule. The currently supported reasons are: \"FieldValueInvalid\", \"FieldValueForbidden\", \"FieldValueRequired\", \"FieldValueDuplicate\". If not set, default to use \"FieldValueInvalid\". All future added reasons must be accepted by clients when reading this value and unknown reasons should be treated as FieldValueInvalid.",
    230                    "type": "string",
    231                },
    232                "rule": {
    233                    "description": "Rule represents the expression which will be evaluated by CEL. ref: https://github.com/google/cel-spec The Rule is scoped to the location of the x-kubernetes-validations extension in the schema. The `self` variable in the CEL expression is bound to the scoped value. Example: - Rule scoped to the root of a resource with a status subresource: {\"rule\": \"self.status.actual <= self.spec.maxDesired\"}\n\nIf the Rule is scoped to an object with properties, the accessible properties of the object are field selectable via `self.field` and field presence can be checked via `has(self.field)`. Null valued fields are treated as absent fields in CEL expressions. If the Rule is scoped to an object with additionalProperties (i.e. a map) the value of the map are accessible via `self[mapKey]`, map containment can be checked via `mapKey in self` and all entries of the map are accessible via CEL macros and functions such as `self.all(...)`. If the Rule is scoped to an array, the elements of the array are accessible via `self[i]` and also by macros and functions. If the Rule is scoped to a scalar, `self` is bound to the scalar value. Examples: - Rule scoped to a map of objects: {\"rule\": \"self.components['Widget'].priority < 10\"} - Rule scoped to a list of integers: {\"rule\": \"self.values.all(value, value >= 0 && value < 100)\"} - Rule scoped to a string value: {\"rule\": \"self.startsWith('kube')\"}\n\nThe `apiVersion`, `kind`, `metadata.name` and `metadata.generateName` are always accessible from the root of the object and from any x-kubernetes-embedded-resource annotated objects. No other metadata properties are accessible.\n\nUnknown data preserved in custom resources via x-kubernetes-preserve-unknown-fields is not accessible in CEL expressions. This includes: - Unknown field values that are preserved by object schemas with x-kubernetes-preserve-unknown-fields. - Object properties where the property schema is of an \"unknown type\". An \"unknown type\" is recursively defined as:\n  - A schema with no type and x-kubernetes-preserve-unknown-fields set to true\n  - An array where the items schema is of an \"unknown type\"\n  - An object where the additionalProperties schema is of an \"unknown type\"\n\nOnly property names of the form `[a-zA-Z_.-/][a-zA-Z0-9_.-/]*` are accessible. Accessible property names are escaped according to the following rules when accessed in the expression: - '__' escapes to '__underscores__' - '.' escapes to '__dot__' - '-' escapes to '__dash__' - '/' escapes to '__slash__' - Property names that exactly match a CEL RESERVED keyword escape to '__{keyword}__'. The keywords are:\n\t  \"true\", \"false\", \"null\", \"in\", \"as\", \"break\", \"const\", \"continue\", \"else\", \"for\", \"function\", \"if\",\n\t  \"import\", \"let\", \"loop\", \"package\", \"namespace\", \"return\".\nExamples:\n  - Rule accessing a property named \"namespace\": {\"rule\": \"self.__namespace__ > 0\"}\n  - Rule accessing a property named \"x-prop\": {\"rule\": \"self.x__dash__prop > 0\"}\n  - Rule accessing a property named \"redact__d\": {\"rule\": \"self.redact__underscores__d > 0\"}\n\nEquality on arrays with x-kubernetes-list-type of 'set' or 'map' ignores element order, i.e. [1, 2] == [2, 1]. Concatenation on arrays with x-kubernetes-list-type use the semantics of the list type:\n  - 'set': `X + Y` performs a union where the array positions of all elements in `X` are preserved and\n    non-intersecting elements in `Y` are appended, retaining their partial order.\n  - 'map': `X + Y` performs a merge where the array positions of all keys in `X` are preserved but the values\n    are overwritten by values in `Y` when the key sets of `X` and `Y` intersect. Elements in `Y` with\n    non-intersecting keys are appended, retaining their partial order.\n\nIf `rule` makes use of the `oldSelf` variable it is implicitly a `transition rule`.\n\nBy default, the `oldSelf` variable is the same type as `self`. When `optionalOldSelf` is true, the `oldSelf` variable is a CEL optional\n variable whose value() is the same type as `self`.\nSee the documentation for the `optionalOldSelf` field for details.\n\nTransition rules by default are applied only on UPDATE requests and are skipped if an old value could not be found. You can opt a transition rule into unconditional evaluation by setting `optionalOldSelf` to true.",
    234                    "type": "string",
    235                },
    236            },
    237            "required": [
    238                "rule",
    239            ],
    240        })
    241    }
    242}