nominal_api/conjure/clients/secrets/api/
secret_service.rs

1use conjure_http::endpoint;
2/// The secrets service provides functionality for creating and retrieving customer secrets (e.g. influx passwords, API keys, etc)
3#[conjure_http::conjure_client(name = "SecretService")]
4pub trait SecretService<
5    #[response_body]
6    I: Iterator<
7            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
8        >,
9> {
10    /// Create a new secret.
11    #[endpoint(
12        method = POST,
13        path = "/secrets/v1/secrets",
14        name = "create",
15        accept = conjure_http::client::StdResponseDeserializer
16    )]
17    fn create(
18        &self,
19        #[auth]
20        auth_: &conjure_object::BearerToken,
21        #[body(serializer = conjure_http::client::StdRequestSerializer)]
22        request: &super::super::super::super::objects::secrets::api::CreateSecretRequest,
23    ) -> Result<
24        super::super::super::super::objects::secrets::api::Secret,
25        conjure_http::private::Error,
26    >;
27    /// Get secret by rid.
28    #[endpoint(
29        method = GET,
30        path = "/secrets/v1/secrets/{rid}",
31        name = "get",
32        accept = conjure_http::client::StdResponseDeserializer
33    )]
34    fn get(
35        &self,
36        #[auth]
37        auth_: &conjure_object::BearerToken,
38        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
39        rid: &super::super::super::super::objects::secrets::api::SecretRid,
40    ) -> Result<
41        super::super::super::super::objects::secrets::api::Secret,
42        conjure_http::private::Error,
43    >;
44    /// Get secrets by a set of rids.
45    #[endpoint(
46        method = POST,
47        path = "/secrets/v1/secrets/batch",
48        name = "getBatch",
49        accept = conjure_http::client::StdResponseDeserializer
50    )]
51    fn get_batch(
52        &self,
53        #[auth]
54        auth_: &conjure_object::BearerToken,
55        #[body(serializer = conjure_http::client::StdRequestSerializer)]
56        request: &super::super::super::super::objects::secrets::api::GetSecretsRequest,
57    ) -> Result<
58        super::super::super::super::objects::secrets::api::GetSecretsResponse,
59        conjure_http::private::Error,
60    >;
61    /// Update a secret by rid.
62    #[endpoint(
63        method = PUT,
64        path = "/secrets/v1/secrets/{rid}",
65        name = "update",
66        accept = conjure_http::client::StdResponseDeserializer
67    )]
68    fn update(
69        &self,
70        #[auth]
71        auth_: &conjure_object::BearerToken,
72        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
73        rid: &super::super::super::super::objects::secrets::api::SecretRid,
74        #[body(serializer = conjure_http::client::StdRequestSerializer)]
75        request: &super::super::super::super::objects::secrets::api::UpdateSecretRequest,
76    ) -> Result<
77        super::super::super::super::objects::secrets::api::Secret,
78        conjure_http::private::Error,
79    >;
80    /// Delete a secret by rid. This is a permanent deletion. To perform a soft delete,
81    /// use the archive endpoint.
82    #[endpoint(
83        method = DELETE,
84        path = "/secrets/v1/secrets/{rid}",
85        name = "delete",
86        accept = conjure_http::client::conjure::EmptyResponseDeserializer
87    )]
88    fn delete(
89        &self,
90        #[auth]
91        auth_: &conjure_object::BearerToken,
92        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
93        rid: &super::super::super::super::objects::secrets::api::SecretRid,
94    ) -> Result<(), conjure_http::private::Error>;
95    /// Archive a secret by rid.
96    #[endpoint(
97        method = PUT,
98        path = "/secrets/v1/secrets/{rid}/archive",
99        name = "archive",
100        accept = conjure_http::client::conjure::EmptyResponseDeserializer
101    )]
102    fn archive(
103        &self,
104        #[auth]
105        auth_: &conjure_object::BearerToken,
106        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
107        rid: &super::super::super::super::objects::secrets::api::SecretRid,
108    ) -> Result<(), conjure_http::private::Error>;
109    /// Unarchive a secret by rid.
110    #[endpoint(
111        method = PUT,
112        path = "/secrets/v1/secrets/{rid}/unarchive",
113        name = "unarchive",
114        accept = conjure_http::client::conjure::EmptyResponseDeserializer
115    )]
116    fn unarchive(
117        &self,
118        #[auth]
119        auth_: &conjure_object::BearerToken,
120        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
121        rid: &super::super::super::super::objects::secrets::api::SecretRid,
122    ) -> Result<(), conjure_http::private::Error>;
123    /// Returns metadata about secrets that match a given query.
124    #[endpoint(
125        method = POST,
126        path = "/secrets/v1/secrets/search",
127        name = "search",
128        accept = conjure_http::client::StdResponseDeserializer
129    )]
130    fn search(
131        &self,
132        #[auth]
133        auth_: &conjure_object::BearerToken,
134        #[body(serializer = conjure_http::client::StdRequestSerializer)]
135        request: &super::super::super::super::objects::secrets::api::SearchSecretsRequest,
136    ) -> Result<
137        super::super::super::super::objects::secrets::api::SearchSecretsResponse,
138        conjure_http::private::Error,
139    >;
140}
141/// The secrets service provides functionality for creating and retrieving customer secrets (e.g. influx passwords, API keys, etc)
142#[conjure_http::conjure_client(name = "SecretService")]
143pub trait AsyncSecretService<
144    #[response_body]
145    I: conjure_http::private::Stream<
146            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
147        >,
148> {
149    /// Create a new secret.
150    #[endpoint(
151        method = POST,
152        path = "/secrets/v1/secrets",
153        name = "create",
154        accept = conjure_http::client::StdResponseDeserializer
155    )]
156    async fn create(
157        &self,
158        #[auth]
159        auth_: &conjure_object::BearerToken,
160        #[body(serializer = conjure_http::client::StdRequestSerializer)]
161        request: &super::super::super::super::objects::secrets::api::CreateSecretRequest,
162    ) -> Result<
163        super::super::super::super::objects::secrets::api::Secret,
164        conjure_http::private::Error,
165    >;
166    /// Get secret by rid.
167    #[endpoint(
168        method = GET,
169        path = "/secrets/v1/secrets/{rid}",
170        name = "get",
171        accept = conjure_http::client::StdResponseDeserializer
172    )]
173    async fn get(
174        &self,
175        #[auth]
176        auth_: &conjure_object::BearerToken,
177        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
178        rid: &super::super::super::super::objects::secrets::api::SecretRid,
179    ) -> Result<
180        super::super::super::super::objects::secrets::api::Secret,
181        conjure_http::private::Error,
182    >;
183    /// Get secrets by a set of rids.
184    #[endpoint(
185        method = POST,
186        path = "/secrets/v1/secrets/batch",
187        name = "getBatch",
188        accept = conjure_http::client::StdResponseDeserializer
189    )]
190    async fn get_batch(
191        &self,
192        #[auth]
193        auth_: &conjure_object::BearerToken,
194        #[body(serializer = conjure_http::client::StdRequestSerializer)]
195        request: &super::super::super::super::objects::secrets::api::GetSecretsRequest,
196    ) -> Result<
197        super::super::super::super::objects::secrets::api::GetSecretsResponse,
198        conjure_http::private::Error,
199    >;
200    /// Update a secret by rid.
201    #[endpoint(
202        method = PUT,
203        path = "/secrets/v1/secrets/{rid}",
204        name = "update",
205        accept = conjure_http::client::StdResponseDeserializer
206    )]
207    async fn update(
208        &self,
209        #[auth]
210        auth_: &conjure_object::BearerToken,
211        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
212        rid: &super::super::super::super::objects::secrets::api::SecretRid,
213        #[body(serializer = conjure_http::client::StdRequestSerializer)]
214        request: &super::super::super::super::objects::secrets::api::UpdateSecretRequest,
215    ) -> Result<
216        super::super::super::super::objects::secrets::api::Secret,
217        conjure_http::private::Error,
218    >;
219    /// Delete a secret by rid. This is a permanent deletion. To perform a soft delete,
220    /// use the archive endpoint.
221    #[endpoint(
222        method = DELETE,
223        path = "/secrets/v1/secrets/{rid}",
224        name = "delete",
225        accept = conjure_http::client::conjure::EmptyResponseDeserializer
226    )]
227    async fn delete(
228        &self,
229        #[auth]
230        auth_: &conjure_object::BearerToken,
231        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
232        rid: &super::super::super::super::objects::secrets::api::SecretRid,
233    ) -> Result<(), conjure_http::private::Error>;
234    /// Archive a secret by rid.
235    #[endpoint(
236        method = PUT,
237        path = "/secrets/v1/secrets/{rid}/archive",
238        name = "archive",
239        accept = conjure_http::client::conjure::EmptyResponseDeserializer
240    )]
241    async fn archive(
242        &self,
243        #[auth]
244        auth_: &conjure_object::BearerToken,
245        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
246        rid: &super::super::super::super::objects::secrets::api::SecretRid,
247    ) -> Result<(), conjure_http::private::Error>;
248    /// Unarchive a secret by rid.
249    #[endpoint(
250        method = PUT,
251        path = "/secrets/v1/secrets/{rid}/unarchive",
252        name = "unarchive",
253        accept = conjure_http::client::conjure::EmptyResponseDeserializer
254    )]
255    async fn unarchive(
256        &self,
257        #[auth]
258        auth_: &conjure_object::BearerToken,
259        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
260        rid: &super::super::super::super::objects::secrets::api::SecretRid,
261    ) -> Result<(), conjure_http::private::Error>;
262    /// Returns metadata about secrets that match a given query.
263    #[endpoint(
264        method = POST,
265        path = "/secrets/v1/secrets/search",
266        name = "search",
267        accept = conjure_http::client::StdResponseDeserializer
268    )]
269    async fn search(
270        &self,
271        #[auth]
272        auth_: &conjure_object::BearerToken,
273        #[body(serializer = conjure_http::client::StdRequestSerializer)]
274        request: &super::super::super::super::objects::secrets::api::SearchSecretsRequest,
275    ) -> Result<
276        super::super::super::super::objects::secrets::api::SearchSecretsResponse,
277        conjure_http::private::Error,
278    >;
279}
280/// The secrets service provides functionality for creating and retrieving customer secrets (e.g. influx passwords, API keys, etc)
281#[conjure_http::conjure_client(name = "SecretService", local)]
282pub trait LocalAsyncSecretService<
283    #[response_body]
284    I: conjure_http::private::Stream<
285            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
286        >,
287> {
288    /// Create a new secret.
289    #[endpoint(
290        method = POST,
291        path = "/secrets/v1/secrets",
292        name = "create",
293        accept = conjure_http::client::StdResponseDeserializer
294    )]
295    async fn create(
296        &self,
297        #[auth]
298        auth_: &conjure_object::BearerToken,
299        #[body(serializer = conjure_http::client::StdRequestSerializer)]
300        request: &super::super::super::super::objects::secrets::api::CreateSecretRequest,
301    ) -> Result<
302        super::super::super::super::objects::secrets::api::Secret,
303        conjure_http::private::Error,
304    >;
305    /// Get secret by rid.
306    #[endpoint(
307        method = GET,
308        path = "/secrets/v1/secrets/{rid}",
309        name = "get",
310        accept = conjure_http::client::StdResponseDeserializer
311    )]
312    async fn get(
313        &self,
314        #[auth]
315        auth_: &conjure_object::BearerToken,
316        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
317        rid: &super::super::super::super::objects::secrets::api::SecretRid,
318    ) -> Result<
319        super::super::super::super::objects::secrets::api::Secret,
320        conjure_http::private::Error,
321    >;
322    /// Get secrets by a set of rids.
323    #[endpoint(
324        method = POST,
325        path = "/secrets/v1/secrets/batch",
326        name = "getBatch",
327        accept = conjure_http::client::StdResponseDeserializer
328    )]
329    async fn get_batch(
330        &self,
331        #[auth]
332        auth_: &conjure_object::BearerToken,
333        #[body(serializer = conjure_http::client::StdRequestSerializer)]
334        request: &super::super::super::super::objects::secrets::api::GetSecretsRequest,
335    ) -> Result<
336        super::super::super::super::objects::secrets::api::GetSecretsResponse,
337        conjure_http::private::Error,
338    >;
339    /// Update a secret by rid.
340    #[endpoint(
341        method = PUT,
342        path = "/secrets/v1/secrets/{rid}",
343        name = "update",
344        accept = conjure_http::client::StdResponseDeserializer
345    )]
346    async fn update(
347        &self,
348        #[auth]
349        auth_: &conjure_object::BearerToken,
350        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
351        rid: &super::super::super::super::objects::secrets::api::SecretRid,
352        #[body(serializer = conjure_http::client::StdRequestSerializer)]
353        request: &super::super::super::super::objects::secrets::api::UpdateSecretRequest,
354    ) -> Result<
355        super::super::super::super::objects::secrets::api::Secret,
356        conjure_http::private::Error,
357    >;
358    /// Delete a secret by rid. This is a permanent deletion. To perform a soft delete,
359    /// use the archive endpoint.
360    #[endpoint(
361        method = DELETE,
362        path = "/secrets/v1/secrets/{rid}",
363        name = "delete",
364        accept = conjure_http::client::conjure::EmptyResponseDeserializer
365    )]
366    async fn delete(
367        &self,
368        #[auth]
369        auth_: &conjure_object::BearerToken,
370        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
371        rid: &super::super::super::super::objects::secrets::api::SecretRid,
372    ) -> Result<(), conjure_http::private::Error>;
373    /// Archive a secret by rid.
374    #[endpoint(
375        method = PUT,
376        path = "/secrets/v1/secrets/{rid}/archive",
377        name = "archive",
378        accept = conjure_http::client::conjure::EmptyResponseDeserializer
379    )]
380    async fn archive(
381        &self,
382        #[auth]
383        auth_: &conjure_object::BearerToken,
384        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
385        rid: &super::super::super::super::objects::secrets::api::SecretRid,
386    ) -> Result<(), conjure_http::private::Error>;
387    /// Unarchive a secret by rid.
388    #[endpoint(
389        method = PUT,
390        path = "/secrets/v1/secrets/{rid}/unarchive",
391        name = "unarchive",
392        accept = conjure_http::client::conjure::EmptyResponseDeserializer
393    )]
394    async fn unarchive(
395        &self,
396        #[auth]
397        auth_: &conjure_object::BearerToken,
398        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
399        rid: &super::super::super::super::objects::secrets::api::SecretRid,
400    ) -> Result<(), conjure_http::private::Error>;
401    /// Returns metadata about secrets that match a given query.
402    #[endpoint(
403        method = POST,
404        path = "/secrets/v1/secrets/search",
405        name = "search",
406        accept = conjure_http::client::StdResponseDeserializer
407    )]
408    async fn search(
409        &self,
410        #[auth]
411        auth_: &conjure_object::BearerToken,
412        #[body(serializer = conjure_http::client::StdRequestSerializer)]
413        request: &super::super::super::super::objects::secrets::api::SearchSecretsRequest,
414    ) -> Result<
415        super::super::super::super::objects::secrets::api::SearchSecretsResponse,
416        conjure_http::private::Error,
417    >;
418}
nominal_api/conjure/clients/secrets/api/secret_service.rs

nominal_api/conjure/clients/secrets/api/
secret_service.rs
