airbyte-faros-destination 0.0.1

package/resources/source-specific-configs/notion.json

@@ -0,0 +1,313 @@
+{
+  "title": "Notion",
+  "description": "Configuration options that apply to records generated by the Notion Source. The options determine how a page in Notion gets mapped to a TMS type in Faros, i.e., a project, epic, sprint or task, and further how properties on that page are mapped to properties of the selected type, e.g., which page property should map to a Faros task's status field. While there are only a handful of required options, you will likely need to override the default property name mappings to match the property names in your Notion account.",
+  "type": "object",
+  "oneOf": [
+    {
+      "type": "object",
+      "title": "None",
+      "properties": {
+        "source_type": {
+          "type": "string",
+          "const": "Notion_None",
+          "order": 0
+        }
+      }
+    },
+    {
+      "type": "object",
+      "title": "Configuration",
+      "required": [
+        "kind_property"
+      ],
+      "properties": {
+        "source_type": {
+          "type": "string",
+          "const": "Notion",
+          "order": 0
+        },
+        "kind_property": {
+          "type": "string",
+          "title": "Kind Property",
+          "description": "The name of the page property whose value determines what kind of object a page is, i.e., a project, epic, sprint, or task. It must have a select type in Notion. It's expected that each kind of page has a unique, fixed value, which must be provided in the kind-specific configuration sections."
+        },
+        "projects": {
+          "type": "object",
+          "title": "Projects",
+          "description": "Configuration for projects",
+          "oneOf": [
+            {
+              "type": "object",
+              "title": "Project Configuration",
+              "required": [
+                "kind"
+              ],
+              "properties": {
+                "option_title": {
+                  "type": "string",
+                  "const": "Projects",
+                  "order": 0
+                },
+                "kind": {
+                  "type": "string",
+                  "title": "Project Kind",
+                  "description": "The value of the kind property for project types."
+                },
+                "properties": {
+                  "type": "object",
+                  "title": "Properties",
+                  "description": "Project properties",
+                  "properties": {
+                    "name": {
+                      "type": "string",
+                      "title": "Name",
+                      "description": "The property that determines a project's name",
+                      "default": "Name"
+                    },
+                    "description": {
+                      "type": "string",
+                      "title": "Description",
+                      "description": "The property that determines a project's description",
+                      "default": "Description"
+                    }
+                  }
+                }
+              }
+            }
+          ]
+        },
+        "epics": {
+          "type": "object",
+          "title": "Epics",
+          "description": "Configuration for epics",
+          "oneOf": [
+            {
+              "type": "object",
+              "title": "Epic Configuration",
+              "required": [
+                "kind"
+              ],
+              "properties": {
+                "option_title": {
+                  "type": "string",
+                  "const": "Epics",
+                  "order": 0
+                },
+                "kind": {
+                  "type": "string",
+                  "title": "Epic Kind",
+                  "description": "The value of the kind property for epic types"
+                },
+                "properties": {
+                  "type": "object",
+                  "title": "Properties",
+                  "description": "Epic properties",
+                  "properties": {
+                    "name": {
+                      "type": "string",
+                      "title": "Name",
+                      "description": "The property that determines an epic's name",
+                      "default": "Name"
+                    },
+                    "description": {
+                      "type": "string",
+                      "title": "Description",
+                      "description": "The property that determines an epic's description",
+                      "default": "Description"
+                    },
+                    "project": {
+                      "type": "string",
+                      "title": "Project",
+                      "description": "The property that determines an epic's project. It must have a relation type in Notion.",
+                      "default": "Project"
+                    },
+                    "status": {
+                      "type": "string",
+                      "title": "Status",
+                      "description": "The property that determines an epic's status",
+                      "default": "Status"
+                    }
+                  }
+                }
+              }
+            }
+          ]
+        },
+        "sprints": {
+          "type": "object",
+          "title": "Sprints",
+          "description": "Configuration for sprints",
+          "oneOf": [
+            {
+              "type": "object",
+              "title": "Sprint Configuration",
+              "required": [
+                "kind"
+              ],
+              "properties": {
+                "option_title": {
+                  "type": "string",
+                  "const": "Sprints",
+                  "order": 0
+                },
+                "kind": {
+                  "type": "string",
+                  "title": "Sprint Kind",
+                  "description": "The value of the kind property for sprint types"
+                },
+                "properties": {
+                  "type": "object",
+                  "title": "Properties",
+                  "description": "Sprint properties",
+                  "properties": {
+                    "name": {
+                      "type": "string",
+                      "title": "Name",
+                      "description": "The property that determines a sprint's name",
+                      "default": "Name"
+                    },
+                    "description": {
+                      "type": "string",
+                      "title": "Description",
+                      "description": "The property that determines a sprint's description",
+                      "default": "Description"
+                    },
+                    "status": {
+                      "type": "string",
+                      "title": "Status",
+                      "description": "The property that determines a sprint's status",
+                      "default": "Status"
+                    },
+                    "started_at": {
+                      "type": "string",
+                      "title": "Started At",
+                      "description": "The property that determines a sprint's start timestamp",
+                      "default": "Started At"
+                    },
+                    "ended_at": {
+                      "type": "string",
+                      "title": "Ended At",
+                      "description": "The property that determines a sprint's end timestamp",
+                      "default": "Ended At"
+                    },
+                    "closed_at": {
+                      "type": "string",
+                      "title": "Closed At",
+                      "description": "The property that determines a sprint's closed timestamp",
+                      "default": "Closed At"
+                    }
+                  }
+                }
+              }
+            }
+          ]
+        },
+        "tasks": {
+          "type": "object",
+          "title": "Tasks",
+          "description": "Configuration for tasks",
+          "oneOf": [
+            {
+              "type": "object",
+              "title": "Task Configuration",
+              "required": [
+                "kind"
+              ],
+              "properties": {
+                "option_title": {
+                  "type": "string",
+                  "const": "Tasks",
+                  "order": 0
+                },
+                "kind": {
+                  "type": "string",
+                  "title": "Task Kind",
+                  "description": "The value of the kind property for task types"
+                },
+                "include_additional_properties": {
+                  "type": "boolean",
+                  "title": "Include Additional Properties",
+                  "description": "Include unmapped properties in the task's additional fields",
+                  "default": false
+                },
+                "properties": {
+                  "type": "object",
+                  "title": "Properties",
+                  "description": "Task properties",
+                  "properties": {
+                    "name": {
+                      "type": "string",
+                      "title": "Name",
+                      "description": "The property that determines a task's name",
+                      "default": "Name"
+                    },
+                    "description": {
+                      "type": "string",
+                      "title": "Description",
+                      "description": "The property that determines a task's description",
+                      "default": "Description"
+                    },
+                    "type": {
+                      "type": "string",
+                      "title": "Task Type",
+                      "description": "The property that determines a task's type, e.g., story, bug, etc.",
+                      "default": "Type"
+                    },
+                    "project": {
+                      "type": "string",
+                      "title": "Project",
+                      "description": "The property that determines a task's project. It must have a relation type in Notion.",
+                      "default": "Project"
+                    },
+                    "epic": {
+                      "type": "string",
+                      "title": "Epic",
+                      "description": "The property that determines a task's epic. It must have a relation type in Notion.",
+                      "default": "Epic"
+                    },
+                    "sprint": {
+                      "type": "string",
+                      "title": "Sprint",
+                      "description": "The property that determines a task's sprint. It must have a relation type in Notion",
+                      "default": "Sprint"
+                    },
+                    "status": {
+                      "type": "string",
+                      "title": "Status",
+                      "description": "The property that determines a task's status",
+                      "default": "Status"
+                    },
+                    "priority": {
+                      "type": "string",
+                      "title": "Priority",
+                      "description": "The property that determines a task's priority",
+                      "default": "Priority"
+                    },
+                    "points": {
+                      "type": "string",
+                      "title": "Points",
+                      "description": "The property that determines a task's points",
+                      "default": "Points"
+                    },
+                    "assignee": {
+                      "type": "string",
+                      "title": "Assignee",
+                      "description": "The property that determines a task's assignee. It must have a person type in Notion.",
+                      "default": "Assignee"
+                    },
+                    "resolved_at": {
+                      "type": "string",
+                      "title": "Resolved At",
+                      "description": "The property that determines a task's resolved timestamp",
+                      "default": "Resolved At"
+                    }
+                  }
+                }
+              }
+            }
+          ]
+        }
+      }
+    }
+  ]
+}

