1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
//! # Generic API function calls
//!
//! _These functions are only available when the `generic` feature is enabled._
//!
//! Module that contains methods to call the API methods in a generic way.
//! What this means is that the API functions can be called indirect,
//! where the path of the method must be provided as an argument.
//!
//! This has a number of consequences,
//! which are caused by the limitations of the `rust` language with respect to abstraction:
//! * The number and types of the required parameters for each method
//! are not known at compile time, which means that (emulated) dynamic typing is used
//! and parameter errors will occur at run-time instead of compile time.
//! * Path parameters must be provided as `&str`.
//! * Body parameters must be provided as a json formatted `String`
//! that can be deserialized at run-time into the expected type.
//! * The response type for each method is not known at compile time.
//! * For `GET` methods the responses will be returned as dynamic trait objects
//! that implement [`erased_serde::Serialize`], defined in the
//! [`erased_serde`](https://crates.io/crates/erased-serde) crate.
//! These objects can be serialized into `json`, `yaml` or `toml` without any type information.
//! * If `DELETE`, `HEAD`, `PATCH`, `POST` and `PUT` methods return data this will be ignored
//! and only errors will be returned.
//!
//! # Examples
//!
//! Get the configuration of the application `my-application` and print it as json.
//!
//! ```ignore
//! # use dsh_api::dsh_api_client_factory::DshApiClientFactory;
//! # #[tokio::main]
//! # async fn main() -> Result<(), Box<dyn std::error::Error>> {
//! # let client = DshApiClientFactory::default().client().await?;
//! let application = client.get("application_configuration", &["my-application"]).await?;
//! println!("{}", serde_json::to_string_pretty(&application)?);
//! # Ok(())
//! # }
//! ```
//!
//! Update the secret `abcdef` to the value `ABCDEF`.
//!
//! ```ignore
//! # use dsh_api::dsh_api_client_factory::DshApiClientFactory;
//! # #[tokio::main]
//! # async fn main() -> Result<(), Box<dyn std::error::Error>> {
//! # let client = DshApiClientFactory::default().client().await?;
//! let secret = serde_json::to_string("ABCDEF")?;
//! client.put("put_secret_by_tenant_by_id", &["abcdef"], &secret).await?;
//! # Ok(())
//! # }
//! ```
//!
//! # API functions
//!
//! [`DshApiClient`] methods that call the DSH resource management API.
//!
//! * [`delete(path, [parameters]) -> Ok`](DshApiClient::delete)
//! * [`get(path, [parameters]) -> serialize`](DshApiClient::get)
//! * [`head(path, [parameters]) -> serialize`](DshApiClient::head)
//! * [`patch(path, [parameters], body) -> serialize`](DshApiClient::patch)
//! * [`post(path, [parameters], body) -> Ok`](DshApiClient::post)
//! * [`put(path, [parameters], body) -> Ok`](DshApiClient::put)
include!;