cluster.yml.json

$ref: #/definitions/Key

$ref: #/definitions/GlobalAwsOpts

$ref: #/definitions/ServiceOverride

required: VolumeID FSType Partition ReadOnly

required: Kind APIVersion Plugins

required: Name Path Configuration

$ref: #/definitions/Unknown

$ref: #/definitions/AuditLogConfig

description: ConfigFile is a multiline string that represent a custom webhook config file

description: CacheTimeout controls how long to cache authentication decisions

description: Authentication strategy that will be used in kubernetes cluster

description: List of additional hostnames and IPs to include in the api server PKI cert

description: Webhook configuration options

description: Authorization mode used by kubernetes

description: Authorization mode options

required: cloud tenantId subscriptionId resourceGroup location vnetName vnetResourceGroup subnetName securityGroupName routeTableName primaryAvailabilitySetName vmType primaryScaleSetName aadClientId aadClientSecret aadClientCertPath aadClientCertPassword cloudProviderBackoff cloudProviderBackoffRetries cloudProviderBackoffExponent cloudProviderBackoffDuration cloudProviderBackoffJitter cloudProviderRateLimit cloudProviderRateLimitQPS cloudProviderRateLimitBucket useInstanceMetadata useManagedIdentityExtension maximumLoadBalancerRuleCount

description: The cloud environment identifier. Takes values from https://github.com/Azure/go-autorest/blob/ec5f4903f77ed9927ac95b19ab8e44ada64c1356/autorest/azure/environments.go#L13

description: The AAD Tenant ID for the Subscription that the cluster is deployed in

description: The ID of the Azure Subscription that the cluster is deployed in

description: The name of the resource group that the cluster is deployed in

description: The location of the resource group that the cluster is deployed in

description: The name of the VNet that the cluster is deployed in

description: The name of the resource group that the Vnet is deployed in

description: The name of the subnet that the cluster is deployed in

description: The name of the security group attached to the cluster's subnet

description: (Optional in 1.6) The name of the route table attached to the subnet that the cluster is deployed in

description:
(Optional) The name of the availability set that should be used as the load balancer backend
If this is set, the Azure cloudprovider will only add nodes from that availability set to the load
balancer backend pool. If this is not set, and multiple agent pools (availability sets) are used, then
the cloudprovider will try to add all nodes to a single backend pool which is forbidden.
In other words, if you use multiple agent pools (availability sets), you MUST set this field.

description:
The type of azure nodes. Candidate valudes are: vmss and standard.
If not set, it will be default to standard.

description:
The name of the scale set that should be used as the load balancer backend.
If this is set, the Azure cloudprovider will only add nodes from that scale set to the load
balancer backend pool. If this is not set, and multiple agent pools (scale sets) are used, then
the cloudprovider will try to add all nodes to a single backend pool which is forbidden.
In other words, if you use multiple agent pools (scale sets), you MUST set this field.

description:
The ClientID for an AAD application with RBAC access to talk to Azure RM APIs
This's used for service principal authentication: https://github.com/Azure/aks-engine/blob/master/docs/topics/service-principals.md

description:
The ClientSecret for an AAD application with RBAC access to talk to Azure RM APIs
This's used for service principal authentication: https://github.com/Azure/aks-engine/blob/master/docs/topics/service-principals.md

description:
The path of a client certificate for an AAD application with RBAC access to talk to Azure RM APIs
This's used for client certificate authentication: https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-protocols-oauth-service-to-service

description:
The password of the client certificate for an AAD application with RBAC access to talk to Azure RM APIs
This's used for client certificate authentication: https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-protocols-oauth-service-to-service

description: Enable exponential backoff to manage resource request retries

description: Backoff retry limit

description: Backoff exponent

description: Backoff duration

description: Backoff jitter

description: Enable rate limiting

description: Rate limit QPS

description: Rate limit Bucket Size

description: Use instance metadata service where possible

description:
Use managed service identity for the virtual machine to access Azure ARM APIs
This's used for managed identity authentication: https://docs.microsoft.com/en-us/azure/active-directory/managed-service-identity/overview
For user-assigned managed identity, need to set the below UserAssignedIdentityID

description:
The Client ID of the user assigned MSI which is assigned to the underlying VMs
This's used for managed identity authentication: https://docs.microsoft.com/en-us/azure/active-directory/managed-service-identity/overview

description: Maximum allowed LoadBalancer Rule Count is the limit enforced by Azure Load balancer, default(0) to 148

description: Sku of Load Balancer and Public IP: `basic` or `standard`, default(blank) to `basic`

description:
Excludes master nodes (labeled with `node-role.kubernetes.io/master`) from the backend pool of Azure standard loadbalancer, default(nil) to `true`
If want adding the master nodes to ALB, this should be set to `false` and remove the `node-role.kubernetes.io/master` label from master nodes

required: DiskName DataDiskURI CachingMode FSType ReadOnly Kind

description: Address of Bastion Host

description: SSH Port of Bastion Host

description: ssh User to Bastion Host

description: SSH Agent Auth enable

description: SSH Private Key

description: SSH Private Key Path

description: SSH Certificate

description: SSH Certificate Path

description: Ignore proxy environment variables

description: overrides autodetection. v1 or v2. Defaults to auto

description: See Issue #33128

required: Driver ReadOnly FSType VolumeAttributes NodePublishSecretRef

description: Cloud provider type used with calico

required: Monitors Path User SecretFile SecretRef ReadOnly

description: Name of the Cloud Provider

description: AWSCloudProvider

description: AzureCloudProvider

description: OpenstackCloudProvider

description: VsphereCloudProvider

description: CustomCloudProvider is a multiline string that represent a custom cloud config file

description: DNS provider

description: DNS config options

description: Upstream nameservers

description: ReverseCIDRs

description: Stubdomains

description: NodeSelector key pair

description: Nodelocal DNS

description: Update strategy

description: Autoscaler fields to determine number of dns replicas

description: Tolerations for Deployments

description: List of etcd urls

description: External CA certificate

description: External Client certificate

description: External Client key

description: External etcd prefix

description: UID to run etcd container as

description: GID to run etcd container as

description: Etcd Recurring snapshot Service, used by rke only

description: Etcd snapshot Retention period

description: Etcd snapshot Creation period

description: Backup backend for etcd snapshots

required: FieldRef ResourceFieldRef ConfigMapKeyRef SecretKeyRef

required: Name HostPath EmptyDir GCEPersistentDisk AWSElasticBlockStore GitRepo Secret NFS ISCSI Glusterfs PersistentVolumeClaim RBD FlexVolume Cinder CephFS Flocker DownwardAPI FC AzureFile ConfigMap VsphereVolume Quobyte AzureDisk PhotonPersistentDisk Projected PortworxVolume ScaleIO StorageOS CSI Ephemeral

required: Name ReadOnly MountPath SubPath MountPropagation SubPathExpr

description: Alternate cloud interface for flannel

required: Driver FSType SecretRef ReadOnly Options

required: zone vpc subnet-id routetable-id role-arn kubernetes-cluster-tag kubernetes-cluster-id disable-security-group-ingress elb-security-group disable-strict-zone-check

description:
TODO: Is there any use for this?  We can get it from the instance metadata service
Maybe if we're not running on AWS, e.g. bootstrap; for now it is not very useful

description:
The AWS VPC flag enables the possibility to run the master components
on a different aws account, on a different cloud provider or on-premises.
If the flag is set also the KubernetesClusterTag must be provided

description: SubnetID enables using a specific subnet to use for ELB's

description: RouteTableID enables using a specific RouteTable

description: RoleARN is the IAM role to assume when interaction with AWS APIs.

description: KubernetesClusterTag is the legacy cluster id we'll use to identify our cluster resources

description: KubernetesClusterID is the cluster id we'll use to identify our cluster resources

description:
The aws provider creates an inbound rule per load balancer on the node security
group. However, this can run into the AWS security group rule limit of 50 if
many LoadBalancers are created.

This flag disables the automatic ingress creation. It requires that the user
has setup a rule that allows inbound traffic on kubelet ports from the
local VPC subnet (so load balancers can access it). E.g. 10.82.0.0/16 30000-32000.

description:
AWS has a hard limit of 500 security groups. For large clusters creating a security group for each ELB
can cause the max number of security groups to be reached. If this is set instead of creating a new
Security group for each ELB this security group will be used instead.

description:
During the instantiation of an new AWS cloud provider, the detected region
is validated against a known set of regions.

In a non-standard, AWS like environment (e.g. Eucalyptus), this check may
be undesirable.  Setting this to true will disable the check and provide
a warning that the check was skipped.  Please note that this is an
experimental feature and work-in-progress for the moment.  If you find
yourself in an non-AWS cloud and open an issue, please indicate that in the
issue body.

required: auth-url username user-id password tenant-id tenant-name trust-id domain-id domain-name region ca-file

required: TargetPortal IQN Lun ISCSIInterface FSType ReadOnly Portals DiscoveryCHAPAuth SessionCHAPAuth SecretRef InitiatorName

description: Ingress controller type used by kubernetes

description:
These options are NOT for configuring Ingress's addon template.
They are used for its ConfigMap options specifically.

description: NodeSelector key pair

description: Ingress controller extra arguments

description: DNS Policy

description: Extra Env vars

description: Extra volumes

description: Extra volume mounts

description: nginx daemonset upgrade strategy

description: Http port for ingress controller daemonset

description: Https port for ingress controller daemonset

description: NetworkMode selector for ingress controller pods. Default is HostNetwork

description: Tolerations for Deployments

description: Enable or disable nginx default-http-backend

description: Priority class name for Nginx-Ingress's "default-http-backend" deployment

