airbyte-faros-destination 0.1.53

package/resources/spec.json

@@ -0,0 +1,468 @@
+{
+  "documentationUrl": "https://docs.faros.ai",
+  "supportsIncremental": true,
+  "supportsNormalization": false,
+  "supportsDBT": true,
+  "supported_destination_sync_modes": [
+    "overwrite",
+    "append",
+    "append_dedup"
+  ],
+  "connectionSpecification": {
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "Faros Destination Spec",
+    "type": "object",
+    "required": [
+      "edition_configs"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "edition_configs": {
+        "order": 0,
+        "title": "Faros Edition",
+        "description": "Choose your Faros Edition.",
+        "type": "object",
+        "oneOf": [
+          {
+            "type": "object",
+            "title": "Community Edition",
+            "required": [
+              "hasura_url"
+            ],
+            "properties": {
+              "edition": {
+                "type": "string",
+                "title": "Community Edition",
+                "description": "Community Edition",
+                "const": "community"
+              },
+              "hasura_url": {
+                "type": "string",
+                "title": "Hasura URL",
+                "description": "The Community Edition Hasura URL.",
+                "default": "http://localhost:8080"
+              },
+              "segment_user_id": {
+                "type": "string",
+                "title": "Segment User Id",
+                "description": "The User UUID with which to track events in Segment. If not present, then reporting is disabled. See https://community.faros.ai/docs/telemetry for more details.",
+                "format": "uuid"
+              }
+            }
+          },
+          {
+            "type": "object",
+            "title": "Cloud Edition",
+            "required": [
+              "api_key",
+              "api_url"
+            ],
+            "properties": {
+              "edition": {
+                "type": "string",
+                "title": "Cloud Edition",
+                "description": "Cloud Edition",
+                "const": "cloud"
+              },
+              "api_url": {
+                "type": "string",
+                "title": "API URL",
+                "description": "The Faros API URL.",
+                "default": "https://prod.api.faros.ai",
+                "examples": [
+                  "https://prod.api.faros.ai"
+                ]
+              },
+              "api_key": {
+                "title": "API Key",
+                "type": "string",
+                "description": "The Faros API key to use to access the API.",
+                "airbyte_secret": true
+              },
+              "graph": {
+                "type": "string",
+                "title": "Graph name",
+                "description": "The Faros graph name.",
+                "default": "default"
+              },
+              "expiration": {
+                "type": "string",
+                "title": "Revision expiration",
+                "description": "The Faros graph revision expiration time.",
+                "default": "5 seconds",
+                "examples": [
+                  "5 seconds"
+                ]
+              }
+            }
+          }
+        ]
+      },
+      "origin": {
+        "order": 1,
+        "type": "string",
+        "title": "Origin name",
+        "description": "The Faros origin name used for uploaded entries. Must be unique.",
+        "examples": [
+          "my-faros-destination"
+        ]
+      },
+      "dry_run": {
+        "order": 2,
+        "type": "boolean",
+        "title": "Dry run",
+        "description": "Process all input records but avoid writing into Faros API",
+        "default": false
+      },
+      "invalid_record_strategy": {
+        "order": 3,
+        "type": "string",
+        "title": "Invalid record strategy",
+        "description": "Strategy to follow to handle an invalid input record.",
+        "default": "SKIP",
+        "enum": [
+          "FAIL",
+          "SKIP"
+        ]
+      },
+      "jsonata_expression": {
+        "order": 4,
+        "type": "string",
+        "title": "JSONata expression",
+        "description": "JSONata expression for converting input records. If provided applies the expression based on specified JSONata apply mode."
+      },
+      "jsonata_mode": {
+        "order": 5,
+        "type": "string",
+        "title": "JSONata apply mode",
+        "description": "JSONata apply mode when converting input records.",
+        "default": "FALLBACK",
+        "enum": [
+          "FALLBACK",
+          "OVERRIDE"
+        ]
+      },
+      "jsonata_destination_models": {
+        "order": 6,
+        "type": "array",
+        "items": {
+          "type": "string"
+        },
+        "title": "JSONata destination models",
+        "description": "Destination models when using JSONata expression.",
+        "examples": [
+          "ims_Incident",
+          "vcs_Commit"
+        ]
+      },
+      "source_specific_configs": {
+        "order": 7,
+        "type": "object",
+        "title": "Source-specific configs",
+        "description": "Configuration options that apply to specific sources.",
+        "oneOf": [
+          {
+            "type": "object",
+            "title": "Configurations",
+            "properties": {
+              "agileaccelerator": {
+                "title": "AgileAccelerator",
+                "description": "Configuration options that apply to records generated by the AgileAccelerator Source.",
+                "type": "object",
+                "oneOf": [
+                  {
+                    "type": "object",
+                    "title": "Configuration",
+                    "properties": {
+                      "max_description_length": {
+                        "type": "integer",
+                        "title": "Max Description Length",
+                        "description": "Value to cut description to specific length",
+                        "default": 1000
+                      },
+                      "work_additional_fields": {
+                        "type": "array",
+                        "title": "Work Additional Fields",
+                        "description": "Fields to save to tms_Task's additionalFields variable",
+                        "default": []
+                      }
+                    }
+                  }
+                ]
+              },
+              "backlog": {
+                "title": "Backlog",
+                "description": "Configuration options that apply to records generated by the Backlog Source.",
+                "type": "object",
+                "oneOf": [
+                  {
+                    "type": "object",
+                    "title": "Configuration",
+                    "properties": {
+                      "max_description_length": {
+                        "type": "integer",
+                        "title": "Max Description Length",
+                        "description": "Value to cut description to specific length",
+                        "default": 1000
+                      }
+                    }
+                  }
+                ]
+              },
+              "bitbucket": {
+                "title": "Bitbucket",
+                "description": "Configuration options that apply to records generated by the Bitbucket Source.",
+                "type": "object",
+                "oneOf": [
+                  {
+                    "type": "object",
+                    "title": "Configuration",
+                    "properties": {
+                      "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\" } }"
+                        ]
+                      }
+                    }
+                  }
+                ]
+              },
+              "datadog": {
+                "title": "Datadog",
+                "description": "Configuration options that apply to records generated by the Datadog Source.",
+                "type": "object",
+                "oneOf": [
+                  {
+                    "type": "object",
+                    "title": "Configuration",
+                    "properties": {
+                      "application_mapping": {
+                        "type": "string",
+                        "title": "Application Mapping",
+                        "description": "JSON map of Datadog 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\" } }"
+                        ]
+                      },
+                      "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"
+                        ]
+                      }
+                    }
+                  }
+                ]
+              },
+              "docker": {
+                "title": "Docker",
+                "description": "Configuration options that apply to records generated by the Docker Source.",
+                "type": "object",
+                "oneOf": [
+                  {
+                    "type": "object",
+                    "title": "Configuration",
+                    "required": [
+                      "organization"
+                    ],
+                    "properties": {
+                      "label_prefix": {
+                        "type": "string",
+                        "title": "Label Prefix",
+                        "description": "Label prefix used to construct build key and commit key for cicd_Artifact and cicd_ArtifactCommitAssociation from labels. Every label key start with this prefix. If the prefix is 'faros-', then the label keys will be 'faros-build-id', 'faros-pipeline-id', etc."
+                      },
+                      "skip_tags": {
+                        "type": "array",
+                        "items": {
+                          "type": "string"
+                        },
+                        "title": "Skip tags",
+                        "description": "The images with the listed tags will be ignored by the feed"
+                      },
+                      "organization": {
+                        "type": "string",
+                        "title": "Organization",
+                        "description": "Organization name to associate with image tags",
+                        "default": "unknown-org"
+                      }
+                    }
+                  }
+                ]
+              },
+              "jira": {
+                "title": "Jira",
+                "description": "Configuration options that apply to records generated by the Jira Source.",
+                "type": "object",
+                "oneOf": [
+                  {
+                    "type": "object",
+                    "title": "Configuration",
+                    "properties": {
+                      "use_board_ownership": {
+                        "type": "boolean",
+                        "title": "Use Board Ownership",
+                        "description": "Use Jira boards for assigning owners of tasks, or use projects.",
+                        "default": false
+                      },
+                      "truncate_limit": {
+                        "type": "integer",
+                        "title": "Truncate Limit",
+                        "description": "Truncate the descriptions of projects, tasks, and epics.",
+                        "default": 10000
+                      },
+                      "exclude_fields": {
+                        "type": "array",
+                        "items": {
+                          "type": "string"
+                        },
+                        "title": "Exclude Fields",
+                        "description": "List of fields to exclude when saving tasks. Defaults to no exclusions.",
+                        "default": []
+                      },
+                      "additional_fields_array_limit": {
+                        "type": "integer",
+                        "title": "Additional Fields Array Limit",
+                        "description": "Truncates an additional field's array value to the given length.",
+                        "default": 50
+                      }
+                    }
+                  }
+                ]
+              },
+              "pagerduty": {
+                "title": "PagerDuty",
+                "description": "Configuration options that apply to records generated by the PagerDuty Source.",
+                "type": "object",
+                "oneOf": [
+                  {
+                    "type": "object",
+                    "title": "Configuration",
+                    "properties": {
+                      "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\" } }"
+                        ]
+                      },
+                      "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"
+                        ]
+                      }
+                    }
+                  }
+                ]
+              },
+              "squadcast": {
+                "title": "SquadCast",
+                "description": "Configuration options that apply to records generated by the SquadCast Source.",
+                "type": "object",
+                "oneOf": [
+                  {
+                    "type": "object",
+                    "title": "Configuration",
+                    "properties": {
+                      "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\" } }"
+                        ]
+                      }
+                    }
+                  }
+                ]
+              },
+              "statuspage": {
+                "title": "StatusPage",
+                "description": "Configuration options that apply to records generated by the StatusPage Source.",
+                "type": "object",
+                "oneOf": [
+                  {
+                    "type": "object",
+                    "title": "Configuration",
+                    "properties": {
+                      "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\" } }"
+                        ]
+                      }
+                    }
+                  }
+                ]
+              },
+              "victorops": {
+                "title": "VictorOps",
+                "description": "Configuration options that apply to records generated by the VictorOps Source.",
+                "type": "object",
+                "oneOf": [
+                  {
+                    "type": "object",
+                    "title": "Configuration",
+                    "properties": {
+                      "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"
+                        ]
+                      }
+                    }
+                  }
+                ]
+              }
+            }
+          }
+        ]
+      }
+    }
+  }
+}