nest-cli.json

$id: #Configuration

description: A map with keys specifying compiler options and values specifying the option setting. See https://docs.nestjs.com/cli/monorepo#global-compiler-options for details

description: (monorepo only) Points at the file containing the tsconfig.json settings that will be used when nest build or nest start is called without a project option (e.g., when the default project is built or started). 'nest build' will not work as expected without this file.

default: tsc

enum: tsc webpack swc

description: Builder to be used (tsc, webpack, swc). For details on how to configure `SWC` see https://docs.nestjs.com/recipes/swc#getting-started

description: If true, enable type checking (when SWC is used). See https://docs.nestjs.com/recipes/swc#type-checking for details.

description: If true, use webpack compiler (deprecated option, use `builder` instead). If false or not present, use tsc. In monorepo mode, the default is true (use webpack), in standard mode, the default is false (use tsc). See https://docs.nestjs.com/cli/monorepo#cli-properties for details.

description: Points at a webpack options file. If not specified, Nest looks for the file webpack.config.js.

$ref: #/definitions/PluginItems

$ref: #/definitions/AssetsOptions

description: Enables automatically distributing non-TypeScript assets whenever a compilation step begins (asset distribution does not happen on incremental compiles in --watch mode). Accept glob-like string and object. See https://docs.nestjs.com/cli/monorepo#assets for details.

description: If true, run in watch-mode, watching all non-TypeScript assets. Setting watchAssets in a top-level compilerOptions property overrides any watchAssets settings within the assets property.

description: If true, whenever the compiler is invoked, it will first remove the compilation output directory (as configured in tsconfig.json, where the default is ./dist).

description: If true, enables the shortcut `rs` to manually restart the server.

description: For finer control, the element can be object.

description: Glob-like file specifications for the assets to be distributed.

description: Glob-like file specifications for the assets to be excluded from the include list.

description: A string specifying the path (relative to the root folder) where the assets should be distributed. Defaults to the same output directory configured for compiler output.

description: If true, run in watch mode watching specified assets. Setting watchAssets in a top-level compilerOptions property overrides any watchAssets settings within the assets property.

description: A map with keys specifying global generate options and values specifying the option setting. See https://docs.nestjs.com/cli/monorepo#global-generate-options for details

$ref: #/definitions/GenerateSpecOptions

$ref: #/definitions/GenerateFlatOptions

$ref: #/definitions/GenerateBaseDirOptions

description: If true, all generate commands will generate a flat structure

type: boolean object

description: If the value is boolean, a value of true enables spec generation by default and a value of false disables it. A flag passed on the CLI command line overrides this setting, as does a project-specific generateOptions setting (more below). If the value is an object, each key represents a schematic name, and the boolean value determines whether the default spec generation is enabled / disabled for that specific schematic. See https://docs.nestjs.com/cli/monorepo#global-generate-options for details.

description: Generate spec file for application schematics or not.

description: Disable spec file generation for class schematics.

description: Alias for class

description: Generate spec file for configuration schematics or not.

description: Alias for configuration

description: Generate spec file for controller schematics or not.

description: Alias for controller

description: Generate spec file for decorator schematics or not.

description: Alias fro decorator

description: Generate spec file for filter schematics or not.

description: Alias for filter

description: Generate spec file for gateway schematics or not.

description: Alias for gateway

description: Generate spec file for guard schematics or not.

description: Alias for guard

description: Generate spec file for interceptor schematics or not.

description: Alias for interceptor

description: Generate spec file for interface schematics or not.

description: Generate spec file for middleware schematics or not.

description: Alias for middleware

description: Generate spec file for module schematics or not.

description: Alias for module

description: Generate spec file for pipe schematics or not.

description: Alias for pipe

description: Generate spec file for provider schematics or not.

description: Alias for provider

description: Generate spec file for resolver schematics or not.

description: Alias for resolver

description: Generate spec file for service schematics or not.

description: Alias for resolver

description: Generate spec file for library schematics or not.

description: Alias for library

description: Generate spec file for sub-app schematics or not.