description: Priority class name for Nginx-Ingress's "nginx-ingress-controller" daemonset

description: Virtual IP range that will be used by Kubernetes services

description: Port range for services defined with NodePort type

description: Enabled/Disable PodSecurityPolicy

description: Enable/Disable AlwaysPullImages admissions plugin

description: Secrets encryption provider config

description: Audit Log Configuration

description: AdmissionConfiguration

description: Event Rate Limit configuration

description: CIDR Range for Pods in cluster

description: Domain of the cluster (default: "cluster.local")

description: The image whose network/ipc namespaces containers in each pod will use

description: Cluster DNS service ip

description: Fail if swap is enabled

description: Generate per node kubelet serving certificates created using kube-ca

required: lb-version use-octavia subnet-id floating-network-id lb-method lb-provider create-monitor monitor-delay monitor-timeout monitor-max-retries manage-security-groups

description: overrides autodetection. Only support v2.

description: uses Octavia V2 service catalog endpoint

description: overrides autodetection.

description: If specified, will create floating ip for loadbalancer, or do not create floating ip.

description: default to ROUND_ROBIN.

required: Manager Operation APIVersion Time FieldsType FieldsV1

description: Monitoring server provider

description:
These options are NOT for configuring the Metrics-Server's addon template.
They are used to pass command args to the metric-server's deployment containers specifically.

description: NodeSelector key pair

description: Update strategy

description: Number of monitoring addon pods

description: Tolerations for Deployments

description: Priority class name for Metrics-Server's "metrics-server" deployment

description: Network Plugin That will be used in kubernetes cluster

description: Plugin options to configure network properties

description: Set MTU for CNI provider

description: CalicoNetworkProvider

description: CanalNetworkProvider

description: FlannelNetworkProvider

description: WeaveNetworkProvider

description: AciNetworkProvider

description: NodeSelector key pair

description: Network plugin daemonset upgrade strategy

description: Tolerations for Deployments

description:
Drain node even if there are pods not managed by a ReplicationController, Job, or DaemonSet
Drain will not proceed without Force set to true if there are such pods

