BIT-588 Relax documentation requirements deep within the network layer (

#58)
bitwarden · Jun 20, 2024 · 016f597 · 016f597
1 parent 3548340
commit 016f597
Show file tree

Hide file tree

Showing 4 changed files with 3 additions and 13 deletions.
diff --git a/app/src/main/java/com/x8bit/bitwarden/data/auth/datasource/network/api/AccountsApi.kt b/app/src/main/java/com/x8bit/bitwarden/data/auth/datasource/network/api/AccountsApi.kt
@@ -10,9 +10,6 @@ import retrofit2.http.POST
  */
 interface AccountsApi {
 
-    /**
-     * Make pre login request to get KDF params.
-     */
     @POST("/accounts/prelogin")
     suspend fun preLogin(@Body body: PreLoginRequestJson): Result<PreLoginResponseJson>
 }
diff --git a/app/src/main/java/com/x8bit/bitwarden/data/auth/datasource/network/api/IdentityApi.kt b/app/src/main/java/com/x8bit/bitwarden/data/auth/datasource/network/api/IdentityApi.kt
@@ -14,9 +14,6 @@ import java.util.UUID
  */
 interface IdentityApi {
 
-    /**
-     * Make request to get an access token.
-     */
     @POST
     @Suppress("LongParameterList")
     @FormUrlEncoded

diff --git a/app/src/main/java/com/x8bit/bitwarden/data/platform/datasource/network/api/ConfigApi.kt b/app/src/main/java/com/x8bit/bitwarden/data/platform/datasource/network/api/ConfigApi.kt
@@ -7,11 +7,7 @@ import retrofit2.http.GET
  * This interface defines the API service for fetching configuration data.
  */
 interface ConfigApi {
-    /**
-     * Retrieves the configuration data from the server.
-     *
-     * @return A [ConfigResponseJson] containing the configuration response model.
-     */
+
     @GET("config")
     suspend fun getConfig(): Result<ConfigResponseJson>
 }
diff --git a/detekt-config.yml b/detekt-config.yml
@@ -27,7 +27,7 @@ output-reports:
 
 comments:
   active: true
-  excludes: [ '**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**' ]
+  excludes: [ '**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**', '**ServiceImpl.kt' ]
   AbsentOrWrongFileLicense:
     active: false
     licenseTemplateFile: 'license.template'
@@ -46,7 +46,7 @@ comments:
     searchInInnerInterface: true
   UndocumentedPublicFunction:
     active: true
-    ignoreAnnotated: [ 'Module' ]
+    ignoreAnnotated: [ 'Module', 'POST', 'PUT', 'DELETE', 'GET', 'PATCH' ]
   UndocumentedPublicProperty:
     active: false