key: protected

description: A protected setting cannot be changed from the UI


key: env

description: An environment variable that will be initialized with the setting's value whenever the plugin is invoked. This is used to inject environment variables into the plugin's execution context. If the named environment variable is already defined at runtime, Meltano will use the passed value from context instead of the configured value.

type: string


description: Used with `kind: object` to process the keys in a particular way.


key: provider

description: The name of a Meltano-supported OAuth provider


key: label

description: A user friendly label describing the plugin


key: value

description: The defined value of the option.


key: docs

description: A URL to the documentation for this plugin


key: requires

description: A set of plugin requirements.

type: object

type: array


description: A single plugin requirement


key: name

description: The name of the required plugin


key: variant

description: The variant of the required plugin


description:
Consent level is meant to interpret the consent-levels of an event for decryption purposes only.

Cumulative means that the highest consent-level in an event must be greater than or equal to the single requested level
for the decrypted stream.

Granular means that the set of consent-levels in an event must enclose the set of requested event levels for the
decrypted stream.

enum: CONSENT_LEVEL_TYPE_UNSPECIFIED 0 CUMULATIVE 1 GRANULAR 2

markdownEnumDescriptions:
(or 0)
(or "CONSENT_LEVEL_TYPE_UNSPECIFIED")
(or 1)
(or "CUMULATIVE")
(or 2)
(or "GRANULAR")


description: Credentials to produce to the event-gateway, or to consume from egress.


description: as this property is secret, it is not always returned


description: filled in from customer profile

type: integer


description:
map of event-contract-ref vs field patterns

constraints:
 data-contract-refs should be existing data contracts
 field_patterns should be valid values (checked by events-core)
 the field_patterns list should have no duplicates.


description: Default Murmurhash3 if empty


key: seed

description: hashing seed


description:
Streams are source or derived streams depending on whether or not linked_stream is null.
Key streams are a separate entity in the api.

type: boolean

deprecationMessage: Field "kafka_topic" is marked as deprecated


key: enabled

description: whether or not this stream is enabled.


description:
consent levels for derived streams

constraints:
if consent_level_type ==  CUMULATIVE then
size = 1
endif


key: description

description: Stream description


key: limits

description: stream limits


key: tags

description: tags are meant for customers to tag their streams


how event consent-levels are interpreted by decrypters.


description: null for source streams


description: The id of the policy that should be applied to this stream's data


description: Kafka topic of the stream. Deprecated in favor of topic in message ExtendedStream


field masking is defined per OUTPUT stream and event-contract ref. combination

The default empty map means no masking. Otherwise, the algorithm in the decrypter is as follows.

 A source stream is (partially) decrypted, and events that don't have enough permissions are dropped.
 the event contract ref string is used to find a MaskedFields instance.
 if present, for all field patterns in the MaskedFields instance, the hash with the specified seed is applied.


description: refers to a event stream.

deprecationMessage: Field "billing_id" is marked as deprecated


description:
the name of the stream
constraints: generic name


description:
A carver for a data pack for Minecraft
https://minecraft.fandom.com/wiki/Custom_world_generation#Carvers

type: number


key: type

description:
A type for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format


key: config

description:
Options for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format


key: probability

description:
A probability that each chunk attempts to generate for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format


key: y

description:
A height at which to generate the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format


key: replaceable

description:
Blocks can be carved for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format


key: items

description:
A block can be carved for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format


description:
Replace blocks for debugging for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format


description:
Whether to enable debug mode for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format


description:
Air replacement options for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format


description:
Water replacement options for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format


description:
Lava replacement options for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format


description:
Barrier replacement options for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format


key: yScale

description:
Vertical scaling options for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format


description:
Horizontal tunnel scaling options for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format


description:
Vertical tunnel scaling options for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format


description:
Floor level options for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format


description:
Vertical rotation options for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format


key: shape

description:
Ravine shape for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format


key: rule

description:
CSS Lint rule

'false' means rule is off
'true' means it is a warning
'2' means the rule is an error


key: tolerations

description: If specified, the pod's tolerations.


Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.


description: HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods.


A list of node selector terms.


description: The name of the service account to use when running the kubernetes pipeline


description:
See
V1: https://docs.ansible.com/automation-controller/latest/html/userguide/ee_reference.html
V3: https://ansible-builder.readthedocs.io/en/latest/definition/

required: version dependencies

required: src dest


key: dependencies

description: Allows adding system, python or galaxy dependencies.


description: Describes files to add to the build context


key: dest

description: Relative subdirectory under build context to place file


key: src

description: File to add to build context


description: Ansible package installation


description: Ansible package to install via pip


description: Ansible Runner package installation


description: Ansible Runner package to install via pip


description: Python package name and path


description: The python package to install via system package manager


description: Path to the python interpreter


key: options

description: Options that effect runtime behavior


description: Customize container startup behavior


key: cmd

description: literal value for CMD Containerfile directive


key: entrypoint

description: literal value for ENTRYPOINT Containerfile directive


description: package to install via pip for entrypoint support


description: Path to the system package manager to use


description: allows GID0 write access to /etc/passwd; currently necessary for many uses


description: Disables the check for Ansible/Runner in final image


key: user

description: Sets the username or UID


key: workdir

description: Default working directory, also often the homedir for ephemeral UIDs


description: Devfile describes the structure of a cloud-native devworkspace and development environment.

enum: build run test debug deploy

required: commandLine component

required: name value

required: name targetPort

default: public

enum: public internal none

default: http

enum: http https ws wss tcp udp

default: /projects


key: attributes

description: Map of implementation-dependant free-form YAML attributes.


key: commands

description: Predefined, ready-to-use, devworkspace-related commands


key: apply

description:
Command that consists in applying a given component definition, typically bound to a devworkspace event.

For example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.

When no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default, unless `deployByDefault` for that component is set to false.


key: component

description: Describes component that will be applied


key: group

description: Defines the group this command is part of


key: isDefault

description: Identifies the default command for a given group kind


key: kind

description: Kind of group the command is part of


key: label

description: Optional label that provides a label for this command to be used in Editor UI menus for example


key: composite

description: Composite command that allows executing several sub-commands either sequentially or concurrently


description: The commands that comprise this composite command


key: parallel

description: Indicates if the sub-commands should be executed concurrently


key: exec

description: CLI Command executed in an existing component container


key: commandLine

description:
The actual command-line string

Special variables that can be used:

 - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping.

 - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/<project-name>). If there are multiple projects, this will point to the directory of the first one.


description: Describes component to which given action relates


key: env

description: Optional list of environment variables that have to be set before running the command


key: hotReloadCapable

description:
Whether the command is capable to reload itself when source code changes. If set to `true` the command won't be restarted and it is expected to handle file changes on its own.

Default value is `false`


key: workingDir

description:
Working directory where the command should be executed

Special variables that can be used:

 - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping.

 - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/<project-name>). If there are multiple projects, this will point to the directory of the first one.


key: id

description: Mandatory identifier that allows referencing this command in composite commands, from a parent, or in events.


key: components

description: List of the devworkspace components, such as editor and plugins, user-provided containers, or other types of components


key: attributes

description: Map of implementation-dependant free-form YAML attributes.


key: container

description: Allows adding and configuring devworkspace-related containers


key: annotation

description: Annotations that should be added to specific resources for this container


key: deployment

description: Annotations to be added to deployment


key: service

description: Annotations to be added to service


key: args

description:
The arguments to supply to the command running the dockerimage component. The arguments are supplied either to the default command provided in the image or to the overridden command.

Defaults to an empty array, meaning use whatever is defined in the image.


key: command

description:
The command to run in the dockerimage component instead of the default one provided in the image.

Defaults to an empty array, meaning use whatever is defined in the image.


key: dedicatedPod

description:
Specify if a container should run in its own separated pod, instead of running as part of the main development environment pod.

Default value is `false`


description: Annotations to be added to Kubernetes Ingress or Openshift Route


description:
Map of implementation-dependant string-based free-form attributes.

Examples of Che-specific attributes:
- cookiesAuthEnabled: "true" / "false",
- type: "terminal" / "ide" / "ide-dev",


key: exposure

description:
Describes how the endpoint should be exposed on the network.
- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.
- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.
- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.

Default value is `public`


key: path

description: Path of the endpoint URL


key: protocol

description:
Describes the application and transport protocols of the traffic that will go through this endpoint.
- `http`: Endpoint will have `http` traffic, typically on a TCP connection. It will be automaticaly promoted to `https` when the `secure` field is set to `true`.
- `https`: Endpoint will have `https` traffic, typically on a TCP connection.
- `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. It will be automaticaly promoted to `wss` when the `secure` field is set to `true`.
- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.
- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.
- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.

Default value is `http`


key: secure

description: Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`.


key: targetPort

description: Port number to be used within the container component. The same port cannot be used by two different container components.


key: env

description:
Environment variables used in this container.

The following variables are reserved and cannot be overridden via env:

 - `$PROJECTS_ROOT`

 - `$PROJECT_SOURCE`


key: mountSources

description:
Toggles whether or not the project source code should be mounted in the component.

Defaults to true for all component types except plugins and components that set `dedicatedPod` to true.


key: sourceMapping

description: Optional specification of the path in the container where project sources should be transferred/mounted when `mountSources` is `true`. When omitted, the default value of /projects is used.


key: volumeMounts

description: List of volumes mounts that should be mounted is this container.


key: items

description: Volume that should be mounted to a component container


key: name

description: The volume mount name is the name of an existing `Volume` component. If several containers mount the same volume name then they will reuse the same volume and will be able to access to the same files.


description: The path in the component container where the volume should be mounted. If not path is mentioned, default path is the is `/<name>`.


key: image