description:
If there are DaemonSet-managed pods, drain will not proceed without IgnoreDaemonSets set to true
(even when set to true, kubectl won't delete pods - so setting default to true)

description: Continue even if there are pods using emptyDir

description:
Period of time in seconds given to each pod to terminate gracefully.
If negative, the default value specified in the pod will be used

description: Time to wait (in seconds) before giving up for one try

description: MaxUnavailableWorker input can be a number of nodes or a percentage of nodes (example, max_unavailable_worker: 2 OR max_unavailable_worker: 20%)

description: MaxUnavailableControlplane input can be a number of nodes or a percentage of nodes

description: link-local IP for nodelocal DNS

description: Nodelocal DNS daemonset upgrade strategy

description: NodeSelector key pair

description: Priority class name for NodeLocal's "node-local-dns" daemonset

required: APIVersion Kind Name UID Controller BlockOwnerDeletion

required: AccessModes Selector Resources VolumeName StorageClassName VolumeMode DataSource

required: Name GenerateName Namespace SelfLink UID ResourceVersion Generation CreationTimestamp DeletionTimestamp DeletionGracePeriodSeconds Labels Annotations OwnerReferences Finalizers ClusterName ManagedFields Spec

required: Kind APIVersion Name GenerateName Namespace SelfLink UID ResourceVersion Generation CreationTimestamp DeletionTimestamp DeletionGracePeriodSeconds Labels Annotations OwnerReferences Finalizers ClusterName ManagedFields Rules OmitStages

required: Level Users UserGroups Verbs Resources Namespaces NonResourceURLs OmitStages

description: URL for the registry

description: User name for registry acces

description: Password for registry access

description: Default registry

description: ECRCredentialPlugin

required: Registry Volume ReadOnly User Group Tenant

required: CephMonitors RBDImage FSType RBDPool RadosUser Keyring SecretRef ReadOnly

description: Name of the host provisioned via docker machine

description: IP or FQDN that is fully resolvable and used for SSH communication

description: Port used for SSH communication

description: Optional - Internal address that will be used for components communication

description: Node role in kubernetes cluster (controlplane, worker, or etcd)

description: Optional - Hostname of the node

description: SSH usesr that will be used by RKE

description: Optional - Docker socket on the node that will be used in tunneling

description: SSH Agent Auth enable

description: SSH Private Key

description: SSH Private Key Path

description: SSH Certificate

description: SSH Certificate Path

description: Node Labels

description: Node Taints

description: Etcd Service

description: KubeAPI Service

description: KubeController Service

description: Scheduler Service

description: Kubelet Service

description: KubeProxy Service

description: etcd image

description: Alpine image

description: rke-nginx-proxy image

description: rke-cert-deployer image

description: rke-service-sidekick image

description: KubeDNS image

description: DNSMasq image

description: KubeDNS side car image

description: KubeDNS autoscaler image

description: CoreDNS image

description: CoreDNS autoscaler image

description: Nodelocal image

description: Kubernetes image

description: Flannel image

description: Flannel CNI image

description: Calico Node image

description: Calico CNI image

description: Calico Controllers image

description: Calicoctl image

description: CalicoFlexVol image

description: Canal Node Image

description: Canal CNI image

description: Canal Controllers Image needed for Calico/Canal v3.14.0+

description: CanalFlannel image

description: CanalFlexVol image

description: Weave Node image

description: Weave CNI image

description: Pod infra container image

description: Ingress Controller image

description: Ingress Controller Backend image

description: Ingress Webhook image

description: Metrics Server image

description: Pod infra container image for Windows

description: Cni deployer container image for Cisco ACI

description: host container image for Cisco ACI

description: opflex agent container image for Cisco ACI

description: mcast daemon container image for Cisco ACI

description: OpenvSwitch container image for Cisco ACI

description: Controller container image for Cisco ACI

description: GBP Server container image for Cisco ACI

description: Opflex Server container image for Cisco ACI

description: Kubernetes nodes

description: Kubernetes components

description: Network configuration used in the kubernetes cluster (flannel, calico)

description: Authentication configuration used in the cluster (default: x509)

description: YAML manifest for user provided addons to be deployed on the cluster

description: List of urls or paths for addons

description: List of images used internally for proxy, cert download and kubedns

description: SSH Private Key Path

description: SSH Certificate Path

description: SSH Agent Auth enable

description: Authorization mode configuration used in the cluster

description: Enable/disable strict docker version checking

description: Enable/disable using cri-dockerd

description: Kubernetes version to use (if kubernetes image is specified, image version takes precedence)

description: List of private registries and their credentials

description: Ingress controller used in the cluster

description: Cluster Name used in the kube config

description: Cloud Provider options

description: kubernetes directory path

description: kubernetes directory path for windows

description: Timeout in seconds for status check on addon deployment jobs

description: Bastion/Jump Host configuration

description: Monitoring Config

description: RestoreCluster flag

description: Rotating Certificates Option

description: Rotate Encryption Key Option

description: DNS Config

description: Upgrade Strategy for the cluster

description: Rotate CA Certificates

description: Services to rotate their certs

description: required

required: Gateway System SecretRef SSLEnabled ProtectionDomain StoragePool StorageMode VolumeName FSType ReadOnly

description: Enable/disable secrets encryption provider config

description: Custom Encryption Provider configuration object

required: service region url signing-region signing-method signing-name

required: VolumeName VolumeNamespace FSType ReadOnly SecretRef

required: Key Operator Value Effect TolerationSeconds

required: Secret DownwardAPI ConfigMap ServiceAccountToken

required: VolumePath FSType StoragePolicyName StoragePolicyID


cypress.schema.json

title: JSON schema for the https://cypress.io Test Runner's configuration file. Details at https://on.cypress.io/configuration

type: object

type: string

description: Url used as prefix for cy.visit() or cy.request() command’s url. Example http://localhost:3030 or https://test.my-domain.com

description: Any values to be set as environment variables. See https://on.cypress.io/environment-variables

type: string array

description: A String or Array of glob patterns used to ignore test files that would otherwise be shown in your list of tests. Cypress uses minimatch with the options: {dot: true, matchBase: true}. We suggest using http://globtester.com to test what files would match.

type: number

description: The number of tests for which snapshots and command data are kept in memory. Reduce this number if you are experiencing high memory consumption in your browser during a test run.

description: Port used to host Cypress. Normally this is a randomly generated port

default: spec

description: The reporter used when running headlessly or in CI. See https://on.cypress.io/reporters

description: The reporter options used. Supported options depend on the reporter. See https://on.cypress.io/reporters#Reporter-Options

description: Slow test threshold in milliseconds. Only affects the visual output of some reporters. For example, the spec reporter will display the test time in yellow if over the threshold. See https://on.cypress.io/configuration#Timeouts

description: A String or Array of string glob patterns of the test files to load. See https://on.cypress.io/configuration#Global

type: boolean

description: Whether Cypress will watch and restart tests on test file changes

description: Time, in milliseconds, to wait until most DOM based commands are considered timed out

description: Time, in milliseconds, to wait for a system command to finish executing during a cy.exec() command

description: Time, in milliseconds, to wait for a task to finish executing during a cy.task() command

description: Time, in milliseconds, to wait for page transition events or cy.visit(), cy.go(), cy.reload() commands to fire their page load events. Network requests are limited by the underlying operating system, and may still time out if this value is increased.

description: Time, in milliseconds, to wait for an XHR request to go out in a cy.wait() command

description: Time, in milliseconds, to wait until a response in a cy.request(), cy.wait(), cy.fixture(), cy.getCookie(), cy.getCookies(), cy.setCookie(), cy.clearCookie(), cy.clearCookies(), and cy.screenshot() commands

default: root project folder

description: Path to folder where application files will attempt to be served from

type: string boolean

default: cypress/fixtures

description: Path to folder containing fixture files (Pass false to disable)

default: cypress/integration

description: Path to folder containing integration test files

default: cypress/downloads

description: Path to folder where files downloaded during a test are saved

description: Path to folder containing component test files (Pass false to disable)

description: Path to plugins file. (Pass false to disable)

description: Whether Cypress will take a screenshot when a test fails during cypress run

default: cypress/screenshots

description: Path to folder where screenshots will be saved from cy.screenshot() command or after a test fails during cypress run

description: Path to file to load before test files load. This file is compiled and bundled. (Pass false to disable)

default: cypress/videos

description: Path to folder where videos will be saved during cypress run

description: Whether Cypress will trash assets within the screenshotsFolder and videosFolder before tests run with cypress run

type: number boolean

description: The quality setting for the video compression, in Constant Rate Factor (CRF). The value can be false to disable compression or a value between 0 and 51, where a lower value results in better quality (at the expense of a higher file size).

description: Whether Cypress will capture a video of the tests run with cypress run

description: Whether Cypress will process, compress, and upload videos to the Dashboard even when all tests in a spec file are passing. This only applies when recording your runs to the Dashboard. Turn this off if you’d like to only upload the spec file’s video when there are failing tests.

description: Whether Chrome Web Security for same-origin policy and insecure mixed content is enabled. Read more about this at https://on.cypress.io/web-security

description: Enables you to override the default user agent the browser sends in all request headers. User agent values are typically used by servers to help identify the operating system, browser, and browser version. See User-Agent MDN Documentation for example user agent values here: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent

description: A String or Array of hosts that you wish to block traffic for. Please read the notes for examples on using this https://on.cypress.io/configuration#blockHosts

description: Whether Cypress will search for and replace obstructive JS code found in .js or .html files that prevent Cypress from working. Please read the notes for more information on this setting. https://on.cypress.io/configuration#modifyObstructiveCode

description: Default height in pixels for the application under tests’ viewport (Override with cy.viewport() command)

description: Default width in pixels for the application under tests’ viewport. (Override with cy.viewport() command)

description: The distance in pixels an element must exceed over time to be considered animating

description: Whether to wait for elements to finish animating before executing commands

default: top

description: Viewport position to which an element should be scrolled prior to action commands. Setting `false` disables scrolling.

description: A 6 character string use to identify this project in the Cypress Dashboard. See https://on.cypress.io/dashboard-service#Identification

enum: system bundled

default: system

description: DEPRECATED: If set to 'bundled', Cypress will use the Node version bundled with Cypress. Otherwise, Cypress will use the Node version that was used to launch the Cypress. This Node version is used when executing your plugins file and building spec files.

description: Allows listening to the `before:run`, `after:run`, `before:spec`, and `after:spec` events in the plugins file during interactive mode.

description: Enables AST-based JS/HTML rewriting. This may fix issues caused by the existing regex-based JS/HTML replacement algorithm.

description: Enable experimental session support. See https://on.cypress.io/session

description: Polyfills `window.fetch` to enable Network spying and stubbing

description: Generate and save commands directly to your test suite by interacting with your app as an end user would.

type: object number null

description: The number of times to retry a failing. Can be configured to apply only in runMode or openMode

description: Enables including elements within the shadow DOM when using querying commands (e.g. cy.get(), cy.find()). Can be set globally in cypress.json, per-suite or per-test in the test configuration object, or programmatically with Cypress.config()

description: Defines client certificates to use when sending requests to the specified URLs

type: array

description: Requests for URLs matching this minimatch pattern will use the supplied client certificate

description: Path(s) to CA file(s) to validate certs against, relative to project root

description: PEM file specific properties

description: Path to the certificate, relative to project root

description: Path to the private key, relative to project root

description: (Optional) File path to a UTF-8 text file containing the passphrase for the key, relative to project root

required: cert key

description: PFX file specific properties

description: Path to the certificate container, relative to project root

description: (Optional) File path to a UTF-8 text file containing the passphrase for the container, relative to project root

required: url certs

$ref: #/definitions/cypressConfig

description: Any component runner specific overrides

description: Any e2e runner specific overrides


tslint.json

type: boolean object array

description: Severity level. Level "error" will cause exit code 2.

enum: default error warning warn off none

default: default

description: Enforces vertical alignment.

enum: arguments elements members parameters statements

$ref: #/definitions/rule

description: An option value or an array of multiple option values.

description: Requires parentheses around the parameters of arrow function definitions.

description: Suggests to convert `() => { return x; }` to `() => x`.

description: Bans the use of specific functions or global methods.

description: Bans the comma operator.

description:
In a binary expression, a literal should always be on the right-hand side if possible.
For example, prefer 'x + 1' over '1 + x'.

description: Enforces PascalCased class and interface names.

description: Enforces formatting rules for single-line comments.

description: Enforces documentation for important items be filled out.

enum: classes enums enum-members functions interfaces methods namespaces properties types variables

enum: all exported internal

enum: all instance static

enum: all private protected public

description: Enforces braces for `if`/`for`/`do`/`while` statements.

enum: as-needed ignore-same-line

description: Enforces a threshold of cyclomatic complexity.

description: Warns when deprecated APIs are used.

description: Enforces UTF-8 file encoding.

description: Ensures the file ends with a newline.

description: Enforces a certain header comment for all files, matched by a regular expression.

description: Enforces a consistent file naming convention.

enum: camel-case pascal-case kebab-case snake-case

description: Requires a `for ... in` statement to be filtered with an `if` statement.

description:
Disallows importing the specified modules directly via `import` and `require`.
Instead only sub modules may be imported from that module.

description: Ensures proper spacing between import statement keywords

description: Enforces indentation with tabs or spaces.

description: Enforces basic format rules for JSDoc comments.

description: Only allows labels in sensible locations.

description: Enforces a consistent linebreak style.

description: A file may not contain more than the specified number of classes

description: Requires files to remain under a certain number of lines

description: Requires lines to be under a certain max length.

description: Enforces member ordering.

enum: static-field instance-field static-method instance-method constructor public-static-field public-static-method protected-static-field protected-static-method private-static-field private-static-method public-instance-field protected-instance-field private-instance-field public-constructor protected-constructor private-constructor public-instance-method protected-instance-method private-instance-method public-static-accessor protected-static-accessor private-static-accessor public-instance-accessor protected-instance-accessor private-instance-accessor

description: Enforces blank line before return when not the only line in the block.

description: Requires that chained method calls be broken apart onto separate lines.

description: Requires parentheses when invoking a constructor via the `new` keyword.

description: Disallows use of `arguments.callee`.

description: Disallows bitwise operators.

description: Disallows any type of assignment in conditionals.

description: Disallows one or more blank lines in a row.

description: Bans the use of specified `console` methods.

description: Disallows access to the constructors of `String`, `Number`, and `Boolean`.

description: Disallows `debugger` statements.

description: Disallows default exports in ES6-style modules.

description: Disallows multiple import statements from the same module.

description: Warns if 'super()' appears twice in a constructor.

description: Prevents duplicate cases in switch statements.

description: Disallows duplicate variable declarations in the same block scope.

description: Bans usage of the delete operator with computed key expressions.

description: Disallows empty blocks.

description: Disallows `eval` function invocations.

description:
Forbid for…in statements
https://palantir.github.io/tslint/rules/no-for-in/

description: Disallows iterating over an array with a for-in loop.

description: Disallows importing modules that are not listed as dependency in the project's package.json.

description: Avoid import statements with side-effect.

description: Warns on use of `${` in non-template strings.

description: Disallows using the `this` keyword outside of classes.

description: Disallow irregular whitespace outside of strings and comments

description:
Disallows the use constant number values outside of variable assignments.
When no list of allowed values is specified, -1, 0 and 1 are allowed by default.

description:
Forbid explicitly declared or implicitly returned union types with both null and undefined as members
https://palantir.github.io/tslint/rules/no-null-undefined-union/

description: Disallows use of the `null` keyword literal.

description: Disallows reassigning parameters.

description: Disallows `/// <reference path=>` imports (use ES6-style imports instead).

description: Disallows unnecessary `return await`.

description: Disallows invocation of `require()`.

description: Disallows shadowing variable declarations.

description: Forbids array literals to contain missing elements.

description:
Forbids unnecessary string literal property access.
Allows `obj["prop-erty"]` (can't be a regular property access).
Disallows `obj["property"]` (should be `obj.property`).

description: Flags throwing plain strings or concatenations of strings because only Errors produce proper stack traces.

description: Disallows importing any submodule.

description: Disallows falling through case statements.

description: Disallows unnecessary references to `this`.

description: Disallows trailing whitespace at the end of a line.

enum: ignore-comments ignore-jsdoc ignore-template-strings ignore-blank-lines

description:
Replaces `x => f(x)` with just `f`.
To catch more cases, enable `only-arrow-functions` and `arrow-return-shorthand` too.

description: Disallows classes that are not strictly necessary.

description: Forbids a 'var'/'let' statement or destructuring initializer to be initialized to 'undefined'.

description: Disallows control flow statements, such as `return`, `continue` `break` and `throws` in finally blocks.

description: Disallows unused expression statements.

description: Disallows usage of variables before their declaration.

description: Disallows usage of the `var` keyword.

description: Requires expressions of type `void` to appear in statement position.

description: Checks that decimal literals should begin with '0.' instead of just '.', and should not end with a trailing '0'.

description: Enforces consistent object literal property quote style.

enum: always as-needed consistent consistent-as-needed

description: Enforces use of ES6 object literal shorthand when possible.

description: Checks ordering of keys in object literals.

enum: ignore-case locale-compare match-declaration-order shorthand-first

description: Requires the specified tokens to be on the same line as the expression preceding them.

enum: check-catch check-finally check-else check-open-brace check-whitespace

description: Disallows multiple variable definitions in the same declaration statement.

description: Disallows traditional (non-arrow) function expressions.

description: Requires that import statements be alphabetized.

enum: case-insensitive case-insensitive-legacy lowercase-first lowercase-last any

description: Recommends to use a conditional expression instead of assigning to the same thing in each branch of an if statement.

description: Requires that variable declarations use `const` instead of `let` and `var` if possible.

description: Recommends a 'for-of' loop over a standard 'for' loop if the index is only used to access the array being iterated.

description: Warns for class methods that do not use 'this'.

description: Prefer `foo(): void` over `foo: () => void` in interfaces and types.

description: Enforces the use of the ES2015 object spread operator over `Object.assign()` where appropriate.

description: Prefer a `switch` statement to an `if` statement with simple `===` comparisons.

description: Prefer a template expression over string literal concatenation.

description: Prefer while loops instead of for loops without an initializer and incrementor.

description:
Force functions marked async contain an await or return statement
https://palantir.github.io/tslint/rules/no-async-without-await/

description: Requires any function or method that returns a promise to be marked async.

description: Requires single or double quotes for string literals.

enum: single double jsx-single jsx-double avoid-escape avoid-template

description: Requires the radix parameter to be specified when calling `parseInt`.

description: When adding two variables, operands must both be of type number or of type string.

description: Prefer `return;` in void functions and `return undefined;` in value-returning functions.

description: Enforces consistent semicolon usage at the end of every statement.

description: Require or disallow a space before function parenthesis

description: Enforces spaces within parentheses or disallow them.

description: Require a `default` case in all `switch` statements.

description: Checks whether the final clause of a switch statement ends in `break;`.

description: Requires or disallows trailing commas in array and object literals, destructuring assignments, function typings, named imports and exports and function parameters.

description: Option to forbid trailing comma after rest

description: Requires `===` and `!==` in place of `==` and `!=`.

description: Makes sure result of `typeof` is compared to correct string values

description: Enforces use of the `isNaN()` function to check for NaN references instead of a comparison to the `NaN` constant.

description: Checks variable names for various errors.

enum: check-format require-const-for-all-caps allow-leading-underscore allow-trailing-underscore allow-pascal-case allow-snake-case ban-keywords

description: Enforces whitespace style conventions.

enum: check-branch check-decl check-operator check-module check-separator check-rest-spread check-type check-typecast check-type-operator check-preblock check-postbrace

description: Enforces function overloads to be consecutive.

description: Bans "// @ts-ignore" comments from being used.

description: Requires using either 'T[]' or 'Array<T>' for arrays.

description: Warns for an awaited value that is not a Promise.

description: Bans specific types from being used. Does not ban the corresponding runtime objects from being used.

description: An interface or literal type with just a call signature can be written as a function type.

description: Requires interface names to begin with a capital 'I'

description: Prefer an interface declaration over a type literal (`type T = { ... }`)

description:
Requires that a default import have the same name as the declaration it imports.
Does nothing for anonymous default exports.

description: Requires explicit visibility declarations for class members.

enum: no-public check-accessor check-constructor check-parameter-property

description: Requires the use of `as Type` for type assertions instead of `<Type>`.

description: Disallows usages of `any` as a type declaration.

description: Warns on comparison to a boolean literal, as in `x === true`.

description: Forbids empty interfaces.

description: Promises returned by functions must be handled appropriately.

description: Disallows explicit type declarations for variables or parameters initialized to a number, string, or boolean.

description: Disallow type inference of {} (empty object type) at function and constructor call sites

description: Disallows internal `module`

description: Disallows mergeable namespaces in the same file.

description: Warns on apparent attempts to define constructors for interfaces or `new` for classes.

description: Disallows use of internal `module`s and `namespace`s.

description: Disallows non-null assertions.

description:
Forbids an object literal to appear in a type assertion expression.
Casting to `any` is still allowed.

description: Disallows parameter properties in class constructors.

description: Forbids JSDoc which duplicates TypeScript functionality.

description: Don't `<reference types="foo" />` if you import `foo` anyway.

description: Warns when a method is used as outside of a method call.

description: Warns when a namespace qualifier (`A.x`) is unnecessary.

description: Warns if a type assertion does not change the type of an expression.

description:
Warns when using an expression of type 'any' in a dynamic way.
Uses are only allowed if they would work for `{} | null | undefined`.
Type casts and tests are allowed.
Expressions that work on all values (such as `"" + x`) are allowed.

description: Disallows unused imports, variables, functions and private class members. Similar to tsc's --noUnusedParameters and --noUnusedLocals options, but does not interrupt code compilation.

description: Disallows the use of require statements except in import statements.

description: Requires that private variables are marked as `readonly` if they're never modified outside of the constructor.

description:
Restricts the types allowed in boolean expressions. By default only booleans are allowed.

The following nodes are checked:
* Arguments to the `!`, `&&`, and `||` operators
* The condition in a conditional expression (`cond ? x : y`)
* Conditions for `if`, `for`, `while`, and `do-while` statements.

enum: allow-null-union allow-undefined-union allow-string allow-enum allow-number allow-mix allow-boolean-or-undefined ignore-rhs

description:
Warns for type predicates that are always true or always false.
Works for 'typeof' comparisons to constants (e.g. 'typeof foo === "string"'), and equality comparison to 'null'/'undefined'.
(TypeScript won't let you compare '1 === 2', but it has an exception for '1 === undefined'.)
Does not yet work for 'instanceof'.
Does *not* warn for 'if (x.y)' where 'x.y' is always truthy. For that, see strict-boolean-expressions.

This rule requires `strictNullChecks` to work properly.

description: Requires type definitions to exist.

enum: call-signature arrow-call-signature parameter arrow-parameter property-declaration variable-declaration member-variable-declaration object-destructuring array-destructuring

description: Requires or disallows whitespace for type definitions.

description:
Checks that type literal members are separated by semicolons.
Enforces a trailing semicolon for multiline type literals.

description: Warns for any two overloads that could be unified into one by using a union or an optional/rest parameter.

description: Warns if an explicitly specified type argument is the default for that type parameter.

description: Prevents using the built-in Function constructor.

description: The name of a built-in configuration preset, or a path or array of paths to other configuration files which are extended by this configuration. These values are handled using node module resolution semantics.

description: A path to a directory or an array of paths to directories of custom rules. These values are handled using node module resolution semantics, if an `index.js` is placed in your rules directory.

description: A map of rules that will be used to lint TypeScript files. These rules apply to `.ts` and `.tsx` files.

description: A map of rules that will be used to lint JavaScript files. These rules apply to `.js` and `.jsx` files.

description: The severity level used when a rule specifies "default" as its severity level. If undefined, "error" is used.

description: Additional linter options.

description: An array of globs. Any file matching these globs will not be linted. All exclude patterns are relative to the configuration file they were specified in.

title: JSON schema for the TSLint configuration files.


project.json

title: compilation options

description: [Deprecated] Options that are passed to the compiler. Use 'buildOptions' instead.

enum: portable full

title: build options

description: Options that are passed to the compiler.

enum: portable full none

description: Set this option to preserve reference assemblies and other context data to allow for runtime compilation.

default: csc

description: Defines glob patterns and file path to include for compilation.

type: string array object

description: List of file globbing patterns to be included.

description: List of file globbing patterns to be excluded.

description: List of file paths to be included.

description: List of file paths to be excluded.

title: mapping options

description: Pairs of destination folders and glob patterns specifying additional files to include/exclude.

description: Defines glob patterns and file paths of resource files to include for compilation.

description: Defines glob patterns and file paths to include for copying to build output.

title: runtime options

title: config options

description: Enables/disables server garbage collection.

description: Enables/disables concurrent garbage collection.

type: integer

description: Limits the number of heaps created by the garbage collector.

description: Specifies the exact processors that garbage collector threads should use.

description: Specifies the list of processors to use for garbage collector threads.

description: Specifies whether to affinitize garbage collection threads with processors. To affinitize a GC thread means that it can only run on its specific CPU. A heap is created for each GC thread.

description: Specifies the maximum commit size, in bytes, for the GC heap and GC bookkeeping.

description: Specifies the GC heap usage as a percentage of the total memory.

description: Configures whether segments that should be deleted are put on a standby list for future use or are released back to the operating system (OS).

description: Specifies the threshold size, in bytes, that causes objects to go on the large object heap (LOH).

description: Sets the minimum number of threads for the thread pool.

description: Sets the maximum number of threads for the thread pool.

title: framework options

description: Properties of the shared framework to use when activating the application.

description: Determines if the framework version is strictly obeyed by the host.

title: pack options

description: Defines options pertaining to the packaging of the project output into a NuGet package.

description: A short description of the package.

description: List of owners of the package.

description: A link to the license for the package.

title: repository options

default: git

format: uri

description: Defines glob patterns and file paths to include in the generated NuGet package.

description: Defines glob patterns and file paths to include in publish output.

title: config options

$ref: #/definitions/dependencies

$ref: #/definitions/compilationOptions

$ref: #/definitions/buildOptions

description: Allow packages supporting these frameworks to be installed in this target, regardless of the compatibility rules.

enum: all runtime compile build contentFiles native analyzers none

title: dependency options

description: Restrict this dependency to matching only a Project or a Package.

description: Each dependency is defined by a name and a version. Dependencies are resolved from NuGet feeds defined by your package sources and projects located in the directories specified by the 'global.json' file.

description:
A command line script or scripts.

Available variables:
%project:Directory% - The project directory
%project:Name% - The project name
%project:Version% - The project version

description: The author of the application.

title: path options

description: [Deprecated] Pairs of destination folders and glob patterns specifying additional files to include in the output NuGet package. (data type: JSON map). Example: { "tools/": "tools/**/*.*" }. Use 'files' in 'packOptions' instead.

description: [Deprecated] Glob pattern to specify files to exclude from publish output. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]. Use 'publishOptions' instead.

description: [Deprecated] Glob pattern to specify files to compile. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]. Use 'compile' in 'buildOptions' instead.

description: [Deprecated] Glob pattern to specify files to exclude from compilation. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]. Use 'compile' in 'buildOptions' instead.

