k8s_openapi/v1_31/apimachinery/pkg/apis/meta/v1/
api_versions.rs

1// Generated from definition io.k8s.apimachinery.pkg.apis.meta.v1.APIVersions
2
3/// APIVersions lists the versions that are available, to allow clients to discover the API at /api, which is the root path of the legacy v1 API.
4#[derive(Clone, Debug, Default, PartialEq)]
5pub struct APIVersions {
6    /// a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.
7    pub server_address_by_client_cidrs: std::vec::Vec<crate::apimachinery::pkg::apis::meta::v1::ServerAddressByClientCIDR>,
8
9    /// versions are the api versions that are available.
10    pub versions: std::vec::Vec<std::string::String>,
11}
12
13impl crate::Resource for APIVersions {
14    const API_VERSION: &'static str = "v1";
15    const GROUP: &'static str = "";
16    const KIND: &'static str = "APIVersions";
17    const VERSION: &'static str = "v1";
18    const URL_PATH_SEGMENT: &'static str = "";
19    type Scope = crate::ClusterResourceScope;
20}
21
22impl crate::DeepMerge for APIVersions {
23    fn merge_from(&mut self, other: Self) {
24        crate::merge_strategies::list::atomic(&mut self.server_address_by_client_cidrs, other.server_address_by_client_cidrs);
25        crate::merge_strategies::list::atomic(&mut self.versions, other.versions);
26    }
27}
28
29impl<'de> crate::serde::Deserialize<'de> for APIVersions {
30    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where D: crate::serde::Deserializer<'de> {
31        #[allow(non_camel_case_types)]
32        enum Field {
33            Key_api_version,
34            Key_kind,
35            Key_server_address_by_client_cidrs,
36            Key_versions,
37            Other,
38        }
39
40        impl<'de> crate::serde::Deserialize<'de> for Field {
41            fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where D: crate::serde::Deserializer<'de> {
42                struct Visitor;
43
44                impl crate::serde::de::Visitor<'_> for Visitor {
45                    type Value = Field;
46
47                    fn expecting(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
48                        f.write_str("field identifier")
49                    }
50
51                    fn visit_str<E>(self, v: &str) -> Result<Self::Value, E> where E: crate::serde::de::Error {
52                        Ok(match v {
53                            "apiVersion" => Field::Key_api_version,
54                            "kind" => Field::Key_kind,
55                            "serverAddressByClientCIDRs" => Field::Key_server_address_by_client_cidrs,
56                            "versions" => Field::Key_versions,
57                            _ => Field::Other,
58                        })
59                    }
60                }
61
62                deserializer.deserialize_identifier(Visitor)
63            }
64        }
65
66        struct Visitor;
67
68        impl<'de> crate::serde::de::Visitor<'de> for Visitor {
69            type Value = APIVersions;
70
71            fn expecting(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
72                f.write_str(<Self::Value as crate::Resource>::KIND)
73            }
74
75            fn visit_map<A>(self, mut map: A) -> Result<Self::Value, A::Error> where A: crate::serde::de::MapAccess<'de> {
76                let mut value_server_address_by_client_cidrs: Option<std::vec::Vec<crate::apimachinery::pkg::apis::meta::v1::ServerAddressByClientCIDR>> = None;
77                let mut value_versions: Option<std::vec::Vec<std::string::String>> = None;
78
79                while let Some(key) = crate::serde::de::MapAccess::next_key::<Field>(&mut map)? {
80                    match key {
81                        Field::Key_api_version => {
82                            let value_api_version: std::string::String = crate::serde::de::MapAccess::next_value(&mut map)?;
83                            if value_api_version != <Self::Value as crate::Resource>::API_VERSION {
84                                return Err(crate::serde::de::Error::invalid_value(crate::serde::de::Unexpected::Str(&value_api_version), &<Self::Value as crate::Resource>::API_VERSION));
85                            }
86                        },
87                        Field::Key_kind => {
88                            let value_kind: std::string::String = crate::serde::de::MapAccess::next_value(&mut map)?;
89                            if value_kind != <Self::Value as crate::Resource>::KIND {
90                                return Err(crate::serde::de::Error::invalid_value(crate::serde::de::Unexpected::Str(&value_kind), &<Self::Value as crate::Resource>::KIND));
91                            }
92                        },
93                        Field::Key_server_address_by_client_cidrs => value_server_address_by_client_cidrs = crate::serde::de::MapAccess::next_value(&mut map)?,
94                        Field::Key_versions => value_versions = crate::serde::de::MapAccess::next_value(&mut map)?,
95                        Field::Other => { let _: crate::serde::de::IgnoredAny = crate::serde::de::MapAccess::next_value(&mut map)?; },
96                    }
97                }
98
99                Ok(APIVersions {
100                    server_address_by_client_cidrs: value_server_address_by_client_cidrs.unwrap_or_default(),
101                    versions: value_versions.unwrap_or_default(),
102                })
103            }
104        }
105
106        deserializer.deserialize_struct(
107            <Self as crate::Resource>::KIND,
108            &[
109                "apiVersion",
110                "kind",
111                "serverAddressByClientCIDRs",
112                "versions",
113            ],
114            Visitor,
115        )
116    }
117}
118
119impl crate::serde::Serialize for APIVersions {
120    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where S: crate::serde::Serializer {
121        let mut state = serializer.serialize_struct(
122            <Self as crate::Resource>::KIND,
123            4,
124        )?;
125        crate::serde::ser::SerializeStruct::serialize_field(&mut state, "apiVersion", <Self as crate::Resource>::API_VERSION)?;
126        crate::serde::ser::SerializeStruct::serialize_field(&mut state, "kind", <Self as crate::Resource>::KIND)?;
127        crate::serde::ser::SerializeStruct::serialize_field(&mut state, "serverAddressByClientCIDRs", &self.server_address_by_client_cidrs)?;
128        crate::serde::ser::SerializeStruct::serialize_field(&mut state, "versions", &self.versions)?;
129        crate::serde::ser::SerializeStruct::end(state)
130    }
131}
132
133#[cfg(feature = "schemars")]
134impl crate::schemars::JsonSchema for APIVersions {
135    fn schema_name() -> std::string::String {
136        "io.k8s.apimachinery.pkg.apis.meta.v1.APIVersions".into()
137    }
138
139    fn json_schema(__gen: &mut crate::schemars::gen::SchemaGenerator) -> crate::schemars::schema::Schema {
140        crate::schemars::schema::Schema::Object(crate::schemars::schema::SchemaObject {
141            metadata: Some(std::boxed::Box::new(crate::schemars::schema::Metadata {
142                description: Some("APIVersions lists the versions that are available, to allow clients to discover the API at /api, which is the root path of the legacy v1 API.".into()),
143                ..Default::default()
144            })),
145            instance_type: Some(crate::schemars::schema::SingleOrVec::Single(std::boxed::Box::new(crate::schemars::schema::InstanceType::Object))),
146            object: Some(std::boxed::Box::new(crate::schemars::schema::ObjectValidation {
147                properties: [
148                    (
149                        "apiVersion".into(),
150                        crate::schemars::schema::Schema::Object(crate::schemars::schema::SchemaObject {
151                            metadata: Some(std::boxed::Box::new(crate::schemars::schema::Metadata {
152                                description: Some("APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources".into()),
153                                ..Default::default()
154                            })),
155                            instance_type: Some(crate::schemars::schema::SingleOrVec::Single(std::boxed::Box::new(crate::schemars::schema::InstanceType::String))),
156                            ..Default::default()
157                        }),
158                    ),
159                    (
160                        "kind".into(),
161                        crate::schemars::schema::Schema::Object(crate::schemars::schema::SchemaObject {
162                            metadata: Some(std::boxed::Box::new(crate::schemars::schema::Metadata {
163                                description: Some("Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds".into()),
164                                ..Default::default()
165                            })),
166                            instance_type: Some(crate::schemars::schema::SingleOrVec::Single(std::boxed::Box::new(crate::schemars::schema::InstanceType::String))),
167                            ..Default::default()
168                        }),
169                    ),
170                    (
171                        "serverAddressByClientCIDRs".into(),
172                        crate::schemars::schema::Schema::Object(crate::schemars::schema::SchemaObject {
173                            metadata: Some(std::boxed::Box::new(crate::schemars::schema::Metadata {
174                                description: Some("a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.".into()),
175                                ..Default::default()
176                            })),
177                            instance_type: Some(crate::schemars::schema::SingleOrVec::Single(std::boxed::Box::new(crate::schemars::schema::InstanceType::Array))),
178                            array: Some(std::boxed::Box::new(crate::schemars::schema::ArrayValidation {
179                                items: Some(crate::schemars::schema::SingleOrVec::Single(std::boxed::Box::new(__gen.subschema_for::<crate::apimachinery::pkg::apis::meta::v1::ServerAddressByClientCIDR>()))),
180                                ..Default::default()
181                            })),
182                            ..Default::default()
183                        }),
184                    ),
185                    (
186                        "versions".into(),
187                        crate::schemars::schema::Schema::Object(crate::schemars::schema::SchemaObject {
188                            metadata: Some(std::boxed::Box::new(crate::schemars::schema::Metadata {
189                                description: Some("versions are the api versions that are available.".into()),
190                                ..Default::default()
191                            })),
192                            instance_type: Some(crate::schemars::schema::SingleOrVec::Single(std::boxed::Box::new(crate::schemars::schema::InstanceType::Array))),
193                            array: Some(std::boxed::Box::new(crate::schemars::schema::ArrayValidation {
194                                items: Some(crate::schemars::schema::SingleOrVec::Single(std::boxed::Box::new(
195                                    crate::schemars::schema::Schema::Object(crate::schemars::schema::SchemaObject {
196                                        instance_type: Some(crate::schemars::schema::SingleOrVec::Single(std::boxed::Box::new(crate::schemars::schema::InstanceType::String))),
197                                        ..Default::default()
198                                    })
199                                ))),
200                                ..Default::default()
201                            })),
202                            ..Default::default()
203                        }),
204                    ),
205                ].into(),
206                required: [
207                    "serverAddressByClientCIDRs".into(),
208                    "versions".into(),
209                ].into(),
210                ..Default::default()
211            })),
212            ..Default::default()
213        })
214    }
215}
k8s_openapi/v1_31/apimachinery/pkg/apis/meta/v1/api_versions.rs

k8s_openapi/v1_31/apimachinery/pkg/apis/meta/v1/
api_versions.rs
