key: buffer

description: The buffer duration to wait before triggering a restart.


key: bufferPoll

description: The buffer polling interval to check for the file stability.

type: integer


key: display

description: The various messages to display during different events.

type: object

type: string

default: Starting...

default: Started

default: Restarting...

default: Restarted

default: Stopping...


key: onBeforeStart

description: The message to display before the watcher starts.


key: onStart

description: The message to display after the watcher starts.


key: onBeforeRestart

description: The message to display before the watcher restarts.


key: onRestart

description: The message to display after the watcher restarts.


key: onBeforeStop

description: The message to display before the watcher stops.


key: clearScreen

description: Clear the screen on start and on every restart.

type: boolean


key: env

description: A set of key-value pairs which will be promptly passed on to your process and accessible via `process.env`.


key: hawk

description: Parameters for scanner runtime and how it should look for vulnerabilities.


key: app

description: **Required** Parameters for the target application and specifics for how it should be scanned.


key: hawkAddOn

description: Parameters for additional HawkScan add-ons.


key: tags

description: Searchable keywords to associate with this scan

type: array


key: spider

description: Spider configuration


key: startupTimeoutMinutes

description: Maximum time in minutes to wait for the scanner process to start

type: number


key: failureThreshold

description: The lowest alert level that returns a failed scan status. Accepted values: high, medium, or low


key: scan

description: Scan Configuration


key: config

description: Scanner configuration overrides, provided as a list of strings.


key: outboundProxy

description: Configuration for an outbound proxy


key: base

description: Enable the basic web crawler for discovering your application’s routes. This spider is appropriate for most traditional web applications.


key: ajax

description: Enable the ajax web crawler for discovering your application’s routes. This spider is appropriate for single-page web applications.


key: maxDurationMinutes

description: Maximum allowed time for enabled spiders to crawl your web application. defaults to 5


key: ajaxBrowser

description: The browser to type and style to use when running the AjaxSpider. This value is ignored when running the hawkscan docker container and use's the default FIREFOX_HEADLESS.


key: seedPaths

description: List of seed paths to add to the site tree. Will be crawled in addition to the root of the application. Used to add unreachable paths to the scanner.


key: apikey

description: api key to authenticated the user with Postman


key: collectionUID

description: Id of the collection to be pulled from Postman


key: filePath

description: File path of the Postman collection


description: Maximum duration that a scan will run.

type: number string


key: maxRuleDurationMinutes

description: Maximum duration that a scan will spend on a rule.


key: requestDelayMillis

description: Delay time between sending requests.


key: concurrentRequests

description: Number of request threads. _If you need that little extra push._ defaults to 20


key: throttlePassiveBacklog

description: Pause active scan when passive backlog is greater than this value, resumes once backlog is empty. defaults to 50


key: policyName

description: Name of the scan policy to use. This field is optional and defaults will be selected if omitted


key: includedPlugins

description: Specify to only run  scan on the listed plugins


key: host

description: **Required**. The host of the outbound proxy


key: credentials

description: Credentials for logging into the proxy


key: username

description: **Required**. The username for proxy credentials


key: password

description: **Required**. The password for proxy credentials


key: realm

description: Realm for proxy credentials


key: scheme

description: Scheme of auth: BASIC, NTLM,


description: **Required** The base url of the application to scan ex: `http://localhost:8000`. If the url cannot be reached, the scan will not proceed.


key: sessionTokens

description: The names of any session tokens used by your application, provided as an array of strings (Hint: these are the names of session cookies used by your application).


key: antiCsrfParam

description: The name of your CSRF security parameter used in any application form inputs. Globally set, HawkScan will parse this parameter value from form responses to use in subsequent requests.


key: authentication

description: Authenticated scan configuration


key: excludePaths

description: An array of strings, used as regexes to match against routes that should be ignored entirely by HawkScan. This field is useful for prohibiting asset directories or other resources that don’t require vulnerability scanning. (TODO: ADD EXAMPLE)


key: applicationId

description: **Required**. The `applicationId` of an application from the StackHawk platform


key: env

description: **Required**. The `env` environment name to organize Scan Results


key: graphqlConf

description: GraphQL API scanner parameters.


key: includePaths

description: An array of strings, used as regexes to constrain the application routes HawkScan will specifically visit. This field is useful for constraining the reach of the HawkScan scanner and spider. (TODO: add examples)


key: autoPolicy

description: Set to `true` to enable an optimized policy when scanning specific APIs like GraphQL and OpenAPI. Defaults to True


key: autoInputVectors

description: Set to `true` to automatically enabled the correct input data types when scanning API’s like GraphQL and OpenAPI. This can increase scan accuracy and reduce false positives. Defaults to True


key: openApiConf

description: OpenApi scanner parameters.


key: soapConf

description: SOAP API scanner parameters.


key: grpcConf

description: gRPC scanner parameters


key: inputVectors

description: Fine grained control of injectable input vectors


key: waitForAppTarget

description: Adds a wait time for app to startup


key: redact

description: Specification for additional redaction of words in the scan logs


key: usernamePassword

description: Optional configuration specifying a username and password based authentication configuration. Do not configure if using `external`.


key: external

description: Optional configuration block for specifying an externally supplied authorization token. Do not configure if using `usernamePassword`.


key: script

description: Optional configuration block for using an authentication script.


key: tokenExtraction

description: Optional configuration block for extracting the authorization token from the authentication response.


key: cookieAuthorization

description: Optional configuration specifying if authorization is maintained via a cookie session. Do not configure if using `tokenAuthorization`.


key: tokenAuthorization