description: [Deprecated] Files to include in compilation (overrides 'compileExclude'). (data type: string or array). Example: [ "Folder1/File1.ext", "Folder2/File2.ext" ]. Use 'compile' in 'buildOptions' instead.

description: [Deprecated] Glob pattern to specify files to include as content. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]. Use 'publishOptions' to publish or 'copyToOutput' in 'buildOptions' to copy to build output instead.

description: [Deprecated] Glob pattern to specify files to exclude from the content list. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]. Use 'publishOptions' to publish or 'copyToOutput' in 'buildOptions' to copy to build output instead.

description: [Deprecated] Files to include as content (overrides 'contentExclude'). (data type: string or array). Example: [ "Folder1/File1.ext", "Folder2/File2.ext" ]. Use 'publishOptions' to publish or 'copyToOutput' in 'buildOptions' to copy to build output instead.

description: Glob pattern to specify files to use for preprocessing. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]

description: Glob pattern to specify files to exclude from use for preprocessing. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]

description: Files to include to use for preprocessing (overrides 'preprocessExclude'). (data type: string or array). Example: [ "Folder1/File1.ext", "Folder2/File2.ext" ]

description: [Deprecated] Glob pattern to specify files to include as resources. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]. Use 'embed' in 'buildOptions' instead.

description: [Deprecated] Glob pattern to specify files to exclude from the resources list. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]. Use 'embed' in 'buildOptions' instead.

