[go] More idiomatic godoc comments (#10044)

* [go] More idiomatic godoc comments

* [go] Mark deprecated fields and functions

* [go] Minor mustache readability/consistency fixes

* [go] Mark deprecated operation parameters

* [go] Deprecate a petstore component property for testing

* [go] Apply deprecated godoc in Go servers also
This commit is contained in:
Nathan Baulch
2021-08-03 19:11:16 +10:00
committed by GitHub
parent 4210b41f84
commit c1c5775271
178 changed files with 2344 additions and 2169 deletions

View File

@@ -17,64 +17,64 @@ func main() {
e.Use(middleware.Recover())
// AddPet - Add a new pet to the store
// AddPet - Add a new pet to the store
e.POST("/v2/pet", c.AddPet)
// DeletePet - Deletes a pet
// DeletePet - Deletes a pet
e.DELETE("/v2/pet/:petId", c.DeletePet)
// FindPetsByStatus - Finds Pets by status
// FindPetsByStatus - Finds Pets by status
e.GET("/v2/pet/findByStatus", c.FindPetsByStatus)
// FindPetsByTags - Finds Pets by tags
// FindPetsByTags - Finds Pets by tags (deprecated)
e.GET("/v2/pet/findByTags", c.FindPetsByTags)
// GetPetById - Find pet by ID
// GetPetById - Find pet by ID
e.GET("/v2/pet/:petId", c.GetPetById)
// UpdatePet - Update an existing pet
// UpdatePet - Update an existing pet
e.PUT("/v2/pet", c.UpdatePet)
// UpdatePetWithForm - Updates a pet in the store with form data
// UpdatePetWithForm - Updates a pet in the store with form data
e.POST("/v2/pet/:petId", c.UpdatePetWithForm)
// UploadFile - uploads an image
// UploadFile - uploads an image
e.POST("/v2/pet/:petId/uploadImage", c.UploadFile)
// DeleteOrder - Delete purchase order by ID
// DeleteOrder - Delete purchase order by ID
e.DELETE("/v2/store/order/:orderId", c.DeleteOrder)
// GetInventory - Returns pet inventories by status
// GetInventory - Returns pet inventories by status
e.GET("/v2/store/inventory", c.GetInventory)
// GetOrderById - Find purchase order by ID
// GetOrderById - Find purchase order by ID
e.GET("/v2/store/order/:orderId", c.GetOrderById)
// PlaceOrder - Place an order for a pet
// PlaceOrder - Place an order for a pet
e.POST("/v2/store/order", c.PlaceOrder)
// CreateUser - Create user
// CreateUser - Create user
e.POST("/v2/user", c.CreateUser)
// CreateUsersWithArrayInput - Creates list of users with given input array
// CreateUsersWithArrayInput - Creates list of users with given input array
e.POST("/v2/user/createWithArray", c.CreateUsersWithArrayInput)
// CreateUsersWithListInput - Creates list of users with given input array
// CreateUsersWithListInput - Creates list of users with given input array
e.POST("/v2/user/createWithList", c.CreateUsersWithListInput)
// DeleteUser - Delete user
// DeleteUser - Delete user
e.DELETE("/v2/user/:username", c.DeleteUser)
// GetUserByName - Get user by user name
// GetUserByName - Get user by user name
e.GET("/v2/user/:username", c.GetUserByName)
// LoginUser - Logs user into the system
// LoginUser - Logs user into the system
e.GET("/v2/user/login", c.LoginUser)
// LogoutUser - Logs out current logged in user session
// LogoutUser - Logs out current logged in user session
e.GET("/v2/user/logout", c.LogoutUser)
// UpdateUser - Updated user
// UpdateUser - Updated user
e.PUT("/v2/user/:username", c.UpdateUser)