Updated copy to be more legible and clear. (#683)
* Updated copy to be more legible and clear. * Fixed validation errors. * Moved publisher and stackOwner to the API Definitions file.
This commit is contained in:
Jordan Zhang
GitHub
Родитель
a55fdaf589
Коммит
41dbd0bc28
|
|
@ -1,6 +1,8 @@
|
|||
{
|
||||
"basePath": "/api/v2",
|
||||
"consumes": ["application/json"],
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"definitions": {
|
||||
"Host": {
|
||||
"example": "{\n \"first_name\": \"David\",\n \"last_name\": \"Nelson\",\n \"full_name\": \"David Nelson\",\n \"email\": \"dnelson@example.com\"\n}",
|
||||
|
|
@ -21,7 +23,7 @@
|
|||
"type": "object"
|
||||
},
|
||||
"Watchlist": {
|
||||
"description": "The root of the Watchlist type's schema.",
|
||||
"description": "",
|
||||
"properties": {
|
||||
"color": {
|
||||
"type": "string",
|
||||
|
|
@ -44,18 +46,20 @@
|
|||
"x-ms-summary": "Watchlist description (external only)"
|
||||
}
|
||||
},
|
||||
"title": "Root Type for Watchlist",
|
||||
"title": "Watchlist",
|
||||
"type": "object"
|
||||
},
|
||||
"WebhookCreatedResponse": {
|
||||
"description": "The root of the WebhookCreatedResponse type's schema.",
|
||||
"description": "WebhookCreatedResponse",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"required": ["id"],
|
||||
"title": "Root Type for WebhookCreatedResponse",
|
||||
"required": [
|
||||
"id"
|
||||
],
|
||||
"title": "WebhookCreatedResponse",
|
||||
"type": "object"
|
||||
},
|
||||
"WebhookInvite": {
|
||||
|
|
@ -117,14 +121,24 @@
|
|||
"type": "array"
|
||||
}
|
||||
},
|
||||
"required": ["hosts", "watchlists", "sent_email", "last_name"],
|
||||
"required": [
|
||||
"hosts",
|
||||
"watchlists",
|
||||
"sent_email",
|
||||
"last_name"
|
||||
],
|
||||
"type": "object"
|
||||
},
|
||||
"WebhookInviteCreateRequest": {
|
||||
"properties": {
|
||||
"event": {
|
||||
"default": "invite",
|
||||
"enum": ["signin", "signout", "watchlist", "invite"],
|
||||
"enum": [
|
||||
"signin",
|
||||
"signout",
|
||||
"watchlist",
|
||||
"invite"
|
||||
],
|
||||
"type": "string",
|
||||
"x-ms-visibility": "internal"
|
||||
},
|
||||
|
|
@ -135,7 +149,10 @@
|
|||
"x-ms-visibility": "internal"
|
||||
}
|
||||
},
|
||||
"required": ["url", "event"],
|
||||
"required": [
|
||||
"url",
|
||||
"event"
|
||||
],
|
||||
"type": "object"
|
||||
},
|
||||
"WebhookSignin": {
|
||||
|
|
@ -217,14 +234,24 @@
|
|||
"x-ms-summary": "Guest's watchlist colors"
|
||||
}
|
||||
},
|
||||
"required": ["acknowledged", "signin_timestamp", "watchlists", "hosts"],
|
||||
"required": [
|
||||
"acknowledged",
|
||||
"signin_timestamp",
|
||||
"watchlists",
|
||||
"hosts"
|
||||
],
|
||||
"type": "object"
|
||||
},
|
||||
"WebhookSigninCreateRequest": {
|
||||
"properties": {
|
||||
"event": {
|
||||
"default": "signin",
|
||||
"enum": ["signin", "signout", "watchlist", "invite"],
|
||||
"enum": [
|
||||
"signin",
|
||||
"signout",
|
||||
"watchlist",
|
||||
"invite"
|
||||
],
|
||||
"type": "string",
|
||||
"x-ms-visibility": "internal"
|
||||
},
|
||||
|
|
@ -235,11 +262,14 @@
|
|||
"x-ms-visibility": "internal"
|
||||
}
|
||||
},
|
||||
"required": ["url", "event"],
|
||||
"required": [
|
||||
"url",
|
||||
"event"
|
||||
],
|
||||
"type": "object"
|
||||
},
|
||||
"WebhookSignout": {
|
||||
"description": "The root of the WebhookSignout type's schema.",
|
||||
"description": "WebhookSignout",
|
||||
"example": "{\"id\":125,\"first_name\":\"N/A\",\"last_name\":\"N/A\",\"email\":\"email@email.com\",\"location_name\":\"N/A\",\"signout_timestamp\":\"1969-12-31T16:16:40-08:00\"}",
|
||||
"properties": {
|
||||
"email": {
|
||||
|
|
@ -268,14 +298,19 @@
|
|||
"x-ms-summary": "Signout time"
|
||||
}
|
||||
},
|
||||
"title": "Root Type for WebhookSignout",
|
||||
"title": "WebhookSignout",
|
||||
"type": "object"
|
||||
},
|
||||
"WebhookSignoutCreateRequest": {
|
||||
"properties": {
|
||||
"event": {
|
||||
"default": "signout",
|
||||
"enum": ["signin", "signout", "watchlist", "invite"],
|
||||
"enum": [
|
||||
"signin",
|
||||
"signout",
|
||||
"watchlist",
|
||||
"invite"
|
||||
],
|
||||
"type": "string",
|
||||
"x-ms-visibility": "internal"
|
||||
},
|
||||
|
|
@ -286,14 +321,22 @@
|
|||
"x-ms-visibility": "internal"
|
||||
}
|
||||
},
|
||||
"required": ["url", "event"],
|
||||
"required": [
|
||||
"url",
|
||||
"event"
|
||||
],
|
||||
"type": "object"
|
||||
},
|
||||
"WebhookWatchlistCreateRequest": {
|
||||
"properties": {
|
||||
"event": {
|
||||
"default": "watchlist",
|
||||
"enum": ["signin", "signout", "watchlist", "invite"],
|
||||
"enum": [
|
||||
"signin",
|
||||
"signout",
|
||||
"watchlist",
|
||||
"invite"
|
||||
],
|
||||
"type": "string",
|
||||
"x-ms-visibility": "internal"
|
||||
},
|
||||
|
|
@ -304,7 +347,10 @@
|
|||
"x-ms-visibility": "internal"
|
||||
}
|
||||
},
|
||||
"required": ["url", "event"],
|
||||
"required": [
|
||||
"url",
|
||||
"event"
|
||||
],
|
||||
"type": "object"
|
||||
}
|
||||
},
|
||||
|
|
@ -312,7 +358,12 @@
|
|||
"info": {
|
||||
"description": "Traction Guest is a leading visitor management solution that tracks visitor invites and sign ins. Actions taken in Traction Guest such as a visitor signing in, an invite being sent by a host, or a visitor matching on a watchlist can trigger actions in other connectors.",
|
||||
"title": "Traction Guest",
|
||||
"version": "1.0.0"
|
||||
"version": "1.0.0",
|
||||
"contact": {
|
||||
"name": "Traction Guest Support",
|
||||
"url": "https://tractionguest.com/support",
|
||||
"email": "support@tractionguest.com"
|
||||
}
|
||||
},
|
||||
"parameters": {},
|
||||
"paths": {
|
||||
|
|
@ -329,7 +380,12 @@
|
|||
"properties": {
|
||||
"event": {
|
||||
"default": "invite",
|
||||
"enum": ["signin", "signout", "watchlist", "invite"],
|
||||
"enum": [
|
||||
"signin",
|
||||
"signout",
|
||||
"watchlist",
|
||||
"invite"
|
||||
],
|
||||
"type": "string",
|
||||
"x-ms-visibility": "internal"
|
||||
},
|
||||
|
|
@ -340,7 +396,10 @@
|
|||
"x-ms-visibility": "internal"
|
||||
}
|
||||
},
|
||||
"required": ["url", "event"],
|
||||
"required": [
|
||||
"url",
|
||||
"event"
|
||||
],
|
||||
"type": "object"
|
||||
}
|
||||
}
|
||||
|
|
@ -385,7 +444,12 @@
|
|||
"properties": {
|
||||
"event": {
|
||||
"default": "signin",
|
||||
"enum": ["signin", "signout", "watchlist", "invite"],
|
||||
"enum": [
|
||||
"signin",
|
||||
"signout",
|
||||
"watchlist",
|
||||
"invite"
|
||||
],
|
||||
"type": "string",
|
||||
"x-ms-visibility": "internal"
|
||||
},
|
||||
|
|
@ -396,7 +460,10 @@
|
|||
"x-ms-visibility": "internal"
|
||||
}
|
||||
},
|
||||
"required": ["url", "event"],
|
||||
"required": [
|
||||
"url",
|
||||
"event"
|
||||
],
|
||||
"type": "object"
|
||||
}
|
||||
}
|
||||
|
|
@ -441,7 +508,12 @@
|
|||
"properties": {
|
||||
"event": {
|
||||
"default": "signout",
|
||||
"enum": ["signin", "signout", "watchlist", "invite"],
|
||||
"enum": [
|
||||
"signin",
|
||||
"signout",
|
||||
"watchlist",
|
||||
"invite"
|
||||
],
|
||||
"type": "string",
|
||||
"x-ms-visibility": "internal"
|
||||
},
|
||||
|
|
@ -452,7 +524,10 @@
|
|||
"x-ms-visibility": "internal"
|
||||
}
|
||||
},
|
||||
"required": ["url", "event"],
|
||||
"required": [
|
||||
"url",
|
||||
"event"
|
||||
],
|
||||
"type": "object"
|
||||
}
|
||||
}
|
||||
|
|
@ -497,7 +572,12 @@
|
|||
"properties": {
|
||||
"event": {
|
||||
"default": "watchlist",
|
||||
"enum": ["signin", "signout", "watchlist", "invite"],
|
||||
"enum": [
|
||||
"signin",
|
||||
"signout",
|
||||
"watchlist",
|
||||
"invite"
|
||||
],
|
||||
"type": "string",
|
||||
"x-ms-visibility": "internal"
|
||||
},
|
||||
|
|
@ -508,7 +588,10 @@
|
|||
"x-ms-visibility": "internal"
|
||||
}
|
||||
},
|
||||
"required": ["url", "event"],
|
||||
"required": [
|
||||
"url",
|
||||
"event"
|
||||
],
|
||||
"type": "object"
|
||||
}
|
||||
}
|
||||
|
|
@ -567,12 +650,18 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"produces": ["application/json"],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"responses": {},
|
||||
"schemes": ["https"],
|
||||
"schemes": [
|
||||
"https"
|
||||
],
|
||||
"security": [
|
||||
{
|
||||
"oauth2_auth": ["admin:webhooks"]
|
||||
"oauth2_auth": [
|
||||
"admin:webhooks"
|
||||
]
|
||||
}
|
||||
],
|
||||
"securityDefinitions": {
|
||||
|
|
@ -587,5 +676,19 @@
|
|||
}
|
||||
},
|
||||
"swagger": "2.0",
|
||||
"tags": []
|
||||
}
|
||||
"tags": [],
|
||||
"x-ms-connector-metadata": [
|
||||
{
|
||||
"propertyName": "Privacy Policy",
|
||||
"propertyValue": "https://tractionguest.com/privacy/"
|
||||
},
|
||||
{
|
||||
"propertyName": "Website",
|
||||
"propertyValue": "https://tractionguest.com"
|
||||
},
|
||||
{
|
||||
"propertyName": "Categories",
|
||||
"propertyValue": "Business Intelligence;Security"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
@ -22,11 +22,15 @@
|
|||
},
|
||||
"redirectMode": "Global",
|
||||
"redirectUrl": "https://global.consent.azure-apim.net/redirect",
|
||||
"scopes": ["admin:webhooks"]
|
||||
"scopes": [
|
||||
"admin:webhooks"
|
||||
]
|
||||
},
|
||||
"type": "oauthSetting"
|
||||
}
|
||||
},
|
||||
"iconBrandColor": "#000000"
|
||||
"iconBrandColor": "#000000",
|
||||
"publisher": "Traction Guest Inc.",
|
||||
"stackOwner": "Traction Guest Inc."
|
||||
}
|
||||
}
|
||||
}
|
||||
Загрузка…
Ссылка в новой задаче