k8s_openapi/v1_33/api/admissionregistration/v1alpha1/
json_patch.rs

Help
1// Generated from definition io.k8s.api.admissionregistration.v1alpha1.JSONPatch
2
3/// JSONPatch defines a JSON Patch.
4#[derive(Clone, Debug, Default, PartialEq)]
5pub struct JSONPatch {
6    /// expression will be evaluated by CEL to create a \[JSON patch\](https://jsonpatch.com/). ref: https://github.com/google/cel-spec
7    ///
8    /// expression must return an array of JSONPatch values.
9    ///
10    /// For example, this CEL expression returns a JSON patch to conditionally modify a value:
11    ///
12    ///   \[
13    ///         JSONPatch{op: "test", path: "/spec/example", value: "Red"},
14    ///         JSONPatch{op: "replace", path: "/spec/example", value: "Green"}
15    ///       \]
16    ///
17    /// To define an object for the patch value, use Object types. For example:
18    ///
19    ///   \[
20    ///         JSONPatch{
21    ///           op: "add",
22    ///           path: "/spec/selector",
23    ///           value: Object.spec.selector{matchLabels: {"environment": "test"}}
24    ///         }
25    ///       \]
26    ///
27    /// To use strings containing '/' and '~' as JSONPatch path keys, use "jsonpatch.escapeKey". For example:
28    ///
29    ///   \[
30    ///         JSONPatch{
31    ///           op: "add",
32    ///           path: "/metadata/labels/" + jsonpatch.escapeKey("example.com/environment"),
33    ///           value: "test"
34    ///         },
35    ///       \]
36    ///
37    /// CEL expressions have access to the types needed to create JSON patches and objects:
38    ///
39    /// - 'JSONPatch' - CEL type of JSON Patch operations. JSONPatch has the fields 'op', 'from', 'path' and 'value'.
40    ///   See \[JSON patch\](https://jsonpatch.com/) for more details. The 'value' field may be set to any of: string,
41    ///   integer, array, map or object.  If set, the 'path' and 'from' fields must be set to a
42    ///   \[JSON pointer\](https://datatracker.ietf.org/doc/html/rfc6901/) string, where the 'jsonpatch.escapeKey()' CEL
43    ///   function may be used to escape path keys containing '/' and '~'.
44    /// - 'Object' - CEL type of the resource object. - 'Object.\<fieldName\>' - CEL type of object field (such as 'Object.spec') - 'Object.\<fieldName1\>.\<fieldName2\>...\<fieldNameN\>` - CEL type of nested field (such as 'Object.spec.containers')
45    ///
46    /// CEL expressions have access to the contents of the API request, organized into CEL variables as well as some other useful variables:
47    ///
48    /// - 'object' - The object from the incoming request. The value is null for DELETE requests. - 'oldObject' - The existing object. The value is null for CREATE requests. - 'request' - Attributes of the API request(\[ref\](/pkg/apis/admission/types.go#AdmissionRequest)). - 'params' - Parameter resource referred to by the policy binding being evaluated. Only populated if the policy has a ParamKind. - 'namespaceObject' - The namespace object that the incoming object belongs to. The value is null for cluster-scoped resources. - 'variables' - Map of composited variables, from its name to its lazily evaluated value.
49    ///   For example, a variable named 'foo' can be accessed as 'variables.foo'.
50    /// - 'authorizer' - A CEL Authorizer. May be used to perform authorization checks for the principal (user or service account) of the request.
51    ///   See https://pkg.go.dev/k8s.io/apiserver/pkg/cel/library#Authz
52    /// - 'authorizer.requestResource' - A CEL ResourceCheck constructed from the 'authorizer' and configured with the
53    ///   request resource.
54    ///
55    /// CEL expressions have access to \[Kubernetes CEL function libraries\](https://kubernetes.io/docs/reference/using-api/cel/#cel-options-language-features-and-libraries) as well as:
56    ///
57    /// - 'jsonpatch.escapeKey' - Performs JSONPatch key escaping. '~' and  '/' are escaped as '~0' and `~1' respectively).
58    ///
59    /// Only property names of the form `\[a-zA-Z_.-/\]\[a-zA-Z0-9_.-/\]*` are accessible. Required.
60    pub expression: Option<std::string::String>,
61}
62
63impl crate::DeepMerge for JSONPatch {
64    fn merge_from(&mut self, other: Self) {
65        crate::DeepMerge::merge_from(&mut self.expression, other.expression);
66    }
67}
68
69impl<'de> crate::serde::Deserialize<'de> for JSONPatch {
70    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where D: crate::serde::Deserializer<'de> {
71        #[allow(non_camel_case_types)]
72        enum Field {
73            Key_expression,
74            Other,
75        }
76
77        impl<'de> crate::serde::Deserialize<'de> for Field {
78            fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where D: crate::serde::Deserializer<'de> {
79                struct Visitor;
80
81                impl crate::serde::de::Visitor<'_> for Visitor {
82                    type Value = Field;
83
84                    fn expecting(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
85                        f.write_str("field identifier")
86                    }
87
88                    fn visit_str<E>(self, v: &str) -> Result<Self::Value, E> where E: crate::serde::de::Error {
89                        Ok(match v {
90                            "expression" => Field::Key_expression,
91                            _ => Field::Other,
92                        })
93                    }
94                }
95
96                deserializer.deserialize_identifier(Visitor)
97            }
98        }
99
100        struct Visitor;
101
102        impl<'de> crate::serde::de::Visitor<'de> for Visitor {
103            type Value = JSONPatch;
104
105            fn expecting(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
106                f.write_str("JSONPatch")
107            }
108
109            fn visit_map<A>(self, mut map: A) -> Result<Self::Value, A::Error> where A: crate::serde::de::MapAccess<'de> {
110                let mut value_expression: Option<std::string::String> = None;
111
112                while let Some(key) = crate::serde::de::MapAccess::next_key::<Field>(&mut map)? {
113                    match key {
114                        Field::Key_expression => value_expression = crate::serde::de::MapAccess::next_value(&mut map)?,
115                        Field::Other => { let _: crate::serde::de::IgnoredAny = crate::serde::de::MapAccess::next_value(&mut map)?; },
116                    }
117                }
118
119                Ok(JSONPatch {
120                    expression: value_expression,
121                })
122            }
123        }
124
125        deserializer.deserialize_struct(
126            "JSONPatch",
127            &[
128                "expression",
129            ],
130            Visitor,
131        )
132    }
133}
134
135impl crate::serde::Serialize for JSONPatch {
136    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where S: crate::serde::Serializer {
137        let mut state = serializer.serialize_struct(
138            "JSONPatch",
139            self.expression.as_ref().map_or(0, |_| 1),
140        )?;
141        if let Some(value) = &self.expression {
142            crate::serde::ser::SerializeStruct::serialize_field(&mut state, "expression", value)?;
143        }
144        crate::serde::ser::SerializeStruct::end(state)
145    }
146}
147
148#[cfg(feature = "schemars")]
149impl crate::schemars::JsonSchema for JSONPatch {
150    fn schema_name() -> std::string::String {
151        "io.k8s.api.admissionregistration.v1alpha1.JSONPatch".into()
152    }
153
154    fn json_schema(__gen: &mut crate::schemars::gen::SchemaGenerator) -> crate::schemars::schema::Schema {
155        crate::schemars::schema::Schema::Object(crate::schemars::schema::SchemaObject {
156            metadata: Some(std::boxed::Box::new(crate::schemars::schema::Metadata {
157                description: Some("JSONPatch defines a JSON Patch.".into()),
158                ..Default::default()
159            })),
160            instance_type: Some(crate::schemars::schema::SingleOrVec::Single(std::boxed::Box::new(crate::schemars::schema::InstanceType::Object))),
161            object: Some(std::boxed::Box::new(crate::schemars::schema::ObjectValidation {
162                properties: [
163                    (
164                        "expression".into(),
165                        crate::schemars::schema::Schema::Object(crate::schemars::schema::SchemaObject {
166                            metadata: Some(std::boxed::Box::new(crate::schemars::schema::Metadata {
167                                description: Some("expression will be evaluated by CEL to create a [JSON patch](https://jsonpatch.com/). ref: https://github.com/google/cel-spec\n\nexpression must return an array of JSONPatch values.\n\nFor example, this CEL expression returns a JSON patch to conditionally modify a value:\n\n\t  [\n\t    JSONPatch{op: \"test\", path: \"/spec/example\", value: \"Red\"},\n\t    JSONPatch{op: \"replace\", path: \"/spec/example\", value: \"Green\"}\n\t  ]\n\nTo define an object for the patch value, use Object types. For example:\n\n\t  [\n\t    JSONPatch{\n\t      op: \"add\",\n\t      path: \"/spec/selector\",\n\t      value: Object.spec.selector{matchLabels: {\"environment\": \"test\"}}\n\t    }\n\t  ]\n\nTo use strings containing '/' and '~' as JSONPatch path keys, use \"jsonpatch.escapeKey\". For example:\n\n\t  [\n\t    JSONPatch{\n\t      op: \"add\",\n\t      path: \"/metadata/labels/\" + jsonpatch.escapeKey(\"example.com/environment\"),\n\t      value: \"test\"\n\t    },\n\t  ]\n\nCEL expressions have access to the types needed to create JSON patches and objects:\n\n- 'JSONPatch' - CEL type of JSON Patch operations. JSONPatch has the fields 'op', 'from', 'path' and 'value'.\n  See [JSON patch](https://jsonpatch.com/) for more details. The 'value' field may be set to any of: string,\n  integer, array, map or object.  If set, the 'path' and 'from' fields must be set to a\n  [JSON pointer](https://datatracker.ietf.org/doc/html/rfc6901/) string, where the 'jsonpatch.escapeKey()' CEL\n  function may be used to escape path keys containing '/' and '~'.\n- 'Object' - CEL type of the resource object. - 'Object.<fieldName>' - CEL type of object field (such as 'Object.spec') - 'Object.<fieldName1>.<fieldName2>...<fieldNameN>` - CEL type of nested field (such as 'Object.spec.containers')\n\nCEL expressions have access to the contents of the API request, organized into CEL variables as well as some other useful variables:\n\n- 'object' - The object from the incoming request. The value is null for DELETE requests. - 'oldObject' - The existing object. The value is null for CREATE requests. - 'request' - Attributes of the API request([ref](/pkg/apis/admission/types.go#AdmissionRequest)). - 'params' - Parameter resource referred to by the policy binding being evaluated. Only populated if the policy has a ParamKind. - 'namespaceObject' - The namespace object that the incoming object belongs to. The value is null for cluster-scoped resources. - 'variables' - Map of composited variables, from its name to its lazily evaluated value.\n  For example, a variable named 'foo' can be accessed as 'variables.foo'.\n- 'authorizer' - A CEL Authorizer. May be used to perform authorization checks for the principal (user or service account) of the request.\n  See https://pkg.go.dev/k8s.io/apiserver/pkg/cel/library#Authz\n- 'authorizer.requestResource' - A CEL ResourceCheck constructed from the 'authorizer' and configured with the\n  request resource.\n\nCEL expressions have access to [Kubernetes CEL function libraries](https://kubernetes.io/docs/reference/using-api/cel/#cel-options-language-features-and-libraries) as well as:\n\n- 'jsonpatch.escapeKey' - Performs JSONPatch key escaping. '~' and  '/' are escaped as '~0' and `~1' respectively).\n\nOnly property names of the form `[a-zA-Z_.-/][a-zA-Z0-9_.-/]*` are accessible. Required.".into()),
168                                ..Default::default()
169                            })),
170                            instance_type: Some(crate::schemars::schema::SingleOrVec::Single(std::boxed::Box::new(crate::schemars::schema::InstanceType::String))),
171                            ..Default::default()
172                        }),
173                    ),
174                ].into(),
175                ..Default::default()
176            })),
177            ..Default::default()
178        })
179    }
180}
k8s_openapi/v1_33/api/admissionregistration/v1alpha1/json_patch.rs

k8s_openapi/v1_33/api/admissionregistration/v1alpha1/
json_patch.rs