package/resources/source-specific-configs/opsgenie.json

@@ -0,0 +1,34 @@
+{
+  "title": "OpsGenie",
+  "description": "Configuration options that apply to records generated by the OpsGenie Source.",
+  "type": "object",
+  "oneOf": [
+    {
+      "type": "object",
+      "title": "Configuration",
+      "properties": {
+        "source_type": {
+          "type": "string",
+          "const": "OpsGenie",
+          "order": 0
+        },
+        "max_description_length": {
+          "type": "integer",
+          "title": "Max Description Length",
+          "description": "Value to cut description to specific length",
+          "default": 1000
+        },
+        "application_mapping": {
+          "type": "string",
+          "title": "Application Mapping",
+          "description": "JSON map of OpsGenie service(s) name, to compute a Faros Application and Platform name. Used to reference compute_Application object, from an ims_Incident object. If specified, and such service exists, the feed will write a compute_Application object.",
+          "multiline": true,
+          "default": "{}",
+          "examples": [
+            "{ \"Aion\": { \"name\": \"aion\", \"platform\": \"ECS\" } }"
+          ]
+        }
+      }
+    }
+  ]
+}

package/resources/source-specific-configs/pagerduty.json

@@ -0,0 +1,48 @@
+{
+  "title": "PagerDuty",
+  "description": "Configuration options that apply to records generated by the PagerDuty Source.",
+  "type": "object",
+  "oneOf": [
+    {
+      "type": "object",
+      "title": "Configuration",
+      "properties": {
+        "source_type": {
+          "type": "string",
+          "const": "PagerDuty",
+          "order": 0
+        },
+        "application_mapping": {
+          "type": "string",
+          "title": "Application Mapping",
+          "description": "JSON map of PagerDuty service(s) name, to compute platform specific app name and platform name. Used to reference compute_Application object, from an ims_Incident object.",
+          "multiline": true,
+          "default": "{}",
+          "examples": [
+            "{ \"Aion\": { \"name\": \"aion\", \"platform\": \"ECS\" } }"
+          ]
+        },
+        "associate_applications_to_teams": {
+          "type": "boolean",
+          "title": "Associate Applications to Teams",
+          "description": "Associate applications to org teams based on PagerDuty team names",
+          "default": false
+        },
+        "default_severity": {
+          "type": "string",
+          "title": "Default Severity",
+          "description": "A default severity category if not present",
+          "pattern": "^(Sev[1-5])?(Custom)?$",
+          "examples": [
+            "Sev1",
+            "Sev2",
+            "Sev3",
+            "Sev4",
+            "Sev5",
+            "Custom"
+          ]
+        }
+      }
+    }
+  ]
+}

