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/petstore/kotlin-json-request-string/src/main/kotlin/org/openapitools/client/apis/PetApi.kt
View File

@@ -48,6 +48,7 @@ class PetApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory = A
}
/**
* POST /pet
* Add a new pet to the store
*
* @param body 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 body Pet object that needs to be added to the store
@@ -117,6 +119,7 @@ class PetApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory = A
}
/**
* DELETE /pet/{petId}
* Deletes a pet
*
* @param petId Pet id to delete
@@ -148,6 +151,7 @@ class PetApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory = A
}
/**
* DELETE /pet/{petId}
* Deletes a pet
*
* @param petId Pet id to delete
@@ -189,6 +193,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
@@ -222,6 +227,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
@@ -268,6 +274,7 @@ class PetApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory = A
}
/**
* GET /pet/getAll
* Get all pets
*
* @param lastUpdated When this endpoint was hit last to help identify if the client already has the latest copy. (optional)
@@ -299,6 +306,7 @@ class PetApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory = A
}
/**
* GET /pet/getAll
* Get all pets
*
* @param lastUpdated When this endpoint was hit last to help identify if the client already has the latest copy. (optional)
@@ -344,6 +352,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
@@ -375,6 +384,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
@@ -415,6 +425,7 @@ class PetApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory = A
}
/**
* PUT /pet
* Update an existing pet
*
* @param body Pet object that needs to be added to the store
@@ -445,6 +456,7 @@ class PetApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory = A
}
/**
* PUT /pet
* Update an existing pet
*
* @param body Pet object that needs to be added to the store
@@ -484,6 +496,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
@@ -516,6 +529,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
@@ -560,6 +574,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
@@ -593,6 +608,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/petstore/kotlin-json-request-string/src/main/kotlin/org/openapitools/client/apis/StoreApi.kt
View File

@@ -47,6 +47,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
@@ -77,6 +78,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
@@ -115,6 +117,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>
@@ -145,6 +148,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>?>
@@ -183,6 +187,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
@@ -214,6 +219,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
@@ -254,6 +260,7 @@ class StoreApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* POST /store/order
* Place an order for a pet
*
* @param body order placed for purchasing the pet
@@ -285,6 +292,7 @@ class StoreApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* POST /store/order
* Place an order for a pet
*
* @param body order placed for purchasing the pet

16
samples/client/petstore/kotlin-json-request-string/src/main/kotlin/org/openapitools/client/apis/UserApi.kt
View File

@@ -47,6 +47,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 body Created user object
@@ -77,6 +78,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 body 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 body 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 body List of user object
@@ -183,6 +187,7 @@ class UserApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* POST /user/createWithList
* Creates list of users with given input array
*
* @param body List of user object
@@ -213,6 +218,7 @@ class UserApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* POST /user/createWithList
* Creates list of users with given input array
*
* @param body List of user object
@@ -251,6 +257,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
@@ -281,6 +288,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
@@ -319,6 +327,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.
@@ -350,6 +359,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.
@@ -390,6 +400,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
@@ -422,6 +433,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
@@ -468,6 +480,7 @@ class UserApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* GET /user/logout
* Logs out current logged in user session
*
* @return void
@@ -497,6 +510,7 @@ class UserApi(basePath: kotlin.String = defaultBasePath, client: Call.Factory =
}
/**
* GET /user/logout
* Logs out current logged in user session
*
* @return ApiResponse<Unit?>
@@ -533,6 +547,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
@@ -564,6 +579,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