Skip to content

Commit ca61876

Browse files
committed
update swagger
1 parent 90fc8e2 commit ca61876

File tree

1 file changed

+115
-1
lines changed

1 file changed

+115
-1
lines changed

swagger.json

Lines changed: 115 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -966,7 +966,7 @@
966966
"format" : "uuid"
967967
},
968968
"required" : true,
969-
"description" : "id of the contact"
969+
"description" : "id of the entity"
970970
}, {
971971
"in" : "header",
972972
"name" : "token",
@@ -1010,6 +1010,63 @@
10101010
}
10111011
}
10121012
},
1013+
"/entity/unlink/{entity_id}" : {
1014+
"post" : {
1015+
"tags" : [ "entity" ],
1016+
"summary" : "unlinks an entity from a list of given contacts",
1017+
"description" : "By passing the entity id and list of contacts, you can unlink the entity from each contact.",
1018+
"parameters" : [ {
1019+
"in" : "path",
1020+
"name" : "entity_id",
1021+
"schema" : {
1022+
"type" : "string",
1023+
"format" : "uuid"
1024+
},
1025+
"required" : true,
1026+
"description" : "id of the entity"
1027+
}, {
1028+
"in" : "header",
1029+
"name" : "token",
1030+
"required" : true,
1031+
"schema" : {
1032+
"type" : "string",
1033+
"example" : "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InRlc3QiLCJpYXQiOjE1ODA3NTM0MDUsImV4cCI6MTU4MDgzOTgwNX0.Q6W7Vo6By35yjZBeLKkk96s8LyqIE2G39AG1H3LRD9M"
1034+
}
1035+
} ],
1036+
"requestBody" : {
1037+
"description" : "The body of the payload",
1038+
"required" : true,
1039+
"content" : {
1040+
"application/json" : {
1041+
"schema" : {
1042+
"type" : "object",
1043+
"required" : [ "contacts" ],
1044+
"properties" : {
1045+
"contacts" : {
1046+
"type" : "string",
1047+
"example" : [{"id":""},{"id":""}]
1048+
}
1049+
}
1050+
}
1051+
}
1052+
}
1053+
},
1054+
"responses" : {
1055+
"200" : {
1056+
"description" : "Successful/already exists"
1057+
},
1058+
"401" : {
1059+
"description" : "Unauthorized"
1060+
},
1061+
"422" : {
1062+
"description" : "Invalid input"
1063+
},
1064+
"500" : {
1065+
"description" : "Server error"
1066+
}
1067+
}
1068+
}
1069+
},
10131070
"/contact" : {
10141071
"post" : {
10151072
"tags" : [ "contact" ],
@@ -1424,6 +1481,63 @@
14241481
}
14251482
}
14261483
},
1484+
"/contact/unlink/{contact_id}" : {
1485+
"post" : {
1486+
"tags" : [ "contact" ],
1487+
"summary" : "unlinks a contact from a list of given entities",
1488+
"description" : "By passing the contact id and list of entities, you can unlink the contact from each entity.",
1489+
"parameters" : [ {
1490+
"in" : "path",
1491+
"name" : "contact_id",
1492+
"schema" : {
1493+
"type" : "string",
1494+
"format" : "uuid"
1495+
},
1496+
"required" : true,
1497+
"description" : "id of the contact"
1498+
}, {
1499+
"in" : "header",
1500+
"name" : "token",
1501+
"required" : true,
1502+
"schema" : {
1503+
"type" : "string",
1504+
"example" : "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InRlc3QiLCJpYXQiOjE1ODA3NTM0MDUsImV4cCI6MTU4MDgzOTgwNX0.Q6W7Vo6By35yjZBeLKkk96s8LyqIE2G39AG1H3LRD9M"
1505+
}
1506+
} ],
1507+
"requestBody" : {
1508+
"description" : "The body of the payload",
1509+
"required" : true,
1510+
"content" : {
1511+
"application/json" : {
1512+
"schema" : {
1513+
"type" : "object",
1514+
"required" : [ "entities" ],
1515+
"properties" : {
1516+
"entities" : {
1517+
"type" : "string",
1518+
"example" : [{"id":""},{"id":""}]
1519+
}
1520+
}
1521+
}
1522+
}
1523+
}
1524+
},
1525+
"responses" : {
1526+
"200" : {
1527+
"description" : "Successful/already exists"
1528+
},
1529+
"401" : {
1530+
"description" : "Unauthorized"
1531+
},
1532+
"422" : {
1533+
"description" : "Invalid input"
1534+
},
1535+
"500" : {
1536+
"description" : "Server error"
1537+
}
1538+
}
1539+
}
1540+
},
14271541
"/csv/{model_type}" : {
14281542
"get" : {
14291543
"tags" : [ "csv" ],

0 commit comments

Comments
 (0)