Skip to content

fix: fix field name pathing #172

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

Open
eyalr1100 wants to merge 3 commits into
base: master
Choose a base branch
from
Open

fix: fix field name pathing #172

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1c3ec26
fix: fix field name pathing
eyalr1100 Jul 27, 2026
4deb8d7
fix: create new schema instead of changing it
eyalr1100 Jul 27, 2026
4e65e81
fix: require all S3 configs
eyalr1100 Jul 27, 2026
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
262 changes: 262 additions & 0 deletions schemas/vector/vectorStandard/synchronizer/v2.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,262 @@
{
"$id": "https://mapcolonies.com/vector/vectorStandard/synchronizer/v2",
"type": "object",
"title": "vectorStandardSynchronizerSchemaV2",
"description": "Vector's standard synchronizer schema",
"allOf": [
{ "$ref": "https://mapcolonies.com/common/boilerplate/v2" },
{
"type": "object",
"required": ["dbs", "schedule", "enrichment"],
"properties": {
"dbs": {
"type": "object",
"required": ["source", "destination", "s3"],
"properties": {
"source": { "$ref": "#/definitions/sourceDb" },
"destination": { "$ref": "#/definitions/destinationDb" },
"s3": { "$ref": "#/definitions/s3" }
}
},
"schedule": { "$ref": "#/definitions/schedule" },
"indexNameFormat": { "$ref": "#/definitions/indexNameFormat" },
"layersFile": { "$ref": "#/definitions/layersFile" },
"aliasesFile": { "$ref": "#/definitions/aliasesFile" },
"enrichment": { "$ref": "#/definitions/enrichment" }
}
}
],
"definitions": {
"sourceDb": {
"type": "object",
"required": ["database", "ssl", "type"],
"properties": {
"host": { "type": "string", "description": "the host of the database", "default": "localhost", "x-env-value": "SOURCE_DB_HOST" },
"port": { "type": "integer", "description": "the port of the database", "default": 5432, "x-env-value": "SOURCE_DB_PORT" },
"username": {
"type": "string",
"description": "the username of the database",
"default": "postgres",
"maxLength": 63,
"x-env-value": "SOURCE_DB_USERNAME"
},
"password": { "type": "string", "description": "the password of the database", "default": "postgres", "x-env-value": "SOURCE_DB_PASSWORD" },
"schema": { "type": "string", "description": "the schema name of the database", "default": "public", "x-env-value": "SOURCE_DB_SCHEMA" },
"database": { "type": "string", "description": "the database name", "maxLength": 63, "x-env-value": "SOURCE_DB_NAME" },
"type": { "type": "string", "description": "the type of the database", "default": "postgres", "x-env-value": "SOURCE_DB_TYPE" },
"ssl": {
"type": "object",
"description": "ssl configuration",
"properties": {
"enabled": {
"type": "boolean",
"description": "enable ssl",
"default": false,
"x-env-value": "SOURCE_DB_ENABLE_SSL_AUTH"
},
"ca": {
"type": "string",
"description": "the path to the ca file",
"x-env-value": "SOURCE_DB_CA_PATH"
},
"cert": {
"type": "string",
"description": "the path to the cert file",
"x-env-value": "SOURCE_DB_CERT_PATH"
},
"key": {
"type": "string",
"description": "the path to the key file",
"x-env-value": "SOURCE_DB_KEY_PATH"
}
},
"unevaluatedProperties": false,
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"then": {
"required": ["cert", "key"]
},
"else": {
"properties": {
"enabled": {
"const": false
}
}
}
}
}
},
"destinationDb": {
"type": "object",
"required": ["database", "ssl", "type"],
"properties": {
"host": { "type": "string", "description": "the host of the database", "default": "localhost", "x-env-value": "DEST_DB_HOST" },
"port": { "type": "integer", "description": "the port of the database", "default": 5432, "x-env-value": "DEST_DB_PORT" },
"username": {
"type": "string",
"description": "the username of the database",
"default": "postgres",
"maxLength": 63,
"x-env-value": "DEST_DB_USERNAME"
},
"password": { "type": "string", "description": "the password of the database", "default": "postgres", "x-env-value": "DEST_DB_PASSWORD" },
"schema": { "type": "string", "description": "the schema name of the database", "default": "public", "x-env-value": "DEST_DB_SCHEMA" },
"database": { "type": "string", "description": "the database name", "maxLength": 63, "x-env-value": "DEST_DB_NAME" },
"type": { "type": "string", "description": "the type of the database", "default": "postgres", "x-env-value": "DEST_DB_TYPE" },
"ssl": {
"type": "object",
"description": "ssl configuration",
"properties": {
"enabled": {
"type": "boolean",
"description": "enable ssl",
"default": false,
"x-env-value": "DEST_DB_ENABLE_SSL_AUTH"
},
"ca": {
"type": "string",
"description": "the path to the ca file",
"x-env-value": "DEST_DB_CA_PATH"
},
"cert": {
"type": "string",
"description": "the path to the cert file",
"x-env-value": "DEST_DB_CERT_PATH"
},
"key": {
"type": "string",
"description": "the path to the key file",
"x-env-value": "DEST_DB_KEY_PATH"
}
},
"unevaluatedProperties": false,
"if": {
"properties": {
"enabled": {
"const": true
}
}
},
"then": {
"required": ["cert", "key"]
},
"else": {
"properties": {
"enabled": {
"const": false
}
}
}
}
}
},
"s3": {
"allOf": [
{
"$ref": "https://mapcolonies.com/common/s3/full/v2"
},
{
"type": "object",
"required": ["fileName", "layersVariable", "aliasFieldName", "idFieldName", "nameFieldName"],
"properties": {
"fileName": {
"type": "string",
"description": "Lua file name",
"x-env-value": "S3_FILE_NAME"
},
"layersVariable": {
"type": "string",
"description": "Lua layers variable name",
"x-env-value": "S3_LAYERS_VARIABLE"
},
"aliasFieldName": {
"type": "string",
"description": "Lua alias field name",
"x-env-value": "S3_ALIAS_FIELD_NAME"
},
"idFieldName": {
"type": "string",
"description": "Lua id field name",
"x-env-value": "S3_ID_FIELD_NAME"
},
"nameFieldName": {
"type": "string",
"description": "Lua name field name",
"x-env-value": "S3_NAME_FIELD_NAME"
}
}
}
]
},
"schedule": {
"type": "string",
"description": "The cron timing spec",
"default": "0 0 * * *",
"examples": ["*/1 * * * *"],
"x-env-value": "SYNC_FIELDS_CRON"
},
"indexNameFormat": {
"type": "string",
"description": "The indexes' names in the source DB",
"default": "{layerName}_{column}_idx",
"examples": ["{layerName}_{column}_idx"],
"x-env-value": "INDEX_NAME_FORMAT"
},
"layersFile": {
"type": "string",
"description": "The path to the layers file",
"default": "./config/layers.json",
"x-env-value": "LAYERS_FILE_PATH"
},
"aliasesFile": {
"type": "string",
"description": "The path to the aliases file",
"default": "./config/aliases.json",
"x-env-value": "ALIASES_FILE_PATH"
},
"enrichment": {
"type": "object",
"description": "Enrichment configuration",
"required": ["enabled"],
"properties": {
"enabled": {
"type": "boolean",
"description": "enable enrichment",
"default": false,
"x-env-value": "ENRICHMENT_ENABLED"
},
"api": {
"type": "string",
"description": "Property alias name API",
"x-env-value": "ENRICHMENT_API_URL",
"default": "https://example.com/layers/{layerName}"
},
"propertiesPath": {
"type": "string",
"default": "{layerName}.properties",
"x-env-value": "ENRICHMENT_PROPERTIES_PATH"
},
"aliasField": {
"type": "string",
"default": "alias",
"x-env-value": "ENRICHMENT_ALIAS_FIELD"
}
},
"unevaluatedProperties": false,
"if": {
"properties": { "enabled": { "const": true } }
},
"then": {
"required": ["api", "propertiesPath", "aliasField"]
},
"else": {
"properties": { "enabled": { "const": false } }
}
}
}
}
Loading