package/resources/source-specific-configs/phabricator.json

@@ -0,0 +1,24 @@
+{
+  "title": "Phabricator",
+  "description": "Configuration options that apply to records generated by the Phabricator Source.",
+  "type": "object",
+  "oneOf": [
+    {
+      "type": "object",
+      "title": "Configuration",
+      "properties": {
+        "source_type": {
+          "type": "string",
+          "const": "Phabricator",
+          "order": 0
+        },
+        "max_description_length": {
+          "type": "integer",
+          "title": "Max Description Length",
+          "description": "Value to cut description to specific length",
+          "default": 1000
+        }
+      }
+    }
+  ]
+}

package/resources/source-specific-configs/servicenow.json

@@ -0,0 +1,72 @@
+{
+  "title": "ServiceNow",
+  "description": "Configuration options that apply to records generated by the ServiceNow Source.",
+  "type": "object",
+  "oneOf": [
+    {
+      "type": "object",
+      "title": "Configuration",
+      "properties": {
+        "source_type": {
+          "type": "string",
+          "const": "ServiceNow",
+          "order": 0
+        },
+        "application_mapping": {
+          "type": "string",
+          "title": "Application Mapping",
+          "description": "JSON map of ServiceNow service(s) name, to compute platform specific app name and platform name. Used to reference compute_Application object, from an ims_Incident object.",
+          "multiline": true,
+          "default": "{}",
+          "examples": [
+            "{ \"Aion\": { \"name\": \"aion\", \"platform\": \"ECS\" } }"
+          ]
+        },
+        "application_field": {
+          "type": "string",
+          "title": "Application Field",
+          "description": "Field name in a ServiceNow incident, to compute a Faros Application name. The value of this field will be used to look up the app/platform in the specified application mapping",
+          "default": "business_service",
+          "pattern": "^(business_service|cmdb_ci)$",
+          "examples": [
+            "business_service",
+            "cmdb_ci"
+          ]
+        },
+        "default_severity": {
+          "type": "string",
+          "title": "Default Severity",
+          "description": "A default severity category if not present",
+          "pattern": "^(Sev[1-5])?(Custom)?$",
+          "examples": [
+            "Sev1",
+            "Sev2",
+            "Sev3",
+            "Sev4",
+            "Sev5",
+            "Custom"
+          ]
+        },
+        "default_priority": {
+          "type": "string",
+          "title": "Default Priority",
+          "description": "A default priority category if not present",
+          "pattern": "^(Critical|High|Medium|Low|Custom)$",
+          "examples": [
+            "Critical",
+            "High",
+            "Medium",
+            "Low",
+            "Custom"
+          ]
+        },
+        "store_current_incidents_associations": {
+          "type": "boolean",
+          "title": "Only store current incidents associations",
+          "description": "Only store current incidents associations in the graph.",
+          "default": false
+        }
+      }
+    }
+  ]
+}

package/resources/source-specific-configs/spec.json

