Skip to content

Fixed users endpoint path in swagger #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kaurmatthi merged 1 commit into from
Sep 30, 2025
Merged

Fixed users endpoint path in swagger #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 19 additions & 17 deletions docs/docs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ const docTemplate = `{
}
}
},
"/users/username/{username}": {
"/users/id/{id}": {
"get": {
"security": [
{
Expand All @@ -115,12 +115,12 @@ const docTemplate = `{
"tags": [
"users"
],
"summary": "Get user by username",
"summary": "Get user by ID",
"parameters": [
{
"type": "string",
"description": "Username",
"name": "username",
"type": "integer",
"description": "User ID",
"name": "id",
"in": "path",
"required": true
}
Expand All @@ -132,6 +132,12 @@ const docTemplate = `{
"$ref": "#/definitions/model.User"
}
},
"400": {
"description": "invalid id",
"schema": {
"$ref": "#/definitions/model.ErrorResponse"
}
},
"404": {
"description": "user not found",
"schema": {
Expand All @@ -147,7 +153,7 @@ const docTemplate = `{
}
}
},
"/users/{id}": {
"/users/username/{username}": {
"get": {
"security": [
{
Expand All @@ -160,12 +166,12 @@ const docTemplate = `{
"tags": [
"users"
],
"summary": "Get user by ID",
"summary": "Get user by username",
"parameters": [
{
"type": "integer",
"description": "User ID",
"name": "id",
"type": "string",
"description": "Username",
"name": "username",
"in": "path",
"required": true
}
Expand All @@ -177,12 +183,6 @@ const docTemplate = `{
"$ref": "#/definitions/model.User"
}
},
"400": {
"description": "invalid id",
"schema": {
"$ref": "#/definitions/model.ErrorResponse"
}
},
"404": {
"description": "user not found",
"schema": {
Expand All @@ -196,7 +196,9 @@ const docTemplate = `{
}
}
}
},
}
},
"/users/{id}": {
"put": {
"security": [
{
Expand Down
36 changes: 19 additions & 17 deletions docs/swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@
}
}
},
"/users/username/{username}": {
"/users/id/{id}": {
"get": {
"security": [
{
Expand All @@ -108,12 +108,12 @@
"tags": [
"users"
],
"summary": "Get user by username",
"summary": "Get user by ID",
"parameters": [
{
"type": "string",
"description": "Username",
"name": "username",
"type": "integer",
"description": "User ID",
"name": "id",
"in": "path",
"required": true
}
Expand All @@ -125,6 +125,12 @@
"$ref": "#/definitions/model.User"
}
},
"400": {
"description": "invalid id",
"schema": {
"$ref": "#/definitions/model.ErrorResponse"
}
},
"404": {
"description": "user not found",
"schema": {
Expand All @@ -140,7 +146,7 @@
}
}
},
"/users/{id}": {
"/users/username/{username}": {
"get": {
"security": [
{
Expand All @@ -153,12 +159,12 @@
"tags": [
"users"
],
"summary": "Get user by ID",
"summary": "Get user by username",
"parameters": [
{
"type": "integer",
"description": "User ID",
"name": "id",
"type": "string",
"description": "Username",
"name": "username",
"in": "path",
"required": true
}
Expand All @@ -170,12 +176,6 @@
"$ref": "#/definitions/model.User"
}
},
"400": {
"description": "invalid id",
"schema": {
"$ref": "#/definitions/model.ErrorResponse"
}
},
"404": {
"description": "user not found",
"schema": {
Expand All @@ -189,7 +189,9 @@
}
}
}
},
}
},
"/users/{id}": {
"put": {
"security": [
{
Expand Down
37 changes: 19 additions & 18 deletions docs/swagger.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,13 +107,21 @@ paths:
summary: Delete user by ID
tags:
- users
get:
put:
consumes:
- application/json
parameters:
- description: User ID
in: path
name: id
required: true
type: integer
- description: User
in: body
name: user
required: true
schema:
$ref: '#/definitions/model.User'
produces:
- application/json
responses:
Expand All @@ -122,37 +130,34 @@ paths:
schema:
$ref: '#/definitions/model.User'
"400":
description: invalid id
description: invalid id or body mismatch
schema:
$ref: '#/definitions/model.ErrorResponse'
"404":
description: user not found
schema:
$ref: '#/definitions/model.ErrorResponse'
"409":
description: user with username/email already exists
schema:
$ref: '#/definitions/model.ErrorResponse'
"500":
description: internal server error
schema:
$ref: '#/definitions/model.ErrorResponse'
security:
- ApiKeyAuth: []
summary: Get user by ID
summary: Update user by ID
tags:
- users
put:
consumes:
- application/json
/users/id/{id}:
get:
parameters:
- description: User ID
in: path
name: id
required: true
type: integer
- description: User
in: body
name: user
required: true
schema:
$ref: '#/definitions/model.User'
produces:
- application/json
responses:
Expand All @@ -161,24 +166,20 @@ paths:
schema:
$ref: '#/definitions/model.User'
"400":
description: invalid id or body mismatch
description: invalid id
schema:
$ref: '#/definitions/model.ErrorResponse'
"404":
description: user not found
schema:
$ref: '#/definitions/model.ErrorResponse'
"409":
description: user with username/email already exists
schema:
$ref: '#/definitions/model.ErrorResponse'
"500":
description: internal server error
schema:
$ref: '#/definitions/model.ErrorResponse'
security:
- ApiKeyAuth: []
summary: Update user by ID
summary: Get user by ID
tags:
- users
/users/username/{username}:
Expand Down
2 changes: 1 addition & 1 deletion internal/controller/users.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ func (c *UserController) GetUserByUsername(ctx *gin.Context) {
// @Failure 404 {object} model.ErrorResponse "user not found"
// @Failure 500 {object} model.ErrorResponse "internal server error"
// @Security ApiKeyAuth
// @Router /users/{id} [get]
// @Router /users/id/{id} [get]
func (c *UserController) GetUserByID(ctx *gin.Context) {
idStr := ctx.Param("id")
id, err := strconv.ParseInt(idStr, 10, 64)
Expand Down