@itentialopensource/adapter-jira 1.7.4 → 1.7.6

package/entities/Users/action.json

@@ -188,6 +188,90 @@
           "mockFile": ""
         }
       ]
+    },
+    {
+      "name": "getUserEmail",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/user/email?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/getUserEmail-default.json"
+        }
+      ]
+    },
+    {
+      "name": "getUserEmailBulk",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/user/email/bulk?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "getAllUsersDefault",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/users?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/getAllUsersDefault-default.json"
+        }
+      ]
+    },
+    {
+      "name": "getAllUsers",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/users/search?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/getAllUsers-default.json"
+        }
+      ]
     }
   ]
 }

package/entities/Users/mockdatafiles/getAllUsers-default.json

@@ -0,0 +1,32 @@
+[
+  {
+    "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
+    "key": "",
+    "accountId": "5b10a2844c20165700ede21g",
+    "accountType": "atlassian",
+    "name": "",
+    "avatarUrls": {
+      "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48",
+      "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+      "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+      "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32"
+    },
+    "displayName": "Mia Krystof",
+    "active": false
+  },
+  {
+    "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10ac8d82e05b22cc7d4ef5",
+    "key": "",
+    "accountId": "5b10ac8d82e05b22cc7d4ef5",
+    "accountType": "atlassian",
+    "name": "",
+    "avatarUrls": {
+      "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=48&s=48",
+      "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=24&s=24",
+      "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=16&s=16",
+      "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=32&s=32"
+    },
+    "displayName": "Emma Richards",
+    "active": false
+  }
+]

package/entities/Users/mockdatafiles/getAllUsersDefault-default.json

@@ -0,0 +1,32 @@
+[
+  {
+    "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
+    "key": "",
+    "accountId": "5b10a2844c20165700ede21g",
+    "accountType": "atlassian",
+    "name": "",
+    "avatarUrls": {
+      "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48",
+      "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+      "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+      "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32"
+    },
+    "displayName": "Mia Krystof",
+    "active": false
+  },
+  {
+    "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10ac8d82e05b22cc7d4ef5",
+    "key": "",
+    "accountId": "5b10ac8d82e05b22cc7d4ef5",
+    "accountType": "atlassian",
+    "name": "",
+    "avatarUrls": {
+      "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=48&s=48",
+      "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=24&s=24",
+      "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=16&s=16",
+      "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=32&s=32"
+    },
+    "displayName": "Emma Richards",
+    "active": false
+  }
+]

package/entities/Users/mockdatafiles/getUserEmail-default.json

@@ -0,0 +1 @@
+"name@example.com"

package/entities/Users/schema.json

@@ -18,7 +18,11 @@
         "getRestapi2usercolumns",
         "putRestapi2usercolumns",
         "deleteRestapi2usercolumns",
-        "getRestapi2usergroups"
+        "getRestapi2usergroups",
+        "getUserEmail",
+        "getUserEmailBulk",
+        "getAllUsersDefault",
+        "getAllUsers"
       ],
       "external_name": "ph_request_type"
     }

package/entities/Webhooks/action.json

@@ -0,0 +1,106 @@
+{
+  "actions": [
+    {
+      "name": "getDynamicWebhooksForApp",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/webhook?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/getDynamicWebhooksForApp-default.json"
+        }
+      ]
+    },
+    {
+      "name": "registerDynamicWebhooks",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/webhook?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/registerDynamicWebhooks-default.json"
+        }
+      ]
+    },
+    {
+      "name": "deleteWebhookById",
+      "protocol": "REST",
+      "method": "DELETE",
+      "entitypath": "{base_path}/{version}/webhook?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "getFailedWebhooks",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/webhook/failed?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/getFailedWebhooks-default.json"
+        }
+      ]
+    },
+    {
+      "name": "refreshWebhooks",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/webhook/refresh?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/refreshWebhooks-default.json"
+        }
+      ]
+    }
+  ]
+}

package/entities/Webhooks/mockdatafiles/getDynamicWebhooksForApp-default.json

