iAuditor PA connector files (#423)
* iAuditor PA connector files * Updated authentication labels Updated to the authentication label, description, and tooltip. This is to instruct users more clearly on how to input the API token in the accepted format of 'Bearer <token>'. * Update certified-connectors/iAuditor/apiProperties.json Co-authored-by: Brandon Cook <BCook98@users.noreply.github.com> * Updated connector action labels Updated the label to some of the actions in the iAuditor PA connector. Co-authored-by: Jack Han <safetyculture@Jacks-MacBook-Pro.local> Co-authored-by: Brandon Cook <BCook98@users.noreply.github.com>
This commit is contained in:
jackihann
GitHub
Родитель
888fb39254
Коммит
e213fb3361
|
|
@ -100,7 +100,7 @@
|
|||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successfully retrieved the data for the specified inspection.",
|
||||
"description": "Successfully retrieved the data of the specified inspection.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/GetAuditByIdResponse"
|
||||
}
|
||||
|
|
@ -114,7 +114,7 @@
|
|||
"audits"
|
||||
],
|
||||
"summary": "Set the archived state of an inspection",
|
||||
"description": "Choose 'Yes' to archive an inspection and 'No' to restore an archived inspection.",
|
||||
"description": "Choose 'Yes' to archive the inspection and 'No' to restore the archived inspection.",
|
||||
"operationId": "ArchiveRestoreAudit",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -424,8 +424,8 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"summary": "Create an Action",
|
||||
"description": "Create a new Action",
|
||||
"summary": "Create an action",
|
||||
"description": "Create a new action",
|
||||
"operationId": "CreateAction",
|
||||
"x-ms-visibility": "advanced",
|
||||
"parameters": [
|
||||
|
|
@ -452,8 +452,8 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"summary": "Delete an Action",
|
||||
"description": "Delete an existing Action",
|
||||
"summary": "Delete an action",
|
||||
"description": "Delete an existing action",
|
||||
"operationId": "DeleteAction",
|
||||
"x-ms-visibility": "advanced",
|
||||
"parameters": [
|
||||
|
|
@ -471,8 +471,8 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"summary": "Update an Action",
|
||||
"description": "Update an existing Action",
|
||||
"summary": "Update an action",
|
||||
"description": "Update an existing action",
|
||||
"operationId": "UpdateAction",
|
||||
"x-ms-visibility": "advanced",
|
||||
"parameters": [
|
||||
|
|
@ -524,7 +524,7 @@
|
|||
"preferences"
|
||||
],
|
||||
"summary": "Search global preferences",
|
||||
"description": "Retrieve the list of report preferences available to all templates.",
|
||||
"description": "Retrieve the list of Report Preferences available to all templates.",
|
||||
"operationId": "SearchPreferences",
|
||||
"parameters": [],
|
||||
"responses": {
|
||||
|
|
@ -545,7 +545,7 @@
|
|||
"audits"
|
||||
],
|
||||
"summary": "Export an inspection report",
|
||||
"description": "Submit an export request for an inspection report into the selected format.",
|
||||
"description": "Submit an export request for an inspection report in the selected format.",
|
||||
"operationId": "InitiateInspectionExport",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -605,12 +605,12 @@
|
|||
"x-ms-summary": "Action ID"
|
||||
},
|
||||
"count": {
|
||||
"description": "The number of matching results returned in the current search run.",
|
||||
"description": "The number of actions returned.",
|
||||
"type": "number",
|
||||
"x-ms-summary": "Count"
|
||||
},
|
||||
"total": {
|
||||
"description": "The overall total number of matching results for the search.",
|
||||
"description": "The total number of actions found in the search parameters.",
|
||||
"type": "number",
|
||||
"x-ms-summary": "Total"
|
||||
},
|
||||
|
|
@ -775,11 +775,11 @@
|
|||
"id": {
|
||||
"type": "string",
|
||||
"x-ms-summary": "Preference ID",
|
||||
"description": "The unique identifier of the report preference."
|
||||
"description": "The unique identifier of the Report Preference."
|
||||
},
|
||||
"label": {
|
||||
"type": "string",
|
||||
"x-ms-summary": "Preference Label",
|
||||
"x-ms-summary": "Preference Name",
|
||||
"description": "The Report Preference name."
|
||||
}
|
||||
}
|
||||
|
|
@ -879,7 +879,7 @@
|
|||
},
|
||||
"duration": {
|
||||
"type": "number",
|
||||
"x-ms-summary": "Duration (s)",
|
||||
"x-ms-summary": "Duration",
|
||||
"description": "The duration of the inspection in seconds."
|
||||
},
|
||||
"authorship": {
|
||||
|
|
@ -1008,15 +1008,15 @@
|
|||
"audit_id": {
|
||||
"type": "string",
|
||||
"description": "The unique identifier of the inspection.",
|
||||
"x-ms-summary": "ID"
|
||||
"x-ms-summary": "Audit ID"
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The name of the inspection.",
|
||||
"x-ms-summary": "Name"
|
||||
"description": "The name/title of the inspection.",
|
||||
"x-ms-summary": "Inspection Title"
|
||||
}
|
||||
},
|
||||
"description": "The inspection the action was created for.",
|
||||
"description": "The inspection that the action is associated with.",
|
||||
"x-ms-summary": "Inspection"
|
||||
},
|
||||
"item": {
|
||||
|
|
@ -1025,15 +1025,15 @@
|
|||
"item_id": {
|
||||
"type": "string",
|
||||
"description": "The question/item's unique identifier.",
|
||||
"x-ms-summary": "ID"
|
||||
"x-ms-summary": "Item ID"
|
||||
},
|
||||
"label": {
|
||||
"type": "string",
|
||||
"description": "The question/item's label.",
|
||||
"x-ms-summary": "Label"
|
||||
"x-ms-summary": "Item Label"
|
||||
}
|
||||
},
|
||||
"description": "The question/item the action was created against.",
|
||||
"description": "The inspection question/item that the action is associated with.",
|
||||
"x-ms-summary": "Item"
|
||||
},
|
||||
"description": {
|
||||
|
|
@ -1071,12 +1071,12 @@
|
|||
"id": {
|
||||
"type": "string",
|
||||
"description": "The assignee's user ID or email (external).",
|
||||
"x-ms-summary": "ID"
|
||||
"x-ms-summary": " Assignee ID"
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The action assignee's name or email (external).",
|
||||
"x-ms-summary": "Name"
|
||||
"x-ms-summary": "Assignee Name"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
|
|
@ -1094,12 +1094,12 @@
|
|||
"user_id": {
|
||||
"type": "string",
|
||||
"description": "The unique identifier of the user who created the action.",
|
||||
"x-ms-summary": "Creator's ID"
|
||||
"x-ms-summary": "Creator ID"
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The name of the user who created the action.",
|
||||
"x-ms-summary": "Creator's Name"
|
||||
"x-ms-summary": "Creator Name"
|
||||
}
|
||||
},
|
||||
"description": "The user who created the action.",
|
||||
|
|
@ -1150,7 +1150,8 @@
|
|||
"id": {
|
||||
"type": "string",
|
||||
"description": "The assignee's user ID or email (external).",
|
||||
"x-ms-summary": "ID"
|
||||
|
||||
"x-ms-summary": "Assignee ID"
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
|
|
@ -1604,4 +1605,4 @@
|
|||
"operationId": "SearchExportProfiles"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -4,9 +4,9 @@
|
|||
"api_key": {
|
||||
"type": "securestring",
|
||||
"uiDefinition": {
|
||||
"displayName": "API Key",
|
||||
"description": "The API Key for this api",
|
||||
"tooltip": "Provide your API Key",
|
||||
"displayName": "API token",
|
||||
"description": "Input format: 'Bearer <token>",
|
||||
"tooltip": "Provide your API token in the format: 'Bearer <token>'. e.g., 'Bearer your_api_token'",
|
||||
"constraints": {
|
||||
"tabIndex": 2,
|
||||
"clearText": false,
|
||||
|
|
@ -22,4 +22,4 @@
|
|||
"publisher": "SafetyCulture Pty Ltd",
|
||||
"stackOwner": "SafetyCulture Pty Ltd"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче