repository
stringclasses 528
values | commit
stringlengths 40
40
| commitDate
timestamp[s] | path
stringlengths 11
149
| repoStars
int64 5
94.9k
| repoLastFetched
stringclasses 528
values | content
stringlengths 48
736k
| license
stringclasses 14
values | language
stringclasses 7
values |
|---|---|---|---|---|---|---|---|---|
hpcc-systems/helm-chart | 7b64a07e918f354559b0f743eeec6cba185199ca | 2022-03-30T14:44:57 | helm/hpcc/values.schema.json | 10 | 2024-05-28T04:25:31.595363Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"definitions": {
"auth": {
"description": "Authentication method",
"type": "string"
},
"authNZ": {
"additionalProperties": {
"type": [
"object"
]
},
"type": "object"
},
"bundle": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"name": {
"description": "The name of the bundle process",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"compileOption": {
"additionalProperties": false,
"properties": {
"cluster": {
"description": "Cluster to apply option to",
"type": "string"
},
"name": {
"description": "Compiler option name",
"type": "string"
},
"value": {
"description": "Compiler option value",
"type": [
"number",
"string",
"boolean"
]
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"componentCost": {
"description": "component level costs",
"properties": {
"perCpu": {
"description": "cost of a single cpu",
"type": "number"
}
},
"type": "object"
},
"dafilesrv": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"image": {
"$ref": "#/definitions/image"
},
"logging": {
"$ref": "#/definitions/logging"
},
"name": {
"description": "The name of the dafilesrv process",
"type": "string"
},
"parallelRequestLimit": {
"default": "20",
"type": "integer"
},
"replicas": {
"type": "integer"
},
"resources": {
"$ref": "#/definitions/resources"
},
"service": {
"$ref": "#/definitions/service"
}
},
"required": [
"name",
"service"
],
"type": "object"
},
"dali": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"auth": {
"$ref": "#/definitions/auth"
},
"env": {
"$ref": "#/definitions/env"
},
"image": {
"$ref": "#/definitions/image"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"ldap": {
"$ref": "#/definitions/ldap"
},
"logging": {
"$ref": "#/definitions/logging"
},
"maxStartupTime": {
"$ref": "#/definitions/maxStartupTime"
},
"minStartupTime": {
"$ref": "#/definitions/minStartupTime"
},
"name": {
"description": "The name of the dali process",
"type": "string"
},
"resources": {
"$ref": "#/definitions/resources"
},
"service": {
"$ref": "#/definitions/service"
},
"services": {
"$ref": "#/definitions/sashaservice",
"description": "sasha services",
"type": "object"
}
},
"required": [
"name",
"auth"
],
"type": "object"
},
"eclSecurity": {
"properties": {
"datafile": {
"$ref": "#/definitions/eclSecurityValues"
},
"embedded": {
"$ref": "#/definitions/eclSecurityValues"
},
"extern": {
"$ref": "#/definitions/eclSecurityValues"
},
"pipe": {
"$ref": "#/definitions/eclSecurityValues"
}
},
"type": "object"
},
"eclSecurityValues": {
"enum": [
"deny",
"allow",
"allowSigned"
],
"type": "string"
},
"eclagent": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"cost": {
"$ref": "#/definitions/componentCost"
},
"dataPlane": {
"description": "The default storage plane to write data files to",
"type": "string"
},
"env": {
"$ref": "#/definitions/env"
},
"image": {
"$ref": "#/definitions/image"
},
"jobMemory": {
"$ref": "#/definitions/memory"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"logging": {
"$ref": "#/definitions/logging"
},
"maxActive": {
"default": 100,
"description": "Maximum number of workunits that can be active simultaneously",
"minimum": 1,
"type": "integer"
},
"replicas": {
"type": "integer"
},
"resources": {
"$ref": "#/definitions/resources"
},
"type": {
"description": "Use the hthor or roxie execution engine for eclagent queries",
"enum": [
"hthor",
"roxie"
],
"type": "string"
},
"useChildProcesses": {
"description": "Launch each workunit as a child process rather than in its own container",
"type": "boolean"
}
},
"required": [
"maxActive"
],
"type": "object"
},
"eclccserver": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"childProcessTimeLimit": {
"default": 10,
"description": "Time limit (in seconds) for child process compilation before aborting and using separate container, when useChildProcesses is false",
"type": "integer"
},
"cost": {
"$ref": "#/definitions/componentCost"
},
"env": {
"$ref": "#/definitions/env"
},
"gitPlane": {
"description": "The storage plane to check git repositories out to",
"type": "string"
},
"gitUsername": {
"description": "The username to use for all remote repository access",
"type": "string"
},
"image": {
"$ref": "#/definitions/image"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"listen": {
"items": {
"type": "string"
},
"type": "array"
},
"logging": {
"$ref": "#/definitions/logging"
},
"maxActive": {
"default": 4,
"description": "Maximum number of compile jobs that can be active simultaneously",
"minimum": 1,
"type": "integer"
},
"name": {
"description": "The name of the eclccserver process",
"type": "string"
},
"options": {
"items": {
"$ref": "#/definitions/compileOption"
},
"type": "array"
},
"replicas": {
"type": "integer"
},
"resources": {
"$ref": "#/definitions/resources"
},
"useChildProcesses": {
"description": "Launch each workunit compile as a child process rather than in its own container",
"type": "boolean"
}
},
"required": [
"name",
"maxActive"
],
"type": "object"
},
"eclscheduler": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"env": {
"$ref": "#/definitions/env"
},
"image": {
"$ref": "#/definitions/image"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"logging": {
"$ref": "#/definitions/logging"
},
"name": {
"description": "The name of the eclccserver process",
"type": "string"
},
"resources": {
"$ref": "#/definitions/resources"
}
},
"required": [
"name"
],
"type": "object"
},
"egress": {
"additionalProperties": false,
"properties": {
"kubeApiCidr": {
"description": "IP range for kubectl API service",
"type": "string"
},
"kubeApiPort": {
"description": "Port used for connections to kubectl API",
"type": "integer"
},
"kubeSystemLabel": {
"description": "Label that has been applied to the kube-system namespace, used to restrict DNS service calls on port 53 to pods in the kube-system namespace",
"type": "string"
},
"restricted": {
"description": "Are any egress controls applied",
"type": "boolean"
}
},
"type": "object"
},
"env": {
"items": {
"properties": {
"name": {
"description": "Environment variable name",
"type": "string"
},
"value": {
"description": "Environment variable value",
"type": [
"number",
"string",
"boolean"
]
}
},
"type": "object"
},
"type": "array"
},
"esp": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"auth": {
"$ref": "#/definitions/auth"
},
"authNZ": {
"$ref": "#/definitions/authNZ"
},
"bindingInfo": {
"description": "Customizable binding options",
"type": "object"
},
"certificate": {
"description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.",
"type": "string"
},
"env": {
"$ref": "#/definitions/env"
},
"image": {
"$ref": "#/definitions/image"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"ldap": {
"$ref": "#/definitions/ldap"
},
"logging": {
"$ref": "#/definitions/logging"
},
"name": {
"description": "The name of the esp process",
"type": "string"
},
"remoteClients": {
"$ref": "#/definitions/remoteClients"
},
"replicas": {
"type": "integer"
},
"resources": {
"$ref": "#/definitions/resources"
},
"service": {
"$ref": "#/definitions/service"
}
},
"required": [
"name",
"service",
"auth"
],
"type": "object"
},
"global": {
"additionalProperties": false,
"properties": {
"cost": {
"description": "default resource cost",
"properties": {
"currencyCode": {
"description": "currency code (ISO 4217)",
"maxLength": 3,
"type": "string"
},
"perCpu": {
"description": "cost of a single cpu",
"type": "number"
},
"storageAtRest": {
"description": "storage cost (GiB per month)",
"type": "number"
},
"storageReads": {
"description": "cost per 10,000 read operations",
"type": "number"
},
"storageWrites": {
"description": "cost per 10,000 write operations",
"type": "number"
}
},
"type": "object"
},
"defaultDataPath": {
"type": "string"
},
"defaultEsp": {
"type": "string"
},
"defaultMirrorPath": {
"type": "string"
},
"egress": {
"$ref": "#/definitions/egress"
},
"env": {
"$ref": "#/definitions/env"
},
"image": {
"$ref": "#/definitions/image"
},
"logAccess": {
"$ref": "#/definitions/logAccess"
},
"logging": {
"$ref": "#/definitions/logging"
},
"metrics": {
"description": "Global metrics configuration",
"properties": {
"sinks": {
"$ref": "#/definitions/sinks"
}
},
"type": "object"
},
"misc": {
"description": "Miscellaneous settings",
"oneOf": [
{
"properties": {
"postJobCommand": {
"description": "Execute this command when a K8s Job launched by a deployment ends, either gracefully or when terminated externally causing a preStop event",
"type": "string"
},
"postJobCommandViaSidecar": {
"description": "Causes shareProcessNamespace to be enabled, and the postJobCommand to execute via a sidecar",
"type": "boolean"
}
},
"type": "object"
},
{
"type": "null"
}
]
},
"noResourceValidation": {
"type": "boolean"
},
"privileged": {
"type": "boolean"
},
"stubInstanceResources": {
"$ref": "#/definitions/stubInstanceResources"
},
"user": {
"$ref": "#/definitions/user"
},
"visibilities": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"ingress": {
"$ref": "#/definitions/ingress"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"loadBalancerSourceRanges": {
"description": "A list of CIDR ranges that you would like to allow for access to the Service",
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"description": "Global visibilities configuration",
"type": "object"
}
},
"type": "object"
},
"hostGroup": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name",
"hosts"
]
},
{
"required": [
"name",
"hostGroup"
]
}
],
"properties": {
"count": {
"description": "Number of hosts in the subset",
"type": "integer"
},
"delta": {
"description": "Cycle offset to apply to the hosts",
"type": "integer"
},
"hostGroup": {
"description": "Name of the hostgroup to create a subset of",
"type": "string"
},
"hosts": {
"description": "a list of host names",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "The name of the host group process",
"type": "string"
},
"offset": {
"description": "Offset of the first host within the group",
"type": "integer"
}
},
"type": "object"
},
"hostGroups": {
"oneOf": [
{
"items": {
"$ref": "#/definitions/hostGroup"
},
"type": "array"
},
{
"type": "null"
}
]
},
"image": {
"additionalProperties": false,
"properties": {
"imagePullSecrets": {
"type": "string"
},
"name": {
"default": "platform-core",
"type": "string"
},
"pullPolicy": {
"enum": [
"IfNotPresent",
"Always",
"Never"
],
"type": "string"
},
"root": {
"default": "hpccsystems",
"type": "string"
},
"version": {
"type": "string"
}
},
"type": "object"
},
"ingress": {
"items": {
"additionalProperties": {
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "array"
},
"issuer": {
"properties": {
"kind": {
"enum": [
"Issuer",
"ClusterIssuer"
],
"type": "string"
},
"name": {
"description": "The name of the issuer which will be referenced in certificate objects",
"type": "string"
},
"spec": {
"description": "The cert-manager spec for the issuer. Should match issuer spec(s) defined by https://cert-manager.io/docs/configuration/",
"type": "object"
}
},
"required": [
"name"
],
"type": "object"
},
"ldap": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"adminGroupName": {
"description": "The Active Directory group containing HPCC Administrators",
"type": "string"
},
"cacheTimeout": {
"description": "Time in minutes after which the cached security information should be reloaded",
"type": "integer"
},
"checkScopeScans": {
"description": "Only return iterated logical file metadata for files that user has scope permission to access",
"type": "boolean"
},
"description": {
"description": "Description of this Active Directory Server component",
"type": "string"
},
"filesBasedn": {
"description": "The base distinguished name that should be used when looking up HPCC file scopes on the Active Directory server",
"type": "string"
},
"groupsBasedn": {
"description": "The base distinguished name that should be used when looking up HPCC groups on the Active Directory server",
"type": "string"
},
"hpccAdminSecretKey": {
"description": "The optional key name to be used to look up the HPCC Administrator account Username/Password",
"type": "string"
},
"hpccAdminVaultId": {
"description": "The optional vault name to be used to look up the HPCC Administrator account Username/Password, using hpccAdminSecretKey",
"type": "string"
},
"ldapAddress": {
"description": "LDAP Server IP address(es), comma separated",
"type": "string"
},
"ldapAdminSecretKey": {
"description": "The key name to be used to look up the Active Directory Administrator account Username/Password",
"type": "string"
},
"ldapAdminVaultId": {
"description": "The optional vault name to be used to look up the Active Directory Administrator account Username/Password, using ldapAdminSecretKey",
"type": "string"
},
"ldapPort": {
"description": "The port of the nonsecure Active Directory server",
"type": "integer"
},
"ldapProtocol": {
"description": "The protocol to use - standard \"LDAP\" or secure \"LDAPS\" over SSL",
"type": "string"
},
"ldapSecurePort": {
"description": "The secure port of the secure Active Directory server",
"type": "integer"
},
"ldapTimeoutSecs": {
"description": "The maximum number of seconds to wait for most Active Directory calls",
"type": "integer"
},
"maxConnections": {
"description": "The maximum number of concurrent LDAP connections to the Active Directory server (default 10)",
"type": "integer"
},
"passwordExpirationWarningDays": {
"description": "Within this time period, ECLWatch displays a warning about pending password expiration",
"type": "integer"
},
"resourcesBasedn": {
"description": "The base distinguished name that should be used when looking up HPCC feature resources on the Active Directory server",
"type": "string"
},
"servertype": {
"description": "LDAP Server Implementation Type (\"ActiveDirectory\", \"AzureActiveDirectory\")",
"type": "string"
},
"sharedCache": {
"description": "Use a single, shared LDAP cache",
"type": "boolean"
},
"systemBasedn": {
"description": "The base distinguished name of the Active Directory Administrator",
"type": "string"
},
"usersBasedn": {
"description": "The base distinguished name that should be used when looking up HPCC users on the Active Directory server",
"type": "string"
},
"workunitsBasedn": {
"description": "The base distinguished name that should be used when looking up workunit scopes on the Active Directory server",
"type": "string"
}
},
"required": [
"ldapAddress"
],
"type": "object"
},
"logAccess": {
"description": "Remote log access information",
"properties": {
"connection": {
"$ref": "#/definitions/logAccessConnection"
},
"logMaps": {
"description": "A list of log maps",
"items": {
"$ref": "#/definitions/logMap"
},
"type": "array"
},
"name": {
"type": "string"
},
"type": {
"description": "Name of HPCC LogAccess plugin type such as 'elasticstack'",
"type": "string"
}
},
"type": "object"
},
"logAccessConnection": {
"description": "Connection information for target remote log access",
"properties": {
"host": {
"type": "string"
},
"port": {
"type": "integer"
},
"protocol": {
"type": "string"
}
},
"type": "object"
},
"logMap": {
"description": "Provides log-store mapping to searchable HPCC log columns",
"properties": {
"searchColumn": {
"description": "Name of column mapped to HPCC log entry column",
"type": "string"
},
"storeName": {
"description": "Name of container housing mapped HPCC log column",
"type": "string"
},
"timeStampColumn": {
"description": "Name of timestamp column related to mapped field (only requried for 'global' mapping)",
"type": "string"
},
"type": {
"description": "The searchable HPCC log column to be mapped - 'global' applies to all known fields",
"enum": [
"global",
"workunits",
"components",
"audience",
"class"
],
"type": "string"
}
},
"type": "object"
},
"logging": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"audiences": {
"description": "List of target audiences to include in logging output. Comprised of 3 letter codes delimited by + or -",
"type": "string"
},
"classes": {
"description": "List of target logging classes to include in output. Comprised of 3 letter codes delimited by + or -",
"type": "string"
},
"detail": {
"description": "Log output verbosity",
"type": "integer"
}
},
"type": "object"
},
"maxStartupTime": {
"description": "The time to wait before startup probing fails (in seconds). Default 300",
"type": "integer"
},
"memory": {
"additionalProperties": false,
"properties": {
"maxMemPercentage": {
"description": "The default maximum percentage of resource memory to dedicate to HPCC",
"type": "number"
},
"query": {
"description": "The amount of overall resourced memory to dedicate to the query",
"type": "string"
},
"thirdParty": {
"description": "The amount of overall resource memory to reserve for 3rd party use",
"type": "string"
}
},
"type": "object"
},
"minStartupTime": {
"description": "The time to wait before initiating startup probing (in seconds). Default 0",
"type": "integer"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"placement": {
"properties": {
"affinity": {
"type": "object"
},
"nodeSelector": {
"$ref": "#/definitions/nodeSelector"
},
"schedulerName": {
"type": "string"
},
"tolerations": {
"$ref": "#/definitions/tolerations"
},
"topologySpreadConstraints": {
"items": {
"$ref": "#/definitions/topologySpreadConstraint"
},
"type": "array"
}
},
"type": "object"
},
"remoteClients": {
"items": {
"properties": {
"name": {
"description": "Remote client name",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"remoteStorage": {
"description": "remote storage definitions",
"items": {
"$ref": "#/definitions/remoteStorageEntry"
},
"type": "array"
},
"remoteStorageEntry": {
"additionalProperties": false,
"description": "information about an individual remote storage definition",
"oneOf": [
{
"required": [
"name",
"service",
"planes"
]
},
{
"required": [
"name",
"service",
"useDafilesrv"
]
}
],
"properties": {
"name": {
"description": "the name of the remote storage definition",
"type": "string"
},
"planes": {
"description": "mapping of remote planes to local planes",
"items": {
"properties": {
"local": {
"description": "The name of the local plane to map to",
"type": "string"
},
"remote": {
"description": "The name of the remote plane to map from",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"secret": {
"description": "the name of the secret containing the certificates to connect to the service",
"type": "string"
},
"service": {
"description": "the remote DFS service",
"type": "string"
},
"useDafilesrv": {
"const": true
}
},
"type": "object"
},
"resources": {
"type": "object"
},
"roxie": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"agentQueryReleaseDelaySeconds": {
"default": 60,
"description": "Delay before unregistering slave queries to allow in-flight to complete. Files are locked until query is unregistered.",
"minimum": 0,
"type": "integer"
},
"agentThreads": {
"default": 30,
"description": "Number of threads processing agent requests",
"minimum": 0,
"type": "integer"
},
"allFilesDynamic": {
"default": false,
"description": "If enabled, files will be resolved per-query and not locked between queries",
"type": "boolean"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"backgroundCopyClass": {
"default": "none",
"description": "Specify an IONICE class for the background copy thread.",
"enum": [
"none",
"best-effort",
"idle"
],
"type": "string"
},
"backgroundCopyPrio": {
"default": 0,
"description": "Specify an IONICE value for the background copy thread, if backgroundCopyClass set to best-effort.",
"type": "integer"
},
"blindLogging": {
"default": false,
"description": "Suppress all logging of any data or query text",
"type": "boolean"
},
"blobCacheMem": {
"default": 0,
"description": "Size (in Mb) of blob index page cache",
"minimum": 0,
"type": "integer"
},
"callbackRetries": {
"default": 3,
"description": "Number of retries before callbacks from agents to server are aborted",
"minimum": 1,
"type": "integer"
},
"callbackTimeout": {
"default": 5000,
"description": "Timeout (in ms) before callbacks from agents to server are resent",
"minimum": 0,
"type": "integer"
},
"certificate": {
"description": "Name of the secret which contains the TLS certificate. Custom configuration instead of using, or overriding cert-manager certificate.",
"type": "string"
},
"channelResources": {
"$ref": "#/definitions/resources"
},
"checkCompleted": {
"default": true,
"description": "Check pending replies when agent gets a retry request",
"type": "boolean"
},
"checkFileDate": {
"default": true,
"description": "Compare file dates of physical files with the information in DFS.",
"type": "boolean"
},
"collectFactoryStatistics": {
"default": true,
"description": "Accumulate summary statistics for all queries",
"type": "boolean"
},
"copyResources": {
"default": true,
"description": "Copies any missing data files/keys from the position they were in when query was deployed.",
"type": "boolean"
},
"dafilesrvLookupTimeout": {
"default": 10000,
"description": "Maximum time (in milliseconds) dafilesrv will wait before timing out the first time through the list",
"minimum": 0,
"type": "integer"
},
"dataPlane": {
"description": "The default storage plane to write data files to",
"type": "string"
},
"defaultConcatPreload": {
"default": 0,
"description": "Default concat preload",
"minimum": 0,
"type": "integer"
},
"defaultFetchPreload": {
"default": 0,
"description": "Default fetch preload",
"minimum": 0,
"type": "integer"
},
"defaultFullKeyedJoinPreload": {
"default": 0,
"description": "Default full keyed join preload",
"minimum": 0,
"type": "integer"
},
"defaultHighPriorityTimeLimit": {
"default": 0,
"description": "Maximum run time (in ms) for any single active high-priority query (if not overridden)",
"minimum": 0,
"type": "integer"
},
"defaultHighPriorityTimeWarning": {
"default": 5000,
"description": "Time (in ms) before generating SNMP warning for a high-priority query (if not overridden)",
"minimum": 0,
"type": "integer"
},
"defaultKeyedJoinPreload": {
"default": 0,
"description": "Default keyed join preload",
"minimum": 0,
"type": "integer"
},
"defaultLowPriorityTimeLimit": {
"default": 0,
"description": "Maximum run time (in ms) for any single active low-priority query (if not overridden)",
"minimum": 0,
"type": "integer"
},
"defaultLowPriorityTimeWarning": {
"default": 0,
"description": "Time (in ms) before generating SNMP warning for a low-priority query (if not overridden)",
"minimum": 0,
"type": "integer"
},
"defaultMemoryLimit": {
"default": 0,
"description": "Maximum amount of memory available for row data in any single active query (if not overridden)",
"minimum": 0,
"type": "integer"
},
"defaultParallelJoinPreload": {
"default": 0,
"description": "Default parallel join preload",
"minimum": 0,
"type": "integer"
},
"defaultPrefetchProjectPreload": {
"default": 10,
"description": "Default prefetch value for PROJECT,PREFETCH activity",
"minimum": 0,
"type": "integer"
},
"defaultSLAPriorityTimeLimit": {
"default": 0,
"description": "Maximum run time (in ms) for any single active SLA-high-priority query (if not overridden)",
"minimum": 0,
"type": "integer"
},
"defaultSLAPriorityTimeWarning": {
"default": 5000,
"description": "Time (in ms) before generating SNMP warning for a SLA-high-priority query (if not overridden)",
"minimum": 0,
"type": "integer"
},
"defaultStripLeadingWhitespace": {
"default": true,
"description": "Default value for stripping leading whitespace in input XML values",
"type": "boolean"
},
"directAccessPlanes": {
"description": "A list of storage planes suitable for roxie to read from directly and not have roxie copy the data to roxie's default plane",
"items": {
"type": "string"
},
"type": "array"
},
"doIbytiDelay": {
"default": true,
"description": "Enables the IBYTI delay logic in the agents.",
"type": "boolean"
},
"enableHeartBeat": {
"default": true,
"description": "Enable HeartBeat messages to roxiepipe clients",
"type": "boolean"
},
"encryptionInTransit": {
"default": false,
"description": "Encrypt traffic between Roxie nodes.",
"type": "boolean"
},
"env": {
"$ref": "#/definitions/env"
},
"fastLaneQueue": {
"default": true,
"description": "Enable special fast-lane queue for simple queries.",
"type": "boolean"
},
"fieldTranslationEnabled": {
"default": "payload",
"description": "Enables translation (where possible) of mismatched file layouts on-the-fly. Specify 'payload' to attempt to translate payload fields only",
"enum": [
"false",
"true",
"payload"
]
},
"fileTimeFuzzySeconds": {
"default": 0,
"description": "Ignore mismatched file dates of up to this amount",
"type": "integer"
},
"flushJHtreeCacheOnOOM": {
"default": true,
"description": "Should the index node memory allocation flush the cache and retry if memory allocation fails",
"type": "boolean"
},
"heapRetainMemory": {
"default": false,
"description": "Retain and do not return unused memory to the operating system.",
"type": "boolean"
},
"heapUseHugePages": {
"default": false,
"description": "Allow roxie to use memory from huge pages if they have been configured.",
"type": "boolean"
},
"heapUseTransparentHugePages": {
"default": true,
"description": "Allow roxie to use memory from transparent huge pages.",
"type": "boolean"
},
"highTimeout": {
"default": 2000,
"description": "Timeout (in ms) before high priority requests are resent to agents",
"minimum": 0,
"type": "integer"
},
"httpCallerIdHeader": {
"default": "HPCC-Caller-Id",
"description": "HTTP Header field to use for sending and receiving CallerId",
"type": "string"
},
"httpGlobalIdHeader": {
"default": "HPCC-Global-Id",
"description": "HTTP Header field to use for sending and receiving GlobalId",
"type": "string"
},
"ignoreFileDateMismatches": {
"default": false,
"description": "Ignore mismatched file dates on local files",
"type": "boolean"
},
"ignoreMissingFiles": {
"default": false,
"description": "Ignore missing files",
"type": "boolean"
},
"ignoreOrphans": {
"default": true,
"description": "Treat out-of-date local files as if they were not present.",
"type": "boolean"
},
"image": {
"$ref": "#/definitions/image"
},
"indexReadChunkSize": {
"default": 60000,
"description": "Break up results from indexRead (and other remote activities) every N bytes",
"minimum": 0,
"type": "integer"
},
"initIbytiDelay": {
"default": 50,
"description": "Initial time (in milliseconds) a secondary agent will wait for an IBYTI packet from a primary peer.",
"minimum": 0,
"type": "integer"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"lazyOpen": {
"default": false,
"description": "Delay opening files until first use.",
"type": "boolean"
},
"leafCacheMem": {
"default": 50,
"description": "Size (in Mb) of leaf index page cache",
"minimum": 0,
"type": "integer"
},
"linuxYield": {
"default": false,
"description": "Yield to scheduler in some tight loops. May help latency on uniprocessor machines",
"type": "boolean"
},
"localFilesExpire": {
"default": -1,
"description": "Period (in ms) of inactivity before a local datafile handle is closed",
"type": "integer"
},
"lockSuperFiles": {
"default": false,
"description": "If enabled, superfiles will be locked while queries that use them are loaded",
"type": "boolean"
},
"logFullQueries": {
"default": false,
"description": "Log full text (unless blindLogging) and resource usage of all queries received ",
"type": "boolean"
},
"logging": {
"$ref": "#/definitions/logging"
},
"lowTimeout": {
"default": 10000,
"description": "Timeout (in ms) before low priority requests are resent to agents",
"minimum": 0,
"type": "integer"
},
"maxBlockSize": {
"default": 10000000,
"description": "Max size of block read from client socket",
"minimum": 0,
"type": "integer"
},
"maxHttpConnectionRequests": {
"default": 0,
"description": "Max number of query requests per persistent http connection",
"minimum": 0,
"type": "integer"
},
"maxHttpKeepAliveWait": {
"default": 5000,
"description": "Max number of miliseconds to wait for additional requests on a persistent http connection",
"minimum": 0,
"type": "integer"
},
"maxLocalFilesOpen": {
"default": 4000,
"description": "Maximum number of local files to keep open",
"minimum": 0,
"type": "integer"
},
"maxLockAttempts": {
"default": 5,
"description": "Number of retries to get lock for global queries",
"minimum": 0,
"type": "integer"
},
"maxRemoteFilesOpen": {
"default": 1000,
"description": "Maximum number of remote files to keep open",
"minimum": 0,
"type": "integer"
},
"maxStartupTime": {
"$ref": "#/definitions/maxStartupTime"
},
"memTraceLevel": {
"default": 1,
"description": "Level of detail in reporting mem mgr information(set to 0 for none, 1 for normal, >1 or more for extended)",
"minimum": 0,
"type": "integer"
},
"memTraceSizeLimit": {
"default": 10,
"description": "Generate stacktrace whenever a request is made for a row larger than this threshold (0 to disable)",
"minimum": 0,
"type": "integer"
},
"memoryStatsInterval": {
"default": 60,
"description": "Interval (in seconds) between reports on Roxie heap usage",
"minimum": 0,
"type": "integer"
},
"minLocalFilesOpen": {
"default": 2000,
"description": "Minimum number of local files to keep open",
"minimum": 0,
"type": "integer"
},
"minRemoteFilesOpen": {
"default": 500,
"description": "Minimum number of remote files to keep open",
"minimum": 0,
"type": "integer"
},
"minStartupTime": {
"$ref": "#/definitions/minStartupTime"
},
"miscDebugTraceLevel": {
"default": 0,
"description": "Level of miscellaneous debug tracing unrelated to all other tracing(set to 0 for none, 1 for normal, >1 or more for extended)",
"minimum": 0,
"type": "integer"
},
"mtuPayload": {
"default": 1400,
"description": "Set higher than 1400 for networks with a larger MTU.",
"maximum": 9000,
"minimum": 1400,
"type": "integer"
},
"mysqlCacheCheckPeriod": {
"default": 10000,
"description": "Time to wait (ms) between checking if any cached MySQL connections can be closed",
"minimum": 0,
"type": "integer"
},
"mysqlCacheTimeoutPeriod": {
"default": 60000,
"description": "Time to wait (ms) before closing a cached MySQL connection",
"minimum": 0,
"type": "integer"
},
"mysqlConnectionCacheSize": {
"default": 10000,
"description": "Number of MySQL connections to hold in cache",
"minimum": 0,
"type": "integer"
},
"name": {
"description": "The name of the roxie process",
"type": "string"
},
"nodeCacheMem": {
"default": 100,
"description": "Size (in Mb) of non-leaf index page cache",
"minimum": 0,
"type": "integer"
},
"parallelAggregate": {
"default": 0,
"description": "Number of parallel threads to use for in-memory aggregate processing. Set to 0 to use one per CPU, 1 to disable parallel processing of in-memory aggregates",
"minimum": 0,
"type": "integer"
},
"parallelQueryLoadThreads": {
"default": 0,
"description": "Use up to n multiple threads for initial query loading",
"minimum": 0,
"type": "integer"
},
"perChannelFlowLimit": {
"default": 10,
"description": "Number of pending queries permitted per channel (per active activity) before blocking",
"minimum": 1,
"type": "integer"
},
"pingInterval": {
"default": 60,
"description": "Interval (in seconds) between Roxie server ping tests",
"minimum": 0,
"type": "integer"
},
"preabortIndexReadsThreshold": {
"default": 100,
"description": "Use seek to precheck keyed limits (i.e. assume ,COUNT) on index reads if limit greater than this value",
"minimum": 0,
"type": "integer"
},
"preabortKeyedJoinsThreshold": {
"default": 100,
"description": "Use seek to precheck limits on keyed joins if limit greater than this value",
"minimum": 0,
"type": "integer"
},
"prefix": {
"description": "The (optional) file prefix to add to relative filenames",
"type": "string"
},
"preload": {
"description": "Preloaded plugins",
"items": {
"type": "string"
},
"type": "array"
},
"preloadOnceData": {
"default": true,
"description": "Evaluate : ONCE sections of queries at query load time",
"type": "boolean"
},
"prestartAgentThreads": {
"default": false,
"description": "Prestart agent worker threads at startup",
"type": "boolean"
},
"reloadRetriesSuspended": {
"default": true,
"description": "Retry loading of suspended queries whenever QuerySet reloads",
"type": "boolean"
},
"remoteFilesExpire": {
"default": 3600000,
"description": "Period (in ms) of inactivity before a remote datafile handle is closed",
"minimum": 0,
"type": "integer"
},
"resources": {
"$ref": "#/definitions/resources"
},
"serverResources": {
"$ref": "#/definitions/resources"
},
"serverThreads": {
"default": 30,
"description": "Default number of threads processing Roxie server requests (if not specified on service)",
"minimum": 0,
"type": "integer"
},
"services": {
"description": "Roxie query services",
"items": {
"$ref": "#/definitions/roxieservice"
},
"type": "array"
},
"simpleLocalKeyedJoins": {
"default": true,
"description": "Enable single-threaded local keyed joins",
"type": "boolean"
},
"slaTimeout": {
"default": 2000,
"description": "Timeout (in ms) before SLA high priority requests are resent to agents",
"minimum": 0,
"type": "integer"
},
"soapTraceLevel": {
"default": 1,
"description": "Level of detail in reporting SOAPCALL information(set to 0 for none, 1 for normal, >1 or more for extended)",
"minimum": 0,
"type": "integer"
},
"socketCheckInterval": {
"default": 5000,
"description": "Interval (in milliseconds) between checks that client socket is still open",
"minimum": 0,
"type": "integer"
},
"spillPlane": {
"description": "The storage plane to write spill files to",
"type": "string"
},
"statsExpiryTime": {
"default": 3600,
"description": "Time (in seconds) that detailed reporting stats are kept",
"minimum": 0,
"type": "integer"
},
"topoServer": {
"$ref": "#/definitions/toposerver"
},
"totalMemoryLimit": {
"default": "1G",
"description": "Maximum amount of memory available for row data in all active queries",
"type": "string"
},
"traceEnabled": {
"default": false,
"description": "TRACE activity output enabled by default (can be overridden in workunit or query)",
"type": "boolean"
},
"traceLevel": {
"default": 1,
"description": "Level of detail in reporting (set to 0 for none, 1 for normal, > 1 or more for extended)",
"minimum": 0,
"type": "integer"
},
"traceLimit": {
"default": 10,
"description": "Number of rows output by TRACE activity",
"minimum": 0,
"type": "integer"
},
"traceTranslations": {
"default": true,
"description": "Trace record layout translations to log file",
"type": "boolean"
},
"trapTooManyActiveQueries": {
"default": true,
"description": "should an SNMP trap get sent when too many active query error occurs",
"type": "boolean"
},
"udpAdjustThreadPriorities": {
"default": false,
"description": "Should UDP socket reading threads operate at elevated priority",
"type": "boolean"
},
"udpAgentBufferSize": {
"default": 262142,
"description": "Controls the read socket buffer size of the UDP agent read sockets",
"minimum": 0,
"type": "integer"
},
"udpFlowSocketsSize": {
"default": 131072,
"description": "Controls the read socket buffer size of the UDP layer flow control sockets",
"minimum": 0,
"type": "integer"
},
"udpLocalWriteSocketSize": {
"default": 1024000,
"description": "Controls the write socket buffer size of the local UDP sockets (Agent to Server on same node)",
"minimum": 0,
"type": "integer"
},
"udpOutQsPriority": {
"default": 0,
"description": "Turns on/off Priority weight-based for output queues (0 round-robin no priority - old logic, 1 round-robin new logic, 2 and higher is factor of priority)",
"minimum": 0,
"type": "integer"
},
"udpQueueSize": {
"default": 100,
"description": "UDP transport layer receive queue size",
"minimum": 0,
"type": "integer"
},
"udpResendLostPackets": {
"default": true,
"description": "UDP transport layer resend lost packets",
"type": "boolean"
},
"udpSendQueueSize": {
"default": 50,
"description": "UDP transport layer send queue size",
"minimum": 0,
"type": "integer"
},
"udpStatsReportInterval": {
"default": 60000,
"description": "UDP transport layer stats reporting interval",
"minimum": 0,
"type": "integer"
},
"udpTraceLevel": {
"default": 1,
"description": "Level of detail in reporting udp information(set to 0 for none, 1 for normal, >1 or more for extended)",
"minimum": 0,
"type": "integer"
},
"useMemoryMappedIndexes": {
"default": false,
"description": "Using memory-mapped files when merging multiple result streams from row-compressed indexes.",
"type": "boolean"
},
"useRemoteResources": {
"default": false,
"description": "Reads any missing data files/keys from the position they were in when deployed.",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"roxieservice": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"ingress": {
"$ref": "#/definitions/ingress"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"listenQueue": {
"type": "integer"
},
"name": {
"type": "string"
},
"numThreads": {
"type": "integer"
},
"port": {
"description": "The local port used by the pod (same as servicePort if not specified)",
"type": "integer"
},
"servicePort": {
"description": "The port that this service will be exposed on",
"type": "integer"
},
"tls": {
"description": "Whether the roxie service uses tls. Requires cert-manager or custom certificate.",
"type": "boolean"
},
"visibility": {
"description": "Should this service be exposed outside the cluster, locally or to the internet",
"type": "string"
}
},
"required": [
"name",
"servicePort"
],
"type": "object"
},
"sasha-coalescer": {
"oneOf": [
{
"allOf": [
{
"$ref": "#/definitions/sashacommon"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"at": {},
"disabled": {},
"env": {},
"image": {},
"interval": {},
"labels": {},
"minDeltaSize": {
"description": "Coalescing will only begin, if the delta size is above this threshold (K)",
"type": "integer"
},
"plane": {},
"resources": {},
"service": {},
"throttle": {}
}
}
],
"type": "object"
},
{
"type": "null"
}
]
},
"sasha-dfurecovery-archiver": {
"oneOf": [
{
"allOf": [
{
"$ref": "#/definitions/sashacommon"
},
{
"$ref": "#/definitions/sasha-limitcutoff"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"at": {},
"cutoff": {},
"disabled": {},
"env": {},
"image": {},
"interval": {},
"labels": {},
"limit": {},
"plane": {},
"resources": {},
"service": {},
"throttle": {}
}
}
],
"type": "object"
},
{
"type": "null"
}
]
},
"sasha-dfuwu-archiver": {
"oneOf": [
{
"allOf": [
{
"$ref": "#/definitions/sashacommon"
},
{
"$ref": "#/definitions/sasha-limitcutoff"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"at": {},
"cutoff": {},
"disabled": {},
"env": {},
"image": {},
"interval": {},
"labels": {},
"limit": {},
"plane": {},
"resources": {},
"service": {},
"throttle": {}
}
}
],
"required": [
"plane"
],
"type": "object"
},
{
"type": "null"
}
]
},
"sasha-file-expiry": {
"oneOf": [
{
"additionalProperties": false,
"allOf": [
{
"$ref": "#/definitions/sashacommon"
}
],
"properties": {
"annotations": {},
"at": {},
"disabled": {},
"expiryDefault": {
"default": "14",
"description": "Default number of days to delete unused standard files that are flagged with EXPIRY",
"type": "integer"
},
"image": {},
"interval": {},
"labels": {},
"persistExpiryDefault": {
"default": "7",
"description": "Default number of days to delete unused persist files",
"type": "integer"
},
"plane": {},
"resources": {},
"service": {},
"throttle": {},
"user": {
"description": "A username authorized to access and remove expired files",
"type": "string"
}
},
"type": "object"
},
{
"type": "null"
}
]
},
"sasha-limitcutoff": {
"properties": {
"cutoff": {
"default": "4",
"description": "minimum age (days)",
"type": "integer"
},
"limit": {
"default": "20",
"description": "threshold before removal starts (0 disables)",
"type": "integer"
}
},
"type": "object"
},
"sasha-wu-archiver": {
"oneOf": [
{
"allOf": [
{
"$ref": "#/definitions/sashacommon"
},
{
"$ref": "#/definitions/sasha-limitcutoff"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"at": {},
"backup": {
"default": "0",
"description": "minimum workunit age to backup (days, 0 disables)",
"type": "integer"
},
"cutoff": {},
"disabled": {},
"duration": {
"default": "0",
"description": "Maximum duration to run WorkUnit archiving session (hours, 0 unlimited)",
"type": "integer"
},
"env": {},
"image": {},
"interval": {},
"keepResultFiles": {
"default": "false",
"description": "option to keep result files owned by workunits after workunit is archived",
"type": "boolean"
},
"labels": {},
"limit": {},
"plane": {},
"resources": {},
"retryinterval": {
"default": "7",
"description": "minimal time before retrying archive of failed WorkUnits (days)",
"type": "integer"
},
"service": {},
"throttle": {}
}
}
],
"required": [
"plane"
],
"type": "object"
},
{
"type": "null"
}
]
},
"sashacommon": {
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"at": {
"default": "* * * * *",
"type": "string"
},
"disabled": {
"type": "boolean"
},
"env": {
"$ref": "#/definitions/env"
},
"image": {
"$ref": "#/definitions/image"
},
"interval": {
"default": 1,
"type": "integer"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"plane": {
"description": "which storage plane to store the sasha data on",
"type": "string"
},
"resources": {
"$ref": "#/definitions/resources"
},
"service": {
"description": "Service properties",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"port": {
"default": 8880,
"description": "The local port used by the pod",
"type": "integer"
},
"servicePort": {
"description": "The port that this service will be exposed on",
"type": "integer"
}
},
"required": [
"servicePort"
],
"type": "object"
},
"throttle": {
"description": "throttle ratio percentage (0-99, 0 no throttling, 50 is half speed)",
"type": "integer"
}
},
"type": "object"
},
"sashaservice": {
"oneOf": [
{
"additionalProperties": false,
"description": "sasha services",
"properties": {
"coalescer": {
"$ref": "#/definitions/sasha-coalescer"
},
"dfurecovery-archiver": {
"$ref": "#/definitions/sasha-dfurecovery-archiver"
},
"dfuwu-archiver": {
"$ref": "#/definitions/sasha-dfuwu-archiver"
},
"disabled": {
"type": "boolean"
},
"file-expiry": {
"$ref": "#/definitions/sasha-file-expiry"
},
"wu-archiver": {
"$ref": "#/definitions/sasha-wu-archiver"
}
},
"type": "object"
},
{
"type": "null"
}
]
},
"secrets": {
"oneOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
]
},
"security": {
"properties": {
"eclSecurity": {
"$ref": "#/definitions/eclSecurity"
},
"mtls": {
"default": true,
"description": "enable global mtls between clients (except roxie which has own setting). NB: requires certificates.enabled=true",
"type": "boolean"
}
},
"type": "object"
},
"service": {
"description": "Service properties",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"application": {
"description": "Application name",
"type": "string"
},
"ingress": {
"$ref": "#/definitions/ingress"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"loadBalancerSourceRanges": {
"description": "A list of CIDR ranges that you would like to allow for access to the Service",
"items": {
"type": "string"
},
"type": "array"
},
"port": {
"default": 8880,
"description": "The local port used by the pod",
"type": "integer"
},
"servicePort": {
"description": "The port that this service will be exposed on",
"type": "integer"
},
"visibility": {
"description": "Should this service be exposed outside the cluster, locally or to the internet",
"type": "string"
}
},
"required": [
"servicePort",
"visibility"
],
"type": "object"
},
"sink": {
"description": "Definition of a metric sink",
"properties": {
"name": {
"description": "Name for the sink, must be unique for the component",
"type": "string"
},
"settings": {
"description": "Settings specific to the sink",
"type": "object"
},
"type": {
"description": "The defined metric sink type",
"type": "string"
}
},
"required": [
"type",
"name"
],
"type": "object"
},
"sinks": {
"items": {
"$ref": "#/definitions/sink"
},
"type": "array"
},
"storagePlane": {
"additionalProperties": false,
"description": "information about an individual storage plane",
"properties": {
"category": {
"description": "the category this plane is usd for, e.g. lz, data",
"enum": [
"data",
"lz",
"dali",
"sasha",
"dll",
"spill",
"temp",
"git",
"remote",
"debug"
],
"type": "string"
},
"cost": {
"description": "Costs associated with the storage and use of the plane",
"properties": {
"storageAtRest": {
"description": "Storage cost (GiB/month)",
"type": "number"
}
},
"type": "object"
},
"defaultSprayParts": {
"description": "Number of parts sprayed by default",
"type": "integer"
},
"disabled": {
"description": "disable this plane definition",
"type": "boolean"
},
"forcePermissions": {
"type": "boolean"
},
"hostGroup": {
"description": "optional name of the host group (for bare metal storage)",
"type": "string"
},
"hosts": {
"description": "a list of host names",
"items": {
"type": "string"
},
"type": "array"
},
"includeDeviceInPath": {
"description": "is a directory based on the part number appended to the path. May not be needed",
"type": "boolean"
},
"name": {
"description": "the name of the storage plane",
"type": "string"
},
"numDevices": {
"description": "optional number of devices in the storage plane (default 1)",
"type": "integer"
},
"prefix": {
"description": "either the path for a local mount, or the url prefix",
"type": "string"
},
"pvc": {
"description": "optional name of the persistent volume claim for this plane",
"type": "string"
},
"replication": {
"description": "which planes (if any) the data is replicated onto (primarily bare metal)",
"items": {
"type": "string"
},
"type": "array"
},
"secret": {
"description": "optional name of any secret required to access this storage plane",
"type": "string"
},
"storageClass": {
"type": "string"
},
"storageMode": {
"type": "string"
},
"storageSize": {
"type": "string"
},
"subDirPerFilePart": {
"default": true,
"description": "Place each logical file part in its own subdirectory",
"type": "boolean"
},
"subPath": {
"description": "optional subdirectory within the mount directory",
"type": "string"
},
"umask": {
"description": "file creation mask (used by despray)",
"type": "string"
}
},
"required": [
"name",
"prefix",
"category"
],
"type": "object"
},
"storagePlanes": {
"description": "storage plane definitions",
"items": {
"$ref": "#/definitions/storagePlane"
},
"type": "array"
},
"stubInstanceResources": {
"description": "resource definitions per instance for stub components",
"properties": {
"additionalProperties": false,
"cpu": {
"default": "50m",
"description": "default per stub instance milli cpu requirements",
"type": "string"
},
"memory": {
"default": "200Mi",
"description": "default per stub instance memory requirements",
"type": "string"
}
},
"type": "object"
},
"thor": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"cost": {
"$ref": "#/definitions/componentCost"
},
"dataPlane": {
"description": "The default storage plane to write data files to",
"type": "string"
},
"eclAgentMemory": {
"$ref": "#/definitions/memory"
},
"eclAgentReplicas": {
"description": "Number of eclagent replicas",
"minimum": 1,
"type": "integer"
},
"eclAgentResources": {
"$ref": "#/definitions/resources"
},
"eclAgentType": {
"description": "eclagent engine type",
"enum": [
"hthor",
"roxie"
]
},
"eclAgentUseChildProcesses": {
"description": "Use processes instead of pods per job (eclagent)",
"type": "boolean"
},
"env": {
"$ref": "#/definitions/env"
},
"expert": {
"description": "Custom internal options usually reserved for internal testing",
"type": "object"
},
"image": {
"$ref": "#/definitions/image"
},
"keepJobs": {
"description": "For debugging purposes. Choose whether to keep jobs after execution",
"enum": [
"none",
"podfailures",
"all"
]
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"lingerPeriod": {
"description": "[Optional] Seconds to keep Thor instance running, waiting for more graphs to execute",
"minimum": 1,
"type": "integer"
},
"logging": {
"$ref": "#/definitions/logging"
},
"managerMemory": {
"$ref": "#/definitions/memory"
},
"managerResources": {
"$ref": "#/definitions/resources"
},
"maxGraphs": {
"description": "The maximum number of Thor graphs that be run concurrently",
"minimum": 1,
"type": "integer"
},
"maxJobs": {
"description": "The maximum number of jobs that can be run concurrenly",
"minimum": 1,
"type": "integer"
},
"multiJobLinger": {
"description": "[Optional] If lingerPeriod set, allows Thor to process more graphs from any job",
"type": "boolean"
},
"name": {
"description": "The name of the thor process",
"type": "string"
},
"numWorkers": {
"description": "The number of worker pods",
"minimum": 1,
"type": "integer"
},
"numWorkersPerPod": {
"default": 1,
"description": "The number of workers to place per pod (must be a factor of numWorkers)",
"minimum": 1,
"type": "integer"
},
"prefix": {
"description": "The (optional) file prefix to add to relative filenames",
"type": "string"
},
"spillPlane": {
"description": "The storage plane to write spill files to",
"type": "string"
},
"thorAgentReplicas": {
"description": "Number of thoragent replicas",
"minimum": 1,
"type": "integer"
},
"workerMemory": {
"$ref": "#/definitions/memory"
},
"workerResources": {
"$ref": "#/definitions/resources"
}
},
"required": [
"name",
"maxJobs",
"maxGraphs"
],
"type": "object"
},
"toleration": {
"properties": {
"effect": {
"type": "string"
},
"key": {
"type": "string"
},
"operator": {
"type": "string"
},
"tolerationSeconds": {
"type": "integer"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"tolerations": {
"items": {
"$ref": "#/definitions/toleration"
},
"type": "array"
},
"topologySpreadConstraint": {
"properties": {
"labelSelector": {
"description": "labelSelector is used to find matching Pods",
"type": "object"
},
"maxSkew": {
"description": "describes the degree to which Pods may be unevenly distributed. It must be greater than zero",
"type": "integer"
},
"topologyKey": {
"description": "is the key of node labels",
"type": "string"
},
"whenUnsatisfiable": {
"description": "indicates how to deal with a Pod if it doesn't satisfy the spread constraint",
"enum": [
"DoNotSchedule",
"ScheduleAnyway"
],
"type": "string"
}
},
"type": "object"
},
"toposerver": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"env": {
"$ref": "#/definitions/env"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"logging": {
"$ref": "#/definitions/logging"
},
"port": {
"type": "integer"
},
"replicas": {
"type": "integer"
},
"traceLevel": {
"type": "integer"
}
},
"type": "object"
},
"user": {
"additionalProperties": false,
"properties": {
"gid": {
"default": 10001,
"type": "integer"
},
"uid": {
"default": 10000,
"type": "integer"
}
},
"type": "object"
},
"vault": {
"additionalProperties": false,
"description": "information about an individual vault",
"properties": {
"client-secret": {
"description": "optional name of kubernetes secret that will provide the vault client token",
"type": "string"
},
"kind": {
"enum": [
"kv-v2",
"kv-v1"
],
"type": "string"
},
"name": {
"description": "the name of the vault",
"type": "string"
},
"url": {
"description": "the url used to access the vault",
"type": "string"
}
},
"required": [
"name",
"url"
],
"type": "object"
},
"vaultCategory": {
"description": "set of vaults under a given category",
"oneOf": [
{
"items": {
"$ref": "#/definitions/vault"
},
"type": "array"
},
{
"type": "null"
}
]
}
},
"properties": {
"bundles": {
"description": "bundles",
"items": {
"$ref": "#/definitions/bundle"
},
"type": "array"
},
"certificates": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"issuers": {
"properties": {
"local": {
"$ref": "#/definitions/issuer"
},
"public": {
"$ref": "#/definitions/issuer"
}
},
"type": "object"
}
},
"type": "object"
},
"dafilesrv": {
"description": "dafilesrv process",
"items": {
"$ref": "#/definitions/dafilesrv"
},
"type": "array"
},
"dali": {
"description": "dali process",
"items": {
"$ref": "#/definitions/dali"
},
"maxItems": 1,
"minItems": 1,
"type": "array"
},
"dfuserver": {
"description": "dfuserver process",
"items": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"disabled": {
"type": "boolean"
},
"env": {
"$ref": "#/definitions/env"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"maxJobs": {
"type": "integer"
},
"name": {
"description": "The name of the dfuserver process",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"eclagent": {
"description": "eclagent process",
"items": {
"allOf": [
{
"$ref": "#/definitions/eclagent"
},
{
"dataPlane": {
"description": "The default storage plane to write data files to",
"type": "string"
},
"name": {
"description": "The name of the eclagent process",
"type": "string"
},
"prefix": {
"description": "The (optional) file prefix to add to relative filenames",
"type": "string"
},
"required": [
"name"
],
"spillPlane": {
"description": "The storage plane to write spill files to",
"type": "string"
}
}
]
},
"type": "array"
},
"eclccserver": {
"description": "eclccserver process",
"items": {
"$ref": "#/definitions/eclccserver"
},
"type": "array"
},
"eclscheduler": {
"description": "eclscheduler process",
"items": {
"$ref": "#/definitions/eclscheduler"
},
"type": "array"
},
"esp": {
"description": "esp process",
"items": {
"$ref": "#/definitions/esp"
},
"type": "array"
},
"global": {
"$ref": "#/definitions/global"
},
"placements": {
"items": {
"properties": {
"placement": {
"$ref": "#/definitions/placement"
},
"pods": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
},
"roxie": {
"description": "roxie process",
"items": {
"$ref": "#/definitions/roxie"
},
"type": "array"
},
"sasha": {
"$ref": "#/definitions/sashaservice",
"description": "sasha services",
"type": "object"
},
"secrets": {
"additionalProperties": false,
"description": "configuration for secrets accessed by the components",
"properties": {
"authn": {
"$ref": "#/definitions/secrets"
},
"codeSign": {
"$ref": "#/definitions/secrets"
},
"codeVerify": {
"$ref": "#/definitions/secrets"
},
"ecl": {
"$ref": "#/definitions/secrets"
},
"git": {
"$ref": "#/definitions/secrets"
},
"storage": {
"$ref": "#/definitions/secrets"
},
"system": {
"$ref": "#/definitions/secrets"
},
"timeout": {
"type": "integer"
}
},
"type": "object"
},
"security": {
"$ref": "#/definitions/security"
},
"storage": {
"additionalProperties": false,
"properties": {
"hostGroups": {
"$ref": "#/definitions/hostGroups"
},
"planes": {
"$ref": "#/definitions/storagePlanes"
},
"remote": {
"$ref": "#/definitions/remoteStorage"
}
},
"type": "object"
},
"thor": {
"description": "thor process",
"items": {
"$ref": "#/definitions/thor"
},
"type": "array"
},
"vaults": {
"additionalProperties": false,
"description": "configuration for vaults accessed by the components",
"properties": {
"authn": {
"$ref": "#/definitions/vaultCategory"
},
"codeSign": {
"$ref": "#/definitions/vaultCategory"
},
"codeVerify": {
"$ref": "#/definitions/vaultCategory"
},
"ecl": {
"$ref": "#/definitions/vaultCategory"
},
"ecl-user": {
"$ref": "#/definitions/vaultCategory"
},
"esp": {
"$ref": "#/definitions/vaultCategory"
},
"storage": {
"$ref": "#/definitions/vaultCategory"
},
"timeout": {
"type": "integer"
}
},
"type": "object"
}
},
"required": [
"dali"
],
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
hpcc-systems/helm-chart | 45d4593993ba769f32ac55008585484c0ec4231a | 2021-07-02T14:38:49 | helm/examples/azure/hpcc-azurefile/values.schema.json | 10 | 2024-05-28T04:25:31.595363Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"definitions": {
"plane": {
"additionalProperties": false,
"properties": {
"category": {
"description": "the category this plane is usd for, e.g. lz, data",
"type": "string"
},
"name": {
"description": "Prefix for the pvc name",
"type": "string"
},
"rwmany": {
"description": "Does the pvc require rw many access (data/dll currently)",
"type": "boolean"
},
"shareName": {
"description": "Azure storage share name",
"type": "string"
},
"size": {
"description": "Size that is required for the volume",
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"sku": {
"type": "string"
},
"subPath": {
"description": "sub path from common.hostpath on host where the pvc is created",
"type": "string"
}
},
"required": [
"name",
"subPath",
"size"
],
"type": "object"
}
},
"properties": {
"common": {
"properties": {
"commonPrefix": {
"type": "string"
},
"secretName": {
"description": "Kubernetes secret name for Azure storage account",
"type": "string"
},
"secretNamespace": {
"default": "default",
"description": "Kubernetes namespace for secret",
"type": "string"
}
},
"type": "object"
},
"planes": {
"description": "List of planes to mount locally",
"oneOf": [
{
"items": {
"$ref": "#/definitions/plane"
},
"type": "array"
},
{
"type": "null"
}
]
}
},
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
hpcc-systems/helm-chart | 7a28af475093e72c5b90c8f8fc74237793eea0eb | 2022-03-24T09:42:22 | helm/hpcc/values.schema.json | 10 | 2024-05-28T04:25:31.595363Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"definitions": {
"bundle": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"name": {
"description": "The name of the bundle process",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"dali": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"image": {
"$ref": "#/definitions/image"
},
"logging": {
"$ref": "#/definitions/logging"
},
"name": {
"description": "The name of the dali process",
"type": "string"
},
"resources": {
"$ref": "#/definitions/resources"
},
"services": {
"$ref": "#/definitions/sashaservice",
"description": "sasha services",
"type": "object"
}
},
"required": [
"name"
],
"type": "object"
},
"eclSecurity": {
"properties": {
"datafile": {
"$ref": "#/definitions/eclSecurityValues"
},
"embedded": {
"$ref": "#/definitions/eclSecurityValues"
},
"extern": {
"$ref": "#/definitions/eclSecurityValues"
},
"pipe": {
"$ref": "#/definitions/eclSecurityValues"
}
},
"type": "object"
},
"eclSecurityValues": {
"enum": [
"deny",
"allow",
"allowSigned"
],
"type": "string"
},
"eclagent": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"image": {
"$ref": "#/definitions/image"
},
"logging": {
"$ref": "#/definitions/logging"
},
"maxActive": {
"default": 100,
"description": "Maximum number of workunits that can be active simultaneously",
"minimum": 1,
"type": "integer"
},
"replicas": {
"type": "integer"
},
"resources": {
"$ref": "#/definitions/resources"
},
"storagePlane": {
"description": "The default storage plane to write data files to",
"type": "string"
},
"type": {
"description": "Use the hthor or roxie execution engine for eclagent queries",
"enum": [
"hthor",
"roxie"
],
"type": "string"
},
"useChildProcesses": {
"description": "Launch each workunit as a child process rather than in its own container",
"type": "boolean"
}
},
"type": "object"
},
"eclccserver": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"image": {
"$ref": "#/definitions/image"
},
"listen": {
"items": {
"type": "string"
},
"type": "array"
},
"logging": {
"$ref": "#/definitions/logging"
},
"name": {
"description": "The name of the eclccserver process",
"type": "string"
},
"replicas": {
"type": "integer"
},
"resources": {
"$ref": "#/definitions/resources"
},
"useChildProcesses": {
"description": "Launch each workunit compile as a child process rather than in its own container",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"eclscheduler": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"image": {
"$ref": "#/definitions/image"
},
"logging": {
"$ref": "#/definitions/logging"
},
"name": {
"description": "The name of the eclccserver process",
"type": "string"
},
"resources": {
"$ref": "#/definitions/resources"
}
},
"required": [
"name"
],
"type": "object"
},
"egress": {
"additionalProperties": false,
"properties": {
"kubeApiCidr": {
"description": "IP range for kubectl API service",
"type": "string"
},
"kubeApiPort": {
"description": "Port used for connections to kubectl API",
"type": "integer"
},
"kubeSystemLabel": {
"description": "Label that has been applied to the kube-system namespace, used to restrict DNS service calls on port 53 to pods in the kube-system namespace",
"type": "string"
},
"restricted": {
"description": "Are any egress controls applied",
"type": "boolean"
}
},
"type": "object"
},
"esp": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"image": {
"$ref": "#/definitions/image"
},
"logging": {
"$ref": "#/definitions/logging"
},
"name": {
"description": "The name of the esp process",
"type": "string"
},
"replicas": {
"type": "integer"
},
"resources": {
"$ref": "#/definitions/resources"
}
},
"required": [
"name"
],
"type": "object"
},
"global": {
"additionalProperties": false,
"properties": {
"cost": {
"description": "resource cost",
"properties": {
"perCpu": {
"description": "cost of a single cpu",
"type": "number"
}
},
"type": "object"
},
"defaultDataPath": {
"type": "string"
},
"defaultEsp": {
"type": "string"
},
"defaultMirrorPath": {
"type": "string"
},
"egress": {
"$ref": "#/definitions/egress"
},
"image": {
"$ref": "#/definitions/image"
},
"logging": {
"$ref": "#/definitions/logging"
},
"metrics": {
"description": "Global metrics configuration",
"properties": {
"sinks": {
"$ref": "#/definitions/sinks"
}
},
"type": "object"
},
"misc": {
"description": "Miscellaneous settings",
"oneOf": [
{
"properties": {
"postJobCommand": {
"description": "Execute this command when a K8s Job launched by a deployment ends, either gracefully or when terminated externally causing a preStop event",
"type": "string"
},
"postJobCommandViaSidecar": {
"description": "Causes shareProcessNamespace to be enabled, and the postJobCommand to execute via a sidecar",
"type": "boolean"
}
},
"type": "object"
},
{
"type": "null"
}
]
},
"privileged": {
"type": "boolean"
}
},
"type": "object"
},
"hostGroup": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name",
"hosts"
]
},
{
"required": [
"name",
"hostGroup"
]
}
],
"properties": {
"count": {
"description": "Number of hosts in the subset",
"type": "integer"
},
"delta": {
"description": "Cycle offset to apply to the hosts",
"type": "integer"
},
"hostGroup": {
"description": "Name of the hostgroup to create a subset of",
"type": "string"
},
"hosts": {
"description": "a list of host names",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "The name of the host group process",
"type": "string"
},
"offset": {
"description": "Offset of the first host within the group",
"type": "integer"
}
},
"type": "object"
},
"hostGroups": {
"oneOf": [
{
"items": {
"$ref": "#/definitions/hostGroup"
},
"type": "array"
},
{
"type": "null"
}
]
},
"image": {
"additionalProperties": false,
"properties": {
"name": {
"default": "platform-core",
"type": "string"
},
"pullPolicy": {
"enum": [
"IfNotPresent",
"Always",
"Never"
],
"type": "string"
},
"root": {
"default": "hpccsystems",
"type": "string"
},
"version": {
"type": "string"
}
},
"type": "object"
},
"issuer": {
"properties": {
"kind": {
"enum": [
"Issuer",
"ClusterIssuer"
],
"type": "string"
},
"name": {
"description": "The name of the issuer which will be referenced in certificate objects",
"type": "string"
},
"spec": {
"description": "The cert-manager spec for the issuer. Should match issuer spec(s) defined by https://cert-manager.io/docs/configuration/",
"type": "object"
}
},
"required": [
"name"
],
"type": "object"
},
"logging": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"audiences": {
"description": "List of target audiences to include in logging output. Comprised of 3 letter codes delimited by + or -",
"type": "string"
},
"classes": {
"description": "List of target logging classes to include in output. Comprised of 3 letter codes delimited by + or -",
"type": "string"
},
"detail": {
"description": "Log output verbosity",
"type": "integer"
}
},
"type": "object"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"placement": {
"properties": {
"affinity": {
"type": "object"
},
"nodeSelector": {
"$ref": "#/definitions/nodeSelector"
},
"schedulerName": {
"type": "string"
},
"tolerations": {
"$ref": "#/definitions/tolerations"
}
},
"type": "object"
},
"resources": {
"type": "object"
},
"roxie": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"channelResources": {
"$ref": "#/definitions/resources"
},
"image": {
"$ref": "#/definitions/image"
},
"logging": {
"$ref": "#/definitions/logging"
},
"name": {
"description": "The name of the roxie process",
"type": "string"
},
"prefix": {
"description": "The (optional) file prefix to add to relative filenames",
"type": "string"
},
"preload": {
"description": "Preloaded plugins",
"items": {
"type": "string"
},
"type": "array"
},
"serverResources": {
"$ref": "#/definitions/resources"
},
"services": {
"description": "Roxie query services",
"items": {
"$ref": "#/definitions/roxieservice"
},
"type": "array"
},
"spillPlane": {
"description": "The storage plane to write spill files to",
"type": "string"
},
"storagePlane": {
"description": "The default storage plane to write data files to",
"type": "string"
},
"topoServer": {
"$ref": "#/definitions/toposerver"
}
},
"required": [
"name"
],
"type": "object"
},
"roxieservice": {
"additionalProperties": false,
"properties": {
"external": {
"type": "boolean"
},
"listenQueue": {
"type": "integer"
},
"name": {
"type": "string"
},
"numThreads": {
"type": "integer"
},
"port": {
"type": "integer"
}
},
"required": [
"name",
"port"
],
"type": "object"
},
"sasha-coalescer": {
"oneOf": [
{
"allOf": [
{
"$ref": "#/definitions/sashacommon"
},
{
"additionalProperties": false,
"properties": {
"at": {},
"disabled": {},
"interval": {},
"minDeltaSize": {
"description": "Coalescing will only begin, if the delta size is above this threashold (K)",
"type": "integer"
},
"port": {},
"resources": {},
"servicePort": {},
"storage": {},
"throttle": {}
}
}
],
"type": "object"
},
{
"type": "null"
}
]
},
"sasha-dfurecovery-archiver": {
"oneOf": [
{
"allOf": [
{
"$ref": "#/definitions/sashacommon"
},
{
"$ref": "#/definitions/sasha-limitcutoff"
},
{
"additionalProperties": false,
"properties": {
"at": {},
"cutoff": {},
"disabled": {},
"interval": {},
"limit": {},
"port": {},
"resources": {},
"servicePort": {},
"storage": {},
"throttle": {}
}
}
],
"type": "object"
},
{
"type": "null"
}
]
},
"sasha-dfuwu-archiver": {
"oneOf": [
{
"allOf": [
{
"$ref": "#/definitions/sashacommon"
},
{
"$ref": "#/definitions/sasha-limitcutoff"
},
{
"additionalProperties": false,
"properties": {
"at": {},
"cutoff": {},
"disabled": {},
"interval": {},
"limit": {},
"port": {},
"resources": {},
"servicePort": {},
"storage": {},
"throttle": {}
}
}
],
"type": "object"
},
{
"type": "null"
}
]
},
"sasha-file-expiry": {
"oneOf": [
{
"additionalProperties": false,
"allOf": [
{
"$ref": "#/definitions/sashacommon"
}
],
"properties": {
"at": {},
"disabled": {},
"expiryDefault": {
"default": "14",
"description": "Default number of days to delete unused standard files that are flagged with EXPIRY",
"type": "integer"
},
"interval": {},
"persistExpiryDefault": {
"default": "7",
"description": "Default number of days to delete unused persist files",
"type": "integer"
},
"port": {},
"resources": {},
"servicePort": {},
"storage": {},
"throttle": {},
"user": {
"description": "A username authorized to access and remove expired files",
"type": "string"
}
},
"type": "object"
},
{
"type": "null"
}
]
},
"sasha-limitcutoff": {
"properties": {
"cutoff": {
"default": "4",
"description": "minimum age (days)",
"type": "integer"
},
"limit": {
"default": "20",
"description": "threshold before removal starts (0 disables)",
"type": "integer"
}
},
"type": "object"
},
"sasha-wu-archiver": {
"oneOf": [
{
"allOf": [
{
"$ref": "#/definitions/sashacommon"
},
{
"$ref": "#/definitions/sasha-limitcutoff"
},
{
"additionalProperties": false,
"properties": {
"at": {},
"backup": {
"default": "0",
"description": "minimum workunit age to backup (days, 0 disables)",
"type": "integer"
},
"cutoff": {},
"disabled": {},
"duration": {
"default": "0",
"description": "Maximum duration to run WorkUnit archiving session (hours, 0 unlimited)",
"type": "integer"
},
"interval": {},
"keepResultFiles": {
"default": "false",
"description": "option to keep result files owned by workunits after workunit is archived",
"type": "boolean"
},
"limit": {},
"port": {},
"resources": {},
"retryinterval": {
"default": "7",
"description": "minimal time before retrying archive of failed WorkUnits (days)",
"type": "integer"
},
"servicePort": {},
"storage": {},
"throttle": {}
}
}
],
"type": "object"
},
{
"type": "null"
}
]
},
"sashacommon": {
"properties": {
"at": {
"default": "* * * * *",
"type": "string"
},
"disabled": {
"type": "boolean"
},
"interval": {
"default": 1,
"type": "integer"
},
"port": {
"type": "integer"
},
"resources": {
"$ref": "#/definitions/resources"
},
"servicePort": {
"type": "integer"
},
"storage": {
"$ref": "#/definitions/storageType"
},
"throttle": {
"description": "throttle ratio percentage (0-99, 0 no throttling, 50 is half speed)",
"type": "integer"
}
},
"type": "object"
},
"sashaservice": {
"oneOf": [
{
"additionalProperties": false,
"description": "sasha services",
"properties": {
"coalescer": {
"$ref": "#/definitions/sasha-coalescer"
},
"dfurecovery-archiver": {
"$ref": "#/definitions/sasha-dfurecovery-archiver"
},
"dfuwu-archiver": {
"$ref": "#/definitions/sasha-dfuwu-archiver"
},
"disabled": {
"type": "boolean"
},
"file-expiry": {
"$ref": "#/definitions/sasha-file-expiry"
},
"wu-archiver": {
"$ref": "#/definitions/sasha-wu-archiver"
}
},
"type": "object"
},
{
"type": "null"
}
]
},
"secrets": {
"oneOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
]
},
"security": {
"properties": {
"eclSecurity": {
"$ref": "#/definitions/eclSecurity"
}
},
"type": "object"
},
"sink": {
"description": "Definition of a metric sink",
"properties": {
"name": {
"description": "Name for the sink, must be unique for the component",
"type": "string"
},
"settings": {
"description": "Settings specific to the sink",
"type": "object"
},
"type": {
"description": "The defined metric sink type",
"type": "string"
}
},
"required": [
"type",
"name"
],
"type": "object"
},
"sinks": {
"items": {
"$ref": "#/definitions/sink"
},
"type": "array"
},
"storagePlane": {
"additionalProperties": false,
"description": "information about an individual storage plane",
"properties": {
"cost": {
"description": "Costs associated with the storage and use of the plane",
"properties": {
"storageAtRest": {
"description": "Storage cost (GiB/month)",
"type": "number"
}
},
"type": "object"
},
"defaultSprayParts": {
"description": "Number of parts sprayed by default",
"type": "integer"
},
"hostGroup": {
"description": "optional name of the host group (for bare metal storage)",
"type": "string"
},
"hosts": {
"description": "a list of host names",
"items": {
"type": "string"
},
"type": "array"
},
"includeDeviceInPath": {
"description": "is a directory based on the part number appended to the path. May not be needed",
"type": "boolean"
},
"labels": {
"description": "a list of labels associated with this plane, e.g. lz, data. NB: if blank/unset, treated as if 'data'",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "the name of the storage plane",
"type": "string"
},
"numDevices": {
"description": "optional number of devices in the storage plane (default 1)",
"type": "integer"
},
"prefix": {
"description": "either the path for a local mount, or the url prefix",
"type": "string"
},
"pvc": {
"description": "optional name of the persistent volume claim for this plane",
"type": "string"
},
"replication": {
"description": "which planes (if any) the data is replicated onto (primarily bare metal)",
"items": {
"type": "string"
},
"type": "array"
},
"secret": {
"description": "optional name of any secret required to access this storage plane",
"type": "string"
},
"umask": {
"description": "file creation mask (used by despray)",
"type": "string"
}
},
"required": [
"name",
"prefix"
],
"type": "object"
},
"storagePlanes": {
"description": "storage plane definitions",
"oneOf": [
{
"items": {
"$ref": "#/definitions/storagePlane"
},
"type": "array"
},
{
"type": "null"
}
]
},
"storageType": {
"additionalProperties": false,
"anyOf": [
{
"required": [
"storageSize"
]
},
{
"required": [
"plane"
]
}
],
"properties": {
"existingClaim": {
"type": "string"
},
"forcePermissions": {
"type": "boolean"
},
"plane": {
"type": "string"
},
"storageClass": {
"type": "string"
},
"storageSize": {
"type": "string"
}
},
"type": "object"
},
"thor": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"eclAgentReplicas": {
"description": "Number of eclagent replicas",
"minimum": 1,
"type": "integer"
},
"eclAgentResources": {
"$ref": "#/definitions/resources"
},
"eclAgentType": {
"description": "eclagent engine type",
"enum": [
"hthor",
"roxie"
]
},
"eclAgentUseChildProcesses": {
"description": "Use processes instead of pods per job (eclagent)",
"type": "boolean"
},
"image": {
"$ref": "#/definitions/image"
},
"keepJobs": {
"description": "For debugging purposes. Choose whether to keep jobs after execution",
"enum": [
"none",
"podfailures",
"all"
]
},
"lingerPeriod": {
"description": "[Optional] Seconds to keep Thor instance running, waiting for more graphs to execute",
"minimum": 1,
"type": "integer"
},
"logging": {
"$ref": "#/definitions/logging"
},
"managerResources": {
"$ref": "#/definitions/resources"
},
"maxGraphs": {
"description": "The maximum number of Thor graphs that be run concurrently",
"minimum": 1,
"type": "integer"
},
"maxJobs": {
"description": "The maximum number of jobs that can be run concurrenly",
"minimum": 1,
"type": "integer"
},
"multiJobLinger": {
"description": "[Optional] If lingerPeriod set, allows Thor to process more graphs from any job",
"type": "boolean"
},
"name": {
"description": "The name of the thor process",
"type": "string"
},
"numWorkers": {
"description": "The number of worker pods",
"minimum": 1,
"type": "integer"
},
"prefix": {
"description": "The (optional) file prefix to add to relative filenames",
"type": "string"
},
"spillPlane": {
"description": "The storage plane to write spill files to",
"type": "string"
},
"storagePlane": {
"description": "The default storage plane to write data files to",
"type": "string"
},
"thorAgentReplicas": {
"description": "Number of thoragent replicas",
"minimum": 1,
"type": "integer"
},
"workerResources": {
"$ref": "#/definitions/resources"
}
},
"required": [
"name",
"maxJobs",
"maxGraphs"
],
"type": "object"
},
"toleration": {
"properties": {
"effect": {
"type": "string"
},
"key": {
"type": "string"
},
"operator": {
"type": "string"
},
"tolerationSeconds": {
"type": "integer"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"tolerations": {
"items": {
"$ref": "#/definitions/toleration"
},
"type": "array"
},
"toposerver": {
"properties": {
"logging": {
"$ref": "#/definitions/logging"
},
"port": {
"type": "integer"
},
"replicas": {
"type": "integer"
},
"traceLevel": {
"type": "integer"
}
},
"type": "object"
},
"vault": {
"additionalProperties": false,
"description": "information about an individual vault",
"properties": {
"client-secret": {
"description": "optional name of kubernetes secret that will provide the vault client token",
"type": "string"
},
"kind": {
"enum": [
"kv-v2",
"kv-v1"
],
"type": "string"
},
"name": {
"description": "the name of the vault",
"type": "string"
},
"url": {
"description": "the url used to access the vault",
"type": "string"
}
},
"required": [
"name",
"url"
],
"type": "object"
},
"vaultCategory": {
"description": "set of vaults under a given category",
"oneOf": [
{
"items": {
"$ref": "#/definitions/vault"
},
"type": "array"
},
{
"type": "null"
}
]
}
},
"properties": {
"bundles": {
"description": "bundles",
"items": {
"$ref": "#/definitions/bundle"
},
"type": "array"
},
"certificates": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"issuers": {
"properties": {
"local": {
"$ref": "#/definitions/issuer"
},
"public": {
"$ref": "#/definitions/issuer"
}
},
"type": "object"
}
},
"type": "object"
},
"dali": {
"description": "dali process",
"items": {
"$ref": "#/definitions/dali"
},
"type": "array"
},
"dfuserver": {
"description": "dfuserver process",
"items": {
"allOf": [
{
"disabled": {
"type": "boolean"
},
"maxJobs": {
"type": "integer"
},
"name": {
"description": "The name of the dfuserver process",
"type": "string"
},
"required": [
"name"
]
}
]
},
"type": "array"
},
"eclagent": {
"description": "eclagent process",
"items": {
"allOf": [
{
"$ref": "#/definitions/eclagent"
},
{
"name": {
"description": "The name of the eclagent process",
"type": "string"
},
"prefix": {
"description": "The (optional) file prefix to add to relative filenames",
"type": "string"
},
"required": [
"name"
],
"spillPlane": {
"description": "The storage plane to write spill files to",
"type": "string"
},
"storagePlane": {
"description": "The default storage plane to write data files to",
"type": "string"
}
}
]
},
"type": "array"
},
"eclccserver": {
"description": "eclccserver process",
"items": {
"$ref": "#/definitions/eclccserver"
},
"type": "array"
},
"eclscheduler": {
"description": "eclscheduler process",
"items": {
"$ref": "#/definitions/eclscheduler"
},
"type": "array"
},
"esp": {
"description": "esp process",
"items": {
"$ref": "#/definitions/esp"
},
"type": "array"
},
"global": {
"$ref": "#/definitions/global"
},
"placements": {
"items": {
"properties": {
"placement": {
"$ref": "#/definitions/placement"
},
"pods": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
},
"roxie": {
"description": "eclagent process",
"items": {
"$ref": "#/definitions/roxie"
},
"type": "array"
},
"sasha": {
"$ref": "#/definitions/sashaservice",
"description": "sasha services",
"type": "object"
},
"secrets": {
"additionalProperties": false,
"description": "configuration for secrets accessed by the components",
"properties": {
"codeSign": {
"$ref": "#/definitions/secrets"
},
"codeVerify": {
"$ref": "#/definitions/secrets"
},
"ecl": {
"$ref": "#/definitions/secrets"
},
"storage": {
"$ref": "#/definitions/secrets"
},
"system": {
"$ref": "#/definitions/secrets"
},
"timeout": {
"type": "integer"
}
},
"type": "object"
},
"security": {
"$ref": "#/definitions/security"
},
"storage": {
"additionalProperties": false,
"properties": {
"daliStorage": {
"$ref": "#/definitions/storageType"
},
"dataStorage": {
"$ref": "#/definitions/storageType"
},
"dllStorage": {
"$ref": "#/definitions/storageType"
},
"hostGroups": {
"$ref": "#/definitions/hostGroups"
},
"planes": {
"$ref": "#/definitions/storagePlanes"
},
"spillStorage": {
"oneOf": [
{
"$ref": "#/definitions/storageType"
},
{
"type": "null"
}
]
}
},
"type": "object"
},
"thor": {
"description": "thor process",
"items": {
"$ref": "#/definitions/thor"
},
"type": "array"
},
"vaults": {
"additionalProperties": false,
"description": "configuration for vaults accessed by the components",
"properties": {
"codeSign": {
"$ref": "#/definitions/vaultCategory"
},
"codeVerify": {
"$ref": "#/definitions/vaultCategory"
},
"ecl": {
"$ref": "#/definitions/vaultCategory"
},
"ecl-user": {
"$ref": "#/definitions/vaultCategory"
},
"esp": {
"$ref": "#/definitions/vaultCategory"
},
"storage": {
"$ref": "#/definitions/vaultCategory"
},
"timeout": {
"type": "integer"
}
},
"type": "object"
}
},
"required": [
"dali"
],
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
hpcc-systems/helm-chart | 344560abc21612f7150aa93d5b3d6c289511f77e | 2021-10-13T15:20:58 | helm/hpcc/values.schema.json | 10 | 2024-05-28T04:25:31.595363Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"definitions": {
"auth": {
"description": "Authentication method",
"enum": [
"none",
"ldap"
],
"type": "string"
},
"bundle": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"name": {
"description": "The name of the bundle process",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"compileOption": {
"additionalProperties": false,
"properties": {
"cluster": {
"description": "Cluster to apply option to",
"type": "string"
},
"name": {
"description": "Compiler option name",
"type": "string"
},
"value": {
"description": "Compiler option value",
"type": [
"number",
"string",
"boolean"
]
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"dafilesrv": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"image": {
"$ref": "#/definitions/image"
},
"logging": {
"$ref": "#/definitions/logging"
},
"name": {
"description": "The name of the dafilesrv process",
"type": "string"
},
"parallelRequestLimit": {
"default": "20",
"type": "integer"
},
"replicas": {
"type": "integer"
},
"resources": {
"$ref": "#/definitions/resources"
},
"service": {
"$ref": "#/definitions/service"
}
},
"required": [
"name",
"service"
],
"type": "object"
},
"dali": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"auth": {
"$ref": "#/definitions/auth"
},
"env": {
"$ref": "#/definitions/env"
},
"image": {
"$ref": "#/definitions/image"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"ldap": {
"$ref": "#/definitions/ldap"
},
"logging": {
"$ref": "#/definitions/logging"
},
"maxStartupTime": {
"$ref": "#/definitions/maxStartupTime"
},
"minStartupTime": {
"$ref": "#/definitions/minStartupTime"
},
"name": {
"description": "The name of the dali process",
"type": "string"
},
"resources": {
"$ref": "#/definitions/resources"
},
"services": {
"$ref": "#/definitions/sashaservice",
"description": "sasha services",
"type": "object"
}
},
"required": [
"name",
"auth"
],
"type": "object"
},
"eclSecurity": {
"properties": {
"datafile": {
"$ref": "#/definitions/eclSecurityValues"
},
"embedded": {
"$ref": "#/definitions/eclSecurityValues"
},
"extern": {
"$ref": "#/definitions/eclSecurityValues"
},
"pipe": {
"$ref": "#/definitions/eclSecurityValues"
}
},
"type": "object"
},
"eclSecurityValues": {
"enum": [
"deny",
"allow",
"allowSigned"
],
"type": "string"
},
"eclagent": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"dataPlane": {
"description": "The default storage plane to write data files to",
"type": "string"
},
"env": {
"$ref": "#/definitions/env"
},
"image": {
"$ref": "#/definitions/image"
},
"jobMemory": {
"$ref": "#/definitions/memory"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"logging": {
"$ref": "#/definitions/logging"
},
"maxActive": {
"default": 100,
"description": "Maximum number of workunits that can be active simultaneously",
"minimum": 1,
"type": "integer"
},
"replicas": {
"type": "integer"
},
"resources": {
"$ref": "#/definitions/resources"
},
"type": {
"description": "Use the hthor or roxie execution engine for eclagent queries",
"enum": [
"hthor",
"roxie"
],
"type": "string"
},
"useChildProcesses": {
"description": "Launch each workunit as a child process rather than in its own container",
"type": "boolean"
}
},
"required": [
"maxActive"
],
"type": "object"
},
"eclccserver": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"env": {
"$ref": "#/definitions/env"
},
"image": {
"$ref": "#/definitions/image"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"listen": {
"items": {
"type": "string"
},
"type": "array"
},
"logging": {
"$ref": "#/definitions/logging"
},
"maxActive": {
"default": 4,
"description": "Maximum number of compile jobs that can be active simultaneously",
"minimum": 1,
"type": "integer"
},
"name": {
"description": "The name of the eclccserver process",
"type": "string"
},
"options": {
"items": {
"$ref": "#/definitions/compileOption"
},
"type": "array"
},
"replicas": {
"type": "integer"
},
"resources": {
"$ref": "#/definitions/resources"
},
"useChildProcesses": {
"description": "Launch each workunit compile as a child process rather than in its own container",
"type": "boolean"
}
},
"required": [
"name",
"maxActive"
],
"type": "object"
},
"eclscheduler": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"env": {
"$ref": "#/definitions/env"
},
"image": {
"$ref": "#/definitions/image"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"logging": {
"$ref": "#/definitions/logging"
},
"name": {
"description": "The name of the eclccserver process",
"type": "string"
},
"resources": {
"$ref": "#/definitions/resources"
}
},
"required": [
"name"
],
"type": "object"
},
"egress": {
"additionalProperties": false,
"properties": {
"kubeApiCidr": {
"description": "IP range for kubectl API service",
"type": "string"
},
"kubeApiPort": {
"description": "Port used for connections to kubectl API",
"type": "integer"
},
"kubeSystemLabel": {
"description": "Label that has been applied to the kube-system namespace, used to restrict DNS service calls on port 53 to pods in the kube-system namespace",
"type": "string"
},
"restricted": {
"description": "Are any egress controls applied",
"type": "boolean"
}
},
"type": "object"
},
"env": {
"items": {
"properties": {
"name": {
"description": "Environment variable name",
"type": "string"
},
"value": {
"description": "Environment variable value",
"type": [
"number",
"string",
"boolean"
]
}
},
"type": "object"
},
"type": "array"
},
"esp": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"auth": {
"$ref": "#/definitions/auth"
},
"env": {
"$ref": "#/definitions/env"
},
"image": {
"$ref": "#/definitions/image"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"ldap": {
"$ref": "#/definitions/ldap"
},
"logging": {
"$ref": "#/definitions/logging"
},
"name": {
"description": "The name of the esp process",
"type": "string"
},
"replicas": {
"type": "integer"
},
"resources": {
"$ref": "#/definitions/resources"
},
"service": {
"$ref": "#/definitions/service"
}
},
"required": [
"name",
"service",
"auth"
],
"type": "object"
},
"global": {
"additionalProperties": false,
"properties": {
"cost": {
"description": "resource cost",
"properties": {
"currencyCode": {
"description": "currency code (ISO 4217)",
"maxLength": 3,
"type": "string"
},
"perCpu": {
"description": "cost of a single cpu",
"type": "number"
},
"storageAtRest": {
"description": "storage cost (GiB per month)",
"type": "number"
},
"storageReads": {
"description": "cost per 10,000 read operations",
"type": "number"
},
"storageWrites": {
"description": "cost per 10,000 write operations",
"type": "number"
}
},
"type": "object"
},
"defaultDataPath": {
"type": "string"
},
"defaultEsp": {
"type": "string"
},
"defaultMirrorPath": {
"type": "string"
},
"egress": {
"$ref": "#/definitions/egress"
},
"env": {
"$ref": "#/definitions/env"
},
"image": {
"$ref": "#/definitions/image"
},
"logging": {
"$ref": "#/definitions/logging"
},
"metrics": {
"description": "Global metrics configuration",
"properties": {
"sinks": {
"$ref": "#/definitions/sinks"
}
},
"type": "object"
},
"misc": {
"description": "Miscellaneous settings",
"oneOf": [
{
"properties": {
"postJobCommand": {
"description": "Execute this command when a K8s Job launched by a deployment ends, either gracefully or when terminated externally causing a preStop event",
"type": "string"
},
"postJobCommandViaSidecar": {
"description": "Causes shareProcessNamespace to be enabled, and the postJobCommand to execute via a sidecar",
"type": "boolean"
}
},
"type": "object"
},
{
"type": "null"
}
]
},
"noResourceValidation": {
"type": "boolean"
},
"privileged": {
"type": "boolean"
},
"stubInstanceResources": {
"$ref": "#/definitions/stubInstanceResources"
},
"visibilities": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"ingress": {
"$ref": "#/definitions/ingress"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"description": "Global visibilities configuration",
"type": "object"
}
},
"type": "object"
},
"hostGroup": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name",
"hosts"
]
},
{
"required": [
"name",
"hostGroup"
]
}
],
"properties": {
"count": {
"description": "Number of hosts in the subset",
"type": "integer"
},
"delta": {
"description": "Cycle offset to apply to the hosts",
"type": "integer"
},
"hostGroup": {
"description": "Name of the hostgroup to create a subset of",
"type": "string"
},
"hosts": {
"description": "a list of host names",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "The name of the host group process",
"type": "string"
},
"offset": {
"description": "Offset of the first host within the group",
"type": "integer"
}
},
"type": "object"
},
"hostGroups": {
"oneOf": [
{
"items": {
"$ref": "#/definitions/hostGroup"
},
"type": "array"
},
{
"type": "null"
}
]
},
"image": {
"additionalProperties": false,
"properties": {
"name": {
"default": "platform-core",
"type": "string"
},
"pullPolicy": {
"enum": [
"IfNotPresent",
"Always",
"Never"
],
"type": "string"
},
"root": {
"default": "hpccsystems",
"type": "string"
},
"version": {
"type": "string"
}
},
"type": "object"
},
"ingress": {
"items": {
"additionalProperties": {
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "array"
},
"issuer": {
"properties": {
"kind": {
"enum": [
"Issuer",
"ClusterIssuer"
],
"type": "string"
},
"name": {
"description": "The name of the issuer which will be referenced in certificate objects",
"type": "string"
},
"spec": {
"description": "The cert-manager spec for the issuer. Should match issuer spec(s) defined by https://cert-manager.io/docs/configuration/",
"type": "object"
}
},
"required": [
"name"
],
"type": "object"
},
"ldap": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"adminGroupName": {
"description": "The Active Directory group containing HPCC Administrators",
"type": "string"
},
"cacheTimeout": {
"description": "Time in minutes after which the cached security information should be reloaded",
"type": "integer"
},
"checkScopeScans": {
"description": "Only return iterated logical file metadata for files that user has scope permission to access",
"type": "boolean"
},
"description": {
"description": "Description of this Active Directory Server component",
"type": "string"
},
"filesBasedn": {
"description": "The base distinguished name that should be used when looking up HPCC file scopes on the Active Directory server",
"type": "string"
},
"groupsBasedn": {
"description": "The base distinguished name that should be used when looking up HPCC groups on the Active Directory server",
"type": "string"
},
"ldapAddress": {
"description": "LDAP Server IP address(es), comma separated",
"type": "string"
},
"ldapAdminSecretKey": {
"description": "The key name to be used to look up the Active Directory Administrator account Username/Password",
"type": "string"
},
"ldapAdminVaultId": {
"description": "The optional vault name to be used to look up the Active Directory Administrator account Username/Password, using ldapAdminSecretKey",
"type": "string"
},
"ldapPort": {
"description": "The port of the nonsecure Active Directory server",
"type": "integer"
},
"ldapProtocol": {
"description": "The protocol to use - standard \"LDAP\" or secure \"LDAPS\" over SSL",
"type": "string"
},
"ldapSecurePort": {
"description": "The secure port of the secure Active Directory server",
"type": "integer"
},
"ldapTimeoutSecs": {
"description": "The maximum number of seconds to wait for most Active Directory calls",
"type": "integer"
},
"maxConnections": {
"description": "The maximum number of concurrent LDAP connections to the Active Directory server (default 10)",
"type": "integer"
},
"passwordExpirationWarningDays": {
"description": "Within this time period, ECLWatch displays a warning about pending password expiration",
"type": "integer"
},
"resourcesBasedn": {
"description": "The base distinguished name that should be used when looking up HPCC feature resources on the Active Directory server",
"type": "string"
},
"servertype": {
"description": "LDAP Server Implementation Type (\"ActiveDirectory\", \"AzureActiveDirectory\")",
"type": "string"
},
"sharedCache": {
"description": "Use a single, shared LDAP cache",
"type": "boolean"
},
"systemBasedn": {
"description": "The base distinguished name of the Active Directory Administrator",
"type": "string"
},
"usersBasedn": {
"description": "The base distinguished name that should be used when looking up HPCC users on the Active Directory server",
"type": "string"
},
"workunitsBasedn": {
"description": "The base distinguished name that should be used when looking up workunit scopes on the Active Directory server",
"type": "string"
}
},
"required": [
"ldapAddress"
],
"type": "object"
},
"logging": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"audiences": {
"description": "List of target audiences to include in logging output. Comprised of 3 letter codes delimited by + or -",
"type": "string"
},
"classes": {
"description": "List of target logging classes to include in output. Comprised of 3 letter codes delimited by + or -",
"type": "string"
},
"detail": {
"description": "Log output verbosity",
"type": "integer"
}
},
"type": "object"
},
"maxStartupTime": {
"description": "The time to wait before startup probing fails (in seconds). Default 300",
"type": "integer"
},
"memory": {
"additionalProperties": false,
"properties": {
"maxMemPercentage": {
"description": "The default maximum percentage of resource memory to dedicate to HPCC",
"type": "number"
},
"query": {
"description": "The amount of overall resourced memory to dedicate to the query",
"type": "string"
},
"thirdParty": {
"description": "The amount of overall resource memory to reserve for 3rd party use",
"type": "string"
}
},
"type": "object"
},
"minStartupTime": {
"description": "The time to wait before initiating startup probing (in seconds). Default 0",
"type": "integer"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"placement": {
"properties": {
"affinity": {
"type": "object"
},
"nodeSelector": {
"$ref": "#/definitions/nodeSelector"
},
"schedulerName": {
"type": "string"
},
"tolerations": {
"$ref": "#/definitions/tolerations"
},
"topologySpreadConstraints": {
"items": {
"$ref": "#/definitions/topologySpreadConstraint"
},
"type": "array"
}
},
"type": "object"
},
"resources": {
"type": "object"
},
"roxie": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"channelResources": {
"$ref": "#/definitions/resources"
},
"dataPlane": {
"description": "The default storage plane to write data files to",
"type": "string"
},
"directAccessPlanes": {
"description": "A list of storage planes suitable for roxie to read from directly and not have roxie copy the data to roxie's default plane",
"items": {
"type": "string"
},
"type": "array"
},
"env": {
"$ref": "#/definitions/env"
},
"image": {
"$ref": "#/definitions/image"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"logging": {
"$ref": "#/definitions/logging"
},
"maxStartupTime": {
"$ref": "#/definitions/maxStartupTime"
},
"minStartupTime": {
"$ref": "#/definitions/minStartupTime"
},
"name": {
"description": "The name of the roxie process",
"type": "string"
},
"prefix": {
"description": "The (optional) file prefix to add to relative filenames",
"type": "string"
},
"preload": {
"description": "Preloaded plugins",
"items": {
"type": "string"
},
"type": "array"
},
"serverResources": {
"$ref": "#/definitions/resources"
},
"services": {
"description": "Roxie query services",
"items": {
"$ref": "#/definitions/roxieservice"
},
"type": "array"
},
"spillPlane": {
"description": "The storage plane to write spill files to",
"type": "string"
},
"topoServer": {
"$ref": "#/definitions/toposerver"
}
},
"required": [
"name"
],
"type": "object"
},
"roxieservice": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"ingress": {
"$ref": "#/definitions/ingress"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"listenQueue": {
"type": "integer"
},
"name": {
"type": "string"
},
"numThreads": {
"type": "integer"
},
"port": {
"description": "The local port used by the pod (same as servicePort if not specified)",
"type": "integer"
},
"servicePort": {
"description": "The port that this service will be exposed on",
"type": "integer"
},
"visibility": {
"description": "Should this service be exposed outside the cluster, locally or to the internet",
"type": "string"
}
},
"required": [
"name",
"servicePort"
],
"type": "object"
},
"sasha-coalescer": {
"oneOf": [
{
"allOf": [
{
"$ref": "#/definitions/sashacommon"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"at": {},
"disabled": {},
"env": {},
"image": {},
"interval": {},
"labels": {},
"minDeltaSize": {
"description": "Coalescing will only begin, if the delta size is above this threshold (K)",
"type": "integer"
},
"plane": {},
"resources": {},
"service": {},
"throttle": {}
}
}
],
"type": "object"
},
{
"type": "null"
}
]
},
"sasha-dfurecovery-archiver": {
"oneOf": [
{
"allOf": [
{
"$ref": "#/definitions/sashacommon"
},
{
"$ref": "#/definitions/sasha-limitcutoff"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"at": {},
"cutoff": {},
"disabled": {},
"env": {},
"image": {},
"interval": {},
"labels": {},
"limit": {},
"plane": {},
"resources": {},
"service": {},
"throttle": {}
}
}
],
"type": "object"
},
{
"type": "null"
}
]
},
"sasha-dfuwu-archiver": {
"oneOf": [
{
"allOf": [
{
"$ref": "#/definitions/sashacommon"
},
{
"$ref": "#/definitions/sasha-limitcutoff"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"at": {},
"cutoff": {},
"disabled": {},
"env": {},
"image": {},
"interval": {},
"labels": {},
"limit": {},
"plane": {},
"resources": {},
"service": {},
"throttle": {}
}
}
],
"required": [
"plane"
],
"type": "object"
},
{
"type": "null"
}
]
},
"sasha-file-expiry": {
"oneOf": [
{
"additionalProperties": false,
"allOf": [
{
"$ref": "#/definitions/sashacommon"
}
],
"properties": {
"annotations": {},
"at": {},
"disabled": {},
"expiryDefault": {
"default": "14",
"description": "Default number of days to delete unused standard files that are flagged with EXPIRY",
"type": "integer"
},
"image": {},
"interval": {},
"labels": {},
"persistExpiryDefault": {
"default": "7",
"description": "Default number of days to delete unused persist files",
"type": "integer"
},
"plane": {},
"resources": {},
"service": {},
"throttle": {},
"user": {
"description": "A username authorized to access and remove expired files",
"type": "string"
}
},
"type": "object"
},
{
"type": "null"
}
]
},
"sasha-limitcutoff": {
"properties": {
"cutoff": {
"default": "4",
"description": "minimum age (days)",
"type": "integer"
},
"limit": {
"default": "20",
"description": "threshold before removal starts (0 disables)",
"type": "integer"
}
},
"type": "object"
},
"sasha-wu-archiver": {
"oneOf": [
{
"allOf": [
{
"$ref": "#/definitions/sashacommon"
},
{
"$ref": "#/definitions/sasha-limitcutoff"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"at": {},
"backup": {
"default": "0",
"description": "minimum workunit age to backup (days, 0 disables)",
"type": "integer"
},
"cutoff": {},
"disabled": {},
"duration": {
"default": "0",
"description": "Maximum duration to run WorkUnit archiving session (hours, 0 unlimited)",
"type": "integer"
},
"env": {},
"image": {},
"interval": {},
"keepResultFiles": {
"default": "false",
"description": "option to keep result files owned by workunits after workunit is archived",
"type": "boolean"
},
"labels": {},
"limit": {},
"plane": {},
"resources": {},
"retryinterval": {
"default": "7",
"description": "minimal time before retrying archive of failed WorkUnits (days)",
"type": "integer"
},
"service": {},
"throttle": {}
}
}
],
"required": [
"plane"
],
"type": "object"
},
{
"type": "null"
}
]
},
"sashacommon": {
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"at": {
"default": "* * * * *",
"type": "string"
},
"disabled": {
"type": "boolean"
},
"env": {
"$ref": "#/definitions/env"
},
"image": {
"$ref": "#/definitions/image"
},
"interval": {
"default": 1,
"type": "integer"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"plane": {
"description": "which storage plane to store the sasha data on",
"type": "string"
},
"resources": {
"$ref": "#/definitions/resources"
},
"service": {
"description": "Service properties",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"port": {
"default": 8880,
"description": "The local port used by the pod",
"type": "integer"
},
"servicePort": {
"description": "The port that this service will be exposed on",
"type": "integer"
}
},
"required": [
"servicePort"
],
"type": "object"
},
"throttle": {
"description": "throttle ratio percentage (0-99, 0 no throttling, 50 is half speed)",
"type": "integer"
}
},
"type": "object"
},
"sashaservice": {
"oneOf": [
{
"additionalProperties": false,
"description": "sasha services",
"properties": {
"coalescer": {
"$ref": "#/definitions/sasha-coalescer"
},
"dfurecovery-archiver": {
"$ref": "#/definitions/sasha-dfurecovery-archiver"
},
"dfuwu-archiver": {
"$ref": "#/definitions/sasha-dfuwu-archiver"
},
"disabled": {
"type": "boolean"
},
"file-expiry": {
"$ref": "#/definitions/sasha-file-expiry"
},
"wu-archiver": {
"$ref": "#/definitions/sasha-wu-archiver"
}
},
"type": "object"
},
{
"type": "null"
}
]
},
"secrets": {
"oneOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
]
},
"security": {
"properties": {
"eclSecurity": {
"$ref": "#/definitions/eclSecurity"
},
"mtls": {
"default": true,
"description": "enable global mtls between clients (except roxie which has own setting). NB: requires certificates.enabled=true",
"type": "boolean"
}
},
"type": "object"
},
"service": {
"description": "Service properties",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"ingress": {
"$ref": "#/definitions/ingress"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"port": {
"default": 8880,
"description": "The local port used by the pod",
"type": "integer"
},
"servicePort": {
"description": "The port that this service will be exposed on",
"type": "integer"
},
"visibility": {
"description": "Should this service be exposed outside the cluster, locally or to the internet",
"type": "string"
}
},
"required": [
"servicePort",
"visibility"
],
"type": "object"
},
"sink": {
"description": "Definition of a metric sink",
"properties": {
"name": {
"description": "Name for the sink, must be unique for the component",
"type": "string"
},
"settings": {
"description": "Settings specific to the sink",
"type": "object"
},
"type": {
"description": "The defined metric sink type",
"type": "string"
}
},
"required": [
"type",
"name"
],
"type": "object"
},
"sinks": {
"items": {
"$ref": "#/definitions/sink"
},
"type": "array"
},
"storagePlane": {
"additionalProperties": false,
"description": "information about an individual storage plane",
"properties": {
"category": {
"description": "the category this plane is usd for, e.g. lz, data",
"enum": [
"data",
"lz",
"dali",
"sasha",
"dll",
"spill"
],
"type": "string"
},
"cost": {
"description": "Costs associated with the storage and use of the plane",
"properties": {
"storageAtRest": {
"description": "Storage cost (GiB/month)",
"type": "number"
}
},
"type": "object"
},
"defaultSprayParts": {
"description": "Number of parts sprayed by default",
"type": "integer"
},
"forcePermissions": {
"type": "boolean"
},
"hostGroup": {
"description": "optional name of the host group (for bare metal storage)",
"type": "string"
},
"hosts": {
"description": "a list of host names",
"items": {
"type": "string"
},
"type": "array"
},
"includeDeviceInPath": {
"description": "is a directory based on the part number appended to the path. May not be needed",
"type": "boolean"
},
"name": {
"description": "the name of the storage plane",
"type": "string"
},
"numDevices": {
"description": "optional number of devices in the storage plane (default 1)",
"type": "integer"
},
"prefix": {
"description": "either the path for a local mount, or the url prefix",
"type": "string"
},
"pvc": {
"description": "optional name of the persistent volume claim for this plane",
"type": "string"
},
"replication": {
"description": "which planes (if any) the data is replicated onto (primarily bare metal)",
"items": {
"type": "string"
},
"type": "array"
},
"secret": {
"description": "optional name of any secret required to access this storage plane",
"type": "string"
},
"storageClass": {
"type": "string"
},
"storageMode": {
"type": "string"
},
"storageSize": {
"type": "string"
},
"subDirPerFilePart": {
"default": true,
"description": "Place each logical file part in its own subdirectory",
"type": "boolean"
},
"subPath": {
"description": "optional subdirectory within the mount directory",
"type": "string"
},
"umask": {
"description": "file creation mask (used by despray)",
"type": "string"
}
},
"required": [
"name",
"prefix",
"category"
],
"type": "object"
},
"storagePlanes": {
"description": "storage plane definitions",
"items": {
"$ref": "#/definitions/storagePlane"
},
"type": "array"
},
"stubInstanceResources": {
"description": "resource definitions per instance for stub components",
"properties": {
"additionalProperties": false,
"cpu": {
"default": "50m",
"description": "default per stub instance milli cpu requirements",
"type": "string"
},
"memory": {
"default": "200Mi",
"description": "default per stub instance memory requirements",
"type": "string"
}
},
"type": "object"
},
"thor": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"dataPlane": {
"description": "The default storage plane to write data files to",
"type": "string"
},
"eclAgentMemory": {
"$ref": "#/definitions/memory"
},
"eclAgentReplicas": {
"description": "Number of eclagent replicas",
"minimum": 1,
"type": "integer"
},
"eclAgentResources": {
"$ref": "#/definitions/resources"
},
"eclAgentType": {
"description": "eclagent engine type",
"enum": [
"hthor",
"roxie"
]
},
"eclAgentUseChildProcesses": {
"description": "Use processes instead of pods per job (eclagent)",
"type": "boolean"
},
"env": {
"$ref": "#/definitions/env"
},
"expert": {
"description": "Custom internal options usually reserved for internal testing",
"type": "object"
},
"image": {
"$ref": "#/definitions/image"
},
"keepJobs": {
"description": "For debugging purposes. Choose whether to keep jobs after execution",
"enum": [
"none",
"podfailures",
"all"
]
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"lingerPeriod": {
"description": "[Optional] Seconds to keep Thor instance running, waiting for more graphs to execute",
"minimum": 1,
"type": "integer"
},
"logging": {
"$ref": "#/definitions/logging"
},
"managerMemory": {
"$ref": "#/definitions/memory"
},
"managerResources": {
"$ref": "#/definitions/resources"
},
"maxGraphs": {
"description": "The maximum number of Thor graphs that be run concurrently",
"minimum": 1,
"type": "integer"
},
"maxJobs": {
"description": "The maximum number of jobs that can be run concurrenly",
"minimum": 1,
"type": "integer"
},
"multiJobLinger": {
"description": "[Optional] If lingerPeriod set, allows Thor to process more graphs from any job",
"type": "boolean"
},
"name": {
"description": "The name of the thor process",
"type": "string"
},
"numWorkers": {
"description": "The number of worker pods",
"minimum": 1,
"type": "integer"
},
"prefix": {
"description": "The (optional) file prefix to add to relative filenames",
"type": "string"
},
"spillPlane": {
"description": "The storage plane to write spill files to",
"type": "string"
},
"thorAgentReplicas": {
"description": "Number of thoragent replicas",
"minimum": 1,
"type": "integer"
},
"workerMemory": {
"$ref": "#/definitions/memory"
},
"workerResources": {
"$ref": "#/definitions/resources"
}
},
"required": [
"name",
"maxJobs",
"maxGraphs"
],
"type": "object"
},
"toleration": {
"properties": {
"effect": {
"type": "string"
},
"key": {
"type": "string"
},
"operator": {
"type": "string"
},
"tolerationSeconds": {
"type": "integer"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"tolerations": {
"items": {
"$ref": "#/definitions/toleration"
},
"type": "array"
},
"topologySpreadConstraint": {
"properties": {
"labelSelector": {
"description": "labelSelector is used to find matching Pods",
"type": "object"
},
"maxSkew": {
"description": "describes the degree to which Pods may be unevenly distributed. It must be greater than zero",
"type": "integer"
},
"topologyKey": {
"description": "is the key of node labels",
"type": "string"
},
"whenUnsatisfiable": {
"description": "indicates how to deal with a Pod if it doesn't satisfy the spread constraint",
"enum": [
"DoNotSchedule",
"ScheduleAnyway"
],
"type": "string"
}
},
"type": "object"
},
"toposerver": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"env": {
"$ref": "#/definitions/env"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"logging": {
"$ref": "#/definitions/logging"
},
"port": {
"type": "integer"
},
"replicas": {
"type": "integer"
},
"traceLevel": {
"type": "integer"
}
},
"type": "object"
},
"vault": {
"additionalProperties": false,
"description": "information about an individual vault",
"properties": {
"client-secret": {
"description": "optional name of kubernetes secret that will provide the vault client token",
"type": "string"
},
"kind": {
"enum": [
"kv-v2",
"kv-v1"
],
"type": "string"
},
"name": {
"description": "the name of the vault",
"type": "string"
},
"url": {
"description": "the url used to access the vault",
"type": "string"
}
},
"required": [
"name",
"url"
],
"type": "object"
},
"vaultCategory": {
"description": "set of vaults under a given category",
"oneOf": [
{
"items": {
"$ref": "#/definitions/vault"
},
"type": "array"
},
{
"type": "null"
}
]
}
},
"properties": {
"bundles": {
"description": "bundles",
"items": {
"$ref": "#/definitions/bundle"
},
"type": "array"
},
"certificates": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"issuers": {
"properties": {
"local": {
"$ref": "#/definitions/issuer"
},
"public": {
"$ref": "#/definitions/issuer"
}
},
"type": "object"
}
},
"type": "object"
},
"dafilesrv": {
"description": "dafilesrv process",
"items": {
"$ref": "#/definitions/dafilesrv"
},
"type": "array"
},
"dali": {
"description": "dali process",
"items": {
"$ref": "#/definitions/dali"
},
"maxItems": 1,
"minItems": 1,
"type": "array"
},
"dfuserver": {
"description": "dfuserver process",
"items": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"disabled": {
"type": "boolean"
},
"env": {
"$ref": "#/definitions/env"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"maxJobs": {
"type": "integer"
},
"name": {
"description": "The name of the dfuserver process",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"eclagent": {
"description": "eclagent process",
"items": {
"allOf": [
{
"$ref": "#/definitions/eclagent"
},
{
"dataPlane": {
"description": "The default storage plane to write data files to",
"type": "string"
},
"name": {
"description": "The name of the eclagent process",
"type": "string"
},
"prefix": {
"description": "The (optional) file prefix to add to relative filenames",
"type": "string"
},
"required": [
"name"
],
"spillPlane": {
"description": "The storage plane to write spill files to",
"type": "string"
}
}
]
},
"type": "array"
},
"eclccserver": {
"description": "eclccserver process",
"items": {
"$ref": "#/definitions/eclccserver"
},
"type": "array"
},
"eclscheduler": {
"description": "eclscheduler process",
"items": {
"$ref": "#/definitions/eclscheduler"
},
"type": "array"
},
"esp": {
"description": "esp process",
"items": {
"$ref": "#/definitions/esp"
},
"type": "array"
},
"global": {
"$ref": "#/definitions/global"
},
"placements": {
"items": {
"properties": {
"placement": {
"$ref": "#/definitions/placement"
},
"pods": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
},
"roxie": {
"description": "roxie process",
"items": {
"$ref": "#/definitions/roxie"
},
"type": "array"
},
"sasha": {
"$ref": "#/definitions/sashaservice",
"description": "sasha services",
"type": "object"
},
"secrets": {
"additionalProperties": false,
"description": "configuration for secrets accessed by the components",
"properties": {
"authn": {
"$ref": "#/definitions/secrets"
},
"codeSign": {
"$ref": "#/definitions/secrets"
},
"codeVerify": {
"$ref": "#/definitions/secrets"
},
"ecl": {
"$ref": "#/definitions/secrets"
},
"storage": {
"$ref": "#/definitions/secrets"
},
"system": {
"$ref": "#/definitions/secrets"
},
"timeout": {
"type": "integer"
}
},
"type": "object"
},
"security": {
"$ref": "#/definitions/security"
},
"storage": {
"additionalProperties": false,
"properties": {
"hostGroups": {
"$ref": "#/definitions/hostGroups"
},
"planes": {
"$ref": "#/definitions/storagePlanes"
}
},
"type": "object"
},
"thor": {
"description": "thor process",
"items": {
"$ref": "#/definitions/thor"
},
"type": "array"
},
"vaults": {
"additionalProperties": false,
"description": "configuration for vaults accessed by the components",
"properties": {
"authn": {
"$ref": "#/definitions/vaultCategory"
},
"codeSign": {
"$ref": "#/definitions/vaultCategory"
},
"codeVerify": {
"$ref": "#/definitions/vaultCategory"
},
"ecl": {
"$ref": "#/definitions/vaultCategory"
},
"ecl-user": {
"$ref": "#/definitions/vaultCategory"
},
"esp": {
"$ref": "#/definitions/vaultCategory"
},
"storage": {
"$ref": "#/definitions/vaultCategory"
},
"timeout": {
"type": "integer"
}
},
"type": "object"
}
},
"required": [
"dali"
],
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
hpcc-systems/helm-chart | 380a2704502c118086b1a0e4005680cb8ee2f4c9 | 2021-09-08T11:27:07 | helm/hpcc/values.schema.json | 10 | 2024-05-28T04:25:31.595363Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"definitions": {
"bundle": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"name": {
"description": "The name of the bundle process",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"compileOption": {
"additionalProperties": false,
"properties": {
"cluster": {
"description": "Cluster to apply option to",
"type": "string"
},
"name": {
"description": "Compiler option name",
"type": "string"
},
"value": {
"description": "Compiler option value",
"type": [
"number",
"string",
"boolean"
]
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"dali": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"env": {
"$ref": "#/definitions/env"
},
"image": {
"$ref": "#/definitions/image"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"logging": {
"$ref": "#/definitions/logging"
},
"maxStartupTime": {
"$ref": "#/definitions/maxStartupTime"
},
"minStartupTime": {
"$ref": "#/definitions/minStartupTime"
},
"name": {
"description": "The name of the dali process",
"type": "string"
},
"resources": {
"$ref": "#/definitions/resources"
},
"services": {
"$ref": "#/definitions/sashaservice",
"description": "sasha services",
"type": "object"
}
},
"required": [
"name"
],
"type": "object"
},
"eclSecurity": {
"properties": {
"datafile": {
"$ref": "#/definitions/eclSecurityValues"
},
"embedded": {
"$ref": "#/definitions/eclSecurityValues"
},
"extern": {
"$ref": "#/definitions/eclSecurityValues"
},
"pipe": {
"$ref": "#/definitions/eclSecurityValues"
}
},
"type": "object"
},
"eclSecurityValues": {
"enum": [
"deny",
"allow",
"allowSigned"
],
"type": "string"
},
"eclagent": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"dataPlane": {
"description": "The default storage plane to write data files to",
"type": "string"
},
"env": {
"$ref": "#/definitions/env"
},
"image": {
"$ref": "#/definitions/image"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"logging": {
"$ref": "#/definitions/logging"
},
"maxActive": {
"default": 100,
"description": "Maximum number of workunits that can be active simultaneously",
"minimum": 1,
"type": "integer"
},
"replicas": {
"type": "integer"
},
"resources": {
"$ref": "#/definitions/resources"
},
"type": {
"description": "Use the hthor or roxie execution engine for eclagent queries",
"enum": [
"hthor",
"roxie"
],
"type": "string"
},
"useChildProcesses": {
"description": "Launch each workunit as a child process rather than in its own container",
"type": "boolean"
}
},
"required": [
"maxActive"
],
"type": "object"
},
"eclccserver": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"env": {
"$ref": "#/definitions/env"
},
"image": {
"$ref": "#/definitions/image"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"listen": {
"items": {
"type": "string"
},
"type": "array"
},
"logging": {
"$ref": "#/definitions/logging"
},
"maxActive": {
"default": 4,
"description": "Maximum number of compile jobs that can be active simultaneously",
"minimum": 1,
"type": "integer"
},
"name": {
"description": "The name of the eclccserver process",
"type": "string"
},
"options": {
"items": {
"$ref": "#/definitions/compileOption"
},
"type": "array"
},
"replicas": {
"type": "integer"
},
"resources": {
"$ref": "#/definitions/resources"
},
"useChildProcesses": {
"description": "Launch each workunit compile as a child process rather than in its own container",
"type": "boolean"
}
},
"required": [
"name",
"maxActive"
],
"type": "object"
},
"eclscheduler": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"env": {
"$ref": "#/definitions/env"
},
"image": {
"$ref": "#/definitions/image"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"logging": {
"$ref": "#/definitions/logging"
},
"name": {
"description": "The name of the eclccserver process",
"type": "string"
},
"resources": {
"$ref": "#/definitions/resources"
}
},
"required": [
"name"
],
"type": "object"
},
"egress": {
"additionalProperties": false,
"properties": {
"kubeApiCidr": {
"description": "IP range for kubectl API service",
"type": "string"
},
"kubeApiPort": {
"description": "Port used for connections to kubectl API",
"type": "integer"
},
"kubeSystemLabel": {
"description": "Label that has been applied to the kube-system namespace, used to restrict DNS service calls on port 53 to pods in the kube-system namespace",
"type": "string"
},
"restricted": {
"description": "Are any egress controls applied",
"type": "boolean"
}
},
"type": "object"
},
"env": {
"items": {
"properties": {
"name": {
"description": "Environment variable name",
"type": "string"
},
"value": {
"description": "Environment variable value",
"type": [
"number",
"string",
"boolean"
]
}
},
"type": "object"
},
"type": "array"
},
"esp": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"env": {
"$ref": "#/definitions/env"
},
"image": {
"$ref": "#/definitions/image"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"ldap": {
"$ref": "#/definitions/ldap"
},
"logging": {
"$ref": "#/definitions/logging"
},
"name": {
"description": "The name of the esp process",
"type": "string"
},
"replicas": {
"type": "integer"
},
"resources": {
"$ref": "#/definitions/resources"
},
"service": {
"description": "Service properties",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"port": {
"default": 8880,
"description": "The local port used by the pod",
"type": "integer"
},
"servicePort": {
"description": "The port that this service will be exposed on",
"type": "integer"
},
"visibility": {
"description": "Should this service be exposed outside the cluster, locally or to the internet",
"type": "string"
}
},
"required": [
"servicePort",
"visibility"
],
"type": "object"
}
},
"required": [
"name",
"service"
],
"type": "object"
},
"global": {
"additionalProperties": false,
"properties": {
"cost": {
"description": "resource cost",
"properties": {
"perCpu": {
"description": "cost of a single cpu",
"type": "number"
}
},
"type": "object"
},
"defaultDataPath": {
"type": "string"
},
"defaultEsp": {
"type": "string"
},
"defaultMirrorPath": {
"type": "string"
},
"egress": {
"$ref": "#/definitions/egress"
},
"env": {
"$ref": "#/definitions/env"
},
"image": {
"$ref": "#/definitions/image"
},
"logging": {
"$ref": "#/definitions/logging"
},
"metrics": {
"description": "Global metrics configuration",
"properties": {
"sinks": {
"$ref": "#/definitions/sinks"
}
},
"type": "object"
},
"misc": {
"description": "Miscellaneous settings",
"oneOf": [
{
"properties": {
"postJobCommand": {
"description": "Execute this command when a K8s Job launched by a deployment ends, either gracefully or when terminated externally causing a preStop event",
"type": "string"
},
"postJobCommandViaSidecar": {
"description": "Causes shareProcessNamespace to be enabled, and the postJobCommand to execute via a sidecar",
"type": "boolean"
}
},
"type": "object"
},
{
"type": "null"
}
]
},
"noResourceValidation": {
"type": "boolean"
},
"privileged": {
"type": "boolean"
},
"visibilities": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"description": "Global visibilities configuration",
"type": "object"
}
},
"type": "object"
},
"hostGroup": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name",
"hosts"
]
},
{
"required": [
"name",
"hostGroup"
]
}
],
"properties": {
"count": {
"description": "Number of hosts in the subset",
"type": "integer"
},
"delta": {
"description": "Cycle offset to apply to the hosts",
"type": "integer"
},
"hostGroup": {
"description": "Name of the hostgroup to create a subset of",
"type": "string"
},
"hosts": {
"description": "a list of host names",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "The name of the host group process",
"type": "string"
},
"offset": {
"description": "Offset of the first host within the group",
"type": "integer"
}
},
"type": "object"
},
"hostGroups": {
"oneOf": [
{
"items": {
"$ref": "#/definitions/hostGroup"
},
"type": "array"
},
{
"type": "null"
}
]
},
"image": {
"additionalProperties": false,
"properties": {
"name": {
"default": "platform-core",
"type": "string"
},
"pullPolicy": {
"enum": [
"IfNotPresent",
"Always",
"Never"
],
"type": "string"
},
"root": {
"default": "hpccsystems",
"type": "string"
},
"version": {
"type": "string"
}
},
"type": "object"
},
"issuer": {
"properties": {
"kind": {
"enum": [
"Issuer",
"ClusterIssuer"
],
"type": "string"
},
"name": {
"description": "The name of the issuer which will be referenced in certificate objects",
"type": "string"
},
"spec": {
"description": "The cert-manager spec for the issuer. Should match issuer spec(s) defined by https://cert-manager.io/docs/configuration/",
"type": "object"
}
},
"required": [
"name"
],
"type": "object"
},
"ldap": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"adminGroupName": {
"description": "The Active Directory group containing HPCC Administrators",
"type": "string"
},
"cacheTimeout": {
"description": "Time in minutes after which the cached security information should be reloaded",
"type": "integer"
},
"description": {
"description": "Description of this Active Directory Server component",
"type": "string"
},
"filesBasedn": {
"description": "The base distinguished name that should be used when looking up HPCC file scopes on the Active Directory server",
"type": "string"
},
"groupsBasedn": {
"description": "The base distinguished name that should be used when looking up HPCC groups on the Active Directory server",
"type": "string"
},
"ldapAdminSecretKey": {
"description": "The key name to be used to look up the Active Directory system administrator account Username/Password",
"type": "string"
},
"ldapAdminVaultId": {
"description": "The optional vault name to be used to look up the Active Directory system administrator account Username/Password, using ldapAdminSecretKey",
"type": "string"
},
"ldapPort": {
"description": "The port of the nonsecure Active Directory server",
"type": "integer"
},
"ldapProtocol": {
"description": "The protocol to use - standard \"LDAP\" or secure \"LDAPS\" over SSL",
"type": "string"
},
"ldapSecurePort": {
"description": "The secure port of the secure Active Directory server",
"type": "integer"
},
"ldapTimeoutSecs": {
"description": "The maximum number of seconds to wait for most Active Directory calls",
"type": "integer"
},
"maxConnections": {
"description": "The maximum number of concurrent LDAP connections to the Active Directory server (default 10)",
"type": "integer"
},
"passwordExpirationWarningDays": {
"description": "Within this time period, ECLWatch displays a warning about pending password expiration",
"type": "integer"
},
"resourcesBasedn": {
"description": "The base distinguished name that should be used when looking up HPCC feature resources on the Active Directory server",
"type": "string"
},
"servertype": {
"description": "LDAP Server Implementation Type (\"ActiveDirectory\", \"AzureActiveDirectory\")",
"type": "string"
},
"sharedCache": {
"description": "Use a single, shared LDAP cache",
"type": "boolean"
},
"systemBasedn": {
"description": "The base distinguished name of the Active Directory systemUser",
"type": "string"
},
"usersBasedn": {
"description": "The base distinguished name that should be used when looking up HPCC users on the Active Directory server",
"type": "string"
},
"workunitsBasedn": {
"description": "The base distinguished name that should be used when looking up workunit scopes on the Active Directory server",
"type": "string"
}
},
"type": "object"
},
"logging": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"audiences": {
"description": "List of target audiences to include in logging output. Comprised of 3 letter codes delimited by + or -",
"type": "string"
},
"classes": {
"description": "List of target logging classes to include in output. Comprised of 3 letter codes delimited by + or -",
"type": "string"
},
"detail": {
"description": "Log output verbosity",
"type": "integer"
}
},
"type": "object"
},
"maxStartupTime": {
"description": "The time to wait before startup probing fails (in seconds). Default 300",
"type": "integer"
},
"minStartupTime": {
"description": "The time to wait before initiating startup probing (in seconds). Default 0",
"type": "integer"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"placement": {
"properties": {
"affinity": {
"type": "object"
},
"nodeSelector": {
"$ref": "#/definitions/nodeSelector"
},
"schedulerName": {
"type": "string"
},
"tolerations": {
"$ref": "#/definitions/tolerations"
}
},
"type": "object"
},
"resources": {
"type": "object"
},
"roxie": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"channelResources": {
"$ref": "#/definitions/resources"
},
"dataPlane": {
"description": "The default storage plane to write data files to",
"type": "string"
},
"env": {
"$ref": "#/definitions/env"
},
"image": {
"$ref": "#/definitions/image"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"logging": {
"$ref": "#/definitions/logging"
},
"maxStartupTime": {
"$ref": "#/definitions/maxStartupTime"
},
"minStartupTime": {
"$ref": "#/definitions/minStartupTime"
},
"name": {
"description": "The name of the roxie process",
"type": "string"
},
"prefix": {
"description": "The (optional) file prefix to add to relative filenames",
"type": "string"
},
"preload": {
"description": "Preloaded plugins",
"items": {
"type": "string"
},
"type": "array"
},
"serverResources": {
"$ref": "#/definitions/resources"
},
"services": {
"description": "Roxie query services",
"items": {
"$ref": "#/definitions/roxieservice"
},
"type": "array"
},
"spillPlane": {
"description": "The storage plane to write spill files to",
"type": "string"
},
"storagePlanes": {
"description": "A list of storage planes suitable for storing roxie data",
"items": {
"type": "string"
},
"type": "array"
},
"topoServer": {
"$ref": "#/definitions/toposerver"
}
},
"required": [
"name"
],
"type": "object"
},
"roxieservice": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"listenQueue": {
"type": "integer"
},
"name": {
"type": "string"
},
"numThreads": {
"type": "integer"
},
"port": {
"description": "The local port used by the pod (same as servicePort if not specified)",
"type": "integer"
},
"servicePort": {
"description": "The port that this service will be exposed on",
"type": "integer"
},
"visibility": {
"description": "Should this service be exposed outside the cluster, locally or to the internet",
"type": "string"
}
},
"required": [
"name",
"servicePort"
],
"type": "object"
},
"sasha-coalescer": {
"oneOf": [
{
"allOf": [
{
"$ref": "#/definitions/sashacommon"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"at": {},
"disabled": {},
"env": {},
"image": {},
"interval": {},
"labels": {},
"minDeltaSize": {
"description": "Coalescing will only begin, if the delta size is above this threshold (K)",
"type": "integer"
},
"plane": {},
"resources": {},
"service": {},
"throttle": {}
}
}
],
"type": "object"
},
{
"type": "null"
}
]
},
"sasha-dfurecovery-archiver": {
"oneOf": [
{
"allOf": [
{
"$ref": "#/definitions/sashacommon"
},
{
"$ref": "#/definitions/sasha-limitcutoff"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"at": {},
"cutoff": {},
"disabled": {},
"env": {},
"image": {},
"interval": {},
"labels": {},
"limit": {},
"plane": {},
"resources": {},
"service": {},
"throttle": {}
}
}
],
"type": "object"
},
{
"type": "null"
}
]
},
"sasha-dfuwu-archiver": {
"oneOf": [
{
"allOf": [
{
"$ref": "#/definitions/sashacommon"
},
{
"$ref": "#/definitions/sasha-limitcutoff"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"at": {},
"cutoff": {},
"disabled": {},
"env": {},
"image": {},
"interval": {},
"labels": {},
"limit": {},
"plane": {},
"resources": {},
"service": {},
"throttle": {}
}
}
],
"required": [
"plane"
],
"type": "object"
},
{
"type": "null"
}
]
},
"sasha-file-expiry": {
"oneOf": [
{
"additionalProperties": false,
"allOf": [
{
"$ref": "#/definitions/sashacommon"
}
],
"properties": {
"annotations": {},
"at": {},
"disabled": {},
"expiryDefault": {
"default": "14",
"description": "Default number of days to delete unused standard files that are flagged with EXPIRY",
"type": "integer"
},
"image": {},
"interval": {},
"labels": {},
"persistExpiryDefault": {
"default": "7",
"description": "Default number of days to delete unused persist files",
"type": "integer"
},
"plane": {},
"resources": {},
"service": {},
"throttle": {},
"user": {
"description": "A username authorized to access and remove expired files",
"type": "string"
}
},
"type": "object"
},
{
"type": "null"
}
]
},
"sasha-limitcutoff": {
"properties": {
"cutoff": {
"default": "4",
"description": "minimum age (days)",
"type": "integer"
},
"limit": {
"default": "20",
"description": "threshold before removal starts (0 disables)",
"type": "integer"
}
},
"type": "object"
},
"sasha-wu-archiver": {
"oneOf": [
{
"allOf": [
{
"$ref": "#/definitions/sashacommon"
},
{
"$ref": "#/definitions/sasha-limitcutoff"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"at": {},
"backup": {
"default": "0",
"description": "minimum workunit age to backup (days, 0 disables)",
"type": "integer"
},
"cutoff": {},
"disabled": {},
"duration": {
"default": "0",
"description": "Maximum duration to run WorkUnit archiving session (hours, 0 unlimited)",
"type": "integer"
},
"env": {},
"image": {},
"interval": {},
"keepResultFiles": {
"default": "false",
"description": "option to keep result files owned by workunits after workunit is archived",
"type": "boolean"
},
"labels": {},
"limit": {},
"plane": {},
"resources": {},
"retryinterval": {
"default": "7",
"description": "minimal time before retrying archive of failed WorkUnits (days)",
"type": "integer"
},
"service": {},
"throttle": {}
}
}
],
"required": [
"plane"
],
"type": "object"
},
{
"type": "null"
}
]
},
"sashacommon": {
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"at": {
"default": "* * * * *",
"type": "string"
},
"disabled": {
"type": "boolean"
},
"env": {
"$ref": "#/definitions/env"
},
"image": {
"$ref": "#/definitions/image"
},
"interval": {
"default": 1,
"type": "integer"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"plane": {
"description": "which storage plane to store the sasha data on",
"type": "string"
},
"resources": {
"$ref": "#/definitions/resources"
},
"service": {
"description": "Service properties",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"port": {
"default": 8880,
"description": "The local port used by the pod",
"type": "integer"
},
"servicePort": {
"description": "The port that this service will be exposed on",
"type": "integer"
}
},
"required": [
"servicePort"
],
"type": "object"
},
"throttle": {
"description": "throttle ratio percentage (0-99, 0 no throttling, 50 is half speed)",
"type": "integer"
}
},
"type": "object"
},
"sashaservice": {
"oneOf": [
{
"additionalProperties": false,
"description": "sasha services",
"properties": {
"coalescer": {
"$ref": "#/definitions/sasha-coalescer"
},
"dfurecovery-archiver": {
"$ref": "#/definitions/sasha-dfurecovery-archiver"
},
"dfuwu-archiver": {
"$ref": "#/definitions/sasha-dfuwu-archiver"
},
"disabled": {
"type": "boolean"
},
"file-expiry": {
"$ref": "#/definitions/sasha-file-expiry"
},
"wu-archiver": {
"$ref": "#/definitions/sasha-wu-archiver"
}
},
"type": "object"
},
{
"type": "null"
}
]
},
"secrets": {
"oneOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
]
},
"security": {
"properties": {
"eclSecurity": {
"$ref": "#/definitions/eclSecurity"
},
"mtls": {
"default": true,
"description": "enable global mtls between clients (except roxie which has own setting). NB: requires certificates.enabled=true",
"type": "boolean"
}
},
"type": "object"
},
"sink": {
"description": "Definition of a metric sink",
"properties": {
"name": {
"description": "Name for the sink, must be unique for the component",
"type": "string"
},
"settings": {
"description": "Settings specific to the sink",
"type": "object"
},
"type": {
"description": "The defined metric sink type",
"type": "string"
}
},
"required": [
"type",
"name"
],
"type": "object"
},
"sinks": {
"items": {
"$ref": "#/definitions/sink"
},
"type": "array"
},
"storagePlane": {
"additionalProperties": false,
"description": "information about an individual storage plane",
"properties": {
"category": {
"description": "the category this plane is usd for, e.g. lz, data",
"enum": [
"data",
"lz",
"dali",
"sasha",
"dll",
"spill"
],
"type": "string"
},
"cost": {
"description": "Costs associated with the storage and use of the plane",
"properties": {
"storageAtRest": {
"description": "Storage cost (GiB/month)",
"type": "number"
}
},
"type": "object"
},
"defaultSprayParts": {
"description": "Number of parts sprayed by default",
"type": "integer"
},
"forcePermissions": {
"type": "boolean"
},
"hostGroup": {
"description": "optional name of the host group (for bare metal storage)",
"type": "string"
},
"hosts": {
"description": "a list of host names",
"items": {
"type": "string"
},
"type": "array"
},
"includeDeviceInPath": {
"description": "is a directory based on the part number appended to the path. May not be needed",
"type": "boolean"
},
"name": {
"description": "the name of the storage plane",
"type": "string"
},
"numDevices": {
"description": "optional number of devices in the storage plane (default 1)",
"type": "integer"
},
"prefix": {
"description": "either the path for a local mount, or the url prefix",
"type": "string"
},
"pvc": {
"description": "optional name of the persistent volume claim for this plane",
"type": "string"
},
"replication": {
"description": "which planes (if any) the data is replicated onto (primarily bare metal)",
"items": {
"type": "string"
},
"type": "array"
},
"secret": {
"description": "optional name of any secret required to access this storage plane",
"type": "string"
},
"storageClass": {
"type": "string"
},
"storageMode": {
"type": "string"
},
"storageSize": {
"type": "string"
},
"subPath": {
"description": "optional subdirectory within the mount directory",
"type": "string"
},
"umask": {
"description": "file creation mask (used by despray)",
"type": "string"
}
},
"required": [
"name",
"prefix",
"category"
],
"type": "object"
},
"storagePlanes": {
"description": "storage plane definitions",
"items": {
"$ref": "#/definitions/storagePlane"
},
"type": "array"
},
"thor": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"dataPlane": {
"description": "The default storage plane to write data files to",
"type": "string"
},
"eclAgentReplicas": {
"description": "Number of eclagent replicas",
"minimum": 1,
"type": "integer"
},
"eclAgentResources": {
"$ref": "#/definitions/resources"
},
"eclAgentType": {
"description": "eclagent engine type",
"enum": [
"hthor",
"roxie"
]
},
"eclAgentUseChildProcesses": {
"description": "Use processes instead of pods per job (eclagent)",
"type": "boolean"
},
"env": {
"$ref": "#/definitions/env"
},
"expert": {
"description": "Custom internal options usually reserved for internal testing",
"type": "object"
},
"image": {
"$ref": "#/definitions/image"
},
"keepJobs": {
"description": "For debugging purposes. Choose whether to keep jobs after execution",
"enum": [
"none",
"podfailures",
"all"
]
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"lingerPeriod": {
"description": "[Optional] Seconds to keep Thor instance running, waiting for more graphs to execute",
"minimum": 1,
"type": "integer"
},
"logging": {
"$ref": "#/definitions/logging"
},
"managerResources": {
"$ref": "#/definitions/resources"
},
"maxGraphs": {
"description": "The maximum number of Thor graphs that be run concurrently",
"minimum": 1,
"type": "integer"
},
"maxJobs": {
"description": "The maximum number of jobs that can be run concurrenly",
"minimum": 1,
"type": "integer"
},
"multiJobLinger": {
"description": "[Optional] If lingerPeriod set, allows Thor to process more graphs from any job",
"type": "boolean"
},
"name": {
"description": "The name of the thor process",
"type": "string"
},
"numWorkers": {
"description": "The number of worker pods",
"minimum": 1,
"type": "integer"
},
"prefix": {
"description": "The (optional) file prefix to add to relative filenames",
"type": "string"
},
"spillPlane": {
"description": "The storage plane to write spill files to",
"type": "string"
},
"thorAgentReplicas": {
"description": "Number of thoragent replicas",
"minimum": 1,
"type": "integer"
},
"workerResources": {
"$ref": "#/definitions/resources"
}
},
"required": [
"name",
"maxJobs",
"maxGraphs"
],
"type": "object"
},
"toleration": {
"properties": {
"effect": {
"type": "string"
},
"key": {
"type": "string"
},
"operator": {
"type": "string"
},
"tolerationSeconds": {
"type": "integer"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"tolerations": {
"items": {
"$ref": "#/definitions/toleration"
},
"type": "array"
},
"toposerver": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"env": {
"$ref": "#/definitions/env"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"logging": {
"$ref": "#/definitions/logging"
},
"port": {
"type": "integer"
},
"replicas": {
"type": "integer"
},
"traceLevel": {
"type": "integer"
}
},
"type": "object"
},
"vault": {
"additionalProperties": false,
"description": "information about an individual vault",
"properties": {
"client-secret": {
"description": "optional name of kubernetes secret that will provide the vault client token",
"type": "string"
},
"kind": {
"enum": [
"kv-v2",
"kv-v1"
],
"type": "string"
},
"name": {
"description": "the name of the vault",
"type": "string"
},
"url": {
"description": "the url used to access the vault",
"type": "string"
}
},
"required": [
"name",
"url"
],
"type": "object"
},
"vaultCategory": {
"description": "set of vaults under a given category",
"oneOf": [
{
"items": {
"$ref": "#/definitions/vault"
},
"type": "array"
},
{
"type": "null"
}
]
}
},
"properties": {
"bundles": {
"description": "bundles",
"items": {
"$ref": "#/definitions/bundle"
},
"type": "array"
},
"certificates": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"issuers": {
"properties": {
"local": {
"$ref": "#/definitions/issuer"
},
"public": {
"$ref": "#/definitions/issuer"
}
},
"type": "object"
}
},
"type": "object"
},
"dali": {
"description": "dali process",
"items": {
"$ref": "#/definitions/dali"
},
"maxItems": 1,
"minItems": 1,
"type": "array"
},
"dfuserver": {
"description": "dfuserver process",
"items": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"disabled": {
"type": "boolean"
},
"env": {
"$ref": "#/definitions/env"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"maxJobs": {
"type": "integer"
},
"name": {
"description": "The name of the dfuserver process",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"eclagent": {
"description": "eclagent process",
"items": {
"allOf": [
{
"$ref": "#/definitions/eclagent"
},
{
"dataPlane": {
"description": "The default storage plane to write data files to",
"type": "string"
},
"name": {
"description": "The name of the eclagent process",
"type": "string"
},
"prefix": {
"description": "The (optional) file prefix to add to relative filenames",
"type": "string"
},
"required": [
"name"
],
"spillPlane": {
"description": "The storage plane to write spill files to",
"type": "string"
}
}
]
},
"type": "array"
},
"eclccserver": {
"description": "eclccserver process",
"items": {
"$ref": "#/definitions/eclccserver"
},
"type": "array"
},
"eclscheduler": {
"description": "eclscheduler process",
"items": {
"$ref": "#/definitions/eclscheduler"
},
"type": "array"
},
"esp": {
"description": "esp process",
"items": {
"$ref": "#/definitions/esp"
},
"type": "array"
},
"global": {
"$ref": "#/definitions/global"
},
"placements": {
"items": {
"properties": {
"placement": {
"$ref": "#/definitions/placement"
},
"pods": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
},
"roxie": {
"description": "roxie process",
"items": {
"$ref": "#/definitions/roxie"
},
"type": "array"
},
"sasha": {
"$ref": "#/definitions/sashaservice",
"description": "sasha services",
"type": "object"
},
"secrets": {
"additionalProperties": false,
"description": "configuration for secrets accessed by the components",
"properties": {
"authn": {
"$ref": "#/definitions/secrets"
},
"codeSign": {
"$ref": "#/definitions/secrets"
},
"codeVerify": {
"$ref": "#/definitions/secrets"
},
"ecl": {
"$ref": "#/definitions/secrets"
},
"storage": {
"$ref": "#/definitions/secrets"
},
"system": {
"$ref": "#/definitions/secrets"
},
"timeout": {
"type": "integer"
}
},
"type": "object"
},
"security": {
"$ref": "#/definitions/security"
},
"storage": {
"additionalProperties": false,
"properties": {
"hostGroups": {
"$ref": "#/definitions/hostGroups"
},
"planes": {
"$ref": "#/definitions/storagePlanes"
}
},
"type": "object"
},
"thor": {
"description": "thor process",
"items": {
"$ref": "#/definitions/thor"
},
"type": "array"
},
"vaults": {
"additionalProperties": false,
"description": "configuration for vaults accessed by the components",
"properties": {
"authn": {
"$ref": "#/definitions/vaultCategory"
},
"codeSign": {
"$ref": "#/definitions/vaultCategory"
},
"codeVerify": {
"$ref": "#/definitions/vaultCategory"
},
"ecl": {
"$ref": "#/definitions/vaultCategory"
},
"ecl-user": {
"$ref": "#/definitions/vaultCategory"
},
"esp": {
"$ref": "#/definitions/vaultCategory"
},
"storage": {
"$ref": "#/definitions/vaultCategory"
},
"timeout": {
"type": "integer"
}
},
"type": "object"
}
},
"required": [
"dali"
],
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
hpcc-systems/helm-chart | 6bf56749be9fe3f3d4473cb4a9acca1a91211f58 | 2021-10-27T14:31:24 | helm/hpcc/values.schema.json | 10 | 2024-05-28T04:25:31.595363Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"definitions": {
"auth": {
"description": "Authentication method",
"type": "string"
},
"authNZ": {
"additionalProperties": {
"type": [
"object"
]
},
"type": "object"
},
"bundle": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"name": {
"description": "The name of the bundle process",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"compileOption": {
"additionalProperties": false,
"properties": {
"cluster": {
"description": "Cluster to apply option to",
"type": "string"
},
"name": {
"description": "Compiler option name",
"type": "string"
},
"value": {
"description": "Compiler option value",
"type": [
"number",
"string",
"boolean"
]
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"dafilesrv": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"image": {
"$ref": "#/definitions/image"
},
"logging": {
"$ref": "#/definitions/logging"
},
"name": {
"description": "The name of the dafilesrv process",
"type": "string"
},
"parallelRequestLimit": {
"default": "20",
"type": "integer"
},
"replicas": {
"type": "integer"
},
"resources": {
"$ref": "#/definitions/resources"
},
"service": {
"$ref": "#/definitions/service"
}
},
"required": [
"name",
"service"
],
"type": "object"
},
"dali": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"auth": {
"$ref": "#/definitions/auth"
},
"env": {
"$ref": "#/definitions/env"
},
"image": {
"$ref": "#/definitions/image"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"ldap": {
"$ref": "#/definitions/ldap"
},
"logging": {
"$ref": "#/definitions/logging"
},
"maxStartupTime": {
"$ref": "#/definitions/maxStartupTime"
},
"minStartupTime": {
"$ref": "#/definitions/minStartupTime"
},
"name": {
"description": "The name of the dali process",
"type": "string"
},
"resources": {
"$ref": "#/definitions/resources"
},
"services": {
"$ref": "#/definitions/sashaservice",
"description": "sasha services",
"type": "object"
}
},
"required": [
"name",
"auth"
],
"type": "object"
},
"eclSecurity": {
"properties": {
"datafile": {
"$ref": "#/definitions/eclSecurityValues"
},
"embedded": {
"$ref": "#/definitions/eclSecurityValues"
},
"extern": {
"$ref": "#/definitions/eclSecurityValues"
},
"pipe": {
"$ref": "#/definitions/eclSecurityValues"
}
},
"type": "object"
},
"eclSecurityValues": {
"enum": [
"deny",
"allow",
"allowSigned"
],
"type": "string"
},
"eclagent": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"dataPlane": {
"description": "The default storage plane to write data files to",
"type": "string"
},
"env": {
"$ref": "#/definitions/env"
},
"image": {
"$ref": "#/definitions/image"
},
"jobMemory": {
"$ref": "#/definitions/memory"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"logging": {
"$ref": "#/definitions/logging"
},
"maxActive": {
"default": 100,
"description": "Maximum number of workunits that can be active simultaneously",
"minimum": 1,
"type": "integer"
},
"replicas": {
"type": "integer"
},
"resources": {
"$ref": "#/definitions/resources"
},
"type": {
"description": "Use the hthor or roxie execution engine for eclagent queries",
"enum": [
"hthor",
"roxie"
],
"type": "string"
},
"useChildProcesses": {
"description": "Launch each workunit as a child process rather than in its own container",
"type": "boolean"
}
},
"required": [
"maxActive"
],
"type": "object"
},
"eclccserver": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"env": {
"$ref": "#/definitions/env"
},
"image": {
"$ref": "#/definitions/image"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"listen": {
"items": {
"type": "string"
},
"type": "array"
},
"logging": {
"$ref": "#/definitions/logging"
},
"maxActive": {
"default": 4,
"description": "Maximum number of compile jobs that can be active simultaneously",
"minimum": 1,
"type": "integer"
},
"name": {
"description": "The name of the eclccserver process",
"type": "string"
},
"options": {
"items": {
"$ref": "#/definitions/compileOption"
},
"type": "array"
},
"replicas": {
"type": "integer"
},
"resources": {
"$ref": "#/definitions/resources"
},
"useChildProcesses": {
"description": "Launch each workunit compile as a child process rather than in its own container",
"type": "boolean"
}
},
"required": [
"name",
"maxActive"
],
"type": "object"
},
"eclscheduler": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"env": {
"$ref": "#/definitions/env"
},
"image": {
"$ref": "#/definitions/image"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"logging": {
"$ref": "#/definitions/logging"
},
"name": {
"description": "The name of the eclccserver process",
"type": "string"
},
"resources": {
"$ref": "#/definitions/resources"
}
},
"required": [
"name"
],
"type": "object"
},
"egress": {
"additionalProperties": false,
"properties": {
"kubeApiCidr": {
"description": "IP range for kubectl API service",
"type": "string"
},
"kubeApiPort": {
"description": "Port used for connections to kubectl API",
"type": "integer"
},
"kubeSystemLabel": {
"description": "Label that has been applied to the kube-system namespace, used to restrict DNS service calls on port 53 to pods in the kube-system namespace",
"type": "string"
},
"restricted": {
"description": "Are any egress controls applied",
"type": "boolean"
}
},
"type": "object"
},
"env": {
"items": {
"properties": {
"name": {
"description": "Environment variable name",
"type": "string"
},
"value": {
"description": "Environment variable value",
"type": [
"number",
"string",
"boolean"
]
}
},
"type": "object"
},
"type": "array"
},
"esp": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"auth": {
"$ref": "#/definitions/auth"
},
"authNZ": {
"$ref": "#/definitions/authNZ"
},
"env": {
"$ref": "#/definitions/env"
},
"image": {
"$ref": "#/definitions/image"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"ldap": {
"$ref": "#/definitions/ldap"
},
"logging": {
"$ref": "#/definitions/logging"
},
"name": {
"description": "The name of the esp process",
"type": "string"
},
"replicas": {
"type": "integer"
},
"resources": {
"$ref": "#/definitions/resources"
},
"service": {
"$ref": "#/definitions/service"
}
},
"required": [
"name",
"service",
"auth"
],
"type": "object"
},
"global": {
"additionalProperties": false,
"properties": {
"cost": {
"description": "resource cost",
"properties": {
"currencyCode": {
"description": "currency code (ISO 4217)",
"maxLength": 3,
"type": "string"
},
"perCpu": {
"description": "cost of a single cpu",
"type": "number"
},
"storageAtRest": {
"description": "storage cost (GiB per month)",
"type": "number"
},
"storageReads": {
"description": "cost per 10,000 read operations",
"type": "number"
},
"storageWrites": {
"description": "cost per 10,000 write operations",
"type": "number"
}
},
"type": "object"
},
"defaultDataPath": {
"type": "string"
},
"defaultEsp": {
"type": "string"
},
"defaultMirrorPath": {
"type": "string"
},
"egress": {
"$ref": "#/definitions/egress"
},
"env": {
"$ref": "#/definitions/env"
},
"image": {
"$ref": "#/definitions/image"
},
"logging": {
"$ref": "#/definitions/logging"
},
"metrics": {
"description": "Global metrics configuration",
"properties": {
"sinks": {
"$ref": "#/definitions/sinks"
}
},
"type": "object"
},
"misc": {
"description": "Miscellaneous settings",
"oneOf": [
{
"properties": {
"postJobCommand": {
"description": "Execute this command when a K8s Job launched by a deployment ends, either gracefully or when terminated externally causing a preStop event",
"type": "string"
},
"postJobCommandViaSidecar": {
"description": "Causes shareProcessNamespace to be enabled, and the postJobCommand to execute via a sidecar",
"type": "boolean"
}
},
"type": "object"
},
{
"type": "null"
}
]
},
"noResourceValidation": {
"type": "boolean"
},
"privileged": {
"type": "boolean"
},
"stubInstanceResources": {
"$ref": "#/definitions/stubInstanceResources"
},
"visibilities": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"ingress": {
"$ref": "#/definitions/ingress"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"description": "Global visibilities configuration",
"type": "object"
}
},
"type": "object"
},
"hostGroup": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"name",
"hosts"
]
},
{
"required": [
"name",
"hostGroup"
]
}
],
"properties": {
"count": {
"description": "Number of hosts in the subset",
"type": "integer"
},
"delta": {
"description": "Cycle offset to apply to the hosts",
"type": "integer"
},
"hostGroup": {
"description": "Name of the hostgroup to create a subset of",
"type": "string"
},
"hosts": {
"description": "a list of host names",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "The name of the host group process",
"type": "string"
},
"offset": {
"description": "Offset of the first host within the group",
"type": "integer"
}
},
"type": "object"
},
"hostGroups": {
"oneOf": [
{
"items": {
"$ref": "#/definitions/hostGroup"
},
"type": "array"
},
{
"type": "null"
}
]
},
"image": {
"additionalProperties": false,
"properties": {
"name": {
"default": "platform-core",
"type": "string"
},
"pullPolicy": {
"enum": [
"IfNotPresent",
"Always",
"Never"
],
"type": "string"
},
"root": {
"default": "hpccsystems",
"type": "string"
},
"version": {
"type": "string"
}
},
"type": "object"
},
"ingress": {
"items": {
"additionalProperties": {
"items": {
"type": "object"
},
"type": "array"
}
},
"type": "array"
},
"issuer": {
"properties": {
"kind": {
"enum": [
"Issuer",
"ClusterIssuer"
],
"type": "string"
},
"name": {
"description": "The name of the issuer which will be referenced in certificate objects",
"type": "string"
},
"spec": {
"description": "The cert-manager spec for the issuer. Should match issuer spec(s) defined by https://cert-manager.io/docs/configuration/",
"type": "object"
}
},
"required": [
"name"
],
"type": "object"
},
"ldap": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"adminGroupName": {
"description": "The Active Directory group containing HPCC Administrators",
"type": "string"
},
"cacheTimeout": {
"description": "Time in minutes after which the cached security information should be reloaded",
"type": "integer"
},
"checkScopeScans": {
"description": "Only return iterated logical file metadata for files that user has scope permission to access",
"type": "boolean"
},
"description": {
"description": "Description of this Active Directory Server component",
"type": "string"
},
"filesBasedn": {
"description": "The base distinguished name that should be used when looking up HPCC file scopes on the Active Directory server",
"type": "string"
},
"groupsBasedn": {
"description": "The base distinguished name that should be used when looking up HPCC groups on the Active Directory server",
"type": "string"
},
"ldapAddress": {
"description": "LDAP Server IP address(es), comma separated",
"type": "string"
},
"ldapAdminSecretKey": {
"description": "The key name to be used to look up the Active Directory Administrator account Username/Password",
"type": "string"
},
"ldapAdminVaultId": {
"description": "The optional vault name to be used to look up the Active Directory Administrator account Username/Password, using ldapAdminSecretKey",
"type": "string"
},
"ldapPort": {
"description": "The port of the nonsecure Active Directory server",
"type": "integer"
},
"ldapProtocol": {
"description": "The protocol to use - standard \"LDAP\" or secure \"LDAPS\" over SSL",
"type": "string"
},
"ldapSecurePort": {
"description": "The secure port of the secure Active Directory server",
"type": "integer"
},
"ldapTimeoutSecs": {
"description": "The maximum number of seconds to wait for most Active Directory calls",
"type": "integer"
},
"maxConnections": {
"description": "The maximum number of concurrent LDAP connections to the Active Directory server (default 10)",
"type": "integer"
},
"passwordExpirationWarningDays": {
"description": "Within this time period, ECLWatch displays a warning about pending password expiration",
"type": "integer"
},
"resourcesBasedn": {
"description": "The base distinguished name that should be used when looking up HPCC feature resources on the Active Directory server",
"type": "string"
},
"servertype": {
"description": "LDAP Server Implementation Type (\"ActiveDirectory\", \"AzureActiveDirectory\")",
"type": "string"
},
"sharedCache": {
"description": "Use a single, shared LDAP cache",
"type": "boolean"
},
"systemBasedn": {
"description": "The base distinguished name of the Active Directory Administrator",
"type": "string"
},
"usersBasedn": {
"description": "The base distinguished name that should be used when looking up HPCC users on the Active Directory server",
"type": "string"
},
"workunitsBasedn": {
"description": "The base distinguished name that should be used when looking up workunit scopes on the Active Directory server",
"type": "string"
}
},
"required": [
"ldapAddress"
],
"type": "object"
},
"logging": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"audiences": {
"description": "List of target audiences to include in logging output. Comprised of 3 letter codes delimited by + or -",
"type": "string"
},
"classes": {
"description": "List of target logging classes to include in output. Comprised of 3 letter codes delimited by + or -",
"type": "string"
},
"detail": {
"description": "Log output verbosity",
"type": "integer"
}
},
"type": "object"
},
"maxStartupTime": {
"description": "The time to wait before startup probing fails (in seconds). Default 300",
"type": "integer"
},
"memory": {
"additionalProperties": false,
"properties": {
"maxMemPercentage": {
"description": "The default maximum percentage of resource memory to dedicate to HPCC",
"type": "number"
},
"query": {
"description": "The amount of overall resourced memory to dedicate to the query",
"type": "string"
},
"thirdParty": {
"description": "The amount of overall resource memory to reserve for 3rd party use",
"type": "string"
}
},
"type": "object"
},
"minStartupTime": {
"description": "The time to wait before initiating startup probing (in seconds). Default 0",
"type": "integer"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"placement": {
"properties": {
"affinity": {
"type": "object"
},
"nodeSelector": {
"$ref": "#/definitions/nodeSelector"
},
"schedulerName": {
"type": "string"
},
"tolerations": {
"$ref": "#/definitions/tolerations"
},
"topologySpreadConstraints": {
"items": {
"$ref": "#/definitions/topologySpreadConstraint"
},
"type": "array"
}
},
"type": "object"
},
"resources": {
"type": "object"
},
"roxie": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"channelResources": {
"$ref": "#/definitions/resources"
},
"dataPlane": {
"description": "The default storage plane to write data files to",
"type": "string"
},
"directAccessPlanes": {
"description": "A list of storage planes suitable for roxie to read from directly and not have roxie copy the data to roxie's default plane",
"items": {
"type": "string"
},
"type": "array"
},
"env": {
"$ref": "#/definitions/env"
},
"image": {
"$ref": "#/definitions/image"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"logging": {
"$ref": "#/definitions/logging"
},
"maxStartupTime": {
"$ref": "#/definitions/maxStartupTime"
},
"minStartupTime": {
"$ref": "#/definitions/minStartupTime"
},
"name": {
"description": "The name of the roxie process",
"type": "string"
},
"prefix": {
"description": "The (optional) file prefix to add to relative filenames",
"type": "string"
},
"preload": {
"description": "Preloaded plugins",
"items": {
"type": "string"
},
"type": "array"
},
"serverResources": {
"$ref": "#/definitions/resources"
},
"services": {
"description": "Roxie query services",
"items": {
"$ref": "#/definitions/roxieservice"
},
"type": "array"
},
"spillPlane": {
"description": "The storage plane to write spill files to",
"type": "string"
},
"topoServer": {
"$ref": "#/definitions/toposerver"
}
},
"required": [
"name"
],
"type": "object"
},
"roxieservice": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"ingress": {
"$ref": "#/definitions/ingress"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"listenQueue": {
"type": "integer"
},
"name": {
"type": "string"
},
"numThreads": {
"type": "integer"
},
"port": {
"description": "The local port used by the pod (same as servicePort if not specified)",
"type": "integer"
},
"servicePort": {
"description": "The port that this service will be exposed on",
"type": "integer"
},
"visibility": {
"description": "Should this service be exposed outside the cluster, locally or to the internet",
"type": "string"
}
},
"required": [
"name",
"servicePort"
],
"type": "object"
},
"sasha-coalescer": {
"oneOf": [
{
"allOf": [
{
"$ref": "#/definitions/sashacommon"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"at": {},
"disabled": {},
"env": {},
"image": {},
"interval": {},
"labels": {},
"minDeltaSize": {
"description": "Coalescing will only begin, if the delta size is above this threshold (K)",
"type": "integer"
},
"plane": {},
"resources": {},
"service": {},
"throttle": {}
}
}
],
"type": "object"
},
{
"type": "null"
}
]
},
"sasha-dfurecovery-archiver": {
"oneOf": [
{
"allOf": [
{
"$ref": "#/definitions/sashacommon"
},
{
"$ref": "#/definitions/sasha-limitcutoff"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"at": {},
"cutoff": {},
"disabled": {},
"env": {},
"image": {},
"interval": {},
"labels": {},
"limit": {},
"plane": {},
"resources": {},
"service": {},
"throttle": {}
}
}
],
"type": "object"
},
{
"type": "null"
}
]
},
"sasha-dfuwu-archiver": {
"oneOf": [
{
"allOf": [
{
"$ref": "#/definitions/sashacommon"
},
{
"$ref": "#/definitions/sasha-limitcutoff"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"at": {},
"cutoff": {},
"disabled": {},
"env": {},
"image": {},
"interval": {},
"labels": {},
"limit": {},
"plane": {},
"resources": {},
"service": {},
"throttle": {}
}
}
],
"required": [
"plane"
],
"type": "object"
},
{
"type": "null"
}
]
},
"sasha-file-expiry": {
"oneOf": [
{
"additionalProperties": false,
"allOf": [
{
"$ref": "#/definitions/sashacommon"
}
],
"properties": {
"annotations": {},
"at": {},
"disabled": {},
"expiryDefault": {
"default": "14",
"description": "Default number of days to delete unused standard files that are flagged with EXPIRY",
"type": "integer"
},
"image": {},
"interval": {},
"labels": {},
"persistExpiryDefault": {
"default": "7",
"description": "Default number of days to delete unused persist files",
"type": "integer"
},
"plane": {},
"resources": {},
"service": {},
"throttle": {},
"user": {
"description": "A username authorized to access and remove expired files",
"type": "string"
}
},
"type": "object"
},
{
"type": "null"
}
]
},
"sasha-limitcutoff": {
"properties": {
"cutoff": {
"default": "4",
"description": "minimum age (days)",
"type": "integer"
},
"limit": {
"default": "20",
"description": "threshold before removal starts (0 disables)",
"type": "integer"
}
},
"type": "object"
},
"sasha-wu-archiver": {
"oneOf": [
{
"allOf": [
{
"$ref": "#/definitions/sashacommon"
},
{
"$ref": "#/definitions/sasha-limitcutoff"
},
{
"additionalProperties": false,
"properties": {
"annotations": {},
"at": {},
"backup": {
"default": "0",
"description": "minimum workunit age to backup (days, 0 disables)",
"type": "integer"
},
"cutoff": {},
"disabled": {},
"duration": {
"default": "0",
"description": "Maximum duration to run WorkUnit archiving session (hours, 0 unlimited)",
"type": "integer"
},
"env": {},
"image": {},
"interval": {},
"keepResultFiles": {
"default": "false",
"description": "option to keep result files owned by workunits after workunit is archived",
"type": "boolean"
},
"labels": {},
"limit": {},
"plane": {},
"resources": {},
"retryinterval": {
"default": "7",
"description": "minimal time before retrying archive of failed WorkUnits (days)",
"type": "integer"
},
"service": {},
"throttle": {}
}
}
],
"required": [
"plane"
],
"type": "object"
},
{
"type": "null"
}
]
},
"sashacommon": {
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"at": {
"default": "* * * * *",
"type": "string"
},
"disabled": {
"type": "boolean"
},
"env": {
"$ref": "#/definitions/env"
},
"image": {
"$ref": "#/definitions/image"
},
"interval": {
"default": 1,
"type": "integer"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"plane": {
"description": "which storage plane to store the sasha data on",
"type": "string"
},
"resources": {
"$ref": "#/definitions/resources"
},
"service": {
"description": "Service properties",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"port": {
"default": 8880,
"description": "The local port used by the pod",
"type": "integer"
},
"servicePort": {
"description": "The port that this service will be exposed on",
"type": "integer"
}
},
"required": [
"servicePort"
],
"type": "object"
},
"throttle": {
"description": "throttle ratio percentage (0-99, 0 no throttling, 50 is half speed)",
"type": "integer"
}
},
"type": "object"
},
"sashaservice": {
"oneOf": [
{
"additionalProperties": false,
"description": "sasha services",
"properties": {
"coalescer": {
"$ref": "#/definitions/sasha-coalescer"
},
"dfurecovery-archiver": {
"$ref": "#/definitions/sasha-dfurecovery-archiver"
},
"dfuwu-archiver": {
"$ref": "#/definitions/sasha-dfuwu-archiver"
},
"disabled": {
"type": "boolean"
},
"file-expiry": {
"$ref": "#/definitions/sasha-file-expiry"
},
"wu-archiver": {
"$ref": "#/definitions/sasha-wu-archiver"
}
},
"type": "object"
},
{
"type": "null"
}
]
},
"secrets": {
"oneOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
]
},
"security": {
"properties": {
"eclSecurity": {
"$ref": "#/definitions/eclSecurity"
},
"mtls": {
"default": true,
"description": "enable global mtls between clients (except roxie which has own setting). NB: requires certificates.enabled=true",
"type": "boolean"
}
},
"type": "object"
},
"service": {
"description": "Service properties",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"ingress": {
"$ref": "#/definitions/ingress"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"port": {
"default": 8880,
"description": "The local port used by the pod",
"type": "integer"
},
"servicePort": {
"description": "The port that this service will be exposed on",
"type": "integer"
},
"visibility": {
"description": "Should this service be exposed outside the cluster, locally or to the internet",
"type": "string"
}
},
"required": [
"servicePort",
"visibility"
],
"type": "object"
},
"sink": {
"description": "Definition of a metric sink",
"properties": {
"name": {
"description": "Name for the sink, must be unique for the component",
"type": "string"
},
"settings": {
"description": "Settings specific to the sink",
"type": "object"
},
"type": {
"description": "The defined metric sink type",
"type": "string"
}
},
"required": [
"type",
"name"
],
"type": "object"
},
"sinks": {
"items": {
"$ref": "#/definitions/sink"
},
"type": "array"
},
"storagePlane": {
"additionalProperties": false,
"description": "information about an individual storage plane",
"properties": {
"category": {
"description": "the category this plane is usd for, e.g. lz, data",
"enum": [
"data",
"lz",
"dali",
"sasha",
"dll",
"spill"
],
"type": "string"
},
"cost": {
"description": "Costs associated with the storage and use of the plane",
"properties": {
"storageAtRest": {
"description": "Storage cost (GiB/month)",
"type": "number"
}
},
"type": "object"
},
"defaultSprayParts": {
"description": "Number of parts sprayed by default",
"type": "integer"
},
"forcePermissions": {
"type": "boolean"
},
"hostGroup": {
"description": "optional name of the host group (for bare metal storage)",
"type": "string"
},
"hosts": {
"description": "a list of host names",
"items": {
"type": "string"
},
"type": "array"
},
"includeDeviceInPath": {
"description": "is a directory based on the part number appended to the path. May not be needed",
"type": "boolean"
},
"name": {
"description": "the name of the storage plane",
"type": "string"
},
"numDevices": {
"description": "optional number of devices in the storage plane (default 1)",
"type": "integer"
},
"prefix": {
"description": "either the path for a local mount, or the url prefix",
"type": "string"
},
"pvc": {
"description": "optional name of the persistent volume claim for this plane",
"type": "string"
},
"replication": {
"description": "which planes (if any) the data is replicated onto (primarily bare metal)",
"items": {
"type": "string"
},
"type": "array"
},
"secret": {
"description": "optional name of any secret required to access this storage plane",
"type": "string"
},
"storageClass": {
"type": "string"
},
"storageMode": {
"type": "string"
},
"storageSize": {
"type": "string"
},
"subDirPerFilePart": {
"default": true,
"description": "Place each logical file part in its own subdirectory",
"type": "boolean"
},
"subPath": {
"description": "optional subdirectory within the mount directory",
"type": "string"
},
"umask": {
"description": "file creation mask (used by despray)",
"type": "string"
}
},
"required": [
"name",
"prefix",
"category"
],
"type": "object"
},
"storagePlanes": {
"description": "storage plane definitions",
"items": {
"$ref": "#/definitions/storagePlane"
},
"type": "array"
},
"stubInstanceResources": {
"description": "resource definitions per instance for stub components",
"properties": {
"additionalProperties": false,
"cpu": {
"default": "50m",
"description": "default per stub instance milli cpu requirements",
"type": "string"
},
"memory": {
"default": "200Mi",
"description": "default per stub instance memory requirements",
"type": "string"
}
},
"type": "object"
},
"thor": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"dataPlane": {
"description": "The default storage plane to write data files to",
"type": "string"
},
"eclAgentMemory": {
"$ref": "#/definitions/memory"
},
"eclAgentReplicas": {
"description": "Number of eclagent replicas",
"minimum": 1,
"type": "integer"
},
"eclAgentResources": {
"$ref": "#/definitions/resources"
},
"eclAgentType": {
"description": "eclagent engine type",
"enum": [
"hthor",
"roxie"
]
},
"eclAgentUseChildProcesses": {
"description": "Use processes instead of pods per job (eclagent)",
"type": "boolean"
},
"env": {
"$ref": "#/definitions/env"
},
"expert": {
"description": "Custom internal options usually reserved for internal testing",
"type": "object"
},
"image": {
"$ref": "#/definitions/image"
},
"keepJobs": {
"description": "For debugging purposes. Choose whether to keep jobs after execution",
"enum": [
"none",
"podfailures",
"all"
]
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"lingerPeriod": {
"description": "[Optional] Seconds to keep Thor instance running, waiting for more graphs to execute",
"minimum": 1,
"type": "integer"
},
"logging": {
"$ref": "#/definitions/logging"
},
"managerMemory": {
"$ref": "#/definitions/memory"
},
"managerResources": {
"$ref": "#/definitions/resources"
},
"maxGraphs": {
"description": "The maximum number of Thor graphs that be run concurrently",
"minimum": 1,
"type": "integer"
},
"maxJobs": {
"description": "The maximum number of jobs that can be run concurrenly",
"minimum": 1,
"type": "integer"
},
"multiJobLinger": {
"description": "[Optional] If lingerPeriod set, allows Thor to process more graphs from any job",
"type": "boolean"
},
"name": {
"description": "The name of the thor process",
"type": "string"
},
"numWorkers": {
"description": "The number of worker pods",
"minimum": 1,
"type": "integer"
},
"prefix": {
"description": "The (optional) file prefix to add to relative filenames",
"type": "string"
},
"spillPlane": {
"description": "The storage plane to write spill files to",
"type": "string"
},
"thorAgentReplicas": {
"description": "Number of thoragent replicas",
"minimum": 1,
"type": "integer"
},
"workerMemory": {
"$ref": "#/definitions/memory"
},
"workerResources": {
"$ref": "#/definitions/resources"
}
},
"required": [
"name",
"maxJobs",
"maxGraphs"
],
"type": "object"
},
"toleration": {
"properties": {
"effect": {
"type": "string"
},
"key": {
"type": "string"
},
"operator": {
"type": "string"
},
"tolerationSeconds": {
"type": "integer"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"tolerations": {
"items": {
"$ref": "#/definitions/toleration"
},
"type": "array"
},
"topologySpreadConstraint": {
"properties": {
"labelSelector": {
"description": "labelSelector is used to find matching Pods",
"type": "object"
},
"maxSkew": {
"description": "describes the degree to which Pods may be unevenly distributed. It must be greater than zero",
"type": "integer"
},
"topologyKey": {
"description": "is the key of node labels",
"type": "string"
},
"whenUnsatisfiable": {
"description": "indicates how to deal with a Pod if it doesn't satisfy the spread constraint",
"enum": [
"DoNotSchedule",
"ScheduleAnyway"
],
"type": "string"
}
},
"type": "object"
},
"toposerver": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"env": {
"$ref": "#/definitions/env"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"logging": {
"$ref": "#/definitions/logging"
},
"port": {
"type": "integer"
},
"replicas": {
"type": "integer"
},
"traceLevel": {
"type": "integer"
}
},
"type": "object"
},
"vault": {
"additionalProperties": false,
"description": "information about an individual vault",
"properties": {
"client-secret": {
"description": "optional name of kubernetes secret that will provide the vault client token",
"type": "string"
},
"kind": {
"enum": [
"kv-v2",
"kv-v1"
],
"type": "string"
},
"name": {
"description": "the name of the vault",
"type": "string"
},
"url": {
"description": "the url used to access the vault",
"type": "string"
}
},
"required": [
"name",
"url"
],
"type": "object"
},
"vaultCategory": {
"description": "set of vaults under a given category",
"oneOf": [
{
"items": {
"$ref": "#/definitions/vault"
},
"type": "array"
},
{
"type": "null"
}
]
}
},
"properties": {
"bundles": {
"description": "bundles",
"items": {
"$ref": "#/definitions/bundle"
},
"type": "array"
},
"certificates": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"issuers": {
"properties": {
"local": {
"$ref": "#/definitions/issuer"
},
"public": {
"$ref": "#/definitions/issuer"
}
},
"type": "object"
}
},
"type": "object"
},
"dafilesrv": {
"description": "dafilesrv process",
"items": {
"$ref": "#/definitions/dafilesrv"
},
"type": "array"
},
"dali": {
"description": "dali process",
"items": {
"$ref": "#/definitions/dali"
},
"maxItems": 1,
"minItems": 1,
"type": "array"
},
"dfuserver": {
"description": "dfuserver process",
"items": {
"additionalProperties": {
"type": [
"integer",
"string",
"boolean"
]
},
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"disabled": {
"type": "boolean"
},
"env": {
"$ref": "#/definitions/env"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"maxJobs": {
"type": "integer"
},
"name": {
"description": "The name of the dfuserver process",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"eclagent": {
"description": "eclagent process",
"items": {
"allOf": [
{
"$ref": "#/definitions/eclagent"
},
{
"dataPlane": {
"description": "The default storage plane to write data files to",
"type": "string"
},
"name": {
"description": "The name of the eclagent process",
"type": "string"
},
"prefix": {
"description": "The (optional) file prefix to add to relative filenames",
"type": "string"
},
"required": [
"name"
],
"spillPlane": {
"description": "The storage plane to write spill files to",
"type": "string"
}
}
]
},
"type": "array"
},
"eclccserver": {
"description": "eclccserver process",
"items": {
"$ref": "#/definitions/eclccserver"
},
"type": "array"
},
"eclscheduler": {
"description": "eclscheduler process",
"items": {
"$ref": "#/definitions/eclscheduler"
},
"type": "array"
},
"esp": {
"description": "esp process",
"items": {
"$ref": "#/definitions/esp"
},
"type": "array"
},
"global": {
"$ref": "#/definitions/global"
},
"placements": {
"items": {
"properties": {
"placement": {
"$ref": "#/definitions/placement"
},
"pods": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
},
"roxie": {
"description": "roxie process",
"items": {
"$ref": "#/definitions/roxie"
},
"type": "array"
},
"sasha": {
"$ref": "#/definitions/sashaservice",
"description": "sasha services",
"type": "object"
},
"secrets": {
"additionalProperties": false,
"description": "configuration for secrets accessed by the components",
"properties": {
"authn": {
"$ref": "#/definitions/secrets"
},
"codeSign": {
"$ref": "#/definitions/secrets"
},
"codeVerify": {
"$ref": "#/definitions/secrets"
},
"ecl": {
"$ref": "#/definitions/secrets"
},
"storage": {
"$ref": "#/definitions/secrets"
},
"system": {
"$ref": "#/definitions/secrets"
},
"timeout": {
"type": "integer"
}
},
"type": "object"
},
"security": {
"$ref": "#/definitions/security"
},
"storage": {
"additionalProperties": false,
"properties": {
"hostGroups": {
"$ref": "#/definitions/hostGroups"
},
"planes": {
"$ref": "#/definitions/storagePlanes"
}
},
"type": "object"
},
"thor": {
"description": "thor process",
"items": {
"$ref": "#/definitions/thor"
},
"type": "array"
},
"vaults": {
"additionalProperties": false,
"description": "configuration for vaults accessed by the components",
"properties": {
"authn": {
"$ref": "#/definitions/vaultCategory"
},
"codeSign": {
"$ref": "#/definitions/vaultCategory"
},
"codeVerify": {
"$ref": "#/definitions/vaultCategory"
},
"ecl": {
"$ref": "#/definitions/vaultCategory"
},
"ecl-user": {
"$ref": "#/definitions/vaultCategory"
},
"esp": {
"$ref": "#/definitions/vaultCategory"
},
"storage": {
"$ref": "#/definitions/vaultCategory"
},
"timeout": {
"type": "integer"
}
},
"type": "object"
}
},
"required": [
"dali"
],
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
ebu/ebu-adm-toolbox | 974d211eb086e262e81f5b1d777cf2595c92be5a | 2023-01-27T12:57:43 | data/schemas/ports.schema.json | 5 | 2024-05-27T07:22:24.827007Z | {
"$id": "https://ebu.ch/ear-adm-toolbox/schemas/ports",
"$schema": "https://json-schema.org/draft-07/schema#",
"description": "Configuration describing process ports that should be automatically connected in an EAT graph",
"properties": {
"in_ports": {
"description": "A list of input ports for this processor that should be automatically connected in the processing graph",
"type": "array"
},
"out_ports": {
"description": "A list of output ports for this processor that should be automatically connected in the processing graph",
"type": "array"
}
},
"title": "ports",
"type": "object"
} | Apache-2.0 | en |
ebu/ebu-adm-toolbox | 974d211eb086e262e81f5b1d777cf2595c92be5a | 2023-01-27T12:57:43 | data/schemas/rewrite_content_objects_emission.schema.json | 5 | 2024-05-27T07:22:24.827007Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"parameters": {
"properties": {
"max_object_depth": {
"type": "integer"
}
},
"type": "object"
},
"type": {
"const": "rewrite_content_objects_emission",
"type": "string"
}
},
"title": "configuration for the rewrite_content_objects_emission process",
"type": "object"
} | Apache-2.0 | en |
ebu/ebu-adm-toolbox | 974d211eb086e262e81f5b1d777cf2595c92be5a | 2023-01-27T12:57:43 | data/schemas/resample_blocks.schema.json | 5 | 2024-05-27T07:22:24.827007Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"parameters": {
"properties": {
"min_duration": {
"description": "The minimum block duration after resampling, specified in ADM time format",
"type": "string"
}
},
"type": "object"
},
"type": {
"const": "resample_blocks"
}
},
"title": "configuration for the resample_blocks process",
"type": "object"
} | Apache-2.0 | en |
ebu/ebu-adm-toolbox | 974d211eb086e262e81f5b1d777cf2595c92be5a | 2023-01-27T12:57:43 | data/schemas/limit_interaction.schema.json | 5 | 2024-05-27T07:22:24.827007Z | {
"$defs": {
"constraint": {
"additionalProperties": false,
"description": "A constraint to clamp a value between a minimum and/or maximum",
"properties": {
"max": {
"type": "number"
},
"min": {
"type": "number"
}
},
"type": "object"
},
"gain": {
"additionalProperties": false,
"description": "An audio gain described as a linear value, or a value in decibels",
"properties": {
"gain": {
"description": "The value of the gain",
"type": "number"
},
"unit": {
"description": "The unit in which the gain is represented",
"enum": [
"dB",
"linear"
]
}
},
"required": [
"gain"
],
"type": "object"
},
"gain_constraint": {
"additionalProperties": false,
"description": "A constraint to clamp a gain value between a minimum and/or maximum",
"properties": {
"max": {
"$ref": "#/$defs/gain"
},
"min": {
"$ref": "#/$defs/gain"
}
},
"type": "object"
},
"gain_range_constraint": {
"additionalProperties": false,
"description": "A definition of a constraint on a gain range, describing the allowed values of the ranges minimum and maximum limits",
"properties": {
"max": {
"$ref": "#/$defs/gain_constraint"
},
"min": {
"$ref": "#/$defs/gain_constraint"
},
"permitted": {
"description": "Whether this range should be present in the output ADM",
"type": "boolean"
}
},
"type": "object"
},
"range_constraint": {
"description": "A definition of a constraint on a range, describing the allowed values of the ranges minimum and maximum limits",
"oneOf": [
{
"additionalProperties": false,
"properties": {
"max": {
"$ref": "#/$defs/constraint"
},
"min": {
"$ref": "#/$defs/constraint"
},
"permitted": {
"const": true,
"description": "Whether this range should be present in the output ADM"
}
},
"required": [
"permitted"
]
},
{
"additionalProperties": false,
"properties": {
"permitted": {
"const": false,
"description": "Whether this range should be present in the output ADM"
}
},
"required": [
"permitted"
]
}
],
"type": "object"
}
},
"$id": "https://ebu.ch/ear-adm-toolbox/schemas/limit_interaction",
"$schema": "https://json-schema.org/draft-07/schema#",
"description": "Configuration for the EAT limit_interaction processor",
"properties": {
"in_ports": {
"items": {
"enum": [
"in_axml"
],
"maxItems": 1,
"minItems": 0
}
},
"out_ports": {
"items": {
"enum": [
"out_axml"
],
"maxItems": 1,
"minItems": 0
}
},
"parameters": {
"additionalProperties": false,
"properties": {
"disable_interaction_type": {
"description": "A list of interaction types to remove from the output ADM",
"items": {
"enum": [
"position",
"gain",
"onOff"
]
},
"type": "array",
"uniqueItems": true
},
"gain_range": {
"$ref": "#/$defs/gain_range_constraint",
"description": "The constraints to be applied to the permitted limits of Gain interaction"
},
"position_range": {
"additionalProperties": false,
"description": "The constraints to be applied to the the Position ADM attributes of the interactionRange Property",
"properties": {
"X": {
"$ref": "#/$defs/range_constraint",
"description": "The constraints to be applied to the permitted limits of X interaction"
},
"Y": {
"$ref": "#/$defs/range_constraint",
"description": "The constraints to be applied to the permitted limits of Y interaction"
},
"Z": {
"$ref": "#/$defs/range_constraint",
"description": "The constraints to be applied to the permitted limits of Z interaction"
},
"azimuth": {
"$ref": "#/$defs/range_constraint",
"description": "The constraints to be applied to the permitted limits of azimuth interaction"
},
"distance": {
"$ref": "#/$defs/range_constraint",
"description": "The constraints to be applied to the permitted limits of distance interaction"
},
"elevation": {
"$ref": "#/$defs/range_constraint",
"description": "The constraints to be applied to the permitted limits of elevation interaction"
}
}
},
"remove_disabled_ranges": {
"description": "Whether to remove InteractionRanges if the associated interaction type is disabled",
"type": "boolean"
}
},
"type": "object"
},
"type": {
"const": "limit_interaction",
"type": "string"
}
},
"title": "limit_interaction",
"type": "object"
} | Apache-2.0 | en |
ebu/ebu-adm-toolbox | 974d211eb086e262e81f5b1d777cf2595c92be5a | 2023-01-27T12:57:43 | data/schemas/config.schema.json | 5 | 2024-05-27T07:22:24.827007Z | {
"$id": "https://ebu.ch/ear-adm-toolbox/schemas/config",
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"connections": {
"description": "A list of additional connections to be applied to the graph",
"items": {
"description": "A connection from the first named port to the second named port",
"items": {
"type": "string"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"type": "array"
},
"processes": {
"description": "A list of processes to be added to the graph",
"items": {
"allOf": [
{
"$ref": "process.schema.json"
},
{
"$ref": "ports.schema.json"
},
{
"$ref": "processes.schema.json"
}
],
"type": "object"
},
"type": "array"
},
"version": {
"description": "The config schema version",
"type": "integer"
}
},
"title": "ADM Toolbox process graph configuration",
"type": "object"
} | Apache-2.0 | en |
ebu/ebu-adm-toolbox | 974d211eb086e262e81f5b1d777cf2595c92be5a | 2023-01-27T12:57:43 | data/schemas/set_profiles.schema.json | 5 | 2024-05-27T07:22:24.827007Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"parameters": {
"properties": {
"profiles": {
"description": "an array of profile objects",
"items": {
"$ref": "profile.schema.json"
},
"type": "array"
}
},
"type": "object"
},
"type": {
"const": "set_profiles",
"type": "string"
}
},
"title": "set_profiles process configuration",
"type": "object"
} | Apache-2.0 | en |
ebu/ebu-adm-toolbox | 974d211eb086e262e81f5b1d777cf2595c92be5a | 2023-01-27T12:57:43 | data/schemas/layout_processes.schema.json | 5 | 2024-05-27T07:22:24.827007Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"parameters": {
"properties": {
"layout": {
"description": "A renderer target speaker layout",
"type": "string"
}
},
"type": "object"
},
"type": {
"oneOf": [
{
"const": "render"
},
{
"const": "measure_loudness"
}
],
"type": "string"
}
},
"title": "Processes that use a layout",
"type": "object"
} | Apache-2.0 | en |
ebu/ebu-adm-toolbox | 974d211eb086e262e81f5b1d777cf2595c92be5a | 2023-01-27T12:57:43 | data/schemas/parameterless_processes.schema.json | 5 | 2024-05-27T07:22:24.827007Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"name": {
"type": "string"
},
"type": {
"oneOf": [
{
"const": "remove_unused"
},
{
"const": "remove_unused_elements"
},
{
"const": "fix_ds_frequency"
},
{
"const": "fix_block_durations"
},
{
"const": "fix_stream_pack_refs"
},
{
"const": "convert_track_stream_to_channel"
},
{
"const": "add_block_rtimes"
},
{
"const": "update_all_programme_loudnesses"
},
{
"const": "set_position_defaults"
},
{
"const": "remove_silent_atu"
},
{
"const": "remove_jump_position"
},
{
"const": "remove_object_times_data_safe"
},
{
"const": "remove_object_times_common_unsafe"
},
{
"const": "remove_importance"
},
{
"const": "infer_object_interact"
},
{
"const": "set_content_dialogue_default"
}
],
"type": "string"
}
},
"title": "Configuration for parameterless processes",
"type": "object"
} | Apache-2.0 | en |
ebu/ebu-adm-toolbox | 974d211eb086e262e81f5b1d777cf2595c92be5a | 2023-01-27T12:57:43 | data/schemas/process.schema.json | 5 | 2024-05-27T07:22:24.827007Z | {
"$id": "https://ebu.ch/ear-adm-toolbox/schemas/process",
"$schema": "https://json-schema.org/draft-07/schema#",
"description": "An object describing the type and version of a process within an EAT graph",
"properties": {
"name": {
"description": "A name to identify this process instance",
"type": "string"
},
"parameters": {
"description": "Type-specific process configuration parameters",
"type": "object"
},
"type": {
"description": "The type of process required"
},
"version": {
"description": "The process version",
"type": "string"
}
},
"required": [
"type",
"name"
],
"title": "process",
"type": "object"
} | Apache-2.0 | en |
ebu/ebu-adm-toolbox | 974d211eb086e262e81f5b1d777cf2595c92be5a | 2023-01-27T12:57:43 | data/schemas/set_version.schema.json | 5 | 2024-05-27T07:22:24.827007Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"parameters": {
"properties": {
"version": {
"type": "string"
}
},
"type": "object"
},
"type": {
"const": "set_version",
"type": "string"
}
},
"title": "configuration for the set_version process",
"type": "object"
} | Apache-2.0 | en |
ebu/ebu-adm-toolbox | 974d211eb086e262e81f5b1d777cf2595c92be5a | 2023-01-27T12:57:43 | data/schemas/remove_elements.schema.json | 5 | 2024-05-27T07:22:24.827007Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"parameters": {
"properties": {
"ids": {
"description": "The ids of the elements to remove",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": {
"const": "remove_elements",
"type": "string"
}
},
"title": "configuration for the remove_elements process",
"type": "object"
} | Apache-2.0 | en |
ebu/ebu-adm-toolbox | 974d211eb086e262e81f5b1d777cf2595c92be5a | 2023-01-27T12:57:43 | data/schemas/validate.schema.json | 5 | 2024-05-27T07:22:24.827007Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"parameters": {
"properties": {
"profile": {
"$ref": "profile.schema.json"
}
},
"type": "object"
},
"type": {
"const": "validate",
"type": "string"
}
},
"title": "validate process configuration",
"type": "object"
} | Apache-2.0 | en |
ebu/ebu-adm-toolbox | 974d211eb086e262e81f5b1d777cf2595c92be5a | 2023-01-27T12:57:43 | data/schemas/path_process.schema.json | 5 | 2024-05-27T07:22:24.827007Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"parameters": {
"properties": {
"path": {
"description": "A path to a file read or written to by this process",
"type": "string"
}
},
"type": "object"
},
"type": {
"oneOf": [
{
"const": "read_adm"
},
{
"const": "read_adm_bw64"
},
{
"const": "write_adm_bw64"
},
{
"const": "read_bw64"
},
{
"const": "write_bw64"
}
],
"type": "string"
}
},
"title": "path consuming processes",
"type": "object"
} | Apache-2.0 | en |
ebu/ebu-adm-toolbox | 974d211eb086e262e81f5b1d777cf2595c92be5a | 2023-01-27T12:57:43 | data/schemas/set_programme_loudness.schema.json | 5 | 2024-05-27T07:22:24.827007Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"parameters": {
"properties": {
"id": {
"description": "The id of the audioProgramme element on which to set loudness metadata",
"type": "string"
}
},
"type": "object"
},
"type": {
"const": "set_programme_loudness",
"type": "string"
}
},
"title": "configuration for the set_programme_loudness process",
"type": "object"
} | Apache-2.0 | en |
ebu/ebu-adm-toolbox | 974d211eb086e262e81f5b1d777cf2595c92be5a | 2023-01-27T12:57:43 | data/schemas/profile.schema.json | 5 | 2024-05-27T07:22:24.827007Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"anyOf": [
{
"properties": {
"level": {
"description": "The profile level",
"type": "integer"
},
"type": {
"const": "itu_emission",
"description": "The profile name"
}
}
},
{
"properties": {
"type": {
"description": "The profile name",
"type": "string"
}
}
}
],
"description": "A description of an ADM profile",
"title": "A description of an ADM profile",
"type": "object"
} | Apache-2.0 | en |
apache/incubator-kie-kogito-runtimes | e1de8a7383b44dac66040860910cc3e3ad1baa3f | 2022-06-16T14:27:44 | quarkus/integration-tests/integration-tests-quarkus-processes/src/test/resources/testJsonSchema/test_greetings.json | 486 | 2024-05-29T15:22:10.624376Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"properties": {
"test": {
"type": "string"
}
},
"type": "object"
} | Apache-2.0 | en |
apache/incubator-kie-kogito-runtimes | e1de8a7383b44dac66040860910cc3e3ad1baa3f | 2022-06-16T14:27:44 | springboot/integration-tests/src/it/integration-tests-springboot-processes-it/src/test/resources/testJsonSchema/test_approvals_firstLineApproval.json | 486 | 2024-05-29T15:22:10.624376Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"definitions": {
"Address": {
"properties": {
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"street": {
"type": "string"
},
"zipCode": {
"type": "string"
}
},
"type": "object"
},
"Traveller": {
"properties": {
"address": {
"$ref": "#/definitions/Address"
},
"email": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"nationality": {
"type": "string"
},
"processed": {
"type": "boolean"
}
},
"type": "object"
}
},
"properties": {
"approved": {
"output": true,
"type": "boolean"
},
"traveller": {
"$ref": "#/definitions/Traveller",
"input": true
}
},
"type": "object"
} | Apache-2.0 | en |
apache/incubator-kie-kogito-runtimes | e1de8a7383b44dac66040860910cc3e3ad1baa3f | 2022-06-16T14:27:44 | springboot/integration-tests/src/it/integration-tests-springboot-processes-it/src/test/resources/testJsonSchema/test_greetings.json | 486 | 2024-05-29T15:22:10.624376Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"properties": {
"test": {
"type": "string"
}
},
"type": "object"
} | Apache-2.0 | en |
apache/incubator-kie-kogito-runtimes | e1de8a7383b44dac66040860910cc3e3ad1baa3f | 2022-06-16T14:27:44 | springboot/integration-tests/src/it/integration-tests-springboot-processes-it/src/test/resources/testJsonSchema/test_cinema.json | 486 | 2024-05-29T15:22:10.624376Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"definitions": {
"Movie": {
"properties": {
"genre": {
"$ref": "#/definitions/MovieGenre"
},
"name": {
"type": "string"
},
"rating": {
"$ref": "#/definitions/Rating"
},
"releaseYear": {
"type": "integer"
}
},
"type": "object"
},
"MovieGenre": {
"enum": [
"COMEDY",
"FANTASY",
"HORROR",
"SCI_FI",
"WESTERN"
],
"type": "string"
},
"Rating": {
"enum": [
"G",
"NC_17",
"PG",
"PG_13",
"R",
"UR"
],
"type": "string"
}
},
"properties": {
"movie": {
"$ref": "#/definitions/Movie"
},
"rating": {}
},
"type": "object"
} | Apache-2.0 | en |
apache/incubator-kie-kogito-runtimes | e1de8a7383b44dac66040860910cc3e3ad1baa3f | 2022-06-16T14:27:44 | quarkus/integration-tests/integration-tests-quarkus-processes/src/test/resources/testJsonSchema/test_approvals_firstLineApproval_instance.json | 486 | 2024-05-29T15:22:10.624376Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"definitions": {
"Address": {
"properties": {
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"street": {
"type": "string"
},
"zipCode": {
"type": "string"
}
},
"type": "object"
},
"Traveller": {
"properties": {
"address": {
"$ref": "#/definitions/Address"
},
"email": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"nationality": {
"type": "string"
},
"processed": {
"type": "boolean"
}
},
"type": "object"
}
},
"phases": [
"abort",
"claim",
"skip",
"complete"
],
"properties": {
"approved": {
"output": true,
"type": "boolean"
},
"traveller": {
"$ref": "#/definitions/Traveller",
"input": true
}
},
"type": "object"
} | Apache-2.0 | en |
apache/incubator-kie-kogito-runtimes | e1de8a7383b44dac66040860910cc3e3ad1baa3f | 2022-06-16T14:27:44 | quarkus/integration-tests/integration-tests-quarkus-processes/src/test/resources/testJsonSchema/test_approvals_firstLineApproval.json | 486 | 2024-05-29T15:22:10.624376Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"definitions": {
"Address": {
"properties": {
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"street": {
"type": "string"
},
"zipCode": {
"type": "string"
}
},
"type": "object"
},
"Traveller": {
"properties": {
"address": {
"$ref": "#/definitions/Address"
},
"email": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"nationality": {
"type": "string"
},
"processed": {
"type": "boolean"
}
},
"type": "object"
}
},
"properties": {
"approved": {
"output": true,
"type": "boolean"
},
"traveller": {
"$ref": "#/definitions/Traveller",
"input": true
}
},
"type": "object"
} | Apache-2.0 | en |
apache/incubator-kie-kogito-runtimes | e1de8a7383b44dac66040860910cc3e3ad1baa3f | 2022-06-16T14:27:44 | quarkus/integration-tests/integration-tests-quarkus-processes/src/test/resources/testJsonSchema/test_approvals.json | 486 | 2024-05-29T15:22:10.624376Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"definitions": {
"Address": {
"properties": {
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"street": {
"type": "string"
},
"zipCode": {
"type": "string"
}
},
"type": "object"
},
"Traveller": {
"properties": {
"address": {
"$ref": "#/definitions/Address"
},
"email": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"nationality": {
"type": "string"
},
"processed": {
"type": "boolean"
}
},
"type": "object"
}
},
"properties": {
"approver": {
"type": "string"
},
"firstLineApproval": {
"type": "boolean"
},
"secondLineApproval": {
"type": "boolean"
},
"traveller": {
"$ref": "#/definitions/Traveller"
}
},
"type": "object"
} | Apache-2.0 | en |
apache/incubator-kie-kogito-runtimes | e1de8a7383b44dac66040860910cc3e3ad1baa3f | 2022-06-16T14:27:44 | springboot/integration-tests/src/it/integration-tests-springboot-processes-it/src/test/resources/testJsonSchema/test_approvals.json | 486 | 2024-05-29T15:22:10.624376Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"definitions": {
"Address": {
"properties": {
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"street": {
"type": "string"
},
"zipCode": {
"type": "string"
}
},
"type": "object"
},
"Traveller": {
"properties": {
"address": {
"$ref": "#/definitions/Address"
},
"email": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"nationality": {
"type": "string"
},
"processed": {
"type": "boolean"
}
},
"type": "object"
}
},
"properties": {
"approver": {
"type": "string"
},
"firstLineApproval": {
"type": "boolean"
},
"secondLineApproval": {
"type": "boolean"
},
"traveller": {
"$ref": "#/definitions/Traveller"
}
},
"type": "object"
} | Apache-2.0 | en |
apache/incubator-kie-kogito-runtimes | f6359e68f100a1a2a74c22c8f2fe6434369daa05 | 2022-08-22T03:00:20 | quarkus/integration-tests/integration-tests-quarkus-processes-reactive/src/test/resources/testJsonSchema/test_approvals.json | 486 | 2024-05-29T15:22:10.624376Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"definitions": {
"Address": {
"properties": {
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"street": {
"type": "string"
},
"zipCode": {
"type": "string"
}
},
"type": "object"
},
"Traveller": {
"properties": {
"address": {
"$ref": "#/definitions/Address"
},
"email": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"nationality": {
"type": "string"
},
"processed": {
"type": "boolean"
}
},
"type": "object"
}
},
"properties": {
"approver": {
"type": "string"
},
"firstLineApproval": {
"type": "boolean"
},
"secondLineApproval": {
"type": "boolean"
},
"traveller": {
"$ref": "#/definitions/Traveller"
}
},
"type": "object"
} | Apache-2.0 | en |
apache/incubator-kie-kogito-runtimes | e1de8a7383b44dac66040860910cc3e3ad1baa3f | 2022-06-16T14:27:44 | quarkus/integration-tests/integration-tests-quarkus-processes/src/test/resources/testJsonSchema/test_cinema.json | 486 | 2024-05-29T15:22:10.624376Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"definitions": {
"Movie": {
"properties": {
"genre": {
"$ref": "#/definitions/MovieGenre"
},
"name": {
"type": "string"
},
"rating": {
"$ref": "#/definitions/Rating"
},
"releaseYear": {
"type": "integer"
}
},
"type": "object"
},
"MovieGenre": {
"enum": [
"COMEDY",
"FANTASY",
"HORROR",
"SCI_FI",
"WESTERN"
],
"type": "string"
},
"Rating": {
"enum": [
"G",
"NC_17",
"PG",
"PG_13",
"R",
"UR"
],
"type": "string"
}
},
"properties": {
"movie": {
"$ref": "#/definitions/Movie"
},
"rating": {}
},
"type": "object"
} | Apache-2.0 | en |
apache/apisix-helm-chart | b94c1e3c1afa26980929fc98bbe52abd34eae30a | 2023-03-02T08:21:10 | charts/apisix/values.schema.json | 213 | 2024-05-28T05:36:02.568047Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"customPlugins": {
"description": "customPlugins allows you to mount your own HTTP plugins",
"properties": {
"enabled": {
"type": "boolean"
},
"luaPath": {
"type": "string"
},
"plugins": {
"items": {
"properties": {
"attrs": {
"type": "object"
},
"configMap": {
"properties": {
"mounts": {
"items": {
"properties": {
"key": {
"minLength": 1,
"type": "string"
},
"path": {
"minLength": 1,
"type": "string"
}
},
"required": [
"key",
"path"
],
"type": "object"
},
"type": "array"
},
"name": {
"minLength": 1,
"type": "string"
}
},
"required": [
"name",
"mounts"
],
"type": "object"
},
"name": {
"minLength": 1,
"type": "string"
}
},
"required": [
"name",
"configMap"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"enabled",
"luaPath",
"plugins"
],
"type": "object"
},
"plugins": {
"description": "APISIX plugins to be enabled",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"stream_plugins": {
"description": "APISIX stream_plugins to be enabled",
"items": {
"type": "string"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
}
}
} | Apache-2.0 | en |
apache/apisix-helm-chart | 747be19f6d8ed4ac39a3d754ebebfda69975e92d | 2023-04-04T06:49:39 | charts/apisix/values.schema.json | 213 | 2024-05-28T05:36:02.568047Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"customPlugins": {
"description": "customPlugins allows you to mount your own HTTP plugins",
"properties": {
"enabled": {
"type": "boolean"
},
"luaPath": {
"type": "string"
},
"plugins": {
"items": {
"properties": {
"attrs": {
"type": "object"
},
"configMap": {
"properties": {
"mounts": {
"items": {
"properties": {
"key": {
"minLength": 1,
"type": "string"
},
"path": {
"minLength": 1,
"type": "string"
}
},
"required": [
"key",
"path"
],
"type": "object"
},
"type": "array"
},
"name": {
"minLength": 1,
"type": "string"
}
},
"required": [
"name",
"mounts"
],
"type": "object"
},
"name": {
"minLength": 1,
"type": "string"
}
},
"required": [
"name",
"configMap"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"enabled",
"luaPath",
"plugins"
],
"type": "object"
},
"plugins": {
"description": "APISIX plugins to be enabled",
"items": {
"type": "string"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"stream_plugins": {
"description": "APISIX stream_plugins to be enabled",
"items": {
"type": "string"
},
"minItems": 0,
"type": "array",
"uniqueItems": true
}
}
} | Apache-2.0 | en |
apache/hudi | 26b719a7fbafdfee480f07a143975f3e85adb3b2 | 2023-01-24T21:46:21 | hudi-utilities/src/test/resources/schema-provider/json/nested-properties/input.json | 5,127 | 2024-05-28T05:35:24.863028Z | {
"$id": "https://example.com/product.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A product from Acme's catalog",
"properties": {
"dimensions": {
"properties": {
"height": {
"type": "number"
},
"length": {
"type": "number"
},
"width": {
"type": "number"
}
},
"required": [
"length",
"width",
"height"
],
"type": "object"
},
"owners": {
"description": "Owners for the product",
"items": {
"properties": {
"company": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"price": {
"description": "The price of the product",
"exclusiveMinimum": 0,
"type": "number"
},
"productId": {
"description": "The unique identifier for a product",
"type": "integer"
},
"productName": {
"description": "Name of the product",
"type": "string"
},
"tags": {
"description": "Tags for the product",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"required": [
"productId",
"productName",
"price"
],
"title": "Product",
"type": "object"
} | Apache-2.0 | en |
apache/hudi | 26b719a7fbafdfee480f07a143975f3e85adb3b2 | 2023-01-24T21:46:21 | hudi-utilities/src/test/resources/schema-provider/json/single-properties/input.json | 5,127 | 2024-05-28T05:35:24.863028Z | {
"$id": "https://example.com/product.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A product from Acme's catalog",
"properties": {
"productId": {
"description": "The unique identifier for a product",
"type": "integer"
}
},
"required": [
"productId"
],
"title": "Product",
"type": "object"
} | Apache-2.0 | en |
apache/hudi | 26b719a7fbafdfee480f07a143975f3e85adb3b2 | 2023-01-24T21:46:21 | hudi-utilities/src/test/resources/schema-provider/json/multiple-properties/input.json | 5,127 | 2024-05-28T05:35:24.863028Z | {
"$id": "https://example.com/product.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A product from Acme's catalog",
"properties": {
"productId": {
"description": "The unique identifier for a product",
"type": "integer"
},
"productName": {
"description": "Name of the product",
"type": "string"
}
},
"required": [
"productId",
"productName"
],
"title": "Product",
"type": "object"
} | Apache-2.0 | en |
apache/camel | 253abbee58e668413a12743453231e7658b62139 | 2023-11-08T19:14:20 | components/camel-jackson/src/test/resources/schemas/json/org.apache.camel.component.jackson.transform.Person.json | 5,364 | 2024-05-29T16:00:40.325996Z | {
"$id": "https://example.com/person.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A person with name and age",
"properties": {
"age": {
"description": "The age of the person",
"type": "integer"
},
"name": {
"description": "The name of the person",
"type": "string"
}
},
"required": [
"name",
"age"
],
"title": "Person",
"type": "object"
} | Apache-2.0 | en |
apache/camel | a88eb080a6732961832e1ab97c6ab6ab5513ed8a | 2021-07-05T04:42:34 | components/camel-json-validator/src/test/resources/org/apache/camel/component/jsonvalidator/OrderItem.json | 5,364 | 2024-05-29T16:00:40.325996Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"properties": {
"product": {
"type": "string"
},
"quantity": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"product",
"quantity"
],
"type": "object"
} | Apache-2.0 | en |
apache/camel | 253abbee58e668413a12743453231e7658b62139 | 2023-11-08T19:14:20 | components/camel-jackson/src/test/resources/org/apache/camel/component/jackson/transform/person.schema.json | 5,364 | 2024-05-29T16:00:40.325996Z | {
"$id": "https://example.com/person.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A person with name and age",
"properties": {
"age": {
"description": "The age of the person",
"type": "integer"
},
"name": {
"description": "The name of the person",
"type": "string"
}
},
"required": [
"name",
"age"
],
"title": "Person",
"type": "object"
} | Apache-2.0 | en |
apache/camel | a88eb080a6732961832e1ab97c6ab6ab5513ed8a | 2021-07-05T04:42:34 | components/camel-json-validator/src/test/resources/org/apache/camel/component/jsonvalidator/Order.json | 5,364 | 2024-05-29T16:00:40.325996Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"properties": {
"customer": {
"type": "string"
},
"orderItems": {
"items": {
"$ref": "OrderItem.json"
},
"type": "array"
}
},
"required": [
"customer",
"orderItems"
],
"type": "object"
} | Apache-2.0 | en |
apache/unomi | dcc6cd8d24fa55edb3b2c745f27ed744289e4f88 | 2022-05-23T15:59:58 | itests/src/test/resources/schemas/schema-invalid.json | 259 | 2024-05-28T04:15:33.217779Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"allOf": [
{
"$ref": "https://unomi.apache.org/schemas/json/event/1-0-0"
}
],
"invalidEntry": "An invalid entry",
"self": {
"format": "jsonschema",
"name": "invalid",
"vendor": "org.apache.unomi",
"version": "1-0-0"
},
"title": "TestEvent",
"type": "object"
} | Apache-2.0 | en |
apache/unomi | 3351b6c54243ccf5dabf13755d44045059359211 | 2022-05-31T07:45:05 | itests/src/test/resources/schemas/schema-invalid.json | 259 | 2024-05-28T04:15:33.217779Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"allOf": [
{
"$ref": "https://unomi.apache.org/schemas/json/event/1-0-0"
}
],
"invalidEntry": "An invalid entry",
"self": {
"format": "jsonschema",
"name": "invalid",
"vendor": "com.vendor.test",
"version": "1-0-0"
},
"title": "TestEvent",
"type": "object"
} | Apache-2.0 | en |
apache/sling-whiteboard | c66c13986646f051a3217b3b1ed5ed5bb2d85399 | 2021-11-11T17:23:27 | json-store/src/test/java/org/apache/sling/jsonstore/karate/schema/minimal.json | 42 | 2024-05-28T04:11:40.01545Z | {
"$id": "https://example.com/minimal",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"description": "A minimal(ish) valid schema",
"properties": {
"$schema": {
"description": "The schema reference",
"type": "string"
},
"tags": {
"description": "Tags that categorize the product",
"type": "array"
}
},
"required": [
"$schema",
"tags"
],
"title": "Minimal",
"type": "object"
} | Apache-2.0 | en |
apache/airflow | 4ee46b984da73974f0a30bcf361ac36e995993c3 | 2024-05-20T16:04:29 | airflow/providers/google/cloud/openlineage/BigQueryErrorRunFacet.json | 34,849 | 2024-05-29T15:13:42.717221Z | {
"$defs": {
"BigQueryErrorRunFacet": {
"allOf": [
{
"$ref": "https://openlineage.io/spec/2-0-2/OpenLineage.json#/$defs/RunFacet"
},
{
"properties": {
"clientError": {
"type": "string"
},
"parserError": {
"type": "string"
}
},
"type": "object"
}
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"bigQueryJob": {
"$ref": "#/$defs/BigQueryErrorRunFacet"
}
},
"type": "object"
} | Apache-2.0 | en |
apache/airflow | 57dab1303c5850b9b2ff81e64cbbe5bd4d1032f9 | 2024-05-23T13:53:07 | airflow/providers/google/cloud/openlineage/BigQueryErrorRunFacet.json | 34,849 | 2024-05-29T15:13:42.717221Z | {
"$defs": {
"BigQueryErrorRunFacet": {
"allOf": [
{
"$ref": "https://openlineage.io/spec/2-0-2/OpenLineage.json#/$defs/RunFacet"
},
{
"properties": {
"clientError": {
"type": "string"
},
"parserError": {
"type": "string"
}
},
"type": "object"
}
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"bigQuery_error": {
"$ref": "#/$defs/BigQueryErrorRunFacet"
}
},
"type": "object"
} | Apache-2.0 | en |
morishin/XDeck | 208a11b400496cd926dfc0e376d45939bab45fc3 | 2023-09-08T03:11:05 | XDeck/Config/schema.json | 19 | 2024-05-27T04:36:15.564614Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"$schema": {
"type": "string"
},
"columns": {
"items": {
"oneOf": [
{
"additionalProperties": false,
"properties": {
"type": {
"enum": [
"forYou",
"following",
"notifications",
"profile"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"type": {
"enum": [
"custom"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
}
]
},
"type": "array"
}
},
"required": [
"columns"
],
"type": "object"
} | MIT | null |
morishin/XDeck | 5de36a61ed1a00c8fce3107638053cd6948c45ee | 2024-01-24T14:42:08 | XDeck/Config/schema.json | 19 | 2024-05-27T04:36:15.564614Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"$schema": {
"type": "string"
},
"columnWidth": {
"type": "integer"
},
"columns": {
"items": {
"oneOf": [
{
"additionalProperties": false,
"properties": {
"type": {
"enum": [
"forYou",
"following",
"notifications",
"profile"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"type": {
"enum": [
"custom"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
}
]
},
"type": "array"
}
},
"required": [
"columns"
],
"type": "object"
} | MIT | null |
MSLNZ/GTC | 9947fc4eb938072ea9814f2f46e9fcf1cd47e645 | 2024-01-19T00:41:15 | GTC/schema/gtc_v_1_5_0.json | 13 | 2024-05-29T09:05:04.168714Z | {
"$defs": {
"Complex": {
"additionalProperties": false,
"properties": {
"CLASS": {
"const": "Complex"
},
"label": {
"$ref": "#/$defs/string_or_null"
},
"n_im": {
"type": "string"
},
"n_re": {
"type": "string"
}
},
"required": [
"CLASS",
"n_re",
"n_im",
"label"
],
"type": "object"
},
"IntermediateReal": {
"additionalProperties": false,
"properties": {
"CLASS": {
"const": "IntermediateReal"
},
"d_components": {
"$ref": "#/$defs/eVector"
},
"i_components": {
"$ref": "#/$defs/iVector"
},
"label": {
"$ref": "#/$defs/string_or_null"
},
"u_components": {
"$ref": "#/$defs/eVector"
},
"uid": {
"$ref": "#/$defs/iUIDString"
},
"value": {
"type": "number"
}
},
"required": [
"CLASS",
"value",
"label",
"uid",
"u_components",
"d_components",
"i_components"
],
"type": "object"
},
"correlation": {
"minProperties": 1,
"propertyNames": {
"$ref": "#/$defs/eUIDString"
},
"type": "object"
},
"df": {
"anyOf": [
{
"minimum": 0,
"type": "number"
},
{
"enum": [
null
]
}
]
},
"eUIDArray ": {
"items": {
"$ref": "#/$defs/eUIDString"
},
"minItems": 0,
"type": "array"
},
"eUIDString": {
"pattern": "^\\(\\d+,\\s*\\d+\\)$",
"type": "string"
},
"eVector": {
"additionalProperties": false,
"properties": {
"CLASS": {
"const": "Vector"
},
"index": {
"$ref": "#/$defs/eUIDArray "
},
"value": {
"items": {
"type": "number"
},
"minItems": 0,
"type": "array"
}
},
"required": [
"CLASS",
"index",
"value"
],
"type": "object"
},
"elementaryReal": {
"additionalProperties": false,
"properties": {
"CLASS": {
"const": "ElementaryReal"
},
"uid": {
"$ref": "#/$defs/eUIDString"
},
"x": {
"type": "number"
}
},
"required": [
"CLASS",
"x",
"uid"
],
"type": "object"
},
"iUIDArray": {
"items": {
"$ref": "#/$defs/iUIDString"
},
"minItems": 0,
"type": "array"
},
"iUIDString": {
"pattern": "^\\(\\d+,\\s*\\d+,\\s*0\\)$",
"type": "string"
},
"iVector": {
"additionalProperties": false,
"properties": {
"CLASS": {
"const": "Vector"
},
"index": {
"$ref": "#/$defs/iUIDArray"
},
"value": {
"items": {
"type": "number"
},
"minItems": 0,
"type": "array"
}
},
"required": [
"CLASS",
"index",
"value"
],
"type": "object"
},
"leaf_node": {
"additionalProperties": false,
"dependencies": {
"correlation": {
"required": [
"ensemble"
]
},
"ensemble": {
"required": [
"correlation"
]
}
},
"properties": {
"CLASS": {
"const": "LeafNode"
},
"complex": {
"items": {
"$ref": "#/$defs/eUIDString"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"correlation": {
"$ref": "#/$defs/correlation"
},
"df": {
"$ref": "#/$defs/df"
},
"ensemble": {
"$ref": "#/$defs/eUIDArray "
},
"independent": {
"type": "boolean"
},
"label": {
"$ref": "#/$defs/string_or_null"
},
"u": {
"minValue": 0,
"type": "number"
},
"uid": {
"$ref": "#/$defs/eUIDString"
}
},
"required": [
"CLASS",
"uid",
"u"
],
"type": "object"
},
"string_or_null": {
"anyOf": [
{
"type": "string"
},
{
"enum": [
null
]
}
]
},
"tagged": {
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z_][a-zA-Z0-9_]*$": {
"else": {
"else": {
"else": {
"additionalProperties": false,
"errorMessage": "Unexpected value for CLASS property",
"type": "object"
},
"if": {
"properties": {
"CLASS": {
"const": "Complex"
}
},
"then": {
"$ref": "#/$defs/Complex"
}
}
},
"if": {
"properties": {
"CLASS": {
"const": "IntermediateReal"
}
}
},
"then": {
"$ref": "#/$defs/IntermediateReal"
}
},
"if": {
"properties": {
"CLASS": {
"const": "ElementaryReal"
}
}
},
"properties": {
"CLASS": {
"type": "string"
}
},
"then": {
"$ref": "#/$defs/elementaryReal"
},
"type": "object"
}
},
"type": "object"
}
},
"$id": "https://measurement.govt.nz/gtc/json_1.5.0",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "JSON Schema for GTC archive",
"properties": {
"CLASS": {
"const": "Archive"
},
"intermediate_uids": {
"patternProperties": {
"^\\(\\d+,\\s*\\d+,\\s*\\d+\\)$": {
"maxItems": 3,
"minItems": 3,
"prefixItems": [
{
"$ref": "#/$defs/string_or_null"
},
{
"type": "number"
},
{
"$ref": "#/$defs/df"
}
],
"type": "array"
},
"additionalProperties": false
},
"type": "object"
},
"leaf_nodes": {
"patternProperties": {
"^\\(\\d+,\\s*\\d+\\)$": {
"$ref": "#/$defs/leaf_node"
},
"additionalProperties": false
},
"type": "object"
},
"tagged_complex": {
"$ref": "#/$defs/tagged"
},
"tagged_real": {
"$ref": "#/$defs/tagged"
},
"untagged_real": {
"$ref": "#/$defs/tagged"
},
"version": {
"type": "string"
}
},
"required": [
"CLASS",
"leaf_nodes"
],
"type": "object"
} | MIT | en |
MSLNZ/GTC | 774fbf9b5e335ea466576aaa1a59c5262b4ee250 | 2024-01-25T22:36:51 | GTC/schema/gtc_v_1_5_0.json | 13 | 2024-05-29T09:05:04.168714Z | {
"$defs": {
"Complex": {
"additionalProperties": false,
"properties": {
"CLASS": {
"const": "Complex"
},
"label": {
"$ref": "#/$defs/string_or_null"
},
"n_im": {
"type": "string"
},
"n_re": {
"type": "string"
}
},
"required": [
"CLASS",
"n_re",
"n_im",
"label"
],
"type": "object"
},
"IntermediateReal": {
"additionalProperties": false,
"properties": {
"CLASS": {
"const": "IntermediateReal"
},
"d_components": {
"$ref": "#/$defs/eVector"
},
"i_components": {
"$ref": "#/$defs/iVector"
},
"label": {
"$ref": "#/$defs/string_or_null"
},
"u_components": {
"$ref": "#/$defs/eVector"
},
"uid": {
"$ref": "#/$defs/iUIDString"
},
"value": {
"type": "number"
}
},
"required": [
"CLASS",
"value",
"label",
"uid",
"u_components",
"d_components",
"i_components"
],
"type": "object"
},
"correlation": {
"minProperties": 1,
"propertyNames": {
"$ref": "#/$defs/eUIDString"
},
"type": "object"
},
"df": {
"anyOf": [
{
"minimum": 1,
"type": "number"
},
{
"enum": [
null
]
}
]
},
"eUIDArray": {
"items": {
"$ref": "#/$defs/eUIDString"
},
"minItems": 0,
"type": "array"
},
"eUIDString": {
"pattern": "^\\(\\d+,\\s*\\d+\\)$",
"type": "string"
},
"eVector": {
"additionalProperties": false,
"properties": {
"CLASS": {
"const": "Vector"
},
"index": {
"$ref": "#/$defs/eUIDArray"
},
"value": {
"items": {
"type": "number"
},
"minItems": 0,
"type": "array"
}
},
"required": [
"CLASS",
"index",
"value"
],
"type": "object"
},
"elementaryReal": {
"additionalProperties": false,
"properties": {
"CLASS": {
"const": "ElementaryReal"
},
"uid": {
"$ref": "#/$defs/eUIDString"
},
"x": {
"type": "number"
}
},
"required": [
"CLASS",
"x",
"uid"
],
"type": "object"
},
"iUIDArray": {
"items": {
"$ref": "#/$defs/iUIDString"
},
"minItems": 0,
"type": "array"
},
"iUIDString": {
"pattern": "^\\(\\d+,\\s*\\d+,\\s*0\\)$",
"type": "string"
},
"iVector": {
"additionalProperties": false,
"properties": {
"CLASS": {
"const": "Vector"
},
"index": {
"$ref": "#/$defs/iUIDArray"
},
"value": {
"items": {
"type": "number"
},
"minItems": 0,
"type": "array"
}
},
"required": [
"CLASS",
"index",
"value"
],
"type": "object"
},
"leaf_node": {
"additionalProperties": false,
"dependencies": {
"correlation": {
"required": [
"ensemble"
]
},
"ensemble": {
"required": [
"correlation"
]
}
},
"properties": {
"CLASS": {
"const": "LeafNode"
},
"complex": {
"items": {
"$ref": "#/$defs/eUIDString"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"correlation": {
"$ref": "#/$defs/correlation"
},
"df": {
"$ref": "#/$defs/df"
},
"ensemble": {
"$ref": "#/$defs/eUIDArray"
},
"independent": {
"type": "boolean"
},
"label": {
"$ref": "#/$defs/string_or_null"
},
"u": {
"minimum": 0,
"type": "number"
},
"uid": {
"$ref": "#/$defs/eUIDString"
}
},
"required": [
"CLASS",
"uid",
"u"
],
"type": "object"
},
"string_or_null": {
"anyOf": [
{
"type": "string"
},
{
"enum": [
null
]
}
]
},
"tagged": {
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z_][a-zA-Z0-9_]*$": {
"else": {
"else": {
"else": {
"additionalProperties": false,
"errorMessage": "Unexpected value for CLASS property",
"type": "object"
},
"if": {
"properties": {
"CLASS": {
"const": "Complex"
}
},
"then": {
"$ref": "#/$defs/Complex"
}
}
},
"if": {
"properties": {
"CLASS": {
"const": "IntermediateReal"
}
}
},
"then": {
"$ref": "#/$defs/IntermediateReal"
}
},
"if": {
"properties": {
"CLASS": {
"const": "ElementaryReal"
}
}
},
"properties": {
"CLASS": {
"type": "string"
}
},
"then": {
"$ref": "#/$defs/elementaryReal"
},
"type": "object"
}
},
"type": "object"
}
},
"$id": "https://measurement.govt.nz/gtc/json_1.5.0",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "JSON Schema for GTC archive",
"properties": {
"CLASS": {
"const": "Archive"
},
"intermediate_uids": {
"patternProperties": {
"^\\(\\d+,\\s*\\d+,\\s*\\d+\\)$": {
"maxItems": 3,
"minItems": 3,
"prefixItems": [
{
"$ref": "#/$defs/string_or_null"
},
{
"type": "number"
},
{
"$ref": "#/$defs/df"
}
],
"type": "array"
},
"additionalProperties": false
},
"type": "object"
},
"leaf_nodes": {
"patternProperties": {
"^\\(\\d+,\\s*\\d+\\)$": {
"$ref": "#/$defs/leaf_node"
},
"additionalProperties": false
},
"type": "object"
},
"tagged_complex": {
"$ref": "#/$defs/tagged"
},
"tagged_real": {
"$ref": "#/$defs/tagged"
},
"untagged_real": {
"$ref": "#/$defs/tagged"
},
"version": {
"type": "string"
}
},
"required": [
"CLASS",
"leaf_nodes"
],
"type": "object"
} | MIT | en |
MSLNZ/GTC | c6bab30ba69b6c1590904f6b477f996c8e313094 | 2024-01-25T19:59:28 | GTC/schema/gtc_v_1_5_0.json | 13 | 2024-05-29T09:05:04.168714Z | {
"$defs": {
"Complex": {
"additionalProperties": false,
"properties": {
"CLASS": {
"const": "Complex"
},
"label": {
"$ref": "#/$defs/string_or_null"
},
"n_im": {
"type": "string"
},
"n_re": {
"type": "string"
}
},
"required": [
"CLASS",
"n_re",
"n_im",
"label"
],
"type": "object"
},
"IntermediateReal": {
"additionalProperties": false,
"properties": {
"CLASS": {
"const": "IntermediateReal"
},
"d_components": {
"$ref": "#/$defs/eVector"
},
"i_components": {
"$ref": "#/$defs/iVector"
},
"label": {
"$ref": "#/$defs/string_or_null"
},
"u_components": {
"$ref": "#/$defs/eVector"
},
"uid": {
"$ref": "#/$defs/iUIDString"
},
"value": {
"type": "number"
}
},
"required": [
"CLASS",
"value",
"label",
"uid",
"u_components",
"d_components",
"i_components"
],
"type": "object"
},
"correlation": {
"minProperties": 1,
"propertyNames": {
"$ref": "#/$defs/eUIDString"
},
"type": "object"
},
"df": {
"anyOf": [
{
"minimum": 1,
"type": "number"
},
{
"enum": [
null
]
}
]
},
"eUIDArray ": {
"items": {
"$ref": "#/$defs/eUIDString"
},
"minItems": 0,
"type": "array"
},
"eUIDString": {
"pattern": "^\\(\\d+,\\s*\\d+\\)$",
"type": "string"
},
"eVector": {
"additionalProperties": false,
"properties": {
"CLASS": {
"const": "Vector"
},
"index": {
"$ref": "#/$defs/eUIDArray "
},
"value": {
"items": {
"type": "number"
},
"minItems": 0,
"type": "array"
}
},
"required": [
"CLASS",
"index",
"value"
],
"type": "object"
},
"elementaryReal": {
"additionalProperties": false,
"properties": {
"CLASS": {
"const": "ElementaryReal"
},
"uid": {
"$ref": "#/$defs/eUIDString"
},
"x": {
"type": "number"
}
},
"required": [
"CLASS",
"x",
"uid"
],
"type": "object"
},
"iUIDArray": {
"items": {
"$ref": "#/$defs/iUIDString"
},
"minItems": 0,
"type": "array"
},
"iUIDString": {
"pattern": "^\\(\\d+,\\s*\\d+,\\s*0\\)$",
"type": "string"
},
"iVector": {
"additionalProperties": false,
"properties": {
"CLASS": {
"const": "Vector"
},
"index": {
"$ref": "#/$defs/iUIDArray"
},
"value": {
"items": {
"type": "number"
},
"minItems": 0,
"type": "array"
}
},
"required": [
"CLASS",
"index",
"value"
],
"type": "object"
},
"leaf_node": {
"additionalProperties": false,
"dependencies": {
"correlation": {
"required": [
"ensemble"
]
},
"ensemble": {
"required": [
"correlation"
]
}
},
"properties": {
"CLASS": {
"const": "LeafNode"
},
"complex": {
"items": {
"$ref": "#/$defs/eUIDString"
},
"maxItems": 2,
"minItems": 2,
"type": "array"
},
"correlation": {
"$ref": "#/$defs/correlation"
},
"df": {
"$ref": "#/$defs/df"
},
"ensemble": {
"$ref": "#/$defs/eUIDArray "
},
"independent": {
"type": "boolean"
},
"label": {
"$ref": "#/$defs/string_or_null"
},
"u": {
"minimum": 0,
"type": "number"
},
"uid": {
"$ref": "#/$defs/eUIDString"
}
},
"required": [
"CLASS",
"uid",
"u"
],
"type": "object"
},
"string_or_null": {
"anyOf": [
{
"type": "string"
},
{
"enum": [
null
]
}
]
},
"tagged": {
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z_][a-zA-Z0-9_]*$": {
"else": {
"else": {
"else": {
"additionalProperties": false,
"errorMessage": "Unexpected value for CLASS property",
"type": "object"
},
"if": {
"properties": {
"CLASS": {
"const": "Complex"
}
},
"then": {
"$ref": "#/$defs/Complex"
}
}
},
"if": {
"properties": {
"CLASS": {
"const": "IntermediateReal"
}
}
},
"then": {
"$ref": "#/$defs/IntermediateReal"
}
},
"if": {
"properties": {
"CLASS": {
"const": "ElementaryReal"
}
}
},
"properties": {
"CLASS": {
"type": "string"
}
},
"then": {
"$ref": "#/$defs/elementaryReal"
},
"type": "object"
}
},
"type": "object"
}
},
"$id": "https://measurement.govt.nz/gtc/json_1.5.0",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "JSON Schema for GTC archive",
"properties": {
"CLASS": {
"const": "Archive"
},
"intermediate_uids": {
"patternProperties": {
"^\\(\\d+,\\s*\\d+,\\s*\\d+\\)$": {
"maxItems": 3,
"minItems": 3,
"prefixItems": [
{
"$ref": "#/$defs/string_or_null"
},
{
"type": "number"
},
{
"$ref": "#/$defs/df"
}
],
"type": "array"
},
"additionalProperties": false
},
"type": "object"
},
"leaf_nodes": {
"patternProperties": {
"^\\(\\d+,\\s*\\d+\\)$": {
"$ref": "#/$defs/leaf_node"
},
"additionalProperties": false
},
"type": "object"
},
"tagged_complex": {
"$ref": "#/$defs/tagged"
},
"tagged_real": {
"$ref": "#/$defs/tagged"
},
"untagged_real": {
"$ref": "#/$defs/tagged"
},
"version": {
"type": "string"
}
},
"required": [
"CLASS",
"leaf_nodes"
],
"type": "object"
} | MIT | en |
bramstroker/homeassistant-powercalc | b9b7b2a3e6b51d12bc110aa82521035b966bb5a0 | 2024-05-03T07:11:32 | profile_library/library_schema.json | 874 | 2024-05-28T05:17:01.516688Z | {
"$defs": {
"device_type": {
"description": "Type of device",
"enum": [
"camera",
"light",
"smart_switch",
"smart_speaker",
"network"
],
"type": "string"
},
"model": {
"properties": {
"aliases": {
"description": "List of aliases for the model",
"items": {
"type": "string"
},
"type": "array"
},
"color_modes": {
"description": "List of color modes supported by the model",
"items": {
"type": "string"
},
"type": "array"
},
"device_type": {
"$ref": "#/$defs/device_type"
},
"id": {
"description": "Identifier of the model",
"type": "string"
},
"updated_at": {
"description": "Last update of the model",
"format": "date-time",
"type": "string"
}
},
"required": [
"id",
"device_type",
"update_timestamp"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "library.json defines the available models and manufacturers for the powercalc integration",
"properties": {
"manufacturers": {
"items": {
"description": "Manufacturer information",
"properties": {
"aliases": {
"description": "List of aliases for the manufacturer",
"items": {
"type": "string"
},
"type": "array"
},
"device_types": {
"description": "List of possible device types",
"items": {
"$ref": "#/$defs/device_type"
},
"type": "array"
},
"models": {
"description": "List of models",
"items": {
"$ref": "#/$defs/model"
},
"type": "array"
},
"name": {
"description": "Name of the manufacturer",
"minLength": 1,
"type": "string"
}
},
"required": [
"name",
"models"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"manufacturers"
],
"type": "object"
} | MIT | en |
bramstroker/homeassistant-powercalc | b9b7b2a3e6b51d12bc110aa82521035b966bb5a0 | 2024-05-03T07:11:32 | profile_library/model_schema.json | 874 | 2024-05-28T05:17:01.516688Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "model.json describes a number of devices, typically lights, for use within the HomeAssistant Powercalc extension.",
"properties": {
"aliases": {
"description": "Aliases for this model",
"items": {
"type": "string"
},
"type": "array"
},
"calculation_enabled_condition": {
"description": "Template which can be evaluated.",
"type": "string"
},
"calculation_strategy": {
"description": "Supported calculation modes",
"enum": [
"lut",
"linear",
"fixed"
],
"type": "string"
},
"config_flow_discovery_remarks": {
"description": "Some remarks to show in the GUI config flow on first step of discovery",
"type": "string"
},
"created_at": {
"description": "Creation date of the profile",
"format": "date-time",
"type": "string"
},
"device_type": {
"description": "Type of device",
"enum": [
"camera",
"light",
"smart_switch",
"smart_speaker",
"network"
],
"type": "string"
},
"fixed_config": {
"description": "Configuration for fixed calculation mode",
"properties": {
"power": {
"type": "number"
},
"states_power": {
"additionalProperties": {
"type": [
"number",
"string"
]
},
"description": "A dict of state attributes and the power. See https://github.com/bramstroker/homeassistant-powercalc#power-per-state.",
"properties": {
"idle": {
"type": [
"number",
"string"
]
},
"off": {
"type": [
"number",
"string"
]
},
"paused": {
"type": [
"number",
"string"
]
},
"playing": {
"type": [
"number",
"string"
]
},
"unavailable": {
"type": [
"number",
"string"
]
}
},
"type": "object"
}
},
"type": "object"
},
"linear_config": {
"description": "Configuration for linear calculation mode",
"properties": {
"calibrate": {
"items": {
"type": "string"
},
"type": "array"
},
"max_power": {
"type": "number"
},
"min_power": {
"type": "number"
}
},
"type": "object"
},
"linked_lut": {
"description": "Use LUT data files from another model",
"type": "string"
},
"measure_description": {
"description": "Add more information about how you measured the device or any remarks",
"type": "string"
},
"measure_device": {
"description": "Device which was used to measure",
"type": "string"
},
"measure_method": {
"description": "How the device was measured",
"enum": [
"manual",
"script"
],
"type": "string"
},
"measure_settings": {
"description": "Settings used for measure script",
"type": "object"
},
"name": {
"description": "The full name",
"type": "string"
},
"sensor_config": {
"description": "Sensor configuration options. See the README",
"type": "object"
},
"standby_power": {
"description": "Power draw when the device is turned off. When you are not able to measure set to 0.4 for lights",
"minimum": 0.05,
"type": "number"
},
"standby_power_on": {
"description": "Power draw when the device is turned on.",
"minimum": 0.05,
"type": "number"
},
"sub_profile_select": {
"description": "Configuration to automatically select a sub profile",
"properties": {
"default": {
"description": "Default profile to select when non of the matchers apply",
"type": "string"
},
"matchers": {
"description": "List of matchers which will be checked",
"items": {
"properties": {
"attribute": {
"type": "string"
},
"integration": {
"type": "string"
},
"map": {
"type": "object"
},
"pattern": {
"type": "string"
},
"profile": {
"type": "string"
},
"type": {
"enum": [
"attribute",
"entity_id",
"entity_state",
"integration"
]
}
},
"required": [
"type"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"default",
"matchers"
],
"type": "object"
}
},
"required": [
"name",
"measure_method",
"measure_device",
"calculation_strategy"
],
"type": "object"
} | MIT | en |
GSS-Cogs/csvcubed | f4eb0046469e6d8dbf796c977ee2d6e41c190b8b | 2022-09-16T14:17:06 | src/csvcubed/schema/codelist-config/v1_1/schema.json | 10 | 2024-05-28T03:38:54.121914Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"definitions": {
"v1.0": {
"concept": {
"description": "A concept in the code list.",
"properties": {
"children": {
"$ref": "#/definitions/v1.0/concepts"
},
"description": {
"description": "Description of the concept.",
"type": "string"
},
"label": {
"description": "Label of the concept.",
"type": "string"
},
"notation": {
"description": "Notation of the concept.",
"type": "string"
},
"same_as": {
"description": "Reference to a concept defined elsewhere.",
"format": "uri",
"type": "string"
},
"sort_order": {
"description": "Sort order of the concept.",
"type": "integer"
},
"uri_safe_identifier_override": {
"description": "Uri safe identifier for the concept.",
"type": "string"
}
},
"required": [
"label",
"notation"
],
"type": "object"
},
"concepts": {
"description": "List of concepts in the code list.",
"items": {
"$ref": "#/definitions/v1.0/concept"
},
"type": "array",
"uniqueItems": true
},
"keywordTypes": {
"description": "A keyword or list of keywords relevant to the code list.",
"oneOf": [
{
"$ref": "#/definitions/v1.0/types/keyword"
},
{
"items": {
"$ref": "#/definitions/v1.0/types/keyword"
},
"type": "array"
}
]
},
"themeTypes": {
"additionalProperties": {
"oneOf": [
{
"$ref": "#/definitions/v1.0/types/theme"
},
{
"themeList": {
"description": "A list of themes.",
"items": {
"$ref": "#/definitions/v1.0/types/theme"
},
"type": "array"
}
}
]
},
"description": "A theme or list of themes that describe the focus of the code list."
},
"types": {
"keyword": {
"description": "A string describing a keyword.",
"type": "string"
},
"theme": {
"$ref": "http://purl.org/csv-cubed/resources/themes.json#/uris",
"description": "A URI describing a theme."
}
}
}
},
"description": "A new code list to be associated with a dimension.",
"id": "https://purl.org/csv-cubed/code-list-config/v1.1",
"properties": {
"$schema": {
"default": "https://purl.org/csv-cubed/code-list-config/v1.1",
"type": "string"
},
"concepts": {
"$ref": "#/definitions/v1.0/concepts"
},
"creator": {
"$ref": "http://purl.org/csv-cubed/resources/organisations.json#/uris",
"description": "The creator of the code list (uri)."
},
"dataset_issued": {
"description": "Date time that the code list was initially published in ISO 8601 format, e.g. 2022-03-31 or 2022-03-31T12:54:30Z.",
"type": "string"
},
"dataset_modified": {
"description": "Date time that the code list was last modified published in ISO 8601 format, e.g. 2022-03-31 or 2022-03-31T12:54:30Z.",
"type": "string"
},
"description": {
"description": "A long description of the code list.",
"type": "string"
},
"id": {
"description": "A unique id for the code list.",
"type": "string"
},
"keywords": {
"$ref": "#/definitions/v1.0/keywordTypes"
},
"license": {
"$ref": "http://purl.org/csv-cubed/resources/licenses.json#/uris",
"description": "URI that represents the copyright license applying to this code list."
},
"publisher": {
"$ref": "http://purl.org/csv-cubed/resources/organisations.json#/uris",
"description": "The publisher of the code list (uri)."
},
"sort": {
"description": "Sort strategy for the concepts.",
"properties": {
"by": {
"default": "label",
"description": "label (default) or notation",
"enum": [
"label",
"notation"
],
"type": "string"
},
"method": {
"default": "ascending",
"description": "ascending (default) or descending",
"enum": [
"ascending",
"descending"
],
"type": "string"
}
},
"required": [
"by",
"method"
],
"type": "object"
},
"summary": {
"description": "A short summary of the code list.",
"type": "string"
},
"themes": {
"$ref": "#/definitions/v1.0/themeTypes"
},
"title": {
"description": "A title for the code list.",
"type": "string"
}
},
"required": [
"title"
],
"title": "Schema for a codelist.",
"type": "object"
} | Apache-2.0 | en |
GSS-Cogs/csvcubed | fb76c03f8c4aed0f4fa97088cbf7c6244b8847f4 | 2023-06-22T10:08:45 | src/csvcubed/schema/cube-config/v1_5/schema.json | 10 | 2024-05-28T03:38:54.121914Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"definitions": {
"v1.0": {
"columnTypes": {
"Attribute_Literal": {
"additionalProperties": false,
"description": "This column represents an attribute (with literal values) of the cube",
"properties": {
"data_type": {
"$ref": "#/definitions/v1.0/dataTypes",
"description": "The data type of the attribute values"
},
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Attribute"
},
"describes_observations": {
"description": "The observed values column that this attribute describes.",
"type": "string"
},
"description": {
"description": "A explanation of what the Attribute represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/attributes.json#/uris/literalValues",
"description": "URI of an existing attribute to reuse or extend"
},
"label": {
"description": "Label describing the Attribute",
"type": "string"
},
"required": {
"default": false,
"description": "true/false - whether or not it is required that every observation has a value for this attribute",
"type": "boolean"
},
"type": {
"const": "attribute",
"description": "This column represents an attribute of the cube",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"Attribute_Resource_Existing": {
"additionalProperties": false,
"description": "This column represents an attribute (with resource values) of the cube (reusing an existing attribute definition)",
"oneOf": [
{
"required": [
"type"
]
},
{
"required": [
"from_template"
]
}
],
"properties": {
"cell_uri_template": {
"description": "A template used to map the cell values in this column into URIs, e.g. 'http://example.com/attribute-values/{+column_csvw_name}'",
"format": "uri",
"type": "string"
},
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Attribute"
},
"describes_observations": {
"description": "The observed values column that this attribute describes.",
"type": "string"
},
"description": {
"description": "A explanation of what the Attribute represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/attributes.json#/uris/resourceValues",
"description": "URI of an existing attribute to reuse or extend"
},
"from_template": {
"$ref": "#/definitions/v1.0/column_templates/attribute_resource"
},
"label": {
"description": "Label describing the Attribute",
"type": "string"
},
"required": {
"default": false,
"description": "true/false - whether it is required that every observation has a value for this attribute",
"type": "boolean"
},
"type": {
"const": "attribute",
"description": "This column represents an attribute of the cube",
"type": "string"
}
},
"type": "object"
},
"Attribute_Resource_New": {
"additionalProperties": false,
"description": "This column represents an attribute (with resource values) of the cube (creating a new attribute)",
"oneOf": [
{
"required": [
"type"
]
},
{
"required": [
"from_template"
]
}
],
"properties": {
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Attribute"
},
"describes_observations": {
"description": "The observed values column that this attribute describes.",
"type": "string"
},
"description": {
"description": "A explanation of what the Attribute represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/attributes.json#/uris/resourceValues",
"description": "URI of an existing attribute to reuse or extend"
},
"from_template": {
"$ref": "#/definitions/v1.0/column_templates/attribute_resource"
},
"label": {
"description": "Label describing the Attribute",
"type": "string"
},
"required": {
"default": false,
"description": "true/false - whether it is required that every observation has a value for this attribute",
"type": "boolean"
},
"type": {
"const": "attribute",
"description": "This column represents an attribute of the cube",
"type": "string"
},
"values": {
"oneOf": [
{
"default": true,
"description": "true/false - whether to automatically generate attribute value resources for each unique value in the column",
"type": "boolean"
},
{
"description": "The distinct attribute values which can be used in the column",
"items": {
"$ref": "#/definitions/v1.0/valueTypes/attributeValueType"
},
"type": "array"
}
]
}
},
"type": "object"
},
"Dimension": {
"additionalProperties": false,
"description": "This column represents a dimension of the cube",
"properties": {
"cell_uri_template": {
"description": "A template used to map the cell values in this column into URIs, e.g. 'http://example.com/code-list/{+column_csvw_name}'",
"format": "uri",
"type": "string"
},
"code_list": {
"description": "A code list defines the unique values permitted in a dimension",
"oneOf": [
{
"default": true,
"description": "true/false - whether to generate a code list defining the unique values permitted in this dimension",
"type": "boolean"
},
{
"$ref": "http://purl.org/csv-cubed/resources/code-lists.json#/uris",
"description": "The URI of a code list defining the unique values permitted in this dimension"
},
{
"description": "The path to the code list json defined using the code list config schema",
"type": "string"
},
{
"$ref": "https://purl.org/csv-cubed/code-list-config/v2.0",
"description": "Inline code list"
}
]
},
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Dimension"
},
"description": {
"description": "A explanation of what the Dimension represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/dimensions.json#/uris",
"description": "URI of an existing dimension to reuse or extend"
},
"from_template": {
"$ref": "#/definitions/v1.0/column_templates/dimension"
},
"label": {
"description": "Label describing the Dimension",
"type": "string"
},
"type": {
"const": "dimension",
"description": "This column represents a dimension of the cube",
"type": "string"
}
},
"type": "object"
},
"Measures_Existing": {
"additionalProperties": false,
"description": "This column represents the phenomenon which has been measured (reusing existing measure definitions)",
"properties": {
"cell_uri_template": {
"description": "A template used to map the cell values in this column into URIs, e.g. 'http://example.com/measures/{+column_csvw_name}'",
"format": "uri",
"type": "string"
},
"type": {
"const": "measures",
"description": "This column represents the phenomenon which has been measured",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"Measures_New": {
"additionalProperties": false,
"description": "This column represents the phenomenon which has been measured (defining new measures)",
"properties": {
"type": {
"const": "measures",
"description": "This column represents the phenomenon which has been measured",
"type": "string"
},
"values": {
"oneOf": [
{
"default": true,
"description": "true/false - whether to automatically generate measures for each unique value in the column",
"type": "boolean"
},
{
"description": "The list of measures permitted in this column",
"items": {
"$ref": "#/definitions/v1.0/valueTypes/measureType"
},
"type": "array"
}
]
}
},
"required": [
"type"
],
"type": "object"
},
"Observations": {
"additionalProperties": false,
"description": "This column holds observed/recorded values",
"properties": {
"data_type": {
"$ref": "#/definitions/v1.0/dataTypes"
},
"measure": {
"$ref": "#/definitions/v1.0/valueTypes/measureType",
"description": "The characteristic which was measured in all observation"
},
"type": {
"const": "observations",
"description": "Column type",
"type": "string"
},
"unit": {
"$ref": "#/definitions/v1.0/valueTypes/unitType",
"description": "The unit that all observations were measured in"
}
},
"required": [
"type"
],
"type": "object"
},
"Units_Existing": {
"additionalProperties": false,
"description": "This column represents the unit of measure in which observations were recorded (reusing existing unit definitions)",
"oneOf": [
{
"required": [
"type"
]
},
{
"required": [
"from_template"
]
}
],
"properties": {
"cell_uri_template": {
"description": "A template used to map the cell values in this column into URIs, e.g. 'http://example.com/measures/{+column_csvw_name}'",
"format": "uri",
"type": "string"
},
"describes_observations": {
"description": "The observed values column that these units describe.",
"type": "string"
},
"from_template": {
"$ref": "#/definitions/v1.0/column_templates/units_existing"
},
"type": {
"const": "units",
"description": "This column represents the unit of measure in which observations were recorded",
"type": "string"
}
},
"type": "object"
},
"Units_New": {
"additionalProperties": false,
"description": "This column represents the unit of measure in which observations were recorded (defining new units)",
"properties": {
"describes_observations": {
"description": "The observed values column that these units describe.",
"type": "string"
},
"type": {
"const": "units",
"description": "This column represents the unit of measure in which observations were recorded",
"type": "string"
},
"values": {
"description": "The Units used in this dataset",
"oneOf": [
{
"default": true,
"description": "true/false - whether to automatically generate new units from the unique values in this column",
"type": "boolean"
},
{
"description": "The list of distinct units in this column",
"items": {
"$ref": "#/definitions/v1.0/valueTypes/unitType"
},
"type": "array"
}
]
}
},
"required": [
"type"
],
"type": "object"
}
},
"column_templates": {
"attribute_resource": {
"description": "Templates for common attribute columns with resource values",
"enum": [
"observation-status"
],
"type": "string"
},
"comment": "This is where you should place all column template identifiers. Ensure you segregate them into the appropriate column type.",
"dimension": {
"description": "Templates for common dimension columns",
"enum": [
"year",
"half-year",
"quarter",
"month",
"week",
"day",
"hour",
"minute",
"second",
"government-year",
"government-half-year",
"government-quarter",
"government-week",
"mixed-period",
"gregorian-instant",
"gregorian-interval",
"statistical-geography"
],
"type": "string"
},
"units_existing": {
"description": "Templates for common existing unit columns",
"enum": [
"qudt"
],
"type": "string"
}
},
"dataTypes": {
"default": "decimal",
"enum": [
"anyURI",
"boolean",
"date",
"dateTime",
"dateTimeStamp",
"decimal",
"integer",
"long",
"int",
"short",
"nonNegativeInteger",
"positiveInteger",
"unsignedLong",
"unsignedInt",
"unsignedShort",
"nonPositiveInteger",
"negativeInteger",
"double",
"float",
"string",
"language",
"time"
],
"type": "string"
},
"keywordTypes": {
"description": "A keyword or list of keywords relevant to the cube",
"oneOf": [
{
"$ref": "#/definitions/v1.0/types/keyword"
},
{
"items": {
"$ref": "#/definitions/v1.0/types/keyword"
},
"type": "array"
}
]
},
"themeTypes": {
"additionalProperties": {
"oneOf": [
{
"$ref": "#/definitions/v1.0/types/theme"
},
{
"themeList": {
"description": "A list of themes",
"items": {
"$ref": "#/definitions/v1.0/types/theme"
},
"type": "array"
}
}
]
},
"description": "A theme or list of themes that describe the focus of the data"
},
"types": {
"definition_uri": {
"description": "A string describing a theme",
"format": "uri",
"type": "string"
},
"keyword": {
"description": "A string describing a keyword",
"type": "string"
},
"organisation": {
"$ref": "http://purl.org/csv-cubed/resources/organisations.json#/uris",
"description": "A URI defining an organisation"
},
"theme": {
"$ref": "http://purl.org/csv-cubed/resources/themes.json#/uris",
"description": "A URI describing a theme"
}
},
"valueTypes": {
"attributeValueType": {
"additionalProperties": false,
"description": "A new attribute value",
"properties": {
"definition_uri": {
"description": "The URI link to an existing definition",
"format": "uri",
"type": "string"
},
"description": {
"description": "The description of the attribute values",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/attribute-values.json#/uris",
"description": "The URI to an existing attribute values to extend"
},
"label": {
"description": "A label describing this attribute value",
"type": "string"
}
},
"required": [
"label"
],
"type": "object"
},
"measureType": {
"additionalProperties": false,
"description": "A new measure",
"properties": {
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Measure"
},
"description": {
"description": "A explanation of what the Measure represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/measures.json#/uris",
"description": "URI of an Existing Measure to reuse or extend"
},
"label": {
"description": "Label for the Measure",
"type": "string"
}
},
"required": [
"label"
],
"type": "object"
},
"unitType": {
"additionalProperties": false,
"description": "A new unit",
"properties": {
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Unit"
},
"description": {
"description": "A explanation of what the Unit represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/units.json#/uris",
"description": "URI of an existing Unit to reuse"
},
"label": {
"description": "Label describing the Unit",
"type": "string"
},
"quantity_kind": {
"$ref": "http://purl.org/csv-cubed/resources/quantity-kinds.json#/uris",
"description": "The QUDT quantity kind this unit is used to measure"
},
"scaling_factor": {
"description": "Scaling factor of the observation to base unit",
"type": "number"
},
"si_scaling_factor": {
"description": "Scaling factor to convert from this unit to the SI base unit defined in the unit's quantity_kind",
"type": "number"
}
},
"required": [
"label"
],
"type": "object"
}
}
}
},
"description": "Schema to be used for creation & validation of a single csv-cubed-flavoured linked data cube in CSV-W format",
"id": "https://purl.org/csv-cubed/qube-config/v1.5",
"properties": {
"$schema": {
"default": "https://purl.org/csv-cubed/qube-config/v1.5",
"type": "string"
},
"columns": {
"additionalProperties": {
"$comment": "ATTENTION: If you ADD any column types below, you MUST UPDATE csvcubed.readers.cubeconfig.v1.configdeserialiser._map_column_type_to_schema_type_refs to reflect your changes.",
"anyOf": [
{
"$ref": "#/definitions/v1.0/columnTypes/Dimension"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Attribute_Resource_New"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Attribute_Resource_Existing"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Attribute_Literal"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Measures_New"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Measures_Existing"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Observations"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Units_New"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Units_Existing"
},
{
"const": false,
"description": "This column will be present in the CSV but will not be converted to RDF",
"type": "boolean"
}
],
"description": "Column's meaning in the data cube"
},
"description": "Map of CSV column titles to definitions of what the column represents (a dimension, an attribute, observations, units or measures). If a column needs to be suppressed (i.e. skipped), the following notation can be used: {'column_name': false}"
},
"creator": {
"$ref": "http://purl.org/csv-cubed/resources/organisations.json#/uris",
"description": "The creator of the data set (uri)"
},
"dataset_issued": {
"description": "Date time that the data set was initially published in ISO 8601 format, e.g. 2022-03-31 or 2022-03-31T12:54:30Z",
"type": "string"
},
"dataset_modified": {
"description": "Date time that the data set was last modified published in ISO 8601 format, e.g. 2022-03-31 or 2022-03-31T12:54:30Z",
"type": "string"
},
"description": {
"description": "A longer description of the cube",
"type": "string"
},
"id": {
"description": "A unique id for the cube",
"type": "string"
},
"keywords": {
"$ref": "#/definitions/v1.0/keywordTypes"
},
"license": {
"$ref": "http://purl.org/csv-cubed/resources/licenses.json#/uris",
"description": "URI that represents the copyright license applying to this cube"
},
"public_contact_point_uri": {
"description": "URI that provides a public contact point for discussion of the data set, e.g. mailto:[email protected]",
"format": "uri",
"type": "string"
},
"publisher": {
"$ref": "http://purl.org/csv-cubed/resources/organisations.json#/uris",
"description": "The publisher of the data set (uri)"
},
"summary": {
"description": "A shorter summary of the data set",
"type": "string"
},
"themes": {
"$ref": "#/definitions/v1.0/themeTypes"
},
"title": {
"description": "A title for this data set",
"type": "string"
}
},
"required": [
"$schema"
],
"title": "Schema for a qb-config cube",
"type": "object"
} | Apache-2.0 | en |
GSS-Cogs/csvcubed | 3f340a8e52d0c84374729bd5c5ed2ef72d886f0e | 2023-01-12T14:29:40 | src/csvcubed/schema/cube-config/v1_4/schema.json | 10 | 2024-05-28T03:38:54.121914Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"definitions": {
"v1.0": {
"columnTypes": {
"Attribute_Literal": {
"additionalProperties": false,
"description": "This column represents an attribute (with literal values) of the cube",
"properties": {
"data_type": {
"$ref": "#/definitions/v1.0/dataTypes",
"description": "The data type of the attribute values"
},
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Attribute"
},
"describes_observations": {
"description": "The observed values column that this attribute describes.",
"type": "string"
},
"description": {
"description": "A explanation of what the Attribute represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/attributes.json#/uris/literalValues",
"description": "URI of an existing attribute to reuse or extend"
},
"label": {
"description": "Label describing the Attribute",
"type": "string"
},
"required": {
"default": false,
"description": "true/false - whether or not it is required that every observation has a value for this attribute",
"type": "boolean"
},
"type": {
"const": "attribute",
"description": "This column represents an attribute of the cube",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"Attribute_Resource_Existing": {
"additionalProperties": false,
"description": "This column represents an attribute (with resource values) of the cube (reusing an existing attribute definition)",
"oneOf": [
{
"required": [
"type"
]
},
{
"required": [
"from_template"
]
}
],
"properties": {
"cell_uri_template": {
"description": "A template used to map the cell values in this column into URIs, e.g. 'http://example.com/attribute-values/{+column_csvw_name}'",
"format": "uri",
"type": "string"
},
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Attribute"
},
"describes_observations": {
"description": "The observed values column that this attribute describes.",
"type": "string"
},
"description": {
"description": "A explanation of what the Attribute represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/attributes.json#/uris/resourceValues",
"description": "URI of an existing attribute to reuse or extend"
},
"from_template": {
"$ref": "#/definitions/v1.0/column_templates/attribute_resource"
},
"label": {
"description": "Label describing the Attribute",
"type": "string"
},
"required": {
"default": false,
"description": "true/false - whether it is required that every observation has a value for this attribute",
"type": "boolean"
},
"type": {
"const": "attribute",
"description": "This column represents an attribute of the cube",
"type": "string"
}
},
"type": "object"
},
"Attribute_Resource_New": {
"additionalProperties": false,
"description": "This column represents an attribute (with resource values) of the cube (creating a new attribute)",
"oneOf": [
{
"required": [
"type"
]
},
{
"required": [
"from_template"
]
}
],
"properties": {
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Attribute"
},
"describes_observations": {
"description": "The observed values column that this attribute describes.",
"type": "string"
},
"description": {
"description": "A explanation of what the Attribute represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/attributes.json#/uris/resourceValues",
"description": "URI of an existing attribute to reuse or extend"
},
"from_template": {
"$ref": "#/definitions/v1.0/column_templates/attribute_resource"
},
"label": {
"description": "Label describing the Attribute",
"type": "string"
},
"required": {
"default": false,
"description": "true/false - whether it is required that every observation has a value for this attribute",
"type": "boolean"
},
"type": {
"const": "attribute",
"description": "This column represents an attribute of the cube",
"type": "string"
},
"values": {
"oneOf": [
{
"default": true,
"description": "true/false - whether to automatically generate attribute value resources for each unique value in the column",
"type": "boolean"
},
{
"description": "The distinct attribute values which can be used in the column",
"items": {
"$ref": "#/definitions/v1.0/valueTypes/attributeValueType"
},
"type": "array"
}
]
}
},
"type": "object"
},
"Dimension": {
"additionalProperties": false,
"description": "This column represents a dimension of the cube",
"properties": {
"cell_uri_template": {
"description": "A template used to map the cell values in this column into URIs, e.g. 'http://example.com/code-list/{+column_csvw_name}'",
"format": "uri",
"type": "string"
},
"code_list": {
"description": "A code list defines the unique values permitted in a dimension",
"oneOf": [
{
"default": true,
"description": "true/false - whether to generate a code list defining the unique values permitted in this dimension",
"type": "boolean"
},
{
"$ref": "http://purl.org/csv-cubed/resources/code-lists.json#/uris",
"description": "The URI of a code list defining the unique values permitted in this dimension"
},
{
"description": "The path to the code list json defined using the code list config schema",
"type": "string"
},
{
"$ref": "https://purl.org/csv-cubed/code-list-config/v1.1",
"description": "Inline code list"
}
]
},
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Dimension"
},
"description": {
"description": "A explanation of what the Dimension represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/dimensions.json#/uris",
"description": "URI of an existing dimension to reuse or extend"
},
"from_template": {
"$ref": "#/definitions/v1.0/column_templates/dimension"
},
"label": {
"description": "Label describing the Dimension",
"type": "string"
},
"type": {
"const": "dimension",
"description": "This column represents a dimension of the cube",
"type": "string"
}
},
"type": "object"
},
"Measures_Existing": {
"additionalProperties": false,
"description": "This column represents the phenomenon which has been measured (reusing existing measure definitions)",
"properties": {
"cell_uri_template": {
"description": "A template used to map the cell values in this column into URIs, e.g. 'http://example.com/measures/{+column_csvw_name}'",
"format": "uri",
"type": "string"
},
"type": {
"const": "measures",
"description": "This column represents the phenomenon which has been measured",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"Measures_New": {
"additionalProperties": false,
"description": "This column represents the phenomenon which has been measured (defining new measures)",
"properties": {
"type": {
"const": "measures",
"description": "This column represents the phenomenon which has been measured",
"type": "string"
},
"values": {
"oneOf": [
{
"default": true,
"description": "true/false - whether to automatically generate measures for each unique value in the column",
"type": "boolean"
},
{
"description": "The list of measures permitted in this column",
"items": {
"$ref": "#/definitions/v1.0/valueTypes/measureType"
},
"type": "array"
}
]
}
},
"required": [
"type"
],
"type": "object"
},
"Observations": {
"additionalProperties": false,
"description": "This column holds observed/recorded values",
"properties": {
"data_type": {
"$ref": "#/definitions/v1.0/dataTypes"
},
"measure": {
"$ref": "#/definitions/v1.0/valueTypes/measureType",
"description": "The characteristic which was measured in all observation"
},
"type": {
"const": "observations",
"description": "Column type",
"type": "string"
},
"unit": {
"$ref": "#/definitions/v1.0/valueTypes/unitType",
"description": "The unit that all observations were measured in"
}
},
"required": [
"type"
],
"type": "object"
},
"Units_Existing": {
"additionalProperties": false,
"description": "This column represents the unit of measure in which observations were recorded (reusing existing unit definitions)",
"oneOf": [
{
"required": [
"type"
]
},
{
"required": [
"from_template"
]
}
],
"properties": {
"cell_uri_template": {
"description": "A template used to map the cell values in this column into URIs, e.g. 'http://example.com/measures/{+column_csvw_name}'",
"format": "uri",
"type": "string"
},
"describes_observations": {
"description": "The observed values column that these units describe.",
"type": "string"
},
"from_template": {
"$ref": "#/definitions/v1.0/column_templates/units_existing"
},
"type": {
"const": "units",
"description": "This column represents the unit of measure in which observations were recorded",
"type": "string"
}
},
"type": "object"
},
"Units_New": {
"additionalProperties": false,
"description": "This column represents the unit of measure in which observations were recorded (defining new units)",
"properties": {
"describes_observations": {
"description": "The observed values column that these units describe.",
"type": "string"
},
"type": {
"const": "units",
"description": "This column represents the unit of measure in which observations were recorded",
"type": "string"
},
"values": {
"description": "The Units used in this dataset",
"oneOf": [
{
"default": true,
"description": "true/false - whether to automatically generate new units from the unique values in this column",
"type": "boolean"
},
{
"description": "The list of distinct units in this column",
"items": {
"$ref": "#/definitions/v1.0/valueTypes/unitType"
},
"type": "array"
}
]
}
},
"required": [
"type"
],
"type": "object"
}
},
"column_templates": {
"attribute_resource": {
"description": "Templates for common attribute columns with resource values",
"enum": [
"observation-status"
],
"type": "string"
},
"comment": "This is where you should place all column template identifiers. Ensure you segregate them into the appropriate column type.",
"dimension": {
"description": "Templates for common dimension columns",
"enum": [
"year",
"half-year",
"quarter",
"month",
"week",
"day",
"hour",
"minute",
"second",
"government-year",
"government-half-year",
"government-quarter",
"government-week",
"gregorian-instant"
],
"type": "string"
},
"units_existing": {
"description": "Templates for common existing unit columns",
"enum": [
"qudt"
],
"type": "string"
}
},
"dataTypes": {
"default": "decimal",
"enum": [
"anyURI",
"boolean",
"date",
"dateTime",
"dateTimeStamp",
"decimal",
"integer",
"long",
"int",
"short",
"nonNegativeInteger",
"positiveInteger",
"unsignedLong",
"unsignedInt",
"unsignedShort",
"nonPositiveInteger",
"negativeInteger",
"double",
"float",
"string",
"language",
"time"
],
"type": "string"
},
"keywordTypes": {
"description": "A keyword or list of keywords relevant to the cube",
"oneOf": [
{
"$ref": "#/definitions/v1.0/types/keyword"
},
{
"items": {
"$ref": "#/definitions/v1.0/types/keyword"
},
"type": "array"
}
]
},
"themeTypes": {
"additionalProperties": {
"oneOf": [
{
"$ref": "#/definitions/v1.0/types/theme"
},
{
"themeList": {
"description": "A list of themes",
"items": {
"$ref": "#/definitions/v1.0/types/theme"
},
"type": "array"
}
}
]
},
"description": "A theme or list of themes that describe the focus of the data"
},
"types": {
"definition_uri": {
"description": "A string describing a theme",
"format": "uri",
"type": "string"
},
"keyword": {
"description": "A string describing a keyword",
"type": "string"
},
"organisation": {
"$ref": "http://purl.org/csv-cubed/resources/organisations.json#/uris",
"description": "A URI defining an organisation"
},
"theme": {
"$ref": "http://purl.org/csv-cubed/resources/themes.json#/uris",
"description": "A URI describing a theme"
}
},
"valueTypes": {
"attributeValueType": {
"additionalProperties": false,
"description": "A new attribute value",
"properties": {
"definition_uri": {
"description": "The URI link to an existing definition",
"format": "uri",
"type": "string"
},
"description": {
"description": "The description of the attribute values",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/attribute-values.json#/uris",
"description": "The URI to an existing attribute values to extend"
},
"label": {
"description": "A label describing this attribute value",
"type": "string"
}
},
"required": [
"label"
],
"type": "object"
},
"measureType": {
"additionalProperties": false,
"description": "A new measure",
"properties": {
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Measure"
},
"description": {
"description": "A explanation of what the Measure represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/measures.json#/uris",
"description": "URI of an Existing Measure to reuse or extend"
},
"label": {
"description": "Label for the Measure",
"type": "string"
}
},
"required": [
"label"
],
"type": "object"
},
"unitType": {
"additionalProperties": false,
"description": "A new unit",
"properties": {
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Unit"
},
"description": {
"description": "A explanation of what the Unit represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/units.json#/uris",
"description": "URI of an existing Unit to reuse"
},
"label": {
"description": "Label describing the Unit",
"type": "string"
},
"quantity_kind": {
"$ref": "http://purl.org/csv-cubed/resources/quantity-kinds.json#/uris",
"description": "The QUDT quantity kind this unit is used to measure"
},
"scaling_factor": {
"description": "Scaling factor of the observation to base unit",
"type": "number"
},
"si_scaling_factor": {
"description": "Scaling factor to convert from this unit to the SI base unit defined in the unit's quantity_kind",
"type": "number"
}
},
"required": [
"label"
],
"type": "object"
}
}
}
},
"description": "Schema to be used for creation & validation of a single csv-cubed-flavoured linked data cube in CSV-W format",
"id": "https://purl.org/csv-cubed/qube-config/v1.4",
"properties": {
"$schema": {
"default": "https://purl.org/csv-cubed/qube-config/v1.4",
"type": "string"
},
"columns": {
"additionalProperties": {
"anyOf": [
{
"$ref": "#/definitions/v1.0/columnTypes/Dimension"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Attribute_Resource_New"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Attribute_Resource_Existing"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Attribute_Literal"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Measures_New"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Measures_Existing"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Observations"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Units_New"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Units_Existing"
},
{
"const": false,
"description": "This column will be present in the CSV but will not be converted to RDF",
"type": "boolean"
}
],
"description": "Column's meaning in the data cube"
},
"description": "Map of CSV column titles to definitions of what the column represents (a dimension, an attribute, observations, units or measures). If a column needs to be suppressed (i.e. skipped), the following notation can be used: {'column_name': false}"
},
"creator": {
"$ref": "http://purl.org/csv-cubed/resources/organisations.json#/uris",
"description": "The creator of the data set (uri)"
},
"dataset_issued": {
"description": "Date time that the data set was initially published in ISO 8601 format, e.g. 2022-03-31 or 2022-03-31T12:54:30Z",
"type": "string"
},
"dataset_modified": {
"description": "Date time that the data set was last modified published in ISO 8601 format, e.g. 2022-03-31 or 2022-03-31T12:54:30Z",
"type": "string"
},
"description": {
"description": "A longer description of the cube",
"type": "string"
},
"id": {
"description": "A unique id for the cube",
"type": "string"
},
"keywords": {
"$ref": "#/definitions/v1.0/keywordTypes"
},
"license": {
"$ref": "http://purl.org/csv-cubed/resources/licenses.json#/uris",
"description": "URI that represents the copyright license applying to this cube"
},
"public_contact_point_uri": {
"description": "URI that provides a public contact point for discussion of the data set, e.g. mailto:[email protected]",
"format": "uri",
"type": "string"
},
"publisher": {
"$ref": "http://purl.org/csv-cubed/resources/organisations.json#/uris",
"description": "The publisher of the data set (uri)"
},
"summary": {
"description": "A shorter summary of the data set",
"type": "string"
},
"themes": {
"$ref": "#/definitions/v1.0/themeTypes"
},
"title": {
"description": "A title for this data set",
"type": "string"
}
},
"required": [
"$schema"
],
"title": "Schema for a qb-config cube",
"type": "object"
} | Apache-2.0 | en |
GSS-Cogs/csvcubed | f4eb0046469e6d8dbf796c977ee2d6e41c190b8b | 2022-09-16T14:17:06 | src/csvcubed/schema/cube-config/v1_3/schema.json | 10 | 2024-05-28T03:38:54.121914Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"definitions": {
"v1.0": {
"columnTypes": {
"Attribute_Literal": {
"additionalProperties": false,
"description": "This column represents an attribute (with literal values) of the cube",
"properties": {
"data_type": {
"$ref": "#/definitions/v1.0/dataTypes",
"description": "The data type of the attribute values"
},
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Attribute"
},
"description": {
"description": "A explanation of what the Attribute represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/attributes.json#/uris/literalValues",
"description": "URI of an existing attribute to reuse or extend"
},
"label": {
"description": "Label describing the Attribute",
"type": "string"
},
"required": {
"default": false,
"description": "true/false - whether or not it is required that every observation has a value for this attribute",
"type": "boolean"
},
"type": {
"const": "attribute",
"description": "This column represents an attribute of the cube",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"Attribute_Resource_Existing": {
"additionalProperties": false,
"description": "This column represents an attribute (with resource values) of the cube (reusing an existing attribute definition)",
"oneOf": [
{
"required": [
"type"
]
},
{
"required": [
"from_template"
]
}
],
"properties": {
"cell_uri_template": {
"description": "A template used to map the cell values in this column into URIs, e.g. 'http://example.com/attribute-values/{+column_csvw_name}'",
"format": "uri",
"type": "string"
},
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Attribute"
},
"description": {
"description": "A explanation of what the Attribute represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/attributes.json#/uris/resourceValues",
"description": "URI of an existing attribute to reuse or extend"
},
"from_template": {
"$ref": "#/definitions/v1.0/column_templates/attribute_resource"
},
"label": {
"description": "Label describing the Attribute",
"type": "string"
},
"required": {
"default": false,
"description": "true/false - whether it is required that every observation has a value for this attribute",
"type": "boolean"
},
"type": {
"const": "attribute",
"description": "This column represents an attribute of the cube",
"type": "string"
}
},
"type": "object"
},
"Attribute_Resource_New": {
"additionalProperties": false,
"description": "This column represents an attribute (with resource values) of the cube (creating a new attribute)",
"oneOf": [
{
"required": [
"type"
]
},
{
"required": [
"from_template"
]
}
],
"properties": {
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Attribute"
},
"description": {
"description": "A explanation of what the Attribute represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/attributes.json#/uris/resourceValues",
"description": "URI of an existing attribute to reuse or extend"
},
"from_template": {
"$ref": "#/definitions/v1.0/column_templates/attribute_resource"
},
"label": {
"description": "Label describing the Attribute",
"type": "string"
},
"required": {
"default": false,
"description": "true/false - whether it is required that every observation has a value for this attribute",
"type": "boolean"
},
"type": {
"const": "attribute",
"description": "This column represents an attribute of the cube",
"type": "string"
},
"values": {
"oneOf": [
{
"default": true,
"description": "true/false - whether to automatically generate attribute value resources for each unique value in the column",
"type": "boolean"
},
{
"description": "The distinct attribute values which can be used in the column",
"items": {
"$ref": "#/definitions/v1.0/valueTypes/attributeValueType"
},
"type": "array"
}
]
}
},
"type": "object"
},
"Dimension": {
"additionalProperties": false,
"description": "This column represents a dimension of the cube",
"properties": {
"cell_uri_template": {
"description": "A template used to map the cell values in this column into URIs, e.g. 'http://example.com/code-list/{+column_csvw_name}'",
"format": "uri",
"type": "string"
},
"code_list": {
"description": "A code list defines the unique values permitted in a dimension",
"oneOf": [
{
"default": true,
"description": "true/false - whether to generate a code list defining the unique values permitted in this dimension",
"type": "boolean"
},
{
"$ref": "http://purl.org/csv-cubed/resources/code-lists.json#/uris",
"description": "The URI of a code list defining the unique values permitted in this dimension"
},
{
"description": "The path to the code list json defined using the code list config schema",
"type": "string"
},
{
"$ref": "https://purl.org/csv-cubed/code-list-config/v1.1",
"description": "Inline code list"
}
]
},
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Dimension"
},
"description": {
"description": "A explanation of what the Dimension represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/dimensions.json#/uris",
"description": "URI of an existing dimension to reuse or extend"
},
"from_template": {
"$ref": "#/definitions/v1.0/column_templates/dimension"
},
"label": {
"description": "Label describing the Dimension",
"type": "string"
},
"type": {
"const": "dimension",
"description": "This column represents a dimension of the cube",
"type": "string"
}
},
"type": "object"
},
"Measures_Existing": {
"additionalProperties": false,
"description": "This column represents the phenomenon which has been measured (reusing existing measure definitions)",
"properties": {
"cell_uri_template": {
"description": "A template used to map the cell values in this column into URIs, e.g. 'http://example.com/measures/{+column_csvw_name}'",
"format": "uri",
"type": "string"
},
"type": {
"const": "measures",
"description": "This column represents the phenomenon which has been measured",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"Measures_New": {
"additionalProperties": false,
"description": "This column represents the phenomenon which has been measured (defining new measures)",
"properties": {
"type": {
"const": "measures",
"description": "This column represents the phenomenon which has been measured",
"type": "string"
},
"values": {
"oneOf": [
{
"default": true,
"description": "true/false - whether to automatically generate measures for each unique value in the column",
"type": "boolean"
},
{
"description": "The list of measures permitted in this column",
"items": {
"$ref": "#/definitions/v1.0/valueTypes/measureType"
},
"type": "array"
}
]
}
},
"required": [
"type"
],
"type": "object"
},
"Observations": {
"additionalProperties": false,
"description": "This column holds observed/recorded values",
"properties": {
"data_type": {
"$ref": "#/definitions/v1.0/dataTypes"
},
"measure": {
"$ref": "#/definitions/v1.0/valueTypes/measureType",
"description": "The characteristic which was measured in all observation"
},
"type": {
"const": "observations",
"description": "Column type",
"type": "string"
},
"unit": {
"$ref": "#/definitions/v1.0/valueTypes/unitType",
"description": "The unit that all observations were measured in"
}
},
"required": [
"type"
],
"type": "object"
},
"Units_Existing": {
"additionalProperties": false,
"description": "This column represents the unit of measure in which observations were recorded (reusing existing unit definitions)",
"oneOf": [
{
"required": [
"type"
]
},
{
"required": [
"from_template"
]
}
],
"properties": {
"cell_uri_template": {
"description": "A template used to map the cell values in this column into URIs, e.g. 'http://example.com/measures/{+column_csvw_name}'",
"format": "uri",
"type": "string"
},
"from_template": {
"$ref": "#/definitions/v1.0/column_templates/units_existing"
},
"type": {
"const": "units",
"description": "This column represents the unit of measure in which observations were recorded",
"type": "string"
}
},
"type": "object"
},
"Units_New": {
"additionalProperties": false,
"description": "This column represents the unit of measure in which observations were recorded (defining new units)",
"properties": {
"type": {
"const": "units",
"description": "This column represents the unit of measure in which observations were recorded",
"type": "string"
},
"values": {
"description": "The Units used in this dataset",
"oneOf": [
{
"default": true,
"description": "true/false - whether to automatically generate new units from the unique values in this column",
"type": "boolean"
},
{
"description": "The list of distinct units in this column",
"items": {
"$ref": "#/definitions/v1.0/valueTypes/unitType"
},
"type": "array"
}
]
}
},
"required": [
"type"
],
"type": "object"
}
},
"column_templates": {
"attribute_resource": {
"description": "Templates for common attribute columns with resource values",
"enum": [
"observation-status"
],
"type": "string"
},
"comment": "This is where you should place all column template identifiers. Ensure you segregate them into the appropriate column type.",
"dimension": {
"description": "Templates for common dimension columns",
"enum": [
"year",
"half-year",
"quarter",
"month",
"week",
"day",
"hour",
"minute",
"second",
"government-year",
"government-half-year",
"government-quarter",
"government-week",
"gregorian-instant"
],
"type": "string"
},
"units_existing": {
"description": "Templates for common existing unit columns",
"enum": [
"qudt"
],
"type": "string"
}
},
"dataTypes": {
"default": "decimal",
"enum": [
"anyURI",
"boolean",
"date",
"dateTime",
"dateTimeStamp",
"decimal",
"integer",
"long",
"int",
"short",
"nonNegativeInteger",
"positiveInteger",
"unsignedLong",
"unsignedInt",
"unsignedShort",
"nonPositiveInteger",
"negativeInteger",
"double",
"float",
"string",
"language",
"time"
],
"type": "string"
},
"keywordTypes": {
"description": "A keyword or list of keywords relevant to the cube",
"oneOf": [
{
"$ref": "#/definitions/v1.0/types/keyword"
},
{
"items": {
"$ref": "#/definitions/v1.0/types/keyword"
},
"type": "array"
}
]
},
"themeTypes": {
"additionalProperties": {
"oneOf": [
{
"$ref": "#/definitions/v1.0/types/theme"
},
{
"themeList": {
"description": "A list of themes",
"items": {
"$ref": "#/definitions/v1.0/types/theme"
},
"type": "array"
}
}
]
},
"description": "A theme or list of themes that describe the focus of the data"
},
"types": {
"definition_uri": {
"description": "A string describing a theme",
"format": "uri",
"type": "string"
},
"keyword": {
"description": "A string describing a keyword",
"type": "string"
},
"organisation": {
"$ref": "http://purl.org/csv-cubed/resources/organisations.json#/uris",
"description": "A URI defining an organisation"
},
"theme": {
"$ref": "http://purl.org/csv-cubed/resources/themes.json#/uris",
"description": "A URI describing a theme"
}
},
"valueTypes": {
"attributeValueType": {
"additionalProperties": false,
"description": "A new attribute value",
"properties": {
"definition_uri": {
"description": "The URI link to an existing definition",
"format": "uri",
"type": "string"
},
"description": {
"description": "The description of the attribute values",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/attribute-values.json#/uris",
"description": "The URI to an existing attribute values to extend"
},
"label": {
"description": "A label describing this attribute value",
"type": "string"
}
},
"required": [
"label"
],
"type": "object"
},
"measureType": {
"additionalProperties": false,
"description": "A new measure",
"properties": {
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Measure"
},
"description": {
"description": "A explanation of what the Measure represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/measures.json#/uris",
"description": "URI of an Existing Measure to reuse or extend"
},
"label": {
"description": "Label for the Measure",
"type": "string"
}
},
"required": [
"label"
],
"type": "object"
},
"unitType": {
"additionalProperties": false,
"description": "A new unit",
"properties": {
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Unit"
},
"description": {
"description": "A explanation of what the Unit represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/units.json#/uris",
"description": "URI of an existing Unit to reuse"
},
"label": {
"description": "Label describing the Unit",
"type": "string"
},
"quantity_kind": {
"$ref": "http://purl.org/csv-cubed/resources/quantity-kinds.json#/uris",
"description": "The QUDT quantity kind this unit is used to measure"
},
"scaling_factor": {
"description": "Scaling factor of the observation to base unit",
"type": "number"
},
"si_scaling_factor": {
"description": "Scaling factor to convert from this unit to the SI base unit defined in the unit's quantity_kind",
"type": "number"
}
},
"required": [
"label"
],
"type": "object"
}
}
}
},
"description": "Schema to be used for creation & validation of a single csv-cubed-flavoured linked data cube in CSV-W format",
"id": "https://purl.org/csv-cubed/qube-config/v1.3",
"properties": {
"$schema": {
"default": "https://purl.org/csv-cubed/qube-config/v1.3",
"type": "string"
},
"columns": {
"additionalProperties": {
"anyOf": [
{
"$ref": "#/definitions/v1.0/columnTypes/Dimension"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Attribute_Resource_New"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Attribute_Resource_Existing"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Attribute_Literal"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Measures_New"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Measures_Existing"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Observations"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Units_New"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Units_Existing"
},
{
"const": false,
"description": "This column will be present in the CSV but will not be converted to RDF",
"type": "boolean"
}
],
"description": "Column's meaning in the data cube"
},
"description": "Map of CSV column titles to definitions of what the column represents (a dimension, an attribute, observations, units or measures). If a column needs to be suppressed (i.e. skipped), the following notation can be used: {'column_name': false}"
},
"creator": {
"$ref": "http://purl.org/csv-cubed/resources/organisations.json#/uris",
"description": "The creator of the data set (uri)"
},
"dataset_issued": {
"description": "Date time that the data set was initially published in ISO 8601 format, e.g. 2022-03-31 or 2022-03-31T12:54:30Z",
"type": "string"
},
"dataset_modified": {
"description": "Date time that the data set was last modified published in ISO 8601 format, e.g. 2022-03-31 or 2022-03-31T12:54:30Z",
"type": "string"
},
"description": {
"description": "A longer description of the cube",
"type": "string"
},
"id": {
"description": "A unique id for the cube",
"type": "string"
},
"keywords": {
"$ref": "#/definitions/v1.0/keywordTypes"
},
"license": {
"$ref": "http://purl.org/csv-cubed/resources/licenses.json#/uris",
"description": "URI that represents the copyright license applying to this cube"
},
"public_contact_point_uri": {
"description": "URI that provides a public contact point for discussion of the data set, e.g. mailto:[email protected]",
"format": "uri",
"type": "string"
},
"publisher": {
"$ref": "http://purl.org/csv-cubed/resources/organisations.json#/uris",
"description": "The publisher of the data set (uri)"
},
"summary": {
"description": "A shorter summary of the data set",
"type": "string"
},
"themes": {
"$ref": "#/definitions/v1.0/themeTypes"
},
"title": {
"description": "A title for this data set",
"type": "string"
}
},
"required": [
"$schema"
],
"title": "Schema for a qb-config cube",
"type": "object"
} | Apache-2.0 | en |
GSS-Cogs/csvcubed | 55905b98a50c452f0ed999cc8f7ea6f84eae3e22 | 2022-06-09T08:54:45 | src/csvcubed/schema/codelist-config/v1_0/schema.json | 10 | 2024-05-28T03:38:54.121914Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"definitions": {
"v1.0": {
"concept": {
"description": "A concept in the code list.",
"properties": {
"children": {
"$ref": "#/definitions/v1.0/concepts"
},
"description": {
"description": "Description of the concept.",
"type": "string"
},
"label": {
"description": "Label of the concept.",
"type": "string"
},
"notation": {
"description": "Notation of the concept.",
"type": "string"
},
"same_as": {
"description": "Reference to a concept defined elsewhere.",
"format": "uri",
"type": "string"
},
"sort_order": {
"description": "Sort order of the concept.",
"type": "integer"
}
},
"required": [
"label",
"notation"
],
"type": "object"
},
"concepts": {
"description": "List of concepts in the code list.",
"items": {
"$ref": "#/definitions/v1.0/concept"
},
"type": "array",
"uniqueItems": true
},
"keywordTypes": {
"description": "A keyword or list of keywords relevant to the code list.",
"oneOf": [
{
"$ref": "#/definitions/v1.0/types/keyword"
},
{
"items": {
"$ref": "#/definitions/v1.0/types/keyword"
},
"type": "array"
}
]
},
"themeTypes": {
"additionalProperties": {
"oneOf": [
{
"$ref": "#/definitions/v1.0/types/theme"
},
{
"themeList": {
"description": "A list of themes.",
"items": {
"$ref": "#/definitions/v1.0/types/theme"
},
"type": "array"
}
}
]
},
"description": "A theme or list of themes that describe the focus of the code list."
},
"types": {
"keyword": {
"description": "A string describing a keyword.",
"type": "string"
},
"theme": {
"$ref": "http://purl.org/csv-cubed/resources/themes.json#/uris",
"description": "A URI describing a theme."
}
}
}
},
"description": "Schema to be used for creation and validation of a single codelist in CSV-W format.",
"id": "https://purl.org/csv-cubed/code-list-config/v1.0",
"properties": {
"$schema": {
"default": "https://purl.org/csv-cubed/code-list-config/v1.0",
"type": "string"
},
"concepts": {
"$ref": "#/definitions/v1.0/concepts"
},
"creator": {
"$ref": "http://purl.org/csv-cubed/resources/organisations.json#/uris",
"description": "The creator of the code list (uri)."
},
"dataset_issued": {
"description": "Date time that the code list was initially published in ISO 8601 format, e.g. 2022-03-31 or 2022-03-31T12:54:30Z.",
"type": "string"
},
"dataset_modified": {
"description": "Date time that the code list was last modified published in ISO 8601 format, e.g. 2022-03-31 or 2022-03-31T12:54:30Z.",
"type": "string"
},
"description": {
"description": "A long description of the code list.",
"type": "string"
},
"id": {
"description": "A unique id for the code list.",
"type": "string"
},
"keywords": {
"$ref": "#/definitions/v1.0/keywordTypes"
},
"license": {
"$ref": "http://purl.org/csv-cubed/resources/licenses.json#/uris",
"description": "URI that represents the copyright license applying to this code list."
},
"publisher": {
"$ref": "http://purl.org/csv-cubed/resources/organisations.json#/uris",
"description": "The publisher of the code list (uri)."
},
"sort": {
"description": "Sort strategy for the concepts.",
"properties": {
"by": {
"default": "label",
"description": "label (default) or notation",
"enum": [
"label",
"notation"
],
"type": "string"
},
"method": {
"default": "ascending",
"description": "ascending (default) or descending",
"enum": [
"ascending",
"descending"
],
"type": "string"
}
},
"required": [
"by",
"method"
],
"type": "object"
},
"summary": {
"description": "A short summary of the code list.",
"type": "string"
},
"themes": {
"$ref": "#/definitions/v1.0/themeTypes"
},
"title": {
"description": "A title for the code list.",
"type": "string"
}
},
"required": [],
"title": "Schema for a codelist.",
"type": "object"
} | Apache-2.0 | en |
GSS-Cogs/csvcubed | cad464807a4d35c44e0687df98e8bdb3ee225fee | 2022-08-23T12:37:52 | src/csvcubed/schema/codelist-config/v1_1/schema.json | 10 | 2024-05-28T03:38:54.121914Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"definitions": {
"v1.0": {
"concept": {
"description": "A concept in the code list.",
"properties": {
"children": {
"$ref": "#/definitions/v1.0/concepts"
},
"description": {
"description": "Description of the concept.",
"type": "string"
},
"label": {
"description": "Label of the concept.",
"type": "string"
},
"notation": {
"description": "Notation of the concept.",
"type": "string"
},
"same_as": {
"description": "Reference to a concept defined elsewhere.",
"format": "uri",
"type": "string"
},
"sort_order": {
"description": "Sort order of the concept.",
"type": "integer"
},
"uri_safe_identifier_override": {
"description": "Uri safe identifier for the concept.",
"type": "string"
}
},
"required": [
"label",
"notation"
],
"type": "object"
},
"concepts": {
"description": "List of concepts in the code list.",
"items": {
"$ref": "#/definitions/v1.0/concept"
},
"type": "array",
"uniqueItems": true
},
"keywordTypes": {
"description": "A keyword or list of keywords relevant to the code list.",
"oneOf": [
{
"$ref": "#/definitions/v1.0/types/keyword"
},
{
"items": {
"$ref": "#/definitions/v1.0/types/keyword"
},
"type": "array"
}
]
},
"themeTypes": {
"additionalProperties": {
"oneOf": [
{
"$ref": "#/definitions/v1.0/types/theme"
},
{
"themeList": {
"description": "A list of themes.",
"items": {
"$ref": "#/definitions/v1.0/types/theme"
},
"type": "array"
}
}
]
},
"description": "A theme or list of themes that describe the focus of the code list."
},
"types": {
"keyword": {
"description": "A string describing a keyword.",
"type": "string"
},
"theme": {
"$ref": "http://purl.org/csv-cubed/resources/themes.json#/uris",
"description": "A URI describing a theme."
}
}
}
},
"description": "Schema to be used for creation and validation of a single codelist in CSV-W format.",
"id": "https://purl.org/csv-cubed/code-list-config/v1.1",
"properties": {
"$schema": {
"default": "https://purl.org/csv-cubed/code-list-config/v1.1",
"type": "string"
},
"concepts": {
"$ref": "#/definitions/v1.0/concepts"
},
"creator": {
"$ref": "http://purl.org/csv-cubed/resources/organisations.json#/uris",
"description": "The creator of the code list (uri)."
},
"dataset_issued": {
"description": "Date time that the code list was initially published in ISO 8601 format, e.g. 2022-03-31 or 2022-03-31T12:54:30Z.",
"type": "string"
},
"dataset_modified": {
"description": "Date time that the code list was last modified published in ISO 8601 format, e.g. 2022-03-31 or 2022-03-31T12:54:30Z.",
"type": "string"
},
"description": {
"description": "A long description of the code list.",
"type": "string"
},
"id": {
"description": "A unique id for the code list.",
"type": "string"
},
"keywords": {
"$ref": "#/definitions/v1.0/keywordTypes"
},
"license": {
"$ref": "http://purl.org/csv-cubed/resources/licenses.json#/uris",
"description": "URI that represents the copyright license applying to this code list."
},
"publisher": {
"$ref": "http://purl.org/csv-cubed/resources/organisations.json#/uris",
"description": "The publisher of the code list (uri)."
},
"sort": {
"description": "Sort strategy for the concepts.",
"properties": {
"by": {
"default": "label",
"description": "label (default) or notation",
"enum": [
"label",
"notation"
],
"type": "string"
},
"method": {
"default": "ascending",
"description": "ascending (default) or descending",
"enum": [
"ascending",
"descending"
],
"type": "string"
}
},
"required": [
"by",
"method"
],
"type": "object"
},
"summary": {
"description": "A short summary of the code list.",
"type": "string"
},
"themes": {
"$ref": "#/definitions/v1.0/themeTypes"
},
"title": {
"description": "A title for the code list.",
"type": "string"
}
},
"required": [
"title"
],
"title": "Schema for a codelist.",
"type": "object"
} | Apache-2.0 | en |
GSS-Cogs/csvcubed | 55905b98a50c452f0ed999cc8f7ea6f84eae3e22 | 2022-06-09T08:54:45 | src/csvcubed/schema/cube-config/v1_1/schema.json | 10 | 2024-05-28T03:38:54.121914Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"definitions": {
"v1.0": {
"columnTypes": {
"Attribute_Literal": {
"additionalProperties": false,
"description": "This column represents an attribute (with resource values) of the cube",
"properties": {
"data_type": {
"$ref": "#/definitions/v1.0/dataTypes",
"description": "The data type of the attribute values"
},
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Attribute"
},
"description": {
"description": "A explanation of what the Attribute represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/attributes.json#/uris/literalValues",
"description": "URI of an existing attribute to reuse or extend"
},
"label": {
"description": "Label describing the Attribute",
"type": "string"
},
"required": {
"default": false,
"description": "Whether or not it is required that every observation has a value for this attribute",
"type": "boolean"
},
"type": {
"const": "attribute",
"description": "This column represents an attribute of the cube",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"Attribute_Resource": {
"additionalProperties": false,
"description": "This column represents an attribute (with literal values) of the cube",
"oneOf": [
{
"required": [
"type"
]
},
{
"required": [
"from_template"
]
}
],
"properties": {
"cell_uri_template": {
"description": "A template used to map the cell values in this column into URIs, e.g. 'http://example.com/attribute-values/{+column_csvw_name}'",
"format": "uri",
"type": "string"
},
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Attribute"
},
"description": {
"description": "A explanation of what the Attribute represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/attributes.json#/uris/resourceValues",
"description": "URI of an existing attribute to reuse or extend"
},
"from_template": {
"$ref": "#/definitions/v1.0/column_templates/attribute_resource"
},
"label": {
"description": "Label describing the Attribute",
"type": "string"
},
"type": {
"const": "attribute",
"description": "This column represents an attribute of the cube",
"type": "string"
},
"values": {
"oneOf": [
{
"default": true,
"description": "Whether to automatically generate attribute value resources for each unique value in the column",
"type": "boolean"
},
{
"description": "The distinct attribute values which can be used in the column",
"items": {
"$ref": "#/definitions/v1.0/valueTypes/attributeValueType"
},
"type": "array"
}
]
}
},
"type": "object"
},
"Dimension": {
"additionalProperties": false,
"description": "This column represents a dimension of the cube",
"properties": {
"cell_uri_template": {
"description": "A template used to map the cell values in this column into URIs, e.g. 'http://example.com/code-list/{+column_csvw_name}'",
"format": "uri",
"type": "string"
},
"code_list": {
"description": "A code list defines the unique values permitted in a dimension",
"oneOf": [
{
"default": true,
"description": "Whether or not to generate a code list defining the unique values permitted in this dimension",
"type": "boolean"
},
{
"$ref": "http://purl.org/csv-cubed/resources/code-lists.json#/uris",
"description": "The URI of a code list defining the unique values permitted in this dimension"
},
{
"description": "The path to the code list json defined using the code list config schema",
"type": "string"
},
{
"$ref": "https://purl.org/csv-cubed/code-list-config/v1.0",
"description": "Inline code list"
}
]
},
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Dimension"
},
"description": {
"description": "A explanation of what the Dimension represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/dimensions.json#/uris",
"description": "URI of an existing dimension to reuse or extend"
},
"from_template": {
"$ref": "#/definitions/v1.0/column_templates/dimension"
},
"label": {
"description": "Label describing the Dimension",
"type": "string"
},
"type": {
"const": "dimension",
"description": "This column represents a dimension of the cube",
"type": "string"
}
},
"required": [],
"type": "object"
},
"Measures": {
"additionalProperties": false,
"description": "This column represents the phenomenon which has been measured",
"properties": {
"cell_uri_template": {
"description": "A template used to map the cell values in this column into URIs, e.g. 'http://example.com/measures/{+column_csvw_name}'",
"format": "uri",
"type": "string"
},
"type": {
"const": "measures",
"description": "This column represents the phenomenon which has been measured",
"type": "string"
},
"values": {
"oneOf": [
{
"default": true,
"description": "Whether to automatically measure resources for each unique value in the column",
"type": "boolean"
},
{
"description": "A list of measures permitted in this column.",
"items": {
"$ref": "#/definitions/v1.0/valueTypes/measureType"
},
"type": "array"
}
]
}
},
"required": [
"type"
],
"type": "object"
},
"Observations": {
"additionalProperties": false,
"description": "This column holds observed/recorded values",
"properties": {
"data_type": {
"$ref": "#/definitions/v1.0/dataTypes"
},
"measure": {
"$ref": "#/definitions/v1.0/valueTypes/measureType",
"description": "The characteristic which was measured in all observation"
},
"type": {
"const": "observations",
"description": "Column type.",
"type": "string"
},
"unit": {
"$ref": "#/definitions/v1.0/valueTypes/unitType",
"description": "The unit that all observations were measured in"
}
},
"required": [
"type"
],
"type": "object"
},
"Units": {
"additionalProperties": false,
"description": "This column represents the unit of measure in which observations were recorded",
"properties": {
"type": {
"const": "units",
"description": "This column represents the unit of measure in which observations were recorded",
"type": "string"
},
"values": {
"description": "The Units used in this dataset.",
"oneOf": [
{
"default": true,
"description": "Whether to automatically generate new units from the unique values in this column.",
"type": "boolean"
},
{
"description": "A list of units permitted in this column.",
"items": {
"$ref": "#/definitions/v1.0/valueTypes/unitType"
},
"type": "array"
}
]
}
},
"required": [
"type"
],
"type": "object"
}
},
"column_templates": {
"attribute_resource": {
"description": "Templates for common attribute columns with resource values",
"enum": [
"observation-status"
],
"type": "string"
},
"comment": "This is where you should place all column template identifiers. Ensure you segregate them into the appropriate column type.",
"dimension": {
"description": "Templates for common dimension columns",
"enum": [
"year",
"half-year",
"quarter",
"month",
"week",
"day",
"hour",
"minute",
"second",
"government-year",
"government-half-year",
"government-quarter",
"government-week",
"gregorian-instant"
],
"type": "string"
}
},
"dataTypes": {
"default": "decimal",
"enum": [
"anyURI",
"boolean",
"date",
"dateTime",
"dateTimeStamp",
"decimal",
"integer",
"long",
"int",
"short",
"nonNegativeInteger",
"positiveInteger",
"unsignedLong",
"unsignedInt",
"unsignedShort",
"nonPositiveInteger",
"negativeInteger",
"double",
"float",
"string",
"language",
"time"
],
"type": "string"
},
"keywordTypes": {
"description": "A keyword or list of keywords relevant to the cube",
"oneOf": [
{
"$ref": "#/definitions/v1.0/types/keyword"
},
{
"items": {
"$ref": "#/definitions/v1.0/types/keyword"
},
"type": "array"
}
]
},
"themeTypes": {
"additionalProperties": {
"oneOf": [
{
"$ref": "#/definitions/v1.0/types/theme"
},
{
"themeList": {
"description": "A list of themes",
"items": {
"$ref": "#/definitions/v1.0/types/theme"
},
"type": "array"
}
}
]
},
"description": "A theme or list of themes that describe the focus of the data"
},
"types": {
"definition_uri": {
"description": "A string describing a theme",
"format": "uri",
"type": "string"
},
"keyword": {
"description": "A string describing a keyword",
"type": "string"
},
"organisation": {
"$ref": "http://purl.org/csv-cubed/resources/organisations.json#/uris",
"description": "A URI defining an organisation."
},
"theme": {
"$ref": "http://purl.org/csv-cubed/resources/themes.json#/uris",
"description": "A URI describing a theme"
}
},
"valueTypes": {
"attributeValueType": {
"additionalProperties": false,
"properties": {
"definition_uri": {
"description": "The URI link to an existing definition",
"format": "uri",
"type": "string"
},
"description": {
"description": "The description of the attribute values",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/attribute-values.json#/uris",
"description": "The URI to an existing attribute values to extend"
},
"label": {
"description": "A label describing this attribute value",
"type": "string"
}
},
"required": [
"label"
],
"type": "object"
},
"measureType": {
"additionalProperties": false,
"properties": {
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Measure"
},
"description": {
"description": "A explanation of what the Measure represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/measures.json#/uris",
"description": "URI of an Existing Measure to reuse or extend"
},
"label": {
"description": "Label for the Measure",
"type": "string"
}
},
"required": [
"label"
],
"type": "object"
},
"unitType": {
"additionalProperties": false,
"properties": {
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Unit"
},
"description": {
"description": "A explanation of what the Unit represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/units.json#/uris",
"description": "URI of an existing Unit to reuse"
},
"label": {
"description": "Label describing the Unit",
"type": "string"
},
"quantity_kind": {
"$ref": "http://purl.org/csv-cubed/resources/quantity-kinds.json#/uris",
"description": "The QUDT quantity kind this unit is used to measure"
},
"scaling_factor": {
"description": "Scaling factor of the observation to base unit",
"type": "number"
},
"si_scaling_factor": {
"description": "Scaling factor to convert from this unit to the SI base unit defined in the unit's quantity_kind",
"type": "number"
}
},
"required": [
"label"
],
"type": "object"
}
}
}
},
"description": "Schema to be used for creation & validation of a single csv-cubed-flavoured linked data cube in CSV-W format",
"id": "https://purl.org/csv-cubed/qube-config/v1.1",
"properties": {
"$schema": {
"default": "https://purl.org/csv-cubed/qube-config/v1.1",
"type": "string"
},
"columns": {
"additionalProperties": {
"anyOf": [
{
"$ref": "#/definitions/v1.0/columnTypes/Dimension"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Attribute_Resource"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Attribute_Literal"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Measures"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Observations"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Units"
}
],
"description": "Column's meaning in the data cube"
},
"description": "Map of CSV column titles to definitions of what the column represents (a dimension, an attribute, observations, units or measures)"
},
"creator": {
"$ref": "http://purl.org/csv-cubed/resources/organisations.json#/uris",
"description": "The creator of the data set (uri)"
},
"dataset_issued": {
"description": "Date time that the data set was initially published in ISO 8601 format, e.g. 2022-03-31 or 2022-03-31T12:54:30Z",
"type": "string"
},
"dataset_modified": {
"description": "Date time that the data set was last modified published in ISO 8601 format, e.g. 2022-03-31 or 2022-03-31T12:54:30Z",
"type": "string"
},
"description": {
"description": "A longer description of the cube",
"type": "string"
},
"id": {
"description": "A unique id for the cube",
"type": "string"
},
"keywords": {
"$ref": "#/definitions/v1.0/keywordTypes"
},
"license": {
"$ref": "http://purl.org/csv-cubed/resources/licenses.json#/uris",
"description": "URI that represents the copyright license applying to this cube"
},
"public_contact_point_uri": {
"description": "URI that provides a public contact point for discussion of the data set, e.g. mailto:[email protected]",
"format": "uri",
"type": "string"
},
"publisher": {
"$ref": "http://purl.org/csv-cubed/resources/organisations.json#/uris",
"description": "The publisher of the data set (uri)"
},
"summary": {
"description": "A shorter summary of the data set",
"type": "string"
},
"themes": {
"$ref": "#/definitions/v1.0/themeTypes"
},
"title": {
"description": "A title for this data set",
"type": "string"
}
},
"required": [
"$schema"
],
"title": "Schema for a qb-config cube",
"type": "object"
} | Apache-2.0 | en |
GSS-Cogs/csvcubed | cad464807a4d35c44e0687df98e8bdb3ee225fee | 2022-08-23T12:37:52 | src/csvcubed/schema/cube-config/v1_3/schema.json | 10 | 2024-05-28T03:38:54.121914Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"definitions": {
"v1.0": {
"columnTypes": {
"Attribute_Literal": {
"additionalProperties": false,
"description": "This column represents an attribute (with literal values) of the cube",
"properties": {
"data_type": {
"$ref": "#/definitions/v1.0/dataTypes",
"description": "The data type of the attribute values"
},
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Attribute"
},
"description": {
"description": "A explanation of what the Attribute represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/attributes.json#/uris/literalValues",
"description": "URI of an existing attribute to reuse or extend"
},
"label": {
"description": "Label describing the Attribute",
"type": "string"
},
"required": {
"default": false,
"description": "Whether or not it is required that every observation has a value for this attribute",
"type": "boolean"
},
"type": {
"const": "attribute",
"description": "This column represents an attribute of the cube",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"Attribute_Resource_Existing": {
"additionalProperties": false,
"description": "This column represents an attribute (with resource values) of the cube",
"oneOf": [
{
"required": [
"type"
]
},
{
"required": [
"from_template"
]
}
],
"properties": {
"cell_uri_template": {
"description": "A template used to map the cell values in this column into URIs, e.g. 'http://example.com/attribute-values/{+column_csvw_name}'",
"format": "uri",
"type": "string"
},
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Attribute"
},
"description": {
"description": "A explanation of what the Attribute represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/attributes.json#/uris/resourceValues",
"description": "URI of an existing attribute to reuse or extend"
},
"from_template": {
"$ref": "#/definitions/v1.0/column_templates/attribute_resource"
},
"label": {
"description": "Label describing the Attribute",
"type": "string"
},
"required": {
"default": false,
"description": "Whether or not it is required that every observation has a value for this attribute",
"type": "boolean"
},
"type": {
"const": "attribute",
"description": "This column represents an attribute of the cube",
"type": "string"
}
},
"type": "object"
},
"Attribute_Resource_New": {
"additionalProperties": false,
"description": "This column represents an attribute (with resource values) of the cube",
"oneOf": [
{
"required": [
"type"
]
},
{
"required": [
"from_template"
]
}
],
"properties": {
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Attribute"
},
"description": {
"description": "A explanation of what the Attribute represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/attributes.json#/uris/resourceValues",
"description": "URI of an existing attribute to reuse or extend"
},
"from_template": {
"$ref": "#/definitions/v1.0/column_templates/attribute_resource"
},
"label": {
"description": "Label describing the Attribute",
"type": "string"
},
"required": {
"default": false,
"description": "Whether or not it is required that every observation has a value for this attribute",
"type": "boolean"
},
"type": {
"const": "attribute",
"description": "This column represents an attribute of the cube",
"type": "string"
},
"values": {
"oneOf": [
{
"default": true,
"description": "Whether to automatically generate attribute value resources for each unique value in the column",
"type": "boolean"
},
{
"description": "The distinct attribute values which can be used in the column",
"items": {
"$ref": "#/definitions/v1.0/valueTypes/attributeValueType"
},
"type": "array"
}
]
}
},
"type": "object"
},
"Dimension": {
"additionalProperties": false,
"description": "This column represents a dimension of the cube",
"properties": {
"cell_uri_template": {
"description": "A template used to map the cell values in this column into URIs, e.g. 'http://example.com/code-list/{+column_csvw_name}'",
"format": "uri",
"type": "string"
},
"code_list": {
"description": "A code list defines the unique values permitted in a dimension",
"oneOf": [
{
"default": true,
"description": "Whether or not to generate a code list defining the unique values permitted in this dimension",
"type": "boolean"
},
{
"$ref": "http://purl.org/csv-cubed/resources/code-lists.json#/uris",
"description": "The URI of a code list defining the unique values permitted in this dimension"
},
{
"description": "The path to the code list json defined using the code list config schema",
"type": "string"
},
{
"$ref": "https://purl.org/csv-cubed/code-list-config/v1.1",
"description": "Inline code list"
}
]
},
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Dimension"
},
"description": {
"description": "A explanation of what the Dimension represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/dimensions.json#/uris",
"description": "URI of an existing dimension to reuse or extend"
},
"from_template": {
"$ref": "#/definitions/v1.0/column_templates/dimension"
},
"label": {
"description": "Label describing the Dimension",
"type": "string"
},
"type": {
"const": "dimension",
"description": "This column represents a dimension of the cube",
"type": "string"
}
},
"type": "object"
},
"Measures_Existing": {
"additionalProperties": false,
"properties": {
"cell_uri_template": {
"description": "A template used to map the cell values in this column into URIs, e.g. 'http://example.com/measures/{+column_csvw_name}'",
"format": "uri",
"type": "string"
},
"type": {
"const": "measures",
"description": "This column represents the phenomenon which has been measured",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"Measures_New": {
"additionalProperties": false,
"description": "This column represents the phenomenon which has been measured",
"properties": {
"type": {
"const": "measures",
"description": "This column represents the phenomenon which has been measured",
"type": "string"
},
"values": {
"oneOf": [
{
"default": true,
"description": "Whether to automatically measure resources for each unique value in the column",
"type": "boolean"
},
{
"description": "A list of measures permitted in this column.",
"items": {
"$ref": "#/definitions/v1.0/valueTypes/measureType"
},
"type": "array"
}
]
}
},
"required": [
"type"
],
"type": "object"
},
"Observations": {
"additionalProperties": false,
"description": "This column holds observed/recorded values",
"properties": {
"data_type": {
"$ref": "#/definitions/v1.0/dataTypes"
},
"measure": {
"$ref": "#/definitions/v1.0/valueTypes/measureType",
"description": "The characteristic which was measured in all observation"
},
"type": {
"const": "observations",
"description": "Column type.",
"type": "string"
},
"unit": {
"$ref": "#/definitions/v1.0/valueTypes/unitType",
"description": "The unit that all observations were measured in"
}
},
"required": [
"type"
],
"type": "object"
},
"Units_Existing": {
"additionalProperties": false,
"description": "This column represents the unit of measure in which observations were recorded",
"oneOf": [
{
"required": [
"type"
]
},
{
"required": [
"from_template"
]
}
],
"properties": {
"cell_uri_template": {
"description": "A template used to map the cell values in this column into URIs, e.g. 'http://example.com/measures/{+column_csvw_name}'",
"format": "uri",
"type": "string"
},
"from_template": {
"$ref": "#/definitions/v1.0/column_templates/units_existing"
},
"type": {
"const": "units",
"description": "This column represents the unit of measure in which observations were recorded",
"type": "string"
}
},
"type": "object"
},
"Units_New": {
"additionalProperties": false,
"description": "This column represents the unit of measure in which observations were recorded",
"properties": {
"type": {
"const": "units",
"description": "This column represents the unit of measure in which observations were recorded",
"type": "string"
},
"values": {
"description": "The Units used in this dataset.",
"oneOf": [
{
"default": true,
"description": "Whether to automatically generate new units from the unique values in this column.",
"type": "boolean"
},
{
"description": "A list of units permitted in this column.",
"items": {
"$ref": "#/definitions/v1.0/valueTypes/unitType"
},
"type": "array"
}
]
}
},
"required": [
"type"
],
"type": "object"
}
},
"column_templates": {
"attribute_resource": {
"description": "Templates for common attribute columns with resource values",
"enum": [
"observation-status"
],
"type": "string"
},
"comment": "This is where you should place all column template identifiers. Ensure you segregate them into the appropriate column type.",
"dimension": {
"description": "Templates for common dimension columns",
"enum": [
"year",
"half-year",
"quarter",
"month",
"week",
"day",
"hour",
"minute",
"second",
"government-year",
"government-half-year",
"government-quarter",
"government-week",
"gregorian-instant"
],
"type": "string"
},
"units_existing": {
"description": "Templates for common existing unit columns",
"enum": [
"qudt"
],
"type": "string"
}
},
"dataTypes": {
"default": "decimal",
"enum": [
"anyURI",
"boolean",
"date",
"dateTime",
"dateTimeStamp",
"decimal",
"integer",
"long",
"int",
"short",
"nonNegativeInteger",
"positiveInteger",
"unsignedLong",
"unsignedInt",
"unsignedShort",
"nonPositiveInteger",
"negativeInteger",
"double",
"float",
"string",
"language",
"time"
],
"type": "string"
},
"keywordTypes": {
"description": "A keyword or list of keywords relevant to the cube",
"oneOf": [
{
"$ref": "#/definitions/v1.0/types/keyword"
},
{
"items": {
"$ref": "#/definitions/v1.0/types/keyword"
},
"type": "array"
}
]
},
"themeTypes": {
"additionalProperties": {
"oneOf": [
{
"$ref": "#/definitions/v1.0/types/theme"
},
{
"themeList": {
"description": "A list of themes",
"items": {
"$ref": "#/definitions/v1.0/types/theme"
},
"type": "array"
}
}
]
},
"description": "A theme or list of themes that describe the focus of the data"
},
"types": {
"definition_uri": {
"description": "A string describing a theme",
"format": "uri",
"type": "string"
},
"keyword": {
"description": "A string describing a keyword",
"type": "string"
},
"organisation": {
"$ref": "http://purl.org/csv-cubed/resources/organisations.json#/uris",
"description": "A URI defining an organisation."
},
"theme": {
"$ref": "http://purl.org/csv-cubed/resources/themes.json#/uris",
"description": "A URI describing a theme"
}
},
"valueTypes": {
"attributeValueType": {
"additionalProperties": false,
"properties": {
"definition_uri": {
"description": "The URI link to an existing definition",
"format": "uri",
"type": "string"
},
"description": {
"description": "The description of the attribute values",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/attribute-values.json#/uris",
"description": "The URI to an existing attribute values to extend"
},
"label": {
"description": "A label describing this attribute value",
"type": "string"
}
},
"required": [
"label"
],
"type": "object"
},
"measureType": {
"additionalProperties": false,
"properties": {
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Measure"
},
"description": {
"description": "A explanation of what the Measure represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/measures.json#/uris",
"description": "URI of an Existing Measure to reuse or extend"
},
"label": {
"description": "Label for the Measure",
"type": "string"
}
},
"required": [
"label"
],
"type": "object"
},
"unitType": {
"additionalProperties": false,
"properties": {
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Unit"
},
"description": {
"description": "A explanation of what the Unit represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/units.json#/uris",
"description": "URI of an existing Unit to reuse"
},
"label": {
"description": "Label describing the Unit",
"type": "string"
},
"quantity_kind": {
"$ref": "http://purl.org/csv-cubed/resources/quantity-kinds.json#/uris",
"description": "The QUDT quantity kind this unit is used to measure"
},
"scaling_factor": {
"description": "Scaling factor of the observation to base unit",
"type": "number"
},
"si_scaling_factor": {
"description": "Scaling factor to convert from this unit to the SI base unit defined in the unit's quantity_kind",
"type": "number"
}
},
"required": [
"label"
],
"type": "object"
}
}
}
},
"description": "Schema to be used for creation & validation of a single csv-cubed-flavoured linked data cube in CSV-W format",
"id": "https://purl.org/csv-cubed/qube-config/v1.3",
"properties": {
"$schema": {
"default": "https://purl.org/csv-cubed/qube-config/v1.3",
"type": "string"
},
"columns": {
"additionalProperties": {
"anyOf": [
{
"$ref": "#/definitions/v1.0/columnTypes/Dimension"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Attribute_Resource_New"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Attribute_Resource_Existing"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Attribute_Literal"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Measures_New"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Measures_Existing"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Observations"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Units_New"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Units_Existing"
},
{
"const": false,
"description": "This column will be present in the CSV but will not be converted to RDF.",
"type": "boolean"
}
],
"description": "Column's meaning in the data cube"
},
"description": "Map of CSV column titles to definitions of what the column represents (a dimension, an attribute, observations, units or measures). If a column needs to be suppressed (i.e. skipped), the following notation can be used: {'column_name': false}"
},
"creator": {
"$ref": "http://purl.org/csv-cubed/resources/organisations.json#/uris",
"description": "The creator of the data set (uri)"
},
"dataset_issued": {
"description": "Date time that the data set was initially published in ISO 8601 format, e.g. 2022-03-31 or 2022-03-31T12:54:30Z",
"type": "string"
},
"dataset_modified": {
"description": "Date time that the data set was last modified published in ISO 8601 format, e.g. 2022-03-31 or 2022-03-31T12:54:30Z",
"type": "string"
},
"description": {
"description": "A longer description of the cube",
"type": "string"
},
"id": {
"description": "A unique id for the cube",
"type": "string"
},
"keywords": {
"$ref": "#/definitions/v1.0/keywordTypes"
},
"license": {
"$ref": "http://purl.org/csv-cubed/resources/licenses.json#/uris",
"description": "URI that represents the copyright license applying to this cube"
},
"public_contact_point_uri": {
"description": "URI that provides a public contact point for discussion of the data set, e.g. mailto:[email protected]",
"format": "uri",
"type": "string"
},
"publisher": {
"$ref": "http://purl.org/csv-cubed/resources/organisations.json#/uris",
"description": "The publisher of the data set (uri)"
},
"summary": {
"description": "A shorter summary of the data set",
"type": "string"
},
"themes": {
"$ref": "#/definitions/v1.0/themeTypes"
},
"title": {
"description": "A title for this data set",
"type": "string"
}
},
"required": [
"$schema"
],
"title": "Schema for a qb-config cube",
"type": "object"
} | Apache-2.0 | en |
GSS-Cogs/csvcubed | 14f2c3deb27bb18848b11a45038fb57cc1a76a34 | 2023-02-13T09:27:27 | src/csvcubed/schema/cube-config/v1_4/schema.json | 10 | 2024-05-28T03:38:54.121914Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"definitions": {
"v1.0": {
"columnTypes": {
"Attribute_Literal": {
"additionalProperties": false,
"description": "This column represents an attribute (with literal values) of the cube",
"properties": {
"data_type": {
"$ref": "#/definitions/v1.0/dataTypes",
"description": "The data type of the attribute values"
},
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Attribute"
},
"describes_observations": {
"description": "The observed values column that this attribute describes.",
"type": "string"
},
"description": {
"description": "A explanation of what the Attribute represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/attributes.json#/uris/literalValues",
"description": "URI of an existing attribute to reuse or extend"
},
"label": {
"description": "Label describing the Attribute",
"type": "string"
},
"required": {
"default": false,
"description": "true/false - whether or not it is required that every observation has a value for this attribute",
"type": "boolean"
},
"type": {
"const": "attribute",
"description": "This column represents an attribute of the cube",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"Attribute_Resource_Existing": {
"additionalProperties": false,
"description": "This column represents an attribute (with resource values) of the cube (reusing an existing attribute definition)",
"oneOf": [
{
"required": [
"type"
]
},
{
"required": [
"from_template"
]
}
],
"properties": {
"cell_uri_template": {
"description": "A template used to map the cell values in this column into URIs, e.g. 'http://example.com/attribute-values/{+column_csvw_name}'",
"format": "uri",
"type": "string"
},
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Attribute"
},
"describes_observations": {
"description": "The observed values column that this attribute describes.",
"type": "string"
},
"description": {
"description": "A explanation of what the Attribute represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/attributes.json#/uris/resourceValues",
"description": "URI of an existing attribute to reuse or extend"
},
"from_template": {
"$ref": "#/definitions/v1.0/column_templates/attribute_resource"
},
"label": {
"description": "Label describing the Attribute",
"type": "string"
},
"required": {
"default": false,
"description": "true/false - whether it is required that every observation has a value for this attribute",
"type": "boolean"
},
"type": {
"const": "attribute",
"description": "This column represents an attribute of the cube",
"type": "string"
}
},
"type": "object"
},
"Attribute_Resource_New": {
"additionalProperties": false,
"description": "This column represents an attribute (with resource values) of the cube (creating a new attribute)",
"oneOf": [
{
"required": [
"type"
]
},
{
"required": [
"from_template"
]
}
],
"properties": {
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Attribute"
},
"describes_observations": {
"description": "The observed values column that this attribute describes.",
"type": "string"
},
"description": {
"description": "A explanation of what the Attribute represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/attributes.json#/uris/resourceValues",
"description": "URI of an existing attribute to reuse or extend"
},
"from_template": {
"$ref": "#/definitions/v1.0/column_templates/attribute_resource"
},
"label": {
"description": "Label describing the Attribute",
"type": "string"
},
"required": {
"default": false,
"description": "true/false - whether it is required that every observation has a value for this attribute",
"type": "boolean"
},
"type": {
"const": "attribute",
"description": "This column represents an attribute of the cube",
"type": "string"
},
"values": {
"oneOf": [
{
"default": true,
"description": "true/false - whether to automatically generate attribute value resources for each unique value in the column",
"type": "boolean"
},
{
"description": "The distinct attribute values which can be used in the column",
"items": {
"$ref": "#/definitions/v1.0/valueTypes/attributeValueType"
},
"type": "array"
}
]
}
},
"type": "object"
},
"Dimension": {
"additionalProperties": false,
"description": "This column represents a dimension of the cube",
"properties": {
"cell_uri_template": {
"description": "A template used to map the cell values in this column into URIs, e.g. 'http://example.com/code-list/{+column_csvw_name}'",
"format": "uri",
"type": "string"
},
"code_list": {
"description": "A code list defines the unique values permitted in a dimension",
"oneOf": [
{
"default": true,
"description": "true/false - whether to generate a code list defining the unique values permitted in this dimension",
"type": "boolean"
},
{
"$ref": "http://purl.org/csv-cubed/resources/code-lists.json#/uris",
"description": "The URI of a code list defining the unique values permitted in this dimension"
},
{
"description": "The path to the code list json defined using the code list config schema",
"type": "string"
},
{
"$ref": "https://purl.org/csv-cubed/code-list-config/v1.1",
"description": "Inline code list"
}
]
},
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Dimension"
},
"description": {
"description": "A explanation of what the Dimension represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/dimensions.json#/uris",
"description": "URI of an existing dimension to reuse or extend"
},
"from_template": {
"$ref": "#/definitions/v1.0/column_templates/dimension"
},
"label": {
"description": "Label describing the Dimension",
"type": "string"
},
"type": {
"const": "dimension",
"description": "This column represents a dimension of the cube",
"type": "string"
}
},
"type": "object"
},
"Measures_Existing": {
"additionalProperties": false,
"description": "This column represents the phenomenon which has been measured (reusing existing measure definitions)",
"properties": {
"cell_uri_template": {
"description": "A template used to map the cell values in this column into URIs, e.g. 'http://example.com/measures/{+column_csvw_name}'",
"format": "uri",
"type": "string"
},
"type": {
"const": "measures",
"description": "This column represents the phenomenon which has been measured",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"Measures_New": {
"additionalProperties": false,
"description": "This column represents the phenomenon which has been measured (defining new measures)",
"properties": {
"type": {
"const": "measures",
"description": "This column represents the phenomenon which has been measured",
"type": "string"
},
"values": {
"oneOf": [
{
"default": true,
"description": "true/false - whether to automatically generate measures for each unique value in the column",
"type": "boolean"
},
{
"description": "The list of measures permitted in this column",
"items": {
"$ref": "#/definitions/v1.0/valueTypes/measureType"
},
"type": "array"
}
]
}
},
"required": [
"type"
],
"type": "object"
},
"Observations": {
"additionalProperties": false,
"description": "This column holds observed/recorded values",
"properties": {
"data_type": {
"$ref": "#/definitions/v1.0/dataTypes"
},
"measure": {
"$ref": "#/definitions/v1.0/valueTypes/measureType",
"description": "The characteristic which was measured in all observation"
},
"type": {
"const": "observations",
"description": "Column type",
"type": "string"
},
"unit": {
"$ref": "#/definitions/v1.0/valueTypes/unitType",
"description": "The unit that all observations were measured in"
}
},
"required": [
"type"
],
"type": "object"
},
"Units_Existing": {
"additionalProperties": false,
"description": "This column represents the unit of measure in which observations were recorded (reusing existing unit definitions)",
"oneOf": [
{
"required": [
"type"
]
},
{
"required": [
"from_template"
]
}
],
"properties": {
"cell_uri_template": {
"description": "A template used to map the cell values in this column into URIs, e.g. 'http://example.com/measures/{+column_csvw_name}'",
"format": "uri",
"type": "string"
},
"describes_observations": {
"description": "The observed values column that these units describe.",
"type": "string"
},
"from_template": {
"$ref": "#/definitions/v1.0/column_templates/units_existing"
},
"type": {
"const": "units",
"description": "This column represents the unit of measure in which observations were recorded",
"type": "string"
}
},
"type": "object"
},
"Units_New": {
"additionalProperties": false,
"description": "This column represents the unit of measure in which observations were recorded (defining new units)",
"properties": {
"describes_observations": {
"description": "The observed values column that these units describe.",
"type": "string"
},
"type": {
"const": "units",
"description": "This column represents the unit of measure in which observations were recorded",
"type": "string"
},
"values": {
"description": "The Units used in this dataset",
"oneOf": [
{
"default": true,
"description": "true/false - whether to automatically generate new units from the unique values in this column",
"type": "boolean"
},
{
"description": "The list of distinct units in this column",
"items": {
"$ref": "#/definitions/v1.0/valueTypes/unitType"
},
"type": "array"
}
]
}
},
"required": [
"type"
],
"type": "object"
}
},
"column_templates": {
"attribute_resource": {
"description": "Templates for common attribute columns with resource values",
"enum": [
"observation-status"
],
"type": "string"
},
"comment": "This is where you should place all column template identifiers. Ensure you segregate them into the appropriate column type.",
"dimension": {
"description": "Templates for common dimension columns",
"enum": [
"year",
"half-year",
"quarter",
"month",
"week",
"day",
"hour",
"minute",
"second",
"government-year",
"government-half-year",
"government-quarter",
"government-week",
"mixed-period",
"gregorian-instant",
"gregorian-interval",
"statistical-geography"
],
"type": "string"
},
"units_existing": {
"description": "Templates for common existing unit columns",
"enum": [
"qudt"
],
"type": "string"
}
},
"dataTypes": {
"default": "decimal",
"enum": [
"anyURI",
"boolean",
"date",
"dateTime",
"dateTimeStamp",
"decimal",
"integer",
"long",
"int",
"short",
"nonNegativeInteger",
"positiveInteger",
"unsignedLong",
"unsignedInt",
"unsignedShort",
"nonPositiveInteger",
"negativeInteger",
"double",
"float",
"string",
"language",
"time"
],
"type": "string"
},
"keywordTypes": {
"description": "A keyword or list of keywords relevant to the cube",
"oneOf": [
{
"$ref": "#/definitions/v1.0/types/keyword"
},
{
"items": {
"$ref": "#/definitions/v1.0/types/keyword"
},
"type": "array"
}
]
},
"themeTypes": {
"additionalProperties": {
"oneOf": [
{
"$ref": "#/definitions/v1.0/types/theme"
},
{
"themeList": {
"description": "A list of themes",
"items": {
"$ref": "#/definitions/v1.0/types/theme"
},
"type": "array"
}
}
]
},
"description": "A theme or list of themes that describe the focus of the data"
},
"types": {
"definition_uri": {
"description": "A string describing a theme",
"format": "uri",
"type": "string"
},
"keyword": {
"description": "A string describing a keyword",
"type": "string"
},
"organisation": {
"$ref": "http://purl.org/csv-cubed/resources/organisations.json#/uris",
"description": "A URI defining an organisation"
},
"theme": {
"$ref": "http://purl.org/csv-cubed/resources/themes.json#/uris",
"description": "A URI describing a theme"
}
},
"valueTypes": {
"attributeValueType": {
"additionalProperties": false,
"description": "A new attribute value",
"properties": {
"definition_uri": {
"description": "The URI link to an existing definition",
"format": "uri",
"type": "string"
},
"description": {
"description": "The description of the attribute values",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/attribute-values.json#/uris",
"description": "The URI to an existing attribute values to extend"
},
"label": {
"description": "A label describing this attribute value",
"type": "string"
}
},
"required": [
"label"
],
"type": "object"
},
"measureType": {
"additionalProperties": false,
"description": "A new measure",
"properties": {
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Measure"
},
"description": {
"description": "A explanation of what the Measure represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/measures.json#/uris",
"description": "URI of an Existing Measure to reuse or extend"
},
"label": {
"description": "Label for the Measure",
"type": "string"
}
},
"required": [
"label"
],
"type": "object"
},
"unitType": {
"additionalProperties": false,
"description": "A new unit",
"properties": {
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Unit"
},
"description": {
"description": "A explanation of what the Unit represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/units.json#/uris",
"description": "URI of an existing Unit to reuse"
},
"label": {
"description": "Label describing the Unit",
"type": "string"
},
"quantity_kind": {
"$ref": "http://purl.org/csv-cubed/resources/quantity-kinds.json#/uris",
"description": "The QUDT quantity kind this unit is used to measure"
},
"scaling_factor": {
"description": "Scaling factor of the observation to base unit",
"type": "number"
},
"si_scaling_factor": {
"description": "Scaling factor to convert from this unit to the SI base unit defined in the unit's quantity_kind",
"type": "number"
}
},
"required": [
"label"
],
"type": "object"
}
}
}
},
"description": "Schema to be used for creation & validation of a single csv-cubed-flavoured linked data cube in CSV-W format",
"id": "https://purl.org/csv-cubed/qube-config/v1.4",
"properties": {
"$schema": {
"default": "https://purl.org/csv-cubed/qube-config/v1.4",
"type": "string"
},
"columns": {
"additionalProperties": {
"anyOf": [
{
"$ref": "#/definitions/v1.0/columnTypes/Dimension"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Attribute_Resource_New"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Attribute_Resource_Existing"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Attribute_Literal"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Measures_New"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Measures_Existing"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Observations"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Units_New"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Units_Existing"
},
{
"const": false,
"description": "This column will be present in the CSV but will not be converted to RDF",
"type": "boolean"
}
],
"description": "Column's meaning in the data cube"
},
"description": "Map of CSV column titles to definitions of what the column represents (a dimension, an attribute, observations, units or measures). If a column needs to be suppressed (i.e. skipped), the following notation can be used: {'column_name': false}"
},
"creator": {
"$ref": "http://purl.org/csv-cubed/resources/organisations.json#/uris",
"description": "The creator of the data set (uri)"
},
"dataset_issued": {
"description": "Date time that the data set was initially published in ISO 8601 format, e.g. 2022-03-31 or 2022-03-31T12:54:30Z",
"type": "string"
},
"dataset_modified": {
"description": "Date time that the data set was last modified published in ISO 8601 format, e.g. 2022-03-31 or 2022-03-31T12:54:30Z",
"type": "string"
},
"description": {
"description": "A longer description of the cube",
"type": "string"
},
"id": {
"description": "A unique id for the cube",
"type": "string"
},
"keywords": {
"$ref": "#/definitions/v1.0/keywordTypes"
},
"license": {
"$ref": "http://purl.org/csv-cubed/resources/licenses.json#/uris",
"description": "URI that represents the copyright license applying to this cube"
},
"public_contact_point_uri": {
"description": "URI that provides a public contact point for discussion of the data set, e.g. mailto:[email protected]",
"format": "uri",
"type": "string"
},
"publisher": {
"$ref": "http://purl.org/csv-cubed/resources/organisations.json#/uris",
"description": "The publisher of the data set (uri)"
},
"summary": {
"description": "A shorter summary of the data set",
"type": "string"
},
"themes": {
"$ref": "#/definitions/v1.0/themeTypes"
},
"title": {
"description": "A title for this data set",
"type": "string"
}
},
"required": [
"$schema"
],
"title": "Schema for a qb-config cube",
"type": "object"
} | Apache-2.0 | en |
GSS-Cogs/csvcubed | ad2359d76e87cc7c417325c0664027d9b08a3efc | 2023-02-20T16:17:43 | src/csvcubed/schema/cube-config/v1_4/schema.json | 10 | 2024-05-28T03:38:54.121914Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"definitions": {
"v1.0": {
"columnTypes": {
"Attribute_Literal": {
"additionalProperties": false,
"description": "This column represents an attribute (with literal values) of the cube",
"properties": {
"data_type": {
"$ref": "#/definitions/v1.0/dataTypes",
"description": "The data type of the attribute values"
},
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Attribute"
},
"describes_observations": {
"description": "The observed values column that this attribute describes.",
"type": "string"
},
"description": {
"description": "A explanation of what the Attribute represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/attributes.json#/uris/literalValues",
"description": "URI of an existing attribute to reuse or extend"
},
"label": {
"description": "Label describing the Attribute",
"type": "string"
},
"required": {
"default": false,
"description": "true/false - whether or not it is required that every observation has a value for this attribute",
"type": "boolean"
},
"type": {
"const": "attribute",
"description": "This column represents an attribute of the cube",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"Attribute_Resource_Existing": {
"additionalProperties": false,
"description": "This column represents an attribute (with resource values) of the cube (reusing an existing attribute definition)",
"oneOf": [
{
"required": [
"type"
]
},
{
"required": [
"from_template"
]
}
],
"properties": {
"cell_uri_template": {
"description": "A template used to map the cell values in this column into URIs, e.g. 'http://example.com/attribute-values/{+column_csvw_name}'",
"format": "uri",
"type": "string"
},
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Attribute"
},
"describes_observations": {
"description": "The observed values column that this attribute describes.",
"type": "string"
},
"description": {
"description": "A explanation of what the Attribute represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/attributes.json#/uris/resourceValues",
"description": "URI of an existing attribute to reuse or extend"
},
"from_template": {
"$ref": "#/definitions/v1.0/column_templates/attribute_resource"
},
"label": {
"description": "Label describing the Attribute",
"type": "string"
},
"required": {
"default": false,
"description": "true/false - whether it is required that every observation has a value for this attribute",
"type": "boolean"
},
"type": {
"const": "attribute",
"description": "This column represents an attribute of the cube",
"type": "string"
}
},
"type": "object"
},
"Attribute_Resource_New": {
"additionalProperties": false,
"description": "This column represents an attribute (with resource values) of the cube (creating a new attribute)",
"oneOf": [
{
"required": [
"type"
]
},
{
"required": [
"from_template"
]
}
],
"properties": {
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Attribute"
},
"describes_observations": {
"description": "The observed values column that this attribute describes.",
"type": "string"
},
"description": {
"description": "A explanation of what the Attribute represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/attributes.json#/uris/resourceValues",
"description": "URI of an existing attribute to reuse or extend"
},
"from_template": {
"$ref": "#/definitions/v1.0/column_templates/attribute_resource"
},
"label": {
"description": "Label describing the Attribute",
"type": "string"
},
"required": {
"default": false,
"description": "true/false - whether it is required that every observation has a value for this attribute",
"type": "boolean"
},
"type": {
"const": "attribute",
"description": "This column represents an attribute of the cube",
"type": "string"
},
"values": {
"oneOf": [
{
"default": true,
"description": "true/false - whether to automatically generate attribute value resources for each unique value in the column",
"type": "boolean"
},
{
"description": "The distinct attribute values which can be used in the column",
"items": {
"$ref": "#/definitions/v1.0/valueTypes/attributeValueType"
},
"type": "array"
}
]
}
},
"type": "object"
},
"Dimension": {
"additionalProperties": false,
"description": "This column represents a dimension of the cube",
"properties": {
"cell_uri_template": {
"description": "A template used to map the cell values in this column into URIs, e.g. 'http://example.com/code-list/{+column_csvw_name}'",
"format": "uri",
"type": "string"
},
"code_list": {
"description": "A code list defines the unique values permitted in a dimension",
"oneOf": [
{
"default": true,
"description": "true/false - whether to generate a code list defining the unique values permitted in this dimension",
"type": "boolean"
},
{
"$ref": "http://purl.org/csv-cubed/resources/code-lists.json#/uris",
"description": "The URI of a code list defining the unique values permitted in this dimension"
},
{
"description": "The path to the code list json defined using the code list config schema",
"type": "string"
},
{
"$ref": "https://purl.org/csv-cubed/code-list-config/v1.1",
"description": "Inline code list"
}
]
},
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Dimension"
},
"description": {
"description": "A explanation of what the Dimension represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/dimensions.json#/uris",
"description": "URI of an existing dimension to reuse or extend"
},
"from_template": {
"$ref": "#/definitions/v1.0/column_templates/dimension"
},
"label": {
"description": "Label describing the Dimension",
"type": "string"
},
"type": {
"const": "dimension",
"description": "This column represents a dimension of the cube",
"type": "string"
}
},
"type": "object"
},
"Measures_Existing": {
"additionalProperties": false,
"description": "This column represents the phenomenon which has been measured (reusing existing measure definitions)",
"properties": {
"cell_uri_template": {
"description": "A template used to map the cell values in this column into URIs, e.g. 'http://example.com/measures/{+column_csvw_name}'",
"format": "uri",
"type": "string"
},
"type": {
"const": "measures",
"description": "This column represents the phenomenon which has been measured",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"Measures_New": {
"additionalProperties": false,
"description": "This column represents the phenomenon which has been measured (defining new measures)",
"properties": {
"type": {
"const": "measures",
"description": "This column represents the phenomenon which has been measured",
"type": "string"
},
"values": {
"oneOf": [
{
"default": true,
"description": "true/false - whether to automatically generate measures for each unique value in the column",
"type": "boolean"
},
{
"description": "The list of measures permitted in this column",
"items": {
"$ref": "#/definitions/v1.0/valueTypes/measureType"
},
"type": "array"
}
]
}
},
"required": [
"type"
],
"type": "object"
},
"Observations": {
"additionalProperties": false,
"description": "This column holds observed/recorded values",
"properties": {
"data_type": {
"$ref": "#/definitions/v1.0/dataTypes"
},
"measure": {
"$ref": "#/definitions/v1.0/valueTypes/measureType",
"description": "The characteristic which was measured in all observation"
},
"type": {
"const": "observations",
"description": "Column type",
"type": "string"
},
"unit": {
"$ref": "#/definitions/v1.0/valueTypes/unitType",
"description": "The unit that all observations were measured in"
}
},
"required": [
"type"
],
"type": "object"
},
"Units_Existing": {
"additionalProperties": false,
"description": "This column represents the unit of measure in which observations were recorded (reusing existing unit definitions)",
"oneOf": [
{
"required": [
"type"
]
},
{
"required": [
"from_template"
]
}
],
"properties": {
"cell_uri_template": {
"description": "A template used to map the cell values in this column into URIs, e.g. 'http://example.com/measures/{+column_csvw_name}'",
"format": "uri",
"type": "string"
},
"describes_observations": {
"description": "The observed values column that these units describe.",
"type": "string"
},
"from_template": {
"$ref": "#/definitions/v1.0/column_templates/units_existing"
},
"type": {
"const": "units",
"description": "This column represents the unit of measure in which observations were recorded",
"type": "string"
}
},
"type": "object"
},
"Units_New": {
"additionalProperties": false,
"description": "This column represents the unit of measure in which observations were recorded (defining new units)",
"properties": {
"describes_observations": {
"description": "The observed values column that these units describe.",
"type": "string"
},
"type": {
"const": "units",
"description": "This column represents the unit of measure in which observations were recorded",
"type": "string"
},
"values": {
"description": "The Units used in this dataset",
"oneOf": [
{
"default": true,
"description": "true/false - whether to automatically generate new units from the unique values in this column",
"type": "boolean"
},
{
"description": "The list of distinct units in this column",
"items": {
"$ref": "#/definitions/v1.0/valueTypes/unitType"
},
"type": "array"
}
]
}
},
"required": [
"type"
],
"type": "object"
}
},
"column_templates": {
"attribute_resource": {
"description": "Templates for common attribute columns with resource values",
"enum": [
"observation-status"
],
"type": "string"
},
"comment": "This is where you should place all column template identifiers. Ensure you segregate them into the appropriate column type.",
"dimension": {
"description": "Templates for common dimension columns",
"enum": [
"year",
"half-year",
"quarter",
"month",
"week",
"day",
"hour",
"minute",
"second",
"government-year",
"government-half-year",
"government-quarter",
"government-week",
"mixed-period",
"gregorian-instant",
"gregorian-interval",
"statistical-geography"
],
"type": "string"
},
"units_existing": {
"description": "Templates for common existing unit columns",
"enum": [
"qudt"
],
"type": "string"
}
},
"dataTypes": {
"default": "decimal",
"enum": [
"anyURI",
"boolean",
"date",
"dateTime",
"dateTimeStamp",
"decimal",
"integer",
"long",
"int",
"short",
"nonNegativeInteger",
"positiveInteger",
"unsignedLong",
"unsignedInt",
"unsignedShort",
"nonPositiveInteger",
"negativeInteger",
"double",
"float",
"string",
"language",
"time"
],
"type": "string"
},
"keywordTypes": {
"description": "A keyword or list of keywords relevant to the cube",
"oneOf": [
{
"$ref": "#/definitions/v1.0/types/keyword"
},
{
"items": {
"$ref": "#/definitions/v1.0/types/keyword"
},
"type": "array"
}
]
},
"themeTypes": {
"additionalProperties": {
"oneOf": [
{
"$ref": "#/definitions/v1.0/types/theme"
},
{
"themeList": {
"description": "A list of themes",
"items": {
"$ref": "#/definitions/v1.0/types/theme"
},
"type": "array"
}
}
]
},
"description": "A theme or list of themes that describe the focus of the data"
},
"types": {
"definition_uri": {
"description": "A string describing a theme",
"format": "uri",
"type": "string"
},
"keyword": {
"description": "A string describing a keyword",
"type": "string"
},
"organisation": {
"$ref": "http://purl.org/csv-cubed/resources/organisations.json#/uris",
"description": "A URI defining an organisation"
},
"theme": {
"$ref": "http://purl.org/csv-cubed/resources/themes.json#/uris",
"description": "A URI describing a theme"
}
},
"valueTypes": {
"attributeValueType": {
"additionalProperties": false,
"description": "A new attribute value",
"properties": {
"definition_uri": {
"description": "The URI link to an existing definition",
"format": "uri",
"type": "string"
},
"description": {
"description": "The description of the attribute values",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/attribute-values.json#/uris",
"description": "The URI to an existing attribute values to extend"
},
"label": {
"description": "A label describing this attribute value",
"type": "string"
}
},
"required": [
"label"
],
"type": "object"
},
"measureType": {
"additionalProperties": false,
"description": "A new measure",
"properties": {
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Measure"
},
"description": {
"description": "A explanation of what the Measure represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/measures.json#/uris",
"description": "URI of an Existing Measure to reuse or extend"
},
"label": {
"description": "Label for the Measure",
"type": "string"
}
},
"required": [
"label"
],
"type": "object"
},
"unitType": {
"additionalProperties": false,
"description": "A new unit",
"properties": {
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Unit"
},
"description": {
"description": "A explanation of what the Unit represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/units.json#/uris",
"description": "URI of an existing Unit to reuse"
},
"label": {
"description": "Label describing the Unit",
"type": "string"
},
"quantity_kind": {
"$ref": "http://purl.org/csv-cubed/resources/quantity-kinds.json#/uris",
"description": "The QUDT quantity kind this unit is used to measure"
},
"scaling_factor": {
"description": "Scaling factor of the observation to base unit",
"type": "number"
},
"si_scaling_factor": {
"description": "Scaling factor to convert from this unit to the SI base unit defined in the unit's quantity_kind",
"type": "number"
}
},
"required": [
"label"
],
"type": "object"
}
}
}
},
"description": "Schema to be used for creation & validation of a single csv-cubed-flavoured linked data cube in CSV-W format",
"id": "https://purl.org/csv-cubed/qube-config/v1.4",
"properties": {
"$schema": {
"default": "https://purl.org/csv-cubed/qube-config/v1.4",
"type": "string"
},
"columns": {
"additionalProperties": {
"$comment": "ATTENTION: If you ADD any column types below, you MUST UPDATE csvcubed.readers.cubeconfig.v1.configdeserialiser._map_column_type_to_schema_type_refs to reflect your changes.",
"anyOf": [
{
"$ref": "#/definitions/v1.0/columnTypes/Dimension"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Attribute_Resource_New"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Attribute_Resource_Existing"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Attribute_Literal"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Measures_New"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Measures_Existing"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Observations"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Units_New"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Units_Existing"
},
{
"const": false,
"description": "This column will be present in the CSV but will not be converted to RDF",
"type": "boolean"
}
],
"description": "Column's meaning in the data cube"
},
"description": "Map of CSV column titles to definitions of what the column represents (a dimension, an attribute, observations, units or measures). If a column needs to be suppressed (i.e. skipped), the following notation can be used: {'column_name': false}"
},
"creator": {
"$ref": "http://purl.org/csv-cubed/resources/organisations.json#/uris",
"description": "The creator of the data set (uri)"
},
"dataset_issued": {
"description": "Date time that the data set was initially published in ISO 8601 format, e.g. 2022-03-31 or 2022-03-31T12:54:30Z",
"type": "string"
},
"dataset_modified": {
"description": "Date time that the data set was last modified published in ISO 8601 format, e.g. 2022-03-31 or 2022-03-31T12:54:30Z",
"type": "string"
},
"description": {
"description": "A longer description of the cube",
"type": "string"
},
"id": {
"description": "A unique id for the cube",
"type": "string"
},
"keywords": {
"$ref": "#/definitions/v1.0/keywordTypes"
},
"license": {
"$ref": "http://purl.org/csv-cubed/resources/licenses.json#/uris",
"description": "URI that represents the copyright license applying to this cube"
},
"public_contact_point_uri": {
"description": "URI that provides a public contact point for discussion of the data set, e.g. mailto:[email protected]",
"format": "uri",
"type": "string"
},
"publisher": {
"$ref": "http://purl.org/csv-cubed/resources/organisations.json#/uris",
"description": "The publisher of the data set (uri)"
},
"summary": {
"description": "A shorter summary of the data set",
"type": "string"
},
"themes": {
"$ref": "#/definitions/v1.0/themeTypes"
},
"title": {
"description": "A title for this data set",
"type": "string"
}
},
"required": [
"$schema"
],
"title": "Schema for a qb-config cube",
"type": "object"
} | Apache-2.0 | en |
GSS-Cogs/csvcubed | f4eb0046469e6d8dbf796c977ee2d6e41c190b8b | 2022-09-16T14:17:06 | src/csvcubed/schema/codelist-config/v1_0/schema.json | 10 | 2024-05-28T03:38:54.121914Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"definitions": {
"v1.0": {
"concept": {
"description": "A concept in the code list.",
"properties": {
"children": {
"$ref": "#/definitions/v1.0/concepts"
},
"description": {
"description": "Description of the concept.",
"type": "string"
},
"label": {
"description": "Label of the concept.",
"type": "string"
},
"notation": {
"description": "Notation of the concept.",
"type": "string"
},
"same_as": {
"description": "Reference to a concept defined elsewhere.",
"format": "uri",
"type": "string"
},
"sort_order": {
"description": "Sort order of the concept.",
"type": "integer"
}
},
"required": [
"label",
"notation"
],
"type": "object"
},
"concepts": {
"description": "List of concepts in the code list.",
"items": {
"$ref": "#/definitions/v1.0/concept"
},
"type": "array",
"uniqueItems": true
},
"keywordTypes": {
"description": "A keyword or list of keywords relevant to the code list.",
"oneOf": [
{
"$ref": "#/definitions/v1.0/types/keyword"
},
{
"items": {
"$ref": "#/definitions/v1.0/types/keyword"
},
"type": "array"
}
]
},
"themeTypes": {
"additionalProperties": {
"oneOf": [
{
"$ref": "#/definitions/v1.0/types/theme"
},
{
"themeList": {
"description": "A list of themes.",
"items": {
"$ref": "#/definitions/v1.0/types/theme"
},
"type": "array"
}
}
]
},
"description": "A theme or list of themes that describe the focus of the code list."
},
"types": {
"keyword": {
"description": "A string describing a keyword.",
"type": "string"
},
"theme": {
"$ref": "http://purl.org/csv-cubed/resources/themes.json#/uris",
"description": "A URI describing a theme."
}
}
}
},
"description": "A new code list to be associated with a dimension.",
"id": "https://purl.org/csv-cubed/code-list-config/v1.0",
"properties": {
"$schema": {
"default": "https://purl.org/csv-cubed/code-list-config/v1.0",
"type": "string"
},
"concepts": {
"$ref": "#/definitions/v1.0/concepts"
},
"creator": {
"$ref": "http://purl.org/csv-cubed/resources/organisations.json#/uris",
"description": "The creator of the code list (uri)."
},
"dataset_issued": {
"description": "Date time that the code list was initially published in ISO 8601 format, e.g. 2022-03-31 or 2022-03-31T12:54:30Z.",
"type": "string"
},
"dataset_modified": {
"description": "Date time that the code list was last modified published in ISO 8601 format, e.g. 2022-03-31 or 2022-03-31T12:54:30Z.",
"type": "string"
},
"description": {
"description": "A long description of the code list.",
"type": "string"
},
"id": {
"description": "A unique id for the code list.",
"type": "string"
},
"keywords": {
"$ref": "#/definitions/v1.0/keywordTypes"
},
"license": {
"$ref": "http://purl.org/csv-cubed/resources/licenses.json#/uris",
"description": "URI that represents the copyright license applying to this code list."
},
"publisher": {
"$ref": "http://purl.org/csv-cubed/resources/organisations.json#/uris",
"description": "The publisher of the code list (uri)."
},
"sort": {
"description": "Sort strategy for the concepts.",
"properties": {
"by": {
"default": "label",
"description": "label (default) or notation",
"enum": [
"label",
"notation"
],
"type": "string"
},
"method": {
"default": "ascending",
"description": "ascending (default) or descending",
"enum": [
"ascending",
"descending"
],
"type": "string"
}
},
"required": [
"by",
"method"
],
"type": "object"
},
"summary": {
"description": "A short summary of the code list.",
"type": "string"
},
"themes": {
"$ref": "#/definitions/v1.0/themeTypes"
},
"title": {
"description": "A title for the code list.",
"type": "string"
}
},
"required": [],
"title": "Schema for a codelist.",
"type": "object"
} | Apache-2.0 | en |
GSS-Cogs/csvcubed | fb76c03f8c4aed0f4fa97088cbf7c6244b8847f4 | 2023-06-22T10:08:45 | src/csvcubed/schema/codelist-config/v2_0/schema.json | 10 | 2024-05-28T03:38:54.121914Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"definitions": {
"v1.0": {
"concept": {
"description": "A concept in the code list.",
"properties": {
"children": {
"$ref": "#/definitions/v1.0/concepts"
},
"description": {
"description": "Description of the concept.",
"type": "string"
},
"exact_match": {
"description": "Reference to a concept defined elsewhere.",
"format": "uri",
"type": "string"
},
"label": {
"description": "Label of the concept.",
"type": "string"
},
"notation": {
"description": "Notation of the concept.",
"type": "string"
},
"sort_order": {
"description": "Sort order of the concept.",
"type": "integer"
},
"uri_safe_identifier_override": {
"description": "Uri safe identifier for the concept.",
"type": "string"
}
},
"required": [
"label",
"notation"
],
"type": "object"
},
"concepts": {
"description": "List of concepts in the code list.",
"items": {
"$ref": "#/definitions/v1.0/concept"
},
"type": "array",
"uniqueItems": true
},
"keywordTypes": {
"description": "A keyword or list of keywords relevant to the code list.",
"oneOf": [
{
"$ref": "#/definitions/v1.0/types/keyword"
},
{
"items": {
"$ref": "#/definitions/v1.0/types/keyword"
},
"type": "array"
}
]
},
"themeTypes": {
"additionalProperties": {
"oneOf": [
{
"$ref": "#/definitions/v1.0/types/theme"
},
{
"themeList": {
"description": "A list of themes.",
"items": {
"$ref": "#/definitions/v1.0/types/theme"
},
"type": "array"
}
}
]
},
"description": "A theme or list of themes that describe the focus of the code list."
},
"types": {
"keyword": {
"description": "A string describing a keyword.",
"type": "string"
},
"theme": {
"$ref": "http://purl.org/csv-cubed/resources/themes.json#/uris",
"description": "A URI describing a theme."
}
}
}
},
"description": "A new code list to be associated with a dimension.",
"id": "https://purl.org/csv-cubed/code-list-config/v2.0",
"properties": {
"$schema": {
"default": "https://purl.org/csv-cubed/code-list-config/v2.0",
"type": "string"
},
"concepts": {
"$ref": "#/definitions/v1.0/concepts"
},
"creator": {
"$ref": "http://purl.org/csv-cubed/resources/organisations.json#/uris",
"description": "The creator of the code list (uri)."
},
"dataset_issued": {
"description": "Date time that the code list was initially published in ISO 8601 format, e.g. 2022-03-31 or 2022-03-31T12:54:30Z.",
"type": "string"
},
"dataset_modified": {
"description": "Date time that the code list was last modified published in ISO 8601 format, e.g. 2022-03-31 or 2022-03-31T12:54:30Z.",
"type": "string"
},
"description": {
"description": "A long description of the code list.",
"type": "string"
},
"id": {
"description": "A unique id for the code list.",
"type": "string"
},
"keywords": {
"$ref": "#/definitions/v1.0/keywordTypes"
},
"license": {
"$ref": "http://purl.org/csv-cubed/resources/licenses.json#/uris",
"description": "URI that represents the copyright license applying to this code list."
},
"publisher": {
"$ref": "http://purl.org/csv-cubed/resources/organisations.json#/uris",
"description": "The publisher of the code list (uri)."
},
"sort": {
"description": "Sort strategy for the concepts.",
"properties": {
"by": {
"default": "label",
"description": "label (default) or notation",
"enum": [
"label",
"notation"
],
"type": "string"
},
"method": {
"default": "ascending",
"description": "ascending (default) or descending",
"enum": [
"ascending",
"descending"
],
"type": "string"
}
},
"required": [
"by",
"method"
],
"type": "object"
},
"summary": {
"description": "A short summary of the code list.",
"type": "string"
},
"themes": {
"$ref": "#/definitions/v1.0/themeTypes"
},
"title": {
"description": "A title for the code list.",
"type": "string"
}
},
"required": [
"title"
],
"title": "Schema for a codelist.",
"type": "object"
} | Apache-2.0 | en |
GSS-Cogs/csvcubed | 737ff716435bb7401f069be7192ea9964d49a9e1 | 2022-07-19T07:42:01 | src/csvcubed/schema/cube-config/v1_2/schema.json | 10 | 2024-05-28T03:38:54.121914Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"definitions": {
"v1.0": {
"columnTypes": {
"Attribute_Literal": {
"additionalProperties": false,
"description": "This column represents an attribute (with resource values) of the cube",
"properties": {
"data_type": {
"$ref": "#/definitions/v1.0/dataTypes",
"description": "The data type of the attribute values"
},
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Attribute"
},
"description": {
"description": "A explanation of what the Attribute represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/attributes.json#/uris/literalValues",
"description": "URI of an existing attribute to reuse or extend"
},
"label": {
"description": "Label describing the Attribute",
"type": "string"
},
"required": {
"default": false,
"description": "Whether or not it is required that every observation has a value for this attribute",
"type": "boolean"
},
"type": {
"const": "attribute",
"description": "This column represents an attribute of the cube",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"Attribute_Resource": {
"additionalProperties": false,
"description": "This column represents an attribute (with literal values) of the cube",
"oneOf": [
{
"required": [
"type"
]
},
{
"required": [
"from_template"
]
}
],
"properties": {
"cell_uri_template": {
"description": "A template used to map the cell values in this column into URIs, e.g. 'http://example.com/attribute-values/{+column_csvw_name}'",
"format": "uri",
"type": "string"
},
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Attribute"
},
"description": {
"description": "A explanation of what the Attribute represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/attributes.json#/uris/resourceValues",
"description": "URI of an existing attribute to reuse or extend"
},
"from_template": {
"$ref": "#/definitions/v1.0/column_templates/attribute_resource"
},
"label": {
"description": "Label describing the Attribute",
"type": "string"
},
"type": {
"const": "attribute",
"description": "This column represents an attribute of the cube",
"type": "string"
},
"values": {
"oneOf": [
{
"default": true,
"description": "Whether to automatically generate attribute value resources for each unique value in the column",
"type": "boolean"
},
{
"description": "The distinct attribute values which can be used in the column",
"items": {
"$ref": "#/definitions/v1.0/valueTypes/attributeValueType"
},
"type": "array"
}
]
}
},
"type": "object"
},
"Dimension": {
"additionalProperties": false,
"description": "This column represents a dimension of the cube",
"properties": {
"cell_uri_template": {
"description": "A template used to map the cell values in this column into URIs, e.g. 'http://example.com/code-list/{+column_csvw_name}'",
"format": "uri",
"type": "string"
},
"code_list": {
"description": "A code list defines the unique values permitted in a dimension",
"oneOf": [
{
"default": true,
"description": "Whether or not to generate a code list defining the unique values permitted in this dimension",
"type": "boolean"
},
{
"$ref": "http://purl.org/csv-cubed/resources/code-lists.json#/uris",
"description": "The URI of a code list defining the unique values permitted in this dimension"
},
{
"description": "The path to the code list json defined using the code list config schema",
"type": "string"
},
{
"$ref": "https://purl.org/csv-cubed/code-list-config/v1.0",
"description": "Inline code list"
}
]
},
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Dimension"
},
"description": {
"description": "A explanation of what the Dimension represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/dimensions.json#/uris",
"description": "URI of an existing dimension to reuse or extend"
},
"from_template": {
"$ref": "#/definitions/v1.0/column_templates/dimension"
},
"label": {
"description": "Label describing the Dimension",
"type": "string"
},
"type": {
"const": "dimension",
"description": "This column represents a dimension of the cube",
"type": "string"
}
},
"required": [],
"type": "object"
},
"Measures": {
"additionalProperties": false,
"description": "This column represents the phenomenon which has been measured",
"properties": {
"cell_uri_template": {
"description": "A template used to map the cell values in this column into URIs, e.g. 'http://example.com/measures/{+column_csvw_name}'",
"format": "uri",
"type": "string"
},
"type": {
"const": "measures",
"description": "This column represents the phenomenon which has been measured",
"type": "string"
},
"values": {
"oneOf": [
{
"default": true,
"description": "Whether to automatically measure resources for each unique value in the column",
"type": "boolean"
},
{
"description": "A list of measures permitted in this column.",
"items": {
"$ref": "#/definitions/v1.0/valueTypes/measureType"
},
"type": "array"
}
]
}
},
"required": [
"type"
],
"type": "object"
},
"Observations": {
"additionalProperties": false,
"description": "This column holds observed/recorded values",
"properties": {
"data_type": {
"$ref": "#/definitions/v1.0/dataTypes"
},
"measure": {
"$ref": "#/definitions/v1.0/valueTypes/measureType",
"description": "The characteristic which was measured in all observation"
},
"type": {
"const": "observations",
"description": "Column type.",
"type": "string"
},
"unit": {
"$ref": "#/definitions/v1.0/valueTypes/unitType",
"description": "The unit that all observations were measured in"
}
},
"required": [
"type"
],
"type": "object"
},
"Units": {
"additionalProperties": false,
"description": "This column represents the unit of measure in which observations were recorded",
"oneOf": [
{
"required": [
"type"
]
},
{
"required": [
"from_template"
]
}
],
"properties": {
"cell_uri_template": {
"description": "A template used to map the cell values in this column into URIs, e.g. 'http://example.com/measures/{+column_csvw_name}'",
"format": "uri",
"type": "string"
},
"from_template": {
"$ref": "#/definitions/v1.0/column_templates/units"
},
"type": {
"const": "units",
"description": "This column represents the unit of measure in which observations were recorded",
"type": "string"
},
"values": {
"description": "The Units used in this dataset.",
"oneOf": [
{
"default": true,
"description": "Whether to automatically generate new units from the unique values in this column.",
"type": "boolean"
},
{
"description": "A list of units permitted in this column.",
"items": {
"$ref": "#/definitions/v1.0/valueTypes/unitType"
},
"type": "array"
}
]
}
},
"type": "object"
}
},
"column_templates": {
"attribute_resource": {
"description": "Templates for common attribute columns with resource values",
"enum": [
"observation-status"
],
"type": "string"
},
"comment": "This is where you should place all column template identifiers. Ensure you segregate them into the appropriate column type.",
"dimension": {
"description": "Templates for common dimension columns",
"enum": [
"year",
"half-year",
"quarter",
"month",
"week",
"day",
"hour",
"minute",
"second",
"government-year",
"government-half-year",
"government-quarter",
"government-week",
"gregorian-instant"
],
"type": "string"
},
"units": {
"description": "Templates for common unit columns",
"enum": [
"qudt"
],
"type": "string"
}
},
"dataTypes": {
"default": "decimal",
"enum": [
"anyURI",
"boolean",
"date",
"dateTime",
"dateTimeStamp",
"decimal",
"integer",
"long",
"int",
"short",
"nonNegativeInteger",
"positiveInteger",
"unsignedLong",
"unsignedInt",
"unsignedShort",
"nonPositiveInteger",
"negativeInteger",
"double",
"float",
"string",
"language",
"time"
],
"type": "string"
},
"keywordTypes": {
"description": "A keyword or list of keywords relevant to the cube",
"oneOf": [
{
"$ref": "#/definitions/v1.0/types/keyword"
},
{
"items": {
"$ref": "#/definitions/v1.0/types/keyword"
},
"type": "array"
}
]
},
"themeTypes": {
"additionalProperties": {
"oneOf": [
{
"$ref": "#/definitions/v1.0/types/theme"
},
{
"themeList": {
"description": "A list of themes",
"items": {
"$ref": "#/definitions/v1.0/types/theme"
},
"type": "array"
}
}
]
},
"description": "A theme or list of themes that describe the focus of the data"
},
"types": {
"definition_uri": {
"description": "A string describing a theme",
"format": "uri",
"type": "string"
},
"keyword": {
"description": "A string describing a keyword",
"type": "string"
},
"organisation": {
"$ref": "http://purl.org/csv-cubed/resources/organisations.json#/uris",
"description": "A URI defining an organisation."
},
"theme": {
"$ref": "http://purl.org/csv-cubed/resources/themes.json#/uris",
"description": "A URI describing a theme"
}
},
"valueTypes": {
"attributeValueType": {
"additionalProperties": false,
"properties": {
"definition_uri": {
"description": "The URI link to an existing definition",
"format": "uri",
"type": "string"
},
"description": {
"description": "The description of the attribute values",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/attribute-values.json#/uris",
"description": "The URI to an existing attribute values to extend"
},
"label": {
"description": "A label describing this attribute value",
"type": "string"
}
},
"required": [
"label"
],
"type": "object"
},
"measureType": {
"additionalProperties": false,
"properties": {
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Measure"
},
"description": {
"description": "A explanation of what the Measure represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/measures.json#/uris",
"description": "URI of an Existing Measure to reuse or extend"
},
"label": {
"description": "Label for the Measure",
"type": "string"
}
},
"required": [
"label"
],
"type": "object"
},
"unitType": {
"additionalProperties": false,
"properties": {
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Unit"
},
"description": {
"description": "A explanation of what the Unit represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/units.json#/uris",
"description": "URI of an existing Unit to reuse"
},
"label": {
"description": "Label describing the Unit",
"type": "string"
},
"quantity_kind": {
"$ref": "http://purl.org/csv-cubed/resources/quantity-kinds.json#/uris",
"description": "The QUDT quantity kind this unit is used to measure"
},
"scaling_factor": {
"description": "Scaling factor of the observation to base unit",
"type": "number"
},
"si_scaling_factor": {
"description": "Scaling factor to convert from this unit to the SI base unit defined in the unit's quantity_kind",
"type": "number"
}
},
"required": [
"label"
],
"type": "object"
}
}
}
},
"description": "Schema to be used for creation & validation of a single csv-cubed-flavoured linked data cube in CSV-W format",
"id": "https://purl.org/csv-cubed/qube-config/v1.2",
"properties": {
"$schema": {
"default": "https://purl.org/csv-cubed/qube-config/v1.2",
"type": "string"
},
"columns": {
"additionalProperties": {
"anyOf": [
{
"$ref": "#/definitions/v1.0/columnTypes/Dimension"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Attribute_Resource"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Attribute_Literal"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Measures"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Observations"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Units"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Units"
}
],
"description": "Column's meaning in the data cube"
},
"description": "Map of CSV column titles to definitions of what the column represents (a dimension, an attribute, observations, units or measures)"
},
"creator": {
"$ref": "http://purl.org/csv-cubed/resources/organisations.json#/uris",
"description": "The creator of the data set (uri)"
},
"dataset_issued": {
"description": "Date time that the data set was initially published in ISO 8601 format, e.g. 2022-03-31 or 2022-03-31T12:54:30Z",
"type": "string"
},
"dataset_modified": {
"description": "Date time that the data set was last modified published in ISO 8601 format, e.g. 2022-03-31 or 2022-03-31T12:54:30Z",
"type": "string"
},
"description": {
"description": "A longer description of the cube",
"type": "string"
},
"id": {
"description": "A unique id for the cube",
"type": "string"
},
"keywords": {
"$ref": "#/definitions/v1.0/keywordTypes"
},
"license": {
"$ref": "http://purl.org/csv-cubed/resources/licenses.json#/uris",
"description": "URI that represents the copyright license applying to this cube"
},
"public_contact_point_uri": {
"description": "URI that provides a public contact point for discussion of the data set, e.g. mailto:[email protected]",
"format": "uri",
"type": "string"
},
"publisher": {
"$ref": "http://purl.org/csv-cubed/resources/organisations.json#/uris",
"description": "The publisher of the data set (uri)"
},
"summary": {
"description": "A shorter summary of the data set",
"type": "string"
},
"themes": {
"$ref": "#/definitions/v1.0/themeTypes"
},
"title": {
"description": "A title for this data set",
"type": "string"
}
},
"required": [
"$schema"
],
"title": "Schema for a qb-config cube",
"type": "object"
} | Apache-2.0 | en |
GSS-Cogs/csvcubed | 55905b98a50c452f0ed999cc8f7ea6f84eae3e22 | 2022-06-09T08:54:45 | src/csvcubed/schema/cube-config/v1_0/schema.json | 10 | 2024-05-28T03:38:54.121914Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"definitions": {
"v1.0": {
"columnTypes": {
"Attribute_Literal": {
"additionalProperties": false,
"description": "This column represents an attribute (with resource values) of the cube",
"properties": {
"data_type": {
"$ref": "#/definitions/v1.0/dataTypes",
"description": "The data type of the attribute values"
},
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Attribute"
},
"description": {
"description": "A explanation of what the Attribute represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/attributes.json#/uris/literalValues",
"description": "URI of an existing attribute to reuse or extend"
},
"label": {
"description": "Label describing the Attribute",
"type": "string"
},
"required": {
"default": false,
"description": "Whether or not it is required that every observation has a value for this attribute",
"type": "boolean"
},
"type": {
"const": "attribute",
"description": "This column represents an attribute of the cube",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"Attribute_Resource": {
"additionalProperties": false,
"description": "This column represents an attribute (with literal values) of the cube",
"oneOf": [
{
"required": [
"type"
]
},
{
"required": [
"from_template"
]
}
],
"properties": {
"cell_uri_template": {
"description": "A template used to map the cell values in this column into URIs, e.g. 'http://example.com/attribute-values/{+column_csvw_name}'",
"format": "uri",
"type": "string"
},
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Attribute"
},
"description": {
"description": "A explanation of what the Attribute represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/attributes.json#/uris/resourceValues",
"description": "URI of an existing attribute to reuse or extend"
},
"from_template": {
"$ref": "#/definitions/v1.0/column_templates/attribute_resource"
},
"label": {
"description": "Label describing the Attribute",
"type": "string"
},
"type": {
"const": "attribute",
"description": "This column represents an attribute of the cube",
"type": "string"
},
"values": {
"oneOf": [
{
"default": true,
"description": "Whether to automatically generate attribute value resources for each unique value in the column",
"type": "boolean"
},
{
"description": "The distinct attribute values which can be used in the column",
"items": {
"$ref": "#/definitions/v1.0/valueTypes/attributeValueType"
},
"type": "array"
}
]
}
},
"type": "object"
},
"Dimension": {
"additionalProperties": false,
"description": "This column represents a dimension of the cube",
"properties": {
"cell_uri_template": {
"description": "A template used to map the cell values in this column into URIs, e.g. 'http://example.com/code-list/{+column_csvw_name}'",
"format": "uri",
"type": "string"
},
"code_list": {
"description": "A code list defines the unique values permitted in a dimension",
"oneOf": [
{
"default": true,
"description": "Whether or not to generate a code list defining the unique values permitted in this dimension",
"type": "boolean"
},
{
"$ref": "http://purl.org/csv-cubed/resources/code-lists.json#/uris",
"description": "The URI of a code list defining the unique values permitted in this dimension"
}
]
},
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Dimension"
},
"description": {
"description": "A explanation of what the Dimension represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/dimensions.json#/uris",
"description": "URI of an existing dimension to reuse or extend"
},
"from_template": {
"$ref": "#/definitions/v1.0/column_templates/dimension"
},
"label": {
"description": "Label describing the Dimension",
"type": "string"
},
"type": {
"const": "dimension",
"description": "This column represents a dimension of the cube",
"type": "string"
}
},
"required": [],
"type": "object"
},
"Measures": {
"additionalProperties": false,
"description": "This column represents the phenomenon which has been measured",
"properties": {
"cell_uri_template": {
"description": "A template used to map the cell values in this column into URIs, e.g. 'http://example.com/measures/{+column_csvw_name}'",
"format": "uri",
"type": "string"
},
"type": {
"const": "measures",
"description": "This column represents the phenomenon which has been measured",
"type": "string"
},
"values": {
"oneOf": [
{
"default": true,
"description": "Whether to automatically measure resources for each unique value in the column",
"type": "boolean"
},
{
"description": "A list of measures permitted in this column.",
"items": {
"$ref": "#/definitions/v1.0/valueTypes/measureType"
},
"type": "array"
}
]
}
},
"required": [
"type"
],
"type": "object"
},
"Observations": {
"additionalProperties": false,
"description": "This column holds observed/recorded values",
"properties": {
"data_type": {
"$ref": "#/definitions/v1.0/dataTypes"
},
"measure": {
"$ref": "#/definitions/v1.0/valueTypes/measureType",
"description": "The characteristic which was measured in all observation"
},
"type": {
"const": "observations",
"description": "Column type.",
"type": "string"
},
"unit": {
"$ref": "#/definitions/v1.0/valueTypes/unitType",
"description": "The unit that all observations were measured in"
}
},
"required": [
"type"
],
"type": "object"
},
"Units": {
"additionalProperties": false,
"description": "This column represents the unit of measure in which observations were recorded",
"properties": {
"type": {
"const": "units",
"description": "This column represents the unit of measure in which observations were recorded",
"type": "string"
},
"values": {
"description": "The Units used in this dataset.",
"oneOf": [
{
"default": true,
"description": "Whether to automatically generate new units from the unique values in this column.",
"type": "boolean"
},
{
"description": "A list of units permitted in this column.",
"items": {
"$ref": "#/definitions/v1.0/valueTypes/unitType"
},
"type": "array"
}
]
}
},
"required": [
"type"
],
"type": "object"
}
},
"column_templates": {
"attribute_resource": {
"description": "Templates for common attribute columns with resource values",
"enum": [
"observation-status"
],
"type": "string"
},
"comment": "This is where you should place all column template identifiers. Ensure you segregate them into the appropriate column type.",
"dimension": {
"description": "Templates for common dimension columns",
"enum": [
"year",
"half-year",
"quarter",
"month",
"week",
"day",
"hour",
"minute",
"second",
"government-year",
"government-half-year",
"government-quarter",
"government-week",
"gregorian-instant"
],
"type": "string"
}
},
"dataTypes": {
"default": "decimal",
"enum": [
"anyURI",
"boolean",
"date",
"dateTime",
"dateTimeStamp",
"decimal",
"integer",
"long",
"int",
"short",
"nonNegativeInteger",
"positiveInteger",
"unsignedLong",
"unsignedInt",
"unsignedShort",
"nonPositiveInteger",
"negativeInteger",
"double",
"float",
"string",
"language",
"time"
],
"type": "string"
},
"keywordTypes": {
"description": "A keyword or list of keywords relevant to the cube",
"oneOf": [
{
"$ref": "#/definitions/v1.0/types/keyword"
},
{
"items": {
"$ref": "#/definitions/v1.0/types/keyword"
},
"type": "array"
}
]
},
"themeTypes": {
"additionalProperties": {
"oneOf": [
{
"$ref": "#/definitions/v1.0/types/theme"
},
{
"themeList": {
"description": "A list of themes",
"items": {
"$ref": "#/definitions/v1.0/types/theme"
},
"type": "array"
}
}
]
},
"description": "A theme or list of themes that describe the focus of the data"
},
"types": {
"definition_uri": {
"description": "A string describing a theme",
"format": "uri",
"type": "string"
},
"keyword": {
"description": "A string describing a keyword",
"type": "string"
},
"organisation": {
"$ref": "http://purl.org/csv-cubed/resources/organisations.json#/uris",
"description": "A URI defining an organisation."
},
"theme": {
"$ref": "http://purl.org/csv-cubed/resources/themes.json#/uris",
"description": "A URI describing a theme"
}
},
"valueTypes": {
"attributeValueType": {
"additionalProperties": false,
"properties": {
"definition_uri": {
"description": "The URI link to an existing definition",
"format": "uri",
"type": "string"
},
"description": {
"description": "The description of the attribute values",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/attribute-values.json#/uris",
"description": "The URI to an existing attribute values to extend"
},
"label": {
"description": "A label describing this attribute value",
"type": "string"
}
},
"required": [
"label"
],
"type": "object"
},
"measureType": {
"additionalProperties": false,
"properties": {
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Measure"
},
"description": {
"description": "A explanation of what the Measure represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/measures.json#/uris",
"description": "URI of an Existing Measure to reuse or extend"
},
"label": {
"description": "Label for the Measure",
"type": "string"
}
},
"required": [
"label"
],
"type": "object"
},
"unitType": {
"additionalProperties": false,
"properties": {
"definition_uri": {
"$ref": "#/definitions/v1.0/types/definition_uri",
"description": "Source URI for the definition of the Unit"
},
"description": {
"description": "A explanation of what the Unit represents",
"type": "string"
},
"from_existing": {
"$ref": "http://purl.org/csv-cubed/resources/units.json#/uris",
"description": "URI of an existing Unit to reuse"
},
"label": {
"description": "Label describing the Unit",
"type": "string"
},
"quantity_kind": {
"$ref": "http://purl.org/csv-cubed/resources/quantity-kinds.json#/uris",
"description": "The QUDT quantity kind this unit is used to measure"
},
"scaling_factor": {
"description": "Scaling factor of the observation to base unit",
"type": "number"
},
"si_scaling_factor": {
"description": "Scaling factor to convert from this unit to the SI base unit defined in the unit's quantity_kind",
"type": "number"
}
},
"required": [
"label"
],
"type": "object"
}
}
}
},
"description": "Schema to be used for creation & validation of a single csv-cubed-flavoured linked data cube in CSV-W format",
"id": "https://purl.org/csv-cubed/qube-config/v1.0",
"properties": {
"$schema": {
"default": "https://purl.org/csv-cubed/qube-config/v1.0",
"type": "string"
},
"columns": {
"additionalProperties": {
"anyOf": [
{
"$ref": "#/definitions/v1.0/columnTypes/Dimension"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Attribute_Resource"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Attribute_Literal"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Measures"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Observations"
},
{
"$ref": "#/definitions/v1.0/columnTypes/Units"
}
],
"description": "Column's meaning in the data cube"
},
"description": "Map of CSV column titles to definitions of what the column represents (a dimension, an attribute, observations, units or measures)"
},
"creator": {
"$ref": "http://purl.org/csv-cubed/resources/organisations.json#/uris",
"description": "The creator of the data set (uri)"
},
"dataset_issued": {
"description": "Date time that the data set was initially published in ISO 8601 format, e.g. 2022-03-31 or 2022-03-31T12:54:30Z",
"type": "string"
},
"dataset_modified": {
"description": "Date time that the data set was last modified published in ISO 8601 format, e.g. 2022-03-31 or 2022-03-31T12:54:30Z",
"type": "string"
},
"description": {
"description": "A longer description of the cube",
"type": "string"
},
"id": {
"description": "A unique id for the cube",
"type": "string"
},
"keywords": {
"$ref": "#/definitions/v1.0/keywordTypes"
},
"license": {
"$ref": "http://purl.org/csv-cubed/resources/licenses.json#/uris",
"description": "URI that represents the copyright license applying to this cube"
},
"public_contact_point_uri": {
"description": "URI that provides a public contact point for discussion of the data set, e.g. mailto:[email protected]",
"format": "uri",
"type": "string"
},
"publisher": {
"$ref": "http://purl.org/csv-cubed/resources/organisations.json#/uris",
"description": "The publisher of the data set (uri)"
},
"summary": {
"description": "A shorter summary of the data set",
"type": "string"
},
"themes": {
"$ref": "#/definitions/v1.0/themeTypes"
},
"title": {
"description": "A title for this data set",
"type": "string"
}
},
"required": [
"$schema"
],
"title": "Schema for a qb-config cube",
"type": "object"
} | Apache-2.0 | en |
boschrexroth/json-schema | a2d8b913b7f301e0f245f5dd20eb596da9dbcf6a | 2024-04-09T08:01:52 | ctrlx-automation/ctrlx-os/apps/package-manifest/package-manifest.v1.4.schema.json | 9 | 2024-05-28T05:20:26.511771Z | {
"$defs": {
"appDirectory": {
"additionalProperties": false,
"description": "Describes an app configuration directory stored as part of a configuration.",
"properties": {
"copyOnLoad": {
"default": false,
"description": "An app is responsible for persisting its configuration state to the app data folder, even for the load command. With copyOnLoad, the app is able to delegate this task to the Solutions app.",
"examples": [
true,
false
],
"title": "Copy on load",
"type": "boolean"
},
"description": {
"description": "Short description of the content of the directory. Will be displayed as part of a configuration.",
"examples": [
"My app",
"My cool feature"
],
"title": "Title",
"type": "string"
},
"i18n": {
"$ref": "#/$defs/i18nTag"
},
"icon": {
"description": "An optional icon which represents the app.",
"examples": [
"my-icon"
],
"title": "Icon",
"type": "string"
},
"name": {
"description": "Path of the app directory. Subdirectories are separated with /, no leading or trailing /",
"examples": [
"my-app",
"my-app/cool-feature"
],
"title": "Path of the app directory in the configuration",
"type": "string"
},
"scopes": {
"description": "Array of scopes. Each scope describes a specific permission for one or more web server resources, e.g. write to a resource using HTTP PUT",
"items": {
"$ref": "#/$defs/scope"
},
"title": "Array of scopes",
"type": "array"
},
"writeProtected": {
"default": true,
"description": "An app can protect its directories in the active configuration against write-access, e.g. via WebDAV. Since XCR-V-0112.",
"examples": [
true,
false
],
"title": "Write-protection of app directories",
"type": "boolean"
}
},
"required": [
"name"
],
"title": "App directory",
"type": "object"
},
"apps": {
"additionalProperties": false,
"description": "Contains configurations for specific rexroth apps",
"properties": {
"rexroth-remoteagent": {
"$ref": "#/$defs/rexroth-remoteagent"
},
"rexroth-setup": {
"$ref": "#/$defs/rexroth-setup"
}
},
"title": "Configurations for specific rexroth apps",
"type": "object"
},
"certificateStore": {
"additionalProperties": false,
"description": "certificate store enables your application to manage certificates and keys using Device Admin",
"properties": {
"description": {
"description": "Describes the content and usage of the certificates in the store",
"example": "Certficates & Keys to connect to the World",
"title": "Description of your certificate store",
"type": "string"
},
"i18n": {
"$ref": "#/$defs/i18nTag"
},
"id": {
"description": "Id of your store, should contain snap name as prefix, e.g. ctrlx-helloworld.certificates",
"example": "ctrlx-helloworld.certificates",
"title": "Id of your store",
"type": "string"
},
"scopesR": {
"description": "A list of scopes that allow the user to have read access to this certificate store",
"items": {
"examples": [
"my-app.r",
"my-app.cool-feature.r"
],
"pattern": "^(.*)$",
"title": "Permission",
"type": "string"
},
"title": "Scopes for viewing the certificate store",
"type": "array"
},
"scopesRWX": {
"description": "A list of scopes that allow the user to have full access to this certificate store",
"items": {
"examples": [
"my-app.rw",
"my-app.cool-feature.rw"
],
"pattern": "^(.*)$",
"title": "Permission",
"type": "string"
},
"title": "Scopes for managing the certificate store",
"type": "array"
},
"title": {
"description": "Title of your certificate store that is displayed in ctrlX Device Admin UI",
"example": "Hello World",
"title": "Title of certificate store",
"type": "string"
}
},
"title": "Store for Certificates and Keys",
"type": "object"
},
"command": {
"description": "A command that is provided and can be executed by another application. A command can have multiple command requests, e.g. to execute the command on multiple services.",
"items": {
"$ref": "#/$defs/commandRequest"
},
"title": "Command",
"type": "array"
},
"commandRequest": {
"additionalProperties": false,
"description": "A command object.",
"properties": {
"after": {
"description": "Defines a list of command identifiers whose commands if present will always be executed before this command.",
"examples": [
"scheduler",
"trace"
],
"items": {
"type": "string"
},
"type": "array"
},
"execution": {
"additionalProperties": false,
"description": "The execution element is deprecated. Use url element instead.",
"properties": {
"method": {
"default": "POST",
"description": "The HTTP method called for executing this command; one of 'POST' and 'PUT'; the default is 'POST'.",
"enum": [
"PUT",
"POST"
],
"examples": [
"POST"
],
"title": "HTTP method",
"type": "string"
},
"url": {
"description": "The URL used for executing this command",
"examples": [
"/automation/api/v1/motion/cfg/save"
],
"title": "URL",
"type": "string"
}
},
"required": [
"url"
],
"title": "Execution",
"type": "object"
},
"id": {
"description": "The identifier of this command; must be unique within the enclosing scope.",
"examples": [
"motion"
],
"title": "Id",
"type": "string"
},
"subject": {
"description": "Denotes what will be saved or loaded; used to inform users, e.g. in messages like 'Loading motion settings' or 'Cannot load motion settings'",
"examples": [
"motion settings"
],
"title": "Subject",
"type": "string"
},
"url": {
"description": "The request URL. Called as a POST request. URLs starting with a slash are interpreted to be relative to https://<host>. The execution and url elements are mutually exclusive, that is exactly one of them is required.",
"examples": [
"/automation/api/v1/motion/cfg/save"
],
"title": "URL",
"type": "string"
}
},
"required": [
"id",
"subject"
],
"title": "Command",
"type": "object"
},
"commandScope": {
"additionalProperties": {
"$ref": "#/$defs/command"
},
"description": "A command scope containing multiple commands.",
"title": "Command Scope",
"type": "object"
},
"commands": {
"additionalProperties": {
"$ref": "#/$defs/commandScope"
},
"description": "Allows to specify commands that integrate into framework operations, e.g. for activeConfiguration. The sub-elements define the scopes that support command integration.",
"properties": {},
"title": "Commands",
"type": "object"
},
"configuration": {
"additionalProperties": false,
"description": "Configuration topics",
"properties": {
"appDirectories": {
"description": "Describes app directories and specifies access to them inside the configuration",
"items": {
"$ref": "#/$defs/appDirectory"
},
"type": "array"
},
"appPrivateFiles": {
"description": "Defines files which are ignored on saving and loading. The files are matched case-insensitively using regular expressions. Since XCR-V-0112.",
"items": {
"description": "A regular expression following the RE2 syntax (https://golang.org/s/re2syntax)",
"examples": [
"^my-app/[^/]+\\.bak$",
"^my-app/tmp/",
"^my-app/tmp"
],
"title": "Regular expression",
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"dashboardWidgetExtension": {
"additionalProperties": false,
"properties": {
"categories": {
"description": "List of categories the widget is displayed",
"example": [
"System",
"Other Category"
],
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"description": "The widget's description as shown in the widget catalog.",
"example": "Shows the status of your axes",
"readOnly": true,
"type": "string"
},
"i18n": {
"$ref": "#/$defs/i18nTag"
},
"icon": {
"description": "The icon to be displayed in the widget catalog.",
"example": "Bosch-Ic-settings",
"readOnly": true,
"type": "string"
},
"image": {
"description": "The path to the image to be displayed in the widget catalog.",
"example": "/motion/axes.svg",
"readOnly": true,
"type": "string"
},
"initialSize": {
"$ref": "#/$defs/dashboardWidgetSize",
"description": "The widget's initial grid size"
},
"maxSize": {
"$ref": "#/$defs/dashboardWidgetSize",
"description": "The widget's maximum grid size"
},
"minSize": {
"$ref": "#/$defs/dashboardWidgetSize",
"description": "The widget's minimum grid size"
},
"order": {
"description": "Order of the item in the header. Lower numbers are displayed first.",
"examples": [
1,
2,
3
],
"title": "Order",
"type": "integer"
},
"permissions": {
"description": "List of permissions to view or interact with the widget.",
"example": [
"rexroth-deviceadmin.package-manager.r",
"rexroth-deviceadmin.package-manager.rw"
],
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"src": {
"description": "The url of the web component's implementation file.",
"examples": [
"widgets.js"
],
"title": "Source",
"type": "string"
},
"tag": {
"description": "The tag name that creates a new instance of the web component.",
"examples": [
"my-widget"
],
"title": "Tag",
"type": "string"
},
"title": {
"description": "The widget's title as shown in the widget catalog.",
"example": "Axes",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"dashboardWidgetSize": {
"properties": {
"cols": {
"description": "Number of columns in the dashboard grid.",
"example": 3,
"readOnly": true,
"type": "number"
},
"rows": {
"description": "Number of rows in the dashboard grid.",
"example": 3,
"readOnly": true,
"type": "number"
}
},
"type": "object"
},
"dependencies": {
"additionalProperties": false,
"description": "Defines all dependencies of the app. The map key is the unique app id. Only direct dependencies should be modeled here.",
"patternProperties": {
"^[a-z0-9-]*[a-z][a-z0-9-]*$": {
"description": "Definition of the version range using npmjs syntax, see https://semver.npmjs.com/ for more details.",
"title": "Version range defined as string",
"type": "string"
}
},
"title": "Map containing dependencies of the app",
"type": "object"
},
"document": {
"additionalProperties": false,
"description": "Specifies a reference to a document",
"properties": {
"description": {
"description": "Short description of the content of the document.",
"examples": [
"Provides my-app related functionalities on ctrlX devices."
],
"title": "Description of the document",
"type": "string"
},
"i18n": {
"$ref": "#/$defs/i18nTag"
},
"name": {
"description": "Name or title of the document. Can be used in headlines, e.g.",
"examples": [
"My-App API"
],
"title": "Name of the document",
"type": "string"
},
"type": {
"description": "Type of the document. Can be used for assignment purposes, e.g.",
"enum": [
"api"
],
"examples": [
"api"
],
"title": "Type of the document",
"type": "string"
},
"url": {
"description": "Specifies the path to the document resource.",
"examples": [
"/my-app/doc/api"
],
"title": "URL of the document",
"type": "string"
}
},
"title": "Document",
"type": "object"
},
"documentation": {
"description": "Contains documents like API references, e.g.",
"items": {
"$ref": "#/$defs/document"
},
"title": "Documentation",
"type": "array"
},
"entries": {
"additionalProperties": false,
"description": "A navigation entry point of the package",
"oneOf": [
{
"required": [
"id",
"title",
"items"
]
}
],
"properties": {
"category": {
"description": "The category the entry point belongs to",
"examples": [
"0_my_apps"
],
"title": "Category",
"type": "string"
},
"description": {
"description": "The description of the entry point",
"examples": [
"My App providing cool features"
],
"title": "Description",
"type": "string"
},
"i18n": {
"$ref": "#/$defs/i18nTag"
},
"icon": {
"description": "An optional icon, see... to represent the entry point",
"examples": [
"bosch-ic-automation"
],
"title": "Icon",
"type": "string"
},
"id": {
"description": "Identifier of the link. Used to define menu orders.",
"examples": [
"my-app"
],
"title": "Id",
"type": "string"
},
"items": {
"description": "Sub entries of the entry point",
"items": {
"$ref": "#/$defs/entries"
},
"title": "Sublinks",
"type": "array"
},
"link": {
"description": "Relative path of the link",
"examples": [
"/my-app",
"/my-app?access_token=${bearertoken}",
"http://${hostname}:1234/",
"https://www.google.com/"
],
"title": "Link to the ressource. The link includes the prefix of the service",
"type": "string"
},
"permissions": {
"description": "An optional list of permissions to enable the entry point",
"items": {
"examples": [
"my-app.r",
"my-app.rw",
"my-app.cool-feature.r",
"my-app.cool-feature.rw"
],
"pattern": "^(.*)$",
"title": "Permission",
"type": "string"
},
"title": "Permissions",
"type": "array"
},
"target": {
"description": "Specifies where to show the link. Identical to the target property of an anchor element.",
"examples": [
"_blank",
"my-app"
],
"title": "Target",
"type": "string"
},
"title": {
"description": "The text representation of the entry point",
"examples": [
"My App"
],
"title": "Title",
"type": "string"
}
},
"title": "Link",
"type": "object"
},
"i18nTag": {
"description": "can be used to supply translations of properties of the object this tag is applied to. The defined tag value must be unique in the scope of the package-manifest.",
"pattern": "^(.*)$",
"title": "i18n Tag",
"type": "string"
},
"license": {
"additionalProperties": false,
"description": "",
"properties": {
"description": {
"examples": [
"Unlock the firewall functionality"
],
"title": "Description of the license",
"type": "string"
},
"i18n": {
"$ref": "#/$defs/i18nTag"
},
"name": {
"examples": [
"SWL_XCR_ENGINEERING_4H"
],
"title": "Identifier of the license",
"type": "string"
},
"required": {
"examples": [
true
],
"title": "Indicates if an licenses is required to operate the application or unlocks optional functionalities",
"type": "boolean"
},
"title": {
"examples": [
"ctrlX OS - Firewall License"
],
"title": "Human readable title of the firewall",
"type": "string"
}
},
"title": "",
"type": "object"
},
"licenses": {
"description": "Licenses are used to control the functionality of the package. Missing licenses results in no or not full availibility",
"items": {
"$ref": "#/$defs/license"
},
"title": "Contains license informations for specific rexroth apps",
"type": "array"
},
"menus": {
"additionalProperties": false,
"description": "Menus and links a package provides. The declarations will be used by the device admin to generate the corresponding entries in the sidebar or overview.",
"properties": {
"overview": {
"items": {
"$ref": "#/$defs/entries"
},
"title": "Overview",
"type": "array"
},
"settings": {
"items": {
"$ref": "#/$defs/entries"
},
"title": "Settings Menu",
"type": "array"
},
"sidebar": {
"items": {
"$ref": "#/$defs/entries"
},
"title": "Sidebar Menu",
"type": "array"
},
"system": {
"items": {
"$ref": "#/$defs/entries"
},
"title": "System Menu",
"type": "array"
}
},
"title": "Menus",
"type": "object"
},
"proxyMapping": {
"additionalProperties": false,
"description": "ProxyMapping defines a web service mappings. A service has a name for identification, a relative path where it should be reachable and a socket (network or unix) to bind to",
"properties": {
"binding": {
"description": "A network socket, e.g. :5000 or unix socket e.g. unix://{$SNAP_DATA}/package-run/my-app.web.sock",
"examples": [
":5000",
"http://localhost:5000",
"unix://{$SNAP_DATA}/package-run/my-app.web.sock"
],
"title": "Binding",
"type": "string"
},
"caddyfile": {
"description": "Path to customized caddy file, which should be included in the original caddy file",
"examples": [
"./caddyfile"
],
"title": "Customized caddy file",
"type": "string"
},
"name": {
"description": "A Name for the mapping",
"examples": [
"my-app.web"
],
"title": "Name",
"type": "string"
},
"options": {
"description": "Additional options of the proxy configuration",
"examples": [
{
"option": "websocket",
"value": ""
},
{
"option": "max_conns",
"value": "2"
}
],
"items": {
"additionalProperties": false,
"properties": {
"option": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"title": "Additional options",
"type": "array"
},
"restricted": {
"description": "Resources, to which the access shall be restricted, e.g. API URLs",
"examples": [
"/my-app-1/api/v1.0",
{
"except": [
"/my-app-2/api/v1.0/except-path-1",
"/my-app-2/api/v1.0/except-path-2"
],
"headersForwarding": [
"X-Auth-Name",
"X-Auth-ID",
"X-Auth-Scopes",
"X-Auth-Expires",
"X-Auth-Issued",
"X-Auth-PlcHandle",
"X-Auth-RemoteAuth",
"X-Auth-Nonce"
],
"path": "/my-app-2/api/v1.0"
}
],
"items": {
"oneOf": [
{
"properties": {
"except": {
"description": "Excepted subpaths, to which the access is not restricted",
"items": {
"type": "string"
},
"type": "array"
},
"headersForwarding": {
"description": "Headers, which are created by idmconnector and forwarded to endpoint",
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"description": "Path, to which the access shall be restricted",
"type": "string"
}
},
"required": [
"path"
],
"type": "object"
},
{
"description": "Path, which is restricted by identity manager",
"type": "string"
}
]
},
"title": "Restricted resources",
"type": "array"
},
"url": {
"description": "Relative path the service is requesting",
"examples": [
"/my-app"
],
"title": "Url",
"type": "string"
}
},
"title": "ProxyMapping",
"type": "object"
},
"rexroth-remoteagent": {
"additionalProperties": false,
"description": "Contains allowed commands for remote device administration",
"properties": {
"commands": {
"description": "Remote device administration commands are used to execute commands on the device from the Nexeed Device Portal",
"examples": [
[
"BACKUP",
"RESTORE",
"REBOOT"
]
],
"items": {
"type": "string"
},
"title": "Remote device administration commands",
"type": "array"
}
},
"title": "Commands for remote device administration",
"type": "object"
},
"rexroth-setup": {
"description": "Provides information for ctrlX Setup regarding the current app, e.g. settings to be saved and restored.",
"properties": {
"settings": {
"description": "App settings to be saved and restored by ctrlX Setup",
"items": {
"$ref": "#/$defs/setupSetting"
},
"type": "array"
}
},
"type": "object"
},
"scope": {
"additionalProperties": false,
"description": "A scope represents a web service resource specific permission and consists of an identifier, a name and a human-readable description.",
"properties": {
"description": {
"description": "The description of the scope. Used by the identity management frontend to describe the scope set.",
"examples": [
"This permissions allows to read and modify all automation parameters",
"This permissions allows to read all automation parameters",
"This permissions allows to read all motion parameters"
],
"title": "Description of the scope",
"type": "string"
},
"i18n": {
"$ref": "#/$defs/i18nTag"
},
"identifier": {
"description": "The unique identifier of the scope. Must be derived from the id and follow the schema <id>.<service>.<scope_name>.<access_type>",
"examples": [
"my-app.cool-feature.rw (allow read/write access to all resources",
"my-app.cool-feature.r (allow access to all resources on a read-only basis)"
],
"title": "The identifier of the scope",
"type": "string"
},
"name": {
"description": "The name of the scope set. Should be unique. Used by the identity management frontend to display the scope. Should describe the what the permission means.",
"examples": [
"Read/write access (all parameters)",
"Read access (all parameters)",
"Read access (motion parameters)"
],
"title": "The name of the scope",
"type": "string"
}
},
"title": "Web server scope",
"type": "object"
},
"scopes-declaration": {
"description": "Scopes used in the application to control access to specific ressources. The scope declaration is used by the identity management (IDM) to assign permissions for specific users or groups.",
"items": {
"$ref": "#/$defs/setOfScopes"
},
"title": "Scopes provided by the package",
"type": "array"
},
"services": {
"additionalProperties": false,
"description": "Services contains a set of services a package is providing",
"properties": {
"proxyMapping": {
"description": "Proxy mappings are used by the reverse proxy to assign specific routes to a server running on a device.",
"items": {
"$ref": "#/$defs/proxyMapping"
},
"title": "Proxy mappings",
"type": "array"
}
},
"title": "Services",
"type": "object"
},
"setOfScopes": {
"additionalProperties": false,
"description": "A set of scopes declares the scopes which are supported by the web service. The set includes identifer, name, a human-readable description and one or more scopes.",
"properties": {
"description": {
"description": "The description of the scope set. Used by the identity management frontend to describe the scope set.",
"title": "Description of the scope set",
"type": "string"
},
"i18n": {
"$ref": "#/$defs/i18nTag"
},
"identifier": {
"description": "The unique identifier of the permission set. Must be derived from the identifier and must not contain spaces. Must be unique.",
"examples": [
"my-app.web"
],
"title": "The identifier of the scope set",
"type": "string"
},
"name": {
"description": "The name of the scope set. Should be unique. Used by the identity management frontend to display the scope set.",
"examples": [
"My App Scopes"
],
"title": "The name of the scope set",
"type": "string"
},
"scopes": {
"description": "Array of scopes. Each scope describes a specific permission for one or more web server resources, e.g. write to a resource using HTTP PUT",
"items": {
"$ref": "#/$defs/scope"
},
"title": "Array of scopes",
"type": "array"
}
},
"title": "Set of scopes",
"type": "object"
},
"setupSetting": {
"properties": {
"description": {
"description": "Short localized description of the setting.",
"example": "Description of myAppSetting",
"type": "string"
},
"name": {
"description": "Name of the setting. Must be unique within the app's settings list. Serves as key in the ctrlx-setup.json file. Required for all types except 'snapshot'. Note that the name '$path' is reserved.",
"example": "myAppSetting",
"type": "string"
},
"type": {
"description": "Type of the setting. One of 'text', 'json', 'file', 'encryptedFile' and 'snapshot'. The default is 'text'.",
"enum": [
"text",
"json",
"file",
"encryptedFile",
"snapshot"
],
"example": "json",
"type": "string"
},
"url": {
"description": "URL used to read (GET) and update (PUT) the setting. A URL starting with a slash is interpreted to be relative to https: //<host>. Required for all types except 'snapshot'.",
"example": "/myapp/api/v1/my-app-setting",
"type": "string"
}
},
"type": "object"
},
"uiExtensionDashboardItems": {
"description": "Web components that should be displayed in the dashboard.",
"items": {
"$ref": "#/$defs/dashboardWidgetExtension"
},
"title": "Dashboard items",
"type": "array"
},
"uiExtensionHeaderItem": {
"additionalProperties": false,
"description": "",
"properties": {
"order": {
"description": "Order of the item in the header. Lower numbers are displayed first.",
"examples": [
1,
2,
3
],
"title": "Order",
"type": "integer"
},
"src": {
"description": "The url of the web component's implementation file.",
"examples": [
"widgets.js"
],
"title": "Source",
"type": "string"
},
"tag": {
"description": "The tag name that creates a new instance of the web component.",
"examples": [
"my-widget"
],
"title": "Tag",
"type": "string"
}
},
"title": "",
"type": "object"
},
"uiExtensionHeaderItems": {
"description": "Web components that should be displayed in the global header.",
"items": {
"$ref": "#/$defs/uiExtensionHeaderItem"
},
"title": "Header items",
"type": "array"
},
"uiExtensions": {
"additionalProperties": false,
"description": "",
"properties": {
"dashboard": {
"$ref": "#/$defs/uiExtensionDashboardItems"
},
"header": {
"$ref": "#/$defs/uiExtensionHeaderItems"
}
},
"title": "Contains ui extensions for the home screen",
"type": "object"
}
},
"$id": "https://json-schema.boschrexroth.com/ctrlx-automation/ctrlx-os/apps/package-manifest/package-manifest.v1.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"$schema": {
"default": "https://json-schema.boschrexroth.com/ctrlx-automation/ctrlx-os/apps/package-manifest/package-manifest.v1.schema.json",
"description": "Definition of schema, should point to a valid package-manifest schema definition, e.g.: https://json-schema.boschrexroth.com/ctrlx-automation/ctrlx-os/apps/package-manifest/package-manifest.v1.schema.json",
"title": "Definition of schema",
"type": "string"
},
"apps": {
"$ref": "#/$defs/apps"
},
"certificatestores": {
"description": "Certficate stores of your application",
"items": {
"$ref": "#/$defs/certificateStore"
},
"title": "List of certificate stores",
"type": "array"
},
"commands": {
"$ref": "#/$defs/commands"
},
"configuration": {
"$ref": "#/$defs/configuration"
},
"dependencies": {
"additionalProperties": false,
"properties": {
"dependsOn": {
"$ref": "#/$defs/dependencies"
}
},
"summary": "Dependencies required by the app providing the package-manifest",
"title": "App dependencies",
"type": "object"
},
"documentation": {
"$ref": "#/$defs/documentation"
},
"id": {
"description": "Unique identifier of the package. Must match the following RegEx: ^[0-9a-ZA-Z]. Must match the identifier defined in the snapcraft.yaml.",
"examples": [
"rexroth-solutions",
"rexroth-automation",
"rexroth-vpnmanager",
"ctrlx-node-red"
],
"title": "Identifier of the package",
"type": "string"
},
"licenses": {
"$ref": "#/$defs/licenses"
},
"menus": {
"$ref": "#/$defs/menus"
},
"required": {
"default": false,
"description": "Required marks an app as non-removable. This app isn't a system app by default but required for the functionality",
"examples": [
true,
false
],
"title": "App is required app for system and not removable",
"type": "boolean"
},
"scopes-declaration": {
"$ref": "#/$defs/scopes-declaration"
},
"services": {
"$ref": "#/$defs/services"
},
"uiExtensions": {
"$ref": "#/$defs/uiExtensions"
},
"version": {
"description": "Version of the package manifest.",
"examples": [
"1.0.0",
"2.1.0",
"1.2.10"
],
"pattern": "^(\\d+\\.)(\\d+\\.)(\\d+)$",
"title": "Package manifest version",
"type": "string"
}
},
"title": "ctrlX OS Package Manifest",
"type": "object"
} | MIT | en |
boschrexroth/json-schema | a2d8b913b7f301e0f245f5dd20eb596da9dbcf6a | 2024-04-09T08:01:52 | ctrlx-automation/ctrlx-os/apps/package-manifest/package-manifest.v1.1.schema.json | 9 | 2024-05-28T05:20:26.511771Z | {
"$id": "https://json-schema.boschrexroth.com/ctrlx-automation/ctrlx-os/apps/package-manifest/package-manifest.v1.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"definitions": {
"appDirectory": {
"additionalProperties": false,
"description": "Describes an app configuration directory stored as part of a configuration.",
"properties": {
"copyOnLoad": {
"default": false,
"description": "An app is responsible for persisting its configuration state to the app data folder, even for the load command. With copyOnLoad, the app is able to delegate this task to the Solutions app.",
"examples": [
true,
false
],
"title": "Copy on load",
"type": "boolean"
},
"description": {
"description": "Short description of the content of the directory. Will be displayed as part of a configuration.",
"examples": [
"My app",
"My cool feature 1",
"My cool feature 2"
],
"title": "Title",
"type": "string"
},
"icon": {
"description": "An optional icon which represents the app.",
"examples": [
"bosch-ic-robot",
"bosch-ic-directory"
],
"title": "Icon",
"type": "string"
},
"name": {
"description": "Path of the app directory. Subdirectories are separated with /, no leading or trailing /",
"examples": [
"my-app",
"my-app/subdir1",
"my-app/subdir2"
],
"title": "Path of the app directory in the configuration",
"type": "string"
}
},
"required": [
"name"
],
"title": "App directory",
"type": "object"
},
"certificateStore": {
"additionalProperties": false,
"description": "certificate store enables your application to manage certificates and keys using Device Admin",
"properties": {
"description": {
"description": "Describes the content and usage of the certificates in the store",
"example": "Certficates & Keys to connect to the World",
"title": "Description of your certificate store",
"type": "string"
},
"id": {
"description": "Id of your store, should contain snap name as prefix, e.g. ctrlx-helloworld.certificates",
"example": "ctrlx-helloworld.certificates",
"title": "Id of your store",
"type": "string"
},
"title": {
"description": "Title of your certificate store that is displayed in ctrlX Device Admin UI",
"example": "Hello World",
"title": "Title of certificate store",
"type": "string"
}
},
"title": "Store for Certificates and Keys",
"type": "object"
},
"command": {
"description": "A command that is provided and can be executed by another application. A command can have multiple command requests, e.g. to execute the command on multiple services.",
"items": {
"$ref": "#/definitions/commandRequest"
},
"title": "Command",
"type": "array"
},
"commandRequest": {
"additionalProperties": false,
"description": "A command object.",
"properties": {
"execution": {
"additionalProperties": false,
"description": "The execution element is deprecated. Use url element instead.",
"properties": {
"method": {
"default": "POST",
"description": "The HTTP method called for executing this command; one of 'POST' and 'PUT'; the default is 'POST'.",
"enum": [
"PUT",
"POST"
],
"examples": [
"POST"
],
"title": "HTTP method",
"type": "string"
},
"url": {
"description": "The URL used for executing this command",
"examples": [
"/automation/api/v1/motion/cfg/save"
],
"title": "URL",
"type": "string"
}
},
"required": [
"url"
],
"title": "Execution",
"type": "object"
},
"id": {
"description": "The identifier of this command; must be unique within the enclosing scope.",
"examples": [
"motion"
],
"title": "Id",
"type": "string"
},
"subject": {
"description": "Denotes what will be saved or loaded; used to inform users, e.g. in messages like 'Loading motion settings' or 'Cannot load motion settings'",
"examples": [
"motion settings"
],
"title": "Subject",
"type": "string"
},
"url": {
"description": "The request URL. Called as a POST request. URLs starting with a slash are interpreted to be relative to https://<host>. The execution and url elements are mutually exclusive, that is exactly one of them is required.",
"examples": [
"/automation/api/v1/motion/cfg/save"
],
"title": "URL",
"type": "string"
}
},
"required": [
"id",
"subject"
],
"title": "Command",
"type": "object"
},
"commandScope": {
"additionalProperties": {
"$ref": "#/definitions/command"
},
"description": "A command scope containing multiple commands.",
"title": "Command Scope",
"type": "object"
},
"commands": {
"additionalProperties": {
"$ref": "#/definitions/commandScope"
},
"description": "Allows to specify commands that integrate into framework operations, e.g. for activeConfiguration. The sub-elements define the scopes that support command integration.",
"properties": {},
"title": "Commands",
"type": "object"
},
"configuration": {
"additionalProperties": false,
"description": "Configuration topics",
"properties": {
"appDirectories": {
"description": "Describes app directories and specifies access to them inside the configuration",
"items": {
"$ref": "#/definitions/appDirectory"
},
"type": "array"
}
},
"type": "object"
},
"document": {
"additionalProperties": false,
"description": "Specifies a reference to a document",
"properties": {
"description": {
"description": "Short description of the content of the document.",
"examples": [
"Provides my-app related functionalities on ctrlX devices."
],
"title": "Description of the document",
"type": "string"
},
"name": {
"description": "Name or title of the document. Can be used in headlines, e.g.",
"examples": [
"My-App API"
],
"title": "Name of the document",
"type": "string"
},
"type": {
"description": "Type of the document. Can be used for assignment purposes, e.g.",
"enum": [
"api"
],
"examples": [
"api"
],
"title": "Type of the document",
"type": "string"
},
"url": {
"description": "Specifies the path to the document resource.",
"examples": [
"/my-app/doc/api"
],
"title": "URL of the document",
"type": "string"
}
},
"title": "Document",
"type": "object"
},
"documentation": {
"description": "Contains documents like API references, e.g.",
"items": {
"$ref": "#/definitions/document"
},
"title": "Documentation",
"type": "array"
},
"entries": {
"additionalProperties": false,
"description": "A navigation entry point of the package",
"oneOf": [
{
"required": [
"id",
"title",
"link"
]
},
{
"required": [
"id",
"title",
"items"
]
}
],
"properties": {
"icon": {
"description": "An optional icon, see... to represent the entry point",
"examples": [
"bosch-ic-automation"
],
"title": "Icon",
"type": "string"
},
"id": {
"description": "Identifier of the link. Used to define menu orders.",
"examples": [
"my-app"
],
"title": "Id",
"type": "string"
},
"items": {
"description": "Sub entries of the entry point",
"items": {
"$ref": "#/definitions/entries"
},
"title": "Sublinks",
"type": "array"
},
"link": {
"description": "Relative path of the link",
"examples": [
"/my-app",
"/my-app?access_token=${bearertoken}",
"http://${hostname}:1234/",
"https://www.google.com/"
],
"title": "Link to the ressource. The link includes the prefix of the service",
"type": "string"
},
"permissions": {
"description": "An optional list of permissions to enable the entry point",
"items": {
"examples": [
"my-app.r",
"my-app.rw",
"my-app.cool-feature.r",
"my-app.cool-feature.rw"
],
"pattern": "^(.*)$",
"title": "Permission",
"type": "string"
},
"title": "Permissions",
"type": "array"
},
"target": {
"description": "Specifies where to show the link. Identical to the target property of an anchor element.",
"examples": [
"_blank",
"my-app"
],
"title": "Target",
"type": "string"
},
"title": {
"description": "The text representation of the entry point",
"examples": [
"My App"
],
"title": "Title",
"type": "string"
}
},
"title": "Link",
"type": "object"
},
"menus": {
"additionalProperties": false,
"description": "Menus and links a package provides. The declarations will be used by the device admin to generate the corresponding entries in the sidebar or overview.",
"properties": {
"overview": {
"items": {
"$ref": "#/definitions/entries"
},
"title": "Overview",
"type": "array"
},
"settings": {
"items": {
"$ref": "#/definitions/entries"
},
"title": "Settings Menu",
"type": "array"
},
"sidebar": {
"items": {
"$ref": "#/definitions/entries"
},
"title": "Sidebar Menu",
"type": "array"
}
},
"title": "Menus",
"type": "object"
},
"proxyMapping": {
"additionalProperties": false,
"description": "ProxyMapping defines a web service mappings. A service has a name for identification, a relative path where it should be reachable and a socket (network or unix) to bind to",
"properties": {
"binding": {
"description": "A network socket, e.g. :5000 or unix socket e.g. unix://{$SNAP_DATA}/package-run/my-app.web.sock",
"examples": [
":5000",
"http://localhost:5000",
"unix://{$SNAP_DATA}/package-run/my-app.web.sock"
],
"title": "Binding",
"type": "string"
},
"name": {
"description": "A Name for the mapping",
"examples": [
"my-app.web"
],
"title": "Name",
"type": "string"
},
"options": {
"description": "Additional options of the proxy configuration",
"examples": [
{
"option": "websocket",
"value": ""
},
{
"option": "max_conns",
"value": "2"
}
],
"items": {
"additionalProperties": false,
"properties": {
"option": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"title": "Additional options",
"type": "array"
},
"restricted": {
"description": "Resources, to which the access shall be restricted, e.g. API URLs",
"items": {
"examples": [
"/my-app/api/v1.0",
"/my-app/api/v1.0"
],
"type": "string"
},
"title": "Restricted resources",
"type": "array"
},
"url": {
"description": "Relative path the service is requesting",
"examples": [
"/my-app"
],
"title": "Url",
"type": "string"
}
},
"title": "ProxyMapping",
"type": "object"
},
"scope": {
"additionalProperties": false,
"description": "A scope represents a web service resource specific permission and consists of an identifier, a name and a human-readable description.",
"properties": {
"description": {
"description": "The description of the scope. Used by the identity management frontend to describe the scope set.",
"examples": [
"This permissions allows to read and modify all automation parameters",
"This permissions allows to read all automation parameters",
"This permissions allows to read all motion parameters"
],
"title": "Description of the scope",
"type": "string"
},
"identifier": {
"description": "The unique identifier of the scope. Must be derived from the id and follow the schema <id>.<service>.<scope_name>.<access_type>",
"examples": [
"my-app.cool-feature.rw (allow read/write access to all resources",
"my-app.cool-feature.r (allow access to all resources on a read-only basis)"
],
"title": "The identifier of the scope",
"type": "string"
},
"name": {
"description": "The name of the scope set. Should be unique. Used by the identity management frontend to display the scope. Should describe the what the permission means.",
"examples": [
"Read/write access (all parameters)",
"Read access (all parameters)",
"Read access (motion parameters)"
],
"title": "The name of the scope",
"type": "string"
}
},
"title": "Web server scope",
"type": "object"
},
"scopes-declaration": {
"description": "Scopes used in the application to control access to specific ressources. The scope declaration is used by the identity management (IDM) to assign permissions for specific users or groups.",
"items": {
"$ref": "#/definitions/setOfScopes"
},
"title": "Scopes provided by the package",
"type": "array"
},
"services": {
"additionalProperties": false,
"description": "Services contains a set of services a package is providing",
"properties": {
"proxyMapping": {
"description": "Proxy mappings are used by the reverse proxy to assign specific routes to a server running on a device.",
"items": {
"$ref": "#/definitions/proxyMapping"
},
"title": "Proxy mappings",
"type": "array"
}
},
"title": "Services",
"type": "object"
},
"setOfScopes": {
"additionalProperties": false,
"description": "A set of scopes declares the scopes which are supported by the web service. The set includes identifer, name, a human-readable description and one or more scopes.",
"properties": {
"description": {
"description": "The description of the scope set. Used by the identity management frontend to describe the scope set.",
"title": "Description of the scope set",
"type": "string"
},
"identifier": {
"description": "The unique identifier of the permission set. Must be derived from the identifier and must not contain spaces. Must be unique.",
"examples": [
"my-app.web"
],
"title": "The identifier of the scope set",
"type": "string"
},
"name": {
"description": "The name of the scope set. Should be unique. Used by the identity management frontend to display the scope set.",
"examples": [
"My App Scopes"
],
"title": "The name of the scope set",
"type": "string"
},
"scopes": {
"description": "Array of scopes. Each scope describes a specific permission for one or more web server resources, e.g. write to a resource using HTTP PUT",
"items": {
"$ref": "#/definitions/scope"
},
"title": "Array of scopes",
"type": "array"
}
},
"title": "Set of scopes",
"type": "object"
}
},
"properties": {
"$schema": {
"default": "https://json-schema.boschrexroth.com/ctrlx-automation/ctrlx-os/apps/package-manifest/package-manifest.v1.schema.json",
"description": "Definition of schema, should point to a valid package-manifest schema definition, e.g.: https://json-schema.boschrexroth.com/ctrlx-automation/ctrlx-os/apps/package-manifest/package-manifest.v1.schema.json",
"title": "Definition of schema",
"type": "string"
},
"certificatestores": {
"description": "Certficate stores of your application",
"items": {
"$ref": "#/definitions/certificateStore"
},
"title": "List of certificate stores",
"type": "array"
},
"commands": {
"$ref": "#/definitions/commands"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"documentation": {
"$ref": "#/definitions/documentation"
},
"id": {
"description": "Unique identifier of the package. Must match the following RegEx: ^[0-9a-ZA-Z]. Must match the identifier defined in the snapcraft.yaml.",
"examples": [
"rexroth-solutions",
"rexroth-automation",
"rexroth-vpnmanager",
"ctrlx-node-red"
],
"title": "Identifier of the package",
"type": "string"
},
"menus": {
"$ref": "#/definitions/menus"
},
"real-time": {
"default": true,
"description": "Real-time indicates whenether the services of the app requires real-time capabilities of the system and is using advanced real-time features, e.g. ctrlX Automation OS task scheduling.",
"examples": [
true,
false
],
"title": "Real-time requirements of the app",
"type": "boolean"
},
"scopes-declaration": {
"$ref": "#/definitions/scopes-declaration"
},
"services": {
"$ref": "#/definitions/services"
},
"version": {
"description": "Version of the package manifest.",
"examples": [
"1.0.0",
"2.1.0",
"1.2.10"
],
"pattern": "^(\\d+\\.)(\\d+\\.)(\\d+)$",
"title": "Package manifest version",
"type": "string"
}
},
"title": "ctrlX OS Package Manifest",
"type": "object"
} | MIT | en |
boschrexroth/json-schema | a2d8b913b7f301e0f245f5dd20eb596da9dbcf6a | 2024-04-09T08:01:52 | ctrlx-automation/ctrlx-os/apps/package-manifest/package-manifest.v1.2.schema.json | 9 | 2024-05-28T05:20:26.511771Z | {
"$id": "https://json-schema.boschrexroth.com/ctrlx-automation/ctrlx-os/apps/package-manifest/package-manifest.v1.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"definitions": {
"appDirectory": {
"additionalProperties": false,
"description": "Describes an app configuration directory stored as part of a configuration.",
"properties": {
"copyOnLoad": {
"default": false,
"description": "An app is responsible for persisting its configuration state to the app data folder, even for the load command. With copyOnLoad, the app is able to delegate this task to the Solutions app.",
"examples": [
true,
false
],
"title": "Copy on load",
"type": "boolean"
},
"description": {
"description": "Short description of the content of the directory. Will be displayed as part of a configuration.",
"examples": [
"My app",
"My cool feature"
],
"title": "Title",
"type": "string"
},
"icon": {
"description": "An optional icon which represents the app.",
"examples": [
"my-icon"
],
"title": "Icon",
"type": "string"
},
"name": {
"description": "Path of the app directory. Subdirectories are separated with /, no leading or trailing /",
"examples": [
"my-app",
"my-app/cool-feature"
],
"title": "Path of the app directory in the configuration",
"type": "string"
},
"writeProtected": {
"default": false,
"description": "An app can protect its directories in the active configuration against write-access, e.g. via WebDAV. Since XCR-V-0112.",
"examples": [
true,
false
],
"title": "Write-protection of app directories",
"type": "boolean"
}
},
"required": [
"name"
],
"title": "App directory",
"type": "object"
},
"apps": {
"additionalProperties": false,
"description": "Contains configurations for specific rexroth apps",
"properties": {
"rexroth-remoteagent": {
"$ref": "#/definitions/rexroth-remoteagent"
}
},
"title": "Configurations for specific rexroth apps",
"type": "object"
},
"certificateStore": {
"additionalProperties": false,
"description": "certificate store enables your application to manage certificates and keys using Device Admin",
"properties": {
"description": {
"description": "Describes the content and usage of the certificates in the store",
"example": "Certficates & Keys to connect to the World",
"title": "Description of your certificate store",
"type": "string"
},
"id": {
"description": "Id of your store, should contain snap name as prefix, e.g. ctrlx-helloworld.certificates",
"example": "ctrlx-helloworld.certificates",
"title": "Id of your store",
"type": "string"
},
"title": {
"description": "Title of your certificate store that is displayed in ctrlX Device Admin UI",
"example": "Hello World",
"title": "Title of certificate store",
"type": "string"
}
},
"title": "Store for Certificates and Keys",
"type": "object"
},
"command": {
"description": "A command that is provided and can be executed by another application. A command can have multiple command requests, e.g. to execute the command on multiple services.",
"items": {
"$ref": "#/definitions/commandRequest"
},
"title": "Command",
"type": "array"
},
"commandRequest": {
"additionalProperties": false,
"description": "A command object.",
"properties": {
"execution": {
"additionalProperties": false,
"description": "The execution element is deprecated. Use url element instead.",
"properties": {
"method": {
"default": "POST",
"description": "The HTTP method called for executing this command; one of 'POST' and 'PUT'; the default is 'POST'.",
"enum": [
"PUT",
"POST"
],
"examples": [
"POST"
],
"title": "HTTP method",
"type": "string"
},
"url": {
"description": "The URL used for executing this command",
"examples": [
"/automation/api/v1/motion/cfg/save"
],
"title": "URL",
"type": "string"
}
},
"required": [
"url"
],
"title": "Execution",
"type": "object"
},
"id": {
"description": "The identifier of this command; must be unique within the enclosing scope.",
"examples": [
"motion"
],
"title": "Id",
"type": "string"
},
"subject": {
"description": "Denotes what will be saved or loaded; used to inform users, e.g. in messages like 'Loading motion settings' or 'Cannot load motion settings'",
"examples": [
"motion settings"
],
"title": "Subject",
"type": "string"
},
"url": {
"description": "The request URL. Called as a POST request. URLs starting with a slash are interpreted to be relative to https://<host>. The execution and url elements are mutually exclusive, that is exactly one of them is required.",
"examples": [
"/automation/api/v1/motion/cfg/save"
],
"title": "URL",
"type": "string"
}
},
"required": [
"id",
"subject"
],
"title": "Command",
"type": "object"
},
"commandScope": {
"additionalProperties": {
"$ref": "#/definitions/command"
},
"description": "A command scope containing multiple commands.",
"title": "Command Scope",
"type": "object"
},
"commands": {
"additionalProperties": {
"$ref": "#/definitions/commandScope"
},
"description": "Allows to specify commands that integrate into framework operations, e.g. for activeConfiguration. The sub-elements define the scopes that support command integration.",
"properties": {},
"title": "Commands",
"type": "object"
},
"configuration": {
"additionalProperties": false,
"description": "Configuration topics",
"properties": {
"appDirectories": {
"description": "Describes app directories and specifies access to them inside the configuration",
"items": {
"$ref": "#/definitions/appDirectory"
},
"type": "array"
},
"appPrivateFiles": {
"description": "Defines files which are ignored on saving and loading. The files are matched case-insensitively using regular expressions. Since XCR-V-0112.",
"items": {
"description": "A regular expression following the RE2 syntax (https://golang.org/s/re2syntax)",
"examples": [
"^my-app/[^/]+\\.bak$",
"^my-app/tmp/",
"^my-app/tmp"
],
"title": "Regular expression",
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"document": {
"additionalProperties": false,
"description": "Specifies a reference to a document",
"properties": {
"description": {
"description": "Short description of the content of the document.",
"examples": [
"Provides my-app related functionalities on ctrlX devices."
],
"title": "Description of the document",
"type": "string"
},
"name": {
"description": "Name or title of the document. Can be used in headlines, e.g.",
"examples": [
"My-App API"
],
"title": "Name of the document",
"type": "string"
},
"type": {
"description": "Type of the document. Can be used for assignment purposes, e.g.",
"enum": [
"api"
],
"examples": [
"api"
],
"title": "Type of the document",
"type": "string"
},
"url": {
"description": "Specifies the path to the document resource.",
"examples": [
"/my-app/doc/api"
],
"title": "URL of the document",
"type": "string"
}
},
"title": "Document",
"type": "object"
},
"documentation": {
"description": "Contains documents like API references, e.g.",
"items": {
"$ref": "#/definitions/document"
},
"title": "Documentation",
"type": "array"
},
"entries": {
"additionalProperties": false,
"description": "A navigation entry point of the package",
"oneOf": [
{
"required": [
"id",
"title",
"link"
]
},
{
"required": [
"id",
"title",
"items"
]
}
],
"properties": {
"icon": {
"description": "An optional icon, see... to represent the entry point",
"examples": [
"bosch-ic-automation"
],
"title": "Icon",
"type": "string"
},
"id": {
"description": "Identifier of the link. Used to define menu orders.",
"examples": [
"my-app"
],
"title": "Id",
"type": "string"
},
"items": {
"description": "Sub entries of the entry point",
"items": {
"$ref": "#/definitions/entries"
},
"title": "Sublinks",
"type": "array"
},
"link": {
"description": "Relative path of the link",
"examples": [
"/my-app",
"/my-app?access_token=${bearertoken}",
"http://${hostname}:1234/",
"https://www.google.com/"
],
"title": "Link to the ressource. The link includes the prefix of the service",
"type": "string"
},
"permissions": {
"description": "An optional list of permissions to enable the entry point",
"items": {
"examples": [
"my-app.r",
"my-app.rw",
"my-app.cool-feature.r",
"my-app.cool-feature.rw"
],
"pattern": "^(.*)$",
"title": "Permission",
"type": "string"
},
"title": "Permissions",
"type": "array"
},
"target": {
"description": "Specifies where to show the link. Identical to the target property of an anchor element.",
"examples": [
"_blank",
"my-app"
],
"title": "Target",
"type": "string"
},
"title": {
"description": "The text representation of the entry point",
"examples": [
"My App"
],
"title": "Title",
"type": "string"
}
},
"title": "Link",
"type": "object"
},
"menus": {
"additionalProperties": false,
"description": "Menus and links a package provides. The declarations will be used by the device admin to generate the corresponding entries in the sidebar or overview.",
"properties": {
"overview": {
"items": {
"$ref": "#/definitions/entries"
},
"title": "Overview",
"type": "array"
},
"settings": {
"items": {
"$ref": "#/definitions/entries"
},
"title": "Settings Menu",
"type": "array"
},
"sidebar": {
"items": {
"$ref": "#/definitions/entries"
},
"title": "Sidebar Menu",
"type": "array"
}
},
"title": "Menus",
"type": "object"
},
"proxyMapping": {
"additionalProperties": false,
"description": "ProxyMapping defines a web service mappings. A service has a name for identification, a relative path where it should be reachable and a socket (network or unix) to bind to",
"properties": {
"binding": {
"description": "A network socket, e.g. :5000 or unix socket e.g. unix://{$SNAP_DATA}/package-run/my-app.web.sock",
"examples": [
":5000",
"http://localhost:5000",
"unix://{$SNAP_DATA}/package-run/my-app.web.sock"
],
"title": "Binding",
"type": "string"
},
"name": {
"description": "A Name for the mapping",
"examples": [
"my-app.web"
],
"title": "Name",
"type": "string"
},
"options": {
"description": "Additional options of the proxy configuration",
"examples": [
{
"option": "websocket",
"value": ""
},
{
"option": "max_conns",
"value": "2"
}
],
"items": {
"additionalProperties": false,
"properties": {
"option": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"title": "Additional options",
"type": "array"
},
"restricted": {
"description": "Resources, to which the access shall be restricted, e.g. API URLs",
"items": {
"examples": [
"/my-app/api/v1.0",
"/my-app/api/v1.0"
],
"type": "string"
},
"title": "Restricted resources",
"type": "array"
},
"url": {
"description": "Relative path the service is requesting",
"examples": [
"/my-app"
],
"title": "Url",
"type": "string"
}
},
"title": "ProxyMapping",
"type": "object"
},
"rexroth-remoteagent": {
"additionalProperties": false,
"description": "Contains allowed commands for remote device administration",
"properties": {
"commands": {
"description": "Remote device administration commands are used to execute commands on the device from the Nexeed Device Portal",
"examples": [
[
"BACKUP",
"RESTORE",
"REBOOT"
]
],
"items": {
"type": "string"
},
"title": "Remote device administration commands",
"type": "array"
}
},
"title": "Commands for remote device administration",
"type": "object"
},
"scope": {
"additionalProperties": false,
"description": "A scope represents a web service resource specific permission and consists of an identifier, a name and a human-readable description.",
"properties": {
"description": {
"description": "The description of the scope. Used by the identity management frontend to describe the scope set.",
"examples": [
"This permissions allows to read and modify all automation parameters",
"This permissions allows to read all automation parameters",
"This permissions allows to read all motion parameters"
],
"title": "Description of the scope",
"type": "string"
},
"identifier": {
"description": "The unique identifier of the scope. Must be derived from the id and follow the schema <id>.<service>.<scope_name>.<access_type>",
"examples": [
"my-app.cool-feature.rw (allow read/write access to all resources",
"my-app.cool-feature.r (allow access to all resources on a read-only basis)"
],
"title": "The identifier of the scope",
"type": "string"
},
"name": {
"description": "The name of the scope set. Should be unique. Used by the identity management frontend to display the scope. Should describe the what the permission means.",
"examples": [
"Read/write access (all parameters)",
"Read access (all parameters)",
"Read access (motion parameters)"
],
"title": "The name of the scope",
"type": "string"
}
},
"title": "Web server scope",
"type": "object"
},
"scopes-declaration": {
"description": "Scopes used in the application to control access to specific ressources. The scope declaration is used by the identity management (IDM) to assign permissions for specific users or groups.",
"items": {
"$ref": "#/definitions/setOfScopes"
},
"title": "Scopes provided by the package",
"type": "array"
},
"services": {
"additionalProperties": false,
"description": "Services contains a set of services a package is providing",
"properties": {
"proxyMapping": {
"description": "Proxy mappings are used by the reverse proxy to assign specific routes to a server running on a device.",
"items": {
"$ref": "#/definitions/proxyMapping"
},
"title": "Proxy mappings",
"type": "array"
}
},
"title": "Services",
"type": "object"
},
"setOfScopes": {
"additionalProperties": false,
"description": "A set of scopes declares the scopes which are supported by the web service. The set includes identifer, name, a human-readable description and one or more scopes.",
"properties": {
"description": {
"description": "The description of the scope set. Used by the identity management frontend to describe the scope set.",
"title": "Description of the scope set",
"type": "string"
},
"identifier": {
"description": "The unique identifier of the permission set. Must be derived from the identifier and must not contain spaces. Must be unique.",
"examples": [
"my-app.web"
],
"title": "The identifier of the scope set",
"type": "string"
},
"name": {
"description": "The name of the scope set. Should be unique. Used by the identity management frontend to display the scope set.",
"examples": [
"My App Scopes"
],
"title": "The name of the scope set",
"type": "string"
},
"scopes": {
"description": "Array of scopes. Each scope describes a specific permission for one or more web server resources, e.g. write to a resource using HTTP PUT",
"items": {
"$ref": "#/definitions/scope"
},
"title": "Array of scopes",
"type": "array"
}
},
"title": "Set of scopes",
"type": "object"
}
},
"properties": {
"$schema": {
"default": "https://json-schema.boschrexroth.com/ctrlx-automation/ctrlx-os/apps/package-manifest/package-manifest.v1.schema.json",
"description": "Definition of schema, should point to a valid package-manifest schema definition, e.g.: https://json-schema.boschrexroth.com/ctrlx-automation/ctrlx-os/apps/package-manifest/package-manifest.v1.schema.json",
"title": "Definition of schema",
"type": "string"
},
"apps": {
"$ref": "#/definitions/apps"
},
"certificatestores": {
"description": "Certficate stores of your application",
"items": {
"$ref": "#/definitions/certificateStore"
},
"title": "List of certificate stores",
"type": "array"
},
"commands": {
"$ref": "#/definitions/commands"
},
"configuration": {
"$ref": "#/definitions/configuration"
},
"documentation": {
"$ref": "#/definitions/documentation"
},
"id": {
"description": "Unique identifier of the package. Must match the following RegEx: ^[0-9a-ZA-Z]. Must match the identifier defined in the snapcraft.yaml.",
"examples": [
"rexroth-solutions",
"rexroth-automation",
"rexroth-vpnmanager",
"ctrlx-node-red"
],
"title": "Identifier of the package",
"type": "string"
},
"menus": {
"$ref": "#/definitions/menus"
},
"required": {
"default": false,
"description": "Required marks an app as non-removable. This app isn't a system app by default but required for the functionality",
"examples": [
true,
false
],
"title": "App is required app for system and not removable",
"type": "boolean"
},
"scopes-declaration": {
"$ref": "#/definitions/scopes-declaration"
},
"services": {
"$ref": "#/definitions/services"
},
"version": {
"description": "Version of the package manifest.",
"examples": [
"1.0.0",
"2.1.0",
"1.2.10"
],
"pattern": "^(\\d+\\.)(\\d+\\.)(\\d+)$",
"title": "Package manifest version",
"type": "string"
}
},
"title": "ctrlX OS Package Manifest",
"type": "object"
} | MIT | en |
boschrexroth/json-schema | a2d8b913b7f301e0f245f5dd20eb596da9dbcf6a | 2024-04-09T08:01:52 | ctrlx-automation/ctrlx-os/apps/package-manifest/package-manifest.v1.3.schema.json | 9 | 2024-05-28T05:20:26.511771Z | {
"$defs": {
"appDirectory": {
"additionalProperties": false,
"description": "Describes an app configuration directory stored as part of a configuration.",
"properties": {
"copyOnLoad": {
"default": false,
"description": "An app is responsible for persisting its configuration state to the app data folder, even for the load command. With copyOnLoad, the app is able to delegate this task to the Solutions app.",
"examples": [
true,
false
],
"title": "Copy on load",
"type": "boolean"
},
"description": {
"description": "Short description of the content of the directory. Will be displayed as part of a configuration.",
"examples": [
"My app",
"My cool feature"
],
"title": "Title",
"type": "string"
},
"icon": {
"description": "An optional icon which represents the app.",
"examples": [
"my-icon"
],
"title": "Icon",
"type": "string"
},
"name": {
"description": "Path of the app directory. Subdirectories are separated with /, no leading or trailing /",
"examples": [
"my-app",
"my-app/cool-feature"
],
"title": "Path of the app directory in the configuration",
"type": "string"
},
"writeProtected": {
"default": true,
"description": "An app can protect its directories in the active configuration against write-access, e.g. via WebDAV. Since XCR-V-0112.",
"examples": [
true,
false
],
"title": "Write-protection of app directories",
"type": "boolean"
}
},
"required": [
"name"
],
"title": "App directory",
"type": "object"
},
"apps": {
"additionalProperties": false,
"description": "Contains configurations for specific rexroth apps",
"properties": {
"rexroth-remoteagent": {
"$ref": "#/$defs/rexroth-remoteagent"
}
},
"title": "Configurations for specific rexroth apps",
"type": "object"
},
"certificateStore": {
"additionalProperties": false,
"description": "certificate store enables your application to manage certificates and keys using Device Admin",
"properties": {
"description": {
"description": "Describes the content and usage of the certificates in the store",
"example": "Certficates & Keys to connect to the World",
"title": "Description of your certificate store",
"type": "string"
},
"id": {
"description": "Id of your store, should contain snap name as prefix, e.g. ctrlx-helloworld.certificates",
"example": "ctrlx-helloworld.certificates",
"title": "Id of your store",
"type": "string"
},
"title": {
"description": "Title of your certificate store that is displayed in ctrlX Device Admin UI",
"example": "Hello World",
"title": "Title of certificate store",
"type": "string"
}
},
"title": "Store for Certificates and Keys",
"type": "object"
},
"command": {
"description": "A command that is provided and can be executed by another application. A command can have multiple command requests, e.g. to execute the command on multiple services.",
"items": {
"$ref": "#/$defs/commandRequest"
},
"title": "Command",
"type": "array"
},
"commandRequest": {
"additionalProperties": false,
"description": "A command object.",
"properties": {
"execution": {
"additionalProperties": false,
"description": "The execution element is deprecated. Use url element instead.",
"properties": {
"method": {
"default": "POST",
"description": "The HTTP method called for executing this command; one of 'POST' and 'PUT'; the default is 'POST'.",
"enum": [
"PUT",
"POST"
],
"examples": [
"POST"
],
"title": "HTTP method",
"type": "string"
},
"url": {
"description": "The URL used for executing this command",
"examples": [
"/automation/api/v1/motion/cfg/save"
],
"title": "URL",
"type": "string"
}
},
"required": [
"url"
],
"title": "Execution",
"type": "object"
},
"id": {
"description": "The identifier of this command; must be unique within the enclosing scope.",
"examples": [
"motion"
],
"title": "Id",
"type": "string"
},
"subject": {
"description": "Denotes what will be saved or loaded; used to inform users, e.g. in messages like 'Loading motion settings' or 'Cannot load motion settings'",
"examples": [
"motion settings"
],
"title": "Subject",
"type": "string"
},
"url": {
"description": "The request URL. Called as a POST request. URLs starting with a slash are interpreted to be relative to https://<host>. The execution and url elements are mutually exclusive, that is exactly one of them is required.",
"examples": [
"/automation/api/v1/motion/cfg/save"
],
"title": "URL",
"type": "string"
}
},
"required": [
"id",
"subject"
],
"title": "Command",
"type": "object"
},
"commandScope": {
"additionalProperties": {
"$ref": "#/$defs/command"
},
"description": "A command scope containing multiple commands.",
"title": "Command Scope",
"type": "object"
},
"commands": {
"additionalProperties": {
"$ref": "#/$defs/commandScope"
},
"description": "Allows to specify commands that integrate into framework operations, e.g. for activeConfiguration. The sub-elements define the scopes that support command integration.",
"properties": {},
"title": "Commands",
"type": "object"
},
"configuration": {
"additionalProperties": false,
"description": "Configuration topics",
"properties": {
"appDirectories": {
"description": "Describes app directories and specifies access to them inside the configuration",
"items": {
"$ref": "#/$defs/appDirectory"
},
"type": "array"
},
"appPrivateFiles": {
"description": "Defines files which are ignored on saving and loading. The files are matched case-insensitively using regular expressions. Since XCR-V-0112.",
"items": {
"description": "A regular expression following the RE2 syntax (https://golang.org/s/re2syntax)",
"examples": [
"^my-app/[^/]+\\.bak$",
"^my-app/tmp/",
"^my-app/tmp"
],
"title": "Regular expression",
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"dependencies": {
"additionalProperties": false,
"description": "Defines all dependencies of the app. The map key is the unique app id. Only direct dependencies should be modeled here.",
"patternProperties": {
"^[a-z0-9-]*[a-z][a-z0-9-]*$": {
"description": "Definition of the version range using npmjs syntax, see https://semver.npmjs.com/ for more details.",
"title": "Version range defined as string",
"type": "string"
}
},
"title": "Map containing dependencies of the app",
"type": "object"
},
"document": {
"additionalProperties": false,
"description": "Specifies a reference to a document",
"properties": {
"description": {
"description": "Short description of the content of the document.",
"examples": [
"Provides my-app related functionalities on ctrlX devices."
],
"title": "Description of the document",
"type": "string"
},
"name": {
"description": "Name or title of the document. Can be used in headlines, e.g.",
"examples": [
"My-App API"
],
"title": "Name of the document",
"type": "string"
},
"type": {
"description": "Type of the document. Can be used for assignment purposes, e.g.",
"enum": [
"api"
],
"examples": [
"api"
],
"title": "Type of the document",
"type": "string"
},
"url": {
"description": "Specifies the path to the document resource.",
"examples": [
"/my-app/doc/api"
],
"title": "URL of the document",
"type": "string"
}
},
"title": "Document",
"type": "object"
},
"documentation": {
"description": "Contains documents like API references, e.g.",
"items": {
"$ref": "#/$defs/document"
},
"title": "Documentation",
"type": "array"
},
"entries": {
"additionalProperties": false,
"description": "A navigation entry point of the package",
"oneOf": [
{
"required": [
"id",
"title",
"link"
]
},
{
"required": [
"id",
"title",
"items"
]
}
],
"properties": {
"i18n": {
"$ref": "#/$defs/i18nTag"
},
"icon": {
"description": "An optional icon, see... to represent the entry point",
"examples": [
"bosch-ic-automation"
],
"title": "Icon",
"type": "string"
},
"id": {
"description": "Identifier of the link. Used to define menu orders.",
"examples": [
"my-app"
],
"title": "Id",
"type": "string"
},
"items": {
"description": "Sub entries of the entry point",
"items": {
"$ref": "#/$defs/entries"
},
"title": "Sublinks",
"type": "array"
},
"link": {
"description": "Relative path of the link",
"examples": [
"/my-app",
"/my-app?access_token=${bearertoken}",
"http://${hostname}:1234/",
"https://www.google.com/"
],
"title": "Link to the ressource. The link includes the prefix of the service",
"type": "string"
},
"permissions": {
"description": "An optional list of permissions to enable the entry point",
"items": {
"examples": [
"my-app.r",
"my-app.rw",
"my-app.cool-feature.r",
"my-app.cool-feature.rw"
],
"pattern": "^(.*)$",
"title": "Permission",
"type": "string"
},
"title": "Permissions",
"type": "array"
},
"target": {
"description": "Specifies where to show the link. Identical to the target property of an anchor element.",
"examples": [
"_blank",
"my-app"
],
"title": "Target",
"type": "string"
},
"title": {
"description": "The text representation of the entry point",
"examples": [
"My App"
],
"title": "Title",
"type": "string"
}
},
"title": "Link",
"type": "object"
},
"i18nTag": {
"description": "can be used to supply translations of properties of the object this tag is applied to. The defined tag value must be unique in the scope of the package-manifest.",
"pattern": "^(.*)$",
"title": "i18n Tag",
"type": "string"
},
"menus": {
"additionalProperties": false,
"description": "Menus and links a package provides. The declarations will be used by the device admin to generate the corresponding entries in the sidebar or overview.",
"properties": {
"overview": {
"items": {
"$ref": "#/$defs/entries"
},
"title": "Overview",
"type": "array"
},
"settings": {
"items": {
"$ref": "#/$defs/entries"
},
"title": "Settings Menu",
"type": "array"
},
"sidebar": {
"items": {
"$ref": "#/$defs/entries"
},
"title": "Sidebar Menu",
"type": "array"
}
},
"title": "Menus",
"type": "object"
},
"proxyMapping": {
"additionalProperties": false,
"description": "ProxyMapping defines a web service mappings. A service has a name for identification, a relative path where it should be reachable and a socket (network or unix) to bind to",
"properties": {
"binding": {
"description": "A network socket, e.g. :5000 or unix socket e.g. unix://{$SNAP_DATA}/package-run/my-app.web.sock",
"examples": [
":5000",
"http://localhost:5000",
"unix://{$SNAP_DATA}/package-run/my-app.web.sock"
],
"title": "Binding",
"type": "string"
},
"caddyfile": {
"description": "Path to customized caddy file, which should be included in the original caddy file",
"examples": [
"./caddyfile"
],
"title": "Customized caddy file",
"type": "string"
},
"name": {
"description": "A Name for the mapping",
"examples": [
"my-app.web"
],
"title": "Name",
"type": "string"
},
"options": {
"description": "Additional options of the proxy configuration",
"examples": [
{
"option": "websocket",
"value": ""
},
{
"option": "max_conns",
"value": "2"
}
],
"items": {
"additionalProperties": false,
"properties": {
"option": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"title": "Additional options",
"type": "array"
},
"restricted": {
"description": "Resources, to which the access shall be restricted, e.g. API URLs",
"examples": [
"/my-app-1/api/v1.0",
{
"except": [
"/my-app-2/api/v1.0/except-path-1",
"/my-app-2/api/v1.0/except-path-2"
],
"headersForwarding": [
"X-Auth-Name",
"X-Auth-ID",
"X-Auth-Scopes",
"X-Auth-Expires",
"X-Auth-Issued",
"X-Auth-PlcHandle",
"X-Auth-RemoteAuth",
"X-Auth-Nonce"
],
"path": "/my-app-2/api/v1.0"
}
],
"items": {
"oneOf": [
{
"properties": {
"except": {
"description": "Excepted subpaths, to which the access is not restricted",
"items": {
"type": "string"
},
"type": "array"
},
"headersForwarding": {
"description": "Headers, which are created by idmconnector and forwarded to endpoint",
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"description": "Path, to which the access shall be restricted",
"type": "string"
}
},
"required": [
"path"
],
"type": "object"
},
{
"description": "Path, which is restricted by identity manager",
"type": "string"
}
]
},
"title": "Restricted resources",
"type": "array"
},
"url": {
"description": "Relative path the service is requesting",
"examples": [
"/my-app"
],
"title": "Url",
"type": "string"
}
},
"title": "ProxyMapping",
"type": "object"
},
"rexroth-remoteagent": {
"additionalProperties": false,
"description": "Contains allowed commands for remote device administration",
"properties": {
"commands": {
"description": "Remote device administration commands are used to execute commands on the device from the Nexeed Device Portal",
"examples": [
[
"BACKUP",
"RESTORE",
"REBOOT"
]
],
"items": {
"type": "string"
},
"title": "Remote device administration commands",
"type": "array"
}
},
"title": "Commands for remote device administration",
"type": "object"
},
"scope": {
"additionalProperties": false,
"description": "A scope represents a web service resource specific permission and consists of an identifier, a name and a human-readable description.",
"properties": {
"description": {
"description": "The description of the scope. Used by the identity management frontend to describe the scope set.",
"examples": [
"This permissions allows to read and modify all automation parameters",
"This permissions allows to read all automation parameters",
"This permissions allows to read all motion parameters"
],
"title": "Description of the scope",
"type": "string"
},
"i18n": {
"$ref": "#/$defs/i18nTag"
},
"identifier": {
"description": "The unique identifier of the scope. Must be derived from the id and follow the schema <id>.<service>.<scope_name>.<access_type>",
"examples": [
"my-app.cool-feature.rw (allow read/write access to all resources",
"my-app.cool-feature.r (allow access to all resources on a read-only basis)"
],
"title": "The identifier of the scope",
"type": "string"
},
"name": {
"description": "The name of the scope set. Should be unique. Used by the identity management frontend to display the scope. Should describe the what the permission means.",
"examples": [
"Read/write access (all parameters)",
"Read access (all parameters)",
"Read access (motion parameters)"
],
"title": "The name of the scope",
"type": "string"
}
},
"title": "Web server scope",
"type": "object"
},
"scopes-declaration": {
"description": "Scopes used in the application to control access to specific ressources. The scope declaration is used by the identity management (IDM) to assign permissions for specific users or groups.",
"items": {
"$ref": "#/$defs/setOfScopes"
},
"title": "Scopes provided by the package",
"type": "array"
},
"services": {
"additionalProperties": false,
"description": "Services contains a set of services a package is providing",
"properties": {
"proxyMapping": {
"description": "Proxy mappings are used by the reverse proxy to assign specific routes to a server running on a device.",
"items": {
"$ref": "#/$defs/proxyMapping"
},
"title": "Proxy mappings",
"type": "array"
}
},
"title": "Services",
"type": "object"
},
"setOfScopes": {
"additionalProperties": false,
"description": "A set of scopes declares the scopes which are supported by the web service. The set includes identifer, name, a human-readable description and one or more scopes.",
"properties": {
"description": {
"description": "The description of the scope set. Used by the identity management frontend to describe the scope set.",
"title": "Description of the scope set",
"type": "string"
},
"identifier": {
"description": "The unique identifier of the permission set. Must be derived from the identifier and must not contain spaces. Must be unique.",
"examples": [
"my-app.web"
],
"title": "The identifier of the scope set",
"type": "string"
},
"name": {
"description": "The name of the scope set. Should be unique. Used by the identity management frontend to display the scope set.",
"examples": [
"My App Scopes"
],
"title": "The name of the scope set",
"type": "string"
},
"scopes": {
"description": "Array of scopes. Each scope describes a specific permission for one or more web server resources, e.g. write to a resource using HTTP PUT",
"items": {
"$ref": "#/$defs/scope"
},
"title": "Array of scopes",
"type": "array"
}
},
"title": "Set of scopes",
"type": "object"
}
},
"$id": "https://json-schema.boschrexroth.com/ctrlx-automation/ctrlx-os/apps/package-manifest/package-manifest.v1.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"$schema": {
"default": "https://json-schema.boschrexroth.com/ctrlx-automation/ctrlx-os/apps/package-manifest/package-manifest.v1.schema.json",
"description": "Definition of schema, should point to a valid package-manifest schema definition, e.g.: https://json-schema.boschrexroth.com/ctrlx-automation/ctrlx-os/apps/package-manifest/package-manifest.v1.schema.json",
"title": "Definition of schema",
"type": "string"
},
"apps": {
"$ref": "#/$defs/apps"
},
"certificatestores": {
"description": "Certficate stores of your application",
"items": {
"$ref": "#/$defs/certificateStore"
},
"title": "List of certificate stores",
"type": "array"
},
"commands": {
"$ref": "#/$defs/commands"
},
"configuration": {
"$ref": "#/$defs/configuration"
},
"dependencies": {
"additionalProperties": false,
"properties": {
"dependsOn": {
"$ref": "#/$defs/dependencies"
}
},
"summary": "Dependencies required by the app providing the package-manifest",
"title": "App dependencies",
"type": "object"
},
"documentation": {
"$ref": "#/$defs/documentation"
},
"id": {
"description": "Unique identifier of the package. Must match the following RegEx: ^[0-9a-ZA-Z]. Must match the identifier defined in the snapcraft.yaml.",
"examples": [
"rexroth-solutions",
"rexroth-automation",
"rexroth-vpnmanager",
"ctrlx-node-red"
],
"title": "Identifier of the package",
"type": "string"
},
"menus": {
"$ref": "#/$defs/menus"
},
"required": {
"default": false,
"description": "Required marks an app as non-removable. This app isn't a system app by default but required for the functionality",
"examples": [
true,
false
],
"title": "App is required app for system and not removable",
"type": "boolean"
},
"scopes-declaration": {
"$ref": "#/$defs/scopes-declaration"
},
"services": {
"$ref": "#/$defs/services"
},
"version": {
"description": "Version of the package manifest.",
"examples": [
"1.0.0",
"2.1.0",
"1.2.10"
],
"pattern": "^(\\d+\\.)(\\d+\\.)(\\d+)$",
"title": "Package manifest version",
"type": "string"
}
},
"title": "ctrlX OS Package Manifest",
"type": "object"
} | MIT | en |
osteele/p5-server | d43dc0aeb99ca98a678f3df7167e63ed88eb654b | 2021-11-13T04:57:35 | p5-analysis/src/models/schemas/categories.json | 44 | 2024-05-28T04:43:07.531077Z | {
"$id": "https://example.com/product.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "p5.js library categories",
"items": {
"additionalProperties": false,
"properties": {
"description": {
"description": "A short description of the library",
"type": "string"
},
"details": {
"description": "Additional details about the library",
"type": "string"
},
"key": {
"description": "A unique key",
"type": "string"
},
"name": {
"description": "The human-readable name of the library",
"type": "string"
}
},
"required": [
"key"
],
"type": "object",
"uniqueItems": true
},
"title": "Categories",
"type": "array"
} | MIT | en |
osteele/p5-server | d43dc0aeb99ca98a678f3df7167e63ed88eb654b | 2021-11-13T04:57:35 | p5-analysis/src/models/schemas/libraries.json | 44 | 2024-05-28T04:43:07.531077Z | {
"$id": "https://example.com/product.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A list of p5.js libraries",
"items": {
"additionalProperties": false,
"properties": {
"defines": {
"additionalProperties": false,
"description": "Functions and property values",
"items": {
"type": "object"
},
"patternProperties": {
"globals|p5": {
"items": {
"pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$",
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"description": {
"description": "A short description of the library",
"type": "string"
},
"homepage": {
"description": "The library's home page",
"pattern": "^https?:",
"type": "string"
},
"importPath": {
"description": "A CDN URL that loads the library",
"pattern": "^https?:|^@",
"type": "string"
},
"name": {
"description": "The human-readable name of the library",
"type": "string"
},
"packageName": {
"description": "NPM package name",
"type": "string"
},
"repository": {
"description": "The repository location, where this is different from the homepage",
"pattern": "^https?:",
"type": "string"
}
},
"required": [
"name",
"homepage",
"description"
],
"type": "object",
"uniqueItems": true
},
"title": "Libraries",
"type": "array"
} | MIT | en |
AbsaOSS/spline-spark-agent | 5f85dfe2d30438fee8b01e48dd0eb805c28ad782 | 2023-03-31T23:51:48 | core/src/main/resources/api/openlineage/OpenLineage.json | 171 | 2024-05-28T06:10:34.840102Z | {
"$defs": {
"BaseFacet": {
"additionalProperties": true,
"description": "all fields of the base facet are prefixed with _ to avoid name conflicts in facets",
"properties": {
"_producer": {
"description": "URI identifying the producer of this metadata. For example this could be a git url with a given tag or sha",
"example": "https://github.com/OpenLineage/OpenLineage/blob/v1-0-0/client",
"format": "uri",
"type": "string"
},
"_schemaURL": {
"description": "The JSON Pointer (https://tools.ietf.org/html/rfc6901) URL to the corresponding version of the schema definition for this facet",
"example": "https://openlineage.io/spec/1-0-2/OpenLineage.json#/$defs/BaseFacet",
"format": "uri",
"type": "string"
}
},
"required": [
"_producer",
"_schemaURL"
],
"type": "object"
},
"Dataset": {
"properties": {
"facets": {
"additionalProperties": {
"$ref": "#/$defs/DatasetFacet"
},
"description": "The facets for this dataset",
"type": "object"
},
"name": {
"description": "The unique name for that dataset within that namespace",
"example": "instance.schema.table",
"type": "string"
},
"namespace": {
"description": "The namespace containing that dataset",
"example": "my-datasource-namespace",
"type": "string"
}
},
"required": [
"namespace",
"name"
],
"type": "object"
},
"DatasetFacet": {
"allOf": [
{
"$ref": "#/$defs/BaseFacet"
}
],
"description": "A Dataset Facet",
"type": "object"
},
"InputDataset": {
"allOf": [
{
"$ref": "#/$defs/Dataset"
},
{
"properties": {
"inputFacets": {
"additionalProperties": {
"$ref": "#/$defs/InputDatasetFacet"
},
"description": "The input facets for this dataset.",
"type": "object"
}
},
"type": "object"
}
],
"description": "An input dataset",
"type": "object"
},
"InputDatasetFacet": {
"allOf": [
{
"$ref": "#/$defs/BaseFacet"
}
],
"description": "An Input Dataset Facet",
"type": "object"
},
"Job": {
"properties": {
"facets": {
"additionalProperties": {
"$ref": "#/$defs/JobFacet"
},
"description": "The job facets.",
"type": "object"
},
"name": {
"description": "The unique name for that job within that namespace",
"example": "myjob.mytask",
"type": "string"
},
"namespace": {
"description": "The namespace containing that job",
"example": "my-scheduler-namespace",
"type": "string"
}
},
"required": [
"namespace",
"name"
],
"type": "object"
},
"JobFacet": {
"allOf": [
{
"$ref": "#/$defs/BaseFacet"
}
],
"description": "A Job Facet",
"type": "object"
},
"OutputDataset": {
"allOf": [
{
"$ref": "#/$defs/Dataset"
},
{
"properties": {
"outputFacets": {
"additionalProperties": {
"$ref": "#/$defs/OutputDatasetFacet"
},
"description": "The output facets for this dataset",
"type": "object"
}
},
"type": "object"
}
],
"description": "An output dataset",
"type": "object"
},
"OutputDatasetFacet": {
"allOf": [
{
"$ref": "#/$defs/BaseFacet"
}
],
"description": "An Output Dataset Facet",
"type": "object"
},
"Run": {
"properties": {
"facets": {
"additionalProperties": {
"$ref": "#/$defs/RunFacet"
},
"description": "The run facets.",
"type": "object"
},
"runId": {
"description": "The globally unique ID of the run associated with the job.",
"format": "uuid",
"type": "string"
}
},
"required": [
"runId"
],
"type": "object"
},
"RunEvent": {
"properties": {
"eventTime": {
"description": "the time the event occurred at",
"format": "date-time",
"type": "string"
},
"eventType": {
"description": "the current transition of the run state. It is required to issue 1 START event and 1 of [ COMPLETE, ABORT, FAIL ] event per run. Additional events with OTHER eventType can be added to the same run. For example to send additional metadata after the run is complete",
"enum": [
"START",
"COMPLETE",
"ABORT",
"FAIL",
"OTHER"
],
"example": "START|COMPLETE|ABORT|FAIL|OTHER",
"type": "string"
},
"inputs": {
"description": "The set of **input** datasets.",
"items": {
"$ref": "#/$defs/InputDataset"
},
"type": "array"
},
"job": {
"$ref": "#/$defs/Job"
},
"outputs": {
"description": "The set of **output** datasets.",
"items": {
"$ref": "#/$defs/OutputDataset"
},
"type": "array"
},
"producer": {
"description": "URI identifying the producer of this metadata. For example this could be a git url with a given tag or sha",
"example": "https://github.com/OpenLineage/OpenLineage/blob/v1-0-0/client",
"format": "uri",
"type": "string"
},
"run": {
"$ref": "#/$defs/Run"
},
"schemaURL": {
"description": "The JSON Pointer (https://tools.ietf.org/html/rfc6901) URL to the corresponding version of the schema definition for this RunEvent",
"example": "https://openlineage.io/spec/0-0-1/OpenLineage.json",
"format": "uri",
"type": "string"
}
},
"required": [
"run",
"job",
"eventTime",
"producer",
"schemaURL"
],
"type": "object"
},
"RunFacet": {
"allOf": [
{
"$ref": "#/$defs/BaseFacet"
}
],
"description": "A Run Facet",
"type": "object"
}
},
"$id": "https://openlineage.io/spec/1-0-2/OpenLineage.json",
"$ref": "#/$defs/RunEvent",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
AbsaOSS/spline-spark-agent | 044aa5ab841dde9e90ae58f54ea381694d5c1760 | 2022-03-21T10:22:19 | core/src/main/resources/api/openlineage/OpenLineage.json | 171 | 2024-05-28T06:10:34.840102Z | {
"$defs": {
"BaseFacet": {
"additionalProperties": true,
"description": "all fields of the base facet are prefixed with _ to avoid name conflicts in facets",
"properties": {
"_producer": {
"description": "URI identifying the producer of this metadata. For example this could be a git url with a given tag or sha",
"example": "https://github.com/OpenLineage/OpenLineage/blob/v1-0-0/client",
"format": "uri",
"type": "string"
},
"_schemaURL": {
"description": "The JSON Pointer (https://tools.ietf.org/html/rfc6901) URL to the corresponding version of the schema definition for this facet",
"example": "https://openlineage.io/spec/1-0-2/OpenLineage.json#/$defs/BaseFacet",
"format": "uri",
"type": "string"
}
},
"required": [
"_producer",
"_schemaURL"
],
"type": "object"
},
"Dataset": {
"properties": {
"facets": {
"additionalProperties": {
"$ref": "#/$defs/DatasetFacet"
},
"description": "The facets for this dataset",
"type": "object"
},
"name": {
"description": "The unique name for that dataset within that namespace",
"example": "instance.schema.table",
"type": "string"
},
"namespace": {
"description": "The namespace containing that dataset",
"example": "my-datasource-namespace",
"type": "string"
}
},
"required": [
"namespace",
"name"
],
"type": "object"
},
"DatasetFacet": {
"allOf": [
{
"$ref": "#/$defs/BaseFacet"
}
],
"description": "A Dataset Facet",
"type": "object"
},
"InputDataset": {
"allOf": [
{
"$ref": "#/$defs/Dataset"
},
{
"properties": {
"inputFacets": {
"additionalProperties": {
"$ref": "#/$defs/InputDatasetFacet"
},
"description": "The input facets for this dataset.",
"type": "object"
}
},
"type": "object"
}
],
"description": "An input dataset",
"type": "object"
},
"InputDatasetFacet": {
"allOf": [
{
"$ref": "#/$defs/BaseFacet"
}
],
"description": "An Input Dataset Facet",
"type": "object"
},
"Job": {
"properties": {
"facets": {
"additionalProperties": {
"$ref": "#/$defs/JobFacet"
},
"description": "The job facets.",
"type": "object"
},
"name": {
"description": "The unique name for that job within that namespace",
"example": "myjob.mytask",
"type": "string"
},
"namespace": {
"description": "The namespace containing that job",
"example": "my-scheduler-namespace",
"type": "string"
}
},
"required": [
"namespace",
"name"
],
"type": "object"
},
"JobFacet": {
"allOf": [
{
"$ref": "#/$defs/BaseFacet"
}
],
"description": "A Job Facet",
"type": "object"
},
"OutputDataset": {
"allOf": [
{
"$ref": "#/$defs/Dataset"
},
{
"properties": {
"outputFacets": {
"additionalProperties": {
"$ref": "#/$defs/OutputDatasetFacet"
},
"description": "The output facets for this dataset",
"type": "object"
}
},
"type": "object"
}
],
"description": "An output dataset",
"type": "object"
},
"OutputDatasetFacet": {
"allOf": [
{
"$ref": "#/$defs/BaseFacet"
}
],
"description": "An Output Dataset Facet",
"type": "object"
},
"Run": {
"properties": {
"facets": {
"additionalProperties": {
"$ref": "#/$defs/RunFacet"
},
"description": "The run facets.",
"type": "object"
},
"runId": {
"description": "The globally unique ID of the run associated with the job.",
"format": "uuid",
"type": "string"
}
},
"required": [
"runId"
],
"type": "object"
},
"RunEvent": {
"properties": {
"eventTime": {
"description": "the time the event occurred at",
"format": "date-time",
"type": "string"
},
"eventType": {
"description": "the current transition of the run state. It is required to issue 1 START event and 1 of [ COMPLETE, ABORT, FAIL ] event per run. Additional events with OTHER eventType can be added to the same run. For example to send additional metadata after the run is complete",
"enum": [
"START",
"COMPLETE",
"ABORT",
"FAIL",
"OTHER"
],
"example": "START|COMPLETE|ABORT|FAIL|OTHER",
"type": "string"
},
"inputs": {
"description": "The set of **input** datasets.",
"items": {
"$ref": "#/$defs/InputDataset"
},
"type": "array"
},
"job": {
"$ref": "#/$defs/Job"
},
"outputs": {
"description": "The set of **output** datasets.",
"items": {
"$ref": "#/$defs/OutputDataset"
},
"type": "array"
},
"producer": {
"description": "URI identifying the producer of this metadata. For example this could be a git url with a given tag or sha",
"example": "https://github.com/OpenLineage/OpenLineage/blob/v1-0-0/client",
"format": "uri",
"type": "string"
},
"run": {
"$ref": "#/$defs/Run"
},
"schemaURL": {
"description": "The JSON Pointer (https://tools.ietf.org/html/rfc6901) URL to the corresponding version of the schema definition for this RunEvent",
"example": "https://openlineage.io/spec/0-0-1/OpenLineage.json",
"format": "uri",
"type": "string"
}
},
"required": [
"run",
"job",
"eventTime",
"producer",
"schemaURL"
],
"type": "object"
},
"RunFacet": {
"allOf": [
{
"$ref": "#/$defs/BaseFacet"
}
],
"description": "A Run Facet",
"type": "object"
}
},
"$id": "https://openlineage.io/spec/1-0-2/OpenLineage.json",
"$ref": "#/$defs/RunEvent",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
AbsaOSS/spline-openlineage | 5e3eafb574a0d20f6ac4e2275d1b74274dacf974 | 2022-04-20T16:00:48 | commons/src/main/resources/openlineage/OpenLineage.json | 5 | 2024-05-27T05:43:59.976271Z | {
"$defs": {
"BaseFacet": {
"additionalProperties": true,
"description": "all fields of the base facet are prefixed with _ to avoid name conflicts in facets",
"properties": {
"_producer": {
"description": "URI identifying the producer of this metadata. For example this could be a git url with a given tag or sha",
"example": "https://github.com/OpenLineage/OpenLineage/blob/v1-0-0/client",
"format": "uri",
"type": "string"
},
"_schemaURL": {
"description": "The JSON Pointer (https://tools.ietf.org/html/rfc6901) URL to the corresponding version of the schema definition for this facet",
"example": "https://openlineage.io/spec/1-0-2/OpenLineage.json#/$defs/BaseFacet",
"format": "uri",
"type": "string"
}
},
"required": [
"_producer",
"_schemaURL"
],
"type": "object"
},
"Dataset": {
"properties": {
"facets": {
"additionalProperties": {
"$ref": "#/$defs/DatasetFacet"
},
"description": "The facets for this dataset",
"type": "object"
},
"name": {
"description": "The unique name for that dataset within that namespace",
"example": "instance.schema.table",
"type": "string"
},
"namespace": {
"description": "The namespace containing that dataset",
"example": "my-datasource-namespace",
"type": "string"
}
},
"required": [
"namespace",
"name"
],
"type": "object"
},
"DatasetFacet": {
"allOf": [
{
"$ref": "#/$defs/BaseFacet"
}
],
"description": "A Dataset Facet",
"type": "object"
},
"InputDataset": {
"allOf": [
{
"$ref": "#/$defs/Dataset"
},
{
"properties": {
"inputFacets": {
"additionalProperties": {
"$ref": "#/$defs/InputDatasetFacet"
},
"description": "The input facets for this dataset.",
"type": "object"
}
},
"type": "object"
}
],
"description": "An input dataset",
"type": "object"
},
"InputDatasetFacet": {
"allOf": [
{
"$ref": "#/$defs/BaseFacet"
}
],
"description": "An Input Dataset Facet",
"type": "object"
},
"Job": {
"properties": {
"facets": {
"additionalProperties": {
"$ref": "#/$defs/JobFacet"
},
"description": "The job facets.",
"type": "object"
},
"name": {
"description": "The unique name for that job within that namespace",
"example": "myjob.mytask",
"type": "string"
},
"namespace": {
"description": "The namespace containing that job",
"example": "my-scheduler-namespace",
"type": "string"
}
},
"required": [
"namespace",
"name"
],
"type": "object"
},
"JobFacet": {
"allOf": [
{
"$ref": "#/$defs/BaseFacet"
}
],
"description": "A Job Facet",
"type": "object"
},
"OutputDataset": {
"allOf": [
{
"$ref": "#/$defs/Dataset"
},
{
"properties": {
"outputFacets": {
"additionalProperties": {
"$ref": "#/$defs/OutputDatasetFacet"
},
"description": "The output facets for this dataset",
"type": "object"
}
},
"type": "object"
}
],
"description": "An output dataset",
"type": "object"
},
"OutputDatasetFacet": {
"allOf": [
{
"$ref": "#/$defs/BaseFacet"
}
],
"description": "An Output Dataset Facet",
"type": "object"
},
"Run": {
"properties": {
"facets": {
"additionalProperties": {
"$ref": "#/$defs/RunFacet"
},
"description": "The run facets.",
"type": "object"
},
"runId": {
"description": "The globally unique ID of the run associated with the job.",
"format": "uuid",
"type": "string"
}
},
"required": [
"runId"
],
"type": "object"
},
"RunEvent": {
"properties": {
"eventTime": {
"description": "the time the event occurred at",
"format": "date-time",
"type": "string"
},
"eventType": {
"description": "the current transition of the run state. It is required to issue 1 START event and 1 of [ COMPLETE, ABORT, FAIL ] event per run. Additional events with OTHER eventType can be added to the same run. For example to send additional metadata after the run is complete",
"enum": [
"START",
"COMPLETE",
"ABORT",
"FAIL",
"OTHER"
],
"example": "START|COMPLETE|ABORT|FAIL|OTHER",
"type": "string"
},
"inputs": {
"description": "The set of **input** datasets.",
"items": {
"$ref": "#/$defs/InputDataset"
},
"type": "array"
},
"job": {
"$ref": "#/$defs/Job"
},
"outputs": {
"description": "The set of **output** datasets.",
"items": {
"$ref": "#/$defs/OutputDataset"
},
"type": "array"
},
"producer": {
"description": "URI identifying the producer of this metadata. For example this could be a git url with a given tag or sha",
"example": "https://github.com/OpenLineage/OpenLineage/blob/v1-0-0/client",
"format": "uri",
"type": "string"
},
"run": {
"$ref": "#/$defs/Run"
},
"schemaURL": {
"description": "The JSON Pointer (https://tools.ietf.org/html/rfc6901) URL to the corresponding version of the schema definition for this RunEvent",
"example": "https://openlineage.io/spec/0-0-1/OpenLineage.json",
"format": "uri",
"type": "string"
}
},
"required": [
"run",
"job",
"eventTime",
"producer",
"schemaURL"
],
"type": "object"
},
"RunFacet": {
"allOf": [
{
"$ref": "#/$defs/BaseFacet"
}
],
"description": "A Run Facet",
"type": "object"
}
},
"$id": "https://openlineage.io/spec/1-0-2/OpenLineage.json",
"$ref": "#/$defs/RunEvent",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
truemail-rb/truemail-rack | 18b708b47b21b5ea99c78a9a6ebcb3754f62f8d8 | 2020-02-19T10:23:07 | spec/support/schemas/controllers/validator/show.json | 28 | 2024-05-29T17:41:17.649875Z | {
"$id": "http://example.com/root.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {},
"properties": {
"configuration": {
"$id": "#/properties/configuration",
"properties": {
"blacklisted_domains": {
"$id": "#/properties/configuration/properties/blacklisted_domains",
"default": null,
"examples": [
null
],
"title": "The Blacklisted_domains Schema",
"type": [
"array",
"null"
]
},
"email_pattern": {
"$id": "#/properties/configuration/properties/email_pattern",
"default": "",
"examples": [
"default gem value"
],
"pattern": "^(.*)$",
"title": "The Email_pattern Schema",
"type": "string"
},
"smtp_error_body_pattern": {
"$id": "#/properties/configuration/properties/smtp_error_body_pattern",
"default": "",
"examples": [
"default gem value"
],
"pattern": "^(.*)$",
"title": "The Smtp_error_body_pattern Schema",
"type": "string"
},
"smtp_safe_check": {
"$id": "#/properties/configuration/properties/smtp_safe_check",
"default": false,
"examples": [
false
],
"title": "The Smtp_safe_check Schema",
"type": "boolean"
},
"validation_type_by_domain": {
"$id": "#/properties/configuration/properties/validation_type_by_domain",
"default": null,
"examples": [
null
],
"title": "The Validation_type_by_domain Schema",
"type": [
"object",
"null"
]
},
"whitelist_validation": {
"$id": "#/properties/configuration/properties/whitelist_validation",
"default": false,
"examples": [
false
],
"title": "The Whitelist_validation Schema",
"type": "boolean"
},
"whitelisted_domains": {
"$id": "#/properties/configuration/properties/whitelisted_domains",
"default": null,
"examples": [
null
],
"title": "The Whitelisted_domains Schema",
"type": [
"array",
"null"
]
}
},
"required": [
"validation_type_by_domain",
"whitelist_validation",
"whitelisted_domains",
"blacklisted_domains",
"smtp_safe_check",
"email_pattern",
"smtp_error_body_pattern"
],
"title": "The Configuration Schema",
"type": "object"
},
"date": {
"$id": "#/properties/date",
"default": "",
"examples": [
"2019-10-27 19:03:33 +0200"
],
"pattern": "^(.*)$",
"title": "The Date Schema",
"type": "string"
},
"email": {
"$id": "#/properties/email",
"default": "",
"examples": [
"[email protected]"
],
"pattern": "^(.*)$",
"title": "The Email Schema",
"type": "string"
},
"errors": {
"$id": "#/properties/errors",
"default": null,
"properties": {
"smtp": {
"$id": "#/properties/errors/properties/smtp",
"default": "",
"examples": [
"smtp error"
],
"pattern": "^(.*)$",
"title": "The Smtp Schema",
"type": "string"
}
},
"title": "The Errors Schema",
"type": [
"object",
"null"
]
},
"smtp_debug": {
"$id": "#/properties/smtp_debug",
"default": null,
"items": {
"$id": "#/properties/smtp_debug/items",
"properties": {
"connection": {
"$id": "#/properties/smtp_debug/items/properties/connection",
"default": false,
"examples": [
true
],
"title": "The Connection Schema",
"type": "boolean"
},
"errors": {
"$id": "#/properties/smtp_debug/items/properties/errors",
"properties": {
"rcptto": {
"$id": "#/properties/smtp_debug/items/properties/errors/properties/rcptto",
"default": "",
"examples": [
"user not found"
],
"pattern": "^(.*)$",
"title": "The Rcptto Schema",
"type": "string"
}
},
"title": "The Errors Schema",
"type": "object"
},
"mail_host": {
"$id": "#/properties/smtp_debug/items/properties/mail_host",
"default": "",
"examples": [
"198.60.125.186"
],
"pattern": "^(.*)$",
"title": "The Mail_host Schema",
"type": "string"
},
"port_opened": {
"$id": "#/properties/smtp_debug/items/properties/port_opened",
"default": false,
"examples": [
true
],
"title": "The Port_opened Schema",
"type": "boolean"
}
},
"required": [
"mail_host",
"port_opened",
"connection",
"errors"
],
"title": "The Items Schema",
"type": "object"
},
"title": "The Smtp_debug Schema",
"type": [
"array",
"null"
]
},
"success": {
"$id": "#/properties/success",
"default": false,
"examples": [
false
],
"title": "The Success Schema",
"type": [
"boolean",
"null"
]
},
"validation_type": {
"$id": "#/properties/validation_type",
"default": "",
"examples": [
"smtp"
],
"pattern": "^(.*)$",
"title": "The Validation_type Schema",
"type": "string"
}
},
"required": [
"date",
"email",
"validation_type",
"success",
"errors",
"smtp_debug",
"configuration"
],
"title": "The Root Schema",
"type": "object"
} | MIT | en |
truemail-rb/truemail-rack | a12f8b18cd4407ff501d74b791b9f813ec90392e | 2022-11-03T10:36:51 | spec/support/schemas/controllers/validator/show.json | 28 | 2024-05-29T17:41:17.649875Z | {
"$id": "http://example.com/example.json",
"$schema": "https://json-schema.org/draft-07/schema",
"additionalProperties": false,
"default": {},
"examples": [
{
"configuration": {
"blacklisted_domains": [
"false.com"
],
"blacklisted_emails": [
"[email protected]"
],
"blacklisted_mx_ip_addresses": [
"1.2.3.4"
],
"dns": [
"1.1.1.1:5353"
],
"email_pattern": "default gem value",
"not_rfc_mx_lookup_flow": false,
"smtp_error_body_pattern": "default gem value",
"smtp_fail_fast": false,
"smtp_safe_check": false,
"validation_type_by_domain": null,
"whitelist_validation": false,
"whitelisted_domains": [
"true.com"
],
"whitelisted_emails": [
"[email protected]"
]
},
"date": "2022-11-03 10:33:00 +0100",
"email": "[email protected]",
"errors": null,
"smtp_debug": null,
"success": true,
"validation_type": "whitelist"
}
],
"properties": {
"configuration": {
"additionalProperties": false,
"default": {},
"examples": [
{
"blacklisted_domains": [
"false.com"
],
"blacklisted_emails": [
"[email protected]"
],
"blacklisted_mx_ip_addresses": [
"1.2.3.4"
],
"dns": [
"1.1.1.1:5353"
],
"email_pattern": "default gem value",
"not_rfc_mx_lookup_flow": false,
"smtp_error_body_pattern": "default gem value",
"smtp_fail_fast": false,
"smtp_safe_check": false,
"validation_type_by_domain": null,
"whitelist_validation": false,
"whitelisted_domains": [
"true.com"
],
"whitelisted_emails": [
"[email protected]"
]
}
],
"properties": {
"blacklisted_domains": {
"default": null,
"examples": [
null,
[
"false.com"
]
],
"items": {
"default": "",
"examples": [
"false.com"
],
"title": "A Schema",
"type": "string"
},
"title": "The blacklisted_domains Schema",
"type": [
"array",
"null"
]
},
"blacklisted_emails": {
"default": null,
"examples": [
null,
[
"[email protected]"
]
],
"items": {
"default": "",
"examples": [
"[email protected]"
],
"title": "A Schema",
"type": "string"
},
"title": "The blacklisted_emails Schema",
"type": [
"array",
"null"
]
},
"blacklisted_mx_ip_addresses": {
"default": null,
"examples": [
null,
[
"1.2.3.4",
"4.3.2.1"
]
],
"items": {
"default": "",
"examples": [
"1.2.3.4",
"4.3.2.1"
],
"title": "A Schema",
"type": "string"
},
"title": "The blacklisted_mx_ip_addresses Schema",
"type": [
"array",
"null"
]
},
"dns": {
"default": null,
"examples": [
null,
[
"1.1.1.1",
"2.2.2.2:5353"
]
],
"title": "The dns Schema",
"type": [
"array",
"null"
]
},
"email_pattern": {
"default": "",
"examples": [
"default gem value"
],
"title": "The email_pattern Schema",
"type": "string"
},
"not_rfc_mx_lookup_flow": {
"default": false,
"examples": [
false
],
"title": "The not_rfc_mx_lookup_flow Schema",
"type": "boolean"
},
"smtp_error_body_pattern": {
"default": "",
"examples": [
"default gem value"
],
"title": "The smtp_error_body_pattern Schema",
"type": "string"
},
"smtp_fail_fast": {
"default": false,
"examples": [
false
],
"title": "The smtp_fail_fast Schema",
"type": "boolean"
},
"smtp_safe_check": {
"default": false,
"examples": [
false
],
"title": "The smtp_safe_check Schema",
"type": "boolean"
},
"validation_type_by_domain": {
"default": null,
"examples": [
null
],
"title": "The validation_type_by_domain Schema",
"type": "null"
},
"whitelist_validation": {
"default": false,
"examples": [
false
],
"title": "The whitelist_validation Schema",
"type": "boolean"
},
"whitelisted_domains": {
"default": null,
"examples": [
null,
[
"true.com"
]
],
"items": {
"default": "",
"examples": [
"true.com"
],
"title": "A Schema",
"type": "string"
},
"title": "The whitelisted_domains Schema",
"type": [
"array",
"null"
]
},
"whitelisted_emails": {
"default": null,
"examples": [
null,
[
"[email protected]"
]
],
"items": {
"default": "",
"examples": [
"[email protected]"
],
"title": "A Schema",
"type": "string"
},
"title": "The whitelisted_emails Schema",
"type": [
"array",
"null"
]
}
},
"required": [
"validation_type_by_domain",
"whitelist_validation",
"whitelisted_emails",
"blacklisted_emails",
"whitelisted_domains",
"blacklisted_domains",
"blacklisted_mx_ip_addresses",
"dns",
"not_rfc_mx_lookup_flow",
"smtp_fail_fast",
"smtp_safe_check",
"email_pattern",
"smtp_error_body_pattern"
],
"title": "The configuration Schema",
"type": "object"
},
"date": {
"default": "",
"examples": [
"2022-11-03 10:33:00 +0100"
],
"title": "The date Schema",
"type": "string"
},
"email": {
"default": "",
"examples": [
"[email protected]"
],
"title": "The email Schema",
"type": "string"
},
"errors": {
"default": null,
"examples": [
null
],
"title": "The errors Schema",
"type": "null"
},
"smtp_debug": {
"default": null,
"examples": [
null
],
"title": "The smtp_debug Schema",
"type": "null"
},
"success": {
"default": false,
"examples": [
true
],
"title": "The success Schema",
"type": "boolean"
},
"validation_type": {
"default": "",
"examples": [
"whitelist"
],
"title": "The validation_type Schema",
"type": "string"
}
},
"required": [
"date",
"email",
"validation_type",
"success",
"errors",
"smtp_debug",
"configuration"
],
"title": "Root Schema",
"type": "object"
} | MIT | en |
massdriver-cloud/mass | 2402ad241cb00b93910a081470018894feed28a9 | 2023-08-31T21:23:04 | pkg/bundle/schemas/bundle-schema.json | 103 | 2024-05-27T06:31:49.107676Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"properties": {
"access": {
"description": "The access level of the bundle. Private bundles will only be accessible by the organization it is published under.",
"enum": [
"public",
"private"
],
"title": "Access",
"type": "string"
},
"app": {
"properties": {
"envs": {
"description": "Map param and connection values to environment variables with JQ for processing.",
"patternProperties": {
"^[a-zA-Z_][a-zA-Z0-9_]*$": {
"type": "string"
}
},
"propertyNames": {
"pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$"
},
"title": "Environment variables",
"type": "object"
},
"policies": {
"description": "Map param and connection values to IAM Permissions & Policies for your application.",
"items": {
"pattern": "^\\.[a-zA-Z0-9._-]*$",
"type": "string"
},
"title": "IAM Permissions",
"type": "array"
},
"secrets": {
"description": "",
"patternProperties": {
"^.*$": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"json": {
"default": false,
"type": "boolean"
},
"required": {
"default": false,
"type": "boolean"
},
"title": {
"type": "string"
}
},
"type": "object"
}
},
"propertyNames": {
"pattern": "^[A-Za-z_][A-Za-z0-9_]*$"
},
"title": "Secrets",
"type": "object"
}
},
"title": "Application Configuration",
"type": "object"
},
"artifacts": {
"description": "Cloud resources created by this bundle that are available to be used as input connections to other bundles. See: https://github.com/massdriver-cloud/artifact-definitions",
"title": "Output Artifacts"
},
"cloud": {
"description": "List of clouds this bundle supports",
"items": {
"enum": [
"AWS",
"GCP",
"Azure",
"Kubernetes"
],
"type": "string"
},
"title": "Cloud",
"type": "array"
},
"connections": {
"description": "Input connections for this bundle. Determines which artifacts from other bundles this bundle depends on. These will be converted to input variables for your IaC module.",
"title": "Input Connections"
},
"description": {
"description": "A description of the bundle.",
"maxLength": 1024,
"minLength": 10,
"title": "Description",
"type": "string"
},
"name": {
"description": "The name of the bundle. This will be prefixed with your organization name upon publishing.",
"maxLength": 53,
"minLength": 3,
"pattern": "^[a-z][a-z0-9-]+[a-z0-9]$",
"title": "Title",
"type": "string"
},
"params": {
"description": "Input parameters for the bundle. These will be converted to input variables for your IaC module.",
"title": "Input Parameters"
},
"runtime": {
"description": "For applications, the runtime this application provides",
"enum": [
"VM",
"Kubernetes",
"Function"
],
"title": "Runtime",
"type": "string"
},
"schema": {
"description": "The JSON Schema used to define the bundle.",
"enum": [
"draft-07"
],
"title": "JSON Schema Schema",
"type": "string"
},
"source_url": {
"description": "Link to the bundle source code.",
"title": "Source URL",
"type": "string"
},
"tags": {
"description": "List of short descriptors for bundle search",
"items": {
"enum": [
"compute",
"networking",
"database",
"storage",
"event driven",
"serverless"
],
"type": "string"
},
"title": "Tags",
"type": "array"
},
"type": {
"description": "The type of bundle: infrastructure (legacy term: bundle) or application.",
"enum": [
"infrastructure",
"application"
],
"title": "Type",
"type": "string"
},
"ui": {
"description": "RJSF UI Schema for advanced control over the UI. See https://react-jsonschema-form.readthedocs.io/en/docs/api-reference/uiSchema/#uischema",
"type": "object"
}
},
"required": [
"params",
"connections",
"artifacts",
"ui",
"schema",
"description",
"access",
"type"
],
"title": "Bundle",
"type": "object"
} | Apache-2.0 | en |
massdriver-cloud/mass | ea29e0bda819c7d4a4eead78e33ed41b41b11e61 | 2023-11-22T06:45:37 | pkg/definition/schemas/artifact-definition-schema.json | 103 | 2024-05-27T06:31:49.107676Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"properties": {
"$md": {
"properties": {
"access": {
"enum": [
"public",
"private"
],
"type": "string"
},
"name": {
"pattern": "^[a-z][a-z0-9-]+$",
"type": "string"
}
},
"type": "object"
},
"properties": {
"properties": {
"data": {
"type": "object"
},
"specs": {
"type": "object"
}
},
"required": [
"data",
"specs"
],
"type": "object"
},
"required": {
"const": [
"data",
"specs"
],
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"$md",
"required",
"properties"
],
"title": "Bundle",
"type": "object"
} | Apache-2.0 | en |
aiverify-foundation/aiverify-developer-tools | afd1e9e614340716c934fb7849f19824377091b1 | 2023-06-16T08:25:35 | ai-verify-plugin/src/schemas/ai-verify.widget.schema.json | 6 | 2024-05-27T05:37:16.006773Z | {
"$id": "/ai-verify.widget.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "AI Verify Widget metadata schema",
"properties": {
"cid": {
"description": "Unique identififer for the widget within the plugin",
"maxLength": 128,
"minLength": 1,
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9-._]*$",
"type": "string"
},
"dependencies": {
"description": "Widget dependencies",
"items": {
"properties": {
"cid": {
"description": "CID of the dependency component",
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"gid": {
"description": "GID of the dependency component plugin. If empty, assume component within same plugin.",
"maxLength": 128,
"type": "string"
},
"version": {
"description": "Version of the component dependency required",
"maxLength": 256,
"minLength": 1,
"type": "string"
}
},
"required": [
"cid"
],
"type": "object"
},
"maxItems": 256,
"type": "array"
},
"description": {
"description": "Widget description",
"maxLength": 256,
"type": "string"
},
"dynamicHeight": {
"default": false,
"description": "Whether this widget has dynamic height",
"type": "boolean"
},
"mockdata": {
"description": "Sample data to be fed into the widget in canvas mode",
"items": {
"properties": {
"cid": {
"description": "CID of sample data for component dependency",
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"datapath": {
"description": "Path to the file containing sample data",
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"gid": {
"description": "GID of sample data for component dependency. If empty, assume GID of same plugin",
"maxLength": 128,
"type": "string"
},
"type": {
"description": "Type of sample data",
"enum": [
"Algorithm",
"InputBlock"
],
"type": "string"
}
},
"required": [
"type",
"cid",
"datapath"
],
"type": "object"
},
"maxItems": 256,
"type": "array"
},
"name": {
"description": "Widget name",
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"properties": {
"description": "List of widget properties",
"items": {
"properties": {
"default": {
"description": "Property default value",
"maxLength": 128,
"type": "string"
},
"helper": {
"description": "Helper text for the property",
"maxLength": 128,
"type": "string"
},
"key": {
"description": "Property key",
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"required": [
"key",
"helper"
],
"type": "object"
},
"maxItems": 256,
"type": "array"
},
"tags": {
"description": "Widget tags, used for searching",
"items": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"maxItems": 128,
"type": "array"
},
"widgetSize": {
"description": "Describe the widget size in terms of canvas grid units",
"properties": {
"maxH": {
"description": "Maximum widget height",
"maximum": 36,
"minimum": 1,
"type": "integer"
},
"maxW": {
"description": "Maximum widget width",
"maximum": 12,
"minimum": 1,
"type": "integer"
},
"minH": {
"description": "Minimum widget height",
"maximum": 36,
"minimum": 1,
"type": "integer"
},
"minW": {
"description": "Minimum widget width",
"maximum": 12,
"minimum": 1,
"type": "integer"
}
},
"required": [
"minW",
"minH",
"maxW",
"maxH"
],
"type": "object"
}
},
"required": [
"cid",
"name",
"widgetSize"
],
"title": "Widget Metadata Schema",
"type": "object"
} | Apache-2.0 | en |
aiverify-foundation/aiverify-developer-tools | c834b418408de2fe2af23a248e5d6ff8792d5290 | 2023-06-05T08:50:23 | ai-verify-plugin/src/schemas/ai-verify.widget.schema.json | 6 | 2024-05-27T05:37:16.006773Z | {
"$id": "/ai-verify.widget.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "AI Verify Widget metadata schema",
"properties": {
"cid": {
"description": "Unique identififer for the widget within the plugin",
"maxLength": 128,
"minLength": 1,
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9-._]*$",
"type": "string"
},
"dependencies": {
"description": "Widget dependencies",
"items": {
"properties": {
"cid": {
"description": "CID of the dependency component",
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"gid": {
"description": "GID of the dependency component plugin. If empty, assume component within same plugin.",
"maxLength": 128,
"type": "string"
},
"version": {
"description": "Version of the component dependency required",
"maxLength": 256,
"minLength": 1,
"type": "string"
}
},
"required": [
"cid"
],
"type": "object"
},
"maxItems": 256,
"type": "array"
},
"description": {
"description": "Widget description",
"maxLength": 256,
"type": "string"
},
"mockdata": {
"description": "Sample data to be fed into the widget in canvas mode",
"items": {
"properties": {
"cid": {
"description": "CID of sample data for component dependency",
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"datapath": {
"description": "Path to the file containing sample data",
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"gid": {
"description": "GID of sample data for component dependency. If empty, assume GID of same plugin",
"maxLength": 128,
"type": "string"
},
"type": {
"description": "Type of sample data",
"enum": [
"Algorithm",
"InputBlock"
],
"type": "string"
}
},
"required": [
"type",
"cid",
"datapath"
],
"type": "object"
},
"maxItems": 256,
"type": "array"
},
"name": {
"description": "Widget name",
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"properties": {
"description": "List of widget properties",
"items": {
"properties": {
"default": {
"description": "Property default value",
"maxLength": 128,
"type": "string"
},
"helper": {
"description": "Helper text for the property",
"maxLength": 128,
"type": "string"
},
"key": {
"description": "Property key",
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"required": [
"key",
"helper"
],
"type": "object"
},
"maxItems": 256,
"type": "array"
},
"tags": {
"description": "Widget tags, used for searching",
"items": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"maxItems": 128,
"type": "array"
},
"widgetSize": {
"description": "Describe the widget size in terms of canvas grid units",
"properties": {
"maxH": {
"description": "Maximum widget height",
"maximum": 36,
"minimum": 1,
"type": "integer"
},
"maxW": {
"description": "Maximum widget width",
"maximum": 12,
"minimum": 1,
"type": "integer"
},
"minH": {
"description": "Minimum widget height",
"maximum": 36,
"minimum": 1,
"type": "integer"
},
"minW": {
"description": "Minimum widget width",
"maximum": 12,
"minimum": 1,
"type": "integer"
}
},
"required": [
"minW",
"minH",
"maxW",
"maxH"
],
"type": "object"
}
},
"required": [
"cid",
"name",
"widgetSize"
],
"title": "Widget Metadata Schema",
"type": "object"
} | Apache-2.0 | en |
aiverify-foundation/aiverify-developer-tools | ccee76a87060fdabc7c27e0d0a1c1722ebc5eba7 | 2023-09-08T06:38:25 | ai-verify-plugin/src/schemas/ai-verify.widget.schema.json | 6 | 2024-05-27T05:37:16.006773Z | {
"$id": "/ai-verify.widget.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "AI Verify Widget metadata schema",
"properties": {
"cid": {
"description": "Unique identifier for the widget within the plugin",
"maxLength": 128,
"minLength": 1,
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9-._]*$",
"type": "string"
},
"dependencies": {
"description": "Widget dependencies",
"items": {
"properties": {
"cid": {
"description": "CID of the dependency component",
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"gid": {
"description": "GID of the dependency component plugin. If empty, assume component within same plugin.",
"maxLength": 128,
"type": "string"
},
"version": {
"description": "Version of the component dependency required",
"maxLength": 256,
"minLength": 1,
"type": "string"
}
},
"required": [
"cid"
],
"type": "object"
},
"maxItems": 256,
"type": "array"
},
"description": {
"description": "Widget description",
"maxLength": 256,
"type": "string"
},
"dynamicHeight": {
"default": false,
"description": "Whether this widget has dynamic height",
"type": "boolean"
},
"mockdata": {
"description": "Sample data to be fed into the widget in canvas mode",
"items": {
"properties": {
"cid": {
"description": "CID of sample data for component dependency",
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"datapath": {
"description": "Path to the file containing sample data",
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"gid": {
"description": "GID of sample data for component dependency. If empty, assume GID of same plugin",
"maxLength": 128,
"type": "string"
},
"type": {
"description": "Type of sample data",
"enum": [
"Algorithm",
"InputBlock"
],
"type": "string"
}
},
"required": [
"type",
"cid",
"datapath"
],
"type": "object"
},
"maxItems": 256,
"type": "array"
},
"name": {
"description": "Widget name",
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"properties": {
"description": "List of widget properties",
"items": {
"properties": {
"default": {
"description": "Property default value",
"maxLength": 128,
"type": "string"
},
"helper": {
"description": "Helper text for the property",
"maxLength": 128,
"type": "string"
},
"key": {
"description": "Property key",
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"required": [
"key",
"helper"
],
"type": "object"
},
"maxItems": 256,
"type": "array"
},
"tags": {
"description": "Widget tags, used for searching",
"items": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"maxItems": 128,
"type": "array"
},
"widgetSize": {
"description": "Describe the widget size in terms of canvas grid units",
"properties": {
"maxH": {
"description": "Maximum widget height",
"maximum": 36,
"minimum": 1,
"type": "integer"
},
"maxW": {
"description": "Maximum widget width",
"maximum": 12,
"minimum": 1,
"type": "integer"
},
"minH": {
"description": "Minimum widget height",
"maximum": 36,
"minimum": 1,
"type": "integer"
},
"minW": {
"description": "Minimum widget width",
"maximum": 12,
"minimum": 1,
"type": "integer"
}
},
"required": [
"minW",
"minH",
"maxW",
"maxH"
],
"type": "object"
}
},
"required": [
"cid",
"name",
"widgetSize"
],
"title": "Widget Metadata Schema",
"type": "object"
} | Apache-2.0 | en |
aiverify-foundation/aiverify-developer-tools | 56da0e6a247b1688935593b801e86deed3317f34 | 2023-10-09T09:04:23 | ai-verify-plugin/src/schemas/ai-verify.widget.schema.json | 6 | 2024-05-27T05:37:16.006773Z | {
"$id": "/ai-verify.widget.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "AI Verify Widget metadata schema",
"properties": {
"author": {
"description": "Widget author",
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"cid": {
"description": "Unique identifier for the widget within the plugin",
"maxLength": 128,
"minLength": 1,
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9-._]*$",
"type": "string"
},
"dependencies": {
"description": "Widget dependencies",
"items": {
"properties": {
"cid": {
"description": "CID of the dependency component",
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"gid": {
"description": "GID of the dependency component plugin. If empty, assume component within same plugin.",
"maxLength": 128,
"type": "string"
},
"version": {
"description": "Version of the component dependency required",
"maxLength": 256,
"minLength": 1,
"type": "string"
}
},
"required": [
"cid"
],
"type": "object"
},
"maxItems": 256,
"type": "array"
},
"description": {
"description": "Widget description",
"maxLength": 256,
"type": "string"
},
"dynamicHeight": {
"default": false,
"description": "Whether this widget has dynamic height",
"type": "boolean"
},
"mockdata": {
"description": "Sample data to be fed into the widget in canvas mode",
"items": {
"properties": {
"cid": {
"description": "CID of sample data for component dependency",
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"datapath": {
"description": "Path to the file containing sample data",
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"gid": {
"description": "GID of sample data for component dependency. If empty, assume GID of same plugin",
"maxLength": 128,
"type": "string"
},
"type": {
"description": "Type of sample data",
"enum": [
"Algorithm",
"InputBlock"
],
"type": "string"
}
},
"required": [
"type",
"cid",
"datapath"
],
"type": "object"
},
"maxItems": 256,
"type": "array"
},
"name": {
"description": "Widget name",
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"properties": {
"description": "List of widget properties",
"items": {
"properties": {
"default": {
"description": "Property default value",
"maxLength": 128,
"type": "string"
},
"helper": {
"description": "Helper text for the property",
"maxLength": 128,
"type": "string"
},
"key": {
"description": "Property key",
"maxLength": 128,
"minLength": 1,
"type": "string"
}
},
"required": [
"key",
"helper"
],
"type": "object"
},
"maxItems": 256,
"type": "array"
},
"tags": {
"description": "Widget tags, used for searching",
"items": {
"maxLength": 128,
"minLength": 1,
"type": "string"
},
"maxItems": 128,
"type": "array"
},
"version": {
"description": "Version of the widget, default to plugin version if not specificed",
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"widgetSize": {
"description": "Describe the widget size in terms of canvas grid units",
"properties": {
"maxH": {
"description": "Maximum widget height",
"maximum": 36,
"minimum": 1,
"type": "integer"
},
"maxW": {
"description": "Maximum widget width",
"maximum": 12,
"minimum": 1,
"type": "integer"
},
"minH": {
"description": "Minimum widget height",
"maximum": 36,
"minimum": 1,
"type": "integer"
},
"minW": {
"description": "Minimum widget width",
"maximum": 12,
"minimum": 1,
"type": "integer"
}
},
"required": [
"minW",
"minH",
"maxW",
"maxH"
],
"type": "object"
}
},
"required": [
"cid",
"name",
"widgetSize"
],
"title": "Widget Metadata Schema",
"type": "object"
} | Apache-2.0 | en |
fivetran/dbt_yaml_schemas | 08d179e36f3ff64cb922cd656f7ada80eb0a8884 | 2021-06-03T14:15:04 | schemas/resources.json | 11 | 2024-05-28T03:30:42.07098Z | {
"$id": "https://gitcdn.xyz/repo/fivetran/dbt_yaml_schemas/main/schemas/dbt_project.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"definitions": {
"resource": {
"properties": {
"columns": {
"items": {
"additionalProperties": false,
"properties": {
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"meta": {
"$ref": "#/definitions/resource/properties/meta"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"quote": {
"$ref": "#/definitions/resource/properties/quote"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
},
"tests": {
"$ref": "#/definitions/resource/properties/tests"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"description": {
"description": "A user-defined description.\nThese descriptions are used in the documentation website rendered by dbt.\nDescriptions can include markdown, as well as the 'doc' jinja function.",
"type": "string"
},
"docs": {
"additionalProperties": false,
"description": "Documentation-specific configuration.",
"properties": {
"show": {
"default": true,
"description": "Whether the resource is shown in the auto-generated documentation website.\nHidden resources will still appear in the dbt DAG visualization, but will be identified as 'hidden'.",
"type": "boolean"
}
},
"type": "object"
},
"freshness": {
"additionalProperties": false,
"description": "Defines the acceptable amount of time between the most recent record, and now, for a table to be considered 'fresh'.",
"properties": {
"error_after": {
"$ref": "#/definitions/resource/properties/freshness/properties/warn_after"
},
"filter": {
"description": "Adds a where clause to the query run by 'dbt source snapshot-freshness' in order to limit data scanned.",
"type": "string"
},
"warn_after": {
"additionalProperties": false,
"properties": {
"count": {
"description": "A positive integer for the number of periods where a data source is still considered 'fresh'.",
"minimum": 1,
"type": "number"
},
"period": {
"description": "The time period used in the freshness calculation.",
"enum": [
"minute",
"hour",
"day"
]
}
},
"required": [
"count",
"period"
],
"type": "object"
}
},
"type": "object"
},
"meta": {
"description": "The metadata that is compiled into the 'manifest.json' file generated by dbt, and is viewable in the auto-generated documentation.",
"type": "object"
},
"name": {
"description": "Object name.",
"minLength": 1,
"type": "string"
},
"quote": {
"default": false,
"description": "Enables or disables quoting for column names.",
"type": "boolean"
},
"tags": {
"description": "Tags used to select resources.",
"items": {
"type": "string"
},
"type": "array"
},
"testSeverity": {
"default": "error",
"description": "If severity is 'warn', dbt will log a warning for the failing test, but the test will still be considered passing.",
"enum": [
"warn",
"error"
],
"type": "string"
},
"tests": {
"description": "The tests are used to assert properties of a column or table.\nOnce these tests are defined, you can validate their correctness by running 'dbt test'.",
"items": {
"anyOf": [
{
"const": "not_null",
"description": "Validates that there are no null values present in a column."
},
{
"const": "unique",
"description": "Validates that there are no duplicate values present in a field."
},
{
"description": "Custom test",
"type": "string"
},
{
"additionalProperties": {
"description": "Custom test",
"properties": {
"severity": {
"$ref": "#/definitions/resource/properties/testSeverity"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
}
},
"type": "object"
},
"maxProperties": 1,
"minProperties": 1,
"properties": {
"acceptedValues": {
"additionalProperties": false,
"description": "Validates that all of the values in a column are present in a supplied list of values. If any values other than those provided in the list are present, then the test will fail.",
"properties": {
"quote": {
"default": true,
"description": "If true, it will single-quote the list of accepted values in the test query. To test non-strings values explicitly set it to false.",
"type": "boolean"
},
"severity": {
"$ref": "#/definitions/resource/properties/testSeverity"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
},
"values": {
"type": "array"
}
},
"required": [
"values"
],
"type": "object"
},
"not_null": {
"additionalProperties": false,
"description": "Validates that there are no duplicate values present in a field.",
"properties": {
"severity": {
"$ref": "#/definitions/resource/properties/testSeverity"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
}
},
"type": "object"
},
"relationships": {
"additionalProperties": false,
"description": "Validates that all of the records in a child table have a corresponding record in a parent table. This property is referred to as 'referential integrity'.",
"properties": {
"field": {
"description": "Parent field name",
"minLength": 1,
"type": "string"
},
"severity": {
"$ref": "#/definitions/resource/properties/testSeverity"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
},
"to": {
"description": "Parent table name. Can be expressed by 'ref' or 'source' functions",
"minLength": 1,
"type": "string"
}
},
"required": [
"to",
"field"
],
"type": "object"
},
"unique": {
"additionalProperties": false,
"description": "Validates that there are no duplicate values present in a field.",
"properties": {
"column_name": {
"description": "Column expression for testing multiple columns",
"minLength": 1,
"type": "string"
},
"severity": {
"$ref": "#/definitions/resource/properties/testSeverity"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
}
},
"type": "object"
}
},
"type": "object"
}
]
},
"type": "array"
}
}
}
},
"description": "Contains configuration of dbt resources",
"properties": {
"analyses": {
"items": {
"additionalProperties": false,
"properties": {
"columns": {
"items": {
"additionalProperties": false,
"properties": {
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"docs": {
"$ref": "#/definitions/resource/properties/docs"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"exposures": {
"items": {
"additionalProperties": false,
"properties": {
"depends_on": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"maturity": {
"enum": [
"high",
"medium",
"low"
]
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"owner": {
"additionalProperties": false,
"properties": {
"email": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"email"
],
"type": "object"
},
"type": {
"enum": [
"dashboard",
"notebook",
"analysis",
"ml",
"application"
]
},
"url": {
"type": "string"
}
},
"required": [
"name",
"type"
],
"type": "object"
},
"type": "array"
},
"macros": {
"items": {
"additionalProperties": false,
"properties": {
"arguments": {
"items": {
"additionalProperties": false,
"properties": {
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"type": {
"description": "The data type of the argument. This is only used for documentation purposes \u2014 there are no restrictions on the values you can use here.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"docs": {
"$ref": "#/definitions/resource/properties/docs"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"models": {
"items": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/definitions/resource/properties/columns"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"docs": {
"$ref": "#/definitions/resource/properties/docs"
},
"meta": {
"$ref": "#/definitions/resource/properties/meta"
},
"name": {
"$ref": "#/definitions/resource/properties/name",
"description": "The name of the model you are declaring properties for. Must match the filename of a model."
},
"tests": {
"$ref": "#/definitions/resource/properties/tests"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"seeds": {
"items": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/definitions/resource/properties/columns"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"docs": {
"$ref": "#/definitions/resource/properties/docs"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"tests": {
"$ref": "#/definitions/resource/properties/tests"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"snapshots": {
"items": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/definitions/resource/properties/columns"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"docs": {
"$ref": "#/definitions/resource/properties/docs"
},
"meta": {
"$ref": "#/definitions/resource/properties/meta"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"tests": {
"$ref": "#/definitions/resource/properties/tests"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"sources": {
"items": {
"properties": {
"database": {
"description": "The database where the source is stored.\nThis parameter is useful if you want to use a source name that differs from the schema name.\nIf you're using BigQuery, use the project name as the database property.",
"minLength": 1,
"type": "string"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"freshness": {
"$ref": "#/definitions/resource/properties/freshness"
},
"loaded_at_field": {
"description": "A column name or expression that returns a timestamp indicating freshness.",
"minLength": 1,
"type": "string"
},
"loader": {
"description": "Describe the tool that loads this source into your warehouse. Note that this property is for documentation purposes only \u2014 dbt does not meaningfully use this.",
"type": "string"
},
"meta": {
"$ref": "#/definitions/resource/properties/meta"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"overrides": {
"description": "Override a source defined in an included package. The properties defined in the overriding source will be applied on top of the base properties of the overridden source.",
"minLength": 1,
"type": "string"
},
"quoting": {
"$ref": "./dbt_project.json#/properties/quoting"
},
"schema": {
"description": "The schema name as stored in the database.\nNote that to use this parameter, your warehouse must allow cross-database queries.\nIf you're using BigQuery, use the dataset name as the schema: property.",
"minLength": 1,
"type": "string"
},
"tables": {
"items": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/definitions/resource/properties/columns"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"freshness": {
"$ref": "#/definitions/resource/properties/freshness"
},
"identifier": {
"description": "The table name as stored in the database.\nBy default, dbt will use the table's 'name' parameter as the identifier.",
"minLength": 1,
"type": "string"
},
"loaded_at_field": {
"$ref": "#/properties/sources/items/properties/loaded_at_field"
},
"meta": {
"$ref": "#/definitions/resource/properties/meta"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"quoting": {
"$ref": "./dbt_project.json#/properties/quoting"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
},
"tests": {
"$ref": "#/definitions/resource/properties/tests"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"version": {
"default": 2,
"type": "number"
}
},
"title": "dbt resource configuration",
"type": "object"
} | MIT | en |
fivetran/dbt_yaml_schemas | 0a4ea9ce04f1375cfa04c691a2ac8700692c6b27 | 2021-06-03T16:01:11 | schemas/profiles.json | 11 | 2024-05-28T03:30:42.07098Z | {
"$id": "https://gitcdn.xyz/repo/fivetran/dbt_yaml_schemas/main/schemas/profiles.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"definitions": {
"bigQueryProfile": {
"allOf": [
{
"$ref": "#definitions/threadsField"
}
],
"oneOf": [
{
"$comment": "https://docs.getdbt.com/reference/warehouse-profiles/bigquery-profile#oauth-via-gcloud",
"allOf": [
{
"$ref": "#definitions/retriesField"
},
{
"$ref": "#definitions/locationField"
}
],
"properties": {
"impersonate_service_account": {
"type": "string"
},
"maximum_bytes_billed": {
"type": "integer"
},
"method": {
"const": "oauth"
}
},
"required": [
"retries"
]
},
{
"$comment": "https://docs.getdbt.com/reference/warehouse-profiles/bigquery-profile#oauth-token-based",
"allOf": [
{
"$ref": "#definitions/retriesField"
},
{
"$ref": "#definitions/locationField"
}
],
"oneOf": [
{
"properties": {
"client_id": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"refresh_token": {
"description": "Using the refresh token and client information, dbt will mint new access tokens as necessary.",
"type": "string"
},
"token_uri": {
"type": "string"
}
},
"required": [
"refresh_token",
"client_id",
"client_secret",
"token_uri"
]
},
{
"properties": {
"token": {
"description": "dbt will use the one-time access token, no questions asked. This approach makes sense if you have an external deployment process that can mint new access tokens and update the profile file accordingly.",
"type": "string"
}
},
"required": [
"token"
]
}
],
"properties": {
"method": {
"const": "oauth-secrets"
}
},
"required": [
"retries"
],
"type": "object"
},
{
"$comment": "https://docs.getdbt.com/reference/warehouse-profiles/bigquery-profile#service-account-file",
"allOf": [
{
"$ref": "#definitions/retriesField"
}
],
"properties": {
"keyfile": {
"description": "/path/to/bigquery/keyfile.json",
"type": "string"
},
"method": {
"const": "service-account"
}
},
"required": [
"keyfile",
"retries"
],
"type": "object"
},
{
"$comment": "https://docs.getdbt.com/reference/warehouse-profiles/bigquery-profile#service-account-json",
"properties": {
"keyfile_json": {
"properties": {
"auth_provider_x509_cert_url": {
"type": "string"
},
"auth_uri": {
"type": "string"
},
"client_email": {
"type": "string"
},
"client_id": {
"type": "string"
},
"client_x509_cert_url": {
"type": "string"
},
"private_key": {
"type": "string"
},
"private_key_id": {
"type": "string"
},
"project_id": {
"type": "string"
},
"token_uri": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"type",
"project_id",
"private_key_id",
"private_key",
"client_email",
"client_id",
"auth_uri",
"token_uri",
"auth_provider_x509_cert_url",
"client_x509_cert_url"
],
"type": "object"
},
"method": {
"const": "service-account-json"
}
},
"required": [
"keyfile_json"
],
"type": "object"
}
],
"properties": {
"dataset": {
"description": "The name of your dbt dataset",
"type": "string"
},
"priority": {
"description": "The priority for the BigQuery jobs that dbt executes can be configured with the priority configuration in your BigQuery profile. This field can be set to one of batch or interactive. For more information on query priority, consult the BigQuery documentation.",
"enum": [
"batch",
"interactive"
],
"type": "string"
},
"project": {
"description": "GCP project id",
"type": "string"
},
"timeout_seconds": {
"default": 300,
"description": "BigQuery supports query timeouts. By default, the timeout is set to 300 seconds. If a dbt model takes longer than this timeout to complete, then BigQuery may cancel the query.",
"type": "integer"
},
"type": {
"const": "bigquery",
"description": "BigQuery Profile.\nhttps://docs.getdbt.com/reference/warehouse-profiles/bigquery-profile"
}
},
"required": [
"type",
"method",
"project",
"dataset",
"timeout_seconds",
"priority"
],
"type": "object"
},
"common": {
"allOf": [
{
"$ref": "#definitions/threadsField"
}
],
"properties": {
"dbname": {
"type": "string"
},
"host": {
"type": "string"
},
"port": {
"type": "integer"
},
"schema": {
"description": "The default schema that dbt will build objects in.",
"type": "string"
},
"user": {
"type": "string"
}
},
"required": [
"type",
"host",
"user",
"port",
"dbname",
"schema"
],
"type": "object"
},
"database": {
"description": "The database that dbt should create models in.",
"type": "string"
},
"keepalivesIdleField": {
"properties": {
"keepalives_idle": {
"default": 0,
"type": "integer"
}
},
"required": [
"keepalives_idle"
],
"type": "object"
},
"locationField": {
"properties": {
"location": {
"anyOf": [
{
"const": "US"
},
{
"const": "EU"
},
{
"type": "string"
}
],
"description": "The location of BigQuery datasets can be configured using the location configuration in a BigQuery profile. location may be iether a multi-regional location (e.g. EU, US), or a regional location (e.g. us-west2) as per the the BigQuery documentation describes."
}
},
"type": "object"
},
"passwordField": {
"properties": {
"password": {
"type": "string"
}
},
"required": [
"password"
],
"type": "object"
},
"postgresProfile": {
"allOf": [
{
"$ref": "#definitions/common"
},
{
"$ref": "#definitions/passwordField"
},
{
"$ref": "#definitions/keepalivesIdleField"
}
],
"properties": {
"role": {
"description": "Controls the Postgres role that dbt assumes when opening new connections to the database.",
"type": "string"
},
"search_path": {
"description": "Controls the Postgres \"search path\" that dbt configures when opening new connections to the database. By default, the Postgres search path is \"$user, public\", meaning that unqualified table names will be searched for in the public schema, or a schema with the same name as the logged-in user. Note: Setting the search_path to a custom value is not necessary or recommended for typical usage of dbt.",
"type": "string"
},
"sslmode": {
"description": "Controls how dbt connectes to Postgres databases using SSL. See the Postgres docs on sslmode for usage information. When unset, dbt will connect to databases using the Postgres default, prefer, as the sslmode.",
"type": "string"
},
"type": {
"const": "postgres",
"description": "Postgres Profile.\nhttps://docs.getdbt.com/reference/warehouse-profiles/postgres-profile"
}
},
"type": "object"
},
"prestoProfile": {
"allOf": [
{
"$ref": "#definitions/passwordField"
},
{
"$ref": "#definitions/threadsField"
}
],
"properties": {
"database": {
"$ref": "#definitions/database"
},
"host": {
"type": "string"
},
"method": {
"enum": [
"none",
"ldap",
"kerberos"
]
},
"port": {
"type": "integer"
},
"schema": {
"description": "The schema to build models into.",
"type": "string"
},
"type": {
"const": "presto",
"description": "Presto Profile.\nhttps://docs.getdbt.com/reference/warehouse-profiles/presto-profile"
},
"user": {
"type": "string"
}
},
"required": [
"type",
"user",
"password",
"database",
"host",
"port",
"schema"
],
"type": "object"
},
"redshiftProfile": {
"allOf": [
{
"$ref": "#definitions/common"
},
{
"$ref": "#definitions/keepalivesIdleField"
}
],
"else": {
"allOf": [
{
"$ref": "#definitions/passwordField"
}
],
"properties": {
"postal_code": {
"pattern": "[A-Z][0-9][A-Z] [0-9][A-Z][0-9]"
}
}
},
"if": {
"properties": {
"method": {
"const": "iam"
}
},
"required": [
"method"
]
},
"properties": {
"search_path": {
"default": "public",
"type": "string"
},
"sslmode": {
"description": "Sets the sslmode used to connect to the database (in case this parameter is set, will look for ca in ~/.postgresql/root.crt)",
"type": "string"
},
"type": {
"const": "redshift",
"description": "Redshift Profile.\nhttps://docs.getdbt.com/reference/warehouse-profiles/redshift-profile"
}
},
"then": {
"properties": {
"autocreate": {
"type": "boolean"
},
"cluster_id": {
"type": "string"
},
"db_groups": {
"type": "array"
},
"iam_duration_seconds": {
"type": "integer"
},
"iam_profile": {
"description": "When value is set, dbt will use the specified profile from your ~/.aws/config file instead of using the profile name default.",
"type": "string"
}
},
"required": [
"cluster_id"
]
},
"type": "object"
},
"retriesField": {
"properties": {
"retries": {
"description": "The number of times dbt should retry queries that result in unhandled server errors.",
"type": "integer"
}
},
"type": "object"
},
"snowflakeProfile": {
"allOf": [
{
"$ref": "#definitions/threadsField"
}
],
"oneOf": [
{
"$ref": "#definitions/passwordField"
},
{
"properties": {
"private_key_passphrase": {
"description": "passphrase for the private key, if key is encrypted",
"type": "string"
},
"private_key_path": {
"description": "path/to/private.key",
"type": "string"
}
},
"required": [
"private_key_path",
"private_key_passphrase"
]
},
{
"properties": {
"authenticator": {
"description": "Can be one of 'externalbrowser' or a valid Okta URL.",
"type": "string"
}
},
"required": [
"authenticator"
]
}
],
"properties": {
"account": {
"description": "The account to connect to as per Snowflake's documentation.",
"type": "string"
},
"client_session_keep_alive": {
"default": false,
"description": "If provided, issue a periodic select statement to keep the connection open when particularly long-running queries are executing (> 4 hours). Default: False (see note below).",
"type": "boolean"
},
"database": {
"$ref": "#definitions/database"
},
"query_tag": {
"description": "A value with which to tag all queries, for later searching in QUERY_HISTORY view.",
"type": "string"
},
"role": {
"description": "The role to assume when running queries as the specified user.",
"type": "string"
},
"schema": {
"description": "The schema to build models into by default. Can be overridden with custom schemas.",
"type": "string"
},
"type": {
"const": "snowflake",
"description": "Snowflake Profile.\nhttps://docs.getdbt.com/reference/warehouse-profiles/snowflake-profile"
},
"user": {
"description": "The user to log in as.",
"type": "string"
},
"warehouse": {
"description": "The warehouse to use when building models.",
"type": "string"
}
},
"required": [
"type",
"account",
"user",
"database",
"warehouse",
"schema",
"query_tag"
],
"type": "object"
},
"sparkProfile": {
"oneOf": [
{
"oneOf": [
{
"properties": {
"endpoint": {
"type": "string"
}
},
"required": [
"endpoint"
]
},
{
"properties": {
"cluster": {
"type": "string"
}
},
"required": [
"cluster"
]
}
],
"properties": {
"driver": {
"description": "path/to/driver",
"type": "string"
},
"method": {
"const": "odbc",
"description": "Use the odbc connection method if you are connecting to a Databricks SQL endpoint or interactive cluster via ODBC driver."
},
"organization": {
"description": "Organization id. Used for Azure Databricks only.",
"type": "string"
},
"token": {
"type": "string"
}
},
"required": [
"method",
"driver",
"organization",
"token"
]
},
{
"properties": {
"auth": {
"type": "string"
},
"kerberos_service_name": {
"type": "string"
},
"method": {
"const": "thrift",
"description": "Use the thrift connection method if you are connecting to a Thrift server sitting in front of a Spark cluster, e.g. a cluster running locally or on Amazon EMR."
}
},
"required": [
"method",
"auth",
"kerberos_service_name"
]
},
{
"properties": {
"cluster": {
"type": "string"
},
"connect_retries": {
"description": "Databricks interactive clusters can take several minutes to start up. You may include the optional profile configs connect_timeout and connect_retries, and dbt will periodically retry the connection.",
"type": "integer"
},
"connect_timeout": {
"description": "Databricks interactive clusters can take several minutes to start up. You may include the optional profile configs connect_timeout and connect_retries, and dbt will periodically retry the connection.",
"type": "integer"
},
"method": {
"const": "http",
"description": "Use the http method if your Spark provider supports generic connections over HTTP (e.g. Databricks interactive cluster)."
},
"organization": {
"description": "Organization id. Used for Azure Databricks only.",
"type": "string"
},
"token": {
"type": "string"
}
},
"required": [
"method",
"organization",
"token",
"cluster"
]
}
],
"properties": {
"host": {
"type": "string"
},
"port": {
"type": "integer"
},
"schema": {
"description": "The schema to build models into.",
"type": "string"
},
"type": {
"const": "spark",
"description": "Apache Spark Profile.\nhttps://docs.getdbt.com/reference/warehouse-profiles/spark-profile"
},
"user": {
"type": "string"
}
},
"required": [
"type",
"schema",
"host",
"port",
"user"
],
"type": "object"
},
"threadsField": {
"properties": {
"threads": {
"default": 1,
"description": "The number of threads the dbt project will run on.",
"type": "integer"
}
},
"type": "object"
}
},
"description": "Contains configuration for connecting dbt to your destination. See https://docs.getdbt.com/reference/profiles.yml.",
"patternProperties": {
".*": {
"additionalProperties": false,
"description": "The name of the profile. Contains all the details required to connect to your data warehouse. sure that this is the same name as the profile indicated in your dbt_project.yml file.",
"properties": {
"outputs": {
"patternProperties": {
".*": {
"oneOf": [
{
"$ref": "#definitions/postgresProfile"
},
{
"$ref": "#definitions/redshiftProfile"
},
{
"$ref": "#definitions/bigQueryProfile"
},
{
"$ref": "#definitions/snowflakeProfile"
},
{
"$ref": "#definitions/sparkProfile"
},
{
"$ref": "#definitions/prestoProfile"
}
]
}
},
"type": "object"
},
"target": {
"description": "This is the default target your dbt project will use. It must be one of the targets you define in your profile. Commonly it is set to dev.",
"type": "string"
}
},
"required": [
"target",
"outputs"
]
},
"config": {
"additionalProperties": false,
"description": "Contains not database specific options.",
"properties": {
"partial_parse": {
"description": "Partial parsing can improve the performance characteristics of dbt runs by limiting the number of files that are parsed by dbt.\nSee https://docs.getdbt.com/reference/profiles.yml#partial_parse.\nDefault: false.",
"type": "boolean"
},
"printer_width": {
"description": "By default, dbt will print out lines padded to 80 characters wide. You can change it using this option.",
"type": "integer"
},
"send_anonymous_usage_stats": {
"description": "Whether to send anonymous usage statistics or not.\nDefault: true.",
"type": "boolean"
},
"use_colors": {
"description": "By default, dbt will colorize the output it prints in your terminal. You can turn this on and off using this option.\nDefault: true.",
"type": "boolean"
}
},
"type": "object"
}
},
"title": "profiles.yml",
"type": "object"
} | MIT | en |
fivetran/dbt_yaml_schemas | 4b36c855a6173b247f01cfbe95c9787cafc39e76 | 2022-11-07T01:19:49 | schemas/resources.json | 11 | 2024-05-28T03:30:42.07098Z | {
"$id": "https://github.com/fivetran/dbt_yaml_schemas/blob/main/schemas/resources.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"definitions": {
"resource": {
"properties": {
"columns": {
"items": {
"additionalProperties": false,
"properties": {
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"meta": {
"$ref": "#/definitions/resource/properties/meta"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"quote": {
"$ref": "#/definitions/resource/properties/quote"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
},
"tests": {
"$ref": "#/definitions/resource/properties/tests"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"description": {
"description": "A user-defined description.\nThese descriptions are used in the documentation website rendered by dbt.\nDescriptions can include markdown, as well as the 'doc' jinja function.",
"type": "string"
},
"docs": {
"additionalProperties": false,
"description": "Documentation-specific configuration.",
"properties": {
"show": {
"default": true,
"description": "Whether the resource is shown in the auto-generated documentation website.\nHidden resources will still appear in the dbt DAG visualization, but will be identified as 'hidden'.",
"type": "boolean"
}
},
"type": "object"
},
"freshness": {
"additionalProperties": false,
"description": "Defines the acceptable amount of time between the most recent record, and now, for a table to be considered 'fresh'.",
"properties": {
"error_after": {
"$ref": "#/definitions/resource/properties/freshness/properties/warn_after"
},
"filter": {
"description": "Adds a where clause to the query run by 'dbt source snapshot-freshness' in order to limit data scanned.",
"type": "string"
},
"warn_after": {
"additionalProperties": false,
"properties": {
"count": {
"description": "A positive integer for the number of periods where a data source is still considered 'fresh'.",
"minimum": 1,
"type": "number"
},
"period": {
"description": "The time period used in the freshness calculation.",
"enum": [
"minute",
"hour",
"day"
]
}
},
"required": [
"count",
"period"
],
"type": "object"
}
},
"type": "object"
},
"meta": {
"description": "The metadata that is compiled into the 'manifest.json' file generated by dbt, and is viewable in the auto-generated documentation.",
"type": "object"
},
"name": {
"description": "Object name.",
"minLength": 1,
"type": "string"
},
"quote": {
"default": false,
"description": "Enables or disables quoting for column names.",
"type": "boolean"
},
"quoting": {
"additionalProperties": false,
"description": "Whether dbt should quote databases, schemas, and identifiers when creating relations (tables/views) or when resolving a ref function to a direct relation reference.\nThe default values vary by database.\nNote that for BigQuery quoting configuration, 'database' and 'schema' should be used here, though these configs will apply to project and dataset names respectively.",
"properties": {
"database": {
"type": "boolean"
},
"identifier": {
"type": "boolean"
},
"schema": {
"type": "boolean"
}
},
"type": "object"
},
"tags": {
"description": "Tags used to select resources.",
"items": {
"type": "string"
},
"type": "array"
},
"testSeverity": {
"default": "error",
"description": "If severity is 'warn', dbt will log a warning for the failing test, but the test will still be considered passing.",
"enum": [
"warn",
"error"
],
"type": "string"
},
"tests": {
"description": "The tests are used to assert properties of a column or table.\nOnce these tests are defined, you can validate their correctness by running 'dbt test'.",
"items": {
"anyOf": [
{
"const": "not_null",
"description": "Validates that there are no null values present in a column."
},
{
"const": "unique",
"description": "Validates that there are no duplicate values present in a field."
},
{
"description": "Custom test",
"type": "string"
},
{
"additionalProperties": {
"description": "Custom test",
"properties": {
"severity": {
"$ref": "#/definitions/resource/properties/testSeverity"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
}
},
"type": "object"
},
"maxProperties": 1,
"minProperties": 1,
"properties": {
"accepted_values": {
"additionalProperties": false,
"description": "Validates that all of the values in a column are present in a supplied list of values. If any values other than those provided in the list are present, then the test will fail.",
"properties": {
"quote": {
"default": true,
"description": "If true, it will single-quote the list of accepted values in the test query. To test non-strings values explicitly set it to false.",
"type": "boolean"
},
"severity": {
"$ref": "#/definitions/resource/properties/testSeverity"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
},
"values": {
"type": "array"
}
},
"required": [
"values"
],
"type": "object"
},
"not_null": {
"additionalProperties": false,
"description": "Validates that there are no duplicate values present in a field.",
"properties": {
"severity": {
"$ref": "#/definitions/resource/properties/testSeverity"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
}
},
"type": "object"
},
"relationships": {
"additionalProperties": false,
"description": "Validates that all of the records in a child table have a corresponding record in a parent table. This property is referred to as 'referential integrity'.",
"properties": {
"field": {
"description": "Parent field name",
"minLength": 1,
"type": "string"
},
"severity": {
"$ref": "#/definitions/resource/properties/testSeverity"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
},
"to": {
"description": "Parent table name. Can be expressed by 'ref' or 'source' functions",
"minLength": 1,
"type": "string"
}
},
"required": [
"to",
"field"
],
"type": "object"
},
"unique": {
"additionalProperties": false,
"description": "Validates that there are no duplicate values present in a field.",
"properties": {
"column_name": {
"description": "Column expression for testing multiple columns",
"minLength": 1,
"type": "string"
},
"severity": {
"$ref": "#/definitions/resource/properties/testSeverity"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
}
},
"type": "object"
}
},
"type": "object"
}
]
},
"type": "array"
}
}
}
},
"description": "Contains configuration of dbt resources",
"properties": {
"analyses": {
"items": {
"additionalProperties": false,
"properties": {
"columns": {
"items": {
"additionalProperties": false,
"properties": {
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"docs": {
"$ref": "#/definitions/resource/properties/docs"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"exposures": {
"items": {
"additionalProperties": false,
"properties": {
"depends_on": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"maturity": {
"enum": [
"high",
"medium",
"low"
]
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"owner": {
"additionalProperties": false,
"properties": {
"email": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"email"
],
"type": "object"
},
"type": {
"enum": [
"dashboard",
"notebook",
"analysis",
"ml",
"application"
]
},
"url": {
"type": "string"
}
},
"required": [
"name",
"type"
],
"type": "object"
},
"type": "array"
},
"macros": {
"items": {
"additionalProperties": false,
"properties": {
"arguments": {
"items": {
"additionalProperties": false,
"properties": {
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"type": {
"description": "The data type of the argument. This is only used for documentation purposes \u2014 there are no restrictions on the values you can use here.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"docs": {
"$ref": "#/definitions/resource/properties/docs"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"models": {
"items": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/definitions/resource/properties/columns"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"docs": {
"$ref": "#/definitions/resource/properties/docs"
},
"meta": {
"$ref": "#/definitions/resource/properties/meta"
},
"name": {
"$ref": "#/definitions/resource/properties/name",
"description": "The name of the model you are declaring properties for. Must match the filename of a model."
},
"tests": {
"$ref": "#/definitions/resource/properties/tests"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"seeds": {
"items": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/definitions/resource/properties/columns"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"docs": {
"$ref": "#/definitions/resource/properties/docs"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"tests": {
"$ref": "#/definitions/resource/properties/tests"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"snapshots": {
"items": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/definitions/resource/properties/columns"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"docs": {
"$ref": "#/definitions/resource/properties/docs"
},
"meta": {
"$ref": "#/definitions/resource/properties/meta"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"tests": {
"$ref": "#/definitions/resource/properties/tests"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"sources": {
"items": {
"properties": {
"database": {
"description": "The database where the source is stored.\nThis parameter is useful if you want to use a source name that differs from the schema name.\nIf you're using BigQuery, use the project name as the database property.",
"minLength": 1,
"type": "string"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"freshness": {
"$ref": "#/definitions/resource/properties/freshness"
},
"loaded_at_field": {
"description": "A column name or expression that returns a timestamp indicating freshness.",
"minLength": 1,
"type": "string"
},
"loader": {
"description": "Describe the tool that loads this source into your warehouse. Note that this property is for documentation purposes only \u2014 dbt does not meaningfully use this.",
"type": "string"
},
"meta": {
"$ref": "#/definitions/resource/properties/meta"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"overrides": {
"description": "Override a source defined in an included package. The properties defined in the overriding source will be applied on top of the base properties of the overridden source.",
"minLength": 1,
"type": "string"
},
"quoting": {
"$ref": "#/definitions/resource/properties/quoting"
},
"schema": {
"description": "The schema name as stored in the database.\nNote that to use this parameter, your warehouse must allow cross-database queries.\nIf you're using BigQuery, use the dataset name as the schema: property.",
"minLength": 1,
"type": "string"
},
"tables": {
"items": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/definitions/resource/properties/columns"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"freshness": {
"$ref": "#/definitions/resource/properties/freshness"
},
"identifier": {
"description": "The table name as stored in the database.\nBy default, dbt will use the table's 'name' parameter as the identifier.",
"minLength": 1,
"type": "string"
},
"loaded_at_field": {
"$ref": "#/properties/sources/items/properties/loaded_at_field"
},
"meta": {
"$ref": "#/definitions/resource/properties/meta"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"quoting": {
"$ref": "#/definitions/resource/properties/quoting"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
},
"tests": {
"$ref": "#/definitions/resource/properties/tests"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"version": {
"default": 2,
"type": "number"
}
},
"title": "dbt resource configuration",
"type": "object"
} | MIT | en |
fivetran/dbt_yaml_schemas | e6ec100976f5f25e4f4056d9ffcf01797fcb9a08 | 2021-06-03T17:59:52 | schemas/profiles.json | 11 | 2024-05-28T03:30:42.07098Z | {
"$id": "https://github.com/fivetran/dbt_yaml_schemas/blob/main/schemas/profiles.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"definitions": {
"bigQueryProfile": {
"allOf": [
{
"$ref": "#definitions/threadsField"
}
],
"oneOf": [
{
"$comment": "https://docs.getdbt.com/reference/warehouse-profiles/bigquery-profile#oauth-via-gcloud",
"allOf": [
{
"$ref": "#/definitions/retriesField"
},
{
"$ref": "#/definitions/locationField"
}
],
"properties": {
"impersonate_service_account": {
"type": "string"
},
"maximum_bytes_billed": {
"type": "integer"
},
"method": {
"const": "oauth"
}
},
"required": [
"retries"
]
},
{
"$comment": "https://docs.getdbt.com/reference/warehouse-profiles/bigquery-profile#oauth-token-based",
"allOf": [
{
"$ref": "#/definitions/retriesField"
},
{
"$ref": "#/definitions/locationField"
}
],
"oneOf": [
{
"properties": {
"client_id": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"refresh_token": {
"description": "Using the refresh token and client information, dbt will mint new access tokens as necessary.",
"type": "string"
},
"token_uri": {
"type": "string"
}
},
"required": [
"refresh_token",
"client_id",
"client_secret",
"token_uri"
]
},
{
"properties": {
"token": {
"description": "dbt will use the one-time access token, no questions asked. This approach makes sense if you have an external deployment process that can mint new access tokens and update the profile file accordingly.",
"type": "string"
}
},
"required": [
"token"
]
}
],
"properties": {
"method": {
"const": "oauth-secrets"
}
},
"required": [
"retries"
],
"type": "object"
},
{
"$comment": "https://docs.getdbt.com/reference/warehouse-profiles/bigquery-profile#service-account-file",
"allOf": [
{
"$ref": "#definitions/retriesField"
}
],
"properties": {
"keyfile": {
"description": "/path/to/bigquery/keyfile.json",
"type": "string"
},
"method": {
"const": "service-account"
}
},
"required": [
"keyfile",
"retries"
],
"type": "object"
},
{
"$comment": "https://docs.getdbt.com/reference/warehouse-profiles/bigquery-profile#service-account-json",
"properties": {
"keyfile_json": {
"properties": {
"auth_provider_x509_cert_url": {
"type": "string"
},
"auth_uri": {
"type": "string"
},
"client_email": {
"type": "string"
},
"client_id": {
"type": "string"
},
"client_x509_cert_url": {
"type": "string"
},
"private_key": {
"type": "string"
},
"private_key_id": {
"type": "string"
},
"project_id": {
"type": "string"
},
"token_uri": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"type",
"project_id",
"private_key_id",
"private_key",
"client_email",
"client_id",
"auth_uri",
"token_uri",
"auth_provider_x509_cert_url",
"client_x509_cert_url"
],
"type": "object"
},
"method": {
"const": "service-account-json"
}
},
"required": [
"keyfile_json"
],
"type": "object"
}
],
"properties": {
"dataset": {
"description": "The name of your dbt dataset",
"type": "string"
},
"priority": {
"description": "The priority for the BigQuery jobs that dbt executes can be configured with the priority configuration in your BigQuery profile. This field can be set to one of batch or interactive. For more information on query priority, consult the BigQuery documentation.",
"enum": [
"batch",
"interactive"
],
"type": "string"
},
"project": {
"description": "GCP project id",
"type": "string"
},
"timeout_seconds": {
"default": 300,
"description": "BigQuery supports query timeouts. By default, the timeout is set to 300 seconds. If a dbt model takes longer than this timeout to complete, then BigQuery may cancel the query.",
"type": "integer"
},
"type": {
"const": "bigquery",
"description": "BigQuery Profile.\nhttps://docs.getdbt.com/reference/warehouse-profiles/bigquery-profile"
}
},
"required": [
"type",
"method",
"project",
"dataset",
"timeout_seconds",
"priority"
],
"type": "object"
},
"common": {
"allOf": [
{
"$ref": "#/definitions/threadsField"
}
],
"properties": {
"dbname": {
"type": "string"
},
"host": {
"type": "string"
},
"port": {
"type": "integer"
},
"schema": {
"description": "The default schema that dbt will build objects in.",
"type": "string"
},
"user": {
"type": "string"
}
},
"required": [
"type",
"host",
"user",
"port",
"dbname",
"schema"
],
"type": "object"
},
"database": {
"description": "The database that dbt should create models in.",
"type": "string"
},
"keepalivesIdleField": {
"properties": {
"keepalives_idle": {
"default": 0,
"type": "integer"
}
},
"required": [
"keepalives_idle"
],
"type": "object"
},
"locationField": {
"properties": {
"location": {
"anyOf": [
{
"const": "US"
},
{
"const": "EU"
},
{
"type": "string"
}
],
"description": "The location of BigQuery datasets can be configured using the location configuration in a BigQuery profile. location may be iether a multi-regional location (e.g. EU, US), or a regional location (e.g. us-west2) as per the the BigQuery documentation describes."
}
},
"type": "object"
},
"passwordField": {
"properties": {
"password": {
"type": "string"
}
},
"required": [
"password"
],
"type": "object"
},
"postgresProfile": {
"allOf": [
{
"$ref": "#/definitions/common"
},
{
"$ref": "#/definitions/passwordField"
},
{
"$ref": "#/definitions/keepalivesIdleField"
}
],
"properties": {
"role": {
"description": "Controls the Postgres role that dbt assumes when opening new connections to the database.",
"type": "string"
},
"search_path": {
"description": "Controls the Postgres \"search path\" that dbt configures when opening new connections to the database. By default, the Postgres search path is \"$user, public\", meaning that unqualified table names will be searched for in the public schema, or a schema with the same name as the logged-in user. Note: Setting the search_path to a custom value is not necessary or recommended for typical usage of dbt.",
"type": "string"
},
"sslmode": {
"description": "Controls how dbt connectes to Postgres databases using SSL. See the Postgres docs on sslmode for usage information. When unset, dbt will connect to databases using the Postgres default, prefer, as the sslmode.",
"type": "string"
},
"type": {
"const": "postgres",
"description": "Postgres Profile.\nhttps://docs.getdbt.com/reference/warehouse-profiles/postgres-profile"
}
},
"type": "object"
},
"prestoProfile": {
"allOf": [
{
"$ref": "#/definitions/passwordField"
},
{
"$ref": "#/definitions/threadsField"
}
],
"properties": {
"database": {
"$ref": "#/definitions/database"
},
"host": {
"type": "string"
},
"method": {
"enum": [
"none",
"ldap",
"kerberos"
]
},
"port": {
"type": "integer"
},
"schema": {
"description": "The schema to build models into.",
"type": "string"
},
"type": {
"const": "presto",
"description": "Presto Profile.\nhttps://docs.getdbt.com/reference/warehouse-profiles/presto-profile"
},
"user": {
"type": "string"
}
},
"required": [
"type",
"user",
"password",
"database",
"host",
"port",
"schema"
],
"type": "object"
},
"redshiftProfile": {
"allOf": [
{
"$ref": "#/definitions/common"
},
{
"$ref": "#/definitions/keepalivesIdleField"
}
],
"else": {
"allOf": [
{
"$ref": "#/definitions/passwordField"
}
],
"properties": {
"postal_code": {
"pattern": "[A-Z][0-9][A-Z] [0-9][A-Z][0-9]"
}
}
},
"if": {
"properties": {
"method": {
"const": "iam"
}
},
"required": [
"method"
]
},
"properties": {
"search_path": {
"default": "public",
"type": "string"
},
"sslmode": {
"description": "Sets the sslmode used to connect to the database (in case this parameter is set, will look for ca in ~/.postgresql/root.crt)",
"type": "string"
},
"type": {
"const": "redshift",
"description": "Redshift Profile.\nhttps://docs.getdbt.com/reference/warehouse-profiles/redshift-profile"
}
},
"then": {
"properties": {
"autocreate": {
"type": "boolean"
},
"cluster_id": {
"type": "string"
},
"db_groups": {
"type": "array"
},
"iam_duration_seconds": {
"type": "integer"
},
"iam_profile": {
"description": "When value is set, dbt will use the specified profile from your ~/.aws/config file instead of using the profile name default.",
"type": "string"
}
},
"required": [
"cluster_id"
]
},
"type": "object"
},
"retriesField": {
"properties": {
"retries": {
"description": "The number of times dbt should retry queries that result in unhandled server errors.",
"type": "integer"
}
},
"type": "object"
},
"snowflakeProfile": {
"allOf": [
{
"$ref": "#/definitions/threadsField"
}
],
"oneOf": [
{
"$ref": "#/definitions/passwordField"
},
{
"properties": {
"private_key_passphrase": {
"description": "passphrase for the private key, if key is encrypted",
"type": "string"
},
"private_key_path": {
"description": "path/to/private.key",
"type": "string"
}
},
"required": [
"private_key_path",
"private_key_passphrase"
]
},
{
"properties": {
"authenticator": {
"description": "Can be one of 'externalbrowser' or a valid Okta URL.",
"type": "string"
}
},
"required": [
"authenticator"
]
}
],
"properties": {
"account": {
"description": "The account to connect to as per Snowflake's documentation.",
"type": "string"
},
"client_session_keep_alive": {
"default": false,
"description": "If provided, issue a periodic select statement to keep the connection open when particularly long-running queries are executing (> 4 hours). Default: False (see note below).",
"type": "boolean"
},
"database": {
"$ref": "#/definitions/database"
},
"query_tag": {
"description": "A value with which to tag all queries, for later searching in QUERY_HISTORY view.",
"type": "string"
},
"role": {
"description": "The role to assume when running queries as the specified user.",
"type": "string"
},
"schema": {
"description": "The schema to build models into by default. Can be overridden with custom schemas.",
"type": "string"
},
"type": {
"const": "snowflake",
"description": "Snowflake Profile.\nhttps://docs.getdbt.com/reference/warehouse-profiles/snowflake-profile"
},
"user": {
"description": "The user to log in as.",
"type": "string"
},
"warehouse": {
"description": "The warehouse to use when building models.",
"type": "string"
}
},
"required": [
"type",
"account",
"user",
"database",
"warehouse",
"schema",
"query_tag"
],
"type": "object"
},
"sparkProfile": {
"oneOf": [
{
"oneOf": [
{
"properties": {
"endpoint": {
"type": "string"
}
},
"required": [
"endpoint"
]
},
{
"properties": {
"cluster": {
"type": "string"
}
},
"required": [
"cluster"
]
}
],
"properties": {
"driver": {
"description": "path/to/driver",
"type": "string"
},
"method": {
"const": "odbc",
"description": "Use the odbc connection method if you are connecting to a Databricks SQL endpoint or interactive cluster via ODBC driver."
},
"organization": {
"description": "Organization id. Used for Azure Databricks only.",
"type": "string"
},
"token": {
"type": "string"
}
},
"required": [
"method",
"driver",
"organization",
"token"
]
},
{
"properties": {
"auth": {
"type": "string"
},
"kerberos_service_name": {
"type": "string"
},
"method": {
"const": "thrift",
"description": "Use the thrift connection method if you are connecting to a Thrift server sitting in front of a Spark cluster, e.g. a cluster running locally or on Amazon EMR."
}
},
"required": [
"method",
"auth",
"kerberos_service_name"
]
},
{
"properties": {
"cluster": {
"type": "string"
},
"connect_retries": {
"description": "Databricks interactive clusters can take several minutes to start up. You may include the optional profile configs connect_timeout and connect_retries, and dbt will periodically retry the connection.",
"type": "integer"
},
"connect_timeout": {
"description": "Databricks interactive clusters can take several minutes to start up. You may include the optional profile configs connect_timeout and connect_retries, and dbt will periodically retry the connection.",
"type": "integer"
},
"method": {
"const": "http",
"description": "Use the http method if your Spark provider supports generic connections over HTTP (e.g. Databricks interactive cluster)."
},
"organization": {
"description": "Organization id. Used for Azure Databricks only.",
"type": "string"
},
"token": {
"type": "string"
}
},
"required": [
"method",
"organization",
"token",
"cluster"
]
}
],
"properties": {
"host": {
"type": "string"
},
"port": {
"type": "integer"
},
"schema": {
"description": "The schema to build models into.",
"type": "string"
},
"type": {
"const": "spark",
"description": "Apache Spark Profile.\nhttps://docs.getdbt.com/reference/warehouse-profiles/spark-profile"
},
"user": {
"type": "string"
}
},
"required": [
"type",
"schema",
"host",
"port",
"user"
],
"type": "object"
},
"threadsField": {
"properties": {
"threads": {
"default": 1,
"description": "The number of threads the dbt project will run on.",
"type": "integer"
}
},
"type": "object"
}
},
"description": "Contains configuration for connecting dbt to your destination. See https://docs.getdbt.com/reference/profiles.yml.",
"patternProperties": {
".*": {
"additionalProperties": false,
"description": "The name of the profile. Contains all the details required to connect to your data warehouse. Make sure that this is the same name as the profile indicated in your dbt_project.yml file.",
"properties": {
"outputs": {
"patternProperties": {
".*": {
"oneOf": [
{
"$ref": "#/definitions/postgresProfile"
},
{
"$ref": "#/definitions/redshiftProfile"
},
{
"$ref": "#/definitions/bigQueryProfile"
},
{
"$ref": "#/definitions/snowflakeProfile"
},
{
"$ref": "#/definitions/sparkProfile"
},
{
"$ref": "#/definitions/prestoProfile"
}
]
}
},
"type": "object"
},
"target": {
"description": "This is the default target your dbt project will use. It must be one of the targets you define in your profile. Commonly it is set to dev.",
"type": "string"
}
},
"required": [
"target",
"outputs"
]
},
"config": {
"additionalProperties": false,
"description": "Common configuration for all profiles.",
"properties": {
"partial_parse": {
"default": false,
"description": "Partial parsing can improve the performance characteristics of dbt runs by limiting the number of files that are parsed by dbt.\nSee https://docs.getdbt.com/reference/profiles.yml#partial_parse",
"type": "boolean"
},
"printer_width": {
"default": 80,
"description": "By default, dbt will print out lines padded to 80 characters wide. You can change it using this option.",
"type": "integer"
},
"send_anonymous_usage_stats": {
"default": true,
"description": "Whether to send anonymous usage statistics or not.",
"type": "boolean"
},
"use_colors": {
"default": true,
"description": "By default, dbt will colorize the output it prints in your terminal. You can turn this on and off using this option.",
"type": "boolean"
}
},
"type": "object"
}
},
"title": "dbt profiles.yml",
"type": "object"
} | MIT | en |
fivetran/dbt_yaml_schemas | 4e1880b45440fba3c9c9aff58711439f79248536 | 2021-06-02T14:57:42 | schemas/packages.json | 11 | 2024-05-28T03:30:42.07098Z | {
"$id": "https://gitcdn.xyz/repo/fivetran/dbt_yaml_schemas/main/schemas/packages.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"definitions": {
"dbtHubPackage": {
"dependencies": {
"version": [
"package"
]
},
"properties": {
"package": {
"description": "DbtHub registry name of a package",
"type": "string"
},
"version": {
"description": "Version number or range",
"oneOf": [
{
"$ref": "#/definitions/semVer"
},
{
"description": "Version range",
"items": {
"type": "string"
},
"maxItems": 2,
"minItems": 1,
"type": "array"
}
]
}
},
"required": [
"package"
]
},
"gitPackage": {
"dependencies": {
"revision": [
"git"
],
"version": [
"git"
],
"warn-unpinned": [
"git"
]
},
"properties": {
"git": {
"description": "Git URL",
"type": "string"
},
"revision": {
"description": "Git repository tag or branch name",
"type": [
"string",
"number"
]
},
"warn-unpinned": {
"description": "Enable warning about unpinned repositories. Note: It is not recommended to disable it.",
"type": "boolean"
}
},
"required": [
"git"
]
},
"localPackage": {
"properties": {
"local": {
"description": "Path to a local package",
"type": "string"
}
},
"required": [
"local"
]
},
"semVer": {
"description": "Semantic version",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
}
},
"description": "Will be filled later",
"properties": {
"packages": {
"description": "A list of Dbt packages",
"items": {
"anyOf": [
{
"$ref": "#/definitions/dbtHubPackage"
},
{
"$ref": "#/definitions/gitPackage"
},
{
"$ref": "#/definitions/localPackage"
}
],
"type": "object"
},
"minItems": 1,
"type": "array"
}
},
"title": "YML Schema for DBT packages file",
"type": "object"
} | MIT | en |
fivetran/dbt_yaml_schemas | d05451333728841f99c800650329631367a094a2 | 2021-06-03T08:22:09 | schemas/packages.json | 11 | 2024-05-28T03:30:42.07098Z | {
"$id": "https://gitcdn.xyz/repo/fivetran/dbt_yaml_schemas/main/schemas/packages.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"definitions": {
"dbtHubPackage": {
"dependencies": {
"version": [
"package"
]
},
"properties": {
"package": {
"description": "dbt Hub package name",
"type": "string"
},
"version": {
"description": "Version number or range",
"oneOf": [
{
"$ref": "#/definitions/semVer"
},
{
"description": "Version range",
"items": {
"type": "string"
},
"maxItems": 2,
"minItems": 1,
"type": "array"
}
]
}
},
"required": [
"package"
]
},
"gitPackage": {
"dependencies": {
"revision": [
"git"
],
"version": [
"git"
],
"warn-unpinned": [
"git"
]
},
"properties": {
"git": {
"description": "Git URL",
"type": "string"
},
"revision": {
"description": "Git repository tag or branch name",
"type": [
"string",
"number"
]
},
"warn-unpinned": {
"description": "Enable warning about unpinned repositories. Note: It is not recommended to disable it.",
"type": "boolean"
}
},
"required": [
"git"
]
},
"localPackage": {
"properties": {
"local": {
"description": "Path to a local package",
"type": "string"
}
},
"required": [
"local"
]
},
"semVer": {
"description": "Semantic version",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
}
},
"description": "Information about packages used in dbt project",
"properties": {
"packages": {
"description": "A list of dbt packages",
"items": {
"$comment": "Should be oneOf?",
"anyOf": [
{
"$ref": "#/definitions/dbtHubPackage"
},
{
"$ref": "#/definitions/gitPackage"
},
{
"$ref": "#/definitions/localPackage"
}
],
"type": "object"
},
"minItems": 1,
"type": "array"
}
},
"title": "dbt packages.yml",
"type": "object"
} | MIT | en |
fivetran/dbt_yaml_schemas | 139e23fb893ec8b8ba412eccd42b17fb99e009df | 2021-06-02T08:14:12 | schemas/packages.json | 11 | 2024-05-28T03:30:42.07098Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"description": "Dockerfile linter, validate inline bash, written in Haskell",
"properties": {},
"title": "JSON Schema for Hadolint, a Dockerfile linter tool",
"trustedRegistries": {
"description": "A list of trusted registries. Ex: docker.io",
"items": {
"type": "string"
},
"type": "array"
},
"type": "object"
} | MIT | en |
fivetran/dbt_yaml_schemas | 9af2695a0db4e376cb3cbe80c6ef382e0d9c3821 | 2022-06-01T23:43:41 | schemas/resources.json | 11 | 2024-05-28T03:30:42.07098Z | {
"$id": "https://github.com/fivetran/dbt_yaml_schemas/blob/main/schemas/resources.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"definitions": {
"resource": {
"properties": {
"columns": {
"items": {
"additionalProperties": false,
"properties": {
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"meta": {
"$ref": "#/definitions/resource/properties/meta"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"quote": {
"$ref": "#/definitions/resource/properties/quote"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
},
"tests": {
"$ref": "#/definitions/resource/properties/tests"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"description": {
"description": "A user-defined description.\nThese descriptions are used in the documentation website rendered by dbt.\nDescriptions can include markdown, as well as the 'doc' jinja function.",
"type": "string"
},
"docs": {
"additionalProperties": false,
"description": "Documentation-specific configuration.",
"properties": {
"show": {
"default": true,
"description": "Whether the resource is shown in the auto-generated documentation website.\nHidden resources will still appear in the dbt DAG visualization, but will be identified as 'hidden'.",
"type": "boolean"
}
},
"type": "object"
},
"freshness": {
"additionalProperties": false,
"description": "Defines the acceptable amount of time between the most recent record, and now, for a table to be considered 'fresh'.",
"properties": {
"error_after": {
"$ref": "#/definitions/resource/properties/freshness/properties/warn_after"
},
"filter": {
"description": "Adds a where clause to the query run by 'dbt source snapshot-freshness' in order to limit data scanned.",
"type": "string"
},
"warn_after": {
"additionalProperties": false,
"properties": {
"count": {
"description": "A positive integer for the number of periods where a data source is still considered 'fresh'.",
"minimum": 1,
"type": "number"
},
"period": {
"description": "The time period used in the freshness calculation.",
"enum": [
"minute",
"hour",
"day"
]
}
},
"required": [
"count",
"period"
],
"type": "object"
}
},
"type": "object"
},
"meta": {
"description": "The metadata that is compiled into the 'manifest.json' file generated by dbt, and is viewable in the auto-generated documentation.",
"type": "object"
},
"name": {
"description": "Object name.",
"minLength": 1,
"type": "string"
},
"quote": {
"default": false,
"description": "Enables or disables quoting for column names.",
"type": "boolean"
},
"quoting": {
"additionalProperties": false,
"description": "Whether dbt should quote databases, schemas, and identifiers when creating relations (tables/views) or when resolving a ref function to a direct relation reference.\nThe default values vary by database.\nNote that for BigQuery quoting configuration, 'database' and 'schema' should be used here, though these configs will apply to project and dataset names respectively.",
"properties": {
"database": {
"type": "boolean"
},
"identifier": {
"type": "boolean"
},
"schema": {
"type": "boolean"
}
},
"type": "object"
},
"tags": {
"description": "Tags used to select resources.",
"items": {
"type": "string"
},
"type": "array"
},
"testSeverity": {
"default": "error",
"description": "If severity is 'warn', dbt will log a warning for the failing test, but the test will still be considered passing.",
"enum": [
"warn",
"error"
],
"type": "string"
},
"tests": {
"description": "The tests are used to assert properties of a column or table.\nOnce these tests are defined, you can validate their correctness by running 'dbt test'.",
"items": {
"anyOf": [
{
"const": "not_null",
"description": "Validates that there are no null values present in a column."
},
{
"const": "unique",
"description": "Validates that there are no duplicate values present in a field."
},
{
"description": "Custom test",
"type": "string"
},
{
"additionalProperties": {
"description": "Custom test",
"properties": {
"severity": {
"$ref": "#/definitions/resource/properties/testSeverity"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
}
},
"type": "object"
},
"maxProperties": 1,
"minProperties": 1,
"properties": {
"acceptedValues": {
"additionalProperties": false,
"description": "Validates that all of the values in a column are present in a supplied list of values. If any values other than those provided in the list are present, then the test will fail.",
"properties": {
"quote": {
"default": true,
"description": "If true, it will single-quote the list of accepted values in the test query. To test non-strings values explicitly set it to false.",
"type": "boolean"
},
"severity": {
"$ref": "#/definitions/resource/properties/testSeverity"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
},
"values": {
"type": "array"
}
},
"required": [
"values"
],
"type": "object"
},
"not_null": {
"additionalProperties": false,
"description": "Validates that there are no duplicate values present in a field.",
"properties": {
"severity": {
"$ref": "#/definitions/resource/properties/testSeverity"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
}
},
"type": "object"
},
"relationships": {
"additionalProperties": false,
"description": "Validates that all of the records in a child table have a corresponding record in a parent table. This property is referred to as 'referential integrity'.",
"properties": {
"field": {
"description": "Parent field name",
"minLength": 1,
"type": "string"
},
"severity": {
"$ref": "#/definitions/resource/properties/testSeverity"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
},
"to": {
"description": "Parent table name. Can be expressed by 'ref' or 'source' functions",
"minLength": 1,
"type": "string"
}
},
"required": [
"to",
"field"
],
"type": "object"
},
"unique": {
"additionalProperties": false,
"description": "Validates that there are no duplicate values present in a field.",
"properties": {
"column_name": {
"description": "Column expression for testing multiple columns",
"minLength": 1,
"type": "string"
},
"severity": {
"$ref": "#/definitions/resource/properties/testSeverity"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
}
},
"type": "object"
}
},
"type": "object"
}
]
},
"type": "array"
}
}
}
},
"description": "Contains configuration of dbt resources",
"properties": {
"analyses": {
"items": {
"additionalProperties": false,
"properties": {
"columns": {
"items": {
"additionalProperties": false,
"properties": {
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"docs": {
"$ref": "#/definitions/resource/properties/docs"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"exposures": {
"items": {
"additionalProperties": false,
"properties": {
"depends_on": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"maturity": {
"enum": [
"high",
"medium",
"low"
]
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"owner": {
"additionalProperties": false,
"properties": {
"email": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"email"
],
"type": "object"
},
"type": {
"enum": [
"dashboard",
"notebook",
"analysis",
"ml",
"application"
]
},
"url": {
"type": "string"
}
},
"required": [
"name",
"type"
],
"type": "object"
},
"type": "array"
},
"macros": {
"items": {
"additionalProperties": false,
"properties": {
"arguments": {
"items": {
"additionalProperties": false,
"properties": {
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"type": {
"description": "The data type of the argument. This is only used for documentation purposes \u2014 there are no restrictions on the values you can use here.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"docs": {
"$ref": "#/definitions/resource/properties/docs"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"metrics": {
"items": {
"additionalProperties": false,
"properties": {
"description": {
"$ref": "#/definitions/resource/properties/description",
"description": "Long form, human-readable description for the metric"
},
"dimensions": {
"items": {
"description": "A list of dimensions to group or filter the metric by",
"type": "string"
},
"type": "array"
},
"filters": {
"items": {
"additionalProperties": false,
"description": "A list of filters to apply before calculating the metric",
"properties": {
"field": {
"description": "Field (column) to be compared",
"type": "string"
},
"operator": {
"description": "comparison operation",
"enum": [
"is",
"is not",
"=",
">=",
"<=",
"!="
]
},
"value": {
"description": "Note that value must be defined as a string in YAML, because it will be compiled into queries as part of a string. If your filter's value needs to be surrounded in quotes inside the query (e.g. text or dates), use \"'nested'\" quotes",
"type": "string"
}
},
"required": [
"field",
"operator",
"value"
],
"type": "object"
},
"type": "array"
},
"label": {
"description": "A short for name / label for the metric",
"minLength": 1,
"type": "string"
},
"meta": {
"$ref": "#/definitions/resource/properties/meta"
},
"model": {
"description": "The dbt model that powers this metric",
"minLength": 1,
"type": "string"
},
"name": {
"$ref": "#/definitions/resource/properties/name",
"description": "A unique identifier for the metric"
},
"sql": {
"description": "The expression to aggregate/calculate over",
"type": "string"
},
"time_grains": {
"description": "One or more \"grains\" at which the metric can be evaluated",
"items": {
"enum": [
"day",
"week",
"month",
"quarter",
"year"
]
},
"type": "array"
},
"timestamp": {
"description": "The time-based component of the metric",
"type": "string"
},
"type": {
"description": "The type of calculation to perform when evaluating a metric",
"type": "string"
}
},
"required": [
"name",
"model",
"type",
"sql",
"timestamp",
"time_grains"
],
"type": "object"
},
"type": "array"
},
"models": {
"items": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/definitions/resource/properties/columns"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"docs": {
"$ref": "#/definitions/resource/properties/docs"
},
"meta": {
"$ref": "#/definitions/resource/properties/meta"
},
"name": {
"$ref": "#/definitions/resource/properties/name",
"description": "The name of the model you are declaring properties for. Must match the filename of a model."
},
"tests": {
"$ref": "#/definitions/resource/properties/tests"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"seeds": {
"items": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/definitions/resource/properties/columns"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"docs": {
"$ref": "#/definitions/resource/properties/docs"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"tests": {
"$ref": "#/definitions/resource/properties/tests"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"snapshots": {
"items": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/definitions/resource/properties/columns"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"docs": {
"$ref": "#/definitions/resource/properties/docs"
},
"meta": {
"$ref": "#/definitions/resource/properties/meta"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"tests": {
"$ref": "#/definitions/resource/properties/tests"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"sources": {
"items": {
"properties": {
"database": {
"description": "The database where the source is stored.\nThis parameter is useful if you want to use a source name that differs from the schema name.\nIf you're using BigQuery, use the project name as the database property.",
"minLength": 1,
"type": "string"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"freshness": {
"$ref": "#/definitions/resource/properties/freshness"
},
"loaded_at_field": {
"description": "A column name or expression that returns a timestamp indicating freshness.",
"minLength": 1,
"type": "string"
},
"loader": {
"description": "Describe the tool that loads this source into your warehouse. Note that this property is for documentation purposes only \u2014 dbt does not meaningfully use this.",
"type": "string"
},
"meta": {
"$ref": "#/definitions/resource/properties/meta"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"overrides": {
"description": "Override a source defined in an included package. The properties defined in the overriding source will be applied on top of the base properties of the overridden source.",
"minLength": 1,
"type": "string"
},
"quoting": {
"$ref": "#/definitions/resource/properties/quoting"
},
"schema": {
"description": "The schema name as stored in the database.\nNote that to use this parameter, your warehouse must allow cross-database queries.\nIf you're using BigQuery, use the dataset name as the schema: property.",
"minLength": 1,
"type": "string"
},
"tables": {
"items": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/definitions/resource/properties/columns"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"freshness": {
"$ref": "#/definitions/resource/properties/freshness"
},
"identifier": {
"description": "The table name as stored in the database.\nBy default, dbt will use the table's 'name' parameter as the identifier.",
"minLength": 1,
"type": "string"
},
"loaded_at_field": {
"$ref": "#/properties/sources/items/properties/loaded_at_field"
},
"meta": {
"$ref": "#/definitions/resource/properties/meta"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"quoting": {
"$ref": "#/definitions/resource/properties/quoting"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
},
"tests": {
"$ref": "#/definitions/resource/properties/tests"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"version": {
"default": 2,
"type": "number"
}
},
"title": "dbt resource configuration",
"type": "object"
} | MIT | en |
fivetran/dbt_yaml_schemas | 1230a7ea888f37dd3dee471467902b77eb0245f6 | 2021-06-03T17:33:20 | schemas/packages.json | 11 | 2024-05-28T03:30:42.07098Z | {
"$id": "https://github.com/fivetran/dbt_yaml_schemas/blob/main/schemas/packages.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"definitions": {
"dbtHubPackage": {
"dependencies": {
"version": [
"package"
]
},
"properties": {
"package": {
"description": "dbt Hub package name",
"type": "string"
},
"version": {
"description": "Version number or range",
"oneOf": [
{
"$ref": "#/definitions/semVer"
},
{
"description": "Version range",
"items": {
"type": "string"
},
"maxItems": 2,
"minItems": 1,
"type": "array"
}
]
}
},
"required": [
"package"
]
},
"gitPackage": {
"dependencies": {
"revision": [
"git"
],
"version": [
"git"
],
"warn-unpinned": [
"git"
]
},
"properties": {
"git": {
"description": "Git URL",
"type": "string"
},
"revision": {
"description": "Git repository tag or branch name",
"type": [
"string",
"number"
]
},
"warn-unpinned": {
"description": "Enable warning about unpinned repositories. Note: It is not recommended to disable it.",
"type": "boolean"
}
},
"required": [
"git"
]
},
"localPackage": {
"properties": {
"local": {
"description": "Path to a local package",
"type": "string"
}
},
"required": [
"local"
]
},
"semVer": {
"description": "Semantic version",
"maxLength": 14,
"minLength": 5,
"pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$",
"type": "string"
}
},
"description": "Information about packages used in dbt project",
"properties": {
"packages": {
"description": "A list of dbt packages",
"items": {
"$comment": "Should be oneOf?",
"anyOf": [
{
"$ref": "#/definitions/dbtHubPackage"
},
{
"$ref": "#/definitions/gitPackage"
},
{
"$ref": "#/definitions/localPackage"
}
],
"type": "object"
},
"minItems": 1,
"type": "array"
}
},
"title": "dbt packages.yml",
"type": "object"
} | MIT | en |
fivetran/dbt_yaml_schemas | 707e9dc00c6cf06e01ed1313a0f4eb5cb5fe1831 | 2021-06-02T14:31:11 | schemas/deployment.json | 11 | 2024-05-28T03:30:42.07098Z | {
"$id": "https://gitcdn.xyz/repo/fivetran/dbt_yaml_schemas/main/schemas/deployment.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Describes the jobs that enable Fivetran to run your dbt commands on a schedule",
"properties": {
"dbtVersion": {
"description": "The version of dbt that will run the project. Supported versions are listed in https://fivetran.com/docs/transformations/dbt/setup-guide#prerequisites \n If the version is not specified, dbt 0.18.0 will be used.",
"enum": [
"0.18.0",
"0.18.1",
"0.18.2",
"0.19.0",
"0.19.1"
],
"type": "string"
},
"jobs": {
"items": {
"properties": {
"name": {
"description": "Unique name of the job. The name will be displayed in the Fivetran dashboard once your jobs are imported.",
"type": "string"
},
"schedule": {
"description": "When this job should run in cron format. For help with cron formatting, visit https://crontab.guru.",
"type": "string"
},
"steps": {
"items": {
"properties": {
"command": {
"anyOf": [
{
"const": "dbt run",
"description": "Executes all of the models in the dependency graph."
},
{
"const": "dbt test",
"description": "Executes all tests."
},
{
"const": "dbt seed",
"description": "Load data from csv files into your data warehouse."
},
{
"const": "dbt snapshot",
"description": "Execute snapshots defined in your project."
},
{
"const": "dbt list",
"description": "List the resources in your project."
},
{
"const": "dbt compile",
"description": "Generates executable SQL from source model, test, and analysis files."
},
{
"type": "string"
}
],
"description": "The dbt command that should run in this step.\nFor a list of available commands visit https://docs.getdbt.com/reference/model-selection-syntax.",
"pattern": "^dbt\\s+\\S+",
"type": "string"
},
"name": {
"description": "The name that will be displayed in the Fivetran dashboard. Step names must be unique.",
"type": "string"
}
},
"required": [
"name",
"command"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"targetName": {
"default": "prod",
"description": "The name of the target that will be used when running the job. If it's not specified, the target will be named 'prod'.",
"type": "string"
}
},
"required": [
"name",
"schedule",
"steps"
],
"type": "object"
},
"minItems": 1,
"type": "array"
}
},
"title": "Fivetran dbt deployment.yml file",
"type": "object"
} | MIT | en |
fivetran/dbt_yaml_schemas | d05451333728841f99c800650329631367a094a2 | 2021-06-03T08:22:09 | schemas/deployment.json | 11 | 2024-05-28T03:30:42.07098Z | {
"$id": "https://gitcdn.xyz/repo/fivetran/dbt_yaml_schemas/main/schemas/deployment.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Describes the jobs that enable Fivetran to run your dbt commands on a schedule",
"properties": {
"dbtVersion": {
"description": "The version of dbt that will run the project. Supported versions are listed in https://fivetran.com/docs/transformations/dbt/setup-guide#prerequisites \n If the version is not specified, dbt 0.18.0 will be used.",
"enum": [
"0.18.0",
"0.18.1",
"0.18.2",
"0.19.0",
"0.19.1"
],
"type": "string"
},
"jobs": {
"items": {
"properties": {
"name": {
"description": "Unique name of the job. The name will be displayed in the Fivetran dashboard once your jobs are imported.",
"type": "string"
},
"schedule": {
"description": "When this job should run in cron format. For help with cron formatting, visit https://crontab.guru.",
"type": "string"
},
"steps": {
"items": {
"properties": {
"command": {
"anyOf": [
{
"const": "dbt run",
"description": "Executes all of the models in the dependency graph."
},
{
"const": "dbt test",
"description": "Executes all tests."
},
{
"const": "dbt seed",
"description": "Load data from csv files into your data warehouse."
},
{
"const": "dbt snapshot",
"description": "Execute snapshots defined in your project."
},
{
"const": "dbt list",
"description": "List the resources in your project."
},
{
"const": "dbt compile",
"description": "Generates executable SQL from source model, test, and analysis files."
},
{
"type": "string"
}
],
"description": "The dbt command that should run in this step.\nFor a list of available commands visit https://docs.getdbt.com/reference/model-selection-syntax.",
"pattern": "^dbt\\s+\\S+",
"type": "string"
},
"name": {
"description": "The name that will be displayed in the Fivetran dashboard. Step names must be unique.",
"type": "string"
}
},
"required": [
"name",
"command"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"targetName": {
"default": "prod",
"description": "The name of the target that will be used when running the job. If it's not specified, the target will be named 'prod'.",
"type": "string"
}
},
"required": [
"name",
"schedule",
"steps"
],
"type": "object"
},
"minItems": 1,
"type": "array"
}
},
"title": "Fivetran dbt deployment.yml",
"type": "object"
} | MIT | en |
fivetran/dbt_yaml_schemas | 30cda3186fce204012fd8d910575e1d2fc9c83a1 | 2021-06-03T16:10:03 | schemas/resources.json | 11 | 2024-05-28T03:30:42.07098Z | {
"$id": "https://gitcdn.xyz/repo/fivetran/dbt_yaml_schemas/main/schemas/resources.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"definitions": {
"resource": {
"properties": {
"columns": {
"items": {
"additionalProperties": false,
"properties": {
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"meta": {
"$ref": "#/definitions/resource/properties/meta"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"quote": {
"$ref": "#/definitions/resource/properties/quote"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
},
"tests": {
"$ref": "#/definitions/resource/properties/tests"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"description": {
"description": "A user-defined description.\nThese descriptions are used in the documentation website rendered by dbt.\nDescriptions can include markdown, as well as the 'doc' jinja function.",
"type": "string"
},
"docs": {
"additionalProperties": false,
"description": "Documentation-specific configuration.",
"properties": {
"show": {
"default": true,
"description": "Whether the resource is shown in the auto-generated documentation website.\nHidden resources will still appear in the dbt DAG visualization, but will be identified as 'hidden'.",
"type": "boolean"
}
},
"type": "object"
},
"freshness": {
"additionalProperties": false,
"description": "Defines the acceptable amount of time between the most recent record, and now, for a table to be considered 'fresh'.",
"properties": {
"error_after": {
"$ref": "#/definitions/resource/properties/freshness/properties/warn_after"
},
"filter": {
"description": "Adds a where clause to the query run by 'dbt source snapshot-freshness' in order to limit data scanned.",
"type": "string"
},
"warn_after": {
"additionalProperties": false,
"properties": {
"count": {
"description": "A positive integer for the number of periods where a data source is still considered 'fresh'.",
"minimum": 1,
"type": "number"
},
"period": {
"description": "The time period used in the freshness calculation.",
"enum": [
"minute",
"hour",
"day"
]
}
},
"required": [
"count",
"period"
],
"type": "object"
}
},
"type": "object"
},
"meta": {
"description": "The metadata that is compiled into the 'manifest.json' file generated by dbt, and is viewable in the auto-generated documentation.",
"type": "object"
},
"name": {
"description": "Object name.",
"minLength": 1,
"type": "string"
},
"quote": {
"default": false,
"description": "Enables or disables quoting for column names.",
"type": "boolean"
},
"tags": {
"description": "Tags used to select resources.",
"items": {
"type": "string"
},
"type": "array"
},
"testSeverity": {
"default": "error",
"description": "If severity is 'warn', dbt will log a warning for the failing test, but the test will still be considered passing.",
"enum": [
"warn",
"error"
],
"type": "string"
},
"tests": {
"description": "The tests are used to assert properties of a column or table.\nOnce these tests are defined, you can validate their correctness by running 'dbt test'.",
"items": {
"anyOf": [
{
"const": "not_null",
"description": "Validates that there are no null values present in a column."
},
{
"const": "unique",
"description": "Validates that there are no duplicate values present in a field."
},
{
"description": "Custom test",
"type": "string"
},
{
"additionalProperties": {
"description": "Custom test",
"properties": {
"severity": {
"$ref": "#/definitions/resource/properties/testSeverity"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
}
},
"type": "object"
},
"maxProperties": 1,
"minProperties": 1,
"properties": {
"acceptedValues": {
"additionalProperties": false,
"description": "Validates that all of the values in a column are present in a supplied list of values. If any values other than those provided in the list are present, then the test will fail.",
"properties": {
"quote": {
"default": true,
"description": "If true, it will single-quote the list of accepted values in the test query. To test non-strings values explicitly set it to false.",
"type": "boolean"
},
"severity": {
"$ref": "#/definitions/resource/properties/testSeverity"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
},
"values": {
"type": "array"
}
},
"required": [
"values"
],
"type": "object"
},
"not_null": {
"additionalProperties": false,
"description": "Validates that there are no duplicate values present in a field.",
"properties": {
"severity": {
"$ref": "#/definitions/resource/properties/testSeverity"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
}
},
"type": "object"
},
"relationships": {
"additionalProperties": false,
"description": "Validates that all of the records in a child table have a corresponding record in a parent table. This property is referred to as 'referential integrity'.",
"properties": {
"field": {
"description": "Parent field name",
"minLength": 1,
"type": "string"
},
"severity": {
"$ref": "#/definitions/resource/properties/testSeverity"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
},
"to": {
"description": "Parent table name. Can be expressed by 'ref' or 'source' functions",
"minLength": 1,
"type": "string"
}
},
"required": [
"to",
"field"
],
"type": "object"
},
"unique": {
"additionalProperties": false,
"description": "Validates that there are no duplicate values present in a field.",
"properties": {
"column_name": {
"description": "Column expression for testing multiple columns",
"minLength": 1,
"type": "string"
},
"severity": {
"$ref": "#/definitions/resource/properties/testSeverity"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
}
},
"type": "object"
}
},
"type": "object"
}
]
},
"type": "array"
}
}
}
},
"description": "Contains configuration of dbt resources",
"properties": {
"analyses": {
"items": {
"additionalProperties": false,
"properties": {
"columns": {
"items": {
"additionalProperties": false,
"properties": {
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"docs": {
"$ref": "#/definitions/resource/properties/docs"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"exposures": {
"items": {
"additionalProperties": false,
"properties": {
"depends_on": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"maturity": {
"enum": [
"high",
"medium",
"low"
]
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"owner": {
"additionalProperties": false,
"properties": {
"email": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"email"
],
"type": "object"
},
"type": {
"enum": [
"dashboard",
"notebook",
"analysis",
"ml",
"application"
]
},
"url": {
"type": "string"
}
},
"required": [
"name",
"type"
],
"type": "object"
},
"type": "array"
},
"macros": {
"items": {
"additionalProperties": false,
"properties": {
"arguments": {
"items": {
"additionalProperties": false,
"properties": {
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"type": {
"description": "The data type of the argument. This is only used for documentation purposes \u2014 there are no restrictions on the values you can use here.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"docs": {
"$ref": "#/definitions/resource/properties/docs"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"models": {
"items": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/definitions/resource/properties/columns"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"docs": {
"$ref": "#/definitions/resource/properties/docs"
},
"meta": {
"$ref": "#/definitions/resource/properties/meta"
},
"name": {
"$ref": "#/definitions/resource/properties/name",
"description": "The name of the model you are declaring properties for. Must match the filename of a model."
},
"tests": {
"$ref": "#/definitions/resource/properties/tests"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"seeds": {
"items": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/definitions/resource/properties/columns"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"docs": {
"$ref": "#/definitions/resource/properties/docs"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"tests": {
"$ref": "#/definitions/resource/properties/tests"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"snapshots": {
"items": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/definitions/resource/properties/columns"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"docs": {
"$ref": "#/definitions/resource/properties/docs"
},
"meta": {
"$ref": "#/definitions/resource/properties/meta"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"tests": {
"$ref": "#/definitions/resource/properties/tests"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"sources": {
"items": {
"properties": {
"database": {
"description": "The database where the source is stored.\nThis parameter is useful if you want to use a source name that differs from the schema name.\nIf you're using BigQuery, use the project name as the database property.",
"minLength": 1,
"type": "string"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"freshness": {
"$ref": "#/definitions/resource/properties/freshness"
},
"loaded_at_field": {
"description": "A column name or expression that returns a timestamp indicating freshness.",
"minLength": 1,
"type": "string"
},
"loader": {
"description": "Describe the tool that loads this source into your warehouse. Note that this property is for documentation purposes only \u2014 dbt does not meaningfully use this.",
"type": "string"
},
"meta": {
"$ref": "#/definitions/resource/properties/meta"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"overrides": {
"description": "Override a source defined in an included package. The properties defined in the overriding source will be applied on top of the base properties of the overridden source.",
"minLength": 1,
"type": "string"
},
"quoting": {
"$ref": "./dbt_project.json#/properties/quoting"
},
"schema": {
"description": "The schema name as stored in the database.\nNote that to use this parameter, your warehouse must allow cross-database queries.\nIf you're using BigQuery, use the dataset name as the schema: property.",
"minLength": 1,
"type": "string"
},
"tables": {
"items": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/definitions/resource/properties/columns"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"freshness": {
"$ref": "#/definitions/resource/properties/freshness"
},
"identifier": {
"description": "The table name as stored in the database.\nBy default, dbt will use the table's 'name' parameter as the identifier.",
"minLength": 1,
"type": "string"
},
"loaded_at_field": {
"$ref": "#/properties/sources/items/properties/loaded_at_field"
},
"meta": {
"$ref": "#/definitions/resource/properties/meta"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"quoting": {
"$ref": "./dbt_project.json#/properties/quoting"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
},
"tests": {
"$ref": "#/definitions/resource/properties/tests"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"version": {
"default": 2,
"type": "number"
}
},
"title": "dbt resource configuration",
"type": "object"
} | MIT | en |
fivetran/dbt_yaml_schemas | d1f44e6b12dab2f98a8c633f7f3602a265e30049 | 2022-11-08T15:40:23 | schemas/resources.json | 11 | 2024-05-28T03:30:42.07098Z | {
"$id": "https://github.com/fivetran/dbt_yaml_schemas/blob/main/schemas/resources.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"definitions": {
"resource": {
"properties": {
"columns": {
"items": {
"additionalProperties": false,
"properties": {
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"meta": {
"$ref": "#/definitions/resource/properties/meta"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"quote": {
"$ref": "#/definitions/resource/properties/quote"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
},
"tests": {
"$ref": "#/definitions/resource/properties/tests"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"description": {
"description": "A user-defined description.\nThese descriptions are used in the documentation website rendered by dbt.\nDescriptions can include markdown, as well as the 'doc' jinja function.",
"type": "string"
},
"docs": {
"additionalProperties": false,
"description": "Documentation-specific configuration.",
"properties": {
"show": {
"default": true,
"description": "Whether the resource is shown in the auto-generated documentation website.\nHidden resources will still appear in the dbt DAG visualization, but will be identified as 'hidden'.",
"type": "boolean"
}
},
"type": "object"
},
"freshness": {
"additionalProperties": false,
"description": "Defines the acceptable amount of time between the most recent record, and now, for a table to be considered 'fresh'.",
"properties": {
"error_after": {
"$ref": "#/definitions/resource/properties/freshness/properties/warn_after"
},
"filter": {
"description": "Adds a where clause to the query run by 'dbt source snapshot-freshness' in order to limit data scanned.",
"type": "string"
},
"warn_after": {
"additionalProperties": false,
"properties": {
"count": {
"description": "A positive integer for the number of periods where a data source is still considered 'fresh'.",
"minimum": 1,
"type": "number"
},
"period": {
"description": "The time period used in the freshness calculation.",
"enum": [
"minute",
"hour",
"day"
]
}
},
"required": [
"count",
"period"
],
"type": "object"
}
},
"type": "object"
},
"meta": {
"description": "The metadata that is compiled into the 'manifest.json' file generated by dbt, and is viewable in the auto-generated documentation.",
"type": "object"
},
"name": {
"description": "Object name.",
"minLength": 1,
"type": "string"
},
"quote": {
"default": false,
"description": "Enables or disables quoting for column names.",
"type": "boolean"
},
"quoting": {
"additionalProperties": false,
"description": "Whether dbt should quote databases, schemas, and identifiers when creating relations (tables/views) or when resolving a ref function to a direct relation reference.\nThe default values vary by database.\nNote that for BigQuery quoting configuration, 'database' and 'schema' should be used here, though these configs will apply to project and dataset names respectively.",
"properties": {
"database": {
"type": "boolean"
},
"identifier": {
"type": "boolean"
},
"schema": {
"type": "boolean"
}
},
"type": "object"
},
"tags": {
"description": "Tags used to select resources.",
"items": {
"type": "string"
},
"type": "array"
},
"testSeverity": {
"default": "error",
"description": "If severity is 'warn', dbt will log a warning for the failing test, but the test will still be considered passing.",
"enum": [
"warn",
"error"
],
"type": "string"
},
"tests": {
"description": "The tests are used to assert properties of a column or table.\nOnce these tests are defined, you can validate their correctness by running 'dbt test'.",
"items": {
"anyOf": [
{
"const": "not_null",
"description": "Validates that there are no null values present in a column."
},
{
"const": "unique",
"description": "Validates that there are no duplicate values present in a field."
},
{
"description": "Custom test",
"type": "string"
},
{
"additionalProperties": {
"description": "Custom test",
"properties": {
"severity": {
"$ref": "#/definitions/resource/properties/testSeverity"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
}
},
"type": "object"
},
"maxProperties": 1,
"minProperties": 1,
"properties": {
"accepted_values": {
"additionalProperties": false,
"description": "Validates that all of the values in a column are present in a supplied list of values. If any values other than those provided in the list are present, then the test will fail.",
"properties": {
"quote": {
"default": true,
"description": "If true, it will single-quote the list of accepted values in the test query. To test non-strings values explicitly set it to false.",
"type": "boolean"
},
"severity": {
"$ref": "#/definitions/resource/properties/testSeverity"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
},
"values": {
"type": "array"
}
},
"required": [
"values"
],
"type": "object"
},
"not_null": {
"additionalProperties": false,
"description": "Validates that there are no duplicate values present in a field.",
"properties": {
"severity": {
"$ref": "#/definitions/resource/properties/testSeverity"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
}
},
"type": "object"
},
"relationships": {
"additionalProperties": false,
"description": "Validates that all of the records in a child table have a corresponding record in a parent table. This property is referred to as 'referential integrity'.",
"properties": {
"field": {
"description": "Parent field name",
"minLength": 1,
"type": "string"
},
"severity": {
"$ref": "#/definitions/resource/properties/testSeverity"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
},
"to": {
"description": "Parent table name. Can be expressed by 'ref' or 'source' functions",
"minLength": 1,
"type": "string"
}
},
"required": [
"to",
"field"
],
"type": "object"
},
"unique": {
"additionalProperties": false,
"description": "Validates that there are no duplicate values present in a field.",
"properties": {
"column_name": {
"description": "Column expression for testing multiple columns",
"minLength": 1,
"type": "string"
},
"severity": {
"$ref": "#/definitions/resource/properties/testSeverity"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
}
},
"type": "object"
}
},
"type": "object"
}
]
},
"type": "array"
}
}
}
},
"description": "Contains configuration of dbt resources",
"properties": {
"analyses": {
"items": {
"additionalProperties": false,
"properties": {
"columns": {
"items": {
"additionalProperties": false,
"properties": {
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"docs": {
"$ref": "#/definitions/resource/properties/docs"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"exposures": {
"items": {
"additionalProperties": false,
"properties": {
"depends_on": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"maturity": {
"enum": [
"high",
"medium",
"low"
]
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"owner": {
"additionalProperties": false,
"properties": {
"email": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"email"
],
"type": "object"
},
"type": {
"enum": [
"dashboard",
"notebook",
"analysis",
"ml",
"application"
]
},
"url": {
"type": "string"
}
},
"required": [
"name",
"type"
],
"type": "object"
},
"type": "array"
},
"macros": {
"items": {
"additionalProperties": false,
"properties": {
"arguments": {
"items": {
"additionalProperties": false,
"properties": {
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"type": {
"description": "The data type of the argument. This is only used for documentation purposes \u2014 there are no restrictions on the values you can use here.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"docs": {
"$ref": "#/definitions/resource/properties/docs"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"metrics": {
"items": {
"additionalProperties": false,
"properties": {
"description": {
"$ref": "#/definitions/resource/properties/description",
"description": "Long form, human-readable description for the metric"
},
"dimensions": {
"items": {
"description": "A list of dimensions to group or filter the metric by",
"type": "string"
},
"type": "array"
},
"filters": {
"items": {
"additionalProperties": false,
"description": "A list of filters to apply before calculating the metric",
"properties": {
"field": {
"description": "Field (column) to be compared",
"type": "string"
},
"operator": {
"description": "comparison operation",
"enum": [
"is",
"is not",
"=",
">=",
"<=",
"!="
]
},
"value": {
"description": "Note that value must be defined as a string in YAML, because it will be compiled into queries as part of a string. If your filter's value needs to be surrounded in quotes inside the query (e.g. text or dates), use \"'nested'\" quotes",
"type": "string"
}
},
"required": [
"field",
"operator",
"value"
],
"type": "object"
},
"type": "array"
},
"label": {
"description": "A short for name / label for the metric",
"minLength": 1,
"type": "string"
},
"meta": {
"$ref": "#/definitions/resource/properties/meta"
},
"model": {
"description": "The dbt model that powers this metric",
"minLength": 1,
"type": "string"
},
"name": {
"$ref": "#/definitions/resource/properties/name",
"description": "A unique identifier for the metric"
},
"sql": {
"description": "The expression to aggregate/calculate over",
"type": "string"
},
"time_grains": {
"description": "One or more \"grains\" at which the metric can be evaluated",
"items": {
"enum": [
"day",
"week",
"month",
"quarter",
"year"
]
},
"type": "array"
},
"timestamp": {
"description": "The time-based component of the metric",
"type": "string"
},
"type": {
"description": "The type of calculation to perform when evaluating a metric",
"type": "string"
}
},
"required": [
"name",
"model",
"type",
"sql",
"timestamp",
"time_grains"
],
"type": "object"
},
"type": "array"
},
"models": {
"items": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/definitions/resource/properties/columns"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"docs": {
"$ref": "#/definitions/resource/properties/docs"
},
"meta": {
"$ref": "#/definitions/resource/properties/meta"
},
"name": {
"$ref": "#/definitions/resource/properties/name",
"description": "The name of the model you are declaring properties for. Must match the filename of a model."
},
"tests": {
"$ref": "#/definitions/resource/properties/tests"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"seeds": {
"items": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/definitions/resource/properties/columns"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"docs": {
"$ref": "#/definitions/resource/properties/docs"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"tests": {
"$ref": "#/definitions/resource/properties/tests"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"snapshots": {
"items": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/definitions/resource/properties/columns"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"docs": {
"$ref": "#/definitions/resource/properties/docs"
},
"meta": {
"$ref": "#/definitions/resource/properties/meta"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"tests": {
"$ref": "#/definitions/resource/properties/tests"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"sources": {
"items": {
"properties": {
"database": {
"description": "The database where the source is stored.\nThis parameter is useful if you want to use a source name that differs from the schema name.\nIf you're using BigQuery, use the project name as the database property.",
"minLength": 1,
"type": "string"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"freshness": {
"$ref": "#/definitions/resource/properties/freshness"
},
"loaded_at_field": {
"description": "A column name or expression that returns a timestamp indicating freshness.",
"minLength": 1,
"type": "string"
},
"loader": {
"description": "Describe the tool that loads this source into your warehouse. Note that this property is for documentation purposes only \u2014 dbt does not meaningfully use this.",
"type": "string"
},
"meta": {
"$ref": "#/definitions/resource/properties/meta"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"overrides": {
"description": "Override a source defined in an included package. The properties defined in the overriding source will be applied on top of the base properties of the overridden source.",
"minLength": 1,
"type": "string"
},
"quoting": {
"$ref": "#/definitions/resource/properties/quoting"
},
"schema": {
"description": "The schema name as stored in the database.\nNote that to use this parameter, your warehouse must allow cross-database queries.\nIf you're using BigQuery, use the dataset name as the schema: property.",
"minLength": 1,
"type": "string"
},
"tables": {
"items": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/definitions/resource/properties/columns"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"freshness": {
"$ref": "#/definitions/resource/properties/freshness"
},
"identifier": {
"description": "The table name as stored in the database.\nBy default, dbt will use the table's 'name' parameter as the identifier.",
"minLength": 1,
"type": "string"
},
"loaded_at_field": {
"$ref": "#/properties/sources/items/properties/loaded_at_field"
},
"meta": {
"$ref": "#/definitions/resource/properties/meta"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"quoting": {
"$ref": "#/definitions/resource/properties/quoting"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
},
"tests": {
"$ref": "#/definitions/resource/properties/tests"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"version": {
"default": 2,
"type": "number"
}
},
"title": "dbt resource configuration",
"type": "object"
} | MIT | en |
fivetran/dbt_yaml_schemas | f03633edf9332b1a789b003eeccf68b4ac201049 | 2021-06-04T07:33:19 | schemas/resources.json | 11 | 2024-05-28T03:30:42.07098Z | {
"$id": "https://github.com/fivetran/dbt_yaml_schemas/blob/main/schemas/resources.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"definitions": {
"resource": {
"properties": {
"columns": {
"items": {
"additionalProperties": false,
"properties": {
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"meta": {
"$ref": "#/definitions/resource/properties/meta"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"quote": {
"$ref": "#/definitions/resource/properties/quote"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
},
"tests": {
"$ref": "#/definitions/resource/properties/tests"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"description": {
"description": "A user-defined description.\nThese descriptions are used in the documentation website rendered by dbt.\nDescriptions can include markdown, as well as the 'doc' jinja function.",
"type": "string"
},
"docs": {
"additionalProperties": false,
"description": "Documentation-specific configuration.",
"properties": {
"show": {
"default": true,
"description": "Whether the resource is shown in the auto-generated documentation website.\nHidden resources will still appear in the dbt DAG visualization, but will be identified as 'hidden'.",
"type": "boolean"
}
},
"type": "object"
},
"freshness": {
"additionalProperties": false,
"description": "Defines the acceptable amount of time between the most recent record, and now, for a table to be considered 'fresh'.",
"properties": {
"error_after": {
"$ref": "#/definitions/resource/properties/freshness/properties/warn_after"
},
"filter": {
"description": "Adds a where clause to the query run by 'dbt source snapshot-freshness' in order to limit data scanned.",
"type": "string"
},
"warn_after": {
"additionalProperties": false,
"properties": {
"count": {
"description": "A positive integer for the number of periods where a data source is still considered 'fresh'.",
"minimum": 1,
"type": "number"
},
"period": {
"description": "The time period used in the freshness calculation.",
"enum": [
"minute",
"hour",
"day"
]
}
},
"required": [
"count",
"period"
],
"type": "object"
}
},
"type": "object"
},
"meta": {
"description": "The metadata that is compiled into the 'manifest.json' file generated by dbt, and is viewable in the auto-generated documentation.",
"type": "object"
},
"name": {
"description": "Object name.",
"minLength": 1,
"type": "string"
},
"quote": {
"default": false,
"description": "Enables or disables quoting for column names.",
"type": "boolean"
},
"quoting": {
"additionalProperties": false,
"description": "Whether dbt should quote databases, schemas, and identifiers when creating relations (tables/views) or when resolving a ref function to a direct relation reference.\nThe default values vary by database.\nNote that for BigQuery quoting configuration, 'database' and 'schema' should be used here, though these configs will apply to project and dataset names respectively.",
"properties": {
"database": {
"type": "boolean"
},
"identifier": {
"type": "boolean"
},
"schema": {
"type": "boolean"
}
},
"type": "object"
},
"tags": {
"description": "Tags used to select resources.",
"items": {
"type": "string"
},
"type": "array"
},
"testSeverity": {
"default": "error",
"description": "If severity is 'warn', dbt will log a warning for the failing test, but the test will still be considered passing.",
"enum": [
"warn",
"error"
],
"type": "string"
},
"tests": {
"description": "The tests are used to assert properties of a column or table.\nOnce these tests are defined, you can validate their correctness by running 'dbt test'.",
"items": {
"anyOf": [
{
"const": "not_null",
"description": "Validates that there are no null values present in a column."
},
{
"const": "unique",
"description": "Validates that there are no duplicate values present in a field."
},
{
"description": "Custom test",
"type": "string"
},
{
"additionalProperties": {
"description": "Custom test",
"properties": {
"severity": {
"$ref": "#/definitions/resource/properties/testSeverity"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
}
},
"type": "object"
},
"maxProperties": 1,
"minProperties": 1,
"properties": {
"acceptedValues": {
"additionalProperties": false,
"description": "Validates that all of the values in a column are present in a supplied list of values. If any values other than those provided in the list are present, then the test will fail.",
"properties": {
"quote": {
"default": true,
"description": "If true, it will single-quote the list of accepted values in the test query. To test non-strings values explicitly set it to false.",
"type": "boolean"
},
"severity": {
"$ref": "#/definitions/resource/properties/testSeverity"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
},
"values": {
"type": "array"
}
},
"required": [
"values"
],
"type": "object"
},
"not_null": {
"additionalProperties": false,
"description": "Validates that there are no duplicate values present in a field.",
"properties": {
"severity": {
"$ref": "#/definitions/resource/properties/testSeverity"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
}
},
"type": "object"
},
"relationships": {
"additionalProperties": false,
"description": "Validates that all of the records in a child table have a corresponding record in a parent table. This property is referred to as 'referential integrity'.",
"properties": {
"field": {
"description": "Parent field name",
"minLength": 1,
"type": "string"
},
"severity": {
"$ref": "#/definitions/resource/properties/testSeverity"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
},
"to": {
"description": "Parent table name. Can be expressed by 'ref' or 'source' functions",
"minLength": 1,
"type": "string"
}
},
"required": [
"to",
"field"
],
"type": "object"
},
"unique": {
"additionalProperties": false,
"description": "Validates that there are no duplicate values present in a field.",
"properties": {
"column_name": {
"description": "Column expression for testing multiple columns",
"minLength": 1,
"type": "string"
},
"severity": {
"$ref": "#/definitions/resource/properties/testSeverity"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
}
},
"type": "object"
}
},
"type": "object"
}
]
},
"type": "array"
}
}
}
},
"description": "Contains configuration of dbt resources",
"properties": {
"analyses": {
"items": {
"additionalProperties": false,
"properties": {
"columns": {
"items": {
"additionalProperties": false,
"properties": {
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"docs": {
"$ref": "#/definitions/resource/properties/docs"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"exposures": {
"items": {
"additionalProperties": false,
"properties": {
"depends_on": {
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"maturity": {
"enum": [
"high",
"medium",
"low"
]
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"owner": {
"additionalProperties": false,
"properties": {
"email": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"email"
],
"type": "object"
},
"type": {
"enum": [
"dashboard",
"notebook",
"analysis",
"ml",
"application"
]
},
"url": {
"type": "string"
}
},
"required": [
"name",
"type"
],
"type": "object"
},
"type": "array"
},
"macros": {
"items": {
"additionalProperties": false,
"properties": {
"arguments": {
"items": {
"additionalProperties": false,
"properties": {
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"type": {
"description": "The data type of the argument. This is only used for documentation purposes \u2014 there are no restrictions on the values you can use here.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"docs": {
"$ref": "#/definitions/resource/properties/docs"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"models": {
"items": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/definitions/resource/properties/columns"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"docs": {
"$ref": "#/definitions/resource/properties/docs"
},
"meta": {
"$ref": "#/definitions/resource/properties/meta"
},
"name": {
"$ref": "#/definitions/resource/properties/name",
"description": "The name of the model you are declaring properties for. Must match the filename of a model."
},
"tests": {
"$ref": "#/definitions/resource/properties/tests"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"seeds": {
"items": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/definitions/resource/properties/columns"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"docs": {
"$ref": "#/definitions/resource/properties/docs"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"tests": {
"$ref": "#/definitions/resource/properties/tests"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"snapshots": {
"items": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/definitions/resource/properties/columns"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"docs": {
"$ref": "#/definitions/resource/properties/docs"
},
"meta": {
"$ref": "#/definitions/resource/properties/meta"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"tests": {
"$ref": "#/definitions/resource/properties/tests"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"sources": {
"items": {
"properties": {
"database": {
"description": "The database where the source is stored.\nThis parameter is useful if you want to use a source name that differs from the schema name.\nIf you're using BigQuery, use the project name as the database property.",
"minLength": 1,
"type": "string"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"freshness": {
"$ref": "#/definitions/resource/properties/freshness"
},
"loaded_at_field": {
"description": "A column name or expression that returns a timestamp indicating freshness.",
"minLength": 1,
"type": "string"
},
"loader": {
"description": "Describe the tool that loads this source into your warehouse. Note that this property is for documentation purposes only \u2014 dbt does not meaningfully use this.",
"type": "string"
},
"meta": {
"$ref": "#/definitions/resource/properties/meta"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"overrides": {
"description": "Override a source defined in an included package. The properties defined in the overriding source will be applied on top of the base properties of the overridden source.",
"minLength": 1,
"type": "string"
},
"quoting": {
"$ref": "#/definitions/resource/properties/quoting"
},
"schema": {
"description": "The schema name as stored in the database.\nNote that to use this parameter, your warehouse must allow cross-database queries.\nIf you're using BigQuery, use the dataset name as the schema: property.",
"minLength": 1,
"type": "string"
},
"tables": {
"items": {
"additionalProperties": false,
"properties": {
"columns": {
"$ref": "#/definitions/resource/properties/columns"
},
"description": {
"$ref": "#/definitions/resource/properties/description"
},
"freshness": {
"$ref": "#/definitions/resource/properties/freshness"
},
"identifier": {
"description": "The table name as stored in the database.\nBy default, dbt will use the table's 'name' parameter as the identifier.",
"minLength": 1,
"type": "string"
},
"loaded_at_field": {
"$ref": "#/properties/sources/items/properties/loaded_at_field"
},
"meta": {
"$ref": "#/definitions/resource/properties/meta"
},
"name": {
"$ref": "#/definitions/resource/properties/name"
},
"quoting": {
"$ref": "#/definitions/resource/properties/quoting"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
},
"tests": {
"$ref": "#/definitions/resource/properties/tests"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"tags": {
"$ref": "#/definitions/resource/properties/tags"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array"
},
"version": {
"default": 2,
"type": "number"
}
},
"title": "dbt resource configuration",
"type": "object"
} | MIT | en |
fivetran/dbt_yaml_schemas | 5f033fae290314257dfa4e7441209588a24f5a9b | 2021-06-02T12:39:06 | schemas/deployment.json | 11 | 2024-05-28T03:30:42.07098Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Describes the jobs that enable Fivetran to run your dbt commands on a schedule",
"properties": {
"dbtVersion": {
"description": "Choose the version of dbt that will run the project. Supported versions are listed in https://fivetran.com/docs/transformations/dbt/setup-guide#prerequisites.\n If the version is not specified, dbt 0.18.0 will be used.",
"oneOf": [
{
"const": "0.18.0"
},
{
"const": "0.18.1"
},
{
"const": "0.18.2"
},
{
"const": "0.19.0"
},
{
"const": "0.19.1"
}
],
"type": "string"
},
"jobs": {
"items": {
"properties": {
"name": {
"description": "Unique name of the job. The name will be displayed in the Fivetran dashboard once your jobs are imported.",
"type": "string"
},
"schedule": {
"description": "When this job should run in cron format. For help with cron formatting, visit https://crontab.guru.",
"type": "string"
},
"steps": {
"items": {
"properties": {
"command": {
"anyOf": [
{
"const": "dbt run",
"description": "Executes all of the models in the dependency graph."
},
{
"const": "dbt test",
"description": "Executes all tests."
},
{
"const": "dbt seed",
"description": "Load data from csv files into your data warehouse."
},
{
"const": "dbt snapshot",
"description": "Execute snapshots defined in your project."
},
{
"const": "dbt list",
"description": "List the resources in your project."
},
{
"const": "dbt compile",
"description": "Generates executable SQL from source model, test, and analysis files."
},
{
"type": "string"
}
],
"description": "The dbt command that should run in this step.\nFor a list of available commands visit https://docs.getdbt.com/reference/model-selection-syntax.",
"minLength": 3,
"type": "string"
},
"name": {
"description": "Give each step a unique name. The name will be displayed in the Fivetran dashboard. Step names must be unique.",
"type": "string"
}
},
"required": [
"name",
"command"
],
"type": "object"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"targetName": {
"description": "The name of the target that will be used when running the job. If it's not specified, the target will be named 'prod'.",
"type": "string"
}
},
"required": [
"name",
"schedule",
"steps"
],
"type": "object"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"title": "Fivetran dbt deployment.yml file",
"type": "object"
} | MIT | en |
fivetran/dbt_yaml_schemas | a446e265d0dbbe8fc1c3328f7cf6673320836a65 | 2021-06-02T08:14:59 | schemas/packages.json | 11 | 2024-05-28T03:30:42.07098Z | {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"description": "Dockerfile linter, validate inline bash, written in Haskell",
"properties": {},
"title": "JSON Schema for Hadolint, a Dockerfile linter tool",
"trustedRegistries": {
"description": "A list of trusted registries. Ex: docker.io",
"items": {
"type": "string"
},
"type": "array"
},
"type": "object"
} | MIT | en |
fivetran/dbt_yaml_schemas | 1230a7ea888f37dd3dee471467902b77eb0245f6 | 2021-06-03T17:33:20 | schemas/deployment.json | 11 | 2024-05-28T03:30:42.07098Z | {
"$id": "https://github.com/fivetran/dbt_yaml_schemas/blob/main/schemas/deployment.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Describes the jobs that enable Fivetran to run your dbt commands on a schedule",
"properties": {
"dbtVersion": {
"description": "The version of dbt that will run the project. Supported versions are listed in https://fivetran.com/docs/transformations/dbt/setup-guide#prerequisites \n If the version is not specified, dbt 0.18.0 will be used.",
"enum": [
"0.18.0",
"0.18.1",
"0.18.2",
"0.19.0",
"0.19.1"
],
"type": "string"
},
"jobs": {
"items": {
"properties": {
"name": {
"description": "Unique name of the job. The name will be displayed in the Fivetran dashboard once your jobs are imported.",
"type": "string"
},
"schedule": {
"description": "When this job should run in cron format. For help with cron formatting, visit https://crontab.guru.",
"type": "string"
},
"steps": {
"items": {
"properties": {
"command": {
"anyOf": [
{
"const": "dbt run",
"description": "Executes all of the models in the dependency graph."
},
{
"const": "dbt test",
"description": "Executes all tests."
},
{
"const": "dbt seed",
"description": "Load data from csv files into your data warehouse."
},
{
"const": "dbt snapshot",
"description": "Execute snapshots defined in your project."
},
{
"const": "dbt list",
"description": "List the resources in your project."
},
{
"const": "dbt compile",
"description": "Generates executable SQL from source model, test, and analysis files."
},
{
"type": "string"
}
],
"description": "The dbt command that should run in this step.\nFor a list of available commands visit https://docs.getdbt.com/reference/model-selection-syntax.",
"pattern": "^dbt\\s+\\S+",
"type": "string"
},
"name": {
"description": "The name that will be displayed in the Fivetran dashboard. Step names must be unique.",
"type": "string"
}
},
"required": [
"name",
"command"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"targetName": {
"default": "prod",
"description": "The name of the target that will be used when running the job. If it's not specified, the target will be named 'prod'.",
"type": "string"
}
},
"required": [
"name",
"schedule",
"steps"
],
"type": "object"
},
"minItems": 1,
"type": "array"
}
},
"title": "Fivetran dbt deployment.yml",
"type": "object"
} | MIT | en |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.