Skip to content

Commit

Permalink
docs: update to latest swagger config
Browse files Browse the repository at this point in the history
  • Loading branch information
peterxcli committed Jan 19, 2024
1 parent f761688 commit de7612a
Show file tree
Hide file tree
Showing 3 changed files with 77 additions and 101 deletions.
67 changes: 29 additions & 38 deletions docs/docs.go
Original file line number Diff line number Diff line change
Expand Up @@ -367,6 +367,35 @@ const docTemplate = `{
}
}
},
"/users": {
"get": {
"description": "Retrieves a list of users",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"User"
],
"summary": "Get Users",
"responses": {
"200": {
"description": "List of users successfully retrieved",
"schema": {
"$ref": "#/definitions/bikefest_pkg_model.UserListResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/bikefest_pkg_model.Response"
}
}
}
}
},
"/users/login/{user_id}": {
"get": {
"description": "Simulates a login process for a user by generating fake access and refresh tokens",
Expand Down Expand Up @@ -472,15 +501,6 @@ const docTemplate = `{
"User"
],
"summary": "Profile",
"parameters": [
{
"type": "string",
"description": "User ID",
"name": "user_id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Profile successfully retrieved",
Expand Down Expand Up @@ -632,35 +652,6 @@ const docTemplate = `{
}
}
}
},
"/users": {
"get": {
"description": "Retrieves a list of users",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"User"
],
"summary": "Get Users",
"responses": {
"200": {
"description": "List of users successfully retrieved",
"schema": {
"$ref": "#/definitions/bikefest_pkg_model.UserListResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/bikefest_pkg_model.Response"
}
}
}
}
}
},
"definitions": {
Expand Down
67 changes: 29 additions & 38 deletions docs/swagger.json
Original file line number Diff line number Diff line change
Expand Up @@ -356,6 +356,35 @@
}
}
},
"/users": {
"get": {
"description": "Retrieves a list of users",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"User"
],
"summary": "Get Users",
"responses": {
"200": {
"description": "List of users successfully retrieved",
"schema": {
"$ref": "#/definitions/bikefest_pkg_model.UserListResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/bikefest_pkg_model.Response"
}
}
}
}
},
"/users/login/{user_id}": {
"get": {
"description": "Simulates a login process for a user by generating fake access and refresh tokens",
Expand Down Expand Up @@ -461,15 +490,6 @@
"User"
],
"summary": "Profile",
"parameters": [
{
"type": "string",
"description": "User ID",
"name": "user_id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Profile successfully retrieved",
Expand Down Expand Up @@ -621,35 +641,6 @@
}
}
}
},
"/users": {
"get": {
"description": "Retrieves a list of users",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"User"
],
"summary": "Get Users",
"responses": {
"200": {
"description": "List of users successfully retrieved",
"schema": {
"$ref": "#/definitions/bikefest_pkg_model.UserListResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/bikefest_pkg_model.Response"
}
}
}
}
}
},
"definitions": {
Expand Down
44 changes: 19 additions & 25 deletions docs/swagger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -362,6 +362,25 @@ paths:
summary: Handle LINE OAuth callback
tags:
- OAuth
/users:
get:
consumes:
- application/json
description: Retrieves a list of users
produces:
- application/json
responses:
"200":
description: List of users successfully retrieved
schema:
$ref: '#/definitions/bikefest_pkg_model.UserListResponse'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/bikefest_pkg_model.Response'
summary: Get Users
tags:
- User
/users/{user_id}:
get:
consumes:
Expand Down Expand Up @@ -449,12 +468,6 @@ paths:
consumes:
- application/json
description: Fetches the profile of a user
parameters:
- description: User ID
in: path
name: user_id
required: true
type: string
produces:
- application/json
responses:
Expand Down Expand Up @@ -535,25 +548,6 @@ paths:
summary: Fake Register
tags:
- User
/users:
get:
consumes:
- application/json
description: Retrieves a list of users
produces:
- application/json
responses:
"200":
description: List of users successfully retrieved
schema:
$ref: '#/definitions/bikefest_pkg_model.UserListResponse'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/bikefest_pkg_model.Response'
summary: Get Users
tags:
- User
securityDefinitions:
ApiKeyAuth:
in: header
Expand Down

0 comments on commit de7612a

Please sign in to comment.