From d254815e541543f1c9bc960a5b74e186b6c77b40 Mon Sep 17 00:00:00 2001 From: Oscar Hinton Date: Fri, 27 Sep 2024 10:38:49 +0200 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Matt Bishop --- docs/architecture/sdk/index.md | 6 +++--- docs/architecture/sdk/server-bindings.md | 2 +- docs/getting-started/sdk/index.md | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/architecture/sdk/index.md b/docs/architecture/sdk/index.md index 072356edf..277df40c8 100644 --- a/docs/architecture/sdk/index.md +++ b/docs/architecture/sdk/index.md @@ -9,16 +9,16 @@ SDK for the Bitwarden [Password Manager][pm]. The SDK is written in Rust and pro multiple languages. The general end goal of the SDK is to own everything up to the presentational layers. This includes but is not limited to: API calls, data models, encryption, and business logic. -We have compiled a list of resources for learning rust in a +We have compiled a list of resources for learning Rust in a [Confluence page](https://bitwarden.atlassian.net/wiki/spaces/DEV/pages/517898288/Rust+Learning+Resources). For API documentation view the latest -[API documentation](https://sdk-api-docs.bitwarden.com/bitwarden/index.html) which also includes +[API documentation](https://sdk-api-docs.bitwarden.com/bitwarden/index.html) that also includes internal private items. ## Architecture The Bitwarden SDK is structured as a single [Git repository](https://github.com/bitwarden/sdk) with -multiple internal crates. Please review the README in the repository for up to date information +multiple internal crates. Please review the `README` in the repository for up to date information about the different crates. We generally strive towards extracting features into separate crates to keep the `bitwarden-core` diff --git a/docs/architecture/sdk/server-bindings.md b/docs/architecture/sdk/server-bindings.md index a34aee2ea..1c9b763bb 100644 --- a/docs/architecture/sdk/server-bindings.md +++ b/docs/architecture/sdk/server-bindings.md @@ -22,7 +22,7 @@ let response: SyncResponseModel = bitwarden_api_api::apis::sync_api::sync_get(&config.api, exclude_subdomains).await?; ``` -You SHOULD not expose the request and response models of the auto generated bindings and SHOULD +You *should not* expose the request and response models of the auto generated bindings and *should* instead define and use your own models. This ensures the server request / response models are decoupled from the SDK models, which allows for easier changes in the future without breaking backwards compatibility. diff --git a/docs/getting-started/sdk/index.md b/docs/getting-started/sdk/index.md index db17fbbc1..c3ba97d7d 100644 --- a/docs/getting-started/sdk/index.md +++ b/docs/getting-started/sdk/index.md @@ -9,7 +9,7 @@ SDK for the Bitwarden [Password Manager][pm]. The SDK is written in Rust and pro multiple languages. For more in-depth documentation please review the [SDK Architecture](../../architecture/sdk) page -and the project's [README](https://github.com/bitwarden/sdk). +and the project's [`README`](https://github.com/bitwarden/sdk). ## Requirements @@ -42,7 +42,7 @@ To build the SDK, run the following command: cargo build ``` -## Linking SDK to clients +## Linking the SDK to clients After modifying the SDK, it can be beneficial to test the changes in the client applications. To do so you will need to update the SDK reference in the client applications.