description: Alias for sub-app

description: Generate spec file for resource schematics or not.

description: Alias for resource

description: Base directory

$ref: #/definitions/CompilerOptions

$ref: #/definitions/GenerateOptions

description: The npm package name of the cli plugin, eg @nestjs/swagger.

$ref: #/definitions/PluginOptions

$ref: #/definitions/GraphQLPluginOptions

$ref: #/definitions/SwaggerPluginOptions

description: If set to true, plugin will generate descriptions and example values for properties based on comments.

description: (GraphQL Only) GraphQL types files suffix. Default value: ['.input.ts', '.args.ts', '.entity.ts', '.model.ts']. See https://docs.nestjs.com/graphql/cli-plugin#using-the-cli-plugin for details.

description: (Swagger Only) DTO (Data Transfer Object) files suffix. Default value: ['.dto.ts', '.entity.ts']. See https://docs.nestjs.com/openapi/cli-plugin#using-the-cli-plugin for details

description: (Swagger Only) Controller files suffix. See https://docs.nestjs.com/openapi/cli-plugin#using-the-cli-plugin for details

description: (Swagger Only) If set to true, the module will reuse class-validator validation decorators (e.g. @Max(10) will add max: 10 to schema definition). See https://docs.nestjs.com/openapi/cli-plugin#using-the-cli-plugin for details

default: description

description: (Swagger Only) The property key to set the comment text to on ApiProperty. See https://docs.nestjs.com/openapi/cli-plugin#using-the-cli-plugin for details

description: (Swagger Only) The property key to set the comment text to on ApiOperation. See https://docs.nestjs.com/openapi/cli-plugin#using-the-cli-plugin for details

default: ts

description: Points at the collection of schematics used to generate components. you generally should not change this value.

default: src

description: Points at the root of the source code for the single project in standard mode structures, or the default project in monorepo mode structures.

default: main

description: The entry file where 'nest start' work with. Default to 'main'.

description: (monorepo only) For a monorepo mode structure, this value is always true.

description: (monorepo only) Points at the project root of the default project.

title: Nest CLI configuration


github-workflow.json

type: string

$ref: #/definitions/globs

description:
When using the push and pull_request events, you can configure a workflow to run on specific branches or tags. If you only define only tags or only branches, the workflow won't run for events affecting the undefined Git ref.
The branches, branches-ignore, tags, and tags-ignore keywords accept glob patterns that use the * and ** wildcard characters to match more than one branch or tag name. For more information, see https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet.
The patterns defined in branches and tags are evaluated against the Git ref's name. For example, defining the pattern mona/octocat in branches will match the refs/heads/mona/octocat Git ref. The pattern releases/** will match the refs/heads/releases/10 Git ref.
You can use two types of filters to prevent a workflow from running on pushes and pull requests to tags and branches:
- branches or branches-ignore - You cannot use both the branches and branches-ignore filters for the same event in a workflow. Use the branches filter when you need to filter branches for positive matches and exclude branches. Use the branches-ignore filter when you only need to exclude branch names.
- tags or tags-ignore - You cannot use both the tags and tags-ignore filters for the same event in a workflow. Use the tags filter when you need to filter tags for positive matches and exclude tags. Use the tags-ignore filter when you only need to exclude tag names.
You can exclude tags and branches using the ! character. The order that you define patterns matters.
- A matching negative pattern (prefixed with !) after a positive match will exclude the Git ref.
- A matching positive pattern after a negative match will include the Git ref again.

type: object

description: To cancel any currently running job or workflow in the same concurrency group, specify cancel-in-progress: true.

type: boolean

$ref: #/definitions/expressionSyntax

type: number

$ref: #/definitions/configuration

type: array

description: The Docker image to use as the container to run the action. The value can be the Docker Hub image name or a registry name.

description: If the image's container registry requires authentication to pull the image, you can use credentials to set a map of the username and password. The credentials are the same values that you would provide to the `docker login` command.

$ref: #/definitions/env

description: Sets an array of environment variables in the container.

description: Sets an array of ports to expose on the container.

description:
Sets an array of volumes for the container to use. You can use volumes to share data between services or other steps in a job. You can specify named Docker volumes, anonymous Docker volumes, or bind mounts on the host.
To specify a volume, you specify the source and destination path: <source>:<destinationPath>
The <source> is a volume name or an absolute path on the host machine, and <destinationPath> is an absolute path in the container.

description: Additional Docker container resource options. For a list of options, see https://docs.docker.com/engine/reference/commandline/create/#options.

$ref: #/definitions/shell

$ref: #/definitions/working-directory

description: You can modify the default permissions granted to the GITHUB_TOKEN, adding or removing access as required, so that you only allow the minimum required access.

enum: read-all write-all

$ref: #/definitions/permissions-event

$ref: #/definitions/permissions-level

enum: read write none

description: To set custom environment variables, you need to specify the variables in the workflow file. You can define environment variables for a step, job, or entire workflow using the jobs.<job_id>.steps[*].env, jobs.<job_id>.env, and env keywords. For more information, see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv

description: The environment that the job references

description: The name of the environment configured in the repo.

description: A deployment URL

$comment: escape `{` and `}` in pattern to be unicode compatible (#1360)

enum: linux macos windows

description:
When using the push and pull_request events, you can configure a workflow to run when at least one file does not match paths-ignore or at least one modified file matches the configured paths. Path filters are not evaluated for pushes to tags.
The paths-ignore and paths keywords accept glob patterns that use the * and ** wildcard characters to match more than one path name. For more information, see https://help.github.com/en/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet.
You can exclude paths using two types of filters. You cannot use both of these filters for the same event in a workflow.
- paths-ignore - Use the paths-ignore filter when you only need to exclude path names.
- paths - Use the paths filter when you need to filter paths for positive matches and exclude paths.

$ref: #/definitions/branch

$ref: #/definitions/path

required: branches branches-ignore

required: tags tags-ignore

required: paths paths-ignore

description: You can override the default shell settings in the runner's operating system using the shell keyword. You can use built-in shell keywords, or you can define a custom set of shell options.

enum: bash pwsh python sh cmd powershell

description:
Selects the types of activity that will trigger a workflow run. Most GitHub events are triggered by more than one type of activity. For example, the event for the release resource is triggered when a release is published, unpublished, created, edited, deleted, or prereleased. The types keyword enables you to narrow down activity that causes the workflow to run. When only one activity type triggers a webhook event, the types keyword is unnecessary.
You can use an array of event types. For more information about each event and their activity types, see https://help.github.com/en/articles/events-that-trigger-workflows#webhook-events.

description: Using the working-directory keyword, you can specify the working directory of where to run the command.

description: Identifies any jobs that must complete successfully before this job will run. It can be a string or array of strings. If a job fails, all jobs that need it are skipped unless the jobs use a conditional statement that causes the job to continue.

$ref: #/definitions/name

description: Each job must have an id to associate with the job. The key job_id is a string and its value is a map of the job's configuration data. You must replace <job_id> with a string that is unique to the jobs object. The <job_id> must start with a letter or _ and contain only alphanumeric characters, -, or _.

description: The name of the job displayed on GitHub.

$ref: #/definitions/jobNeeds

description:
You can use the if conditional to prevent a job from running unless a condition is met. You can use any supported context and expression to create a conditional.
Expressions in an if conditional do not require the ${{ }} syntax. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions.

type: boolean number string

description: The location and version of a reusable workflow file to run as a job, of the form './{path/to}/{localfile}.yml' or '{owner}/{repo}/{path}/{filename}@{ref}'. {ref} can be a SHA, a release tag, or a branch name. Using the commit SHA is the safest for stability and security.

description: A map of inputs that are passed to the called workflow. Any inputs that you pass must match the input specifications defined in the called workflow. Unlike 'jobs.<job_id>.steps[*].with', the inputs you pass with 'jobs.<job_id>.with' are not be available as environment variables in the called workflow. Instead, you can reference the inputs by using the inputs context.

description: When a job is used to call a reusable workflow, you can use 'secrets' to provide a map of secrets that are passed to the called workflow. Any secrets that you pass must match the names defined in the called workflow.

description: A strategy creates a build matrix for your jobs. You can define different variations of an environment to run each job in.

description:
A build matrix is a set of different configurations of the virtual environment. For example you might run a job against more than one supported version of a language, operating system, or tool. Each configuration is a copy of the job that runs and reports a status.
You can specify a matrix by supplying an array for the configuration options. For example, if the GitHub virtual environment supports Node.js versions 6, 8, and 10 you could specify an array of those versions in the matrix.
When you define a matrix of operating systems, you must set the required runs-on keyword to the operating system of the current job, rather than hard-coding the operating system name. To access the operating system name, you can use the matrix.os context parameter to set runs-on. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions.

description: When set to true, GitHub cancels all in-progress jobs if any matrix job fails. Default: true

description: The maximum number of jobs that can run simultaneously when using a matrix job strategy. By default, GitHub will maximize the number of jobs run in parallel depending on the available runners on GitHub-hosted virtual machines.

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.

description: The name of the job displayed on GitHub.

description: The type of machine to run the job on. The machine can be either a GitHub-hosted runner, or a self-hosted runner.

description: The environment that the job references.

description: A map of outputs for a job. Job outputs are available to all downstream jobs that depend on this job.

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

description: A map of default settings that will apply to all steps in the job.

description:
A job contains a sequence of tasks called steps. Steps can run commands, run setup tasks, or run an action in your repository, a public repository, or an action published in a Docker registry. Not all steps run actions, but all actions run as a step. Each step runs in its own process in the virtual environment and has access to the workspace and filesystem. Because steps run in their own process, changes to environment variables are not preserved between steps. GitHub provides built-in steps to set up and complete a job.
Must contain either `uses` or `run`

description: A unique identifier for the step. You can use the id to reference the step in contexts. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions.

description:
You can use the if conditional to prevent a step from running unless a condition is met. You can use any supported context and expression to create a conditional.
Expressions in an if conditional do not require the ${{ }} syntax. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions.

description: A name for your step to display on GitHub.

description:
Selects an action to run as part of a step in your job. An action is a reusable unit of code. You can use an action defined in the same repository as the workflow, a public repository, or in a published Docker container image (https://hub.docker.com/).
We strongly recommend that you include the version of the action you are using by specifying a Git ref, SHA, or Docker tag number. If you don't specify a version, it could break your workflows or cause unexpected behavior when the action owner publishes an update.
- Using the commit SHA of a released action version is the safest for stability and security.
- Using the specific major action version allows you to receive critical fixes and security patches while still maintaining compatibility. It also assures that your workflow should still work.
- Using the master branch of an action may be convenient, but if someone releases a new major version with a breaking change, your workflow could break.
Some actions require inputs that you must set using the with keyword. Review the action's README file to determine the inputs required.
Actions are either JavaScript files or Docker containers. If the action you're using is a Docker container you must run the job in a Linux virtual environment. For more details, see https://help.github.com/en/articles/virtual-environments-for-github-actions.

description:
Runs command-line programs using the operating system's shell. If you do not provide a name, the step name will default to the text specified in the run command.
Commands run using non-login shells by default. You can choose a different shell and customize the shell used to run commands. For more information, see https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#using-a-specific-shell.
Each run keyword represents a new process and shell in the virtual environment. When you provide multi-line commands, each line runs in the same shell.

description: A map of the input parameters defined by the action. Each input parameter is a key/value pair. Input parameters are set as environment variables. The variable is prefixed with INPUT_ and converted to upper case.

description: Sets environment variables for steps to use in the virtual environment. You can also set environment variables for the entire workflow or a job.

description: Prevents a job from failing when a step fails. Set to true to allow a job to pass when this step fails.

description: The maximum number of minutes to run the step before killing the process.

description: The maximum number of minutes to let a workflow run before GitHub automatically cancels it. Default: 360

description: A strategy creates a build matrix for your jobs. You can define different variations of an environment to run each job in.

description: When set to true, GitHub cancels all in-progress jobs if any matrix job fails. Default: true

description: Prevents a workflow run from failing when a job fails. Set to true to allow a workflow run to pass when this job fails.

description:
A container to run any steps in a job that don't already specify a container. If you have steps that use both script and container actions, the container actions will run as sibling containers on the same network with the same volume mounts.
If you do not set a container, all steps will run directly on the host specified by runs-on unless a step refers to an action configured to run in a container.

description:
Additional containers to host services for a job in a workflow. These are useful for creating databases or cache services like redis. The runner on the virtual machine will automatically create a network and manage the life cycle of the service containers.
When you use a service container for a job or your step uses container actions, you don't need to set port information to access the service. Docker automatically exposes all ports between containers on the same network.
When both the job and the action run in a container, you can directly reference the container by its hostname. The hostname is automatically mapped to the service name.
When a step does not use a container action, you must access the service using localhost and bind the ports.

description: The name of your workflow. GitHub displays the names of your workflows on your repository's actions page. If you omit this field, GitHub sets the name to the workflow's filename.

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.

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

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.

enum: created rerequested completed requested_action

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/.

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.

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.

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/.

description: 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.

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

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

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

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.

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/.

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.

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

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

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/.

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 .

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/.

description: 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/.

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/.

enum: created updated closed reopened edited deleted

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.

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.

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.

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.

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.

enum: published unpublished created edited deleted prereleased released

default: published unpublished created edited deleted prereleased released

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/.

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.

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 _.

description: A string description of the input parameter.

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

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

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.

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

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.

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.

enum: string choice boolean number environment

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.

description:
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.

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).

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

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

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.

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.


jsonld.json

$ref: #/definitions/context

$ref: #/definitions/graph

$ref: #/definitions/common

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

description: 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

description: Used to set the default container type for a term.

description: Used to express an ordered set of data.

description: 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

title: Schema for JSON-LD

type: object array


drupal-info.json

const: module

title: A route name of the configuration form

$ref: #/definitions/dependency

title: Dependencies that are needed to run certain automated tests for this extension

const: theme

title: Base theme

default: classy

title: A list of libraries to add to all pages where the theme is active

title: A collection of libraries and assets to override

title: A collection of libraries and assets to add whenever a library is attached

title: The theme engine

default: twig

title: The path to logo relative to the theme's .info.yml

title: The path to screenshot relative to the theme's .info.yml file

title: A list of theme regions

title: A list of inherited regions to remove

title: A list of features to expose on the theme 'Settings' page

title: A list of stylesheets from other modules or themes to remove from all pages where the theme is active

title: A list of stylesheets to add to the CKEditor frame

const: profile

title: Declare the installation profile as a distribution

title: The distribution name

title: The theme for the distribution installation

title: Required modules

title: Modules to install to support the profile

title: List any themes that should be installed as part of the profile installation

title: Extension dependency

title: Machine name

title: The human-readable name

enum: module theme profile theme_engine

title: Semantic core version requirement

title: Extension description

title: A key that allows to group extension together an administrative pages

title: The version of the extension

title: The machine name of extension project on drupal.org

title: The date and time when the extension was packaged

type: integer

title: Do not the extension in admin interface

title: The minimal PHP version that is required for this extension

required: type core_version_requirement name

title: JSON schema for Drupal extension info file


meta-runtime.json

$ref: #/$defs/Metadata

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

$ref: #/$defs/ActionGroup

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.

title: Action Groups

$ref: #/$defs/Redirect

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

title: Import Redirection

markdownDescription: Content in a collection that Ansible needs to load from another location or that has been deprecated/removed. The top level keys of plugin_routing are types of plugins, with individual plugin names as subkeys. To define a new location for a plugin, set the redirect field to another name. To deprecate a plugin, use the deprecation field to provide a custom warning message and the removal version or date. If the plugin has been renamed or moved to a new location, the redirect field should also be provided. If a plugin is being removed entirely, tombstone can be used for the fatal error message and removal version or date.

title: Plugin Routing

title: The version of Ansible Core (ansible-core) required to use the collection. Multiple versions can be separated with a comma.

title: Ansible Meta Runtime Schema


coffeelint.json

description: Determines the error level

enum: error warn ignore

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

$ref: #/definitions/base

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]