@@ -0,0 +1,40 @@
+{
+  "maxResults": 3,
+  "startAt": 0,
+  "total": 3,
+  "isLast": true,
+  "values": [
+    {
+      "id": 10000,
+      "jqlFilter": "project = PRJ",
+      "fieldIdsFilter": [
+        "summary",
+        "customfield_10029"
+      ],
+      "events": [
+        "jira:issue_updated",
+        "jira:issue_created"
+      ],
+      "expirationDate": "2019-06-01T12:42:30.000+0000"
+    },
+    {
+      "id": 10001,
+      "jqlFilter": "issuetype = Bug",
+      "events": [
+        "jira:issue_created"
+      ],
+      "expirationDate": "2019-06-01T12:42:30.000+0000"
+    },
+    {
+      "id": 10002,
+      "jqlFilter": "project = PRJ",
+      "issuePropertyKeysFilter": [
+        "my-issue-property-key"
+      ],
+      "events": [
+        "issue_property_set"
+      ],
+      "expirationDate": "2019-06-01T12:42:30.000+0000"
+    }
+  ]
+}

package/entities/Webhooks/mockdatafiles/getFailedWebhooks-default.json

@@ -0,0 +1,17 @@
+{
+  "values": [
+    {
+      "id": "1",
+      "body": "{\"data\":\"webhook data\"}",
+      "url": "https://example.com",
+      "failureTime": 1573118132000
+    },
+    {
+      "id": "2",
+      "url": "https://example.com",
+      "failureTime": 1573540473480
+    }
+  ],
+  "maxResults": 100,
+  "next": "https://your-domain.atlassian.net/rest/api/3/webhook/failed?failedAfter=1573540473480&maxResults=100"
+}

package/entities/Webhooks/mockdatafiles/refreshWebhooks-default.json

@@ -0,0 +1,3 @@
+{
+  "expirationDate": "2019-06-01T12:42:30.000+0000"
+}

package/entities/Webhooks/mockdatafiles/registerDynamicWebhooks-default.json

@@ -0,0 +1,15 @@
+{
+  "webhookRegistrationResult": [
+    {
+      "createdWebhookId": 1000
+    },
+    {
+      "errors": [
+        "The clause watchCount is unsupported"
+      ]
+    },
+    {
+      "createdWebhookId": 1001
+    }
+  ]
+}

package/entities/Webhooks/schema.json

@@ -0,0 +1,23 @@
+{
+  "$id": "schema.json",
+  "type": "object",
+  "schema": "http://json-schema.org/draft-07/schema#",
+  "translate": false,
+  "dynamicfields": true,
+  "properties": {
+    "ph_request_type": {
+      "type": "string",
+      "description": "type of request (internal to adapter)",
+      "default": "",
+      "enum": [
+        "getDynamicWebhooksForApp",
+        "registerDynamicWebhooks",
+        "deleteWebhookById",
+        "getFailedWebhooks",
+        "refreshWebhooks"
+      ],
+      "external_name": "ph_request_type"
+    }
+  },
+  "definitions": {}
+}

package/entities/WorkflowSchemeProjectAssociations/action.json

@@ -0,0 +1,45 @@
+{
+  "actions": [
+    {
+      "name": "getWorkflowSchemeProjectAssociations",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/workflowscheme/project?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/getWorkflowSchemeProjectAssociations-default.json"
+        }
+      ]
+    },
+    {
+      "name": "assignSchemeToProject",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/workflowscheme/project?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    }
+  ]
+}

package/entities/WorkflowSchemeProjectAssociations/mockdatafiles/getWorkflowSchemeProjectAssociations-default.json

@@ -0,0 +1,21 @@
+{
+  "values": [
+    {
+      "projectIds": [
+        "10010",
+        "10020"
+      ],
+      "workflowScheme": {
+        "id": 101010,
+        "name": "Example workflow scheme",
+        "description": "The description of the example workflow scheme.",
+        "defaultWorkflow": "jira",
+        "issueTypeMappings": {
+          "10000": "scrum workflow",
+          "10001": "builds workflow"
+        },
+        "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
+      }
+    }
+  ]
+}

package/entities/WorkflowSchemeProjectAssociations/schema.json

@@ -0,0 +1,20 @@
+{
+  "$id": "schema.json",
+  "type": "object",
+  "schema": "http://json-schema.org/draft-07/schema#",
+  "translate": false,
+  "dynamicfields": true,
+  "properties": {
+    "ph_request_type": {
+      "type": "string",
+      "description": "type of request (internal to adapter)",
+      "default": "",
+      "enum": [
+        "getWorkflowSchemeProjectAssociations",
+        "assignSchemeToProject"
+      ],
+      "external_name": "ph_request_type"
+    }
+  },
+  "definitions": {}
+}