description: [Deprecated] Files to include as resources (overrides 'resourceExclude'). (data type: string or array). Example: [ "Folder1/File1.ext", "Folder2/File2.ext" ]. Use 'embed' in 'buildOptions' instead.

description: Glob pattern to specify files to share with dependent projects. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]

description: Glob pattern to specify files to exclude from sharing with dependent projects. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]

description: Files to include for sharing with dependent projects (overrides 'sharedExclude'). (data type: string or array). Example: [ "Folder1/File1.ext", "Folder2/File2.ext" ]

description: [Deprecated] Glob pattern to indicate files to exclude from other glob patterns, in addition to the default patterns specified in 'excludeBuiltIn'. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]. Use 'exclude' within 'compile' or 'embed' instead.

description: [Deprecated] Default glob pattern to indicate files to exclude from other glob patterns. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]. Use 'exclude' within 'compile' or 'embed' instead.

description: The name of the test runner to use with this project

title: command options

title: configuration options

description: Configurations are named groups of compilation settings. There are two defaults built into the runtime: 'Debug' and 'Release'.

title: additional options

description: Copyright details for the package.

description: [Deprecated] A URL for the image to use as the icon for the package. This should be a 32x32-pixel .png file that has a transparent background. Use this in 'packOptions' instead.

description: [Deprecated] A link to the license for the package. Use this in 'packOptions' instead.

description: [Deprecated] A Boolean value that specifies whether the client needs to ensure that the package license (described by licenseUrl) is accepted before the package is installed. Use this in 'packOptions' instead.

description: [Deprecated] List of owners of the package. Use this in 'packOptions' instead.

description: A URL for the home page of the package.

description: [Deprecated] A short description of the package. Use this in 'packOptions' instead.

description: [Deprecated] A space-delimited list of tags and keywords that describe the package. Use this in 'packOptions' instead.

description: The human-friendly title of the package

description: [Deprecated] A description of the changes made in each release of the package. Use this in 'packOptions' instead.

description: The locale ID for the package, such as en-us.

description: The description of the project/package.

title: framework options

description: Target frameworks that will be built, and dependencies that are specific to the build of this project for that framework.

title: resource options

description: Overrides the generated resource names with custom ones.

title: repository options

description: [Deprecated] Contains information about the repository where the project is stored. Use this in 'packOptions' instead.

title: script options

description: Scripts to execute during the various stages.

description: The version of the project/package. Examples: 1.2.3, 1.2.3-beta, 1.2.3-*

title: tool options

description: Project-specific command line tools accessible when in the project.json directory.

title: runtime options

description: List of runtime identifiers supported by this project (used when building standalone applications).

description: Specify a unique identifier for the development time user secrets of the project.

title: JSON schema for .NET Core project.json files


markdownlint-config-schema.json

title: Markdownlint configuration schema

description: Default state for all rules

description: Path to configuration file to extend

description: JSON Schema URI (used by some editors)

description: MD001/heading-increment/header-increment - Heading levels should only increment by one level at a time

description: MD002/first-heading-h1/first-header-h1 - First heading should be a top-level heading

type: boolean object

description: Heading level

description: MD003/heading-style/header-style - Heading style

description: Heading style

default: consistent

description: MD004/ul-style - Unordered list style

description: List style

enum: consistent asterisk plus dash sublist

description: MD005/list-indent - Inconsistent indentation for list items at the same level

description: MD006/ul-start-left - Consider starting bulleted lists at the beginning of the line

description: MD007/ul-indent - Unordered list indentation

description: Spaces for indent

description: Whether to indent the first level of the list

description: Spaces for first level indent (when start_indented is set)

description: MD009/no-trailing-spaces - Trailing spaces

description: Spaces for line break

description: Allow spaces for empty lines in list items

description: Include unnecessary breaks

description: MD010/no-hard-tabs - Hard tabs

description: Include code blocks

description: Fenced code languages to ignore

description: Number of spaces for each hard tab

description: MD011/no-reversed-links - Reversed link syntax

description: MD012/no-multiple-blanks - Multiple consecutive blank lines

description: Consecutive blank lines

description: MD013/line-length - Line length

description: Number of characters

description: Number of characters for headings

description: Number of characters for code blocks

description: Include code blocks

description: Include tables

description: Include headings

description: Include headings

description: Strict length checking

description: Stern length checking

description: MD014/commands-show-output - Dollar signs used before commands without showing output

description: MD018/no-missing-space-atx - No space after hash on atx style heading

description: MD019/no-multiple-space-atx - Multiple spaces after hash on atx style heading

description: MD020/no-missing-space-closed-atx - No space inside hashes on closed atx style heading

description: MD021/no-multiple-space-closed-atx - Multiple spaces inside hashes on closed atx style heading

description: MD022/blanks-around-headings/blanks-around-headers - Headings should be surrounded by blank lines

description: Blank lines above heading

type: integer array

description: Blank lines below heading

description: MD023/heading-start-left/header-start-left - Headings must start at the beginning of the line

description: MD024/no-duplicate-heading/no-duplicate-header - Multiple headings with the same content

description: Only check sibling headings

description: Only check sibling headings

description: MD025/single-title/single-h1 - Multiple top-level headings in the same document

description: Heading level

description: RegExp for matching title in front matter

description: MD026/no-trailing-punctuation - Trailing punctuation in heading

description: Punctuation characters

description: MD027/no-multiple-space-blockquote - Multiple spaces after blockquote symbol

description: MD028/no-blanks-blockquote - Blank line inside blockquote

description: MD029/ol-prefix - Ordered list item prefix

description: List style

enum: one ordered one_or_ordered zero

description: MD030/list-marker-space - Spaces after list markers

description: Spaces for single-line unordered list items

description: Spaces for single-line ordered list items

description: Spaces for multi-line unordered list items

description: Spaces for multi-line ordered list items

description: MD031/blanks-around-fences - Fenced code blocks should be surrounded by blank lines

description: Include list items

description: MD032/blanks-around-lists - Lists should be surrounded by blank lines

description: MD033/no-inline-html - Inline HTML

description: Allowed elements

description: MD034/no-bare-urls - Bare URL used

description: MD035/hr-style - Horizontal rule style

description: Horizontal rule style

description: MD036/no-emphasis-as-heading/no-emphasis-as-header - Emphasis used instead of a heading

description: Punctuation characters

description: MD037/no-space-in-emphasis - Spaces inside emphasis markers

description: MD038/no-space-in-code - Spaces inside code span elements

description: MD039/no-space-in-links - Spaces inside link text

description: MD040/fenced-code-language - Fenced code blocks should have a language specified

description: List of languages

description: Require language only

description: MD041/first-line-heading/first-line-h1 - First line in a file should be a top-level heading

description: Heading level

description: MD042/no-empty-links - No empty links

description: MD043/required-headings/required-headers - Required heading structure

description: List of headings

description: List of headings

description: Match case of headings

description: MD044/proper-names - Proper names should have the correct capitalization

description: List of proper names

description: Include code blocks

description: Include HTML elements

description: MD045/no-alt-text - Images should have alternate text (alt text)

description: MD046/code-block-style - Code block style

description: Block style

description: MD047/single-trailing-newline - Files should end with a single newline character

description: MD048/code-fence-style - Code fence style

description: Code fence style

description: MD049/emphasis-style - Emphasis style should be consistent

description: Emphasis style

description: MD050/strong-style - Strong style should be consistent

description: Strong style

