openstack_sdk_identity/v3/auth/system/
list.rs

1// Licensed under the Apache License, Version 2.0 (the "License");
2// you may not use this file except in compliance with the License.
3// You may obtain a copy of the License at
4//
5//     http://www.apache.org/licenses/LICENSE-2.0
6//
7// Unless required by applicable law or agreed to in writing, software
8// distributed under the License is distributed on an "AS IS" BASIS,
9// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10// See the License for the specific language governing permissions and
11// limitations under the License.
12//
13// SPDX-License-Identifier: Apache-2.0
14//
15// WARNING: This file is automatically generated from OpenAPI schema using
16// `openstack-codegenerator`.
17
18//! New in version 3.10
19//!
20//! This call returns the list of systems that are available to be scoped to
21//! based on the X-Auth-Token provided in the request.
22//!
23//! Relationship:
24//! `https://docs.openstack.org/api/openstack-identity/3/rel/auth_system`
25//!
26use derive_builder::Builder;
27use http::{HeaderMap, HeaderName, HeaderValue};
28
29use openstack_sdk_core::api::rest_endpoint_prelude::*;
30
31#[derive(Builder, Debug, Clone)]
32#[builder(setter(strip_option))]
33pub struct Request {
34    #[builder(setter(name = "_headers"), default, private)]
35    _headers: Option<HeaderMap>,
36}
37impl Request {
38    /// Create a builder for the endpoint.
39    pub fn builder() -> RequestBuilder {
40        RequestBuilder::default()
41    }
42}
43
44impl RequestBuilder {
45    /// Add a single header to the System.
46    pub fn header<K, V>(&mut self, header_name: K, header_value: V) -> &mut Self
47    where
48        K: Into<HeaderName>,
49        V: Into<HeaderValue>,
50    {
51        self._headers
52            .get_or_insert(None)
53            .get_or_insert_with(HeaderMap::new)
54            .insert(header_name.into(), header_value.into());
55        self
56    }
57
58    /// Add multiple headers.
59    pub fn headers<I, T>(&mut self, iter: I) -> &mut Self
60    where
61        I: Iterator<Item = T>,
62        T: Into<(Option<HeaderName>, HeaderValue)>,
63    {
64        self._headers
65            .get_or_insert(None)
66            .get_or_insert_with(HeaderMap::new)
67            .extend(iter.map(Into::into));
68        self
69    }
70}
71
72impl RestEndpoint for Request {
73    fn method(&self) -> http::Method {
74        http::Method::GET
75    }
76
77    fn endpoint(&self) -> Cow<'static, str> {
78        "auth/system".to_string().into()
79    }
80
81    fn parameters(&self) -> QueryParams<'_> {
82        QueryParams::default()
83    }
84
85    fn service_type(&self) -> ServiceType {
86        ServiceType::Identity
87    }
88
89    fn response_key(&self) -> Option<Cow<'static, str>> {
90        Some("system".into())
91    }
92
93    /// Returns headers to be set into the request
94    fn request_headers(&self) -> Option<&HeaderMap> {
95        self._headers.as_ref()
96    }
97
98    /// Returns required API version
99    fn api_version(&self) -> Option<ApiVersion> {
100        Some(ApiVersion::new(3, 0))
101    }
102}
103
104#[cfg(test)]
105mod tests {
106    use super::*;
107    use http::{HeaderName, HeaderValue};
108    use httpmock::MockServer;
109    #[cfg(feature = "sync")]
110    use openstack_sdk_core::api::Query;
111    use openstack_sdk_core::test::client::FakeOpenStackClient;
112    use openstack_sdk_core::types::ServiceType;
113    use serde_json::json;
114
115    #[test]
116    fn test_service_type() {
117        assert_eq!(
118            Request::builder().build().unwrap().service_type(),
119            ServiceType::Identity
120        );
121    }
122
123    #[test]
124    fn test_response_key() {
125        assert_eq!(
126            Request::builder().build().unwrap().response_key().unwrap(),
127            "system"
128        );
129    }
130
131    #[cfg(feature = "sync")]
132    #[test]
133    fn endpoint() {
134        let server = MockServer::start();
135        let client = FakeOpenStackClient::new(server.base_url());
136        let mock = server.mock(|when, then| {
137            when.method(httpmock::Method::GET)
138                .path("/auth/system".to_string());
139
140            then.status(200)
141                .header("content-type", "application/json")
142                .json_body(json!({ "system": {} }));
143        });
144
145        let endpoint = Request::builder().build().unwrap();
146        let _: serde_json::Value = endpoint.query(&client).unwrap();
147        mock.assert();
148    }
149
150    #[cfg(feature = "sync")]
151    #[test]
152    fn endpoint_headers() {
153        let server = MockServer::start();
154        let client = FakeOpenStackClient::new(server.base_url());
155        let mock = server.mock(|when, then| {
156            when.method(httpmock::Method::GET)
157                .path("/auth/system".to_string())
158                .header("foo", "bar")
159                .header("not_foo", "not_bar");
160            then.status(200)
161                .header("content-type", "application/json")
162                .json_body(json!({ "system": {} }));
163        });
164
165        let endpoint = Request::builder()
166            .headers(
167                [(
168                    Some(HeaderName::from_static("foo")),
169                    HeaderValue::from_static("bar"),
170                )]
171                .into_iter(),
172            )
173            .header(
174                HeaderName::from_static("not_foo"),
175                HeaderValue::from_static("not_bar"),
176            )
177            .build()
178            .unwrap();
179        let _: serde_json::Value = endpoint.query(&client).unwrap();
180        mock.assert();
181    }
182}
openstack_sdk_identity/v3/auth/system/list.rs

openstack_sdk_identity/v3/auth/system/
list.rs
