feat: Added HTTP method+path to JavaDocs in kotlin retrofit2 client

Author: ranger-ross

modules/openapi-generator/src/main/resources/kotlin-client/libraries/jvm-retrofit2/api.mustache

@@ -131,6 +131,7 @@ import okhttp3.MultipartBody
     {{/isEnum}}
     {{/allParams}}
     /**
+     * {{{httpMethod}}} {{{path}}}
      * {{summary}}
      * {{notes}}
      * Responses:{{#responses}}

samples/client/echo_api/kotlin-model-prefix-type-mappings/src/main/kotlin/org/openapitools/client/apis/AuthApi.kt

@@ -9,6 +9,7 @@ import com.google.gson.annotations.SerializedName
 
 interface AuthApi {
     /**
+     * POST auth/http/basic
      * To test HTTP basic authentication
      * To test HTTP basic authentication
      * Responses:
@@ -20,6 +21,7 @@ interface AuthApi {
     suspend fun testAuthHttpBasic(): Response<kotlin.String>
 
     /**
+     * POST auth/http/bearer
      * To test HTTP bearer authentication
      * To test HTTP bearer authentication
      * Responses:

samples/client/echo_api/kotlin-model-prefix-type-mappings/src/main/kotlin/org/openapitools/client/apis/BodyApi.kt

@@ -14,6 +14,7 @@ import okhttp3.MultipartBody
 
 interface BodyApi {
     /**
+     * POST binary/gif
      * Test binary (gif) response body
      * Test binary (gif) response body
      * Responses:
@@ -25,6 +26,7 @@ interface BodyApi {
     suspend fun testBinaryGif(): Response<ResponseBody>
 
     /**
+     * POST body/application/octetstream/binary
      * Test body parameter(s)
      * Test body parameter(s)
      * Responses:
@@ -37,6 +39,7 @@ interface BodyApi {
     suspend fun testBodyApplicationOctetstreamBinary(@Body body: RequestBody? = null): Response<kotlin.String>
 
     /**
+     * POST body/application/octetstream/array_of_binary
      * Test array of binary in multipart mime
      * Test array of binary in multipart mime
      * Responses:
@@ -50,6 +53,7 @@ interface BodyApi {
     suspend fun testBodyMultipartFormdataArrayOfBinary(@Part files: MultipartBody.Part): Response<kotlin.String>
 
     /**
+     * POST body/application/octetstream/single_binary
      * Test single binary in multipart mime
      * Test single binary in multipart mime
      * Responses:
@@ -63,6 +67,7 @@ interface BodyApi {
     suspend fun testBodyMultipartFormdataSingleBinary(@Part myFile: MultipartBody.Part? = null): Response<kotlin.String>
 
     /**
+     * POST echo/body/FreeFormObject/response_string
      * Test free form object
      * Test free form object
      * Responses:
@@ -75,6 +80,7 @@ interface BodyApi {
     suspend fun testEchoBodyFreeFormObjectResponseString(@Body body: kotlin.Any? = null): Response<kotlin.String>
 
     /**
+     * POST echo/body/Pet
      * Test body parameter(s)
      * Test body parameter(s)
      * Responses:
@@ -87,6 +93,7 @@ interface BodyApi {
     suspend fun testEchoBodyPet(@Body apiPet: ApiPet? = null): Response<ApiPet>
 
     /**
+     * POST echo/body/Pet/response_string
      * Test empty response body
      * Test empty response body
      * Responses:
@@ -99,6 +106,7 @@ interface BodyApi {
     suspend fun testEchoBodyPetResponseString(@Body apiPet: ApiPet? = null): Response<kotlin.String>
 
     /**
+     * POST echo/body/Tag/response_string
      * Test empty json (request body)
      * Test empty json (request body)
      * Responses:

samples/client/echo_api/kotlin-model-prefix-type-mappings/src/main/kotlin/org/openapitools/client/apis/FormApi.kt

@@ -9,6 +9,7 @@ import com.google.gson.annotations.SerializedName
 
 interface FormApi {
     /**
+     * POST form/integer/boolean/string
      * Test form parameter(s)
      * Test form parameter(s)
      * Responses:
@@ -24,6 +25,7 @@ interface FormApi {
     suspend fun testFormIntegerBooleanString(@Field("integer_form") integerForm: kotlin.Int? = null, @Field("boolean_form") booleanForm: kotlin.Boolean? = null, @Field("string_form") stringForm: kotlin.String? = null): Response<kotlin.String>
 
     /**
+     * POST form/oneof
      * Test form parameter(s) for oneOf schema
      * Test form parameter(s) for oneOf schema
      * Responses:

samples/client/echo_api/kotlin-model-prefix-type-mappings/src/main/kotlin/org/openapitools/client/apis/HeaderApi.kt

@@ -20,6 +20,7 @@ interface HeaderApi {
     }
 
     /**
+     * GET header/integer/boolean/string/enums
      * Test header parameter(s)
      * Test header parameter(s)
      * Responses:

samples/client/echo_api/kotlin-model-prefix-type-mappings/src/main/kotlin/org/openapitools/client/apis/PathApi.kt

@@ -20,6 +20,7 @@ interface PathApi {
     }
 
     /**
+     * GET path/string/{path_string}/integer/{path_integer}/{enum_nonref_string_path}/{enum_ref_string_path}
      * Test path parameter(s)
      * Test path parameter(s)
      * Responses:

samples/client/echo_api/kotlin-model-prefix-type-mappings/src/main/kotlin/org/openapitools/client/apis/QueryApi.kt

@@ -24,6 +24,7 @@ interface QueryApi {
     }
 
     /**
+     * GET query/enum_ref_string
      * Test query parameter(s)
      * Test query parameter(s)
      * Responses:
@@ -37,6 +38,7 @@ interface QueryApi {
     suspend fun testEnumRefString(@Query("enum_nonref_string_query") enumNonrefStringQuery: EnumNonrefStringQueryTestEnumRefString? = null, @Query("enum_ref_string_query") enumRefStringQuery: ApiStringEnumRef? = null): Response<kotlin.String>
 
     /**
+     * GET query/datetime/date/string
      * Test query parameter(s)
      * Test query parameter(s)
      * Responses:
@@ -51,6 +53,7 @@ interface QueryApi {
     suspend fun testQueryDatetimeDateString(@Query("datetime_query") datetimeQuery: java.time.OffsetDateTime? = null, @Query("date_query") dateQuery: java.time.LocalDate? = null, @Query("string_query") stringQuery: kotlin.String? = null): Response<kotlin.String>
 
     /**
+     * GET query/integer/boolean/string
      * Test query parameter(s)
      * Test query parameter(s)
      * Responses:
@@ -65,6 +68,7 @@ interface QueryApi {
     suspend fun testQueryIntegerBooleanString(@Query("integer_query") integerQuery: kotlin.Int? = null, @Query("boolean_query") booleanQuery: kotlin.Boolean? = null, @Query("string_query") stringQuery: kotlin.String? = null): Response<kotlin.String>
 
     /**
+     * GET query/style_deepObject/explode_true/object
      * Test query parameter(s)
      * Test query parameter(s)
      * Responses:
@@ -77,6 +81,7 @@ interface QueryApi {
     suspend fun testQueryStyleDeepObjectExplodeTrueObject(@Query("query_object") queryObject: ApiPet? = null): Response<kotlin.String>
 
     /**
+     * GET query/style_form/explode_true/array_string
      * Test query parameter(s)
      * Test query parameter(s)
      * Responses:
@@ -89,6 +94,7 @@ interface QueryApi {
     suspend fun testQueryStyleFormExplodeTrueArrayString(@Query("values") values: kotlin.collections.List<kotlin.String>? = null): Response<kotlin.String>
 
     /**
+     * GET query/style_form/explode_true/object
      * Test query parameter(s)
      * Test query parameter(s)
      * Responses:

samples/client/petstore/kotlin-default-values-jvm-retrofit2/src/main/kotlin/org/openapitools/client/apis/DefaultApi.kt

@@ -9,6 +9,7 @@ import com.squareup.moshi.Json
 
 interface DefaultApi {
     /**
+     * POST test
      * Tests default values
      * Tests default values of different parameters
      * Responses:

samples/client/petstore/kotlin-jvm-jackson/src/main/kotlin/org/openapitools/client/apis/PetApi.kt

@@ -13,6 +13,7 @@ import okhttp3.MultipartBody
 
 interface PetApi {
     /**
+     * POST pet
      * Add a new pet to the store
      * 
      * Responses:
@@ -26,6 +27,7 @@ interface PetApi {
     fun addPet(@Body pet: Pet): Call<Pet>
 
     /**
+     * DELETE pet/{petId}
      * Deletes a pet
      * 
      * Responses:
@@ -49,6 +51,7 @@ interface PetApi {
     }
 
     /**
+     * GET pet/findByStatus
      * Finds Pets by status
      * Multiple status values can be provided with comma separated strings
      * Responses:
@@ -62,6 +65,7 @@ interface PetApi {
     fun findPetsByStatus(@Query("status") status: CSVParams): Call<kotlin.collections.List<Pet>>
 
     /**
+     * GET pet/findByTags
      * Finds Pets by tags
      * Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
      * Responses:
@@ -76,6 +80,7 @@ interface PetApi {
     fun findPetsByTags(@Query("tags") tags: CSVParams): Call<kotlin.collections.List<Pet>>
 
     /**
+     * GET pet/{petId}
      * Find pet by ID
      * Returns a single pet
      * Responses:
@@ -90,6 +95,7 @@ interface PetApi {
     fun getPetById(@Path("petId") petId: kotlin.Long): Call<Pet>
 
     /**
+     * PUT pet
      * Update an existing pet
      * 
      * Responses:
@@ -105,6 +111,7 @@ interface PetApi {
     fun updatePet(@Body pet: Pet): Call<Pet>
 
     /**
+     * POST pet/{petId}
      * Updates a pet in the store with form data
      * 
      * Responses:
@@ -120,6 +127,7 @@ interface PetApi {
     fun updatePetWithForm(@Path("petId") petId: kotlin.Long, @Field("name") name: kotlin.String? = null, @Field("status") status: kotlin.String? = null): Call<Unit>
 
     /**
+     * POST pet/{petId}/uploadImage
      * uploads an image
      * 
      * Responses:

samples/client/petstore/kotlin-jvm-jackson/src/main/kotlin/org/openapitools/client/apis/StoreApi.kt

@@ -10,6 +10,7 @@ import org.openapitools.client.models.Order
 
 interface StoreApi {
     /**
+     * DELETE store/order/{orderId}
      * Delete purchase order by ID
      * For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
      * Responses:
@@ -23,6 +24,7 @@ interface StoreApi {
     fun deleteOrder(@Path("orderId") orderId: kotlin.String): Call<Unit>
 
     /**
+     * GET store/inventory
      * Returns pet inventories by status
      * Returns a map of status codes to quantities
      * Responses:
@@ -34,6 +36,7 @@ interface StoreApi {
     fun getInventory(): Call<kotlin.collections.Map<kotlin.String, kotlin.Int>>
 
     /**
+     * GET store/order/{orderId}
      * Find purchase order by ID
      * For valid response try integer IDs with value &lt;&#x3D; 5 or &gt; 10. Other values will generate exceptions
      * Responses:
@@ -48,6 +51,7 @@ interface StoreApi {
     fun getOrderById(@Path("orderId") orderId: kotlin.Long): Call<Order>
 
     /**
+     * POST store/order
      * Place an order for a pet
      * 
      * Responses: