loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity

Added HTTP method+path to JavaDocs in kotlin clients (#20618)

Browse Source 
* feat: Added HTTP method+path to JavaDocs in kotlin OkHTTP client

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

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

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

* feat: Added HTTP method+path to JavaDocs in kotlin volley client
This commit is contained in:
Ross Sullivan
2025-02-09 22:55:23 +09:00
committed by GitHub
parent adbbe68d4d
commit e1130c343a
113 changed files with 1007 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
samples/client/echo_api/kotlin-jvm-okhttp/src/main/kotlin/org/openapitools/client/apis/AuthApi.kt
View File

@@ -45,6 +45,7 @@ class AuthApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* POST /auth/http/basic
* To test HTTP basic authentication
* To test HTTP basic authentication
* @return kotlin.String
@@ -75,6 +76,7 @@ class AuthApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* POST /auth/http/basic
* To test HTTP basic authentication
* To test HTTP basic authentication
* @return ApiResponse<kotlin.String?>
@@ -113,6 +115,7 @@ class AuthApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* POST /auth/http/bearer
* To test HTTP bearer authentication
* To test HTTP bearer authentication
* @return kotlin.String
@@ -143,6 +146,7 @@ class AuthApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* POST /auth/http/bearer
* To test HTTP bearer authentication
* To test HTTP bearer authentication
* @return ApiResponse<kotlin.String?>

16
samples/client/echo_api/kotlin-jvm-okhttp/src/main/kotlin/org/openapitools/client/apis/BodyApi.kt
View File

@@ -47,6 +47,7 @@ class BodyApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* POST /binary/gif
* Test binary (gif) response body
* Test binary (gif) response body
* @return java.io.File
@@ -77,6 +78,7 @@ class BodyApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* POST /binary/gif
* Test binary (gif) response body
* Test binary (gif) response body
* @return ApiResponse<java.io.File?>
@@ -114,6 +116,7 @@ class BodyApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* POST /body/application/octetstream/binary
* Test body parameter(s)
* Test body parameter(s)
* @param body (optional)
@@ -145,6 +148,7 @@ class BodyApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* POST /body/application/octetstream/binary
* Test body parameter(s)
* Test body parameter(s)
* @param body (optional)
@@ -186,6 +190,7 @@ class BodyApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* POST /body/application/octetstream/array_of_binary
* Test array of binary in multipart mime
* Test array of binary in multipart mime
* @param files
@@ -217,6 +222,7 @@ class BodyApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* POST /body/application/octetstream/array_of_binary
* Test array of binary in multipart mime
* Test array of binary in multipart mime
* @param files
@@ -258,6 +264,7 @@ class BodyApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* POST /body/application/octetstream/single_binary
* Test single binary in multipart mime
* Test single binary in multipart mime
* @param myFile (optional)
@@ -289,6 +296,7 @@ class BodyApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* POST /body/application/octetstream/single_binary
* Test single binary in multipart mime
* Test single binary in multipart mime
* @param myFile (optional)
@@ -330,6 +338,7 @@ class BodyApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* POST /echo/body/FreeFormObject/response_string
* Test free form object
* Test free form object
* @param body Free form object (optional)
@@ -361,6 +370,7 @@ class BodyApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* POST /echo/body/FreeFormObject/response_string
* Test free form object
* Test free form object
* @param body Free form object (optional)
@@ -402,6 +412,7 @@ class BodyApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* POST /echo/body/Pet
* Test body parameter(s)
* Test body parameter(s)
* @param apiPet Pet object that needs to be added to the store (optional)
@@ -433,6 +444,7 @@ class BodyApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* POST /echo/body/Pet
* Test body parameter(s)
* Test body parameter(s)
* @param apiPet Pet object that needs to be added to the store (optional)
@@ -474,6 +486,7 @@ class BodyApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* POST /echo/body/Pet/response_string
* Test empty response body
* Test empty response body
* @param apiPet Pet object that needs to be added to the store (optional)
@@ -505,6 +518,7 @@ class BodyApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* POST /echo/body/Pet/response_string
* Test empty response body
* Test empty response body
* @param apiPet Pet object that needs to be added to the store (optional)
@@ -546,6 +560,7 @@ class BodyApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* POST /echo/body/Tag/response_string
* Test empty json (request body)
* Test empty json (request body)
* @param apiTag Tag object (optional)
@@ -577,6 +592,7 @@ class BodyApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* POST /echo/body/Tag/response_string
* Test empty json (request body)
* Test empty json (request body)
* @param apiTag Tag object (optional)

4
samples/client/echo_api/kotlin-jvm-okhttp/src/main/kotlin/org/openapitools/client/apis/FormApi.kt
View File

@@ -45,6 +45,7 @@ class FormApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* POST /form/integer/boolean/string
* Test form parameter(s)
* Test form parameter(s)
* @param integerForm (optional)
@@ -78,6 +79,7 @@ class FormApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* POST /form/integer/boolean/string
* Test form parameter(s)
* Test form parameter(s)
* @param integerForm (optional)
@@ -125,6 +127,7 @@ class FormApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* POST /form/oneof
* Test form parameter(s) for oneOf schema
* Test form parameter(s) for oneOf schema
* @param form1 (optional)
@@ -161,6 +164,7 @@ class FormApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* POST /form/oneof
* Test form parameter(s) for oneOf schema
* Test form parameter(s) for oneOf schema
* @param form1 (optional)

2
samples/client/echo_api/kotlin-jvm-okhttp/src/main/kotlin/org/openapitools/client/apis/HeaderApi.kt
View File

@@ -64,6 +64,7 @@ class HeaderApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory
}
/**
* GET /header/integer/boolean/string/enums
* Test header parameter(s)
* Test header parameter(s)
* @param integerHeader (optional)
@@ -99,6 +100,7 @@ class HeaderApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory
}
/**
* GET /header/integer/boolean/string/enums
* Test header parameter(s)
* Test header parameter(s)
* @param integerHeader (optional)

2
samples/client/echo_api/kotlin-jvm-okhttp/src/main/kotlin/org/openapitools/client/apis/PathApi.kt
View File

@@ -64,6 +64,7 @@ class PathApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* GET /path/string/{path_string}/integer/{path_integer}/{enum_nonref_string_path}/{enum_ref_string_path}
* Test path parameter(s)
* Test path parameter(s)
* @param pathString
@@ -98,6 +99,7 @@ class PathApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* GET /path/string/{path_string}/integer/{path_integer}/{enum_nonref_string_path}/{enum_ref_string_path}
* Test path parameter(s)
* Test path parameter(s)
* @param pathString

12
samples/client/echo_api/kotlin-jvm-okhttp/src/main/kotlin/org/openapitools/client/apis/QueryApi.kt
View File

@@ -66,6 +66,7 @@ class QueryApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* GET /query/enum_ref_string
* Test query parameter(s)
* Test query parameter(s)
* @param enumNonrefStringQuery (optional)
@@ -98,6 +99,7 @@ class QueryApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* GET /query/enum_ref_string
* Test query parameter(s)
* Test query parameter(s)
* @param enumNonrefStringQuery (optional)
@@ -148,6 +150,7 @@ class QueryApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* GET /query/datetime/date/string
* Test query parameter(s)
* Test query parameter(s)
* @param datetimeQuery (optional)
@@ -181,6 +184,7 @@ class QueryApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* GET /query/datetime/date/string
* Test query parameter(s)
* Test query parameter(s)
* @param datetimeQuery (optional)
@@ -236,6 +240,7 @@ class QueryApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* GET /query/integer/boolean/string
* Test query parameter(s)
* Test query parameter(s)
* @param integerQuery (optional)
@@ -269,6 +274,7 @@ class QueryApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* GET /query/integer/boolean/string
* Test query parameter(s)
* Test query parameter(s)
* @param integerQuery (optional)
@@ -324,6 +330,7 @@ class QueryApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* GET /query/style_deepObject/explode_true/object
* Test query parameter(s)
* Test query parameter(s)
* @param queryObject (optional)
@@ -355,6 +362,7 @@ class QueryApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* GET /query/style_deepObject/explode_true/object
* Test query parameter(s)
* Test query parameter(s)
* @param queryObject (optional)
@@ -400,6 +408,7 @@ class QueryApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* GET /query/style_form/explode_true/array_string
* Test query parameter(s)
* Test query parameter(s)
* @param queryObject (optional)
@@ -431,6 +440,7 @@ class QueryApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* GET /query/style_form/explode_true/array_string
* Test query parameter(s)
* Test query parameter(s)
* @param queryObject (optional)
@@ -476,6 +486,7 @@ class QueryApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* GET /query/style_form/explode_true/object
* Test query parameter(s)
* Test query parameter(s)
* @param queryObject (optional)
@@ -507,6 +518,7 @@ class QueryApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* GET /query/style_form/explode_true/object
* Test query parameter(s)
* Test query parameter(s)
* @param queryObject (optional)