description: Allows specifying the definition of an image for outer loop builds


key: autoBuild

description:
Defines if the image should be built during startup.

Default value is `false`


key: dockerfile

description: Allows specifying dockerfile type build


key: args

description: The arguments to supply to the dockerfile build.


key: buildContext

description: Path of source directory to establish build context. Defaults to ${PROJECT_SOURCE} in the container


key: devfileRegistry

description: Dockerfile's Devfile Registry source


key: id

description: Id in a devfile registry that contains a Dockerfile. The src in the OCI registry required for the Dockerfile build will be downloaded for building the image.


key: registryUrl

description: Devfile Registry URL to pull the Dockerfile from when using the Devfile Registry as Dockerfile src. To ensure the Dockerfile gets resolved consistently in different environments, it is recommended to always specify the `devfileRegistryUrl` when `Id` is used.


key: git

description: Dockerfile's Git source


key: checkoutFrom

description: Defines from what the project should be checked out. Required if there are more than one remote configured


key: remote

description: The remote name should be used as init. Required if there are more than one remote configured


key: revision

description: The revision to checkout from. Should be branch name, tag or commit id. Default branch is used if missing or specified revision is not found.


key: fileLocation

description: Location of the Dockerfile in the Git repository when using git as Dockerfile src. Defaults to Dockerfile.


key: remotes

description: The remotes map which should be initialized in the git project. Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured.


key: rootRequired

description:
Specify if a privileged builder pod is required.

Default value is `false`


key: uri

description: URI Reference of a Dockerfile. It can be a full URL or a relative URI from the current devfile as the base URI.


key: imageName

description: Name of the image for the resulting outerloop build


key: kubernetes

description: Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.


key: deployByDefault

description:
Defines if the component should be deployed during startup.

Default value is `false`


key: annotation

description: Annotations to be added to Kubernetes Ingress or Openshift Route


key: attributes

description:
Map of implementation-dependant string-based free-form attributes.

Examples of Che-specific attributes:
- cookiesAuthEnabled: "true" / "false",
- type: "terminal" / "ide" / "ide-dev",


key: exposure

description:
Describes how the endpoint should be exposed on the network.
- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.
- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.
- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.

Default value is `public`


key: path

description: Path of the endpoint URL


key: protocol

description:
Describes the application and transport protocols of the traffic that will go through this endpoint.
- `http`: Endpoint will have `http` traffic, typically on a TCP connection. It will be automaticaly promoted to `https` when the `secure` field is set to `true`.
- `https`: Endpoint will have `https` traffic, typically on a TCP connection.
- `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. It will be automaticaly promoted to `wss` when the `secure` field is set to `true`.
- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.
- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.
- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.

Default value is `http`


key: secure

description: Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`.


key: targetPort

description: Port number to be used within the container component. The same port cannot be used by two different container components.


key: inlined

description: Inlined manifest


description: Location in a file fetched from a uri.


key: name

description: Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin.


key: openshift

description: Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.


key: volume

description: Allows specifying the definition of a volume shared by several other components


key: ephemeral

description: Ephemeral volumes are not stored persistently across restarts. Defaults to false


key: size

description: Size of the volume


key: events

description: Bindings of commands to events. Each command is referred-to by its name.


key: postStart

description: IDs of commands that should be executed after the devworkspace is completely started. In the case of Che-Theia, these commands should be executed after all plugins and extensions have started, including project cloning. This means that those commands are not triggered until the user opens the IDE in his browser.


key: postStop

description: IDs of commands that should be executed after stopping the devworkspace.


key: preStart

description: IDs of commands that should be executed before the devworkspace start. Kubernetes-wise, these commands would typically be executed in init containers of the devworkspace POD.


key: preStop

description: IDs of commands that should be executed before stopping the devworkspace.


key: metadata

description: Optional metadata


key: architectures

description: Optional list of processor architectures that the devfile supports, empty list suggests that the devfile can be used on any architecture


key: items

description: Architecture describes the architecture type


key: attributes

description: Map of implementation-dependant free-form YAML attributes. Deprecated, use the top-level attributes field instead.


key: description

description: Optional devfile description


key: displayName

description: Optional devfile display name


key: globalMemoryLimit

description: Optional devfile global memory limit


key: icon

description: Optional devfile icon, can be a URI or a relative path in the project


key: language

description: Optional devfile language


key: name

description: Optional devfile name


key: projectType

description: Optional devfile project type


key: provider

description: Optional devfile provider information


key: supportUrl

description: Optional link to a page that provides support information


key: tags

description: Optional devfile tags


key: version

description: Optional semver-compatible version


key: website

description: Optional devfile website


key: parent

description: Parent devworkspace template


description: Overrides of attributes encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules.


key: commands

description: Overrides of commands encapsulated in a parent devfile or a plugin. Overriding is done according to K8S strategic merge patch standard rules.


key: apply

description:
Command that consists in applying a given component definition, typically bound to a devworkspace event.

For example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.

When no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default, unless `deployByDefault` for that component is set to false.


key: component

description: Describes component that will be applied


key: group

description: Defines the group this command is part of


key: isDefault

description: Identifies the default command for a given group kind


key: kind

description: Kind of group the command is part of


key: label

description: Optional label that provides a label for this command to be used in Editor UI menus for example


key: attributes

description: Map of implementation-dependant free-form YAML attributes.


key: composite

description: Composite command that allows executing several sub-commands either sequentially or concurrently


description: The commands that comprise this composite command


key: parallel

description: Indicates if the sub-commands should be executed concurrently


key: exec

description: CLI Command executed in an existing component container


key: commandLine

description:
The actual command-line string

Special variables that can be used:

 - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping.

 - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/<project-name>). If there are multiple projects, this will point to the directory of the first one.


description: Describes component to which given action relates


key: env

description: Optional list of environment variables that have to be set before running the command


key: hotReloadCapable

description:
Whether the command is capable to reload itself when source code changes. If set to `true` the command won't be restarted and it is expected to handle file changes on its own.

Default value is `false`


key: workingDir

description:
Working directory where the command should be executed

Special variables that can be used:

 - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping.

 - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/<project-name>). If there are multiple projects, this will point to the directory of the first one.


key: id

description: Mandatory identifier that allows referencing this command in composite commands, from a parent, or in events.


key: components

description: Overrides of components encapsulated in a parent devfile or a plugin. Overriding is done according to K8S strategic merge patch standard rules.


key: container

description: Allows adding and configuring devworkspace-related containers


key: annotation

description: Annotations that should be added to specific resources for this container


key: deployment

description: Annotations to be added to deployment


key: service

description: Annotations to be added to service


key: args

description:
The arguments to supply to the command running the dockerimage component. The arguments are supplied either to the default command provided in the image or to the overridden command.

Defaults to an empty array, meaning use whatever is defined in the image.


key: command

description:
The command to run in the dockerimage component instead of the default one provided in the image.

Defaults to an empty array, meaning use whatever is defined in the image.


key: dedicatedPod

description:
Specify if a container should run in its own separated pod, instead of running as part of the main development environment pod.

Default value is `false`


description: Annotations to be added to Kubernetes Ingress or Openshift Route


key: attributes

description:
Map of implementation-dependant string-based free-form attributes.

Examples of Che-specific attributes:
- cookiesAuthEnabled: "true" / "false",
- type: "terminal" / "ide" / "ide-dev",


key: exposure

description:
Describes how the endpoint should be exposed on the network.
- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.
- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.
- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.

Default value is `public`


key: path

description: Path of the endpoint URL


key: protocol

description:
Describes the application and transport protocols of the traffic that will go through this endpoint.
- `http`: Endpoint will have `http` traffic, typically on a TCP connection. It will be automaticaly promoted to `https` when the `secure` field is set to `true`.
- `https`: Endpoint will have `https` traffic, typically on a TCP connection.
- `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. It will be automaticaly promoted to `wss` when the `secure` field is set to `true`.
- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.
- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.
- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.

Default value is `http`


key: secure

description: Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`.


key: targetPort

description: Port number to be used within the container component. The same port cannot be used by two different container components.


key: env

description:
Environment variables used in this container.

The following variables are reserved and cannot be overridden via env:

 - `$PROJECTS_ROOT`

 - `$PROJECT_SOURCE`


key: mountSources

description:
Toggles whether or not the project source code should be mounted in the component.

Defaults to true for all component types except plugins and components that set `dedicatedPod` to true.


key: sourceMapping

description: Optional specification of the path in the container where project sources should be transferred/mounted when `mountSources` is `true`. When omitted, the default value of /projects is used.


key: volumeMounts

description: List of volumes mounts that should be mounted is this container.


key: items

description: Volume that should be mounted to a component container


key: name

description: The volume mount name is the name of an existing `Volume` component. If several containers mount the same volume name then they will reuse the same volume and will be able to access to the same files.


description: The path in the component container where the volume should be mounted. If not path is mentioned, default path is the is `/<name>`.


key: image

description: Allows specifying the definition of an image for outer loop builds


key: autoBuild

description:
Defines if the image should be built during startup.

Default value is `false`


key: dockerfile

description: Allows specifying dockerfile type build


key: args

description: The arguments to supply to the dockerfile build.


key: buildContext

description: Path of source directory to establish build context. Defaults to ${PROJECT_SOURCE} in the container


key: devfileRegistry

description: Dockerfile's Devfile Registry source


key: id

description: Id in a devfile registry that contains a Dockerfile. The src in the OCI registry required for the Dockerfile build will be downloaded for building the image.


key: registryUrl

description: Devfile Registry URL to pull the Dockerfile from when using the Devfile Registry as Dockerfile src. To ensure the Dockerfile gets resolved consistently in different environments, it is recommended to always specify the `devfileRegistryUrl` when `Id` is used.


