key: on

description: The name of the GitHub event that triggers the workflow. You can provide a single event string, array of events, array of event types, or an event configuration map that schedules a workflow or restricts the execution of a workflow to specific files, tags, or branch changes. For a list of available events, see https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows.

enum: created edited deleted

default: created edited deleted

enum: created rerequested completed requested_action

enum: completed requested rerequested

default: completed requested rerequested

enum: created edited deleted transferred pinned unpinned labeled unlabeled locked unlocked category_changed answered unanswered

enum: opened edited deleted transferred pinned unpinned closed reopened assigned unassigned labeled unlabeled locked unlocked milestoned demilestoned

enum: added edited deleted

default: added edited deleted

enum: created closed opened edited deleted

default: created closed opened edited deleted

enum: created updated closed reopened edited deleted

enum: created moved converted edited deleted

default: created moved converted edited deleted

enum: created updated moved deleted

default: created updated moved deleted

default: opened synchronize reopened

enum: submitted edited dismissed

default: submitted edited dismissed

enum: published updated

default: published updated

enum: published unpublished created edited deleted prereleased released

enum: boolean number string

enum: string choice boolean number environment

const: string

const: boolean

const: number

const: environment

const: choice

enum: requested completed

default: requested completed


description: Runs your workflow anytime the branch_protection_rule event occurs. More than one activity type triggers this event.

type: string


description: Runs your workflow anytime the check_run event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/checks/runs.

default: created rerequested completed requested_action


description: Runs your workflow anytime the check_suite event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/checks/suites/.


key: create

description: Runs your workflow anytime someone creates a branch or tag, which triggers the create event. For information about the REST API, see https://developer.github.com/v3/git/refs/#create-a-reference.


key: delete

description: Runs your workflow anytime someone deletes a branch or tag, which triggers the delete event. For information about the REST API, see https://developer.github.com/v3/git/refs/#delete-a-reference.


key: deployment

description: Runs your workflow anytime someone creates a deployment, which triggers the deployment event. Deployments created with a commit SHA may not have a Git ref. For information about the REST API, see https://developer.github.com/v3/repos/deployments/.


Runs your workflow anytime a third party provides a deployment status, which triggers the deployment_status event. Deployments created with a commit SHA may not have a Git ref. For information about the REST API, see https://developer.github.com/v3/repos/deployments/#create-a-deployment-status.


key: discussion

description: Runs your workflow anytime the discussion event occurs. More than one activity type triggers this event. For information about the GraphQL API, see https://docs.github.com/en/graphql/guides/using-the-graphql-api-for-discussions

default: created edited deleted transferred pinned unpinned labeled unlabeled locked unlocked category_changed answered unanswered


description: Runs your workflow anytime the discussion_comment event occurs. More than one activity type triggers this event. For information about the GraphQL API, see https://docs.github.com/en/graphql/guides/using-the-graphql-api-for-discussions


key: fork

description: Runs your workflow anytime when someone forks a repository, which triggers the fork event. For information about the REST API, see https://developer.github.com/v3/repos/forks/#create-a-fork.


key: gollum

description: Runs your workflow when someone creates or updates a Wiki page, which triggers the gollum event.


description: Runs your workflow anytime the issue_comment event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/issues/comments/.


key: issues

description: Runs your workflow anytime the issues event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/issues.

default: opened edited deleted transferred pinned unpinned closed reopened assigned unassigned labeled unlabeled locked unlocked milestoned demilestoned


key: label

description: Runs your workflow anytime the label event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/issues/labels/.


key: member

description: Runs your workflow anytime the member event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/repos/collaborators/.


description: Runs your workflow when a pull request is added to a merge queue, which adds the pull request to a merge group. For information about the merge queue, see https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue .


key: milestone

description: Runs your workflow anytime the milestone event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/issues/milestones/.


Runs your workflow anytime someone pushes to a GitHub Pages-enabled branch, which triggers the page_build event. For information about the REST API, see https://developer.github.com/v3/repos/pages/.


key: project

description: Runs your workflow anytime the project event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/projects/.

default: created updated closed reopened edited deleted


description: Runs your workflow anytime the project_card event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/projects/cards.


description: Runs your workflow anytime the project_column event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/projects/columns.


key: public

description: Runs your workflow anytime someone makes a private repository public, which triggers the public event. For information about the REST API, see https://developer.github.com/v3/repos/#edit.


description:
Runs your workflow anytime the pull_request event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/pulls.
Note: Workflows do not run on private base repositories when you open a pull request from a forked repository.
When you create a pull request from a forked repository to the base repository, GitHub sends the pull_request event to the base repository and no pull request events occur on the forked repository.
Workflows don't run on forked repositories by default. You must enable GitHub Actions in the Actions tab of the forked repository.
The permissions for the GITHUB_TOKEN in forked repositories is read-only. For more information about the GITHUB_TOKEN, see https://help.github.com/en/articles/virtual-environments-for-github-actions.

type: array


description:
Runs your workflow anytime the pull_request_review event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/pulls/reviews.
Note: Workflows do not run on private base repositories when you open a pull request from a forked repository.
When you create a pull request from a forked repository to the base repository, GitHub sends the pull_request event to the base repository and no pull request events occur on the forked repository.
Workflows don't run on forked repositories by default. You must enable GitHub Actions in the Actions tab of the forked repository.
The permissions for the GITHUB_TOKEN in forked repositories is read-only. For more information about the GITHUB_TOKEN, see https://help.github.com/en/articles/virtual-environments-for-github-actions.


description:
Runs your workflow anytime a comment on a pull request's unified diff is modified, which triggers the pull_request_review_comment event. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/pulls/comments.
Note: Workflows do not run on private base repositories when you open a pull request from a forked repository.
When you create a pull request from a forked repository to the base repository, GitHub sends the pull_request event to the base repository and no pull request events occur on the forked repository.
Workflows don't run on forked repositories by default. You must enable GitHub Actions in the Actions tab of the forked repository.
The permissions for the GITHUB_TOKEN in forked repositories is read-only. For more information about the GITHUB_TOKEN, see https://help.github.com/en/articles/virtual-environments-for-github-actions.


description: This event is similar to pull_request, except that it runs in the context of the base repository of the pull request, rather than in the merge commit. This means that you can more safely make your secrets available to the workflows triggered by the pull request, because only workflows defined in the commit on the base repository are run. For example, this event allows you to create workflows that label and comment on pull requests, based on the contents of the event payload.


key: push

description:
Runs your workflow when someone pushes to a repository branch, which triggers the push event.
Note: The webhook payload available to GitHub Actions does not include the added, removed, and modified attributes in the commit object. You can retrieve the full commit object using the REST API. For more information, see https://developer.github.com/v3/repos/commits/#get-a-single-commit.


description: Runs your workflow anytime a package is published or updated. For more information, see https://help.github.com/en/github/managing-packages-with-github-packages.


key: release

description: Runs your workflow anytime the release event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/repos/releases/ in the GitHub Developer documentation.

default: published unpublished created edited deleted prereleased released


key: status

description: Runs your workflow anytime the status of a Git commit changes, which triggers the status event. For information about the REST API, see https://developer.github.com/v3/repos/statuses/.


key: watch

description: Runs your workflow anytime the watch event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/activity/starring/.


description: Allows workflows to be reused by other workflows.

type: object

type: boolean

type: boolean number string


key: inputs

description: When using the workflow_call keyword, you can optionally specify inputs that are passed to the called workflow from the caller workflow.


description: A string identifier to associate with the input. The value of <input_id> is a map of the input's metadata. The <input_id> must be a unique identifier within the inputs object. The <input_id> must start with a letter or _ and contain only alphanumeric characters, -, or _.


key: description

description: A string description of the input parameter.


key: deprecationMessage

description: A string shown to users using the deprecated input.


key: required

description: A boolean to indicate whether the action requires the input parameter. Set to true when the parameter is required.


key: type

description: Required if input is defined for the on.workflow_call keyword. The value of this parameter is a string specifying the data type of the input. This must be one of: boolean, number, or string.


key: default

description: The default value is used when an input parameter isn't specified in a workflow file.


key: secrets

description: A map of the secrets that can be used in the called workflow. Within the called workflow, you can use the secrets context to refer to a secret.


description: A string identifier to associate with the secret.


description: A string description of the secret parameter.


description: A boolean specifying whether the secret must be supplied.


description: You can now create workflows that are manually triggered with the new workflow_dispatch event. You will then see a 'Run workflow' button on the Actions tab, enabling you to easily trigger a run.

type: number


description: Input parameters allow you to specify data that the action expects to use during runtime. GitHub stores input parameters as environment variables. Input ids with uppercase letters are converted to lowercase during runtime. We recommended using lowercase input ids.


description: A string representing the default value. The default value is used when an input parameter isn't specified in a workflow file.


description: A string representing the type of the input.


key: options

description: The options of the dropdown list, if the type is a choice.