description: Optional configuration telling HawkScan how to pass the authorization token to your application on each request to maintain authorized access. Do not configure if using `cookieAuthorization`.


key: sessionScript

description: Optional configuration for using a session management script.


key: loggedInIndicator

description: **Required**. A regex to match against http responses from pages in the web application to determine if the scanned pages user session is still logged in to the app, provided as a string (ex. `"\\Qsigned in as\\E"`).


key: loggedOutIndicator

description: **Required**. A regex to match against http responses from pages in the web application to determine if the scanned pages user session is logged out of the app, provided as a string


key: testPath

description: A configuration block specifying how to verify authentication/authorization is working


key: loginPagePath

description: The path to your login form, if applicable. This is an optional path but is often required if the `POST` to the loginPath requires an anti csrf token to be passed as part of the `POST`. The `app.antiCsrfParam` will be extracted from the response body of a GET request to this page.


key: loginPath

description: **Required** login route to `POST` credentials for a user in the application (ex. `/login`). An http `POST` request using the type specified will be made to this path.


key: usernameField

description: **Required** the username html field used in your application form or json, provided as a string.


key: passwordField

description: **Required** The password html field used in your application form or json, provided as a string.


key: scanUsername

description:
*Required** The username credentials provided to authentication when attempting to login to the web application, provided as a string.
HawkScan best practices recommend using [environment variable runtime overrides](https://docs.stackhawk.com/hawkscan/configuration/#environment-variable-runtime-overrides) for this value (ex. "${SCAN_USERNAME:admin}" will use the $SCAN_USERNAME environment variable as the scanUsername, or fallback to admin).


key: scanPassword

description:
*Required** The password credentials provided to authentication when attempting to login to the web application, provided as a string.
HawkScan best practices recommend using [environment variable runtime overrides](https://docs.stackhawk.com/hawkscan/configuration/#environment-variable-runtime-overrides) for this value (ex. "${SCAN_PASSWORD}" will use the $SCAN_PASSWORD environment variable as the scanPassword).


key: type

description: An enum value describing the type of `POST` data expected by the `loginPath`

enum: FORM JSON HTTP


key: otherParams

description: Other request parameters required by your login payload, provided as an array of objects with `name` and `value` string keys. This setting is helpful if your authentication process requires other parameters included in the form POST besides the username and password parameters. If in doubt, this setting can be safely left unconfigured.


key: realm

description: Realm for NTLM authentication


description: Specifies the type of token being supplied. If `COOKIE` is specified the .external.value should be in the form of a cookie value <cookie-name>=<cookie-value> . Defaults to `Token`.

enum: TOKEN COOKIE


key: values

description: The value pairs containing the token that will authorize requests. How the token is passed to your application is determined by the assigned `type`.


key: name

description: The name of the authentication script specified in the hawkAddOn.scripts.name


key: parameters

description: The parameters required for the authentication script.


key: credentials

description: The credentials required for the authentication script. These values will be redacted.


description: Specifying `TOKEN_PATH` tells HawkScan to extract the token from the JSON payload of the response from authentication. `HEADER` tells HawkScan to extract the token from a header in the response from authentication. defaults to `TOKEN_PATH`.


key: value

description:
*Required**. String containing the path to the token in the JSON payload authentication response or the name of the response header containing the token.
Example: if the authentication response JSON payload looks like `{"auth" : {"token": "<my-auth-token>"}}` the value would be `auth.token`. If the authentication response has a header named `AuthToken: <my-token>`, then the value should be `AuthToken`.


key: cookieNames

description: A list of strings that are the names of cookies used for maintaining a session. Typically this is one value like `jsessionid` or `PHPSESS`. When used in combination with authentication HawkScan will use this value to persist authenticated session state with your application.


description:
An enum value representing how to pass the authorization token to your application.
`HEADER` indicates that each request should have the authorization token header added to the requests.
`QUERY_PARAM` indicates that the token should be passed as a query parameter.


description: **Required** The name of the `HEADER` or `QUERY_PARAM` the token should be passed as.


description: The name of the session script specified in the hawkAddOn.scripts.name


description: The parameters required for the session script.


description: An enum value representing what to match against in the response from issuing a GET request to the `testPath.path`. The supported values are `HEADER` and `BODY`.

enum: HEADER BODY


key: path

description: **Required**. The path to a protected route in your application that requires authorization. For example `/mysettings`. A `GET` request will be made to this path using the configured authentication.


key: success

description:
A regex that will match against the response header or body, specified by `type`, of the GET request to the `path`.
A match of the regex supplied will indicate that scanning should proceed with the specified authentication.


key: fail

description:
A regex that will match against the response header or body, specified by `type`, of the GET request to the `path`.
A match of the regex supplied will indicate that scanning should halt and enter an error state.


key: requestMethod

description: Request method to use for queries. Will generate GraphQL queries as either POST payloads or GET uri strings.

enum: GET POST PUT


key: requestBody

description: The request content to send along with POST or PUT requests for authentication verification.


key: requestHeaders

description:
List of key/value pairs to be included as headers in the request to the `path`.
Headers that match the following pattern are unable to be added or modified `'^(Host|Origin|Proxy-.*|Sec-.*|Content-Length)'`.


key: schemaPath

description: Path to the GraphQL introspection endpoint, relative to the target URI


enum: POST GET


key: uriMaxLength

description: Max length of URIs when generation queries for GET requests.


key: maxDepth

description: Maximum depth for generated query graphs


key: enabled

description: Enable GraphQL scan support. HawkScan will enumerate all possible field types and input values for GraphQL Queries and Mutations. Provide relative path to the API endpoint.


key: operation

description: GraphQL operation to enumerate and scan. Defaults to find all Query and Mutation operations.

enum: ALL QUERY MUTATION


key: filePath

description: Relative path to a JSON formatted GraphQL schema (default: None)


key: excludeOperations

description: GraphQL operations to exclude from the spider


key: fakerEnabled

description: Enables faker for a GraphQL scan to generate more realistic values when format is provided on the API spec or custom variables.


key: customVariables

description: Define custom variables and values for use in GraphQL scanning.


key: field

description: The field name of the param to inject values into


key: values

description: A list of possible values to be randomly selected for the given field


key: operationName

description: An optional operationName that will only inject custom values if the name of the operation on the request matches


key: operationType

description: An optional GraphQL operation type (MUTATION or QUERY) that will inject custom values only when the request matches the operation type


key: path

description: A string relative path to an OpenAPI specification file (JSON or YAML) from the specified app.host


description:
Relative path to specification file(s) (JSON or YAML).
The path is relative to the `/hawk` mount point specified by the `-v` docker run argument. ie: `docker run -v $(pwd):/hawk`.


key: inline

description: Define your openapi specification yaml inlined as a string.


key: strict

description: Enable strict parsing of the openapi.


description: Define custom variables and values for use in REST API scanning.


key: includeAllMethods

description: When custom variables are provided, DELETE's are skipped for injection. Set this to true to override this default and include all methods in variable injection.


key: includedMethods

description: List of methods to include in custom variable injection. Note: if 'includeAllMethods' is set to true, this list is ignored and all methods will be used for custom variable injection.

enum: POST PUT DELETE GET OPTIONS PATCH HEAD


description: Enables faker for a REST API scan to generate more realistic values when format is provided on the API spec or custom variables.


key: maxAliasesForCollections

description:
Maximum number of aliases for a collection when parsing YAML.
 Increase this value if you see the error "Number of aliases for non-scalar nodes exceeds the specified max=100"


description: An optional path regex that will only inject custom values if the path of the request matches


key: requestMethods

description: A list of optional HTTP request methods that will inject custom values only when the request matches one of those methods.


description: Host path to the SOAP WSDL, prefixed with a `/`


description: Relative path to the SOAP WSDL schema definition file


description: Host path for the grpc reflection endpoint.


description: Relative path to the grpc protobuf file


description: Define custom variables and values for use in gRPC scanning.


description: The field name of the param to inject values into


description: A list of possible values to be randomly selected for the given field


description: The path to a public reachable route in your application. For example `/index`. A `GET` request will be made to this path to confirm the host is up and ready to receive traffic.


key: requestMethod

description: Request method to use for queries. Will generate GraphQL queries as either POST payloads or GET uri strings.


key: requestBody

description: The request content to send along with POST or PUT requests for target verification.


key: waitTimeoutMillis

description: The maximum amount of time in milliseconds that HawkScan will wait for your app to be available before it starts scanning


key: pollDelay

description: The maximum amount of time in milliseconds in between requests to your application to see if it's running


key: headers

description: List of string header names: the values of HTTP headers matching these names will be redacted from alerts and logs.


description: List of string static values: the values here will be added to the redacted token list. This is best used with ${ENV_VAR:default} interpolation.


key: replacer

description: Configuration for the replacer addOn


key: scripts

description: List of configurations for custom scripts.


key: rules

description: List of regex match and replace rules for request headers.


key: matchString

description: If `replaceOnly` is false, only match the header name. If `replaceOnly` is true, matches the exact string on the header line.


key: replacement

description: If false, replace existing header value or add the missing header using replacement as the value. If true, only replace the matchString of an existing header line.


key: replaceOnly


key: isRegex

description: Enable regex search for `matchString`. Useful when `replaceOnly` is true (e.g. `Referer:.*` will replace the entire `Referer:` header line)


key: name

description: the name of this custom script


key: type

enum: active authentication httpsender passive proxy standalone targeted session


key: path

description: Path to the file location for the custom script


key: vars

description: Named variables to expose to the script


key: language

description: **Required**. The language of this script

enum: KOTLIN JAVASCRIPT


key: id

description: Plugin Id for script


description: The keyword name.


key: value

description: An arbitrary value to associate with the keyword.


key: solution

description: Solution filter description


description: Path to filtered solution. Should be relative to current .slnf


key: projects

description: List of projects that will be included in filitered solution. Paths should be relative to solution rather than to .slnf


key: OutputSpec

description: Describes the component output specification


key: InputValuePlaceholder

description: Represents the command-line argument placeholder that will be replaced at run-time by the input argument value.


key: inputValue

description: Name of the input.


key: InputPathPlaceholder

description: Represents the command-line argument placeholder that will be replaced at run-time by a local file path pointing to a file containing the input argument value.


key: inputPath

description: Name of the input.


key: OutputPathPlaceholder

description: Represents the command-line argument placeholder that will be replaced at run-time by a local file path pointing to a file where the program should write its output data.


key: outputPath

description: Name of the output.


key: ConcatPlaceholder

description: Represents the command-line argument placeholder that will be replaced at run-time by the concatenated values of its items.


key: concat

description: Items to concatenate


key: IsPresentPlaceholder

description: Represents the command-line argument placeholder that will be replaced at run-time by a boolean value specifying whether the caller has passed an argument for the specified optional input.


key: isPresent

description: Name of the input.


key: IfPlaceholder

required: cond then


key: image

description: Docker image name.


key: command

description: Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided.


key: args

description: Arguments to the entrypoint. The docker image's CMD is used if this is not provided.


key: env

description: List of environment variables to set in the container.


key: ContainerImplementation

description: Represents the container component implementation.


key: ComponentSpec

description: Component specification. Describes the metadata (name, description, source), the interface (inputs and outputs) and the implementation of the component.


key: ComponentReference

description: Component reference. Contains information that can be used to locate and load a component by name, digest or URL


key: GraphInputArgument

description: Represents the component argument value that comes from the graph component input.


key: graphInput

description: References the input of the graph/pipeline.


key: TaskOutputArgument

description: Represents the component argument value that comes from the output of a sibling task.

required: taskId outputName


key: taskOutput

description: References the output of a sibling task.


key: TwoArgumentOperands

description: Pair of operands for a binary operation.


key: TwoLogicalOperands

description: Pair of operands for a binary logical operation.


key: RetryStrategySpec

description: Optional configuration that specifies how the task should be retried if it fails.


key: CachingStrategySpec

description: Optional configuration that specifies how the task execution may be skipped if the output data exist in cache.

format: duration


key: ExecutionOptionsSpec

description: Optional configuration that specifies how the task should be executed. Can be used to set some platform-specific options.


key: TaskSpec

description: 'Task specification. Task is a configured component - a component supplied with arguments and other applied configuration changes.


key: GraphSpec

description: Describes the graph component implementation. It represents a graph of component tasks connected to the upstream sources of data using the argument specifications. It also describes the sources of graph output values.


key: GraphImplementation

description: Represents the graph component implementation.


key: PipelineRunSpec

description: The object that can be sent to the backend to start a new Run.


description:
A data pack advancement
https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend

type: string boolean number array object

type: string number boolean

enum: challenge goal task

default: task

type: array object


key: extra

description: A list of additional raw JSON text components to be displayed after this one.


key: items

description: A child text component. Child text components inherit all formatting and interactivity from the parent component, unless they explicitly override them.


key: color

description: The color to render the content in.


key: font

description: The resource location of the font for this component in the resource pack within assets/<namespace>/font.


key: bold

description: Whether to render the content in bold.


key: italic

description: Whether to render the content in italics. Note that text that is italicized by default, such as custom item names, can be unitalicized by setting this to false.


key: underlined

description: Whether to underline the content.


key: strikethrough

description: Whether to strikethrough the content.


key: obfuscated

description: Whether to render the content obfuscated.


key: insertion

description: When the text is shift-clicked by a player, this string is inserted in their chat input. It does not overwrite any existing text the player was writing. This only works in chat messages.


key: clickEvent

description: Allows for events to occur when the player clicks on text. Only work in chat messages and written books, unless specified otherwise.


key: action

description: The action to perform when clicked.


key: value

description: The URL, file path, chat, command or book page used by the specified action.


key: hoverEvent

description: Allows for a tooltip to be displayed when the player hovers their mouse over text.


description: The type of tooltip to show.


description: The formatting and type of this tag varies depending on the action.


key: contents

description: The formatting of this tag varies depending on the action.


key: text

description: A string containing plain text to display directly. Can also be a number or boolean that is displayed directly.


key: translate

description: A translation identifier, corresponding to the identifiers found in loaded language files. Displayed as the corresponding text in the player's selected language. If no corresponding translation can be found, the identifier itself is used as the translated text.


key: with

description: A list of raw JSON text components to be inserted into slots in the translation text.


key: items

description: A raw JSON text component. If no component is provided for a slot, the slot is displayed as no text.


key: display

description:
Display options for the current advancement
https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend


key: icon

description:
Icon options for the current advancement
https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend


key: item

description:
An item identifier for the current advancement
https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend


key: nbt

description:
A named binary tag of an item for the current advancement
https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend


key: title

description:
A title for the current advancement
https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend


key: frame

description:
A frame type for the icon for the current advancement
https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend


key: background

description:
A background directory for the current advancement
https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend


key: description

description:
A description for the current advancement
https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend


description:
Whether or not to show the toast pop up after completing the current advancement
https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend


description:
Whether or not to announce in the chat when the current advancement has been completed
https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend


key: hidden

description:
Whether or not to hide this advancement and all its children from the advancement screen until the current advancement have been completed
https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend


key: parent

description:
A parent directory for the current advancement
https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend


key: criteria

description:
Required criterias have to be met for the current advancement
https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend


key: additionalProperties

description:
Required criteria have to be met for the current advancement
https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend


key: trigger

description:
A trigger for the current advancement
https://minecraft.fandom.com/wiki/Advancement/JSON_format#Criteria


key: conditions

description:
Conditions need to be met when the trigger gets activated for the current advancement
https://minecraft.fandom.com/wiki/Advancement/JSON_format#Criteria


key: player

description:
Check properties of the player for the current advancement
https://minecraft.fandom.com/wiki/Advancement/JSON_format#Criteria


key: requirements

description:
Requirements for the current advancement
https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend


key: items

description:
Criterions for the current advancement
https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend


description:
Criterion name for the current advancement
https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend


key: rewards

description:
Rewards for the current advancement
https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend


key: recipes

description:
Recipes to unlock for the current advancement
https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend


description:
A namespaced identifier for a recipe for the current advancement
https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend


key: loot

description:
Loot tables to give to the player for the current advancement
https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend


description:
A namespaced identifier for a loot table for the current advancement
https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend


key: experience

description:
An experience amount for the current advancement
https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend


key: function

description:
A function to run for the current advancement
https://minecraft.fandom.com/wiki/Advancement/JSON_format#Legend


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


description: CacheTimeout controls how long to cache authentication decisions


key: strategy

description: Authentication strategy that will be used in kubernetes cluster


key: sans

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


key: webhook

description: Webhook configuration options


key: mode

description: Authorization mode used by kubernetes


key: options

description: Authorization mode options


key: cloud

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


key: tenantId

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


key: subscriptionId

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


key: resourceGroup

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


key: location

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


key: vnetName

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


key: vnetResourceGroup

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


key: subnetName

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


key: securityGroupName

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


key: routeTableName

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


key: primaryAvailabilitySetName

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


key: vmType

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


key: primaryScaleSetName

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


key: aadClientId

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


key: aadClientSecret

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


key: aadClientCertPath

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


key: aadClientCertPassword

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


key: cloudProviderBackoff

description: Enable exponential backoff to manage resource request retries


key: cloudProviderBackoffRetries

description: Backoff retry limit


key: cloudProviderBackoffExponent

description: Backoff exponent


key: cloudProviderBackoffDuration

description: Backoff duration


key: cloudProviderBackoffJitter

description: Backoff jitter


key: cloudProviderRateLimit

description: Enable rate limiting


key: cloudProviderRateLimitQPS

description: Rate limit QPS


key: cloudProviderRateLimitBucket

description: Rate limit Bucket Size


key: useInstanceMetadata

description: Use instance metadata service where possible


key: useManagedIdentityExtension

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


key: userAssignedIdentityID

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


key: maximumLoadBalancerRuleCount

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


key: loadBalancerSku

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


key: excludeMasterFromStandardLB

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


key: address

description: Address of Bastion Host


key: port

description: SSH Port of Bastion Host


key: user

description: ssh User to Bastion Host


description: SSH Agent Auth enable


description: SSH Private Key


description: SSH Private Key Path


description: SSH Certificate


description: SSH Certificate Path


description: Ignore proxy environment variables


key: bs-version

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


key: trust-device-path

description: See Issue #33128


key: CloudProvider

description: Cloud provider type used with calico


key: name

description: Name of the Cloud Provider


key: awsCloudProvider

description: AWSCloudProvider


key: azureCloudProvider

description: AzureCloudProvider


key: openstackCloudProvider

description: OpenstackCloudProvider


key: vsphereCloudProvider

description: VsphereCloudProvider


key: customCloudProvider

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


key: provider

description: DNS provider


key: options

description: DNS config options


key: upstreamnameservers

description: Upstream nameservers


key: reversecidrs

description: ReverseCIDRs


key: stubdomains

description: Stubdomains


description: NodeSelector key pair


key: nodelocal

description: Nodelocal DNS


Update strategy


Autoscaler fields to determine number of dns replicas


key: tolerations

description: Tolerations for Deployments


description: List of etcd urls


description: External CA certificate


key: cert

description: External Client certificate


key: key

description: External Client key


key: path

description: External etcd prefix


key: uid

description: UID to run etcd container as


key: gid

description: GID to run etcd container as


key: snapshot

description: Etcd Recurring snapshot Service, used by rke only


key: retention

description: Etcd snapshot Retention period


key: creation

description: Etcd snapshot Creation period


Backup backend for etcd snapshots


key: Iface

description: Alternate cloud interface for flannel


key: zone

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


key: vpc

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


key: subnet-id

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


key: routetable-id

description: RouteTableID enables using a specific RouteTable


key: role-arn

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


key: kubernetes-cluster-tag

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


key: kubernetes-cluster-id

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


key: disable-security-group-ingress

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

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


key: elb-security-group

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


key: disable-strict-zone-check

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

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


key: provider

description: Ingress controller type used by kubernetes


key: options

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


description: NodeSelector key pair


description: Ingress controller extra arguments


description: DNS Policy


description: Extra Env vars


description: Extra volumes


description: Extra volume mounts


nginx daemonset upgrade strategy


description: Http port for ingress controller daemonset


description: Https port for ingress controller daemonset


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


key: tolerations

description: Tolerations for Deployments


description: Enable or disable nginx default-http-backend


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


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


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


description: Port range for services defined with NodePort type


description: Enabled/Disable PodSecurityPolicy


description: Enable/Disable AlwaysPullImages admissions plugin


Secrets encryption provider config


Audit Log Configuration


AdmissionConfiguration


Event Rate Limit configuration


description: CIDR Range for Pods in cluster


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


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


description: Cluster DNS service ip


description: Fail if swap is enabled


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


key: lb-version

description: overrides autodetection. Only support v2.


key: use-octavia

description: uses Octavia V2 service catalog endpoint


description: overrides autodetection.


key: floating-network-id

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


key: lb-method

description: default to ROUND_ROBIN.


description: Monitoring server provider


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


description: NodeSelector key pair


Update strategy


key: replicas

description: Number of monitoring addon pods


description: Tolerations for Deployments


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


key: plugin

description: Network Plugin That will be used in kubernetes cluster


description: Plugin options to configure network properties


key: mtu

description: Set MTU for CNI provider


CalicoNetworkProvider


CanalNetworkProvider


FlannelNetworkProvider


WeaveNetworkProvider


AciNetworkProvider


Network plugin daemonset upgrade strategy


key: force

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


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


description: Continue even if there are pods using emptyDir


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


key: timeout

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


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


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


description: link-local IP for nodelocal DNS


Nodelocal DNS daemonset upgrade strategy


description: NodeSelector key pair


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


key: url

description: URL for the registry


key: user

description: User name for registry acces


key: password

description: Password for registry access


description: Default registry


ECRCredentialPlugin


key: nodeName

description: Name of the host provisioned via docker machine


key: address

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


key: port

description: Port used for SSH communication


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


key: role

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


description: Optional - Hostname of the node


description: SSH usesr that will be used by RKE


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


description: SSH Agent Auth enable


description: SSH Private Key


description: SSH Private Key Path


description: SSH Certificate


description: SSH Certificate Path


key: labels

description: Node Labels


key: taints

description: Node Taints


key: etcd

description: Etcd Service


key: kube-api

description: KubeAPI Service


key: kube-controller

description: KubeController Service


key: scheduler

description: Scheduler Service


key: kubelet

description: Kubelet Service


key: kubeproxy

description: KubeProxy Service


description: etcd image


key: alpine

description: Alpine image


description: rke-nginx-proxy image


description: rke-cert-deployer image


description: rke-service-sidekick image


key: kubedns

description: KubeDNS image


key: dnsmasq

description: DNSMasq image


description: KubeDNS side car image


description: KubeDNS autoscaler image


key: coredns

description: CoreDNS image


description: CoreDNS autoscaler image


key: nodelocal

description: Nodelocal image


key: kubernetes

description: Kubernetes image


key: flannel

description: Flannel image


description: Flannel CNI image


description: Calico Node image


description: Calico CNI image


description: Calico Controllers image


description: Calicoctl image


description: CalicoFlexVol image


description: Canal Node Image


description: Canal CNI image


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


description: CanalFlannel image


description: CanalFlexVol image


description: Weave Node image


description: Weave CNI image


description: Pod infra container image


key: ingress

description: Ingress Controller image


description: Ingress Controller Backend image


description: Ingress Webhook image


description: Metrics Server image


description: Pod infra container image for Windows


description: Cni deployer container image for Cisco ACI


description: host container image for Cisco ACI


description: opflex agent container image for Cisco ACI


description: mcast daemon container image for Cisco ACI


description: OpenvSwitch container image for Cisco ACI


description: Controller container image for Cisco ACI


description: GBP Server container image for Cisco ACI


description: Opflex Server container image for Cisco ACI


key: nodes

description: Kubernetes nodes


key: services

description: Kubernetes components


key: network

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


key: authentication

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


key: addons

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


description: List of urls or paths for addons


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


description: SSH Private Key Path


description: SSH Certificate Path


description: SSH Agent Auth enable


key: authorization

description: Authorization mode configuration used in the cluster


description: Enable/disable strict docker version checking


description: Enable/disable using cri-dockerd


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


description: List of private registries and their credentials


description: Ingress controller used in the cluster


description: Cluster Name used in the kube config


Cloud Provider options


description: kubernetes directory path


description: kubernetes directory path for windows


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


Bastion/Jump Host configuration


key: monitoring

description: Monitoring Config


key: restore

description: RestoreCluster flag


Rotating Certificates Option


description: Rotate Encryption Key Option


key: dns

description: DNS Config


Upgrade Strategy for the cluster


key: CACertificates

description: Rotate CA Certificates


key: Services

description: Services to rotate their certs


key: router-id

description: required


key: enabled

description: Enable/disable secrets encryption provider config


Custom Encryption Provider configuration object


key: baseUrl

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


key: env

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


key: ignoreTestFiles

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

type: string array


key: numTestsKeptInMemory

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


key: port

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


key: reporter

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

default: spec


key: reporterOptions

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


key: slowTestThreshold

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


key: testFiles

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


key: watchForFileChanges

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


key: defaultCommandTimeout

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


key: execTimeout

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


key: taskTimeout

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


key: pageLoadTimeout

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


key: requestTimeout

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


key: responseTimeout

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


key: fileServerFolder

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

default: root project folder


key: fixturesFolder

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

type: string boolean

default: cypress/fixtures


key: integrationFolder

description: Path to folder containing integration test files

default: cypress/integration


key: downloadsFolder

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

default: cypress/downloads


key: componentFolder

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


key: pluginsFile

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


key: screenshotOnRunFailure

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


key: screenshotsFolder

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

default: cypress/screenshots


key: supportFile

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


key: videosFolder

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

default: cypress/videos


key: trashAssetsBeforeRuns

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


key: videoCompression

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

type: number boolean


key: video

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


key: videoUploadOnPasses

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


key: chromeWebSecurity

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


key: userAgent

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


key: blockHosts

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


key: modifyObstructiveCode

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


key: viewportHeight

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


key: viewportWidth

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


key: animationDistanceThreshold

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


key: waitForAnimations

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


key: scrollBehavior

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

default: top


key: projectId

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


key: nodeVersion

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

enum: system bundled

default: system


key: experimentalInteractiveRunEvents

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


key: experimentalSourceRewriting

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


key: experimentalSessionSupport

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


key: experimentalFetchPolyfill

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


key: experimentalStudio

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


key: retries

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

type: object number null


key: includeShadowDom

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


key: clientCertificates

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

required: cert key

required: url certs


key: url

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


key: ca

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


key: items

description: PEM file specific properties


key: cert

description: Path to the certificate, relative to project root


key: key

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


key: passphrase

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


description: PFX file specific properties


key: pfx

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


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


key: component

description: Any component runner specific overrides


Any e2e runner specific overrides


key: severity

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

enum: default error warning warn off none

default: default


key: align

description: Enforces vertical alignment.

enum: arguments elements members parameters statements


key: options

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


key: arrow-parens

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


key: arrow-return-shorthand

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


key: ban

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


key: ban-comma-operator

description: Bans the comma operator.


key: binary-expression-operand-order

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


key: class-name

description: Enforces PascalCased class and interface names.


key: comment-format

description: Enforces formatting rules for single-line comments.


key: completed-docs

description: Enforces documentation for important items be filled out.

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

enum: all exported internal

enum: all instance static

enum: all private protected public


key: curly

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

enum: as-needed ignore-same-line


key: cyclomatic-complexity

description: Enforces a threshold of cyclomatic complexity.


key: deprecation

description: Warns when deprecated APIs are used.


key: encoding

description: Enforces UTF-8 file encoding.


key: eofline

description: Ensures the file ends with a newline.


key: file-header

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


key: file-name-casing

description: Enforces a consistent file naming convention.

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


key: forin

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


key: import-blacklist

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


key: options


key: import-spacing

description: Ensures proper spacing between import statement keywords


key: indent

description: Enforces indentation with tabs or spaces.

enum: tabs spaces


key: jsdoc-format

description: Enforces basic format rules for JSDoc comments.


key: label-position

description: Only allows labels in sensible locations.


key: linebreak-style

description: Enforces a consistent linebreak style.

enum: LF CRLF


key: max-classes-per-file

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


key: max-file-line-count

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


key: max-line-length

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


key: member-ordering

description: Enforces member ordering.

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


key: newline-before-return

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


key: newline-per-chained-call

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


key: new-parens

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


key: no-arg

description: Disallows use of `arguments.callee`.


key: no-bitwise

description: Disallows bitwise operators.


key: no-conditional-assignment

description: Disallows any type of assignment in conditionals.


key: no-consecutive-blank-lines

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


key: options

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


key: no-console

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


key: no-construct

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


key: no-debugger

description: Disallows `debugger` statements.


key: no-default-export

description: Disallows default exports in ES6-style modules.


key: no-duplicate-imports

description: Disallows multiple import statements from the same module.


key: no-duplicate-super

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


key: no-duplicate-switch-case

description: Prevents duplicate cases in switch statements.


key: no-duplicate-variable

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


key: no-dynamic-delete

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


key: no-empty

description: Disallows empty blocks.

enum: allow-empty-catch allow-empty-functions


key: no-eval

description: Disallows `eval` function invocations.


key: no-for-in

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


key: no-for-in-array

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


key: no-implicit-dependencies

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

enum: dev optional


key: no-import-side-effect

description: Avoid import statements with side-effect.


key: no-invalid-template-strings

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


key: no-invalid-this

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


key: options


key: no-irregular-whitespace

description: Disallow irregular whitespace outside of strings and comments


key: no-magic-numbers

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


key: no-null-undefined-union

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


key: no-null-keyword

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


key: no-parameter-reassignment

description: Disallows reassigning parameters.


key: no-reference

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


key: no-return-await

description: Disallows unnecessary `return await`.


key: no-require-imports

description: Disallows invocation of `require()`.


key: no-shadowed-variable

description: Disallows shadowing variable declarations.


key: no-sparse-arrays

description: Forbids array literals to contain missing elements.


key: no-string-literal

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


key: no-string-throw

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


key: no-submodule-imports

description: Disallows importing any submodule.


key: no-switch-case-fall-through

description: Disallows falling through case statements.


key: no-this-assignment

description: Disallows unnecessary references to `this`.


key: no-trailing-whitespace

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

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


key: options

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


key: no-unnecessary-callback-wrapper

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


key: no-unnecessary-class

description: Disallows classes that are not strictly necessary.


key: no-unnecessary-initializer

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


key: no-unsafe-finally

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


key: no-unused-expression

description: Disallows unused expression statements.


key: no-use-before-declare

description: Disallows usage of variables before their declaration.


key: no-var-keyword

description: Disallows usage of the `var` keyword.


key: no-void-expression

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


key: number-literal-format

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


key: object-literal-key-quotes

description: Enforces consistent object literal property quote style.

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


key: object-literal-shorthand

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

enum: always never


key: object-literal-sort-keys

description: Checks ordering of keys in object literals.

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


key: one-line

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

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


key: one-variable-per-declaration

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


key: only-arrow-functions

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


key: ordered-imports

description: Requires that import statements be alphabetized.

required: match order

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

enum: full basename


key: options


key: prefer-conditional-expression

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


key: prefer-const

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

enum: all any


key: prefer-for-of

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


key: prefer-function-over-method

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

enum: allow-public allow-protected


key: prefer-method-signature

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


key: prefer-object-spread

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


key: prefer-switch

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


key: prefer-template

description: Prefer a template expression over string literal concatenation.


key: prefer-while

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


key: no-async-without-await

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


key: promise-function-async

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


key: quotemark

description: Requires single or double quotes for string literals.

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


key: radix

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


key: restrict-plus-operands

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


key: return-undefined

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


key: semicolon

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


key: options

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


key: space-before-function-paren

description: Require or disallow a space before function parenthesis


key: space-within-parens

description: Enforces spaces within parentheses or disallow them.


key: switch-default

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


key: switch-final-break

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


key: trailing-comma

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

enum: always never ignore


key: esSpecCompliant

description: Option to forbid trailing comma after rest


key: triple-equals

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

enum: allow-null-check allow-undefined-check


key: typeof-compare

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


key: use-isnan

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


key: variable-name

description: Checks variable names for various errors.

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


key: whitespace

description: Enforces whitespace style conventions.

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


key: adjacent-overload-signatures

description: Enforces function overloads to be consecutive.


key: ban-ts-ignore

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


key: array-type

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

enum: array generic array-simple


key: await-promise

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


key: ban-types

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


key: options


key: callable-types

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


key: interface-name

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

enum: always-prefix never-prefix


key: interface-over-type-literal

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


key: match-default-export-name

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


key: member-access

description: Requires explicit visibility declarations for class members.

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


key: no-angle-bracket-type-assertion

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


key: no-any

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


key: no-boolean-literal-compare

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


key: no-empty-interface

description: Forbids empty interfaces.


key: no-floating-promises

description: Promises returned by functions must be handled appropriately.


key: no-inferrable-types

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

enum: ignore-params ignore-properties


key: no-inferred-empty-object-type

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


key: no-internal-module

description: Disallows internal `module`


key: no-mergeable-namespace

description: Disallows mergeable namespaces in the same file.


key: no-misused-new

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


key: no-namespace

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


key: options

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


key: no-non-null-assertion

description: Disallows non-null assertions.


key: no-object-literal-type-assertion

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


key: no-parameter-properties

description: Disallows parameter properties in class constructors.


key: no-redundant-jsdoc

description: Forbids JSDoc which duplicates TypeScript functionality.


key: no-reference-import

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


key: no-unbound-method

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


key: no-unnecessary-qualifier

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


key: no-unnecessary-type-assertion

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


key: no-unsafe-any

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


key: no-unused-variable

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


key: no-var-requires

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


key: prefer-readonly

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


key: strict-boolean-expressions

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

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

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


key: strict-type-predicates

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

This rule requires `strictNullChecks` to work properly.


key: typedef

description: Requires type definitions to exist.

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


key: typedef-whitespace

description: Requires or disallows whitespace for type definitions.

enum: nospace onespace space


key: options


key: type-literal-delimiter

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

enum: always never


key: unified-signatures

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


key: use-default-type-parameter

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


key: function-constructor

description: Prevents using the built-in Function constructor.


key: extends

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


key: rulesDirectory

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


key: rules

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


key: jsRules

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


key: defaultSeverity

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

enum: error warning warn off none

default: error


key: linterOptions

description: Additional linter options.


key: exclude

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


key: compilationOptions

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

enum: portable full


key: preserveCompilationContext

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


key: buildOptions

description: Options that are passed to the compiler.

enum: portable full none

default: csc

type: string array object


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


key: compile

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


key: include

description: List of file globbing patterns to be included.


description: List of file globbing patterns to be excluded.


key: includeFiles

description: List of file paths to be included.


key: excludeFiles

description: List of file paths to be excluded.


key: mappings

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


key: embed

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


key: copyToOutput

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


description: Enables/disables server garbage collection.


description: Enables/disables concurrent garbage collection.


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


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


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


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


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


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


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


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


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


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


key: framework

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


key: applyPatches

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


key: packOptions

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

default: git

format: uri


key: summary

description: A short description of the package.


key: tags

description: A space-delimited list of tags and keywords that describe the package.


key: owners

description: List of owners of the package.


key: releaseNotes

description: A description of the changes made in each release of the package.


key: iconUrl

description: A URL for the image to use as the icon for the package. This should be a 32x32-pixel .png file that has a transparent background.


key: licenseUrl

description: A link to the license for the package.


key: requireLicenseAcceptance

description: A Boolean value that specifies whether the client needs to ensure that the package license (described by licenseUrl) is accepted before the package is installed.


key: repository

description: Contains information about the repository where the project is stored.


key: files

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


key: publishOptions

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


key: imports

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


key: dependencies

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

type: string object

enum: default build platform

enum: project package


key: target

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


key: script

description:
A command line script or scripts.

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


key: authors

description: The author of the application.


key: packInclude

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


key: publishExclude

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


key: compile

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


key: compileExclude

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


key: compileFiles

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


key: content

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


key: contentExclude

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


key: contentFiles

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


key: preprocess

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


key: preprocessExclude

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


key: preprocessFiles

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


key: resource

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


key: resourceExclude

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


key: resourceFiles

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


key: shared

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


key: sharedExclude

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


key: sharedFiles

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


key: exclude

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


key: excludeBuiltIn

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

default: bin/** obj/** **/*.xproj


key: testRunner

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


key: configurations

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


key: copyright

description: Copyright details for the package.


key: iconUrl

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


key: licenseUrl

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


key: requireLicenseAcceptance

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


key: owners

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


key: projectUrl

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


key: summary

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


key: tags

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


key: title

description: The human-friendly title of the package


key: releaseNotes

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


key: language

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


key: description

description: The description of the project/package.


key: frameworks

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


key: namedResource

description: Overrides the generated resource names with custom ones.


key: repository

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


key: scripts

description: Scripts to execute during the various stages.


key: version

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


key: tools

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


key: runtimes

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


key: userSecretsId

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


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

enum: text audio video picture graphic composite component

enum: complete incomplete

format: date-time

enum: usable withheld canceled


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


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


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


key: uri

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


key: type

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


key: mimetype

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


key: representationtype

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


key: profile

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


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


key: firstcreated

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


key: versioncreated

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


key: embargoed

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


key: pubstatus

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


key: urgency

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


key: copyrightholder

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


key: copyrightnotice

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


key: usageterms

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


key: ednote

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


key: language

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


key: person

description: An individual human being. nar:subject


key: name

description: The name of a person


key: rel

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


key: scheme

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


key: code

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


key: organisation

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


description: The name of the organisation


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


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


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


key: symbols

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


key: ticker

description: Ticker symbol used for the financial instrument


key: exchange

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


key: place

description: A named location. nar:subject


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


description: The name of the place


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


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


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


key: subject

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


description: The name of the subject


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


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


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


key: event

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


description: The name of the event


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


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


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


key: object

description: Something material, excluding persons. nar:subject


description: The name of the object


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


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


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


key: infosource

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


description: The name of the infosource


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


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


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


key: title

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


key: byline

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