Files
fielderp-server/documentation/partner.js
T

247 lines
5.7 KiB
JavaScript

export default {
"/partner": {
get: {
tags: ["Partner"],
summary: "Get all Partners",
responses: {
200: {
description: "OK",
content: {},
},
},
},
post: {
tags: ["Partner"],
summary: "Create New Partner",
requestBody: {
required: true,
content: {
"application/json": {
schema: {
type: "object",
properties: {
name: {
type: "string",
required: true,
},
email: {
type: "string",
required: true,
},
phone: {
type: "string",
required: true,
},
address: {
type: "string",
required: true,
},
city: {
type: "string",
required: true,
},
state: {
type: "string",
required: true,
},
pincode: {
type: "string",
required: true,
},
contactPersons: {
type: "array",
required: true,
items: {
type: "object",
properties: {
name: {
type: "string",
required: true,
},
email: {
type: "string",
required: true,
},
mobile: {
type: "string",
required: true,
},
designation: {
type: "string",
required: true,
},
},
},
},
},
},
},
},
},
responses: {
200: {
description: "OK",
content: {},
},
},
},
},
"/partner/{id}": {
get: {
tags: ["Partner"],
summary: "Get Partner Details by ID",
parameters: [
{
in: "path",
name: "id",
required: true,
schema: {
type: "string",
},
},
],
responses: {
200: {
description: "OK",
content: {},
},
},
},
patch: {
tags: ["Partner"],
summary: "Update Partner Details by ID",
parameters: [
{
in: "path",
name: "id",
required: true,
schema: {
type: "string",
},
},
],
requestBody: {
required: true,
content: {
"application/json": {
schema: {
type: "object",
properties: {
name: {
type: "string",
required: true,
},
email: {
type: "string",
required: true,
},
phone: {
type: "string",
required: true,
},
address: {
type: "string",
required: true,
},
city: {
type: "string",
required: true,
},
state: {
type: "string",
required: true,
},
pincode: {
type: "string",
required: true,
},
contactPersons: {
type: "array",
required: true,
items: {
type: "object",
properties: {
name: {
type: "string",
required: true,
},
email: {
type: "string",
required: true,
},
mobile: {
type: "string",
required: true,
},
designation: {
type: "string",
required: true,
},
},
},
},
},
},
},
},
},
responses: {
200: {
description: "OK",
content: {},
},
},
},
delete: {
tags: ["Partner"],
summary: "Deactivate Partner by ID",
parameters: [
{
in: "path",
name: "id",
required: true,
schema: {
type: "string",
},
},
],
responses: {
200: {
description: "OK",
content: {},
},
},
},
},
"/partner/{id}/approve": {
tags: ["Partner"],
summary: "Approve a Partner added by an Executive",
parameters: [
{
in: "path",
name: "id",
required: true,
schema: {
type: "string",
},
},
],
responses: {
200: {
description: "OK",
content: {},
},
},
},
"/partner/unapproved": {
tags: ["Partner"],
summary: "Get all Unapproved Partners",
responses: {
200: {
description: "OK",
content: {},
},
},
},
};