key: git

description: Dockerfile's Git source


key: checkoutFrom

description: Defines from what the project should be checked out. Required if there are more than one remote configured


key: remote

description: The remote name should be used as init. Required if there are more than one remote configured


key: revision

description: The revision to checkout from. Should be branch name, tag or commit id. Default branch is used if missing or specified revision is not found.


key: fileLocation

description: Location of the Dockerfile in the Git repository when using git as Dockerfile src. Defaults to Dockerfile.


key: remotes

description: The remotes map which should be initialized in the git project. Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured.


key: rootRequired

description:
Specify if a privileged builder pod is required.

Default value is `false`


key: uri

description: URI Reference of a Dockerfile. It can be a full URL or a relative URI from the current devfile as the base URI.


key: imageName

description: Name of the image for the resulting outerloop build


key: kubernetes

description: Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.


key: deployByDefault

description:
Defines if the component should be deployed during startup.

Default value is `false`


key: annotation

description: Annotations to be added to Kubernetes Ingress or Openshift Route


key: attributes

description:
Map of implementation-dependant string-based free-form attributes.

Examples of Che-specific attributes:
- cookiesAuthEnabled: "true" / "false",
- type: "terminal" / "ide" / "ide-dev",


key: exposure

description:
Describes how the endpoint should be exposed on the network.
- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.
- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.
- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.

Default value is `public`


key: path

description: Path of the endpoint URL


key: protocol

description:
Describes the application and transport protocols of the traffic that will go through this endpoint.
- `http`: Endpoint will have `http` traffic, typically on a TCP connection. It will be automaticaly promoted to `https` when the `secure` field is set to `true`.
- `https`: Endpoint will have `https` traffic, typically on a TCP connection.
- `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. It will be automaticaly promoted to `wss` when the `secure` field is set to `true`.
- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.
- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.
- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.

Default value is `http`


key: secure

description: Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`.


key: targetPort

description: Port number to be used within the container component. The same port cannot be used by two different container components.


key: inlined

description: Inlined manifest


description: Location in a file fetched from a uri.


key: name

description: Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin.


key: openshift

description: Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.


key: volume

description: Allows specifying the definition of a volume shared by several other components


key: ephemeral

description: Ephemeral volumes are not stored persistently across restarts. Defaults to false


key: size

description: Size of the volume


key: id

description: Id in a registry that contains a Devfile yaml file


description: Reference to a Kubernetes CRD of type DevWorkspaceTemplate


key: projects

description: Overrides of projects encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules.


description: Map of implementation-dependant free-form YAML attributes.


key: clonePath

description: Path relative to the root of the projects to which this project should be cloned into. This is a unix-style relative path (i.e. uses forward slashes). The path is invalid if it is absolute or tries to escape the project root through the usage of '..'. If not specified, defaults to the project name.


key: git

description: Project's Git source


key: checkoutFrom

description: Defines from what the project should be checked out. Required if there are more than one remote configured


key: remote

description: The remote name should be used as init. Required if there are more than one remote configured


key: revision

description: The revision to checkout from. Should be branch name, tag or commit id. Default branch is used if missing or specified revision is not found.


key: remotes

description: The remotes map which should be initialized in the git project. Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured.


description: Project name


key: zip

description: Project's Zip source


key: location

description: Zip project's source location address. Should be file path of the archive, e.g. file://$FILE_PATH


key: registryUrl

description: Registry URL to pull the parent devfile from when using id in the parent reference. To ensure the parent devfile gets resolved consistently in different environments, it is recommended to always specify the `registryUrl` when `id` is used.


key: starterProjects

description: Overrides of starterProjects encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules.


key: description

description: Description of a starter project


key: subDir

description: Sub-directory from a starter project to be used as root for starter project.


key: uri

description: URI Reference of a parent devfile YAML file. It can be a full URL or a relative URI with the current devfile as the base URI.


key: variables

description: Overrides of variables encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules.


key: version

description: Specific stack/sample version to pull the parent devfile from, when using id in the parent reference. To specify `version`, `id` must be defined and used as the import reference source. `version` can be either a specific stack version, or `latest`. If no `version` specified, default version will be used.


description: Projects worked on in the devworkspace, containing names and sources locations


key: attributes


description: Project's Git source


key: schemaVersion

description: Devfile schema version


description: StarterProjects is a project that can be used as a starting point when bootstrapping new projects


description:
Map of key-value variables used for string replacement in the devfile. Values can be referenced via {{variable-key}} to replace the corresponding value in string fields in the devfile. Replacement cannot be used for

 - schemaVersion, metadata, parent source

 - element identifiers, e.g. command id, component name, endpoint name, project name

 - references to identifiers, e.g. in events, a command's component, container's volume mount name

 - string enums, e.g. command group kind, endpoint exposure


description: Valid URI

format: uri


description: A contribution that is part of this extension

required: id type targets

enum: member public anonymous


key: id

description: A reference ID (string) for the contribution. Each contribution's ID must be unique within an extension.


key: type

description: The ID of the contributionType of this contribution.


description: (Optional) A string describing what the contribution is providing.


key: targets

description: An array of contribution IDs that the contribution is targeting (contributing to).


key: items

description: Contribution IDs that the contribution is targeting.


key: restrictedTo

description: Valid Values: https://docs.microsoft.com/en-us/azure/devops/extend/develop/public-project?view=azure-devops#contribution-visibility


key: properties

description: (Optional) An object that includes properties for the contribution as defined in the contribution type.


description: A contribution Type that is part of this extension

required: id name

enum: string uri guid boolean integer double dateTime array object


description: A reference ID (string) for the contribution type. Each contribution type's ID must be unique within an extension.


key: name

description: The friendly name of the contribution type.


description: (Optional) A string describing in more detail what the contribution type is for.


description: (Optional) A dictionary that maps property names to property descriptions. These properties describe the required and optional properties that can be used by contributions of this type.


description: Information about the contributionType Property


description: The type of value that the property can have.


key: required

description: (Optional) A boolean value which if true indicates that the property is required for all contributions of this type.


description: (Optional) A string describing what the property is used for.


key: manifestVersion

description: This should be 1.


description: This is a string that must be unique among extensions from the same publisher.


description: Should be in the format major.minor.patch, for example 0.1.2 or 1.0.0. You can also add a fourth number for the following format: 0.1.2.3


key: publisher

description: This identifier must match the identifier the extension is published under.


key: categories

description: At least one category must be provided and there is no limit to how many categories you may include.

enum:
Azure Repos
Azure Boards
Azure Pipelines
Azure Test Plans
Azure Artifacts


description: Id of the product or service which your integration/extension should support


description: Some installation target identifiers, like and , support an optional version range. This further clarifies the supported releases the extension or integration is supported on.Microsoft.TeamFoundation.ServerMicrosoft.TeamFoundation.Server.Integration


key: scopes

description: An array of authorization scopes (strings) listing permissions required by your extension.


description: Authorization Scope.


key: demands

description: An array of demands (strings) listing the capabilities required by your extension.


description: Demand Scope.


key: baseUri

description: (Optional) base URL for all relative URLs specified by the extension's contributions.


key: icons

description: Dictionary of icons representing the extension.

format: uri-reference


key: default

description: The value must be the path to the icon file in the extension


key: tags

description: Array of string tags to help users find your extension.

examples:
Extension
Marketplace
Publish
Package
Install
Continuous Integration
Continuous Delivery
Build
Release
Azure Pipelines
Azure DevOps Extensions
Visual Studio Extensions
__BYOLENFORCED
__DoNotDownload


description: A tag to help users find your extension.


key: galleryFlags

description: Array of string tags to classify your extension within the Visual Studio Marketplace

enum: Paid Preview Public


description: A string tag to classify your extension within the Visual Studio Marketplace


key: licensing

description: More information: https://docs.microsoft.com/en-us/azure/devops/extend/develop/manifest?view=azure-devops#mark-an-extension-as-paid


key: galleryproperties


key: screenshots

description: Array of images that could not be included in your **content*.


key: items

description: Each image should be 1366x768 pixels.


key: path

description: The path of each item is the path to the file in the extension.


key: details

description: GitHub Flavored Markdown file which describes the details of the Extension


key: license

description: GitHub Flavored Markdown file which describes the license information of the Extension


key: pricing

description: GitHub Flavored Markdown file which describes the pricing information of the Extension


key: getstarted

description: First steps, how to setup or use.


key: learn

description: Deeper content to help users better understand your extension or service.


description: End user license agreement.


key: privacypolicy

description: Privacy policy for an extension.


key: support

description: Get help and support for an extension.


key: badges

description: Array of links to external metadata badges like TravisCI, Appveyor etc from the approved badges sites.

required: href uri


key: href

description: Link the user navigates to when clicking the badge.


key: uri

description: The absolute URL of the badge image to be displayed.


key: branding

description: Dictionary of brand-related properties.

enum: light dark


key: color

