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

This commit is contained in:
Andrew Haisting 2023-09-21 11:50:55 -05:00 committed by Álison Fernandes
parent 35483408b2
commit 016f597d8c
4 changed files with 3 additions and 13 deletions

View file

@ -10,9 +10,6 @@ import retrofit2.http.POST
*/ */
interface AccountsApi { interface AccountsApi {
/**
* Make pre login request to get KDF params.
*/
@POST("/accounts/prelogin") @POST("/accounts/prelogin")
suspend fun preLogin(@Body body: PreLoginRequestJson): Result<PreLoginResponseJson> suspend fun preLogin(@Body body: PreLoginRequestJson): Result<PreLoginResponseJson>
} }

View file

@ -14,9 +14,6 @@ import java.util.UUID
*/ */
interface IdentityApi { interface IdentityApi {
/**
* Make request to get an access token.
*/
@POST @POST
@Suppress("LongParameterList") @Suppress("LongParameterList")
@FormUrlEncoded @FormUrlEncoded

View file

@ -7,11 +7,7 @@ import retrofit2.http.GET
* This interface defines the API service for fetching configuration data. * This interface defines the API service for fetching configuration data.
*/ */
interface ConfigApi { interface ConfigApi {
/**
* Retrieves the configuration data from the server.
*
* @return A [ConfigResponseJson] containing the configuration response model.
*/
@GET("config") @GET("config")
suspend fun getConfig(): Result<ConfigResponseJson> suspend fun getConfig(): Result<ConfigResponseJson>
} }

View file

@ -27,7 +27,7 @@ output-reports:
comments: comments:
active: true active: true
excludes: [ '**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**' ] excludes: [ '**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**', '**ServiceImpl.kt' ]
AbsentOrWrongFileLicense: AbsentOrWrongFileLicense:
active: false active: false
licenseTemplateFile: 'license.template' licenseTemplateFile: 'license.template'
@ -46,7 +46,7 @@ comments:
searchInInnerInterface: true searchInInnerInterface: true
UndocumentedPublicFunction: UndocumentedPublicFunction:
active: true active: true
ignoreAnnotated: [ 'Module' ] ignoreAnnotated: [ 'Module', 'POST', 'PUT', 'DELETE', 'GET', 'PATCH' ]
UndocumentedPublicProperty: UndocumentedPublicProperty:
active: false active: false