From 592f36a15daeade0d2a70d5408027a4518b23fee Mon Sep 17 00:00:00 2001 From: Florian Sabonchi Date: Sun, 6 Nov 2022 23:03:00 +0100 Subject: [PATCH 1/2] feat: update of api route naming to emergency-room --- docs/docs.go | 5 +---- docs/swagger.json | 5 +---- docs/swagger.yaml | 4 +--- main.go | 10 +++++----- 4 files changed, 8 insertions(+), 16 deletions(-) diff --git a/docs/docs.go b/docs/docs.go index 89a4033..a4e3545 100644 --- a/docs/docs.go +++ b/docs/docs.go @@ -294,16 +294,13 @@ const docTemplate = `{ "lastPage": { "type": "boolean" }, - "numPages": { - "type": "integer" - }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, - "totalSite": { + "totalSize": { "type": "integer" } } diff --git a/docs/swagger.json b/docs/swagger.json index 3bac5b2..aaa75f7 100644 --- a/docs/swagger.json +++ b/docs/swagger.json @@ -282,16 +282,13 @@ "lastPage": { "type": "boolean" }, - "numPages": { - "type": "integer" - }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, - "totalSite": { + "totalSize": { "type": "integer" } } diff --git a/docs/swagger.yaml b/docs/swagger.yaml index 8ac27e0..35acae8 100644 --- a/docs/swagger.yaml +++ b/docs/swagger.yaml @@ -24,13 +24,11 @@ definitions: type: array lastPage: type: boolean - numPages: - type: integer page: type: integer pageSize: type: integer - totalSite: + totalSize: type: integer type: object routes.GetSingleERResponse: diff --git a/main.go b/main.go index b9b348f..5f10b05 100644 --- a/main.go +++ b/main.go @@ -33,11 +33,11 @@ func setupRouter() *gin.Engine { v1.GET("/healthz", routes.HealthzRoute) v1.GET("/version", routes.VersionRoute(Version)) - v1.PUT("/er", routes.AuthMiddleware(), routes.CreateEmergencyRoom) - v1.GET("/er", routes.GetEmergencyRooms) - v1.GET("/er/:id", routes.GetEmergencyRoomById) - v1.PATCH("/er/:id", routes.AuthMiddleware(), routes.UpdateEmergencyRoom) - v1.DELETE("/er/:id", routes.AuthMiddleware(), routes.DeleteEmergencyRoom) + v1.PUT("/emergency-room", routes.AuthMiddleware(), routes.CreateEmergencyRoom) + v1.GET("/emergency-room", routes.GetEmergencyRooms) + v1.GET("/emergency-room/:id", routes.GetEmergencyRoomById) + v1.PATCH("/emergency-room/:id", routes.AuthMiddleware(), routes.UpdateEmergencyRoom) + v1.DELETE("/emergency-room/:id", routes.AuthMiddleware(), routes.DeleteEmergencyRoom) return router } From 38e8a0532d4a8a1e0870cf9f2d9dc018cf16bc69 Mon Sep 17 00:00:00 2001 From: Florian Sabonchi Date: Sun, 6 Nov 2022 23:04:58 +0100 Subject: [PATCH 2/2] feat: update of api route comments --- routes/rooms.go | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/routes/rooms.go b/routes/rooms.go index 2a3d8b8..c3a661e 100644 --- a/routes/rooms.go +++ b/routes/rooms.go @@ -25,7 +25,7 @@ type GetSingleERResponse struct { // @Param id path string true "Emergency Room's ID" // @Success 200 {object} GetSingleERResponse // @Failure 400 {object} HTTPErrorResponse -// @Router /er/{id} [get] +// @Router /emergency-room/{id} [get] func GetEmergencyRoomById(ctx *gin.Context) { log, logCtx := logging.GetRequestLogger(ctx) db := models.GetDB(logCtx) @@ -65,7 +65,7 @@ func GetEmergencyRoomById(ctx *gin.Context) { // @Param page_size query uint false "page size, 100 is assumed when omitted" // @Success 200 {object} GetMultipleERsResponse // @Failure 400 {object} HTTPErrorResponse -// @Router /er [get] +// @Router /emergency-room [get] func GetEmergencyRooms(ctx *gin.Context) { _, logCtx := logging.GetRequestLogger(ctx) db := models.GetDB(logCtx) @@ -129,7 +129,7 @@ type PutERRequest struct { // @Success 200 {object} GetSingleERResponse // @Failure 400 {object} HTTPErrorResponse // @Failure 501 {object} HTTPErrorResponse -// @Router /er [put] +// @Router /emergency-room [put] func CreateEmergencyRoom(ctx *gin.Context) { log, logCtx := logging.GetRequestLogger(ctx) @@ -180,7 +180,7 @@ func CreateEmergencyRoom(ctx *gin.Context) { // @Param emergency-room body PutERRequest true "ER to update" // @Success 200 // @Failure 400 {object} HTTPErrorResponse -// @Router /er/{id} [patch] +// @Router /emergency-room/{id} [patch] func UpdateEmergencyRoom(ctx *gin.Context) { log, logCtx := logging.GetRequestLogger(ctx) db := models.GetDB(logCtx) @@ -231,7 +231,7 @@ func UpdateEmergencyRoom(ctx *gin.Context) { // @Param id path string true "Emergency Room's ID" // @Success 200 // @Failure 400 {object} HTTPErrorResponse -// @Router /er/{id} [delete] +// @Router /emergency-room/{id} [delete] func DeleteEmergencyRoom(ctx *gin.Context) { log, logCtx := logging.GetRequestLogger(ctx) db := models.GetDB(logCtx)