description: Primary color of the extension or publisher; can be a hex (#ff00ff), RGB (rgb(100,200,50)), or supported HTML color names (blue).


key: theme

description: Complements the color; use dark for dark branding colors, or light for lighter branding colors.


key: public

description: Set to true to make this extension public in the Visual Studio Market Place


description: A file you wish to include in your extension. Both folders and individual files are acceptable


description: Path of resource, root directory is where your manifest file is located


key: addressable

description: Set to true if you want your file to be URL-addressable


key: packagePath

description: Places your resource from disk to the specified value when packaged


description:
The output format options
https://gohugo.io/templates/output-formats/#configure-output-formats

enum: application/javascript application/json application/manifest+json application/octet-stream application/pdf application/rss+xml application/toml application/typescript application/xml application/yaml font/otf font/ttf image/bmp image/gif image/jpeg image/png image/svg+xml image/webp text/calendar text/css text/csv text/html text/jsx text/plain text/tsx text/x-sass text/x-scss video/3gpp video/mp4 video/mpeg video/ogg video/webm video/x-msvideo

default: index

default: alternate


key: name

description:
The identifier
https://gohugo.io/templates/output-formats/#configure-output-formats


key: mediaType

description:
The media type
https://gohugo.io/templates/output-formats/#configure-output-formats


key: path

description:
The path
https://gohugo.io/templates/output-formats/#configure-output-formats


key: baseName

description:
The base filename for the list filenames
https://gohugo.io/templates/output-formats/#configure-output-formats


key: protocol

description:
The replacement for `http://` or `https://` in `baseURL`
https://gohugo.io/templates/output-formats/#configure-output-formats


key: isPlainText

description:
Enable/disable Go's plain text templates parser for the templates
https://gohugo.io/templates/output-formats/#configure-output-formats


key: noUgly

description:
Enable/disable adding file extensions to urls
https://gohugo.io/templates/output-formats/#configure-output-formats


key: notAlternative

description:
Include/exclude this format in an AlternativeOutputFormats format listing
https://gohugo.io/templates/output-formats/#configure-output-formats


key: permalinkable

description:
Enable/disable .Permalink and .RelPermalink return the rendering output format
https://gohugo.io/templates/output-formats/#configure-output-formats


key: weight

description:
The weight
https://gohugo.io/templates/output-formats/#configure-output-formats


key: aliases

description:
The aliases
https://gohugo.io/content-management/front-matter#predefined


key: audio

description:
The audio
https://gohugo.io/content-management/front-matter#predefined


key: date

description:
The datetime
https://gohugo.io/content-management/front-matter#predefined


key: description

description:
The description
https://gohugo.io/content-management/front-matter#predefined


key: draft

description:
Specify that the content is (not) the draft
https://gohugo.io/content-management/front-matter#predefined


key: expiryDate

description:
The expire date
https://gohugo.io/content-management/front-matter#predefined


key: headless

description:
Specify that the content is (not) the headless bundle
https://gohugo.io/content-management/front-matter#predefined


key: images

description:
The images
https://gohugo.io/content-management/front-matter#predefined


key: isCJKLanguage

description:
Specify that the page language is (not) the CJK language
https://gohugo.io/content-management/front-matter#predefined


key: keywords

description:
The keywords
https://gohugo.io/content-management/front-matter#predefined


key: layout

description:
The layout
https://gohugo.io/content-management/front-matter#predefined


key: lastmod

description:
The last modification time
https://gohugo.io/content-management/front-matter#predefined


key: linkTitle

description:
The link title
https://gohugo.io/content-management/front-matter#predefined


key: outputs

description:
The output format options
https://gohugo.io/content-management/front-matter#predefined


key: publishDate

description:
The publish date
https://gohugo.io/content-management/front-matter#predefined


key: resources

description:
The resource options
https://gohugo.io/content-management/front-matter#predefined


key: name

description:
The value for `Name`
https://gohugo.io/content-management/page-resources/#page-resources-metadata


key: title

description:
The value for `Title`
https://gohugo.io/content-management/page-resources/#page-resources-metadata


key: params

description:
The param options
https://gohugo.io/content-management/page-resources/#page-resources-metadata


The param
https://gohugo.io/content-management/page-resources/#page-resources-metadata


key: series

description:
The series
https://gohugo.io/content-management/front-matter#predefined


key: slug

description:
The slug
https://gohugo.io/content-management/front-matter#predefined


key: summary

description:
The summary
https://gohugo.io/content-management/front-matter#predefined


description:
The title
https://gohugo.io/content-management/front-matter#predefined


key: type

description:
The type
https://gohugo.io/content-management/front-matter#predefined


key: url

description:
The url
https://gohugo.io/content-management/front-matter#predefined


key: videos

description:
The videos
https://gohugo.io/content-management/front-matter#predefined


key: weight

description:
The weight
https://gohugo.io/content-management/front-matter#predefined


The front matter default
https://gohugo.io/content-management/front-matter#front-matter-cascade


key: archetypeDir

description:
The directory to store archetype files
https://gohugo.io/getting-started/configuration/#archetypedir

default: archetypes


key: assetDir

description:
The directory to store asset files
https://gohugo.io/getting-started/configuration/#assetdir

default: assets


key: baseURL

description:
The hostname and the path to the root
https://gohugo.io/getting-started/configuration/#baseurl


key: build

description:
The build options
https://gohugo.io/getting-started/configuration/#configure-build

default: fallback

enum: never always fallback


key: useResourceCacheWhen

description:
The time when to use the cached resources in `/resources/_gen` for `PostCSS` and `ToCSS`
https://gohugo.io/getting-started/configuration/#configure-build


key: writeStats

description:
Enable/disable `hugo_stats.json` writing to the root project directory
https://gohugo.io/getting-started/configuration/#configure-build


key: noJSConfigInAssets

description:
Enable/disable `jsconfig.json` writing into your `/assets` folder with mapping of imports from running `js.Build`
https://gohugo.io/getting-started/configuration/#configure-build


key: buildDrafts

description:
Include/exclude the drafts when building
https://gohugo.io/getting-started/configuration/#builddrafts-false


key: buildExpired

description:
Include/exclude the content already expired
https://gohugo.io/getting-started/configuration/#buildexpired


key: buildFuture

description:
Include/exclude the content with `publishDate` in the future
https://gohugo.io/getting-started/configuration/#buildfuture


key: caches

description:
The cache options
https://gohugo.io/getting-started/configuration/#configure-file-caches

dir: :cacheDir/modules

examples: :cacheDir :project :resourceDir :resourceDir/_gen :cacheDir/:project :cacheDir/modules


description: Cache entry


key: maxAge

description:
The duration before the cache entry will be evicted
https://gohugo.io/getting-started/configuration/#the-keywords-explained


key: dir

description:
The absolute path to store cache files
https://gohugo.io/getting-started/configuration/#the-keywords-explained


key: cascade

description:
The front matter options
https://gohugo.io/content-management/front-matter#front-matter-cascade


key: path

description:
The glob pattern matching the content path below /content
https://gohugo.io/content-management/front-matter#front-matter-cascade


key: kind

description:
The glob pattern matching the page's kind
https://gohugo.io/content-management/front-matter#front-matter-cascade


key: lang

description:
The glob pattern matching the page's language
https://gohugo.io/content-management/front-matter#front-matter-cascade


key: canonifyURLs

description:
Enable/disable relative URLs to absolute conversion
https://gohugo.io/getting-started/configuration/#canonifyurls


key: contentDir

description:
The directory where content files are stored
https://gohugo.io/getting-started/configuration/#contentdir

default: content


key: copyright

description:
The copyright notice for your site
https://gohugo.io/getting-started/configuration/#copyright


key: dataDir

description:
The directory where data files are stored
https://gohugo.io/getting-started/configuration/#datadir

default: data


key: defaultContentLanguage

description:
The default content language for the content without language indicator
https://gohugo.io/getting-started/configuration/#defaultcontentlanguage

default: en


key: defaultContentLanguageInSubdir

description:
Enable/disable rendering the default content language in subdir
https://gohugo.io/getting-started/configuration/#defaultcontentlanguageinsubdir


key: disableAliases

description:
Enable/disable generation of the alias redirects
https://gohugo.io/getting-started/configuration/#disablealiases


key: disableHugoGeneratorInject

description:
Enable/disable injecting a generator meta tag in the HTML head on the home page only
https://gohugo.io/getting-started/configuration/#disablehugogeneratorinject


key: disableKinds

description:
Disabled kinds of pages
https://gohugo.io/getting-started/configuration/#disablekinds

enum: page home section taxonomy term RSS sitemap robotsTXT 404


key: disableLiveReload

description:
Enable/disable automatic live reloading of browser window
https://gohugo.io/getting-started/configuration/#disablelivereload


key: disablePathToLower

description:
Enable/disable the url/path to lowercase conversion
https://gohugo.io/getting-started/configuration/#disablepathtolower


key: enableEmoji

description:
Enable/disable Emoji emoticons support for page content
https://gohugo.io/getting-started/configuration/#enableemoji


key: enableGitInfo

description:
Enable/disable .GitInfo object for each page
https://gohugo.io/getting-started/configuration/#enablegitinfo


key: enableInlineShortcodes

description:
Enable/disable inline shortcode support
https://gohugo.io/getting-started/configuration/#enableinlineshortcodes


key: enableMissingTranslationPlaceholders

description:
Enable/disable placeholder substitution instead of the default value or an empty string if a translation is missing
https://gohugo.io/getting-started/configuration/#enablemissingtranslationplaceholders


key: enableRobotsTXT

description:
Enable/disable generation of robots.txt file
https://gohugo.io/getting-started/configuration/#enablerobotstxt


key: frontmatter

description:
The front matter options
https://gohugo.io/getting-started/configuration/#configure-front-matter

date: date publishDate lastmod

lastmod: :git lastmod date publishDate

publishDate: publishDate date

enum: date publishDate lastmod :default :filename :git modified pubdate

enum: expiryDate unpublishdate

enum: :git lastmod date publishDate :fileModTime modified pubdate

enum: publishDate date pubdate


key: date


key: expiryDate


key: lastmod


key: publishDate


key: footnoteAnchorPrefix

description:
The prefix for footnote anchors
https://gohugo.io/getting-started/configuration/#footnoteanchorprefix


key: footnoteReturnLinkContents

description:
The text to display for footnote return links
https://gohugo.io/getting-started/configuration/#footnotereturnlinkcontents


key: googleAnalytics

description:
The Google Analytics tracking ID
https://gohugo.io/getting-started/configuration/#googleanalytics


key: hasCJKLanguage

description:
Enable/disable auto-detecting Chinese/Japanese/Korean Languages in the content
https://gohugo.io/getting-started/configuration/#hascjklanguage


key: imaging

description:
The image processing options
https://gohugo.io/getting-started/configuration/#imaging

resampleFilter: Box

hint: photo

anchor: Smart

bgColor: #ffffff

default: Box

enum: NearestNeighbor Box Linear Hermite MitchellNetravali CatmullRom BSpline Gaussian Lanczos Hann Hamming Blackman Bartlett Welch Cosine

default: photo

enum: picture photo drawing icon text

default: Smart

enum: Smart TopLeft Top TopRight Left Center Right BottomLeft Bottom BottomRight

default: #ffffff


key: resampleFilter

description:
The default resample filter
https://gohugo.io/content-management/image-processing/#resampling-filter


key: quality

description:
The default quality
https://gohugo.io/content-management/image-processing/#image-processing-config


key: hint

description:
The default hint about what type of image
https://gohugo.io/content-management/image-processing/#image-processing-config


key: anchor

description:
The anchor used when cropping pictures with either .Fill or .Crop
https://gohugo.io/content-management/image-processing/#image-processing-config


key: bgColor

description:
The default background color
https://gohugo.io/content-management/image-processing/#image-processing-config


key: exif

description:
Exif options
https://gohugo.io/content-management/image-processing/#image-processing-config


key: includeFields

description:
The regexp matching the included fields
https://gohugo.io/content-management/image-processing/#image-processing-config


key: excludeFields

description:
The regexp matching the excluded fields
https://gohugo.io/content-management/image-processing/#image-processing-config


key: disableDate

description:
Enable/disable extracting the 'photo taken' date/time into .Date
https://gohugo.io/content-management/image-processing/#image-processing-config


key: disableLatLong

description:
Enable/disable extracting the 'photo taken where' into .Long and .Lat
https://gohugo.io/content-management/image-processing/#image-processing-config


key: languageCode

description:
The language tag as defined by RFC 5646
https://gohugo.io/getting-started/configuration/#languagecode


key: languages

description:
The language options
https://gohugo.io/content-management/multilingual/#configure-languages


description: Tha language options


key: disableLanguages

description:
The disabled languages
https://gohugo.io/content-management/multilingual/#disable-a-language


key: markup

description:
The markdown options
https://gohugo.io/getting-started/configuration-markup

failureLevel: fatal

safeMode: unsafe

defaultMarkdownHandler: goldmark

linkifyProtocol: https

autoHeadingIDType: github

style: monokai

default: fatal

default: unsafe

enum: unsafe safe server secure

default: goldmark

enum: goldmark blackfriday

default: https

default: github

enum: table inline

default: monokai

enum: algol algol_nu api arduino autumn borland bw colorful dracula emacs friendly fruity github igor lovelace manni monokai monokailight murphy native pastie perldoc pygments rainbow_dash rrt swapoff tango trac vim vs xcode


key: asciidocExt

description:
AsciidocExt options
https://docs.asciidoctor.org/asciidoctor/latest/cli/man1/asciidoctor/#processing-information


key: attributes

description:
The document attributes
https://docs.asciidoctor.org/asciidoctor/latest/cli/man1/asciidoctor/#document-settings


key: backend

description:
The backend output file format
https://docs.asciidoctor.org/asciidoctor/latest/cli/man1/asciidoctor/#document-settings


key: failureLevel

description:
The minimum logging level
https://docs.asciidoctor.org/asciidoctor/latest/cli/man1/asciidoctor/#processing-information


key: safeMode

description:
The safe mode
https://docs.asciidoctor.org/asciidoctor/latest/safe-modes/


key: sectionNumbers

description:
Enable/disable section title's auto-numbering
https://docs.asciidoctor.org/asciidoctor.js/latest/cli/options/#document-conversion


key: trace

description:
Include/exclude the backtrace information on errors
https://gohugo.io/getting-started/configuration-markup#configure-markup


key: verbose

description:
Enable/disable verbose error printing
https://gohugo.io/getting-started/configuration-markup#configure-markup


key: blackfriday

description:
Blackfriday options
https://gohugo.io/getting-started/configuration-markup#blackfriday


key: defaultMarkdownHandler

description:
The default markdown renderer
https://gohugo.io/getting-started/configuration-markup#blackfriday


key: goldmark

description:
Goldmark options
https://gohugo.io/getting-started/configuration-markup#goldmark


key: extensions

description:
The extension options
https://gohugo.io/getting-started/configuration-markup#goldmark


key: parser

description:
The parser options
https://gohugo.io/getting-started/configuration-markup#goldmark


key: renderer

description:
The renderer options
https://gohugo.io/getting-started/configuration-markup#goldmark


key: highlight

description:
The highlighting options
https://gohugo.io/getting-started/configuration-markup#highlight


key: anchorLineNos

description:
Enable/disable anchors on line numbers
https://gohugo.io/getting-started/configuration-markup#highlight


description:
The highlighted line number range
https://gohugo.io/getting-started/configuration-markup#highlight


key: lineAnchors

description:
The prefix for the anchors on line numbers
https://gohugo.io/getting-started/configuration-markup#highlight


key: lineNoStart

description:
The first line
https://gohugo.io/getting-started/configuration-markup#highlight


key: lineNos

description:
Enable/disable line numbers
https://gohugo.io/getting-started/configuration-markup#highlight


key: style


key: tableOfContents

description:
The table of contents options
https://gohugo.io/getting-started/configuration-markup#table-of-contents


key: startLevel

description:
The start heading level
https://gohugo.io/getting-started/configuration-markup#table-of-contents


key: endLevel

description:
The end heading level
https://gohugo.io/getting-started/configuration-markup#table-of-contents


key: ordered

description:
Enable/disable ordered list generation
https://gohugo.io/getting-started/configuration-markup#table-of-contents


key: mediaTypes

description:
The media type's options
https://gohugo.io/templates/output-formats/#media-types

default: js jsm mjs

examples: js jsm mjs

default: xml rss

examples: xml rss

default: yaml yml

examples: yaml yml

default: jpg jpeg gpe jif jfif

examples: jpg jpeg gpe jif jfif

default: mpg mpeg

examples: mpg mpeg


key: application/javascript


key: application/rss+xml


key: application/yaml


key: image/jpeg


key: menu

description:
The menu options
https://gohugo.io/content-management/menus/#add-non-content-entries-to-a-menu


description:
The menu
https://gohugo.io/content-management/menus/#add-non-content-entries-to-a-menu


key: identifier

description:
Required when two or more menu entries have the same name
https://gohugo.io/content-management/menus/#properties-front-matter


key: name

description:
The text to display when rendering the menu entry.
https://gohugo.io/content-management/menus/#properties-front-matter


key: parent

description:
Required for child entries in a nested menu.
https://gohugo.io/content-management/menus/#properties-front-matter


key: weight

description:
A non-zero integer indicating the entry's position relative the root of the menu, or to its parent for a child entry
https://gohugo.io/content-management/menus/#properties-front-matter


key: pageRef

description:
Required for internal links.
https://gohugo.io/content-management/menus/#properties-site-configuration


key: url

description:
Required for external links.
https://gohugo.io/content-management/menus/#properties-site-configuration


key: minify


key: tdewolff


key: html


key: module

description:
The module options
https://gohugo.io/hugo-modules/configuration/

proxy: direct

default: true

default: direct

examples: path/to/input_directory1 -> path/to/output_directory1,path/to/input_directory2 -> path/to/output_directory2

source: content

target: content

source: static

target: static

source: layouts

target: layouts

source: data

target: data

source: assets

target: assets

source: archetypes

target: archetypes

required: source target


key: noVendor

description:
The glob pattern matching the paths to skip when vendoring
https://gohugo.io/hugo-modules/configuration/#module-config-top-level


key: vendorClosest

description:
Enable/disable picking the vendored module closest to the module using it
https://gohugo.io/hugo-modules/configuration/#module-config-top-level


key: proxy

description:
The proxy server to download the remote modules
https://gohugo.io/hugo-modules/configuration/#module-config-top-level


key: noProxy

description:
The glob list of the matching paths that should not use the proxy configured above
https://gohugo.io/hugo-modules/configuration/#module-config-top-level


key: private

description:
The glob list of the matching paths that should be treated as private
https://gohugo.io/hugo-modules/configuration/#module-config-top-level


key: replacements

description:
The list of the module path to directory replacement mapping
https://gohugo.io/hugo-modules/configuration/#module-config-top-level


key: hugoVersion

description:
The version
https://gohugo.io/hugo-modules/configuration/#module-config-hugoversion


key: min

description:
The minimum required version
https://gohugo.io/hugo-modules/configuration/#module-config-hugoversion


key: max

description:
The maximum required version
https://gohugo.io/hugo-modules/configuration/#module-config-hugoversion


key: extended

description:
Enable/disable requiring the extended version
https://gohugo.io/hugo-modules/configuration/#module-config-hugoversion


key: imports

description:
The import options
https://gohugo.io/hugo-modules/configuration/#module-config-imports


key: path

description:
The path
https://gohugo.io/hugo-modules/configuration/#module-config-imports


key: ignoreConfig

description:
Use/ignore the configuration file
https://gohugo.io/hugo-modules/configuration/#module-config-imports


key: ignoreImports

description:
Use/ignore the imports
https://gohugo.io/hugo-modules/configuration/#module-config-imports


key: disable

description:
Enable/disable the module
https://gohugo.io/hugo-modules/configuration/#module-config-imports


key: noMounts

description:
Enable/disable the folder mounting
https://gohugo.io/hugo-modules/configuration/#module-config-imports


description:
Enable/disable vendoring this import
https://gohugo.io/hugo-modules/configuration/#module-config-imports


key: mounts

description:
The mount options
https://gohugo.io/hugo-modules/configuration/#module-config-mounts


key: source

description:
The source path
https://gohugo.io/hugo-modules/configuration/#module-config-mounts


key: target

description:
The target path
https://gohugo.io/hugo-modules/configuration/#module-config-mounts


key: lang

description:
The language code
https://gohugo.io/hugo-modules/configuration/#module-config-mounts


key: includeFiles

description:
The included files
https://gohugo.io/hugo-modules/configuration/#module-config-mounts


key: excludeFiles

description:
The excluded files
https://gohugo.io/hugo-modules/configuration/#module-config-mounts


key: newContentEditor

description:
The content editor
https://gohugo.io/getting-started/configuration/#newcontenteditor


key: noChmod

description:
Enable/disable syncing permission mode of files
https://gohugo.io/getting-started/configuration/#nochmod


key: noTimes

description:
Enable/disable syncing modification time of files
https://gohugo.io/getting-started/configuration/#notimes


key: outputFormats

description:
The output format options
https://gohugo.io/templates/output-formats/#configure-output-formats


key: paginate

description:
The default number of elements per page in pagination
https://gohugo.io/getting-started/configuration/#paginate


key: paginatePath

description:
The path element used during pagination
https://gohugo.io/getting-started/configuration/#paginatepath

default: page


key: permalinks

description:
The permalink options
https://gohugo.io/content-management/urls/#permalinks

examples: :year :month :monthname :day :weekday :weekdayname :yearday :section :sections :title :slug :filename


description: The permalink


key: pluralizeListTitles

description:
Pluralize/leave titles in lists
https://gohugo.io/getting-started/configuration/#pluralizelisttitles


key: publishDir

description:
The directory where Hugo writes the final static site
https://gohugo.io/getting-started/configuration/#publishdir

default: public


key: related

description:
The related content options
https://gohugo.io/getting-started/configuration/#related


key: includeNewer

description:
Include/exclude the pages newer than the current page
https://gohugo.io/content-management/related/#top-level-config-options


key: toLower

description:
Enable/disable lowering the case keywords in both the indexes and the queries
https://gohugo.io/content-management/related/#top-level-config-options


key: indices

description:
The related content option's entry
https://gohugo.io/content-management/related/#config-options-per-index


key: name

description:
The index name
https://gohugo.io/content-management/related/#config-options-per-index


key: weight

description:
The weight indicating how important this parameter is relative to the other parameters
https://gohugo.io/content-management/related/#config-options-per-index


key: pattern

description:
The date format
https://gohugo.io/content-management/related/#config-options-per-index


description:
Enable/disable lowering the case keywords in both the indexes and the queries
https://gohugo.io/content-management/related/#config-options-per-index


key: relativeURLs

description:
Enable/disable making all relative URLs relative to content root
https://gohugo.io/getting-started/configuration/#relativeurls


key: refLinksErrorLevel

description:
The logging level for page links cannot be resolved
https://gohugo.io/getting-started/configuration/#reflinkserrorlevel

default: ERROR

enum: ERROR WARNING


key: refLinksNotFoundURL

description:
The placeholder when a page reference cannot be found in `ref` or `relref`
https://gohugo.io/getting-started/configuration/#reflinksnotfoundurl


key: removePathAccents

description:
Remove/leave non-spacing marks from composite characters in content paths
https://gohugo.io/getting-started/configuration/#removepathaccents


key: security

description:
The security options
https://gohugo.io/about/security-model/#security-policy

allow: ^dart-sass-embedded$ ^go$ ^npx$ ^postcss$


key: exec

default: ^dart-sass-embedded$ ^go$ ^npx$ ^postcss$


key: allow


key: sitemap

description:
The sitemap options
https://gohugo.io/templates/sitemap-template/#configure-sitemapxml

changefreq: monthly

default: monthly


key: summaryLength

description:
The length of text in words to show in a .Summary
https://gohugo.io/getting-started/configuration/#summarylength


key: taxonomies

description:
The taxonomy options
https://gohugo.io/content-management/taxonomies#configure-taxonomies

category: categories

tag: tags

default: tags

default: categories


key: tag

description:
The default taxonomy
https://gohugo.io/content-management/taxonomies#configure-taxonomies


key: category


key: ^(?!tag|category)$

description:
The custom taxonomy
https://gohugo.io/content-management/taxonomies#configure-taxonomies


key: themesDir

description:
The directory where themes are stored
https://gohugo.io/getting-started/configuration/#themesdir

default: themes


key: timeout

description:
The timeout for generating page contents
https://gohugo.io/getting-started/configuration/#timeout


key: timeZone

description:
The time zone
https://gohugo.io/getting-started/configuration/#timezone

enum: Africa/Abidjan Africa/Accra Africa/Addis_Ababa Africa/Algiers Africa/Asmara Africa/Asmera Africa/Bamako Africa/Bangui Africa/Banjul Africa/Bissau Africa/Blantyre Africa/Brazzaville Africa/Bujumbura Africa/Cairo Africa/Casablanca Africa/Ceuta Africa/Conakry Africa/Dakar Africa/Dar_es_Salaam Africa/Djibouti Africa/Douala Africa/El_Aaiun Africa/Freetown Africa/Gaborone Africa/Harare Africa/Johannesburg Africa/Juba Africa/Kampala Africa/Khartoum Africa/Kigali Africa/Kinshasa Africa/Lagos Africa/Libreville Africa/Lome Africa/Luanda Africa/Lubumbashi Africa/Lusaka Africa/Malabo Africa/Maputo Africa/Maseru Africa/Mbabane Africa/Mogadishu Africa/Monrovia Africa/Nairobi Africa/Ndjamena Africa/Niamey Africa/Nouakchott Africa/Ouagadougou Africa/Porto-Novo Africa/Sao_Tome Africa/Timbuktu Africa/Tripoli Africa/Tunis Africa/Windhoek America/Adak America/Anchorage America/Anguilla America/Antigua America/Araguaina America/Argentina/Buenos_Aires America/Argentina/Catamarca America/Argentina/ComodRivadavia America/Argentina/Cordoba America/Argentina/Jujuy America/Argentina/La_Rioja America/Argentina/Mendoza America/Argentina/Rio_Gallegos America/Argentina/Salta America/Argentina/San_Juan America/Argentina/San_Luis America/Argentina/Tucuman America/Argentina/Ushuaia America/Aruba America/Asuncion America/Atikokan America/Atka America/Bahia America/Bahia_Banderas America/Barbados America/Belem America/Belize America/Blanc-Sablon America/Boa_Vista America/Bogota America/Boise America/Buenos_Aires America/Cambridge_Bay America/Campo_Grande America/Cancun America/Caracas America/Catamarca America/Cayenne America/Cayman America/Chicago America/Chihuahua America/Coral_Harbour America/Cordoba America/Costa_Rica America/Creston America/Cuiaba America/Curacao America/Danmarkshavn America/Dawson America/Dawson_Creek America/Denver America/Detroit America/Dominica America/Edmonton America/Eirunepe America/El_Salvador America/Ensenada America/Fort_Nelson America/Fort_Wayne America/Fortaleza America/Glace_Bay America/Godthab America/Goose_Bay America/Grand_Turk America/Grenada America/Guadeloupe America/Guatemala America/Guayaquil America/Guyana America/Halifax America/Havana America/Hermosillo America/Indiana/Indianapolis America/Indiana/Knox America/Indiana/Marengo America/Indiana/Petersburg America/Indiana/Tell_City America/Indiana/Vevay America/Indiana/Vincennes America/Indiana/Winamac America/Indianapolis America/Inuvik America/Iqaluit America/Jamaica America/Jujuy America/Juneau America/Kentucky/Louisville America/Kentucky/Monticello America/Knox_IN America/Kralendijk America/La_Paz America/Lima America/Los_Angeles America/Louisville America/Lower_Princes America/Maceio America/Managua America/Manaus America/Marigot America/Martinique America/Matamoros America/Mazatlan America/Mendoza America/Menominee America/Merida America/Metlakatla America/Mexico_City America/Miquelon America/Moncton America/Monterrey America/Montevideo America/Montreal America/Montserrat America/Nassau America/New_York America/Nipigon America/Nome America/Noronha America/North_Dakota/Beulah America/North_Dakota/Center America/North_Dakota/New_Salem America/Nuuk America/Ojinaga America/Panama America/Pangnirtung America/Paramaribo America/Phoenix America/Port-au-Prince America/Port_of_Spain America/Porto_Acre America/Porto_Velho America/Puerto_Rico America/Punta_Arenas America/Rainy_River America/Rankin_Inlet America/Recife America/Regina America/Resolute America/Rio_Branco America/Rosario America/Santa_Isabel America/Santarem America/Santiago America/Santo_Domingo America/Sao_Paulo America/Scoresbysund America/Shiprock America/Sitka America/St_Barthelemy America/St_Johns America/St_Kitts America/St_Lucia America/St_Thomas America/St_Vincent America/Swift_Current America/Tegucigalpa America/Thule America/Thunder_Bay America/Tijuana America/Toronto America/Tortola America/Vancouver America/Virgin America/Whitehorse America/Winnipeg America/Yakutat America/Yellowknife Antarctica/Casey Antarctica/Davis Antarctica/DumontDUrville Antarctica/Macquarie Antarctica/Mawson Antarctica/McMurdo Antarctica/Palmer Antarctica/Rothera Antarctica/South_Pole Antarctica/Syowa Antarctica/Troll Antarctica/Vostok Arctic/Longyearbyen Asia/Aden Asia/Almaty Asia/Amman Asia/Anadyr Asia/Aqtau Asia/Aqtobe Asia/Ashgabat Asia/Ashkhabad Asia/Atyrau Asia/Baghdad Asia/Bahrain Asia/Baku Asia/Bangkok Asia/Barnaul Asia/Beirut Asia/Bishkek Asia/Brunei Asia/Calcutta Asia/Chita Asia/Choibalsan Asia/Chongqing Asia/Chungking Asia/Colombo Asia/Dacca Asia/Damascus Asia/Dhaka Asia/Dili Asia/Dubai Asia/Dushanbe Asia/Famagusta Asia/Gaza Asia/Harbin Asia/Hebron Asia/Ho_Chi_Minh Asia/Hong_Kong Asia/Hovd Asia/Irkutsk Asia/Istanbul Asia/Jakarta Asia/Jayapura Asia/Jerusalem Asia/Kabul Asia/Kamchatka Asia/Karachi Asia/Kashgar Asia/Kathmandu Asia/Katmandu Asia/Khandyga Asia/Kolkata Asia/Krasnoyarsk Asia/Kuala_Lumpur Asia/Kuching Asia/Kuwait Asia/Macao Asia/Macau Asia/Magadan Asia/Makassar Asia/Manila Asia/Muscat Asia/Nicosia Asia/Novokuznetsk Asia/Novosibirsk Asia/Omsk Asia/Oral Asia/Phnom_Penh Asia/Pontianak Asia/Pyongyang Asia/Qatar Asia/Qostanay Asia/Qyzylorda Asia/Rangoon Asia/Riyadh Asia/Saigon Asia/Sakhalin Asia/Samarkand Asia/Seoul Asia/Shanghai Asia/Singapore Asia/Srednekolymsk Asia/Taipei Asia/Tashkent Asia/Tbilisi Asia/Tehran Asia/Tel_Aviv Asia/Thimbu Asia/Thimphu Asia/Tokyo Asia/Tomsk Asia/Ujung_Pandang Asia/Ulaanbaatar Asia/Ulan_Bator Asia/Urumqi Asia/Ust-Nera Asia/Vientiane Asia/Vladivostok Asia/Yakutsk Asia/Yangon Asia/Yekaterinburg Asia/Yerevan Atlantic/Azores Atlantic/Bermuda Atlantic/Canary Atlantic/Cape_Verde Atlantic/Faeroe Atlantic/Faroe Atlantic/Jan_Mayen Atlantic/Madeira Atlantic/Reykjavik Atlantic/South_Georgia Atlantic/St_Helena Atlantic/Stanley Australia/ACT Australia/Adelaide Australia/Brisbane Australia/Broken_Hill Australia/Canberra Australia/Currie Australia/Darwin Australia/Eucla Australia/Hobart Australia/LHI Australia/Lindeman Australia/Lord_Howe Australia/Melbourne Australia/North Australia/NSW Australia/Perth Australia/Queensland Australia/South Australia/Sydney Australia/Tasmania Australia/Victoria Australia/West Australia/Yancowinna Brazil/Acre Brazil/DeNoronha Brazil/East Brazil/West Canada/Atlantic Canada/Central Canada/Eastern Canada/Mountain Canada/Newfoundland Canada/Pacific Canada/Saskatchewan Canada/Yukon Chile/Continental Chile/EasterIsland Cuba Egypt Eire Etc/GMT Etc/GMT+0 Etc/GMT+1 Etc/GMT+10 Etc/GMT+11 Etc/GMT+12 Etc/GMT+2 Etc/GMT+3 Etc/GMT+4 Etc/GMT+5 Etc/GMT+6 Etc/GMT+7 Etc/GMT+8 Etc/GMT+9 Etc/GMT-0 Etc/GMT-1 Etc/GMT-10 Etc/GMT-11 Etc/GMT-12 Etc/GMT-13 Etc/GMT-14 Etc/GMT-2 Etc/GMT-3 Etc/GMT-4 Etc/GMT-5 Etc/GMT-6 Etc/GMT-7 Etc/GMT-8 Etc/GMT-9 Etc/GMT0 Etc/Greenwich Etc/UCT Etc/Universal Etc/UTC Etc/Zulu Europe/Amsterdam Europe/Andorra Europe/Astrakhan Europe/Athens Europe/Belfast Europe/Belgrade Europe/Berlin Europe/Bratislava Europe/Brussels Europe/Bucharest Europe/Budapest Europe/Busingen Europe/Chisinau Europe/Copenhagen Europe/Dublin Europe/Gibraltar Europe/Guernsey Europe/Helsinki Europe/Isle_of_Man Europe/Istanbul Europe/Jersey Europe/Kaliningrad Europe/Kiev Europe/Kirov Europe/Lisbon Europe/Ljubljana Europe/London Europe/Luxembourg Europe/Madrid Europe/Malta Europe/Mariehamn Europe/Minsk Europe/Monaco Europe/Moscow Europe/Nicosia Europe/Oslo Europe/Paris Europe/Podgorica Europe/Prague Europe/Riga Europe/Rome Europe/Samara Europe/San_Marino Europe/Sarajevo Europe/Saratov Europe/Simferopol Europe/Skopje Europe/Sofia Europe/Stockholm Europe/Tallinn Europe/Tirane Europe/Tiraspol Europe/Ulyanovsk Europe/Uzhgorod Europe/Vaduz Europe/Vatican Europe/Vienna Europe/Vilnius Europe/Volgograd Europe/Warsaw Europe/Zagreb Europe/Zaporozhye Europe/Zurich GB GB-Eire Hongkong Iceland Indian/Antananarivo Indian/Chagos Indian/Christmas Indian/Cocos Indian/Comoro Indian/Kerguelen Indian/Mahe Indian/Maldives Indian/Mauritius Indian/Mayotte Indian/Reunion Iran Israel Jamaica Japan Kwajalein Libya Mexico/BajaNorte Mexico/BajaSur Mexico/General Navajo NZ NZ-CHAT Pacific/Apia Pacific/Auckland Pacific/Bougainville Pacific/Chatham Pacific/Chuuk Pacific/Easter Pacific/Efate Pacific/Enderbury Pacific/Fakaofo Pacific/Fiji Pacific/Funafuti Pacific/Galapagos Pacific/Gambier Pacific/Guadalcanal Pacific/Guam Pacific/Honolulu Pacific/Johnston Pacific/Kanton Pacific/Kiritimati Pacific/Kosrae Pacific/Kwajalein Pacific/Majuro Pacific/Marquesas Pacific/Midway Pacific/Nauru Pacific/Niue Pacific/Norfolk Pacific/Noumea Pacific/Pago_Pago Pacific/Palau Pacific/Pitcairn Pacific/Pohnpei Pacific/Ponape Pacific/Port_Moresby Pacific/Rarotonga Pacific/Saipan Pacific/Samoa Pacific/Tahiti Pacific/Tarawa Pacific/Tongatapu Pacific/Truk Pacific/Wake Pacific/Wallis Pacific/Yap Poland Portugal PRC ROC Singapore US/Alaska US/Aleutian US/Arizona US/Central US/East-Indiana US/Eastern US/Hawaii US/Indiana-Starke US/Michigan US/Mountain US/Pacific US/Samoa


key: title

description:
The site title
https://gohugo.io/getting-started/configuration/#title


key: titleCaseStyle

description:
The title case style
https://gohugo.io/getting-started/configuration/#titlecasestyle

default: AP

enum: AP Chicago Go


key: uglyURLs

description:
Enable/disable adding file extensions to urls
https://gohugo.io/getting-started/configuration/#uglyurls


key: watch

description:
Enable/disable watching filesystem for changes and recreating as needed
https://gohugo.io/getting-started/configuration/#watch


description: Schema for UI5 Tooling Configuration File (ui5.yaml)

errorMessage:
Unsupported "specVersion"
Your UI5 CLI installation might be outdated.
Supported specification versions: "3.1", "3.0", "2.6", "2.5", "2.4", "2.3", "2.2", "2.1", "2.0", "1.1", "1.0", "0.1"
For details, see: https://sap.github.io/ui5-tooling/pages/Configuration/#specification-versions

required: specVersion type

enum: application library theme-library module

const: application

required: specVersion type metadata

enum: time hash

const: library

const: theme-library

const: module

errorMessage: Not a valid project name. It must consist of lowercase alphanumeric characters, dash, underscore, and period only. Additionally, it may contain an npm-style package scope. For details, see: https://sap.github.io/ui5-tooling/stable/pages/Configuration/#name

errorMessage: Not a valid version according to the Semantic Versioning specification (https://semver.org/)

errorMessage: Either "development" or "optional" can be true, but not both

required: specVersion kind type metadata middleware

errorMessage: Not a valid extension name. It must consist of lowercase alphanumeric characters, dash, underscore, and period only. Additionally, it may contain an npm-style package scope. For details, see: https://sap.github.io/ui5-tooling/stable/pages/Configuration/#name


key: name

description: Unique identifier for the project, for example: organization.product.project


By default, the UI5 Tooling expects *.properties files to be UTF-8 encoded.


key: version

description: Framework version to use in this project


description: Unique identifier for the extension, for example: ui5-task-fearless-rock


key: plugins

description: Enables plugins for JSDoc

examples: plugins/markdown plugins/summarize


key: recurseDepth

description: Controls recursion depth for source files and tutorials


key: source

description: Determines the set of input files


key: include

description: An array of paths to input files


key: exclude

description: An array of paths to exclude from input


key: includePattern

description: Forces input filenames to match regular expression


key: excludePattern


key: sourceType

description: Determines how input files are parsed

enum: module script

default: module


key: opts

description: Determines flags that `jsdoc` command will be invoked with

default: all

enum: all private protected public undefined

default: templates/default


key: access

description: Only display symbols with the given `access` property


key: debug

description: Log information that can help debug issues in JSDoc itself


key: destination

description: The path to the output folder for the generated documentation


key: encoding

description: Assume this encoding when reading all source files


key: package

description: The `package.json` file that contains the project name, version, and other details


key: pedantic

description: Treat errors as fatal errors, and treat warnings as errors


key: readme

description: The README.md file to include in the generated documentation


key: recurse

description: Recurses to subdirectories when searching input files


key: template

description: The path to the template to use for generating output


key: test

description: Run JSDoc's test suite, and print the results to the console


key: tutorials

description: Directory in which JSDoc should search for tutorials


key: tags

description: Controls allowed JSDoc tags and their interpretation

type: boolean array

default: jsdoc closure

enum: jsdoc closure


key: allowUnknownTags

description: Determines how to handle unrecognized tags


key: dictionaries

description: Controls which tags JSDoc recognizes and how they are interpreted


key: templates

description: Affects the appearance and content of generated documentation


key: cleverLinks

description: Controls @link tag text rendering


key: includeDate

description: Controls if current date is displayed in the footer of documentation


key: layoutFile

description: Path to layout file to use for documentation template


key: outputSourceFiles

description: Disables pretty-printed source files


key: exclude

description: An array of paths that should not be copied to the output directory


key: excludePattern

description: A regular expression indicating which files to skip


key: include

description: An array of paths whose contents should be copied to the output directory


key: includePattern

description: A regular expression indicating which files to copy


key: useLongnameInNav

description: Controls if shortened or longhand version of a symbol will be shown in documentation


key: monospaceLinks

description: Controls @link tag text rendering


description: Root Schema of options for Cloudtoid GatewayCore

default: gwcore

type: string integer

enum: none lax strict

default: lax


key: system

description: This section that contains all system wide configurations.


key: routeCacheMaxCount

description: The maximum number of mappings between "inbound downstream request path" and "outbound upstream request URL" that can be cached in memory.


key: routes

description: This is the section in which proxy routes are defined.


key: additionalProperties

description: This is the url path pattern that if matched, the request is proxied to the address defined by its `to` property.


key: proxy

description: The proxy configuration.


key: to

description: This is an expression that defines the URL of the upstream server to which the downstream request is forwarded to.


key: proxyName

description: This is an expression that defines the name of this proxy. This value is used in the Via HTTP header send on the outbound upstream request, and the outbound downstream response. If a value is specified, an `x-gwcore-proxy-name` header with this value is also added to the outbound upstream request.


key: upstreamRequest

description: The options that control the upstream requests.


key: httpVersion

description: An expression that defines the HTTP protocol version of outbound upstream requests.


key: headers

description: The options that control the upstream request headers.


key: discardInboundHeaders

description: Specifies if downstream inbound request and content headers should be discarded and not forwarded to the upstream.


key: discardEmpty

description: Specifies if inbound headers with empty value should be discarded.


key: discardUnderscore

description: Specifies if inbound headers with an underscore in their name should be discarded.


key: addExternalAddress

description: Specifies if a `x-gwcore-external-address` header with the IP address of the immediate caller should be added to the outbound upstream request.


key: skipVia

description: Specifies if the `via` header should be skipped from the outbound request.


key: skipForwarded

description: Specifies if `forwarded` header and `x-forwarded-*` headers should be skipped from the outbound requests.


key: appends

description: The headers to be appended to the outbound upstream requests. If the header already exists, it is kept and the new value is appended. The value can be either text or an expression.


key: items

description: The value can be either text or an expression.


key: overrides

description: The headers to be added to the outbound upstream requests. If the header already exists, its value is replaced. The value can be either text or an expression.


description: Specifies the inbound downstream headers that should be discarded.


key: sender

description: The options that control connection to the upstream server.


key: httpClientName

description: The name of the .NET HttpClient that will be used to send the request. The default value is a system generated unique name.


key: timeoutInMilliseconds

description: The total timeout in milliseconds to wait for the outbound upstream request to complete. This can be a number or an expression.


key: connectTimeoutInMilliseconds

description: The connect timeout in milliseconds. No timeout is set by default.


description: The expect 100 continue timeout in milliseconds.


description: Specifies how long a connection can be idle in the pool to be considered reusable.


key: pooledConnectionLifetimeInMilliseconds

description: Specifies how long a connection can live in the connection pool. By default, no timeout is set and the connection can stay in the pool.


key: responseDrainTimeoutInMilliseconds

description: Specifies the response drain timeout.


key: maxAutomaticRedirections

description: The maximum number of allowed HTTP redirects.


key: maxConnectionsPerServer

description: The maximum number of simultaneous TCP connections allowed to a single server. No caps are set by default.


key: maxResponseDrainSizeInBytes

description: The maximum size of data that can be drained from responses in bytes.


key: maxResponseHeadersLengthInKilobytes

description: The maximum length, in kilobytes (1024 bytes), of the response headers.


key: allowAutoRedirect

description: Indicates whether the HTTP handler used by the outbound upstream request sender should follow redirection responses.


key: useCookies

description: Indicates whether the HTTP handler used by the outbound upstream request sender should store server cookies and use these cookies when sending requests.


key: downstreamResponse

description: The options that control the downstream responses sent to the clients.


key: headers

description: The options that control the downstream response headers sent to the clients.


key: discardInboundHeaders

description: Specifies if upstream inbound response, content, and trailing headers should be discarded and not forwarded to the downstream client.


key: discardEmpty

description: Specifies if inbound headers with empty value should be discarded.


key: discardUnderscore

description: Specifies if inbound headers with an underscore in their name should be discarded.


key: addServer

description: Specifies if a `server` header should be added. The value of this header is set to `gwcore`.


key: addVia

description: Specifies if the `via` header should be added to the outbound response.


key: cookies

description: The options that are applied to the `set-cookie` headers in the inbound upstream response. If the cookie name is symbol '*', then the settings are applied to all `set-cookie` headers.


key: secure

description: It limits the scope of the cookie to 'secure' channels. A secure cookie is only sent to the server when a request is made using HTTPS.


key: httpOnly

description: It limits the scope of the cookie to HTTP requests, forbidding JavaScript from accessing the cookie.


key: sameSite

description: It asserts that a cookie must not be sent with cross-origin requests, providing some protection against cross-site request forgery attacks. The valid values are `strict`, `lax`, and `none`.


key: domain

description: It specifies the hosts to which the cookie will be sent and can be an expression. For example, if the value of the Domain attribute is 'example.com', the user agent will include the cookie in the Cookie header when making HTTP requests to example.com, www.example.com, and www.corp.example.com. Use this property to specify or override the domain attribute. Set this value to an empty string ("") to remove the domain attribute from the cookie.


key: appends

description: The headers to be appended to the outbound downstream response. If the header already exists, it is kept and the new value is appended. The value can be either text or an expression.


key: items

description: The value can be either text or an expression.


key: overrides

description: The headers to be added to the outbound downstream response. If the header already exists, its value is replaced. The value can be either text or an expression.


key: discards

description: The inbound upstream headers that should be discarded.


description: The name of the header to be discarded.


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

enum: analysisTarget attachment responseFile resultFile standardStream tracedFile unmodified modified added deleted renamed uncontrolled driver extension translation taxonomy policy referencedOnCommandLine memoryContents directory userSpecifiedConfiguration toolSpecifiedConfiguration debugOutputFile

format: date-time

required: artifactLocation replacements

required: configuration descriptor

required: id sourceNodeId targetNodeId

enum: notApplicable pass fail review open informational


key: address

description: A physical or virtual address, or a range of addresses, in an 'addressable region' (memory or a binary file).


key: absoluteAddress

description: The address expressed as a byte offset from the start of the addressable region.


key: relativeAddress

description: The address expressed as a byte offset from the absolute address of the top-most parent object.


key: length

description: The number of bytes in this range of addresses.


key: kind

description: An open-ended string that identifies the address kind. 'data', 'function', 'header','instruction', 'module', 'page', 'section', 'segment', 'stack', 'stackFrame', 'table' are well-known values.


key: name

description: A name that is associated with the address, e.g., '.text'.


key: fullyQualifiedName

description: A human-readable fully qualified name that is associated with the address.


key: offsetFromParent

description: The byte offset of this address from the absolute or relative address of the parent object.


key: index

description: The index within run.addresses of the cached object for this address.


key: parentIndex

description: The index within run.addresses of the parent object.


key: properties

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


key: artifact

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


key: description

description: A short description of the artifact.


key: location

description: The location of the artifact.


description: Identifies the index of the immediate parent of the artifact, if this artifact is nested.


key: offset

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


description: The length of the artifact in bytes.


key: roles

description: The role or roles played by the artifact in the analysis.


key: mimeType

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


key: contents

description: The contents of the artifact.


key: encoding

description: Specifies the encoding for an artifact object that refers to a text file.


key: sourceLanguage

description: Specifies the source language for any artifact object that refers to a text file that contains source code.


key: hashes

description: A dictionary, each of whose keys is the name of a hash function and each of whose values is the hashed value of the artifact produced by the specified hash function.


key: lastModifiedTimeUtc

description: The Coordinated Universal Time (UTC) date and time at which the artifact was most recently modified. See "Date/time properties" in the SARIF spec for the required format.


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


key: artifactChange

description: A change to a single artifact.


key: artifactLocation

description: The location of the artifact to change.


key: replacements

description: An array of replacement objects, each of which represents the replacement of a single region in a single artifact specified by 'artifactLocation'.


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