description: 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]

description: [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]

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

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

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

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

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]

description: 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]

description: 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]

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

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

description: 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]

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

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

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

description: 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]

description: 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]

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

description: 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]

description: 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]

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

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

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

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

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

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

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

title: JSON schema for coffeelint.json files


chart.json

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.

description: The name of the chart

description: A SemVer 2 version

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.

description: A single-sentence description of this project

description: The type of the chart

default: application

enum: application library

description: A list of keywords about this project

description: The URL of this projects home page

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

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.

description: The name of the chart

description: The version of the chart

description: The repository URL or alias

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

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

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.

required: parent child

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

description: The source key of the values to be imported

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

description: The maintainers name

description: The maintainers email

format: email

description: A URL for the maintainer

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

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.

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.

description: A list of annotations keyed by name

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.

enum: true false

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.

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

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.

required: apiVersion name version

title: Helm Chart.yaml


jscpd.json

enum: green blue red yellow orange purple pink grey gray cyan black

$ref: #/definitions/colorPreset

$ref: #/definitions/colorHex

enum: abap actionscript ada apacheconf apl applescript arduino arff asciidoc asm6502 aspnet autohotkey autoit bash basic batch bison brainfuck bro c c-header clike clojure coffeescript comments cpp cpp-header crystal csharp csp css-extras css d dart diff django docker eiffel elixir elm erb erlang flow fortran fsharp gedcom gherkin git glsl go graphql groovy haml handlebars haskell haxe hpkp hsts http ichigojam icon inform7 ini io j java javascript jolie json jsx julia keymap kotlin latex less liquid lisp livescript lolcode lua makefile markdown markup matlab mel mizar monkey n4js nasm nginx nim nix nsis objectivec ocaml opencl oz parigp pascal perl php plsql powershell processing prolog properties protobuf pug puppet pure python q qore r reason renpy rest rip roboconf ruby rust sas sass scala scheme scss smalltalk smarty soy sql stylus swift tap tcl textile tsx tt2 twig typescript vbnet velocity verilog vhdl vim visual-basic wasm url wiki xeora xojo xquery yaml

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

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

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

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

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

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

