Skip to content

Commit aec98f3

Browse files
authored
docs: fix wrong description of MonthConfigs PATCH API endpoint (#463)
1 parent 1be0040 commit aec98f3

File tree

4 files changed

+8
-8
lines changed

4 files changed

+8
-8
lines changed

api/docs.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2088,14 +2088,14 @@ const docTemplate = `{
20882088
}
20892089
},
20902090
"patch": {
2091-
"description": "Creates a new MonthConfig",
2091+
"description": "Changes settings of an existing MonthConfig",
20922092
"produces": [
20932093
"application/json"
20942094
],
20952095
"tags": [
20962096
"MonthConfigs"
20972097
],
2098-
"summary": "Create MonthConfig",
2098+
"summary": "Update MonthConfig",
20992099
"parameters": [
21002100
{
21012101
"type": "string",

api/swagger.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2076,14 +2076,14 @@
20762076
}
20772077
},
20782078
"patch": {
2079-
"description": "Creates a new MonthConfig",
2079+
"description": "Changes settings of an existing MonthConfig",
20802080
"produces": [
20812081
"application/json"
20822082
],
20832083
"tags": [
20842084
"MonthConfigs"
20852085
],
2086-
"summary": "Create MonthConfig",
2086+
"summary": "Update MonthConfig",
20872087
"parameters": [
20882088
{
20892089
"type": "string",

api/swagger.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2124,7 +2124,7 @@ paths:
21242124
tags:
21252125
- MonthConfigs
21262126
patch:
2127-
description: Creates a new MonthConfig
2127+
description: Changes settings of an existing MonthConfig
21282128
parameters:
21292129
- description: ID of the Envelope
21302130
in: path
@@ -2157,7 +2157,7 @@ paths:
21572157
description: Internal Server Error
21582158
schema:
21592159
$ref: '#/definitions/httperrors.HTTPError'
2160-
summary: Create MonthConfig
2160+
summary: Update MonthConfig
21612161
tags:
21622162
- MonthConfigs
21632163
post:

pkg/controllers/month_config.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -244,8 +244,8 @@ func (co Controller) CreateMonthConfig(c *gin.Context) {
244244
c.JSON(http.StatusCreated, MonthConfigResponse{Data: mConfigObject})
245245
}
246246

247-
// @Summary Create MonthConfig
248-
// @Description Creates a new MonthConfig
247+
// @Summary Update MonthConfig
248+
// @Description Changes settings of an existing MonthConfig
249249
// @Tags MonthConfigs
250250
// @Produce json
251251
// @Success 201 {object} MonthConfigResponse

0 commit comments

Comments
 (0)