@@ -0,0 +1,78 @@
+{
+  "order": 9,
+  "type": "object",
+  "title": "Source-specific configs",
+  "description": "Configuration options that apply to specific sources.",
+  "oneOf": [
+    {
+      "type": "object",
+      "title": "Configurations",
+      "properties": {
+        "option_title": {
+          "type": "string",
+          "const": "Source-specific configs"
+        },
+        "agileaccelerator": {
+          "$ref": "agileaccelerator.json"
+        },
+        "azurepipeline": {
+          "$ref": "azurepipeline.json"
+        },
+        "backlog": {
+          "$ref": "backlog.json"
+        },
+        "bamboohr": {
+          "$ref": "bamboohr.json"
+        },
+        "bitbucket": {
+          "$ref": "bitbucket.json"
+        },
+        "circleci": {
+          "$ref": "circleci.json"
+        },
+        "clickup": {
+          "$ref": "clickup.json"
+        },
+        "datadog": {
+          "$ref": "datadog.json"
+        },
+        "docker": {
+          "$ref": "docker.json"
+        },
+        "firehydrant": {
+          "$ref": "firehydrant.json"
+        },
+        "jenkins": {
+          "$ref": "jenkins.json"
+        },
+        "jira": {
+          "$ref": "jira.json"
+        },
+        "notion": {
+          "$ref": "notion.json"
+        },
+        "opsgenie": {
+          "$ref": "opsgenie.json"
+        },
+        "pagerduty": {
+          "$ref": "pagerduty.json"
+        },
+        "phabricator": {
+          "$ref": "phabricator.json"
+        },
+        "servicenow": {
+          "$ref": "servicenow.json"
+        },
+        "squadcast": {
+          "$ref": "squadcast.json"
+        },
+        "statuspage": {
+          "$ref": "statuspage.json"
+        },
+        "victorops": {
+          "$ref": "victorops.json"
+        }
+      }
+    }
+  ]
+}

package/resources/source-specific-configs/squadcast.json

@@ -0,0 +1,28 @@
+{
+  "title": "SquadCast",
+  "description": "Configuration options that apply to records generated by the SquadCast Source.",
+  "type": "object",
+  "oneOf": [
+    {
+      "type": "object",
+      "title": "Configuration",
+      "properties": {
+        "source_type": {
+          "type": "string",
+          "const": "SquadCast",
+          "order": 0
+        },
+        "application_mapping": {
+          "type": "string",
+          "title": "Application Mapping",
+          "description": "JSON map of SquadCast service(s) name, to compute platform specific app name and platform name. Used to reference compute_Application object, from an ims_Incident object.",
+          "multiline": true,
+          "default": "{}",
+          "examples": [
+            "{ \"Aion\": { \"name\": \"aion\", \"platform\": \"ECS\" } }"
+          ]
+        }
+      }
+    }
+  ]
+}

package/resources/source-specific-configs/statuspage.json

@@ -0,0 +1,28 @@
+{
+  "title": "Statuspage",
+  "description": "Configuration options that apply to records generated by the Statuspage Source.",
+  "type": "object",
+  "oneOf": [
+    {
+      "type": "object",
+      "title": "Configuration",
+      "properties": {
+        "source_type": {
+          "type": "string",
+          "const": "Statuspage",
+          "order": 0
+        },
+        "application_mapping": {
+          "type": "string",
+          "title": "Application Mapping",
+          "description": "JSON map of Statuspage service(s) name, to compute platform specific app name and platform name. Used to reference compute_Application object, from an ims_Incident object.",
+          "multiline": true,
+          "default": "{}",
+          "examples": [
+            "{ \"Aion\": { \"name\": \"aion\", \"platform\": \"ECS\" } }"
+          ]
+        }
+      }
+    }
+  ]
+}

package/resources/source-specific-configs/victorops.json

@@ -0,0 +1,37 @@
+{
+  "title": "VictorOps",
+  "description": "Configuration options that apply to records generated by the VictorOps Source.",
+  "type": "object",
+  "oneOf": [
+    {
+      "type": "object",
+      "title": "Configuration",
+      "properties": {
+        "source_type": {
+          "type": "string",
+          "const": "VictorOps",
+          "order": 0
+        },
+        "application_mapping": {
+          "type": "string",
+          "title": "Application Mapping",
+          "description": "JSON map of VictorOps service(s) name, to compute a Faros Application and Platform name. Used to reference compute_Application object, from an ims_Incident object. If specified, and such service exists, the feed will write a compute_Application object.",
+          "multiline": true,
+          "default": "{}",
+          "examples": [
+            "{ \"Aion\": { \"name\": \"aion\", \"platform\": \"ECS\" } }"
+          ]
+        },
+        "application_field": {
+          "type": "string",
+          "title": "Application Field",
+          "description": "Field name in a VictorOps incident, to compute a Faros Application name. The value of this field will be used to look up the app/platform in the specified application mapping",
+          "default": "service",
+          "examples": [
+            "routing_key"
+          ]
+        }
+      }
+    }
+  ]
+}