description: path to directory for non-console reports

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

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

description: ignore code blocks matching these regular expressions

enum: mild strict weak

default: mild

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

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

$ref: #/definitions/format

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

enum: leveldb redis

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

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

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

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

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

description: show full information during duplicate detection

description: use absolute paths in reports

description: do not follow symlinks

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

description: ignore case of symbols in code (experimental)

description: ignore all files from .gitignore file

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

default: Copy/Paste

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

$ref: #/definitions/color

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

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

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

enum: flat classic

default: classic

description: badge look: flat or classic

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

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

description: size of badge relative to default of 1

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


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

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

type: integer string

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

description: A file location to which this annotation refers.

$ref: #/definitions/physicalLocation

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

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

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

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

description: A message relevant to this annotation.

description: Categorizes the location.

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

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

enum: source sink sanitizer

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.

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.

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.

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

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

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".

enum: important essential unimportant

description: The source code at the specified location.

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

$ref: #/definitions/annotation

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

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

description: A message relevant to a code location

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

required: message locations

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.

$ref: #/definitions/annotatedCodeLocation

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.

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

$ref: #/definitions/stack

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

$ref: #/definitions/exception

description: A change to a single file.

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

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

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'.

$ref: #/definitions/replacement

required: uri replacements

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.

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

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

