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

16
samples/client/others/kotlin-jvm-okhttp-non-ascii-headers/src/main/kotlin/org/openapitools/client/apis/PetApi.kt
View File

@@ -47,6 +47,7 @@ class PetApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory = A
}
/**
* POST /pet
* Add a new pet to the store
*
* @param pet Pet object that needs to be added to the store
@@ -78,6 +79,7 @@ class PetApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory = A
}
/**
* POST /pet
* Add a new pet to the store
*
* @param pet Pet object that needs to be added to the store
@@ -119,6 +121,7 @@ class PetApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory = A
}
/**
* DELETE /pet/{petId}
* Deletes a pet
*
* @param petId Pet id to delete
@@ -150,6 +153,7 @@ class PetApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory = A
}
/**
* DELETE /pet/{petId}
* Deletes a pet
*
* @param petId Pet id to delete
@@ -209,6 +213,7 @@ class PetApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory = A
}
/**
* GET /pet/findByStatus
* Finds Pets by status
* Multiple status values can be provided with comma separated strings
* @param status Status values that need to be considered for filter
@@ -240,6 +245,7 @@ class PetApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory = A
}
/**
* GET /pet/findByStatus
* Finds Pets by status
* Multiple status values can be provided with comma separated strings
* @param status Status values that need to be considered for filter
@@ -283,6 +289,7 @@ class PetApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory = A
}
/**
* GET /pet/findByTags
* Finds Pets by tags
* Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
* @param tags Tags to filter by
@@ -316,6 +323,7 @@ class PetApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory = A
}
/**
* GET /pet/findByTags
* Finds Pets by tags
* Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
* @param tags Tags to filter by
@@ -362,6 +370,7 @@ class PetApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory = A
}
/**
* GET /pet/{petId}
* Find pet by ID
* Returns a single pet
* @param petId ID of pet to return
@@ -393,6 +402,7 @@ class PetApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory = A
}
/**
* GET /pet/{petId}
* Find pet by ID
* Returns a single pet
* @param petId ID of pet to return
@@ -433,6 +443,7 @@ class PetApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory = A
}
/**
* PUT /pet
* Update an existing pet
*
* @param pet Pet object that needs to be added to the store
@@ -464,6 +475,7 @@ class PetApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory = A
}
/**
* PUT /pet
* Update an existing pet
*
* @param pet Pet object that needs to be added to the store
@@ -505,6 +517,7 @@ class PetApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory = A
}
/**
* POST /pet/{petId}
* Updates a pet in the store with form data
*
* @param petId ID of pet that needs to be updated
@@ -537,6 +550,7 @@ class PetApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory = A
}
/**
* POST /pet/{petId}
* Updates a pet in the store with form data
*
* @param petId ID of pet that needs to be updated
@@ -581,6 +595,7 @@ class PetApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory = A
}
/**
* POST /pet/{petId}/uploadImage
* uploads an image
*
* @param petId ID of pet to update
@@ -614,6 +629,7 @@ class PetApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory = A
}
/**
* POST /pet/{petId}/uploadImage
* uploads an image
*
* @param petId ID of pet to update

8
samples/client/others/kotlin-jvm-okhttp-non-ascii-headers/src/main/kotlin/org/openapitools/client/apis/StoreApi.kt
View File

@@ -46,6 +46,7 @@ class StoreApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* 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
* @param orderId ID of the order that needs to be deleted
@@ -76,6 +77,7 @@ class StoreApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* 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
* @param orderId ID of the order that needs to be deleted
@@ -114,6 +116,7 @@ class StoreApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* GET /store/inventory
* Returns pet inventories by status
* Returns a map of status codes to quantities
* @return kotlin.collections.Map<kotlin.String, kotlin.Int>
@@ -144,6 +147,7 @@ class StoreApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* GET /store/inventory
* Returns pet inventories by status
* Returns a map of status codes to quantities
* @return ApiResponse<kotlin.collections.Map<kotlin.String, kotlin.Int>?>
@@ -182,6 +186,7 @@ class StoreApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* 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
* @param orderId ID of pet that needs to be fetched
@@ -213,6 +218,7 @@ class StoreApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* 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
* @param orderId ID of pet that needs to be fetched
@@ -253,6 +259,7 @@ class StoreApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* POST /store/order
* Place an order for a pet
*
* @param order order placed for purchasing the pet
@@ -284,6 +291,7 @@ class StoreApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* POST /store/order
* Place an order for a pet
*
* @param order order placed for purchasing the pet

16
samples/client/others/kotlin-jvm-okhttp-non-ascii-headers/src/main/kotlin/org/openapitools/client/apis/UserApi.kt
View File

@@ -46,6 +46,7 @@ class UserApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* POST /user
* Create user
* This can only be done by the logged in user.
* @param user Created user object
@@ -76,6 +77,7 @@ class UserApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* POST /user
* Create user
* This can only be done by the logged in user.
* @param user Created user object
@@ -115,6 +117,7 @@ class UserApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* POST /user/createWithArray
* Creates list of users with given input array
*
* @param user List of user object
@@ -145,6 +148,7 @@ class UserApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* POST /user/createWithArray
* Creates list of users with given input array
*
* @param user List of user object
@@ -184,6 +188,7 @@ class UserApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* POST /user/createWithList
* Creates list of users with given input array
*
* @param user List of user object
@@ -214,6 +219,7 @@ class UserApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* POST /user/createWithList
* Creates list of users with given input array
*
* @param user List of user object
@@ -253,6 +259,7 @@ class UserApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* DELETE /user/{username}
* Delete user
* This can only be done by the logged in user.
* @param username The name that needs to be deleted
@@ -283,6 +290,7 @@ class UserApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* DELETE /user/{username}
* Delete user
* This can only be done by the logged in user.
* @param username The name that needs to be deleted
@@ -321,6 +329,7 @@ class UserApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* GET /user/{username}
* Get user by user name
*
* @param username The name that needs to be fetched. Use user1 for testing.
@@ -352,6 +361,7 @@ class UserApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* GET /user/{username}
* Get user by user name
*
* @param username The name that needs to be fetched. Use user1 for testing.
@@ -392,6 +402,7 @@ class UserApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* GET /user/login
* Logs user into the system
*
* @param username The user name for login
@@ -424,6 +435,7 @@ class UserApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* GET /user/login
* Logs user into the system
*
* @param username The user name for login
@@ -470,6 +482,7 @@ class UserApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* GET /user/logout
* Logs out current logged in user session
*
* @return void
@@ -499,6 +512,7 @@ class UserApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* GET /user/logout
* Logs out current logged in user session
*
* @return ApiResponse<Unit?>
@@ -535,6 +549,7 @@ class UserApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* PUT /user/{username}
* Updated user
* This can only be done by the logged in user.
* @param username name that need to be deleted
@@ -566,6 +581,7 @@ class UserApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* PUT /user/{username}
* Updated user
* This can only be done by the logged in user.
* @param username name that need to be deleted