package/entities/WorkflowTransitionRules/action.json

@@ -0,0 +1,65 @@
+{
+  "actions": [
+    {
+      "name": "getWorkflowTransitionRuleConfigurations",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/workflow/rule/config?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/getWorkflowTransitionRuleConfigurations-default.json"
+        }
+      ]
+    },
+    {
+      "name": "updateWorkflowTransitionRuleConfigurations",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/workflow/rule/config?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/updateWorkflowTransitionRuleConfigurations-default.json"
+        }
+      ]
+    },
+    {
+      "name": "deleteWorkflowTransitionRuleConfigurations",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/workflow/rule/config/delete?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/deleteWorkflowTransitionRuleConfigurations-default.json"
+        }
+      ]
+    }
+  ]
+}

package/entities/WorkflowTransitionRules/mockdatafiles/deleteWorkflowTransitionRuleConfigurations-default.json

@@ -0,0 +1,34 @@
+{
+  "updateResults": [
+    {
+      "workflowId": {
+        "name": "Workflow with one rule not updated",
+        "draft": false
+      },
+      "ruleUpdateErrors": {
+        "example-rule-id": [
+          "The rule with this id does not exist: example-rule-id"
+        ]
+      },
+      "updateErrors": []
+    },
+    {
+      "workflowId": {
+        "name": "Workflow with all rules successfully updated",
+        "draft": true
+      },
+      "ruleUpdateErrors": {},
+      "updateErrors": []
+    },
+    {
+      "workflowId": {
+        "name": "Non-existing workflow",
+        "draft": false
+      },
+      "ruleUpdateErrors": {},
+      "updateErrors": [
+        "Workflow not found: WorkflowIdBean{name=Non-existing workflow, draft=false}"
+      ]
+    }
+  ]
+}

package/entities/WorkflowTransitionRules/mockdatafiles/getWorkflowTransitionRuleConfigurations-default.json

@@ -0,0 +1,56 @@
+{
+  "maxResults": 10,
+  "startAt": 0,
+  "total": 1,
+  "isLast": true,
+  "values": [
+    {
+      "workflowId": {
+        "name": "My Workflow name",
+        "draft": false
+      },
+      "postFunctions": [
+        {
+          "id": "b4d6cbdc-59f5-11e9-8647-d663bd873d93",
+          "key": "postfunction-key",
+          "configuration": {
+            "value": "{ \"color\": \"red\" }",
+            "disabled": false
+          },
+          "transition": {
+            "id": 1,
+            "name": "Open"
+          }
+        }
+      ],
+      "conditions": [
+        {
+          "id": "d663bd873d93-59f5-11e9-8647-b4d6cbdc",
+          "key": "condition-key",
+          "configuration": {
+            "value": "{ \"size\": \"medium\" }",
+            "disabled": false
+          },
+          "transition": {
+            "id": 1,
+            "name": "Open"
+          }
+        }
+      ],
+      "validators": [
+        {
+          "id": "11e9-59f5-b4d6cbdc-8647-d663bd873d93",
+          "key": "validator-key",
+          "configuration": {
+            "value": "\"{ \\\"shape\\\": \\\"square\\\" }\"",
+            "disabled": false
+          },
+          "transition": {
+            "id": 1,
+            "name": "Open"
+          }
+        }
+      ]
+    }
+  ]
+}

package/entities/WorkflowTransitionRules/mockdatafiles/updateWorkflowTransitionRuleConfigurations-default.json

@@ -0,0 +1,34 @@
+{
+  "updateResults": [
+    {
+      "workflowId": {
+        "name": "Workflow with one rule not updated",
+        "draft": false
+      },
+      "ruleUpdateErrors": {
+        "example-rule-id": [
+          "The rule with this id does not exist: example-rule-id"
+        ]
+      },
+      "updateErrors": []
+    },
+    {
+      "workflowId": {
+        "name": "Workflow with all rules successfully updated",
+        "draft": true
+      },
+      "ruleUpdateErrors": {},
+      "updateErrors": []
+    },
+    {
+      "workflowId": {
+        "name": "Non-existing workflow",
+        "draft": false
+      },
+      "ruleUpdateErrors": {},
+      "updateErrors": [
+        "Workflow not found: WorkflowIdBean{name=Non-existing workflow, draft=false}"
+      ]
+    }
+  ]
+}