description: The length of the file in bytes.

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

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

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.

$ref: #/definitions/hash

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

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.

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

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

$ref: #/definitions/fileChange

required: description fileChanges

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

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.

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

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

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

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

required: value algorithm

description: The runtime environment of the analysis tool run.

description: The command line used to invoke the tool.

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

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

format: date-time

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

description: The machine that hosted the analysis tool run.

description: The account that ran the analysis tool.

description: The process id for the analysis tool run.

description: The fully qualified path to the analysis tool.

description: The working directory for the analysis rool run.

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

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

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

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.

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

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.

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

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.

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

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

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.

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.

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

description: An identifier for the condition that was encountered.

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.

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

description: The file and region relevant to this notification.

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

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

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

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

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

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

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.

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

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

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

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

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

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

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

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

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

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.

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

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.

description: A result produced by an analysis tool.

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

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

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

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.

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

description: A unique identifier for the result.

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

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

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

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

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

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

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

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

description: Describes an analysis rule.

description: A stable, opaque identifier for the rule.

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

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.

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.

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.

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

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

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

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

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.

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

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.

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

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.

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

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

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.

description: An identifier for the run.

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

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

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.

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

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

description: A message relevant to this call stack.

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

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

description: A function call within a stack trace.

description: A message relevant to this stack frame.

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

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

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