description: MD051/link-fragments - Link fragments should be valid

description: MD052/reference-links-images - Reference links and images should use a label that is defined

description: MD053/link-image-reference-definitions - Link and image reference definitions should be needed

description: Ignored definitions

description: headings - MD001, MD002, MD003, MD018, MD019, MD020, MD021, MD022, MD023, MD024, MD025, MD026, MD036, MD041, MD043

description: headers - MD001, MD002, MD003, MD018, MD019, MD020, MD021, MD022, MD023, MD024, MD025, MD026, MD036, MD041, MD043

description: bullet - MD004, MD005, MD006, MD007, MD032

description: ul - MD004, MD005, MD006, MD007, MD030, MD032

description: indentation - MD005, MD006, MD007, MD027

description: whitespace - MD009, MD010, MD012, MD027, MD028, MD030, MD037, MD038, MD039

description: hard_tab - MD010

description: links - MD011, MD034, MD039, MD042, MD051, MD052, MD053

description: blank_lines - MD012, MD022, MD031, MD032, MD047

description: line_length - MD013

description: code - MD014, MD031, MD038, MD040, MD046, MD048

description: atx - MD018, MD019

description: spaces - MD018, MD019, MD020, MD021, MD023

description: atx_closed - MD020, MD021

description: blockquote - MD027, MD028

description: ol - MD029, MD030, MD032

description: html - MD033

description: url - MD034

description: hr - MD035

description: emphasis - MD036, MD037, MD049, MD050

description: language - MD040

description: spelling - MD044

description: accessibility - MD045

description: images - MD045, MD052, MD053


description: A news item as JSON object -- copyright 2020 IPTC - International Press Telecommunications Council - www.iptc.org - This document is published under the Creative Commons Attribution 4.0 license, see  http://creativecommons.org/licenses/by/4.0/

title: Description

description: A free-form textual description of the content of the item. (The string appended to description_ in the property name should reflect the format and/or the purpose of the text, separating the parts with _). nar:description

title: Body

description: The textual content of the news object. (The string appended to body_ in the property name should reflect the format and/or the purpose of the text, separating the parts with _). nar:inlineData or nar:inlineXML

title: Extra headlines

description: Additional headlines or strings of that type can be handled here. This is not replacing the main headline-property in ninjs. (The string appended to headline_ in the property name should reflect the format and/or the purpose of the text, separating the parts with _) nar:headline with roles issue #13. (Added in 1.3)

title: Uniform Resource Identifier

description: The identifier for this news object. nar:newsItem@guid

title: Type

