mirror of
https://github.com/OpenAPITools/openapi-generator.git
synced 2025-12-20 01:47:07 +00:00
update samples, docs
This commit is contained in:
@@ -40,6 +40,7 @@ import kotlin.collections.Map
|
||||
interface PetApi {
|
||||
|
||||
@Operation(
|
||||
tags = ["pet",],
|
||||
summary = "Add a new pet to the store",
|
||||
operationId = "addPet",
|
||||
description = """""",
|
||||
@@ -58,6 +59,7 @@ interface PetApi {
|
||||
}
|
||||
|
||||
@Operation(
|
||||
tags = ["pet",],
|
||||
summary = "Deletes a pet",
|
||||
operationId = "deletePet",
|
||||
description = """""",
|
||||
@@ -75,6 +77,7 @@ interface PetApi {
|
||||
}
|
||||
|
||||
@Operation(
|
||||
tags = ["pet",],
|
||||
summary = "Finds Pets by status",
|
||||
operationId = "findPetsByStatus",
|
||||
description = """Multiple status values can be provided with comma separated strings""",
|
||||
@@ -94,6 +97,7 @@ interface PetApi {
|
||||
}
|
||||
|
||||
@Operation(
|
||||
tags = ["pet",],
|
||||
summary = "Finds Pets by tags",
|
||||
operationId = "findPetsByTags",
|
||||
description = """Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.""",
|
||||
@@ -113,6 +117,7 @@ interface PetApi {
|
||||
}
|
||||
|
||||
@Operation(
|
||||
tags = ["pet",],
|
||||
summary = "Find pet by ID",
|
||||
operationId = "getPetById",
|
||||
description = """Returns a single pet""",
|
||||
@@ -133,6 +138,7 @@ interface PetApi {
|
||||
}
|
||||
|
||||
@Operation(
|
||||
tags = ["pet",],
|
||||
summary = "Update an existing pet",
|
||||
operationId = "updatePet",
|
||||
description = """""",
|
||||
@@ -153,6 +159,7 @@ interface PetApi {
|
||||
}
|
||||
|
||||
@Operation(
|
||||
tags = ["pet",],
|
||||
summary = "Updates a pet in the store with form data",
|
||||
operationId = "updatePetWithForm",
|
||||
description = """""",
|
||||
@@ -171,6 +178,7 @@ interface PetApi {
|
||||
}
|
||||
|
||||
@Operation(
|
||||
tags = ["pet",],
|
||||
summary = "uploads an image",
|
||||
operationId = "uploadFile",
|
||||
description = """""",
|
||||
|
||||
@@ -39,6 +39,7 @@ import kotlin.collections.Map
|
||||
interface StoreApi {
|
||||
|
||||
@Operation(
|
||||
tags = ["store",],
|
||||
summary = "Delete purchase order by ID",
|
||||
operationId = "deleteOrder",
|
||||
description = """For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors""",
|
||||
@@ -56,6 +57,7 @@ interface StoreApi {
|
||||
}
|
||||
|
||||
@Operation(
|
||||
tags = ["store",],
|
||||
summary = "Returns pet inventories by status",
|
||||
operationId = "getInventory",
|
||||
description = """Returns a map of status codes to quantities""",
|
||||
@@ -74,6 +76,7 @@ interface StoreApi {
|
||||
}
|
||||
|
||||
@Operation(
|
||||
tags = ["store",],
|
||||
summary = "Find purchase order by ID",
|
||||
operationId = "getOrderById",
|
||||
description = """For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions""",
|
||||
@@ -93,6 +96,7 @@ interface StoreApi {
|
||||
}
|
||||
|
||||
@Operation(
|
||||
tags = ["store",],
|
||||
summary = "Place an order for a pet",
|
||||
operationId = "placeOrder",
|
||||
description = """""",
|
||||
|
||||
@@ -39,6 +39,7 @@ import kotlin.collections.Map
|
||||
interface UserApi {
|
||||
|
||||
@Operation(
|
||||
tags = ["user",],
|
||||
summary = "Create user",
|
||||
operationId = "createUser",
|
||||
description = """This can only be done by the logged in user.""",
|
||||
@@ -55,6 +56,7 @@ interface UserApi {
|
||||
}
|
||||
|
||||
@Operation(
|
||||
tags = ["user",],
|
||||
summary = "Creates list of users with given input array",
|
||||
operationId = "createUsersWithArrayInput",
|
||||
description = """""",
|
||||
@@ -71,6 +73,7 @@ interface UserApi {
|
||||
}
|
||||
|
||||
@Operation(
|
||||
tags = ["user",],
|
||||
summary = "Creates list of users with given input array",
|
||||
operationId = "createUsersWithListInput",
|
||||
description = """""",
|
||||
@@ -87,6 +90,7 @@ interface UserApi {
|
||||
}
|
||||
|
||||
@Operation(
|
||||
tags = ["user",],
|
||||
summary = "Delete user",
|
||||
operationId = "deleteUser",
|
||||
description = """This can only be done by the logged in user.""",
|
||||
@@ -104,6 +108,7 @@ interface UserApi {
|
||||
}
|
||||
|
||||
@Operation(
|
||||
tags = ["user",],
|
||||
summary = "Get user by user name",
|
||||
operationId = "getUserByName",
|
||||
description = """""",
|
||||
@@ -123,6 +128,7 @@ interface UserApi {
|
||||
}
|
||||
|
||||
@Operation(
|
||||
tags = ["user",],
|
||||
summary = "Logs user into the system",
|
||||
operationId = "loginUser",
|
||||
description = """""",
|
||||
@@ -141,6 +147,7 @@ interface UserApi {
|
||||
}
|
||||
|
||||
@Operation(
|
||||
tags = ["user",],
|
||||
summary = "Logs out current logged in user session",
|
||||
operationId = "logoutUser",
|
||||
description = """""",
|
||||
@@ -157,6 +164,7 @@ interface UserApi {
|
||||
}
|
||||
|
||||
@Operation(
|
||||
tags = ["user",],
|
||||
summary = "Updated user",
|
||||
operationId = "updateUser",
|
||||
description = """This can only be done by the logged in user.""",
|
||||
|
||||
Reference in New Issue
Block a user