openstack_sdk/api/identity/v3/group/
delete.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//! Deletes a group.
19//!
20//! Relationship:
21//! `https://docs.openstack.org/api/openstack-identity/3/rel/group`
22//!
23use derive_builder::Builder;
24use http::{HeaderMap, HeaderName, HeaderValue};
25
26use crate::api::rest_endpoint_prelude::*;
27
28use std::borrow::Cow;
29
30#[derive(Builder, Debug, Clone)]
31#[builder(setter(strip_option))]
32pub struct Request<'a> {
33    /// group_id parameter for /v3/groups/{group_id} API
34    #[builder(default, setter(into))]
35    id: Cow<'a, str>,
36
37    #[builder(setter(name = "_headers"), default, private)]
38    _headers: Option<HeaderMap>,
39}
40impl<'a> Request<'a> {
41    /// Create a builder for the endpoint.
42    pub fn builder() -> RequestBuilder<'a> {
43        RequestBuilder::default()
44    }
45}
46
47impl RequestBuilder<'_> {
48    /// Add a single header to the Group.
49    pub fn header(&mut self, header_name: &'static str, header_value: &'static str) -> &mut Self
50where {
51        self._headers
52            .get_or_insert(None)
53            .get_or_insert_with(HeaderMap::new)
54            .insert(header_name, HeaderValue::from_static(header_value));
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::DELETE
75    }
76
77    fn endpoint(&self) -> Cow<'static, str> {
78        format!("groups/{id}", id = self.id.as_ref(),).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        None
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    #[cfg(feature = "sync")]
108    use crate::api::Query;
109    use crate::test::client::FakeOpenStackClient;
110    use crate::types::ServiceType;
111    use http::{HeaderName, HeaderValue};
112    use httpmock::MockServer;
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!(Request::builder().build().unwrap().response_key().is_none())
126    }
127
128    #[cfg(feature = "sync")]
129    #[test]
130    fn endpoint() {
131        let server = MockServer::start();
132        let client = FakeOpenStackClient::new(server.base_url());
133        let mock = server.mock(|when, then| {
134            when.method(httpmock::Method::DELETE)
135                .path(format!("/groups/{id}", id = "id",));
136
137            then.status(200)
138                .header("content-type", "application/json")
139                .json_body(json!({ "dummy": {} }));
140        });
141
142        let endpoint = Request::builder().id("id").build().unwrap();
143        let _: serde_json::Value = endpoint.query(&client).unwrap();
144        mock.assert();
145    }
146
147    #[cfg(feature = "sync")]
148    #[test]
149    fn endpoint_headers() {
150        let server = MockServer::start();
151        let client = FakeOpenStackClient::new(server.base_url());
152        let mock = server.mock(|when, then| {
153            when.method(httpmock::Method::DELETE)
154                .path(format!("/groups/{id}", id = "id",))
155                .header("foo", "bar")
156                .header("not_foo", "not_bar");
157            then.status(200)
158                .header("content-type", "application/json")
159                .json_body(json!({ "dummy": {} }));
160        });
161
162        let endpoint = Request::builder()
163            .id("id")
164            .headers(
165                [(
166                    Some(HeaderName::from_static("foo")),
167                    HeaderValue::from_static("bar"),
168                )]
169                .into_iter(),
170            )
171            .header("not_foo", "not_bar")
172            .build()
173            .unwrap();
174        let _: serde_json::Value = endpoint.query(&client).unwrap();
175        mock.assert();
176    }
177}
openstack_sdk/api/identity/v3/group/delete.rs

openstack_sdk/api/identity/v3/group/
delete.rs