description: This event occurs when a workflow run is requested or completed, and allows you to execute a workflow based on the finished result of another workflow. For example, if your pull_request workflow generates build artifacts, you can create a new workflow that uses workflow_run to analyze the results and add a comment to the original pull request.


You can use the GitHub API to trigger a webhook event called repository_dispatch when you want to trigger a workflow for activity that happens outside of GitHub. For more information, see https://developer.github.com/v3/repos/#create-a-repository-dispatch-event.
To trigger the custom repository_dispatch webhook event, you must send a POST request to a GitHub API endpoint and provide an event_type name to describe the activity type. To trigger a workflow run, you must also configure your workflow to use the repository_dispatch event.


key: schedule

description:
You can schedule a workflow to run at specific UTC times using POSIX cron syntax (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/crontab.html#tag_20_25_07). Scheduled workflows run on the latest commit on the default or base branch. The shortest interval you can run scheduled workflows is once every 5 minutes.
Note: GitHub Actions does not support the non-standard syntax @yearly, @monthly, @weekly, @daily, @hourly, and @reboot.
You can use crontab guru (https://crontab.guru/). to help generate your cron syntax and confirm what time it will run. To help you get started, there is also a list of crontab guru examples (https://crontab.guru/examples.html).


key: env

description: A map of environment variables that are available to all jobs and steps in the workflow.


key: defaults

description: A map of default settings that will apply to all jobs in the workflow.


key: concurrency

description:
Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time. A concurrency group can be any string or expression. The expression can use any context except for the secrets context.
You can also specify concurrency at the workflow level.
When a concurrent job or workflow is queued, if another job or workflow using the same concurrency group in the repository is in progress, the queued job or workflow will be pending. Any previously pending job or workflow in the concurrency group will be canceled. To also cancel any currently running job or workflow in the same concurrency group, specify cancel-in-progress: true.


key: jobs

description:
A workflow run is made up of one or more jobs. Jobs run in parallel by default. To run jobs sequentially, you can define dependencies on other jobs using the jobs.<job_id>.needs keyword.
Each job runs in a fresh instance of the virtual environment specified by runs-on.
You can run an unlimited number of jobs as long as you are within the workflow usage limits. For more information, see https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#usage-limits.


key: run-name

description: The name for workflow runs generated from the workflow. GitHub displays the workflow run name in the list of workflow runs on your repository's 'Actions' tab.


description: Used to define the short-hand names that are used throughout a JSON-LD document.

type: object string array null


description: Used to express a graph.


description: Used to uniquely identify things that are being described in the document with IRIs or blank node identifiers.

format: uri


description: Used to specify the data that is associated with a particular property in the graph.

type: string boolean number null


Used to specify the language for a particular string value or the default language of a JSON-LD document.


description: Used to set the data type of a node or typed value.

type: string null array


Used to set the default container type for a term.


Used to express an ordered set of data.


Used to express an unordered set of data and to ensure that values are always represented as arrays.


description: Used to express reverse properties.

type: string object null


description: Used to set the base IRI against which relative IRIs are resolved


description: Used to expand properties and values in @type with a common prefix IRI


description: See https://docs.ansible.com/ansible/devel/dev_guide/developing_collections_structure.html#meta-directory


description: A mapping of groups and the list of action plugin and module names they contain. They may also have a special ‘metadata’ dictionary in the list, which can be used to include actions from other groups.


description: A mapping of names for Python import statements and their redirected locations.


key: level

description: Determines the error level

enum: error warn ignore


This rule checks to see that there is spacing before and after the arrow operator that declares a function. [default level: ignore]


description: This rule checks to see that there is the proper spacing inside curly braces. The spacing amount is specified by `spaces`. The spacing amount for empty objects is specified by `empty_object_spaces`. [default level: ignore]

type: integer


This rule mandates that all class names are CamelCased. Camel casing class names is a generally accepted way of distinguishing constructor functions - which require the `new` prefix to behave properly - from plain old functions. [default level: error]


[default level: error]


description: This rule checks to see that there is spacing before and after the colon in a colon assignment (i.e., classes, objects). [default level: ignore]


description: Examine the complexity of your application. [default level: ignore]


Prevents defining duplicate keys in object literals and classes. [default level: error]


Requires constructors with no parameters to include the parens. [default level: ignore]


This rule makes sure that parentheses are around comprehensions. [default level: warn]


Checks that the file ends with a single newline. [default level: ignore]


key: indentation

description: This rule imposes a standard number of spaces to be used for indentation. Since whitespace is significant in CoffeeScript, it's critical that a project chooses a standard indentation format and stays consistent. Other roads lead to darkness. [default level: error]


description: This rule ensures your project uses only windows or unix line endings. [default level: ignore]

enum: unix windows


description: This rule imposes a maximum line length on your code. [default level: error]


Warns when you use `this` inside a function that wasn't defined with a fat arrow. This rule does not apply to methods defined in a class, since they have `this` bound to the class instance (or the class itself, for class methods). [default level: ignore]


description: Checks the number of newlines between classes and other code. [default level: ignore]


Backticks allow snippets of JavaScript to be embedded in CoffeeScript. While some folks consider backticks useful in a few niche circumstances, they should be avoided because so none of JavaScript's 'bad parts', like with and eval, sneak into CoffeeScript. [default level: error]


This rule detects the `debugger` statement. [default level: warn]


Disallows declaring empty functions. The goal of this rule is that unintentional empty callbacks can be detected. [default level: ignore]


This rule prohibits empty parameter lists in function definitions. [default level: ignore]


description: This rule prohibits implicit braces when declaring object literals. Implicit braces can make code more difficult to understand, especially when used in combination with optional parenthesis. [default level: ignore]


This rule prohibits implicit parens on function calls. [default level: ignore]


This rule prohibits string interpolation in a single quoted string. [default level: ignore]


This rule warns about nested string interpolation, as it tends to make code harder to read and understand. [default level: warn]


This rule forbids the increment and decrement arithmetic operators. Some people believe the `++` and `--` to be cryptic and the cause of bugs due to misunderstandings of their precedence rules. [default level: ignore]


Warns when you use the fat arrow for a private function inside a class definition scope. It is not necessary and it does not do anything. [default level: warn]


description: This rule checks that no stand alone `@` are in use, they are discouraged. [default level: ignore]


description: This rule forbids tabs in indentation. Enough said. [default level: error]


This rule prohibits `this`. Use `@` instead. [default level: ignore]


This rule forbids throwing string literals or interpolations. While JavaScript (and CoffeeScript by extension) allow any expression to be thrown, it is best to only throw `Error` objects, because they contain valuable debugging information like the stack trace. [default level: error]


This rule prohibits trailing semicolons, since they are needless cruft in CoffeeScript. [default level: error]


description: This rule forbids trailing whitespace in your code, since it is needless cruft. [default level: error]


This rule prohibits double quotes unless string interpolation is used or the string contains single quotes. [default level: ignore]


Disallows defining functions with fat arrows when `this` is not used within the function.  [default level: warn]


Requires constructors with parameters to include the parens. [default level: ignore]


This rule prohibits `&&`, `||`, `==`, `!=` and `!`. Use `and`, `or`, `is`, `isnt`, and `not` instead. `!!` (for converting to a boolean) is ignored. [default level: ignore]


This rule enforces that operators have space around them.  [default level: ignore]


This rule checks to make sure you have a space after commas. [default level: ignore]


This rule detects when changes are made by transform function, and warns that line numbers are probably incorrect. [default level: warn]


key: apiVersion

description: The apiVersion field should be v2 for Helm charts that require at least Helm 3. Charts supporting previous Helm versions have an apiVersion set to v1 and are still installable by Helm 3.


key: name

description: The name of the chart


key: version

description: A SemVer 2 version


key: kubeVersion

description: The optional kubeVersion field can define semver constraints on supported Kubernetes versions. Helm will validate the version constraints when installing the chart and fail if the cluster runs an unsupported Kubernetes version.


key: description

description: A single-sentence description of this project


key: type

description: The type of the chart

default: application

enum: application library


key: keywords

description: A list of keywords about this project


key: home

description: The URL of this projects home page


key: sources

description: A list of URLs to source code for this project


key: dependencies

description:
In Helm, one chart may depend on any number of other charts. These dependencies can be dynamically linked using the dependencies field in Chart.yaml or brought in to the charts/ directory and managed manually.
The charts required by the current chart are defined as a list in the dependencies field.

required: parent child


description: The version of the chart


key: repository

description: The repository URL or alias


key: condition

description: A yaml path that resolves to a boolean, used for enabling/disabling charts


key: tags

description: Tags can be used to group charts for enabling/disabling together


key: import-values

description: ImportValues holds the mapping of source values to parent key to be imported. Each item can be a string or pair of child/parent sublist items.


key: parent

description: The destination path in the parent chart's values


key: child

description: The source key of the values to be imported


key: alias

description: Alias to be used for the chart. Useful when you have to add the same chart multiple times


description: The maintainers name


key: email

description: The maintainers email

format: email


key: url

description: A URL for the maintainer


key: icon

description: A URL to an SVG or PNG image to be used as an icon


key: appVersion

description: Note that the appVersion field is not related to the version field. It is a way of specifying the version of the application. For example, the drupal chart may have an appVersion: "8.2.1", indicating that the version of Drupal included in the chart (by default) is 8.2.1. This field is informational, and has no impact on chart version calculations. Wrapping the version in quotes is highly recommended. It forces the YAML parser to treat the version number as a string. Leaving it unquoted can lead to parsing issues in some cases. For example, YAML interprets 1.0 as a floating point value, and a git commit SHA like 1234e10 as scientific notation.


key: deprecated

description: When managing charts in a Chart Repository, it is sometimes necessary to deprecate a chart. The optional deprecated field in Chart.yaml can be used to mark a chart as deprecated. If the latest version of a chart in the repository is marked as deprecated, then the chart as a whole is considered to be deprecated. The chart name can be later reused by publishing a newer version that is not marked as deprecated.


key: annotations

description: A list of annotations keyed by name

enum: true false

enum:
Basic Install
Seamless Upgrades
Full Lifecycle
Deep Insights
Auto Pilot


description:
This annotation is used to provide some details about the changes introduced by a given chart version. Artifact Hub can generate and display a ChangeLog based on the entries in the changes field in all your chart versions.
This annotation can be provided using two different formats: using a plain list of strings with the description of the change or using a list of objects with some extra structured information (see example below). Please feel free to use the one that better suits your needs. The UI experience will be slightly different depending on the choice. When using the list of objects option the valid supported kinds are added, changed, deprecated, removed, fixed and security.


description: Use this annotation to indicate that this chart version contains security updates. When a package release contains security updates, a special message will be displayed in the Artifact Hub UI as well as in the new release email notification.


description:
By default, Artifact Hub will try to extract the containers images used by Helm charts from the manifests generated from a dry-run install using the default values. If you prefer, you can also provide a list of containers images manually by using this annotation.
Containers images will be scanned for security vulnerabilities. The security report generated will be available in the package detail view. It is possible to whitelist images so that they are not scanned by setting the whitelisted flag to true.


description: This annotation can be used to list the operator's CRDs. They will be visible in the package's detail view as cards.


description: Use this annotation to provide a list of example CRs for the operator's CRDs. Each of the examples can be opened from the corresponding CRD card in the package's detail view.


description: Use this annotation to indicate the chart's license. By default, Artifact Hub tries to read the chart's license from the LICENSE file in the chart, but it's possible to override or provide it with this annotation. It must be a valid SPDX identifier.


description: This annotation allows including named links, which will be rendered nicely in Artifact Hub. You can use this annotation to include links not included previously in the Chart.yaml file, or you can use it to name links already present (in the sources section, for example).


description: This annotation can be used if you want to display a different name for a given user in Artifact Hub than the one used in the Chart.yaml file. If the email used matches, the name used in the annotations entry will be displayed in Artifact Hub. It's also possible to include maintainers that should only be listed in Artifact Hub by adding additional entries.


description: Use this annotation to indicate that your chart represents an operator. Artifact Hub at the moment also considers your chart to represent an operator if the word operator appears in the chart name.


description: Use this annotation to indicate the capabilities of the operator your chart provides. It must be one of the following options: Basic Install, Seamless Upgrades, Full Lifecycle, Deep Insights or Auto Pilot. For more information please see the capability level diagram.


description: Use this annotation to indicate that this chart version is a pre-release. This status will be displayed in the UI's package view, as well as in new releases notifications emails.


description: This annotation allows recommending other related packages. Recommended packages will be featured in the package detail view in Artifact Hub.


description: This annotation can be used to provide some information about the key used to sign a given chart version. This information will be displayed on the Artifact Hub UI, making it easier for users to get the information they need to verify the integrity and origin of your chart. The url field indicates where users can find the public key and it is mandatory when a sign key entry is provided.


key: minLines

description: minimum size of code block in lines to check for duplication


key: maxLines

description: maximum size of source file in lines to check for duplication


key: maxSize

description: maximum size of source file in bytes to check for duplication (e.g.,: 1kb, 1mb, 120kb)


key: minTokens

description: minimum size of code block in tokens to check for duplication


key: threshold

description: maximum allowed duplicate lines expressed as a percentage; exit with error and exit code 1 when threshold exceeded


key: formatsExts

description: custom mapping from formats to file extensions (default: https://github.com/kucherenko/jscpd/blob/master/packages/tokenizer/src/formats.ts); see https://github.com/kucherenko/jscpd/blob/master/supported_formats.md


key: output

description: path to directory for non-console reports

default: ./report


key: path

description: paths that should be included in duplicate detection (default: [process.cwd()])


key: pattern

description: glob pattern for files that should be included in duplicate detection (e.g., **/*.txt); only used to filter directories configured via path option


key: ignorePattern

description: ignore code blocks matching these regular expressions


key: mode

description: mode of detection quality; see https://github.com/kucherenko/jscpd/blob/master/packages/jscpd/README.md#mode

enum: mild strict weak

default: mild


key: ignore

description: glob pattern for files that should be excluded from duplicate detection


key: format

description: list of formats for which to detect duplication (default: all); see https://github.com/kucherenko/jscpd/blob/master/supported_formats.md


key: store

description: store used to collect information about code (default: in-memory store); install @jscpd/leveldb-store and use leveldb for big repositories

enum: leveldb redis


key: reporters

description: a list of reporters to use to output information about duplication; see https://github.com/kucherenko/jscpd/blob/master/packages/jscpd/README.md#reporters

enum: xml json csv markdown consoleFull html console silent threshold xcode


key: blame

description: get information about authors and dates of duplicated blocks from Git


key: silent

description: do not write duplicate detection progress and result to console


key: verbose

description: show full information during duplicate detection


key: absolute

description: use absolute paths in reports


key: noSymLinks

description: do not follow symlinks


key: skipLocal

description: skip duplicates within folders; just detect cross-folder duplicates


key: ignoreCase

description: ignore case of symbols in code (experimental)


key: gitignore

description: ignore all files from .gitignore file


description: output path for duplication level badge (default: path.join(output, 'jscpd-badge.svg'))


key: label

description: badge subject text (URL-encoding needed for spaces or special characters)

default: Copy/Paste


key: labelColor

description: badge label color (name or RGB code without #); see https://github.com/badgen/badgen/blob/master/src/color-presets.ts


key: status

description: badge value text (URL-encoding needed for spaces or special characters, default: duplication %)


key: color

description: badge color (name or RGB code without #, default: green if beneath threshold, red if above threshold, grey if threshold not set); see https://github.com/badgen/badgen/blob/master/src/color-presets.ts


key: style

description: badge look: flat or classic

enum: flat classic

default: classic


key: icon

description: URL for icon to display in front of badge subject text (e.g., data:image/svg+xml;base64,...)


key: iconWidth

description: SVG width of icon to display in front of badge subject text; set this if icon is not square


key: scale

description: size of badge relative to default of 1


key: exitCode

description: exit code to use when at least one duplicate code block is detected but threshold is not exceeded


description: Static Analysis Results Format (SARIF) Version 1.0.0 JSON Schema: a standard format for the output of static analysis and other tools.

type: integer string

enum: alias assignment branch call callReturn continuation declaration functionEnter functionExit functionReturn usage

enum: source sink sanitizer

enum: important essential unimportant

required: message locations

required: uri replacements

required: description fileChanges

required: value algorithm

format: date-time

default: warning

enum: note warning error


key: annotatedCodeLocation

description: An annotation used to express code flows through a method or other locations that are related to a result.


key: id

description: OBSOLETE (use "step" instead): An identifier for the location, unique within the scope of the code flow within which it occurs.


key: step

description: The 0-based sequence number of the location in the code flow within which it occurs.


key: physicalLocation

description: A file location to which this annotation refers.


key: fullyQualifiedLogicalName

description: The fully qualified name of the method or function that is executing.


key: logicalLocationKey

description: A key used to retrieve the annotation's logicalLocation from the logicalLocations dictionary.


key: module

description: The name of the module that contains the code that is executing.


key: threadId

description: The thread identifier of the code that is executing.


key: message

description: A message relevant to this annotation.


key: kind

description: Categorizes the location.


key: taintKind

description: Classifies state transitions in code locations relevant to a taint analysis.


key: target

description: The fully qualified name of the target on which this location operates. For an annotation of kind 'call', for example, the target refers to the fully qualified logical name of the function called from this location.


key: values

description: An ordered set of strings that comprise input or return values for the current operation. For an annotation of kind 'call', for example, this property may hold the ordered list of arguments passed to the callee.


key: state

description: A dictionary, each of whose keys specifies a variable or expression, the associated value of which represents the variable or expression value. For an annotation of kind 'continuation', for example, this dictionary might hold the current assumed values of a set of global variables.


key: targetKey

description: A key used to retrieve the target's logicalLocation from the logicalLocations dictionary.


key: essential

description: OBSOLETE (use "importance" instead): True if this location is essential to understanding the code flow in which it occurs.


key: importance

description: Specifies the importance of this location in understanding the code flow in which it occurs. The order from most to least important is "essential", "important", "unimportant". Default: "important".


key: snippet

description: The source code at the specified location.


key: annotations

description: A set of messages relevant to the current annotated code location.


key: properties

description: Key/value pairs that provide additional information about the code location.


key: tags

description: A set of distinct strings that provide additional information.


description: A message relevant to a code location


key: locations

description: An array of 'physicalLocation' objects associated with the annotation.


description: A message relevant to the code flow


description: An array of 'annotatedCodeLocation' objects, each of which describes a single location visited by the tool in the course of producing the result.


description: Key/value pairs that provide additional information about the code flow.


description: A string that identifies the kind of exception, for example, the fully qualified type name of an object that was thrown, or the symbolic name of a signal.


description: A string that describes the exception.


key: stack

description: The sequence of function calls leading to the exception.


key: innerExceptions

description: An array of exception objects each of which is considered a cause of this exception.


key: fileChange

description: A change to a single file.


key: uri

description: A string that represents the location of the file to change as a valid URI.


key: uriBaseId

description: A string that identifies the conceptual base for the 'uri' property (if it is relative), e.g.,'$(SolutionDir)' or '%SRCROOT%'.


key: replacements

description: An array of replacement objects, each of which represents the replacement of a single range of bytes in a single file specified by 'uri'.


key: file

description: A single file. In some cases, this file might be nested within another file.


description: The path to the file within its containing file.


key: parentKey

description: Identifies the key of the immediate parent of the file, if this file is nested.


key: offset

description: The offset in bytes of the file within its containing file.


key: length

description: The length of the file in bytes.


key: mimeType

description: The MIME type (RFC 2045) of the file.


key: contents

description: The contents of the file, expressed as a MIME Base64-encoded byte sequence.


key: hashes

description: An array of hash objects, each of which specifies a hashed value for the file, along with the name of the algorithm used to compute the hash.


description: Key/value pairs that provide additional information about the file.


description: A set of distinct strings that provide additional information.


key: fix

description: A proposed fix for the problem represented by a result object. A fix specifies a set of file to modify. For each file, it specifies a set of bytes to remove, and provides a set of new bytes to replace them.


key: description

description: A string that describes the proposed fix, enabling viewers to present a proposed change to an end user.


key: fileChanges

description: One or more file changes that comprise a fix for a result.


key: formattedRuleMessage

description: Contains information that can be used to construct a formatted message that describes a result.


key: formatId

description: A string that identifies the message format used to format the message that describes this result. The value of formatId must correspond to one of the names in the set of name/value pairs contained in the 'messageFormats' property of the rule object whose 'id' property matches the 'ruleId' property of this result.


key: arguments

description: An array of strings that will be used, in combination with a message format, to construct a result message.


key: hash

description: A hash value of some file or collection of files, together with the algorithm used to compute the hash.


key: value

description: The hash value of some file or collection of files, computed by the algorithm named in the 'algorithm' property.


key: algorithm

description: The name of the algorithm used to compute the hash value specified in the 'value' property.


key: invocation

description: The runtime environment of the analysis tool run.


key: commandLine

description: The command line used to invoke the tool.


key: responseFiles

description: The contents of any response files specified on the tool's command line.


key: startTime

description: The date and time at which the run started. See "Date/time properties" in the SARIF spec for the required format.


key: endTime

description: The date and time at which the run ended. See "Date/time properties" in the  SARIF spec for the required format.


key: machine

description: The machine that hosted the analysis tool run.


key: account

description: The account that ran the analysis tool.


key: processId

description: The process id for the analysis tool run.


key: fileName

description: The fully qualified path to the analysis tool.


key: workingDirectory

description: The working directory for the analysis rool run.


key: environmentVariables

description: The environment variables associated with the analysis tool process, expressed as key/value pairs.


key: properties

description: Key/value pairs that provide additional information about the run.


key: tags

description: A set of distinct strings that provide additional information.


key: location

description: The location where an analysis tool produced a result.


key: analysisTarget

description: Identifies the file that the analysis tool was instructed to scan. This need not be the same as the file where the result actually occurred.


key: resultFile

description: Identifies the file where the analysis tool produced the result.


key: fullyQualifiedLogicalName

description: The human-readable fully qualified name of the logical location where the analysis tool produced the result. If 'logicalLocationKey' is not specified, this member is can used to retrieve the location logicalLocation from the logicalLocations dictionary, if one exists.


key: logicalLocationKey

description: A key used to retrieve the location logicalLocation from the logicalLocations dictionary, when the string specified by 'fullyQualifiedLogicalName' is not unique.


key: decoratedName

description: The machine-readable fully qualified name for the logical location where the analysis tool produced the result, such as the mangled function name provided by a C++ compiler that encodes calling convention, return type and other details along with the function name.


description: Key/value pairs that provide additional information about the location.


key: logicalLocation

description: A logical location of a construct that produced a result.


key: name

description: Identifies the construct in which the result occurred. For example, this property might contain the name of a class or a method.


key: parentKey

description: Identifies the key of the immediate parent of the construct in which the result was detected. For example, this property might point to a logical location that represents the namespace that holds a type.


key: kind

description: The type of construct this logicalLocationComponent refers to. Should be one of 'function', 'member', 'module', 'namespace', 'package', 'resource', or 'type', if any of those accurately describe the construct.


key: notification

description: Describes a condition relevant to the tool itself, as opposed to being relevant to a target being analyzed by the tool.


key: id

description: An identifier for the condition that was encountered.


key: ruleId

description: The stable, unique identifier of the rule (if any) to which this notification is relevant. If 'ruleKey' is not specified, this member can be used to retrieve rule metadata from the rules dictionary, if it exists.


key: ruleKey

description: A key used to retrieve the rule metadata from the rules dictionary that is relevant to the notification.


key: physicalLocation

description: The file and region relevant to this notification.


key: message

description: A string that describes the condition that was encountered.


key: level

description: A value specifying the severity level of the notification.


key: threadId

description: The thread identifier of the code that generated the notification.


key: time

description: The date and time at which the analysis tool generated the notification.


key: exception

description: The runtime exception, if any, relevant to this notification.


key: properties

description: Key/value pairs that provide additional information about the notification.


key: tags

description: A set of distinct strings that provide additional information.


description: A physical location relevant to a result. Specifies a reference to a programming artifact together with a range of bytes or characters within that artifact.


key: uri

description: The location of the file as a valid URI.


key: uriBaseId

description: A string that identifies the conceptual base for the 'uri' property (if it is relative), e.g.,'$(SolutionDir)' or '%SRCROOT%'.


key: region

description: The region within the file where the result was detected.


description: A region within a file where a result was detected.


key: startLine

description: The line number of the first character in the region.


key: startColumn

description: The column number of the first character in the region.


key: endLine

description: The line number of the last character in the region.


key: endColumn

description: The column number of the last character in the region.


key: offset

description: The zero-based offset from the beginning of the file of the first byte or character in the region.


key: length

description: The length of the region in bytes or characters.


key: replacement

description: The replacement of a single range of bytes in a file. Specifies the location within the file where the replacement is to be made, the number of bytes to remove at that location, and a sequence of bytes to insert at that location.


description: A non-negative integer specifying the offset in bytes from the beginning of the file at which bytes are to be removed, inserted or both. An offset of 0 shall denote the first byte in the file.


key: deletedLength

description: The number of bytes to delete, starting at the byte offset specified by offset, measured from the beginning of the file.


key: insertedBytes

description: The MIME Base64-encoded byte sequence to be inserted at the byte offset specified by the 'offset' property, measured from the beginning of the file.


key: result

description: A result produced by an analysis tool.

enum: notApplicable pass note warning error

enum: suppressedInSource suppressedExternally

enum: new existing absent


key: ruleId

description: The stable, unique identifier of the rule (if any) to which this notification is relevant. If 'ruleKey' is not specified, this member can be used to retrieve rule metadata from the rules dictionary, if it exists.


key: ruleKey

description: A key used to retrieve the rule metadata from the rules dictionary that is relevant to the notification.


key: level

description: A value specifying the severity level of the result. If this property is not present, its implied value is 'warning'.


key: message

description: A string that describes the result. The first sentence of the message only will be displayed when visible space is limited.


key: formattedRuleMessage

description: A 'formattedRuleMessage' object that can be used to construct a formatted message that describes the result. If the 'formattedMessage' property is present on a result, the 'fullMessage' property shall not be present. If the 'fullMessage' property is present on an result, the 'formattedMessage' property shall not be present


key: locations

description: One or more locations where the result occurred. Specify only one location unless the problem indicated by the result can only be corrected by making a change at every specified location.


key: snippet

description: A source code or other file fragment that illustrates the result.


key: id

description: A unique identifier for the result.


key: toolFingerprintContribution

description: A string that contributes to the unique identity of the result.


key: stacks

description: An array of 'stack' objects relevant to the result.


key: codeFlows

description: An array of 'codeFlow' objects relevant to the result.


key: relatedLocations

description: A grouped set of locations and messages, if available, that represent code areas that are related to this result.


key: items

description: A flag value indicating one or more suppression conditions.


key: baselineState

description: The state of a result relative to a baseline of a previous run.


key: fixes

description: An array of 'fix' objects, each of which represents a proposed fix to the problem indicated by the result.


key: properties

description: Key/value pairs that provide additional information about the result.


key: tags

description: A set of distinct strings that provide additional information.


key: rule

description: Describes an analysis rule.


description: A stable, opaque identifier for the rule.


key: name

description: A rule identifier that is understandable to an end user.


key: shortDescription

description: A concise description of the rule. Should be a single sentence that is understandable when visible space is limited to a single line of text.


key: fullDescription

description: A string that describes the rule. Should, as far as possible, provide details sufficient to enable resolution of any problem indicated by the result.


key: messageFormats

description: A set of name/value pairs with arbitrary names. The value within each name/value pair shall consist of plain text interspersed with placeholders, which can be used to format a message in combination with an arbitrary number of additional string arguments.


key: defaultLevel

description: A value specifying the default severity level of the result.


key: helpUri

description: A URI where the primary documentation for the rule can be found.


description: Key/value pairs that provide additional information about the rule.


key: run

description: Describes a single run of an analysis tool, and contains the output of that run.


key: tool

description: Information about the tool or tool pipeline that generated the results in this run. A run can only contain results produced by a single tool or tool pipeline. A run can aggregate results from multiple log files, as long as context around the tool run (tool command-line arguments and the like) is identical for all aggregated files.


key: invocation

description: Describes the runtime environment, including parameterization, of the analysis tool run.


key: files

description: A dictionary, each of whose keys is a URI and each of whose values is an array of file objects representing the location of a single file scanned during the run.


key: logicalLocations

description: A dictionary, each of whose keys specifies a logical location such as a namespace, type or function.


key: results

description: The set of results contained in an SARIF log. The results array can be omitted when a run is solely exporting rules metadata. It must be present (but may be empty) in the event that a log file represents an actual scan.


key: toolNotifications

description: A list of runtime conditions detected by the tool in the course of the analysis.


key: configurationNotifications

description: A list of conditions detected by the tool that are relevant to the tool's configuration.


key: rules

description: A dictionary, each of whose keys is a string and each of whose values is a 'rule' object, that describe all rules associated with an analysis tool or a specific run of an analysis tool.


key: id

description: An identifier for the run.


key: stableId

description: A stable identifier for a run, for example, 'nightly Clang analyzer run'. Multiple runs of the same type can have the same stableId.


key: automationId

description: A global identifier that allows the run to be correlated with other artifacts produced by a larger automation process.


key: baselineId

description: The 'id' property of a separate (potentially external) SARIF 'run' instance that comprises the baseline that was used to compute result 'baselineState' properties for the run.


key: architecture

description: The hardware architecture for which the run was targeted.


key: stack

description: A call stack that is relevant to a result.


key: message

description: A message relevant to this call stack.


key: frames

description: An array of stack frames that represent a sequence of calls, rendered in reverse chronological order, that comprise the call stack.


key: properties

description: Key/value pairs that provide additional information about the stack.


key: tags

description: A set of distinct strings that provide additional information.


key: stackFrame

description: A function call within a stack trace.


description: A message relevant to this stack frame.


key: uri

description: The uri of the source code file to which this stack frame refers.


key: uriBaseId

description: A string that identifies the conceptual base for the 'uri' property (if it is relative), e.g.,'$(SolutionDir)' or '%SRCROOT%'.


key: line

description: The line of the location to which this stack frame refers.


key: column


key: module

description: The name of the module that contains the code of this stack frame.


key: threadId

description: The thread identifier of the stack frame.


key: fullyQualifiedLogicalName

description: The fully qualified name of the method or function that is executing.


key: logicalLocationKey

description: A key used to retrieve the stack frame logicalLocation from the logicalLocations dictionary, when the 'fullyQualifiedLogicalName' is not unique.


key: address

description: The address of the method or function that is executing.


key: offset

description: The offset from the method or function that is executing.


key: parameters

description: The parameters of the call that is executing.


description: Key/value pairs that provide additional information about the stack frame.


key: tool

description: The analysis tool that was run.


key: name

description: The name of the tool.


key: fullName

description: The name of the tool along with its version and any other useful identifying information, such as its locale.


key: version

description: The tool version, in whatever format the tool natively provides.


key: semanticVersion

description: The tool version in the format specified by Semantic Versioning 2.0.


key: fileVersion

description: The binary version of the tool's primary executable file (for operating systems such as Windows that provide that information).


key: sarifLoggerVersion

description: A version that uniquely identifies the SARIF logging component that generated this file, if it is versioned separately from the tool.


key: language

description: The tool language (expressed as an ISO 649 two-letter lowercase culture code) and region (expressed as an ISO 3166 two-letter uppercase subculture code associated with a country or region).


key: properties

description: Key/value pairs that provide additional information about the tool.


key: tags

description: A set of distinct strings that provide additional information.


key: $schema

description: The URI of the JSON schema corresponding to the version.


description: The SARIF format version of this log file.


key: runs

description: The set of runs contained in this log file.


key: schemas

description: A list of JSON schema references.

required: name url description


key: fileMatch

description: A Minimatch glob expression for matching up file names with a schema.


key: url

description: An absolute URL to the schema location


description: The name of the schema


key: description

description: A description of the schema


key: versions

description: A set of specific version to schema mappings


description: The schema version of the catalog


description: Link to https://json.schemastore.org/schema-catalog.json


description: Define the schema for the the Transcend AI Proxy service.

required: routeName enabledPolicies

const: redactEmail

const: log


description: Defines an op

type: array string

format: regex

type: array boolean number object string

type: string number

required: username password

format: uri-reference

required: range run


description: Name of the op


description: Description of the op


key: inputs

description: Parameter of an op


key: array

description: Array parameter of an op


key: isSecret

description: If the array is secret


key: additionalItems

description: JSON Schema [additionalItems keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.10)


key: items

description: JSON Schema [items keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.9)


key: maxItems

description: JSON Schema [maxItems keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.10)


key: minItems

description: JSON Schema [minItems keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.11)


key: uniqueItems

description: JSON Schema [uniqueItems keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.13)


key: boolean

description: Boolean parameter of an op


key: default

description: Default value


key: dir

description: Directory parameter of an op


description: Markdown in [v0.28 CommonMark syntax](http://spec.commonmark.org/0.28/) including GFM table extension


description: Default value; an absolute path rooted at dir containing op.yml or, a relative path interpreted from where the op is started


description: If the directory is secret


key: file

description: File parameter of an op


description: If the file is secret


key: number

description: Number parameter of an op


description: If the number is secret


key: properties

description: JSON Schema [allOf keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.22)


description: JSON Schema [anyOf keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.23)


key: enum

description: JSON Schema [enum keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.20)


key: format

description: Requires the number be an integer


key: maximum

description: JSON Schema [maximum keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.2)


key: minimum

description: JSON Schema [minimum keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.4)


key: multipleOf

description: JSON Schema [multipleOf keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.1)


key: not

description: JSON Schema [not keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.25)


description: JSON Schema [oneOf keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.24)


key: object

description: Object parameter of an op


key: isSecret

description: If the object is secret


key: additionalProperties

description: JSON Schema [additionalProperties keyword](https://tools.ietf.org/html/draft-handrews-json-schema-validation-00#section-6.5.6)


key: dependencies

description: JSON Schema [dependencies keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.19)


key: maxProperties

description: JSON Schema [maxProperties keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.13)


key: minProperties

description: JSON Schema [minProperties keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.14)


description: JSON Schema [properties keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.16)


description: Parameter constraints


key: description

description: JSON Schema [description](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-6.1)


key: title

description: JSON Schema [title](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-6.1)


key: type

description: JSON Schema [type](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.21)


key: writeOnly

description: JSON Schema [writeOnly](https://tools.ietf.org/html/draft-handrews-json-schema-validation-00#section-10.3)


key: patternProperties

description: JSON Schema [patternProperties keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.17)


key: required

description: JSON Schema [required keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.15)


key: socket

description: Socket parameter of an op


description: If the socket is secret


key: string

description: String parameter of an op


description: If the string is secret


key: properties

description: JSON Schema [allOf keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.22)


description: JSON Schema [anyOf keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.23)


key: enum

description: JSON Schema [enum keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.20)


key: format

description: Superset of JSON Schema [format keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-7)


description: JSON Schema [date-time format](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-7.3.1)


description: A docker image reference as defined by [github.com/docker/distribution/reference](https://github.com/docker/distribution/tree/docker/1.13/reference)


description: JSON Schema [email format](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-7.3.2)


description: JSON Schema [hostname format](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-7.3.3)


description: JSON Schema [ipv4 format](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-7.3.4)


description: JSON Schema [ipv6 format](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-7.3.5)


description: JSON Schema [uri format](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-7.3.6)


description: A semantic version as defined by [semver.org](http://semver.org/)


key: maxLength

description: JSON Schema [maxLength keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.6)


key: minLength

description: JSON Schema [minLength keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.7)


key: not

description: JSON Schema [not keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.25)


description: JSON Schema [oneOf keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.24)


key: pattern

description: JSON Schema [pattern keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.8)


key: run

description: A single node of the [call graph](https://en.wikipedia.org/wiki/Call_graph)

required: until run

type: array object string


key: cmd

description: Command run by a container; overrides any set at the image level


key: items

description: Expression coercible to string value


key: dirs

description: Directories in the container


(will be bound to same path in op)


Expression coercible to dir value &/or scope ref to set upon exit


key: envVars

description: Environment variables in the container


(will be bound to in scope ref w/ same name)


Expression coercible to string value


description: Reference to a value


key: files

description: Files in the container


Expression coercible to file value &/or scope ref to set upon exit


key: ref

description: Reference to an image


key: name

description: Name the container can be referenced by from other containers


key: ports

description: Ports bound from the container to the host


description: Host port(s) to bind to


description: Container socket address mapped to a socket ref


key: workDir

description: Working directory path (overrides any defined by image)


key: if

description: If any predicate evaluates to false, the call will be skipped.


description: Condition which evaluates to true or false


key: eq

description: True if all items are equal


description: Expression coercible to string value


key: exists

description: True if value exists w/ reference


key: ne

description: True if any items aren't equal


key: notExists

description: True if no value exists w/ reference


key: inputs

description: Initializes INPUT_NAME from VALUE in format 'INPUT_NAME: VALUE'. If VALUE is null, it MUST be assumed VALUE == $(INPUT_NAME)


description: Expression which evaluates to a value


key: outputs

description: Initializes NAME from OUTPUT_NAME in format 'NAME: OUTPUT_NAME'. If OUTPUT_NAME is null, it MUST be assumed NAME == OUTPUT_NAME


key: pullCreds

description: Credentials used during authentication with the source of an image or op


key: username

description: Expression coercible to string value


key: password

description: Expression coercible to string value


description: Reference to an op


key: parallelLoop

description: Loop in which all iterations are called simultaneously.


key: run

description: What gets run on each iteration of the loop


key: serialLoop

description: Loop in which each iteration gets called sequentially.


key: range

description: Range of the loop, i.e. the value to loop over


key: until

description: Exit condition of the loop; evaluated before each iteration.


key: vars

description: Variables added to scope on each iteration


key: index

description: Variable each iterations associated index will be made available through


key: key

description: Variable each iterations associated key will be made available through


key: value

description: Variable each iterations associated value will be made available through


key: version

description: Version of the op


key: opspec

description: Version of [opspec](https://opspec.io) used by the op


key: field

description: constraint: valid field path, follows avro constraints + slashes


key: type

description:
constraint: one of the validator types. handled by code
This should become an enum


description: constraint: a type specific definition


The timestamp when this Schema was created.


key: description

description: The description of this Schema. Used in the Portal. Markdown syntax is supported. This field can be modified.


description: The URI to the icon used with this Schema. This always an absolute URI, with the https scheme. Used in the Portal.


key: labels

description: Generic (key/value) labels for this Schema.


key: title

description: The human readable title of this Schema. Used in the Portal. Defaults to the Schema name. This field can be modified.


The timestamp when this Data Contract was created.


description: The description of this Data Contract. Used in the Portal. Markdown syntax is supported. This field can be modified.


description: Generic (key/value) labels for this Data Contract.


description: The human readable title of this Data Contract. Used in the Portal. Defaults to the Data Contract name if left unspecified. This field can be modified.


description: Full reference to a (nested) field. For non-top-level fields (i.e. nested fields), each level should be separated by a forward slash. E.g. customer/id.


How null values should generally be dealt with for a field.


description: If a field is of ordinal values, defines the possible values and their order.


Metadata on the type of personal data this field may contain.


The statistical data type of the field, e.g. nominal, ordinal, numerical.


description: If the type is DEFAULT_VALUE, the desired default value must be specified.


description: avro compatible name set by creator OR derived from name


key: doc

description:
constraints:
size < 5000


key: name

description: constraints: same as SimpleSchemaDefinition


key: definition

description: constraints: is no longer required provided simple_schema is not empty.


key: id

description: The UUID of this schema


description: (-- 'is' is intentional here (see https://google.aip.dev/140#booleans) --)


key: handle

description: constraints: generic name constraint


description: constraints: generic name constraint


description: constraints: `\d+\.\d+\.\d+


description: constraint: handle should already exist


description: constraints: generic name constraint, unique within handle


description: constraints: semantic version, e.g. 1.12.3


description: The special sensitive data type as defined by the GDPR https://eur-lex.europa.eu/legal-content/EN/TXT/HTML/?uri=CELEX:32016R0679#d1e2051-1-1


description: Currently, only string fields or repeated string fields can be marked as PII, since other data types cannot store an encrypted string.


description: A quasi identifier doesn't identify an individual directly, but combined with other QIs can result in a unique (direct) identifier.


description: The purpose level as defined in the purpose level mapping of an organization.


description:
PII Fields as a map, where the key is the field path (i.e. producerSessionId or customer/id) and the
 value is the purpose level, provided as an integer

deprecationMessage: Field "pii_fields" is marked as deprecated


description: constraints: overall size < 100000 TBD


description: avro compatible name set by creator OR derived from name (thus ignore_empty = true)


description: constraints: printable characters


key: namespace

description:
constraints:
dot separated sequence of name constraints
must be Avro compatible. When absent becomes <handle>.<name>.v<version>


description: The key of the label.


description: The value of the label. An empty string means there is no value.


key: globalTags

description: Sets a list of key:value tags on all spans.


key: aggregate

description: Array of objects that define fields to aggregate.


key: groupby

description: The data fields to group by. If not specified, a single group containing all data objects will be used.


key: as

description: The output field names to use for each aggregated field.


description: The data field for which to compute aggregate function.


key: op

description:
The aggregation operations to apply to the fields, such as sum, average or count.
See the [full list of supported aggregation operations](https://vega.github.io/vega-lite/docs/aggregate.html#supported-aggregation-operations)
for more information.


key: contains

description:
Determines how size calculation should be performed, one of `"content"` or `"padding"`. The default setting (`"content"`) interprets the width and height settings as the data rectangle (plotting) dimensions, to which padding is then added. In contrast, the `"padding"` setting includes the padding within the view size calculations, such that the width and height settings indicate the **total** intended size of the view.

__Default value__: `"content"`

enum: content padding


key: resize

description:
A boolean flag indicating if autosize layout should be re-calculated on every view update.

__Default value__: `false`


key: type

description:
The sizing format type. One of `"pad"`, `"fit"` or `"none"`. See the [autosize type](https://vega.github.io/vega-lite/docs/size.html#autosize) documentation for descriptions of each.

__Default value__: `"pad"`


key: domain

description:
A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

__Default value:__ `true`


key: format

description:
The formatting pattern for labels. This is D3's [number format pattern](https://github.com/d3/d3-format#locale_format) for quantitative fields and D3's [time format pattern](https://github.com/d3/d3-time-format#locale_format) for time field.

See the [format documentation](format.html) for more information.

__Default value:__  derived from [numberFormat](config.html#format) config for quantitative fields and from [timeFormat](config.html#format) config for temporal fields.


key: grid

description:
A boolean flag indicating if grid lines should be included as part of the axis

__Default value:__ `true` for [continuous scales](scale.html#continuous) that are not binned; otherwise, `false`.


key: labelAngle

description:
The rotation angle of the axis labels.

__Default value:__ `-90` for nominal and ordinal fields; `0` otherwise.


key: labelBound

description:
Indicates if labels should be hidden if they exceed the axis range. If `false `(the default) no bounds overlap analysis is performed. If `true`, labels will be hidden if they exceed the axis range by more than 1 pixel. If this property is a number, it specifies the pixel tolerance: the maximum amount by which a label bounding box may exceed the axis range.

__Default value:__ `false`.

type: boolean number


key: labelFlush

description:
Indicates if the first and last axis labels should be aligned flush with the scale range. Flush alignment for a horizontal axis will left-align the first label and right-align the last label. For vertical axes, bottom and top text baselines are applied instead. If this property is a number, it also indicates the number of pixels by which to offset the first and last labels; for example, a value of 2 will flush-align the first and last labels and also push them 2 pixels outward from the center of the axis. The additional adjustment can sometimes help the labels better visually group with corresponding axis ticks.

__Default value:__ `true` for axis of a continuous x-scale. Otherwise, `false`.


key: labelOverlap

description:
The strategy to use for resolving overlap of axis labels. If `false` (the default), no overlap reduction is attempted. If set to `true` or `"parity"`, a strategy of removing every other label is used (this works well for standard linear axes). If set to `"greedy"`, a linear scan of the labels is performed, removing any labels that overlaps with the last visible label (this often works better for log-scaled axes).

__Default value:__ `true` for non-nominal fields with non-log scales; `"greedy"` for log scales; otherwise `false`.

type: string


key: labelPadding

description: The padding, in pixels, between axis and text labels.


key: labels

description:
A boolean flag indicating if labels should be included as part of the axis.

__Default value:__  `true`.


key: maxExtent

description:
The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

__Default value:__ `undefined`.


key: minExtent

description:
The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

__Default value:__ `30` for y-axis; `undefined` for x-axis.


key: offset

description:
The offset, in pixels, by which to displace the axis from the edge of the enclosing group or data rectangle.

__Default value:__ derived from the [axis config](config.html#facet-scale-config)'s `offset` (`0` by default)


key: orient

description:
The orientation of the axis. One of `"top"`, `"bottom"`, `"left"` or `"right"`. The orientation can be used to further specialize the axis type (e.g., a y axis oriented for the right edge of the chart).

__Default value:__ `"bottom"` for x-axes and `"left"` for y-axes.


key: position

description:
The anchor position of the axis in pixels. For x-axis with top or bottom orientation, this sets the axis group x coordinate. For y-axis with left or right orientation, this sets the axis group y coordinate.

__Default value__: `0`


key: tickCount

description: A desired number of ticks, for axes visualizing quantitative scales. The resulting number may be different so that values are "nice" (multiples of 2, 5, 10) and lie within the underlying scale's range.


key: tickSize

description: The size in pixels of axis ticks.


key: ticks

description: Boolean value that determines whether the axis should include ticks.


key: title

description:
A title for the field. If `null`, the title will be removed.

__Default value:__  derived from the field's name and transformation function (`aggregate`, `bin` and `timeUnit`).  If the field has an aggregate function, the function is displayed as a part of the title (e.g., `"Sum of Profit"`). If the field is binned or has a time unit applied, the applied function will be denoted in parentheses (e.g., `"Profit (binned)"`, `"Transaction Date (year-month)"`).  Otherwise, the title is simply the field name.

__Note__: You can customize the default field title format by providing the [`fieldTitle` property in the [config](config.html) or [`fieldTitle` function via the `compile` function's options](compile.html#field-title).


key: titleMaxLength

description: Max length for axis title if the title is automatically generated from the field's description.


key: titlePadding

description: The padding, in pixels, between title and axis.


key: values

description: Explicitly set the visible axis tick values.

type: array


key: zindex

description:
A non-positive integer indicating z-index of the axis.
If zindex is 0, axes should be drawn behind all chart elements.
To put them in front, use `"zindex = 1"`.

__Default value:__ `1` (in front of the marks) for actual axis and `0` (behind the marks) for grids.


key: bandPosition

description: An interpolation fraction indicating where, for `band` scales, axis ticks should be positioned. A value of `0` places ticks at the left edge of their bands. A value of `0.5` places ticks in the middle of their bands.


key: domain

description:
A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

__Default value:__ `true`


key: domainColor

description:
Color of axis domain line.

__Default value:__  (none, using Vega default).


key: domainWidth

description:
Stroke width of axis domain line

__Default value:__  (none, using Vega default).


key: grid

description:
A boolean flag indicating if grid lines should be included as part of the axis

__Default value:__ `true` for [continuous scales](scale.html#continuous) that are not binned; otherwise, `false`.


key: gridColor

description: Color of gridlines.


key: gridDash

description: The offset (in pixels) into which to begin drawing with the grid dash array.


key: gridOpacity

description:
The stroke opacity of grid (value between [0,1])

__Default value:__ (`1` by default)


key: gridWidth

description: The grid width, in pixels.


key: labelAngle

description:
The rotation angle of the axis labels.

__Default value:__ `-90` for nominal and ordinal fields; `0` otherwise.


key: labelBound

description:
Indicates if labels should be hidden if they exceed the axis range. If `false `(the default) no bounds overlap analysis is performed. If `true`, labels will be hidden if they exceed the axis range by more than 1 pixel. If this property is a number, it specifies the pixel tolerance: the maximum amount by which a label bounding box may exceed the axis range.

__Default value:__ `false`.


key: labelColor

description: The color of the tick label, can be in hex color code or regular color name.


key: labelFlush

description:
Indicates if the first and last axis labels should be aligned flush with the scale range. Flush alignment for a horizontal axis will left-align the first label and right-align the last label. For vertical axes, bottom and top text baselines are applied instead. If this property is a number, it also indicates the number of pixels by which to offset the first and last labels; for example, a value of 2 will flush-align the first and last labels and also push them 2 pixels outward from the center of the axis. The additional adjustment can sometimes help the labels better visually group with corresponding axis ticks.

__Default value:__ `true` for axis of a continuous x-scale. Otherwise, `false`.


key: labelFont

description: The font of the tick label.


key: labelFontSize

description: The font size of the label, in pixels.


key: labelLimit

description: Maximum allowed pixel width of axis tick labels.


key: labelOverlap

description:
The strategy to use for resolving overlap of axis labels. If `false` (the default), no overlap reduction is attempted. If set to `true` or `"parity"`, a strategy of removing every other label is used (this works well for standard linear axes). If set to `"greedy"`, a linear scan of the labels is performed, removing any labels that overlaps with the last visible label (this often works better for log-scaled axes).

__Default value:__ `true` for non-nominal fields with non-log scales; `"greedy"` for log scales; otherwise `false`.


key: labelPadding

description: The padding, in pixels, between axis and text labels.


key: labels

description:
A boolean flag indicating if labels should be included as part of the axis.

__Default value:__  `true`.


key: maxExtent

description:
The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

__Default value:__ `undefined`.


key: minExtent

description:
The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

__Default value:__ `30` for y-axis; `undefined` for x-axis.


key: shortTimeLabels

description:
Whether month names and weekday names should be abbreviated.

__Default value:__  `false`


key: tickColor

description: The color of the axis's tick.


key: tickRound

description: Boolean flag indicating if pixel position values should be rounded to the nearest integer.


key: tickSize

description: The size in pixels of axis ticks.


key: tickWidth

description: The width, in pixels, of ticks.


key: ticks

description: Boolean value that determines whether the axis should include ticks.


key: titleAlign

description: Horizontal text alignment of axis titles.


key: titleAngle

description: Angle in degrees of axis titles.


key: titleBaseline

description: Vertical text baseline for axis titles.


key: titleColor

description: Color of the title, can be in hex color code or regular color name.


key: titleFont

description: Font of the title. (e.g., `"Helvetica Neue"`).


key: titleFontSize

description: Font size of the title.


key: titleFontWeight

description: Font weight of the title. (e.g., `"bold"`).


key: titleLimit

description: Maximum allowed pixel width of axis titles.


key: titleMaxLength

description: Max length for axis title if the title is automatically generated from the field's description.


key: titlePadding

description: The padding, in pixels, between title and axis.


key: titleX

description: X-coordinate of the axis title relative to the axis group.


key: titleY

description: Y-coordinate of the axis title relative to the axis group.


key: axis

description: Axis configuration, which determines default properties for all `x` and `y` [axes](axis.html). For a full list of axis configuration options, please see the [corresponding section of the axis documentation](axis.html#config).


key: axisBand

description: Specific axis config for axes with "band" scales.


key: axisBottom

description: Specific axis config for x-axis along the bottom edge of the chart.


key: axisLeft

description: Specific axis config for y-axis along the left edge of the chart.


key: axisRight

description: Specific axis config for y-axis along the right edge of the chart.


key: axisTop

description: Specific axis config for x-axis along the top edge of the chart.


key: axisX

description: X-axis specific config.


key: axisY

description: Y-axis specific config.


key: align

description: The horizontal alignment of the text. One of `"left"`, `"right"`, `"center"`.


key: angle

description: The rotation angle of the text, in degrees.


key: baseline

description:
The vertical alignment of the text. One of `"top"`, `"middle"`, `"bottom"`.

__Default value:__ `"middle"`


key: binSpacing

description:
Offset between bar for binned field.  Ideal value for this is either 0 (Preferred by statisticians) or 1 (Vega-Lite Default, D3 example style).

__Default value:__ `1`


key: color

description:
Default color.  Note that `fill` and `stroke` have higher precedence than `color` and will override `color`.

__Default value:__ ■ `"#4682b4"`

__Note:__ This property cannot be used in a [style config](mark.html#style-config).


key: continuousBandSize

description:
The default size of the bars on continuous scales.

__Default value:__ `5`


key: discreteBandSize

description:
The size of the bars.  If unspecified, the default size is  `bandSize-1`,
which provides 1 pixel offset between bars.


key: dx

description: The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the _angle_ property.


key: dy

description: The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the _angle_ property.


key: fill

description:
Default Fill Color.  This has higher precedence than config.color

__Default value:__ (None)


key: fillOpacity

description:
The fill opacity (value between [0,1]).

__Default value:__ `1`


key: filled

description:
Whether the mark's color should be used as fill color instead of stroke color.

__Default value:__ `true` for all marks except `point` and `false` for `point`.

__Applicable for:__ `bar`, `point`, `circle`, `square`, and `area` marks.

__Note:__ This property cannot be used in a [style config](mark.html#style-config).


key: font

description: The typeface to set the text in (e.g., `"Helvetica Neue"`).


key: fontSize

description: The font size, in pixels.


key: fontStyle

description: The font style (e.g., `"italic"`).


key: fontWeight

description: The font weight (e.g., `"bold"`).


key: interpolate

description:
The line interpolation method to use for line and area marks. One of the following:
- `"linear"`: piecewise linear segments, as in a polyline.
- `"linear-closed"`: close the linear segments to form a polygon.
- `"step"`: alternate between horizontal and vertical segments, as in a step function.
- `"step-before"`: alternate between vertical and horizontal segments, as in a step function.
- `"step-after"`: alternate between horizontal and vertical segments, as in a step function.
- `"basis"`: a B-spline, with control point duplication on the ends.
- `"basis-open"`: an open B-spline; may not intersect the start or end.
- `"basis-closed"`: a closed B-spline, as in a loop.
- `"cardinal"`: a Cardinal spline, with control point duplication on the ends.
- `"cardinal-open"`: an open Cardinal spline; may not intersect the start or end, but will intersect other control points.
- `"cardinal-closed"`: a closed Cardinal spline, as in a loop.
- `"bundle"`: equivalent to basis, except the tension parameter is used to straighten the spline.
- `"monotone"`: cubic interpolation that preserves monotonicity in y.


key: limit

description: The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.


key: opacity

description:
The overall opacity (value between [0,1]).

__Default value:__ `0.7` for non-aggregate plots with `point`, `tick`, `circle`, or `square` marks or layered `bar` charts and `1` otherwise.


key: orient

description:
The orientation of a non-stacked bar, tick, area, and line charts.
The value is either horizontal (default) or vertical.
- For bar, rule and tick, this determines whether the size of the bar and tick
should be applied to x or y dimension.
- For area, this property determines the orient property of the Vega output.
- For line, this property determines the sort order of the points in the line
if `config.sortLineBy` is not specified.
For stacked charts, this is always determined by the orientation of the stack;
therefore explicitly specified value will be ignored.


key: radius

description: Polar coordinate radial offset, in pixels, of the text label from the origin determined by the `x` and `y` properties.


key: shape

description:
The default symbol shape to use. One of: `"circle"` (default), `"square"`, `"cross"`, `"diamond"`, `"triangle-up"`, or `"triangle-down"`, or a custom SVG path.

__Default value:__ `"circle"`


key: size

description:
The pixel area each the point/circle/square.
For example: in the case of circles, the radius is determined in part by the square root of the size value.

__Default value:__ `30`


key: stroke

description:
Default Stroke Color.  This has higher precedence than config.color

__Default value:__ (None)


key: strokeDash

description: An array of alternating stroke, space lengths for creating dashed or dotted lines.


key: strokeDashOffset

description: The offset (in pixels) into which to begin drawing with the stroke dash array.


key: strokeOpacity

description:
The stroke opacity (value between [0,1]).

__Default value:__ `1`


key: strokeWidth

description: The stroke width, in pixels.


key: tension

description: Depending on the interpolation type, sets the tension parameter (for line and area marks).


key: text

description: Placeholder text if the `text` channel is not specified


key: theta

description: Polar coordinate angle, in radians, of the text label from the origin determined by the `x` and `y` properties. Values for `theta` follow the same convention of `arc` mark `startAngle` and `endAngle` properties: angles are measured in radians, with `0` indicating "north".


key: base

description:
The number base to use for automatic bin determination (default is base 10).

__Default value:__ `10`


key: divide

description:
Scale factors indicating allowable subdivisions. The default value is [5, 2], which indicates that for base 10 numbers (the default base), the method may consider dividing bin sizes by 5 and/or 2. For example, for an initial step size of 10, the method can check if bin sizes of 2 (= 10/5), 5 (= 10/2), or 1 (= 10/(5*2)) might also satisfy the given constraints.

__Default value:__ `[5, 2]`


key: maxbins

description:
Maximum number of bins.

__Default value:__ `6` for `row`, `column` and `shape` channels; `10` for other channels


key: minstep

description: A minimum allowable step size (particularly useful for integer values).


key: nice

description: If true (the default), attempts to make the bin boundaries use human-friendly boundaries, such as multiples of ten.


key: step

description:
An exact step size to use between bins.

__Note:__ If provided, options such as maxbins will be ignored.


key: steps

description: An array of allowable step sizes to choose from.


key: empty

description:
By default, all data values are considered to lie within an empty selection.
When set to `none`, empty selections contain no data values.


key: encodings

description:
An array of encoding channels. The corresponding data field values
must match for a data tuple to fall within the selection.


key: fields

description:
An array of field names whose values must match for a data tuple to
fall within the selection.


key: on

description:
A [Vega event stream](https://vega.github.io/vega/docs/event-streams/) (object or selector) that triggers the selection.
For interval selections, the event stream must specify a [start and end](https://vega.github.io/vega/docs/event-streams/#between-filters).


key: resolve

description:
With layered and multi-view displays, a strategy that determines how
selections' data queries are resolved when applied in a filter transform,
conditional encoding rule, or scale domain.


key: data

description: An object describing the data source


key: description

description: Description of this mark for commenting purpose.


key: name

description: Name of the visualization for later reference.


key: title

description: Title for the plot.


key: transform

description: An array of data transformations such as filter and new field calculation.


key: BinParams

description: Binning properties or boolean flag for determining whether to bin data or not.

type: object


key: base


key: divide


key: extent

description: A two-element (`[min, max]`) array indicating the range of desired bin values.


key: maxbins


key: minstep


key: nice

type: boolean


key: step


key: steps


key: as

description: The output fields at which to write the start and end bin values.


key: bin

description: An object indicating bin properties, or simply `true` for using default bin parameters.


key: field

description: The data field to bin.


key: align

description: The horizontal alignment of the text. One of `"left"`, `"right"`, `"center"`.


key: angle

description: The rotation angle of the text, in degrees.


key: baseline

description:
The vertical alignment of the text. One of `"top"`, `"middle"`, `"bottom"`.

__Default value:__ `"middle"`


key: color

description:
Default color.  Note that `fill` and `stroke` have higher precedence than `color` and will override `color`.

__Default value:__ ■ `"#4682b4"`

__Note:__ This property cannot be used in a [style config](mark.html#style-config).


key: dx

description: The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the _angle_ property.


key: dy

description: The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the _angle_ property.


key: fill

description:
Default Fill Color.  This has higher precedence than config.color

__Default value:__ (None)


key: fillOpacity

description:
The fill opacity (value between [0,1]).

__Default value:__ `1`


key: filled

description:
Whether the mark's color should be used as fill color instead of stroke color.

__Default value:__ `true` for all marks except `point` and `false` for `point`.

__Applicable for:__ `bar`, `point`, `circle`, `square`, and `area` marks.

__Note:__ This property cannot be used in a [style config](mark.html#style-config).


key: font

description: The typeface to set the text in (e.g., `"Helvetica Neue"`).


key: fontSize

description: The font size, in pixels.


key: fontStyle

description: The font style (e.g., `"italic"`).


key: fontWeight

description: The font weight (e.g., `"bold"`).


key: interpolate

description:
The line interpolation method to use for line and area marks. One of the following:
- `"linear"`: piecewise linear segments, as in a polyline.
- `"linear-closed"`: close the linear segments to form a polygon.
- `"step"`: alternate between horizontal and vertical segments, as in a step function.
- `"step-before"`: alternate between vertical and horizontal segments, as in a step function.
- `"step-after"`: alternate between horizontal and vertical segments, as in a step function.
- `"basis"`: a B-spline, with control point duplication on the ends.
- `"basis-open"`: an open B-spline; may not intersect the start or end.
- `"basis-closed"`: a closed B-spline, as in a loop.
- `"cardinal"`: a Cardinal spline, with control point duplication on the ends.
- `"cardinal-open"`: an open Cardinal spline; may not intersect the start or end, but will intersect other control points.
- `"cardinal-closed"`: a closed Cardinal spline, as in a loop.
- `"bundle"`: equivalent to basis, except the tension parameter is used to straighten the spline.
- `"monotone"`: cubic interpolation that preserves monotonicity in y.


key: limit

description: The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.


key: opacity

description:
The overall opacity (value between [0,1]).

__Default value:__ `0.7` for non-aggregate plots with `point`, `tick`, `circle`, or `square` marks or layered `bar` charts and `1` otherwise.


key: orient

description:
The orientation of a non-stacked bar, tick, area, and line charts.
The value is either horizontal (default) or vertical.
- For bar, rule and tick, this determines whether the size of the bar and tick
should be applied to x or y dimension.
- For area, this property determines the orient property of the Vega output.
- For line, this property determines the sort order of the points in the line
if `config.sortLineBy` is not specified.
For stacked charts, this is always determined by the orientation of the stack;
therefore explicitly specified value will be ignored.