Files
quicklanch-server/src/app/modules/template/template.swagger.ts
T

198 lines
5.3 KiB
TypeScript

export const templateSwaggerDocs = {
"/api/template": {
post: {
tags: ["template"],
summary: "Create new template",
description: "",
requestBody: {
required: true,
content: {
"application/json": {
example: JSON.stringify({
language: "en",
deliveryCharge: "60",
banner: {
isVisible: true,
bannerTitle: "Delicious Homemade Food",
bannerDesc:
"Fresh, healthy and tasty meals delivered to your door.",
bannerImage: "https://example.com/banner.jpg",
},
address: {
isVisible: true,
phoneNumber: "+8801712345678",
shopLocation: "Dhaka, Bangladesh",
shopEmail: "foodshop@example.com",
},
ingredient: {
isVisible: true,
options: [
{
ingrImg: "https://example.com/tomato.jpg",
ingrTitle: "Tomato",
ingrDes: "Fresh organic tomatoes",
},
{
ingrImg: "https://example.com/chicken.jpg",
ingrTitle: "Chicken",
ingrDes: "Premium quality chicken",
},
],
},
instruction: {
isVisible: true,
instBanner: "https://example.com/instruction-banner.jpg",
options: [
{
hint: "Step 1",
detail: "Wash all ingredients properly",
},
{
hint: "Step 2",
detail: "Cook on medium heat for 20 minutes",
},
],
},
faq: {
isVisible: true,
options: [
{
index: 1,
text: "Is the food fresh?",
},
{
index: 2,
text: "Do you offer home delivery?",
},
],
},
tips: {
isVisible: true,
tipsBanner: "https://example.com/tips-banner.jpg",
options: [
{
index: 1,
text: "Use fresh ingredients for best taste",
},
{
index: 2,
text: "Serve hot for better flavor",
},
],
},
priceCombo: {
isVisible: true,
options: [
{
quantity: "1",
price: "120",
},
{
quantity: "2",
price: "220",
},
],
},
product: {
isVisible: true,
price: "120",
discount: 10,
productName: "Chicken Burger",
},
}), // put your request body
},
},
},
responses: {
201: { description: "template created successfully" },
500: { description: "Validation error or internal server error" },
},
},
get: {
tags: ["template"],
summary: "Get all template",
description: "",
parameters: [
{
name: "page",
in: "query",
required: false,
schema: { type: "number" },
},
{
name: "limit",
in: "query",
required: false,
schema: { type: "number" },
},
],
responses: {
200: { description: "template fetched successfully" },
401: { description: "unauthorized" },
},
},
},
"/api/template/{id}": {
get: {
tags: ["template"],
summary: "Get single template",
description: "",
parameters: [
{
name: "id",
in: "path",
required: true,
schema: { type: "string" },
},
],
responses: {
200: { description: "template fetched successfully" },
401: { description: "unauthorized" },
},
},
patch: {
tags: ["template"],
summary: "Update template",
description: "",
parameters: [
{
name: "id",
in: "path",
required: true,
schema: { type: "string" },
},
],
requestBody: {
required: true,
content: {
"application/json": {
example: JSON.stringify({}), // put your request body
},
},
},
responses: {
200: { description: "template updated successfully" },
500: { description: "Validation error or internal server error" },
},
},
delete: {
tags: ["template"],
summary: "Delete template",
description: "",
parameters: [
{
name: "id",
in: "path",
required: true,
schema: { type: "string" },
},
],
responses: {
200: { description: "template delete successfully" },
401: { description: "unauthorized" },
},
},
},
};