description: The generic news type of this news object. (Value 'component' added in version 1.2 as issue #21.). nar:itemClass

enum: text audio video picture graphic composite component

title: MIME type

description: A MIME type which applies to this news object. nar:contentType

title: Representation type

description: Indicates how complete this representation of a news item is. No mapping to nar. Specific for ninjs.

enum: complete incomplete

title: Profile

description: An identifier for the structure of the news object. This can be any string but we suggest something identifying the structure of the content such as 'text-only' or 'text-photo'. Profiles are typically provider-specific. nar:profile

title: Version

description: The version of the news object which is identified by the uri property. nar:newsItem@version

title: First created

description: Indicates when the first version of the item was created. (Added in version 1.2 from issue #5). nar:firstCreated

format: date-time

title: Version created

description: The date and time when this version of the news object was created. nar:versionCreated

title: Embargoed

description: The date and time before which all versions of the news object are embargoed. If absent, this object is not embargoed. nar:embargoed

title: Publication status

description: The publishing status of the news object, its value is *usable* by default. nar:pubStatus

enum: usable withheld canceled

title: Urgency

description: The editorial urgency of the content from 1 to 9. 1 represents the highest urgency, 9 the lowest. nar:urgency

title: Copyright holder

description: The person or organisation claiming the intellectual property for the content. nar:copyrightHolder

title: Copyright notice

description: Any necessary copyright notice for claiming the intellectual property for the content. nar:copyrightNotice

title: Usage terms

description: A natural-language statement about the usage terms pertaining to the content. nar:usageTerms

title: Editorial note

description: A note that is intended to be read by internal staff at the receiving organisation, but not published to the end-user. (Added in version 1.2 from issue #6.) . ednote: nar:edNote

title: Language

description: The human language used by the content. The value should follow IETF BCP47. nar:language

title: Person

description: An individual human being. nar:subject

title: Name

description: The name of a person

title: Relationship

description: The relationship of the content of the news object to the person

title: Scheme

description: The identifier of a scheme (= controlled vocabulary) which includes a code for the person

title: Code

description: The code for the person in a scheme (= controlled vocabulary) which is identified by the scheme property

title: Organisation

description: An administrative and functional structure which may act as as a business, as a political party or not-for-profit party. nar:subject

title: Name

description: The name of the organisation

title: Relationship

description: The relationship of the content of the news object to the organisation

title: Scheme

description: The identifier of a scheme (= controlled vocabulary) which includes a code for the organisation

title: Code

description: The code for the organisation in a scheme (= controlled vocabulary) which is identified by the scheme property

title: Symbols

description: Symbols used for a financial instrument linked to the organisation at a specific market place

title: Ticker

description: Ticker symbol used for the financial instrument

title: Exchange

description: Identifier for the marketplace which uses the ticker symbols of the ticker property

title: Place

description: A named location. nar:subject

description: An object holding geo data of this place. Could be of any relevant geo data JSON object definition.

title: Name

description: The name of the place

title: Relationship

description: The relationship of the content of the news object to the place

title: Scheme

description: The identifier of a scheme (= controlled vocabulary) which includes a code for the place

title: Code

description: The code for the place in a scheme (= controlled vocabulary) which is identified by the scheme property

title: Subject

description: A concept with a relationship to the content. nar:subject

title: Name

description: The name of the subject

title: Relationship

description: The relationship of the content of the news object to the subject

title: Scheme

description: The identifier of a scheme (= controlled vocabulary) which includes a code for the subject

title: Code

description: The code for the subject in a scheme (= controlled vocabulary) which is identified by the scheme property

title: Event

description: Something which happens in a planned or unplanned manner. nar:?

title: Name

description: The name of the event

title: Relationship

description: The relationship of the content of the news object to the event

title: Scheme

description: The identifier of a scheme (= controlled vocabulary) which includes a code for the event

title: Code

description: The code for the event in a scheme (= controlled vocabulary) which is identified by the scheme property

title: Object

description: Something material, excluding persons. nar:subject

title: Name

description: The name of the object

title: Relationship

description: The relationship of the content of the news object to the object

title: Scheme

description: The identifier of a scheme (= controlled vocabulary) which includes a code for the object

title: Code

description: The code for the object in a scheme (= controlled vocabulary) which is identified by the scheme property

title: Info source

description: A party (person or organisation) which originated, modified, enhanced, distributed, aggregated or supplied the content or provided some information used to create or enhance the content. (Added in version 1.2 according to issue #15.) .    infosource:  nar:infoSource

title: Name

description: The name of the infosource

title: Relationship

description: The relationship of the content of the news object to the infosource

title: Schema

description: The identifier of a scheme (= controlled vocabulary) which includes a code for the infosource

title: Code

description: The code for the infosource in a scheme (= controlled vocabulary) which is identified by the scheme property

title: Title

description: A short natural-language name for the item. (Added in version 1.2 according to issue #9). nar:itemMeta/title

title: Byline

description: The name(s) of the creator(s) of the content. nar:by

title: Headline

description: A brief and snappy introduction to the content, designed to catch the reader's attention. nar:headline

title: Slugline

description: A human-readable identifier for the item. (Added in version 1.2 from issue #4.). nar:slugline

title: Located

description: The name of the location from which the content originates. nar:located

title: Character count

description: The total character count in the article excluding figure captions. (Added in version 1.2 according to issue #27.). nar:charcount

title: Word count

description: The total number of words in the article excluding figure captions. (Added in version 1.2 according to issue #27.). nar:wordcount

title: Renditions

description: Wrapper for different renditions of the news object. nar:remoteContent

description: A specific rendition of the content of the news object. (Description changed in version 1.2 according to issue #17.)

title: href

description: The URL for accessing the rendition as a resource. nar:remoteContent@ref

title: mimetype

description: A MIME type which applies to the rendition. nar:remoteContent@contenttype

title: Title

description: A title for the link to the rendition resource

title: Height

description: For still and moving images: the height of the display area measured in pixels. nar:remoteContent@height

title: Width

description: For still and moving images: the width of the display area measured in pixels. nar:remoteContent@width

title: Size in bytes

description: The size of the rendition resource in bytes

title: Duration

description: The total time duration of the content in seconds. (Added in version 1.2. Issue #18). nar:remoteContent@duration

title: Format

description: Binary format name. (Added in version 1.2. Issue #18). nar:remoteContent@format

description: Content of news objects which are associated with this news object. nar:link

title: Alternative id

description: Alternative identifiers of the item. It is up to the individual provider to name and set type on the alternative identifiers they like to use. nar:altId issue #3. (Added in version 1.3)

title: Trust indicator

description: An array of objects to allow links to documents about trust indicators. (nar:link) issue #44. (Added in version 1.3)

title: Scheme

description: The identifier of a scheme (= controlled vocabulary) which includes a code for the trust indicator

title: Code

description: The code for the trust indicator in a scheme (= controlled vocabulary) which is identified by the scheme property

title: Title

description: The title of the resource being referenced.

title: href

description: The URL for accessing the trust indicator resource.

title: Standard

description: An object with information about standard, version and schema this instance is valid against. nar:standard, nar:standardversion and xml:schema issue #43. (Added in version 1.3)

title: Name of standard.

description: For example ninjs. nar:standard

title: Version of standard.

description: For example 1.3. nar:standardversion

title: Schema

description: The uri of the json schema to use for validation.

title: Genre

description: A nature, intellectual or journalistic form of the content. nar:genre. (Added in version 1.3)

title: Name

description: The name of the genre

title: Scheme

description: The identifier of a scheme (= controlled vocabulary) which includes a code for the genre. Normally  http://cv.iptc.org/newscodes/genre/

title: Code

description: The code for the genre in a scheme (= controlled vocabulary) which is identified by the scheme property

title: IPTC ninjs - News in JSON - 1.3 (approved, 13 May 2020)


comet.json

const: string

description: Any string that match the '.*' regex

const: long

description:
Any whole number that match the '[-|+|0-9][0-9]*' regex.
ints are mapped to as 'int' in some database whereas 'longs are mapped as 'bigint' and shorts as 'smallint'

const: int

const: short

const: double

description: Any decimal number that match the '[-+]?\d*\.?\d+[Ee]?[-+]?\d*' regex

const: boolean

description:
Any string that match the '(?i)true|yes|[y1]<-TF->(?i)false|no|[n0]' regex,
where the value on the left of '<-T' represent true and values on the right of 'F->' represent the false

const: byte

description: Any single char

const: date

description: Any date that match the 'yyyy-MM-dd' regex (2023-12-31)

description: Any date that match the 'yyyyMMdd' regex (20231231)

description: Timestamp based on `ISO Date with offset` pattern (2023-12-31+02:00)

description: Timestamp based on `ISO Date with or without offset` pattern (2011-12-03+02:00)

description: Timestamp based on `ISO Local Date and Time` pattern (2023-12-31T10:15:30)

description: Timestamp based on `ISO Local Date and Time` pattern (2023-12-31T10:15:30+01:00)

description: Timestamp based on `ISO Zoned Date Time`pattern (2023-12-31T10:15:30+01:00[Europe/Paris])

description: Timestamp based on `ISO Date and time with ZoneId` pattern (2011-12-03T10:15:30+01:00[Europe/Paris])

description: Timestamp based on `year and day of year` pattern (2023-337)

description: Timestamp based on `Year and Week` pattern (2012-W48-6)

description: Timestamp based on `Date and Time of an Instant` pattern - UTC only - (2023-12-31T10:15:30Z)

description: Timestamp based on `RFC 1123 / RFC 822` patterns (Tue, 3 Jun 2008 11:05:30 GMT)

const: timestamp

description:
date/time that match the 'yyyy-MM-dd HH:mm:ss' regex s (2019-12-31 23:59:02).
For epoch timestamp, set pattern attribute to 'epoch_second' or 'epoch_milli'

const: decimal

description: Any floating value that match the '-?\d*\.{0,1}\d+' regex

const: struct

description: Any attribute that has children. Set the array to true if this attribute is made of a list of attributes

const: text

const: keyword

const: integer

const: float

const: binary

const: ip

const: completion

const: object

const: array

description: Append to or overwrite existing data

const: OVERWRITE

description: That data will overwrite the existing data or create it if it does not exist

const: APPEND

description: Append the data to an existing table or create it if it does not exist

description: Fail if teh table already exist

const: IGNORE

description: Do not save at all. Useful in interactive / test mode.

const: SA

description: Service account

const: USER

description: End user

const: GROUP

description: Group of users / service accounts

const: LEFT

description: Remove all leading space chars from the input

const: RIGHT

description: Remove all trailing spaces from the input

const: BOTH

description: Remove all leading and trailing spaces from the input

description: Do not remove leading or trailing spaces from the input

description: DDL used to create a table

description: SQL CREATE DDL statement

description:
How to test if the table exist.
Use the following statement by default: 'select count(*) from tableName where 1=0'

description: Table types supported by the Extract module

const: TABLE

description: SQl Table

const: VIEW

description: SQl View

const: SYSTEM TABLE

description: Database specific system table

const: GLOBAL TEMPORARY

const: LOCAL TEMPORARY

const: ALIAS

description: Table alias

const: SYNONYM

description: Table synonym

description: Custom type definition. Custom types are defined in the types/types.comet.yml file

description: unique id for this type

$ref: #/definitions/PrimitiveType

description:
To what primitive type should this type be mapped.
 This is the memory representation of the type, When saving, this primitive type is mapped to the database specific type

description: Regex used to validate the input field

description:
useful when parsing specific string:
 - double: To parse a french decimal (comma as decimal separator) set it to fr_FR locale.
- decimal: to set the precision and scale of this number, '38,9' by default.
-

description: This field makes sure that the pattern matches the value you want to match. This will be checked on startup

description: Describes this type

description: How this type is indexed in your datawarehouse

$ref: #/definitions/MapString

description: Configure here the type mapping for each datawarehouse.\nWill be used when inferring DDL from schema.

required: name pattern primitiveType

description: Partition columns, no partitioning by default

description: 0.0 means no sampling, > 0  && < 1 means sample dataset, >=1 absolute number of partitions. Used exclusively on Hadoop & databricks warehouses

description: Attributes used to partition de dataset.

description: Zero based position of the first character for this attribute

description: Zero based position of the last character to include in this attribute

required: first last

description: Connection

description: aka jdbc, bigquery, snowflake, redshift ...

description: Set only if you want to use the Spark engine

$ref: #/definitions/WriteMode

description: Used for JDBC connections only. Write mode, APPEND by default

description: Connection options

description: Row level security policy to apply to the output data.

description: This Row Level Security unique name

description: Description for this access policy

description: The condition that goes to the WHERE clause and limit the visible rows.

description:
user / groups / service accounts to which this security level is applied.
ex : user:me@mycompany.com,group:group@mycompany.com,serviceAccount:mysa@google-accounts.com

required: name grants

description: Column level security policy to apply to the attribute.

description: This role to give to the granted users

required: role grants

description: list of attributes to join an existing and incoming dataset. Use renamed columns if any here.

description: Optional valid delete condition on the incoming dataset. Use renamed column here.

description: Timestamp column used to identify last version, if not specified currently ingested row is considered the last

description:
Useful when you want to merge only on a subset of the existing partitions, thus improving performance and reducing costs.
You may use here:
- Any SQL condition
- latest which will be translated to the last existing partition
- column in last(10) which will apply the merge on the last 10 partitions of your dataset.
 last and latest assume that your table is partitioned by day.

description: DSV by default. Supported file formats are :\n- DSV : Delimiter-separated values file. Delimiter value is specified in the "separator" field.\n- POSITION : FIXED format file where values are located at an exact position in each line.\n- SIMPLE_JSON : For optimisation purpose, we differentiate JSON with top level values from JSON\n  with deep level fields. SIMPLE_JSON are JSON files with top level fields only.\n- JSON :  Deep JSON file. Use only when your json documents contain sub-documents, otherwise prefer to\n  use SIMPLE_JSON since it is much faster.\n- XML : XML files

const: DSV

description: any single or multiple character delimited file. Separator is specified in the separator field

const: POSITION

description: any fixed position file. Positions are specified in the position field

const: JSON

description:
any deep json file.
To improve performance, prefer the SIMPLE_JSON format if your json documents are flat

description: any json file containing an array of json objects.

description:
any flat json file.
To improve performance, prefer this format if your json documents are flat

const: XML

description: any xml file. Use the metadata.xml.rowTag field to specify the root tag of your xml file

description: Map of string

description: Map of connections

description: Map of jdbc engines

description: Map of table ddl

description: Jdbc engine

description:
List of all SQL create statements used to create audit tables for this JDBC engine.
Tables are created only if the execution of the pingSQL statement fails

description:
Privacy strategies. The following default strategies are defined by default:
- none: Leave the data as is
- hide: replace the data with an empty string
- hideX("s", n): replace the string with n occurrences of the string 's'
- md5: Redact the data using the MD5 algorithm
- sha1: Redact the data using the SHA1 algorithm
- sha256: Redact the data using the SHA256 algorithm
 - sha512: Redact the data using the SHA512 algorithm
- initials: keep only the first char of each word in the data

description: configure Spark internal options

description:
How the RDD are cached. Default is MEMORY_AND_DISK_SER.
Available options are (https://spark.apache.org/docs/latest/api/java/index.html?org/apache/spark/storage/StorageLevel.html):
- MEMORY_ONLY
- MEMORY_AND_DISK
- MEMORY_ONLY_SER
- MEMORY_AND_DISK_SER
- DISK_ONLY
- OFF_HEAP

description:
May be parquet or ORC. Default is parquet. Used for BigQuery intermediate storage. Use ORC for for JSON files to keep the original data structure.
https://stackoverflow.com/questions/53674838/spark-writing-parquet-arraystring-converts-to-a-different-datatype-when-loadin

description: The GCS bucket that temporarily holds the data before it is loaded to BigQuery.

description: Internal use. Do not modify.

description: Should access policies be enforced ?

description: GCP project location. Required if apply is true.

description: GCP Project id. Required if apply is true.

description: Taxonomy name. Required if apply is true.

description: Max number of Spark jobs to run in parallel, default is 1

description: Pool name to use for Spark jobs, default is 'default'

description: This can be FIFO or FAIR, to control whether jobs within the pool queue up behind each other (the default) or share the pool’s resources fairly.

description: Scheduler filename in the metadata folder. If not set, defaults to fairscheduler.xml.

description: When using filesystem storage, the path to the expectations file

description: should expectations be executed ?

description: When using filesystem storage, the path to the metrics file

description: Max number of unique values accepted for a discrete column. Default is 10

description: Should metrics be computed ?

description: spark  options to use

description: ES: Attribute to use as id of the document. Generated by Elasticsearch if not specified.

description: ES or BQ: The timestamp column to use for table partitioning if any. No partitioning by default\nES:Timestamp field format as expected by Elasticsearch ("{beginTs|yyyy.MM.dd}" for example).

description: BQ: Database location (EU, US, ...)

description: FS or BQ: List of attributes to use for clustering

description: BQ: Number of days before this table is set as expired and deleted. Never by default.

description: BQ: Should be require a partition filter on every request ? No by default.

description: BQ: Should we materialize as a table or as a view when saving the results ? false by default.

description: BQ: Enable automatic refresh of materialized view ? false by default.

description: BQ: Refresh interval in milliseconds. Default to BigQuery default value

description: FS: File format

description: FS: File extension

description: FS or BQ: List of partition attributes

description: JDBC: Connection String

description: When outputting files, should we coalesce it to a single file. Useful when CSV is the output format.

description: UTF-8 if not specified.

description: are json objects on a single line or multiple line ? Single by default.  false means single. false also means faster

description: Is the json stored as a single object array ? false by default. This means that by default we have on json document per line.

description: does the dataset has a header ? true bu default

description: the values delimiter,  ';' by default value may be a multichar string starting from Spark3

description: The String quote char, '"' by default

description: escaping char '\' by default

description: Write mode, APPEND by default

description: Pattern to ignore or UDF to apply to ignore some lines

description: com.databricks.spark.xml options to use (eq. rowTag)

description:
Folder on the local filesystem where incoming files are stored.
 Typically, this folder will be scanned periodically to move the dataset to the cluster for ingestion.
                     Files located in this folder are moved to the pending folder for ingestion by the "import" command.

description:
recognized filename extensions. json, csv, dsv, psv are recognized by default.
Only files with these extensions will be moved to the pending folder.

description:
Ack extension used for each file. ".ack" if not specified.
Files are moved to the pending folder only once a file with the same name as the source file and with this extension is present.
To move a file without requiring an ack file to be present, set explicitly this property to the empty string value "".

description: Options to add to the spark reader

description: Validator to use, 'spark' or 'native'. Default to 'spark' of SL_VALIDATOR env variable is set to 'native'

description: Treat empty columns as null in DSV files. Default to false

description: Treat a specific input string as a null value indicator

description: Configure freshness checks on this dataset

description: Cron expression to use for this domain/table

description: Schema in JDBC Database / Snowflake / Redshift or Dataset in BigQuery

description: Tables to scan in this domain

description: DAG reference

description: Database name of Project id in BigQuery

description: List of domains to scan

description: Files recognized by the extensions property are moved to this folder for ingestion by the "import" command.

description: Files that cannot be ingested (do not match by any table pattern) are moved to this folder.

description: Files that have been ingested are moved to this folder if SL_ARCHIVE is set to true.

description: Files that are being ingested are moved to this folder.

description: When filesystem storage is used, successfully ingested stored in this this folder in parquet format or any format set by the SL_DEFAULT_WRITE_FORMAT env property.

description: When filesystem storage is used, rejected records are stored in this folder in parquet format or any format set by the SL_DEFAULT_WRITE_FORMAT env property.

description: Invalid records are stored in this folder in source format when SL_SINK_REPLAY_TO_FILE is set to true.

description: How old may be teh data before a warning is raised. Use syntax like '3 day' or '2 hour' or '30 minute'

description: How old may be teh data before an error is raised. Use syntax like '3 day' or '2 hour' or '30 minute'

description:
Schema name, must be unique among all the schemas belonging to the same domain.
  *                     Will become the hive table name On Premise or BigQuery Table name on GCP.

description: If present, the table is renamed with this name. Useful when use in conjunction with the 'extract' module

description:
filename pattern to which this schema must be applied.
  *                     This instructs the framework to use this schema to parse any file with a filename that match this pattern.

description: Attributes parsing rules.

description: Dataset metadata

description: free text

description: Reserved for future use.

description: Reserved for future use.

description: Set of string to attach to this Schema

description: Row level security on this schema.

description: Expectations to check after Load / Transform has succeeded

description: List of columns that make up the primary key

description: Map of rolename -> List[Users].

description: Store here a couple of records illustrating the table data.

description: remove all records that do not match this condition

description: Sample of filename matching this schema

description: Attribute name as defined in the source dataset and as received in the file

description: semantic type of the attribute

description: Is it an array ?

description: Should this attribute always be present in the source

description: Should this attribute be applied a privacy transformation at ingestion time

description: free text for attribute description

description: If present, the attribute is renamed with this name

description: If present, what kind of stat should be computed for this field

description: List of sub-attributes (valid for JSON and XML files only)

description: Default value for this attribute when it is not present.

description: Tags associated with this attribute

description: Scripted field : SQL request on renamed column

description: If this attribute is a foreign key, reference to [domain.]table[.attribute]

description: Should this attribute be ignored on ingestion. Default to false

description: Policy tag to assign to this attribute. Used for column level security

description: Main SQL request to execute (do not forget to prefix table names with the database name to avoid conflicts)

description: Output Database (refer to a project id in BigQuery). Default to SL_DATABASE env var if set.

description: Output domain in output Area (Will be the Database name in Hive or Dataset in BigQuery)

description: Dataset Name in output Area (Will be the Table name in Hive & BigQuery)

description: List of columns used for partitioning the output.

description: List of SQL requests to executed before the main SQL request is run

description: List of SQL requests to executed after the main SQL request is run

description: Map of rolename -> List[Users].

description: Output table description

description: Configure freshness checks on the output table

description: Attributes comments and access policies

description: Python script URI to execute instead of the SQL request

description: Set of string to attach to the output table

description: Cron expression to use for this task

description: Name of the lock

description: Name of the lock

description: Name of the lock

description: Name of the lock

description: Output table description

description: Column name

description: Column description

description: Access policy to apply to this column

description: A schema in JDBC database or a folder in HDFS or a dataset in BigQuery.

description:
Domain name. Make sure you use a name that may be used as a folder name on the target storage.
                   - When using HDFS or Cloud Storage,  files once ingested are stored in a sub-directory named after the domain name.
                   - When used with BigQuery, files are ingested and sorted in tables under a dataset named after the domain name.

description:
List of schemas for each dataset in this domain.
A domain usually contains multiple schemas. Each schema defining how the contents of the input file should be parsed.
See Schema for more details.

description: Domain Description (free text)

description: Set of string to attach to this domain

description: Optional name. If not specified, the name of the file without the extension is used.

description: Default task properties to apply to all tasks defined in tasks section and in included files

description: List of transform tasks to execute

description: table name. Set to '*' to extract all tables

description: List of columns to extract. All columns by default.

description: Optional catalog name in the source database

description: Database schema where source tables are located

description: Metadata to use for the generated YAML file.

description: List of tables to extract

description: One or many of the predefined table types

description: List database connections to use to extract the data

description: Connection name as defined in the connections section of the application.conf file

description: JDBC connection options: url, user, password ...

description: Input for ref object

description: Database pattern to match, none if any database

description: Domain pattern to match, none if any domain match

description: Table pattern to match

description: Output for ref object

description: Describe how to resolve a reference in a transform task

description: The input table to resolve

description: The output table resolved with the domain and database

description: Default environment to use. May be also set using the SL_ENV environment variable

description: When using filesystem storage, default path to store the datasets

description: default metadata folder name. May be also set using the SL_METADATA environment variable

description: Validate the YAML file when loading it. If set to true fails on any error

description: Should ingested files be archived after ingestion ?

description: Should invalid records be stored in a replay file ?

description: Default write format in Spark. parquet is the default

description: Default write format in Spark for rejected records. parquet is the default

description: Default write format in Spark for audit records. parquet is the default

description: output files in CSV format ? Default is false

description: CSV file extension when csvOutput is true. Default is .csv

description: Only generate privacy tasks. Reserved for internal use

description: Should empty strings be considered as null values ?

description: Default validator to use when none is specified in the schema. Valid values are 'spark' or 'native'. Default is 'spark'

description: In what order should the files for a same table be loaded ? By time (default) or by or name ?

description: Should we analyze the result and generate HIVE statistics ? (useful for Spark / Databricks)

description: Should we create the table in Hive ? (useful for Spark / Databricks)

description: Should we load of the files to be stored in the same table in a single task or one by one ?

description: Maximum number of files to be stored in the same table in a single task

description: Should we force a distinct on the merge ?

description: Should we optimize the partition write on the merge ?

description: pending, accepted ... areas configuration

description: Airflow endpoint configuration when using Airflow Launcher

description: Hadoop configuration if applicable

description: Connection configurations

description: JDBC engine configurations

description: Privacy algorithms

description: Root folder for the application. May be also set using the SL_ROOT environment variable

description: Internal configuration

description: Access policies configuration

description: Spark Job scheduling configuration

description: Coma separated list of UDF to register in Spark jobs. May be also set using the SL_UDFS environment variable

description: Expectations configuration

description: Pattern to use to replace parameters in SQL queries in addition to the jinja syntax {{param}}. Default is ${param}

description: Should we reject all records when an error occurs ? Default is false

description: Maximum number of records to reject when an error occurs. Default is 100

description: DSV ingestion extra options

description: reserved

description: reserved

description: reserved

description: reserved

description: reserved

description: reserved

description: reserved

description: Default target database (projectId in GCP). May be also set using the SL_DATABASE environment variable

description: reserved

description: Default connection to use when loading / transforming data

description: JSON Schema for Starlake Data Pipeline

description: Expectations library defined as a map name(params) -> sql request that should return 0 record

title: Starlake Data Pipeline