description: The thread identifier of the stack frame.

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

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

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

description: The parameters of the call that is executing.

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

description: The analysis tool that was run.

description: The name of the tool.

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

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

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

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

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

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).

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

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

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

description: The SARIF format version of this log file.

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

title: Static Analysis Results Format (SARIF) Version 1.0.0 JSON Schema


schema-catalog.json

description: A list of JSON schema references.

required: name url description

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

description: An absolute URL to the schema location

description: The name of the schema

description: A description of the schema

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

required: schemas version $schema

title: JSON schema for SchemaStore.org catalog files


pathfinder-policy-yml-schema.json

title: pathfinderPolicy.yml

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

required: routeName enabledPolicies

const: redactEmail

const: log


description: Defines an op

description: Name of the op

description: Description of the op

description: Parameter of an op

title: arrayParam

description: Array parameter of an op

description: If the array is secret

title: arrayConstraints

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

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

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

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

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

title: booleanParam

description: Boolean parameter of an op

description: Default value

title: dirParam

description: Directory parameter of an op

title: markdown

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

title: fileParam

description: File parameter of an op

description: If the file is secret

title: numberParam

description: Number parameter of an op

description: If the number is secret

title: numberConstraints

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)

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

title: integer

description: Requires the number be an integer

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

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

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

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)

title: objectParam

description: Object parameter of an op

description: If the object is secret

title: objectConstraints

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

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

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

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)

title: typeConstraints

description: Parameter constraints

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

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

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

type: array string

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

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

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

title: socketParam

description: Socket parameter of an op

description: If the socket is secret

title: stringParam

description: String parameter of an op

description: If the string is secret

title: stringConstraints

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

title: date-time

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

title: docker-image-ref

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

title: email

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

title: hostname

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

title: ipv4

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

title: ipv6

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

title: uri

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

title: semver

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

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

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

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

format: regex

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

title: containerCall

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

description: Expression coercible to string value

description: Directories in the container

description: (will be bound to same path in op)

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

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

description: Expression coercible to string value

description: Reference to a value

description: Environment variables in the container

description: Files in the container

description: (will be bound to same path in op)

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

description: Reference to an image

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

type: array boolean number object string

description: Ports bound from the container to the host

description: Host port(s) to bind to

type: string number

description: Container socket address mapped to a socket ref

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

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

description: Condition which evaluates to true or false

description: True if all items are equal

description: Expression coercible to string value

description: True if value exists w/ reference

description: True if any items aren't equal

description: Expression coercible to string value

description: True if no value exists w/ reference

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

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

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

description: Expression coercible to string value

description: Expression coercible to string value

required: username password

description: Reference to an op

title: parallelCall

description: Loop in which all iterations are called simultaneously.

description: What gets run on each iteration of the loop

title: serialCall

description: Loop in which each iteration gets called sequentially.

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

description: What gets run on each iteration of the loop

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

description: Variables added to scope on each iteration

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

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

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

title: call

description: Version of the op

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

title: semVer

title: Op File