riccardo/coupon
Archived
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Swagger correction

Browse Source
This commit is contained in:
riccardo
2021-09-05 20:36:39 +02:00
parent c8f520137d
commit 13f6cd2d14
3 changed files with 21 additions and 169 deletions
Download Patch File Download Diff File Expand all files Collapse all files

160
storage/api-docs/api-docs.json
View File

@@ -1,159 +1 @@
{
"openapi": "3.0.0",
"info": {
"title": "Example API",
"contact": {
"name": "Support Team",
"email": "support@example.com"
},
"version": "1.0"
},
"paths": {
"/get-coupon": {
"get": {
"tags": [
"getCoupon"
],
"summary": "Retrieve a coupon code for the user, based on the selected brand, if available.",
"operationId": "/get-coupon",
"parameters": [
{
"name": "brand_id",
"in": "query",
"description": "ID of the brand for which the coupon is requested.",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Returns the coupon code"
},
"401": {
"description": "Error: Not authenticated.",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Token expired."
}
},
"type": "object"
}
}
}
},
"403": {
"description": "Error: Not authorized.",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Not authorized."
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
},
"/generate-coupons": {
"get": {
"tags": [
"generateCoupons"
],
"summary": "Generates coupon codes for a brand.",
"operationId": "/generate-coupons",
"parameters": [
{
"name": "quantity",
"in": "query",
"description": "Quantity of coupons to be generated.",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "prefix",
"in": "query",
"description": "Prefix to be used in the coupon codes.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success.",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Coupon code(s) generation job sent."
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Not authenticated.",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Token expired."
}
},
"type": "object"
}
}
}
},
"403": {
"description": "Error: Not authorized.",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Not authorized."
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
}
}
}
{"openapi":"3.0.0","info":{"title":"Example API","contact":{"name":"Support Team","email":"support@example.com"},"version":"1.0"},"paths":{"\/get-coupon":{"get":{"tags":["getCoupon"],"summary":"Retrieve a coupon code for the user, based on the selected brand, if available.","operationId":"\/get-coupon","parameters":[{"name":"brand_id","in":"query","description":"ID of the brand for which the coupon is requested.","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Returns the coupon code","content":{"application\/json":{"schema":{"example":{"data":{"code":"d4r6o9sd46i.5i4is57u3"}}}}}},"401":{"description":"Error: Not authenticated.","content":{"application\/json":{"schema":{"properties":{"message":{"type":"string","example":"Token expired."}},"type":"object"}}}},"403":{"description":"Error: Not authorized.","content":{"application\/json":{"schema":{"properties":{"message":{"type":"string","example":"Not authorized."}},"type":"object"}}}}},"security":[{"bearer_token":[]}]}},"\/generate-coupons":{"post":{"tags":["generateCoupons"],"summary":"Generates coupon codes for a brand.","operationId":"\/generate-coupons","parameters":[{"name":"quantity","in":"query","description":"Quantity of coupons to be generated.","required":true,"schema":{"type":"integer"}},{"name":"prefix","in":"query","description":"Prefix to be used in the coupon codes.","required":false,"schema":{"type":"string"}}],"responses":{"201":{"description":"Success.","content":{"application\/json":{"schema":{"properties":{"message":{"type":"string","example":"Coupon code(s) generation job sent."}},"type":"object"}}}},"401":{"description":"Error: Not authenticated.","content":{"application\/json":{"schema":{"properties":{"message":{"type":"string","example":"Token expired."}},"type":"object"}}}},"403":{"description":"Error: Not authorized.","content":{"application\/json":{"schema":{"properties":{"message":{"type":"string","example":"Not authorized."}},"type":"object"}}}}},"security":[{"bearer_token":[]}]}}},"components":{"securitySchemes":{"bearer_token":{"type":"apiKey","description":"Enter token in format (Bearer <token>)","name":"Authorization","in":"header"}}}}