telboon/ktm-booking-bot
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Feat(swagger): Added examples
All checks were successful
ktm-booking-bot/ktm-booking-bot/pipeline/head This commit looks good
Details

Browse Source
This commit is contained in:
Samuel Pua
2022-09-27 04:12:57 +08:00
parent 77ced03557
commit e99182da51
4 changed files with 39 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
backend/docs/docs.go
View File

@@ -424,17 +424,22 @@ const docTemplate = `{
"ktmtrainbot.BookingCreateRequest": {
"type": "object",
"required": [
"contact",
"gender",
"name",
"passport",
"passportExpiry",
"timeCode",
"travelDate"
],
"properties": {
"contact": {
"type": "string"
"type": "string",
"example": "+6512345678"
},
"gender": {
"type": "string"
"type": "string",
"example": "M"
},
"name": {
"type": "string"
@@ -443,13 +448,16 @@ const docTemplate = `{
"type": "string"
},
"passportExpiry": {
"type": "string"
"type": "string",
"format": "date-time"
},
"timeCode": {
"type": "string"
"type": "string",
"example": "1300"
},
"travelDate": {
"type": "string"
"type": "string",
"format": "date-time"
}
}
},

18
backend/docs/swagger.json
View File

@@ -416,17 +416,22 @@
"ktmtrainbot.BookingCreateRequest": {
"type": "object",
"required": [
"contact",
"gender",
"name",
"passport",
"passportExpiry",
"timeCode",
"travelDate"
],
"properties": {
"contact": {
"type": "string"
"type": "string",
"example": "+6512345678"
},
"gender": {
"type": "string"
"type": "string",
"example": "M"
},
"name": {
"type": "string"
@@ -435,13 +440,16 @@
"type": "string"
},
"passportExpiry": {
"type": "string"
"type": "string",
"format": "date-time"
},
"timeCode": {
"type": "string"
"type": "string",
"example": "1300"
},
"travelDate": {
"type": "string"
"type": "string",
"format": "date-time"
}
}
},

8
backend/docs/swagger.yaml
View File

@@ -24,23 +24,31 @@ definitions:
ktmtrainbot.BookingCreateRequest:
properties:
contact:
example: "+6512345678"
type: string
gender:
example: M
type: string
name:
type: string
passport:
type: string
passportExpiry:
format: date-time
type: string
timeCode:
example: "1300"
type: string
travelDate:
format: date-time
type: string
required:
- contact
- gender
- name
- passport
- passportExpiry
- timeCode
- travelDate
type: object
ktmtrainbot.BookingResponse: