Warn on missing doc (#199)

We want to encourage documentation on all public items. I'm not
completely sold on the idea since certain things are self-descriptive
but we also should strongly discourage undocumented things.

Adds `missing_docs = "warn"` to cargo workspace and adds
`allow(missing_docs)` to all existing violations. The plan is to prevent
new infractions and to slowly document as we work on areas.

Author: Hinton

Cargo.toml

@@ -82,6 +82,9 @@ pkcs5 = { git = "https://github.com/bitwarden/rustcrypto-formats.git", rev = "2b
 unused_async = "deny"
 unwrap_used = "deny"
 
+[workspace.lints.rust]
+missing_docs = "warn"
+
 # Compile all dependencies with some optimizations when building this crate on debug
 # This slows down clean builds by about 50%, but the resulting binaries can be orders of magnitude faster
 # As clean builds won't occur very often, this won't slow down the development process

bitwarden_license/bitwarden-sm/README.md

@@ -0,0 +1 @@
+# bitwarden-sm

bitwarden_license/bitwarden-sm/src/client_projects.rs

@@ -12,43 +12,50 @@ use crate::{
 /// Aliases to maintain backward compatibility
 pub type ClientProjects = ProjectsClient;
 
+#[allow(missing_docs)]
 pub struct ProjectsClient {
     pub client: Client,
 }
 
 impl ProjectsClient {
+    #[allow(missing_docs)]
     pub fn new(client: Client) -> Self {
         Self { client }
     }
 
+    #[allow(missing_docs)]
     pub async fn get(
         &self,
         input: &ProjectGetRequest,
     ) -> Result<ProjectResponse, SecretsManagerError> {
         get_project(&self.client, input).await
     }
 
+    #[allow(missing_docs)]
     pub async fn create(
         &self,
         input: &ProjectCreateRequest,
     ) -> Result<ProjectResponse, SecretsManagerError> {
         create_project(&self.client, input).await
     }
 
+    #[allow(missing_docs)]
     pub async fn list(
         &self,
         input: &ProjectsListRequest,
     ) -> Result<ProjectsResponse, SecretsManagerError> {
         list_projects(&self.client, input).await
     }
 
+    #[allow(missing_docs)]
     pub async fn update(
         &self,
         input: &ProjectPutRequest,
     ) -> Result<ProjectResponse, SecretsManagerError> {
         update_project(&self.client, input).await
     }
 
+    #[allow(missing_docs)]
     pub async fn delete(
         &self,
         input: ProjectsDeleteRequest,
@@ -59,6 +66,7 @@ impl ProjectsClient {
 
 /// This trait is for backward compatibility
 pub trait ClientProjectsExt {
+    #[allow(missing_docs)]
     fn projects(&self) -> ClientProjects;
 }
 
@@ -68,7 +76,9 @@ impl ClientProjectsExt for Client {
     }
 }
 
+#[allow(missing_docs)]
 pub trait ProjectsClientExt {
+    #[allow(missing_docs)]
     fn projects(&self) -> ProjectsClient;
 }
 

bitwarden_license/bitwarden-sm/src/client_secrets.rs

@@ -15,64 +15,74 @@ use crate::{
 /// Aliases to maintain backward compatibility
 pub type ClientSecrets = SecretsClient;
 
+#[allow(missing_docs)]
 pub struct SecretsClient {
     client: Client,
 }
 
 impl SecretsClient {
+    #[allow(missing_docs)]
     pub fn new(client: Client) -> Self {
         Self { client }
     }
 
+    #[allow(missing_docs)]
     pub async fn get(
         &self,
         input: &SecretGetRequest,
     ) -> Result<SecretResponse, SecretsManagerError> {
         get_secret(&self.client, input).await
     }
 
+    #[allow(missing_docs)]
     pub async fn get_by_ids(
         &self,
         input: SecretsGetRequest,
     ) -> Result<SecretsResponse, SecretsManagerError> {
         get_secrets_by_ids(&self.client, input).await
     }
 
+    #[allow(missing_docs)]
     pub async fn create(
         &self,
         input: &SecretCreateRequest,
     ) -> Result<SecretResponse, SecretsManagerError> {
         create_secret(&self.client, input).await
     }
 
+    #[allow(missing_docs)]
     pub async fn list(
         &self,
         input: &SecretIdentifiersRequest,
     ) -> Result<SecretIdentifiersResponse, SecretsManagerError> {
         list_secrets(&self.client, input).await
     }
 
+    #[allow(missing_docs)]
     pub async fn list_by_project(
         &self,
         input: &SecretIdentifiersByProjectRequest,
     ) -> Result<SecretIdentifiersResponse, SecretsManagerError> {
         list_secrets_by_project(&self.client, input).await
     }
 
+    #[allow(missing_docs)]
     pub async fn update(
         &self,
         input: &SecretPutRequest,
     ) -> Result<SecretResponse, SecretsManagerError> {
         update_secret(&self.client, input).await
     }
 
+    #[allow(missing_docs)]
     pub async fn delete(
         &self,
         input: SecretsDeleteRequest,
     ) -> Result<SecretsDeleteResponse, SecretsManagerError> {
         delete_secrets(&self.client, input).await
     }
 
+    #[allow(missing_docs)]
     pub async fn sync(
         &self,
         input: &SecretsSyncRequest,
@@ -83,6 +93,7 @@ impl SecretsClient {
 
 /// This trait is for backward compatibility
 pub trait ClientSecretsExt {
+    #[allow(missing_docs)]
     fn secrets(&self) -> ClientSecrets;
 }
 
@@ -92,7 +103,9 @@ impl ClientSecretsExt for Client {
     }
 }
 
+#[allow(missing_docs)]
 pub trait SecretsClientExt {
+    #[allow(missing_docs)]
     fn secrets(&self) -> SecretsClient;
 }
 

bitwarden_license/bitwarden-sm/src/lib.rs

@@ -1,7 +1,11 @@
+#![doc = include_str!("../README.md")]
+
 mod client_projects;
 mod client_secrets;
 mod error;
+#[allow(missing_docs)]
 pub mod projects;
+#[allow(missing_docs)]
 pub mod secrets;
 
 pub use client_projects::{ClientProjects, ClientProjectsExt, ProjectsClient, ProjectsClientExt};

bitwarden_license/bitwarden-sm/src/projects/create.rs

@@ -11,6 +11,7 @@ use crate::{
     projects::ProjectResponse,
 };
 
+#[allow(missing_docs)]
 #[derive(Serialize, Deserialize, Debug, JsonSchema, Validate)]
 #[serde(rename_all = "camelCase", deny_unknown_fields)]
 pub struct ProjectCreateRequest {

bitwarden_license/bitwarden-sm/src/projects/delete.rs

@@ -8,6 +8,7 @@ use uuid::Uuid;
 
 use crate::error::SecretsManagerError;
 
+#[allow(missing_docs)]
 #[derive(Serialize, Deserialize, Debug, JsonSchema)]
 #[serde(rename_all = "camelCase", deny_unknown_fields)]
 pub struct ProjectsDeleteRequest {
@@ -27,6 +28,7 @@ pub(crate) async fn delete_projects(
     ProjectsDeleteResponse::process_response(res)
 }
 
+#[allow(missing_docs)]
 #[derive(Serialize, Deserialize, Debug, JsonSchema)]
 #[serde(rename_all = "camelCase", deny_unknown_fields)]
 pub struct ProjectsDeleteResponse {

bitwarden_license/bitwarden-sm/src/projects/get.rs

@@ -5,6 +5,7 @@ use uuid::Uuid;
 
 use crate::{error::SecretsManagerError, projects::ProjectResponse};
 
+#[allow(missing_docs)]
 #[derive(Serialize, Deserialize, Debug, JsonSchema)]
 #[serde(rename_all = "camelCase", deny_unknown_fields)]
 pub struct ProjectGetRequest {

bitwarden_license/bitwarden-sm/src/projects/list.rs

@@ -7,6 +7,7 @@ use uuid::Uuid;
 
 use crate::{error::SecretsManagerError, projects::ProjectResponse};
 
+#[allow(missing_docs)]
 #[derive(Serialize, Deserialize, Debug, JsonSchema)]
 #[serde(rename_all = "camelCase", deny_unknown_fields)]
 pub struct ProjectsListRequest {
@@ -30,6 +31,7 @@ pub(crate) async fn list_projects(
     ProjectsResponse::process_response(res, &mut key_store.context())
 }
 
+#[allow(missing_docs)]
 #[derive(Serialize, Deserialize, Debug, JsonSchema)]
 #[serde(rename_all = "camelCase", deny_unknown_fields)]
 pub struct ProjectsResponse {

bitwarden_license/bitwarden-sm/src/projects/project_response.rs

@@ -11,6 +11,7 @@ use uuid::Uuid;
 
 use crate::error::SecretsManagerError;
 
+#[allow(missing_docs)]
 #[derive(Serialize, Deserialize, Debug, JsonSchema)]
 #[serde(rename_all = "camelCase", deny_unknown_fields)]
 pub struct ProjectResponse {

bitwarden_license/bitwarden-sm/src/projects/update.rs

@@ -11,6 +11,7 @@ use crate::{
     projects::ProjectResponse,
 };
 
+#[allow(missing_docs)]
 #[derive(Serialize, Deserialize, Debug, JsonSchema, Validate)]
 #[serde(rename_all = "camelCase", deny_unknown_fields)]
 pub struct ProjectPutRequest {

bitwarden_license/bitwarden-sm/src/secrets/create.rs

@@ -11,6 +11,7 @@ use crate::{
     secrets::SecretResponse,
 };
 
+#[allow(missing_docs)]
 #[derive(Serialize, Deserialize, Debug, JsonSchema, Validate)]
 #[serde(rename_all = "camelCase", deny_unknown_fields)]
 pub struct SecretCreateRequest {

bitwarden_license/bitwarden-sm/src/secrets/delete.rs

@@ -8,6 +8,7 @@ use uuid::Uuid;
 
 use crate::error::SecretsManagerError;
 
+#[allow(missing_docs)]
 #[derive(Serialize, Deserialize, Debug, JsonSchema)]
 #[serde(rename_all = "camelCase", deny_unknown_fields)]
 pub struct SecretsDeleteRequest {
@@ -27,6 +28,7 @@ pub(crate) async fn delete_secrets(
     SecretsDeleteResponse::process_response(res)
 }
 
+#[allow(missing_docs)]
 #[derive(Serialize, Deserialize, Debug, JsonSchema)]
 #[serde(rename_all = "camelCase", deny_unknown_fields)]
 pub struct SecretsDeleteResponse {

bitwarden_license/bitwarden-sm/src/secrets/get.rs

@@ -5,6 +5,7 @@ use uuid::Uuid;
 
 use crate::{error::SecretsManagerError, secrets::SecretResponse};
 
+#[allow(missing_docs)]
 #[derive(Serialize, Deserialize, Debug, JsonSchema)]
 #[serde(rename_all = "camelCase", deny_unknown_fields)]
 pub struct SecretGetRequest {

bitwarden_license/bitwarden-sm/src/secrets/get_by_ids.rs

@@ -6,6 +6,7 @@ use uuid::Uuid;
 
 use crate::{error::SecretsManagerError, secrets::SecretsResponse};
 
+#[allow(missing_docs)]
 #[derive(Serialize, Deserialize, Debug, JsonSchema)]
 #[serde(rename_all = "camelCase", deny_unknown_fields)]
 pub struct SecretsGetRequest {

bitwarden_license/bitwarden-sm/src/secrets/list.rs

@@ -13,6 +13,7 @@ use uuid::Uuid;
 
 use crate::error::SecretsManagerError;
 
+#[allow(missing_docs)]
 #[derive(Serialize, Deserialize, Debug, JsonSchema)]
 #[serde(rename_all = "camelCase", deny_unknown_fields)]
 pub struct SecretIdentifiersRequest {
@@ -36,6 +37,7 @@ pub(crate) async fn list_secrets(
     SecretIdentifiersResponse::process_response(res, &mut key_store.context())
 }
 
+#[allow(missing_docs)]
 #[derive(Serialize, Deserialize, Debug, JsonSchema)]
 #[serde(rename_all = "camelCase", deny_unknown_fields)]
 pub struct SecretIdentifiersByProjectRequest {
@@ -59,6 +61,7 @@ pub(crate) async fn list_secrets_by_project(
     SecretIdentifiersResponse::process_response(res, &mut key_store.context())
 }
 
+#[allow(missing_docs)]
 #[derive(Serialize, Deserialize, Debug, JsonSchema)]
 #[serde(rename_all = "camelCase", deny_unknown_fields)]
 pub struct SecretIdentifiersResponse {

bitwarden_license/bitwarden-sm/src/secrets/secret_response.rs

@@ -13,6 +13,7 @@ use uuid::Uuid;
 
 use crate::error::SecretsManagerError;
 
+#[allow(missing_docs)]
 #[derive(Serialize, Deserialize, Debug, JsonSchema)]
 #[serde(rename_all = "camelCase", deny_unknown_fields)]
 pub struct SecretResponse {
@@ -84,6 +85,7 @@ impl SecretResponse {
     }
 }
 
+#[allow(missing_docs)]
 #[derive(Serialize, Deserialize, Debug, JsonSchema)]
 #[serde(rename_all = "camelCase", deny_unknown_fields)]
 pub struct SecretsResponse {

bitwarden_license/bitwarden-sm/src/secrets/sync.rs

@@ -8,6 +8,7 @@ use uuid::Uuid;
 
 use crate::{error::SecretsManagerError, secrets::SecretResponse};
 
+#[allow(missing_docs)]
 #[derive(Serialize, Deserialize, Debug, JsonSchema)]
 #[serde(rename_all = "camelCase", deny_unknown_fields)]
 pub struct SecretsSyncRequest {
@@ -36,6 +37,7 @@ pub(crate) async fn sync_secrets(
     SecretsSyncResponse::process_response(res, &mut key_store.context())
 }
 
+#[allow(missing_docs)]
 #[derive(Serialize, Deserialize, Debug, JsonSchema)]
 #[serde(rename_all = "camelCase", deny_unknown_fields)]
 pub struct SecretsSyncResponse {

bitwarden_license/bitwarden-sm/src/secrets/update.rs

@@ -11,6 +11,7 @@ use crate::{
     secrets::SecretResponse,
 };
 
+#[allow(missing_docs)]
 #[derive(Serialize, Deserialize, Debug, JsonSchema, Validate)]
 #[serde(rename_all = "camelCase", deny_unknown_fields)]
 pub struct SecretPutRequest {