Skip to content

Commit 9827f7b

Browse files
fehguyfehguy
committed
updated sample with nicknames
1 parent a2d23af commit 9827f7b

File tree

3 files changed

+35
-18
lines changed

3 files changed

+35
-18
lines changed

‎samples/scala-play2/app/controllers/PetApiController.scala‎

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ class PetApiController extends BaseApiController {
2020
implicit request => JsonResponse(new value.ApiResponse(200, "Ok"))
2121
}
2222

23-
@ApiOperation(value = "Find pet by ID", notes = "Returns a pet", response = classOf[models.Pet], httpMethod = "GET")
23+
@ApiOperation(nickname = "getPetById", value = "Find pet by ID", notes = "Returns a pet", response = classOf[models.Pet], httpMethod = "GET")
2424
@ApiResponses(Array(
2525
new ApiResponse(code = 400, message = "Invalid ID supplied"),
2626
new ApiResponse(code = 404, message = "Pet not found")))
@@ -33,7 +33,8 @@ class PetApiController extends BaseApiController {
3333
}
3434
}
3535

36-
@ApiOperation(value = "Add a new Pet",
36+
@ApiOperation(nickname = "addPet",
37+
value = "Add a new Pet",
3738
response = classOf[Void],
3839
httpMethod = "POST",
3940
authorizations = Array(new Authorization(value="oauth2",
@@ -57,7 +58,8 @@ class PetApiController extends BaseApiController {
5758
}
5859
}
5960

60-
@ApiOperation(value = "Update an existing Pet", response = classOf[Void], httpMethod = "PUT")
61+
@ApiOperation(nickname = "updatePet",
62+
value = "Update an existing Pet", response = classOf[Void], httpMethod = "PUT")
6163
@ApiResponses(Array(
6264
new ApiResponse(code = 400, message = "Invalid ID supplied"),
6365
new ApiResponse(code = 404, message = "Pet not found"),
@@ -76,7 +78,8 @@ class PetApiController extends BaseApiController {
7678
}
7779
}
7880

79-
@ApiOperation(value = "Finds Pets by status",
81+
@ApiOperation(nickname = "findPetByStatus",
82+
value = "Finds Pets by status",
8083
notes = "Multiple status values can be provided with comma seperated strings",
8184
response = classOf[models.Pet], responseContainer = "List", httpMethod = "GET")
8285
@ApiResponses(Array(
@@ -89,7 +92,8 @@ class PetApiController extends BaseApiController {
8992
JsonResponse(results)
9093
}
9194

92-
@ApiOperation(value = "Finds Pets by tags",
95+
@ApiOperation(nickname = "findPetsByTags",
96+
value = "Finds Pets by tags",
9397
notes = "Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.",
9498
response = classOf[models.Pet], responseContainer = "List", httpMethod = "GET")
9599
@ApiResponses(Array(
@@ -102,7 +106,8 @@ class PetApiController extends BaseApiController {
102106
JsonResponse(results)
103107
}
104108

105-
@ApiOperation(value = "Attach an Image File for a pet",
109+
@ApiOperation(nickname = "attachImage",
110+
value = "Attach an Image File for a pet",
106111
notes = "Is not functional, only used to test file upload params",
107112
response = classOf[Void], httpMethod = "GET")
108113
@ApiResponses(Array(

‎samples/scala-play2/app/controllers/StoreApiController.scala‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ import scala.collection.JavaConverters._
2222
object StoreApiController extends BaseApiController {
2323
var storeData = new StoreData
2424

25-
@ApiOperation(value = "Find purchase order by ID", notes = "For valid response try integer IDs with value <= 5. " +
25+
@ApiOperation(nickname = "getOrderById",
26+
value = "Find purchase order by ID", notes = "For valid response try integer IDs with value <= 5. " +
2627
"Anything above 5 or nonintegers will generate API errors", response = classOf[models.Order], httpMethod = "GET")
2728
@ApiResponses(value = Array(
2829
new ApiResponse(code = 400, message = "Invalid ID supplied"),
@@ -35,15 +36,17 @@ object StoreApiController extends BaseApiController {
3536
}
3637
}
3738

38-
@ApiOperation(value = "Gets orders in the system", response = classOf[models.Order], httpMethod = "GET", responseContainer = "List")
39+
@ApiOperation(nickname = "getOrders",
40+
value = "Gets orders in the system", response = classOf[models.Order], httpMethod = "GET", responseContainer = "List")
3941
@ApiResponses(Array(
4042
new ApiResponse(code = 404, message = "No Orders found")))
4143
def getOrders(@ApiImplicitParam(value = "Get all orders or only those which are complete", dataType = "Boolean", required = true)@QueryParam("isComplete") isComplete: Boolean) = Action { implicit request =>
4244
val orders: java.util.List[Order] = storeData.orders.toList.asJava
4345
JsonResponse(orders)
4446
}
4547

46-
@ApiOperation(value = "Place an order for a pet", response = classOf[Void], httpMethod = "POST")
48+
@ApiOperation(nickname = "placeOrder",
49+
value = "Place an order for a pet", response = classOf[Void], httpMethod = "POST")
4750
@ApiResponses(Array(
4851
new ApiResponse(code = 400, message = "Invalid order")))
4952
@ApiImplicitParams(Array(
@@ -59,7 +62,8 @@ object StoreApiController extends BaseApiController {
5962
}
6063
}
6164

62-
@ApiOperation(value = "Delete purchase order by ID", notes = "For valid response try integer IDs with value < 1000. " +
65+
@ApiOperation(nickname = "deleteOrder",
66+
value = "Delete purchase order by ID", notes = "For valid response try integer IDs with value < 1000. " +
6367
"Anything above 1000 or nonintegers will generate API errors", httpMethod = "DELETE")
6468
@ApiResponses(Array(
6569
new ApiResponse(code = 400, message = "Invalid ID supplied"),

‎samples/scala-play2/app/controllers/UserApiController.scala‎

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@ import java.io.StringWriter
2121
object UserApiController extends BaseApiController {
2222
var userData = new UserData
2323

24-
@ApiOperation(value = "Create user", notes = "This can only be done by the logged in user.", httpMethod = "POST" )
24+
@ApiOperation(nickname = "createUser",
25+
value = "Create user", notes = "This can only be done by the logged in user.", httpMethod = "POST" )
2526
@ApiImplicitParams(Array(
2627
new ApiImplicitParam(name = "body", value = "Created user object", required = true, dataType = "User", paramType = "body")))
2728
def createUser = Action { implicit request =>
@@ -35,7 +36,8 @@ object UserApiController extends BaseApiController {
3536
}
3637
}
3738

38-
@ApiOperation(value = "Creates list of users with given input array", response = classOf[Void], httpMethod = "POST")
39+
@ApiOperation(nickname = "createUsersWithArrayInput",
40+
value = "Creates list of users with given input array", response = classOf[Void], httpMethod = "POST")
3941
@ApiImplicitParams(Array(
4042
new ApiImplicitParam(name = "body", value = "List of user object", required = true, dataType = "Array[User]", paramType = "body")))
4143
def createUsersWithArrayInput = Action { implicit request =>
@@ -49,7 +51,8 @@ object UserApiController extends BaseApiController {
4951
}
5052
}
5153

52-
@ApiOperation(value = "Creates list of users with given list input", response = classOf[Void], httpMethod = "POST")
54+
@ApiOperation(nickname = "createUsersWithListInput",
55+
value = "Creates list of users with given list input", response = classOf[Void], httpMethod = "POST")
5356
@ApiImplicitParams(Array(
5457
new ApiImplicitParam(name = "body", value = "List of user object", required = true, dataType = "List[User]", paramType = "body")))
5558
def createUsersWithListInput = Action { implicit request =>
@@ -63,7 +66,8 @@ object UserApiController extends BaseApiController {
6366
}
6467
}
6568

66-
@ApiOperation(value = "Updated user", notes = "This can only be done by the logged in user.", httpMethod = "PUT")
69+
@ApiOperation(nickname = "updateUser",
70+
value = "Updated user", notes = "This can only be done by the logged in user.", httpMethod = "PUT")
6771
@ApiResponses(Array(
6872
new ApiResponse(code = 400, message = "Invalid username supplied"),
6973
new ApiResponse(code = 404, message = "User not found")))
@@ -81,7 +85,8 @@ object UserApiController extends BaseApiController {
8185
}
8286
}
8387

84-
@ApiOperation(value = "Delete user", notes = "This can only be done by the logged in user.", httpMethod = "DELETE")
88+
@ApiOperation(nickname = "deleteUser",
89+
value = "Delete user", notes = "This can only be done by the logged in user.", httpMethod = "DELETE")
8590
@ApiResponses(Array(
8691
new ApiResponse(code = 400, message = "Invalid username supplied"),
8792
new ApiResponse(code = 404, message = "User not found")))
@@ -91,7 +96,8 @@ object UserApiController extends BaseApiController {
9196
Ok
9297
}
9398

94-
@ApiOperation(value = "Get user by user name", response = classOf[models.User], httpMethod = "GET")
99+
@ApiOperation(nickname = "getUserByName",
100+
value = "Get user by user name", response = classOf[models.User], httpMethod = "GET")
95101
@ApiResponses(Array(
96102
new ApiResponse(code = 400, message = "Invalid username supplied"),
97103
new ApiResponse(code = 404, message = "User not found")))
@@ -103,7 +109,8 @@ object UserApiController extends BaseApiController {
103109
}
104110
}
105111

106-
@ApiOperation(value = "Logs user into the system", response = classOf[String], httpMethod = "GET")
112+
@ApiOperation(nickname = "loginUser",
113+
value = "Logs user into the system", response = classOf[String], httpMethod = "GET")
107114
@ApiResponses(Array(
108115
new ApiResponse(code = 400, message = "Invalid username and password combination")))
109116
def loginUser(
@@ -112,7 +119,8 @@ object UserApiController extends BaseApiController {
112119
JsonResponse("logged in user session:" + System.currentTimeMillis())
113120
}
114121

115-
@ApiOperation(value = "Logs out current logged in user session", httpMethod = "GET")
122+
@ApiOperation(nickname = "logoutUser",
123+
value = "Logs out current logged in user session", httpMethod = "GET")
116124
def logoutUser() = Action { implicit request =>
117125
Ok
118126
}

0 commit comments

Comments
 (0)