Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add events to enrichment settings file (Closes #806) #807

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add events to enrichment settings file (Closes #806) #807

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
201 changes: 201 additions & 0 deletions ...com.snowplowanalytics.snowplow.enrichments/api_request_enrichment_config/jsonschema/1-0-1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
{
"$schema": "http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#",
"description": "Schema for API Request Enrichment configuration",
"self": {
"vendor": "com.snowplowanalytics.snowplow.enrichments",
"name": "api_request_enrichment_config",
"format": "jsonschema",
"version": "1-0-1"
},

"type": "object",
"properties": {
"vendor": {
"type": "string"
},
"name": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"events" : {
"type" : [ "array", "null" ],
"items" : {
"oneOf": [
{
"type": "object",
"properties": {
"eventType": {
"type": "string",
"enum": ["struct", "ad_impression", "transaction",
"transaction_item", "page_view","page_ping"]
}
},
"required": ["eventType"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"eventType": {
"type": "string",
"enum": ["unstruct"]
},
"schema": {
"type": "string",
"pattern": "^iglu:([a-zA-Z0-9-_.]+)/([a-zA-Z0-9-_]+)/([a-zA-Z0-9-_]+)/([1-9][0-9]*|\\*)-((?:0|[1-9][0-9]*)|\\*)-((?:0|[1-9][0-9]*)|\\*)$"
}
},
"required": ["eventType", "schema"],
"additionalProperties": false
}
]
},
"description": "Perform this enrichment for the events in the list. Use null to disable"
},
"parameters": {
"type": "object",
"properties": {
"inputs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]+$"
},
"pojo": {
"type": "object",
"properties": {
"field": {
"type": "string"
}
},
"additionalProperties": false
},
"json": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": ["unstruct_event", "contexts", "derived_contexts"]
},
"schemaCriterion": {
"type": "string",
"pattern": "^iglu:[a-zA-Z0-9-_.]+/[a-zA-Z0-9-_]+/[a-zA-Z0-9-_]+/([1-9][0-9]*|\\*)-((?:0|[1-9][0-9]*)|\\*)-((?:0|[1-9][0-9]*)|\\*)$"
},
"jsonPath": {
"type": "string",
"pattern": "^\\$.*$"
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"minProperties": 2,
"maxProperties": 2,
"required": ["key"]
}
},
"api": {
"type": "object",
"minProperties": 1,
"maxProperties": 1,
"properties": {
"http": {
"type": "object",
"properties": {
"method": {
"type": "string",
"enum": ["GET", "POST", "PUT"]
},
"uri": {
"type": "string"
},
"timeout": {
"type": "integer",
"minimum": 1,
"maximum": 60000
},
"authentication": {
"type": "object",
"properties": {
"httpBasic": {
"type": "object",
"properties": {
"username": {
"type": "string"
},
"password": {
"type": "string"
}
},
"required": ["username", "password"],
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"required": ["method", "uri", "timeout", "authentication"],
"additionalProperties": false
}
},
"additionalProperties": false
},
"outputs": {
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"properties": {
"schema": {
"type": "string",
"pattern": "^iglu:([a-zA-Z0-9-_.]+)/([a-zA-Z0-9-_]+)/([a-zA-Z0-9-_]+)/([1-9][0-9]*(?:-(?:0|[1-9][0-9]*)){2})$"
},
"json": {
"type": "object",
"properties": {
"jsonPath": {
"type": "string",
"pattern": "^\\$.*$"
}
},
"required": ["jsonPath"],
"additionalProperties": false
}
},
"required": ["schema"],
"minProperties": 2,
"maxProperties": 2,
"additionalProperties": false
}
},
"cache": {
"type": "object",
"properties": {
"size": {
"type": "integer",
"minimum": 1
},
"ttl": {
"type": "integer",
"minimum": 0,
"maximum": 86400
}
},
"additionalProperties": false,
"required": ["size", "ttl"]
}
},
"additionalProperties": false,
"required": ["inputs", "api", "outputs", "cache"]
}
},
"additionalProperties": false,
"required": ["name", "vendor", "enabled", "parameters"]
}

70 changes: 70 additions & 0 deletions .../com.snowplowanalytics.snowplow.enrichments/http_header_extractor_config/jsonschema/1-0-1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
{
"$schema": "http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#",
"description": "Schema for HTTP header extractor enrichment",
"self": {
"vendor": "com.snowplowanalytics.snowplow.enrichments",
"name": "http_header_extractor_config",
"format": "jsonschema",
"version": "1-0-1"
},

"type": "object",
"properties": {
"vendor": {
"type": "string"
},
"name": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"events" : {
"type" : [ "array", "null" ],
"items" : {
"oneOf": [
{
"type": "object",
"properties": {
"eventType": {
"type": "string",
"enum": ["struct", "ad_impression", "transaction",
"transaction_item", "page_view","page_ping"]
}
},
"required": ["eventType"],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"eventType": {
"type": "string",
"enum": ["unstruct"]
},
"schema": {
"type": "string",
"pattern": "^iglu:([a-zA-Z0-9-_.]+)/([a-zA-Z0-9-_]+)/([a-zA-Z0-9-_]+)/([1-9][0-9]*|\\*)-((?:0|[1-9][0-9]*)|\\*)-((?:0|[1-9][0-9]*)|\\*)$"
}
},
"required": ["eventType", "schema"],
"additionalProperties": false
}
]
},
"description": "Perform this enrichment for the events in the list. Use null to disable"
},
"parameters": {
"type": "object",
"properties": {
"headersPattern": {
"type": "string"
}
},
"required": ["headersPattern"],
"additionalProperties": false
}
},
"required": ["name", "vendor", "enabled", "parameters"],
"additionalProperties": false
}
Loading