dsh_rest_api_client 0.7.0

REST API client for KPN Data Services Hub
Documentation 
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

# How to upgrade
To upgrade to a newer version of the OpenAPI spec, we can regenerate the client using Progenitor.

## Install Rust  Nightly
The Rust formatter of Progenitor requires Rust nightly to run. Install Rust nightly using rustup.

```shell
rustup install nightly
```

## Install progenitor
install progenitor using cargo

```shell
cargo install cargo-progenitor --version 0.12.0
```

## Prepare the OpenAPI spec file
Download the OpenAPI spec file from the DSH API documentation.

The spec of DSH is missing the required `OperationId` field and authentication. To add this, run the following python script:

```shell
python3 update_openapi_spec.py path/to/openapi.json
```

## Generate the client
To generate the client run the following command:

```shell
cargo +nightly progenitor -i dsh_rest_api_client/openapi_spec/openapi_1_11_1.json -o dsh_rest_client -n dsh_rest_client -v 0.1.0
```

## Update the client
Copy the generated `lib.rs` from `tmp_dsh_rest_api_client` to the src folder of `dsh_rest_api_client` in the `dsh_sdk` repository and update the `README.md` file and `cargo.toml` with the new version number. 

in `lib.rs` add the feature flags to all parent items ("client", "types")