key: parent

description: The immediate parent group in the hierarchy, if any. Not all groups must have a parent; the catalog supports multi-root hierarchies. Groups may however not have more than one parent. This field is an entity reference.


key: children

description: The immediate child groups of this group in the hierarchy (whose parent field points to this group). The list must be present, but may be empty if there are no child groups. The items are not guaranteed to be ordered in any particular way. The entries of this array are entity references.

type: array

type: string

examples: backstage other


key: members

description: The users that are members of this group. The entries of this array are entity references.


description: A location is a marker that references other places to look for catalog data.

kind: Location

type: url

type: object


key: type

description: The single location type, that's common to the targets specified in the spec. If it is left out, it is inherited from the location type that originally read the entity data.


key: target

description: A single target as a string. Can be either an absolute path/URL (depending on the type), or a relative path such as ./details/catalog-info.yaml which is resolved relative to the location of this Location entity itself.


key: targets

description: A list of targets as strings. They can all be either absolute paths/URLs (depending on the type), or relative paths such as ./details/catalog-info.yaml which are resolved relative to the location of this Location entity itself.


description: A resource describes the infrastructure a system needs to operate, like BigTable databases, Pub/Sub topics, S3 buckets or CDNs. Modelling them together with components and systems allows to visualize resource footprint, and create tooling around them.

kind: Resource

type: database

owner: artist-relations-team

[System] artist-engagement-portal

required: type owner

examples: database s3-bucket cluster


key: metadata

description: Stores artist details


description: The type of resource.


key: owner

description: An entity reference to the owner of the resource.


key: dependsOn

description: An array of references to other entities that the resource depends on to function.


key: system

description: An entity reference to the system that the resource belongs to.


description: A system is a collection of resources and components. The system may expose or consume one or several APIs. It is viewed as abstraction level that provides potential consumers insights into exposed features without needing a too detailed view into the details of all components. This also gives the owning team the possibility to decide about published artifacts and APIs.

kind: System

domain: artists


description: Handy tools to keep artists in the loop


description: An entity reference to the owner of the component.


key: domain

description: An entity reference to the domain that the system belongs to.


description: A Template describes a scaffolding task for use with the Scaffolder. It describes the required parameters as well as a series of steps that will be taken to execute the scaffolding task.

kind: Template

type: website

required: name description

Fetch

url: ./template

Publish to GitHub

repoUrl: {{ parameters.repoUrl }}

if: {{ parameters.repoUrl }}

required: type steps

examples: service website library

type: string boolean


description: Next.js application skeleton for creating isomorphic web applications.


key: name

description: Unique name of the component


key: description

description: Description of the component


description: The type of component created by the template. The software catalog accepts any type value, but an organization should take great care to establish a proper taxonomy for these. Tools including Backstage itself may read this field and behave differently depending on its value. For example, a website type component may present tooling in the Backstage interface that is specific to just websites.


key: parameters

description: The JSONSchema describing the inputs for the template.


description: A list of separate forms to collect parameters.


key: items


key: steps

description: A list of steps to execute.


description: A description of the step to execute.


key: id

description: The ID of the step, which can be used to refer to its outputs.


description: The name of the step, which will be displayed in the UI during the scaffolding process.


key: action

description: The name of the action to execute.


key: input

description: A templated object describing the inputs to the action.


key: if

description: A templated condition that skips the step when evaluated to false. If the condition is true or not defined, the step is executed. The condition is true, if the input is not `false`, `undefined`, `null`, `""`, `0`, or `[]`.


key: output

description: A templated object describing the outputs of the scaffolding task.


key: links

description: A list of external hyperlinks, typically pointing to resources created or updated by the template


key: url

description: A url in a standard uri format.


key: entityRef

description: An entity reference to an entity in the catalog.


key: title

description: A user friendly display name for the link.


key: icon

description: A key representing a visual icon to be displayed in the UI.


key: owner

description: The user (or group) owner of the template


description: A user describes a person, such as an employee, a contractor, or similar. Users belong to Group entities in the catalog. These catalog user entries are connected to the way that authentication within the Backstage ecosystem works. See the auth section of the docs for a discussion of these concepts.

kind: User

displayName: Jenny Doe

memberOf: team-b employees

examples: team-b employees


key: profile

description: Optional profile information about the user, mainly for display purposes. All fields of this structure are also optional. The email would be a primary email of some form, that the user may wish to be used for contacting them. The picture is expected to be a URL pointing to an image that's representative of the user, and that a browser could fetch and render on a profile page or similar.


key: displayName

description: A simple display name to present to users.


key: email

description: An email where this user can be reached.


key: picture

description: The URL of an image that represents this user.


key: memberOf

description: The list of groups that the user is a direct member of (i.e., no transitive memberships are listed here). The list must be present, but may be empty if the user is not member of any groups. The items are not guaranteed to be ordered in any particular way. The entries of this array are entity references.


key: entity

description: The parts of the format that's common to all versions/kinds of entity.

kind: Component

LoremService

product_name: Random value Generator

type: service

lifecycle: production

owner: tools

required: apiVersion kind metadata

examples: API Component Domain Group Location Resource System Template User

my-component-yay

etag: lsndfkjsndfkjnsdfkjnsd==

namespace: the-namespace

backstage.io/custom: ValueStuff

example.com/bindings: are-secret

type: integer

default: default

examples: default admin


key: metadata

description: Creates Lorems like a pro.


key: apiVersion

description: The version of specification format for this particular entity that this is written against.


key: kind

description: The high level entity type being described.


description: Metadata fields common to all versions/kinds of entity.


key: uid

description: A globally unique ID for the entity. This field can not be set by the user at creation time, and the server will reject an attempt to do so. The field will be populated in read operations. The field can (optionally) be specified when performing update or delete operations, but the server is free to reject requests that do so in such a way that it breaks semantics.


key: etag

description: An opaque string that changes for each update operation to any part of the entity, including metadata. This field can not be set by the user at creation time, and the server will reject an attempt to do so. The field will be populated in read operations. The field can (optionally) be specified when performing update or delete operations, and the server will then reject the operation if it does not match the current stored value.


key: generation

description: A positive nonzero number that indicates the current generation of data for this entity; the value is incremented each time the spec changes. This field can not be set by the user at creation time, and the server will reject an attempt to do so. The field will be populated in read operations.


key: name

description: The name of the entity. Must be unique within the catalog at any given point in time, for any given namespace + kind pair.


key: namespace

description: The namespace that the entity belongs to.


key: title

description: A display name of the entity, to be presented in user interfaces instead of the name property, when available.


key: description

description: A short (typically relatively few words, on one line) description of the entity.


key: labels

description: Key/value pairs of identifying information attached to the entity.


key: annotations

description: Key/value pairs of non-identifying auxiliary information attached to the entity.


key: tags

description: A list of single-valued strings, to for example classify catalog entities in various ways.


key: links

description: A list of external hyperlinks related to the entity. Links can provide additional contextual information that may be located outside of Backstage itself. For example, an admin dashboard or external CMS page.


key: url

description: A url in a standard uri format.


description: A user friendly display name for the link.


key: icon

description: A key representing a visual icon to be displayed in the UI.


key: spec

description: The specification data describing the entity itself.


key: relations

description: The relations that this entity has with other entities.


key: common

description: Common definitions to import from other schemas

required: kind namespace name

required: type target

required: type level message

enum: info warning error

required: name message

examples: Error InputError


key: reference

description: A reference by name to another entity.


key: kind

description: The kind field of the entity.


description: The metadata.namespace field of the entity.


description: The metadata.name field of the entity.


key: relation

description: A directed relation from one entity to another.


key: type

description: The type of relation.


key: status

description: The current status of the entity, as claimed by various sources.


key: statusItem

description: A specific status item on a well known format.


key: level

description: The status level / severity of the status item.


key: message

description: A brief message describing the status, intended for human consumption.


key: error

description: An optional serialized error object related to the status.


key: statusLevel

description: A status level / severity.


description: A serialized error object.


key: name

description: The type name of the error


description: The message of the error


key: code

description: An error code associated with the error


key: stack

description: An error stack trace


key: dependencies

description: A list of dependencies.

type: string object

enum: default build


key: frameworks

description: The frameworks on which your project will run.


key: runtimes

description: The Operating System and Architectures on which your application will be running.


key: supports

description: A list of supported target frameworks.


key: additionalProperties

description: A supported target framework.


description: Static Analysis Results Format (SARIF) Version 2.1.0-rtm.5 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

format: uri-reference

required: configuration descriptor

required: id sourceNodeId targetNodeId

format: uri

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.


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.


key: artifactContent

description: Represents the contents of an artifact.


key: text

description: UTF-8-encoded content from a text artifact.


key: binary

description: MIME Base64-encoded content from a binary artifact, or from a text artifact in its original encoding.


key: rendered

description: An alternate rendered representation of the artifact (e.g., a decompiled representation of a binary region).


key: properties

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


description: Specifies the location of an artifact.


key: uri

description: A string containing a valid relative or absolute URI.


key: uriBaseId

description: A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.


key: index

description: The index within the run artifacts array of the artifact object associated with the artifact location.


key: description

description: A short description of the artifact location.


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


key: attachment

description: An artifact relevant to a result.


description: A message describing the role played by the attachment.


description: The location of the attachment.


key: regions

description: An array of regions of interest within the attachment.


key: rectangles

description: An array of rectangles specifying areas of interest within the image.


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


key: codeFlow

description: A set of threadFlows which together describe a pattern of code execution relevant to detecting a result.


key: message

description: A message relevant to the code flow.


key: threadFlows

description: An array of one or more unique threadFlow objects, each of which describes the progress of a program through a thread of execution.


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


key: configurationOverride

description: Information about how a specific rule or notification was reconfigured at runtime.


key: configuration

description: Specifies how the rule or notification was configured during the scan.


key: descriptor

description: A reference used to locate the descriptor whose configuration was overridden.


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


key: conversion

description: Describes how a converter transformed the output of a static analysis tool from the analysis tool's native output format into the SARIF format.


key: tool

description: A tool object that describes the converter.


key: invocation

description: An invocation object that describes the invocation of the converter.


key: analysisToolLogFiles

description: The locations of the analysis tool's per-run log files.


key: properties

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


key: edge

description: Represents a directed edge in a graph.


key: id

description: A string that uniquely identifies the edge within its graph.


key: label

description: A short description of the edge.


key: sourceNodeId

description: Identifies the source node (the node at which the edge starts).


key: targetNodeId

description: Identifies the target node (the node at which the edge ends).


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


key: edgeTraversal

description: Represents the traversal of a single edge during a graph traversal.


key: edgeId

description: Identifies the edge being traversed.


key: message

description: A message to display to the user as the edge is traversed.


key: finalState

description: The values of relevant expressions after the edge has been traversed.


key: stepOverEdgeCount

description: The number of edge traversals necessary to return from a nested graph.


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


key: exception

description: Describes a runtime exception encountered during the execution of an analysis tool.


key: kind

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


description: A message that describes the exception.


key: stack

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


key: innerExceptions

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


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


key: externalProperties

description: The top-level element of an external property file.


key: schema

description: The URI of the JSON schema corresponding to the version of the external property file format.


key: version

description: The SARIF format version of this external properties object.


key: guid

description: A stable, unique identifier for this external properties object, in the form of a GUID.


key: runGuid

description: A stable, unique identifier for the run associated with this external properties object, in the form of a GUID.


key: conversion

description: A conversion object that will be merged with a separate run.


key: graphs

description: An array of graph objects that will be merged with a separate run.


key: externalizedProperties

description: Key/value pairs that provide additional information that will be merged with a separate run.


key: artifacts

description: An array of artifact objects that will be merged with a separate run.


key: invocations

description: Describes the invocation of the analysis tool that will be merged with a separate run.


key: logicalLocations

description: An array of logical locations such as namespaces, types or functions that will be merged with a separate run.


key: threadFlowLocations

description: An array of threadFlowLocation objects that will be merged with a separate run.


key: results

description: An array of result objects that will be merged with a separate run.


key: taxonomies

description: Tool taxonomies that will be merged with a separate run.


key: driver

description: The analysis tool object that will be merged with a separate run.


key: extensions

description: Tool extensions that will be merged with a separate run.


key: policies

description: Tool policies that will be merged with a separate run.


key: translations

description: Tool translations that will be merged with a separate run.


key: addresses

description: Addresses that will be merged with a separate run.


key: webRequests

description: Requests that will be merged with a separate run.


key: webResponses

description: Responses that will be merged with a separate run.


key: properties

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


key: externalPropertyFileReference

description: Contains information that enables a SARIF consumer to locate the external property file that contains the value of an externalized property associated with the run.


key: location

description: The location of the external property file.


key: guid

description: A stable, unique identifier for the external property file in the form of a GUID.


key: itemCount

description: A non-negative integer specifying the number of items contained in the external property file.


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


key: externalPropertyFileReferences

description: References to external property files that should be inlined with the content of a root log file.


key: conversion

description: An external property file containing a run.conversion object to be merged with the root log file.


key: graphs

description: An array of external property files containing a run.graphs object to be merged with the root log file.


key: externalizedProperties

description: An external property file containing a run.properties object to be merged with the root log file.


key: artifacts

description: An array of external property files containing run.artifacts arrays to be merged with the root log file.


key: invocations

description: An array of external property files containing run.invocations arrays to be merged with the root log file.


key: logicalLocations

description: An array of external property files containing run.logicalLocations arrays to be merged with the root log file.


key: threadFlowLocations

description: An array of external property files containing run.threadFlowLocations arrays to be merged with the root log file.


key: results

description: An array of external property files containing run.results arrays to be merged with the root log file.


key: taxonomies

description: An array of external property files containing run.taxonomies arrays to be merged with the root log file.


key: addresses

description: An array of external property files containing run.addresses arrays to be merged with the root log file.


key: driver

description: An external property file containing a run.driver object to be merged with the root log file.


key: extensions

description: An array of external property files containing run.extensions arrays to be merged with the root log file.


key: policies

description: An array of external property files containing run.policies arrays to be merged with the root log file.


key: translations

description: An array of external property files containing run.translations arrays to be merged with the root log file.


key: webRequests

description: An array of external property files containing run.requests arrays to be merged with the root log file.


key: webResponses

description: An array of external property files containing run.responses arrays to be merged with the root log file.


key: properties

description: Key/value pairs that provide additional information about the external property files.


key: fix

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


key: description

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


key: artifactChanges

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


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


key: graph

description: A network of nodes and directed edges that describes some aspect of the structure of the code (for example, a call graph).


description: A description of the graph.


key: nodes

description: An array of node objects representing the nodes of the graph.


key: edges

description: An array of edge objects representing the edges of the graph.


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


key: graphTraversal

description: Represents a path through a graph.


key: runGraphIndex

description: The index within the run.graphs to be associated with the result.


key: resultGraphIndex

description: The index within the result.graphs to be associated with the result.


description: A description of this graph traversal.


key: initialState

description: Values of relevant expressions at the start of the graph traversal that may change during graph traversal.


key: immutableState

description: Values of relevant expressions at the start of the graph traversal that remain constant for the graph traversal.


key: edgeTraversals

description: The sequences of edges traversed by this graph traversal.


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


key: invocation

description: The runtime environment of the analysis tool run.

type: boolean


key: commandLine

description: The command line used to invoke the tool.


key: arguments

description: An array of strings, containing in order the command line arguments passed to the tool from the operating system.


key: responseFiles

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


key: startTimeUtc

description: The Coordinated Universal Time (UTC) date and time at which the invocation started. See "Date/time properties" in the SARIF spec for the required format.


key: endTimeUtc

description: The Coordinated Universal Time (UTC) date and time at which the invocation ended. See "Date/time properties" in the SARIF spec for the required format.


key: exitCode

description: The process exit code.


key: ruleConfigurationOverrides

description: An array of configurationOverride objects that describe rules related runtime overrides.


key: notificationConfigurationOverrides

description: An array of configurationOverride objects that describe notifications related runtime overrides.


key: toolExecutionNotifications

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


key: toolConfigurationNotifications

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


key: exitCodeDescription

description: The reason for the process exit.


key: exitSignalName

description: The name of the signal that caused the process to exit.


key: exitSignalNumber

description: The numeric value of the signal that caused the process to exit.


key: processStartFailureMessage

description: The reason given by the operating system that the process failed to start.


key: executionSuccessful

description: Specifies whether the tool's execution completed successfully.


key: machine

description: The machine on which the invocation occurred.


key: account

description: The account under which the invocation occurred.


key: processId

description: The id of the process in which the invocation occurred.


key: executableLocation

description: An absolute URI specifying the location of the executable that was invoked.


key: workingDirectory

description: The working directory for the invocation.


key: environmentVariables

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


key: stdin

description: A file containing the standard input stream to the process that was invoked.


key: stdout

description: A file containing the standard output stream from the process that was invoked.


key: stderr

description: A file containing the standard error stream from the process that was invoked.


key: stdoutStderr

description: A file containing the interleaved standard output and standard error stream from the process that was invoked.


key: properties

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


key: location

description: A location within a programming artifact.


key: id

description: Value that distinguishes this location from all other locations within a single result object.


key: physicalLocation

description: Identifies the artifact and region.


key: logicalLocations

description: The logical locations associated with the result.


key: message

description: A message relevant to the location.


key: annotations

description: A set of regions relevant to the location.


key: relationships

description: An array of objects that describe relationships between this location and others.


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


key: locationRelationship

description: Information about the relation of one location to another.


key: target

description: A reference to the related location.


key: kinds

description: A set of distinct strings that categorize the relationship. Well-known kinds include 'includes', 'isIncludedBy' and 'relevant'.


key: description

description: A description of the location relationship.


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


key: logicalLocation

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


key: name

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


key: index

description: The index within the logical locations array.


key: fullyQualifiedName

description: The human-readable fully qualified name of the logical location.


key: decoratedName

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


key: parentIndex

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


key: kind

description: The type of construct this logical location component refers to. Should be one of 'function', 'member', 'module', 'namespace', 'parameter', 'resource', 'returnType', 'type', 'variable', 'object', 'array', 'property', 'value', 'element', 'text', 'attribute', 'comment', 'declaration', 'dtd' or 'processingInstruction', if any of those accurately describe the construct.


key: properties

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


description: Encapsulates a message intended to be read by the end user.


key: text

description: A plain text message string.


key: markdown

description: A Markdown message string.


key: id

description: The identifier for this message.


key: arguments

description: An array of strings to substitute into the message string.


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


key: multiformatMessageString

description: A message string or message format string rendered in multiple formats.


description: A plain text message string or format string.


description: A Markdown message string or format string.


key: node

description: Represents a node in a graph.


description: A string that uniquely identifies the node within its graph.


key: label

description: A short description of the node.


key: location

description: A code location associated with the node.


key: children

description: Array of child nodes.


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


key: notification

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

default: warning

enum: none note warning error


key: locations

description: The locations relevant to this notification.


key: message

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


key: level

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


key: threadId

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


key: timeUtc

description: The Coordinated Universal Time (UTC) date and time at which the analysis tool generated the notification.


key: exception

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


key: descriptor

description: A reference used to locate the descriptor relevant to this notification.


key: associatedRule

description: A reference used to locate the rule descriptor associated with this notification.


key: properties

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


key: physicalLocation

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


key: address

description: The address of the location.


key: artifactLocation

description: The location of the artifact.


key: region

description: Specifies a portion of the artifact.


key: contextRegion

description: Specifies a portion of the artifact that encloses the region. Allows a viewer to display additional context around the region.


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


key: propertyBag

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


key: tags

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


key: rectangle

description: An area within an image.

type: number


key: top

description: The Y coordinate of the top edge of the rectangle, measured in the image's natural units.


key: left

description: The X coordinate of the left edge of the rectangle, measured in the image's natural units.


key: bottom

description: The Y coordinate of the bottom edge of the rectangle, measured in the image's natural units.


key: right

description: The X coordinate of the right edge of the rectangle, measured in the image's natural units.


key: message

description: A message relevant to the rectangle.


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


description: A region within an artifact where a result was detected.


key: startLine

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


key: startColumn

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


key: endLine

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


key: endColumn

description: The column number of the character following the end of the region.


key: charOffset

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


key: charLength

description: The length of the region in characters.


key: byteOffset

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


key: byteLength

description: The length of the region in bytes.


key: snippet

description: The portion of the artifact contents within the specified region.


description: A message relevant to the region.


key: sourceLanguage

description: Specifies the source language, if any, of the portion of the artifact specified by the region object.


key: properties

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


key: replacement

description: The replacement of a single region of an artifact.


key: deletedRegion

description: The region of the artifact to delete.


key: insertedContent

description: The content to insert at the location specified by the 'deletedRegion' property.


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


key: reportingDescriptor

description: Metadata that describes a specific report produced by the tool, as part of the analysis it provides or its runtime reporting.


key: id

description: A stable, opaque identifier for the report.


key: deprecatedIds

description: An array of stable, opaque identifiers by which this report was known in some previous version of the analysis tool.


key: guid

description: A unique identifier for the reporting descriptor in the form of a GUID.


key: deprecatedGuids

description: An array of unique identifies in the form of a GUID by which this report was known in some previous version of the analysis tool.


key: name

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


key: deprecatedNames

description: An array of readable identifiers by which this report was known in some previous version of the analysis tool.


key: shortDescription

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


key: fullDescription

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


key: messageStrings

description: A set of name/value pairs with arbitrary names. Each value is a multiformatMessageString object, which holds message strings in plain text and (optionally) Markdown format. The strings can include placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments.


key: defaultConfiguration

description: Default reporting configuration information.


key: helpUri

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


key: help

description: Provides the primary documentation for the report, useful when there is no online documentation.


key: relationships

description: An array of objects that describe relationships between this reporting descriptor and others.


key: properties

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


key: reportingConfiguration

description: Information about a rule or notification that can be configured at runtime.


key: enabled

description: Specifies whether the report may be produced during the scan.


key: level

description: Specifies the failure level for the report.


key: rank

description: Specifies the relative priority of the report. Used for analysis output only.


key: parameters

description: Contains configuration information specific to a report.


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


key: reportingDescriptorReference

description: Information about how to locate a relevant reporting descriptor.


key: id

description: The id of the descriptor.


key: index

description: The index into an array of descriptors in toolComponent.ruleDescriptors, toolComponent.notificationDescriptors, or toolComponent.taxonomyDescriptors, depending on context.


key: guid

description: A guid that uniquely identifies the descriptor.


key: toolComponent

description: A reference used to locate the toolComponent associated with the descriptor.


description: Key/value pairs that provide additional information about the reporting descriptor reference.


key: reportingDescriptorRelationship

description: Information about the relation of one reporting descriptor to another.


key: target

description: A reference to the related reporting descriptor.


key: kinds

description: A set of distinct strings that categorize the relationship. Well-known kinds include 'canPrecede', 'canFollow', 'willPrecede', 'willFollow', 'superset', 'subset', 'equal', 'disjoint', 'relevant', and 'incomparable'.


key: description

description: A description of the reporting descriptor relationship.


key: result

description: A result produced by an analysis tool.

default: fail

enum: new unchanged updated absent


key: ruleId

description: The stable, unique identifier of the rule, if any, to which this result is relevant.


key: ruleIndex

description: The index within the tool component rules array of the rule object associated with this result.


key: rule

description: A reference used to locate the rule descriptor relevant to this result.


key: kind

description: A value that categorizes results by evaluation state.


key: level

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


key: message

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


key: analysisTarget

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


key: locations

description: The set of locations where the result was detected. Specify only one location unless the problem indicated by the result can only be corrected by making a change at every specified location.


description: A stable, unique identifier for the result in the form of a GUID.


key: correlationGuid

description: A stable, unique identifier for the equivalence class of logically identical results to which this result belongs, in the form of a GUID.


key: occurrenceCount

description: A positive integer specifying the number of times this logically unique result was observed in this run.


key: partialFingerprints

description: A set of strings that contribute to the stable, unique identity of the result.


key: fingerprints

description: A set of strings each of which individually defines a stable, unique identity for the result.


key: stacks

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


key: codeFlows

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


key: graphs

description: An array of zero or more unique graph objects associated with the result.


key: graphTraversals

description: An array of one or more unique 'graphTraversal' objects.


key: relatedLocations

description: A set of locations relevant to this result.


key: suppressions

description: A set of suppressions relevant to this result.


key: baselineState

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


key: rank

description: A number representing the priority or importance of the result.


key: attachments

description: A set of artifacts relevant to the result.


key: hostedViewerUri

description: An absolute URI at which the result can be viewed.


key: workItemUris

description: The URIs of the work items associated with this result.


key: provenance

description: Information about how and when the result was detected.


key: fixes

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


key: taxa

description: An array of references to taxonomy reporting descriptors that are applicable to the result.


key: webRequest

description: A web request associated with this result.


key: webResponse

description: A web response associated with this result.


key: properties

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


key: resultProvenance

description: Contains information about how and when a result was detected.


key: firstDetectionTimeUtc

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


key: lastDetectionTimeUtc

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


key: firstDetectionRunGuid

description: A GUID-valued string equal to the automationDetails.guid property of the run in which the result was first detected.


key: lastDetectionRunGuid

description: A GUID-valued string equal to the automationDetails.guid property of the run in which the result was most recently detected.


key: invocationIndex

description: The index within the run.invocations array of the invocation object which describes the tool invocation that detected the result.


key: conversionSources

description: An array of physicalLocation objects which specify the portions of an analysis tool's output that a converter transformed into the result.


key: run

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

default: en-US


key: tool

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


key: invocations

description: Describes the invocation of the analysis tool.


key: conversion

description: A conversion object that describes how a converter transformed an analysis tool's native reporting format into the SARIF format.


key: language

description: The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase culture code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).


key: versionControlProvenance

description: Specifies the revision in version control of the artifacts that were scanned.


key: originalUriBaseIds

description: The artifact location specified by each uriBaseId symbol on the machine where the tool originally ran.


key: artifacts

description: An array of artifact objects relevant to the run.


key: logicalLocations

description: An array of logical locations such as namespaces, types or functions.


key: graphs

description: An array of zero or more unique graph objects associated with the run.


key: results

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


key: automationDetails

description: Automation details that describe this run.


key: runAggregates

description: Automation details that describe the aggregate of runs to which this run belongs.


key: baselineGuid

description: The 'guid' property of a previous SARIF 'run' that comprises the baseline that was used to compute result 'baselineState' properties for the run.


key: redactionTokens

description: An array of strings used to replace sensitive information in a redaction-aware property.


key: defaultEncoding

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


key: defaultSourceLanguage

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


key: newlineSequences

description: An ordered list of character sequences that were treated as line breaks when computing region information for the run.


key: columnKind

description: Specifies the unit in which the tool measures columns.


key: externalPropertyFileReferences

description: References to external property files that should be inlined with the content of a root log file.


key: threadFlowLocations

description: An array of threadFlowLocation objects cached at run level.


key: taxonomies

description: An array of toolComponent objects relevant to a taxonomy in which results are categorized.


key: addresses

description: Addresses associated with this run instance, if any.


key: translations

description: The set of available translations of the localized data provided by the tool.


key: policies

description: Contains configurations that may potentially override both reportingDescriptor.defaultConfiguration (the tool's default severities) and invocation.configurationOverrides (severities established at run-time from the command line).


key: webRequests

description: An array of request objects cached at run level.


key: webResponses

description: An array of response objects cached at run level.


key: specialLocations

description: A specialLocations object that defines locations of special significance to SARIF consumers.


key: properties

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


key: runAutomationDetails

description: Information that describes a run's identity and role within an engineering system process.


key: description

description: A description of the identity and role played within the engineering system by this object's containing run object.


key: id

description: A hierarchical string that uniquely identifies this object's containing run object.


key: guid

description: A stable, unique identifier for this object's containing run object in the form of a GUID.


key: correlationGuid

description: A stable, unique identifier for the equivalence class of runs to which this object's containing run object belongs in the form of a GUID.


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


description: Defines locations of special significance to SARIF consumers.


key: displayBase

description: Provides a suggestion to SARIF consumers to display file paths relative to the specified location.


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


key: stack

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


key: message

description: A message relevant to this call stack.


key: frames

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


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


key: stackFrame

description: A function call within a stack trace.


key: location

description: The location to which this stack frame refers.


key: module

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


key: threadId

description: The thread identifier of the stack frame.


key: parameters

description: The parameters of the call that is executing.


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


key: suppression

description: A suppression that is relevant to a result.

enum: inSource external

enum: accepted underReview rejected


description: A stable, unique identifier for the suppression in the form of a GUID.


key: kind

description: A string that indicates where the suppression is persisted.


key: status

description: A string that indicates the review status of the suppression.


key: justification

description: A string representing the justification for the suppression.


description: Identifies the location associated with the suppression.


key: properties

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


key: threadFlow

description: Describes a sequence of code locations that specify a path through a single thread of execution such as an operating system or fiber.


key: id

description: An string that uniquely identifies the threadFlow within the codeFlow in which it occurs.


description: A message relevant to the thread flow.


key: initialState

description: Values of relevant expressions at the start of the thread flow that may change during thread flow execution.


key: immutableState

description: Values of relevant expressions at the start of the thread flow that remain constant.


key: locations

description: A temporally ordered array of 'threadFlowLocation' objects, each of which describes a location visited by the tool while producing the result.


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


key: threadFlowLocation

description: A location visited by an analysis tool while simulating or monitoring the execution of a program.

enum: important essential unimportant

default: important


key: index

description: The index within the run threadFlowLocations array.


description: The code location.


key: stack

description: The call stack leading to this location.


key: kinds

description: A set of distinct strings that categorize the thread flow location. Well-known kinds include 'acquire', 'release', 'enter', 'exit', 'call', 'return', 'branch', 'implicit', 'false', 'true', 'caution', 'danger', 'unknown', 'unreachable', 'taint', 'function', 'handler', 'lock', 'memory', 'resource', 'scope' and 'value'.


key: taxa

description: An array of references to rule or taxonomy reporting descriptors that are applicable to the thread flow location.


key: module

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


key: state

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


key: nestingLevel

description: An integer representing a containment hierarchy within the thread flow.


key: executionOrder

description: An integer representing the temporal order in which execution reached this location.


key: executionTimeUtc

description: The Coordinated Universal Time (UTC) date and time at which this location was executed.


key: importance

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


key: webRequest

description: A web request associated with this thread flow location.


key: webResponse

description: A web response associated with this thread flow location.


key: properties

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


key: tool

description: The analysis tool that was run.


key: driver

description: The analysis tool that was run.


key: extensions

description: Tool extensions that contributed to or reconfigured the analysis tool that was run.


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


key: toolComponent

description: A component, such as a plug-in or the driver, of the analysis tool that was run.

default: localizedData nonLocalizedData

enum: localizedData nonLocalizedData


key: guid

description: A unique identifier for the tool component in the form of a GUID.


key: name

description: The name of the tool component.


key: organization

description: The organization or company that produced the tool component.


key: product

description: A product suite to which the tool component belongs.


key: productSuite

description: A localizable string containing the name of the suite of products to which the tool component belongs.


key: shortDescription

description: A brief description of the tool component.


key: fullDescription

description: A comprehensive description of the tool component.


key: fullName

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


key: version

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


key: semanticVersion

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


key: dottedQuadFileVersion

description: The binary version of the tool component's primary executable file expressed as four non-negative integers separated by a period (for operating systems that express file versions in this way).


key: releaseDateUtc

description: A string specifying the UTC date (and optionally, the time) of the component's release.


key: downloadUri

description: The absolute URI from which the tool component can be downloaded.


key: informationUri

description: The absolute URI at which information about this version of the tool component can be found.


key: globalMessageStrings

description: A dictionary, each of whose keys is a resource identifier and each of whose values is a multiformatMessageString object, which holds message strings in plain text and (optionally) Markdown format. The strings can include placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments.


key: notifications

description: An array of reportingDescriptor objects relevant to the notifications related to the configuration and runtime execution of the tool component.


key: rules

description: An array of reportingDescriptor objects relevant to the analysis performed by the tool component.


key: taxa

description: An array of reportingDescriptor objects relevant to the definitions of both standalone and tool-defined taxonomies.


key: locations

description: An array of the artifactLocation objects associated with the tool component.


key: language

description: The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase language code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).


key: contents

description: The kinds of data contained in this object.


key: isComprehensive

description: Specifies whether this object contains a complete definition of the localizable and/or non-localizable data for this component, as opposed to including only data that is relevant to the results persisted to this log file.


key: localizedDataSemanticVersion

description: The semantic version of the localized strings defined in this component; maintained by components that provide translations.


description: The minimum value of localizedDataSemanticVersion required in translations consumed by this component; used by components that consume translations.


key: associatedComponent

description: The component which is strongly associated with this component. For a translation, this refers to the component which has been translated. For an extension, this is the driver that provides the extension's plugin model.


key: translationMetadata

description: Translation metadata, required for a translation, not populated by other component types.


key: supportedTaxonomies

description: An array of toolComponentReference objects to declare the taxonomies supported by the tool component.


key: properties

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


key: toolComponentReference

description: Identifies a particular toolComponent object, either the driver or an extension.


key: name

description: The 'name' property of the referenced toolComponent.


key: index

description: An index into the referenced toolComponent in tool.extensions.


key: guid

description: The 'guid' property of the referenced toolComponent.


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


description: Provides additional metadata related to translation.


description: The name associated with the translation metadata.


key: fullName

description: The full name associated with the translation metadata.


key: shortDescription

description: A brief description of the translation metadata.


key: fullDescription

description: A comprehensive description of the translation metadata.


key: downloadUri

description: The absolute URI from which the translation metadata can be downloaded.


key: informationUri

description: The absolute URI from which information related to the translation metadata can be downloaded.


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


key: versionControlDetails

description: Specifies the information necessary to retrieve a desired revision from a version control system.


key: repositoryUri

description: The absolute URI of the repository.


key: revisionId

description: A string that uniquely and permanently identifies the revision within the repository.


key: branch

description: The name of a branch containing the revision.


key: revisionTag

description: A tag that has been applied to the revision.


key: asOfTimeUtc

description: A Coordinated Universal Time (UTC) date and time that can be used to synchronize an enlistment to the state of the repository at that time.


key: mappedTo

description: The location in the local file system to which the root of the repository was mapped at the time of the analysis.


key: properties

description: Key/value pairs that provide additional information about the version control details.


key: webRequest

description: Describes an HTTP request.


description: The index within the run.webRequests array of the request object associated with this result.


key: protocol

description: The request protocol. Example: 'http'.


key: version

description: The request version. Example: '1.1'.


key: target

description: The target of the request.


key: method

description: The HTTP method. Well-known values are 'GET', 'PUT', 'POST', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS', 'TRACE', 'CONNECT'.


key: headers

description: The request headers.


key: parameters

description: The request parameters.


key: body

description: The body of the request.


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


key: webResponse

description: Describes the response to an HTTP request.


key: index

description: The index within the run.webResponses array of the response object associated with this result.


description: The response protocol. Example: 'http'.


description: The response version. Example: '1.1'.


key: statusCode

description: The response status code. Example: 451.


key: reasonPhrase

description: The response reason. Example: 'Not found'.


description: The response headers.


description: The body of the response.


key: noResponseReceived

description: Specifies whether a response was received from the server.


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


key: $schema

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


description: The SARIF format version of this log file.


key: runs

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


key: inlineExternalProperties

description: References to external property files that share data between runs.


key: properties

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


description: Configuration for Actions Label Commenter, for posting messages triggered by labels.

enum: lock unlock


key: info

description: General information about the API.

required: version title


key: title

description: A unique and precise title of the API.


key: version

description: A semantic version number of the API.


key: description

description: A longer description of the API. Should be different from the title.  GitHub Flavored Markdown is allowed.


key: termsOfService

description: The terms of service for the API.


key: contact

description: Contact information for the owners of the API.

format: email


key: name

description: The identifying name of the contact person/organization.


key: url

description: The URL pointing to the contact information.


key: email

description: The email address of the contact person/organization.


description: The name of the license type. It's encouraged to use an OSI compatible license.


description: The URL pointing to the license.


key: paths

description: Relative paths to the individual endpoints. They must be relative to the 'basePath'.


key: definitions

description: One or more JSON objects describing the schemas being consumed and produced by the API.


key: parameterDefinitions

description: One or more JSON representations for parameters


key: responseDefinitions

description: One or more JSON representations for responses


key: externalDocs

description: information about external documentation


key: mimeType

description: The MIME type of the HTTP message.


key: summary

description: A brief summary of the operation.


description: A longer description of the operation, GitHub Flavored Markdown is allowed.


key: operationId

description: A unique identifier of the operation.


key: produces

description: A list of MIME types the API can produce.


key: consumes

description: A list of MIME types the API can consume.


key: responses

description: Response objects names can either be any valid HTTP status code or 'default'.


key: vendorExtension

description: Any property starting with x- is valid.


key: description

description: A brief description of the parameter. This could contain examples of use.  GitHub Flavored Markdown is allowed.


description: The name of the parameter.


key: in

description: Determines the location of the parameter.


key: required

description: Determines whether or not this parameter is required or optional.


key: allowEmptyValue

description: allows sending a parameter by name only or with an empty value.


key: schema

description: A deterministic version of a JSON Schema object.


key: fileSchema


key: parametersList

description: The parameters needed to send a valid API call.


key: schemesList

description: The transfer protocol of the API.

enum: http https ws wss


key: swagger

description: The Swagger version of this document.


key: host

description: The host (name or ip) of the API. Example: 'swagger.io'


key: basePath

description: The base path to the API. Example: '/api'.


description: A list of MIME types accepted by the API.


key: type

description:
A form item type
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#keys

enum: checkboxes dropdown input markdown textarea


description: Specify whether require a form item


description:
A form item
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#about-githubs-form-schema

const: markdown

required: type attributes

const: textarea

enum:
1C Enterprise
4D
ABAP CDS
ABAP
ABNF
AFDKO
AGS Script
AIDL
AL
AMPL
ANTLR
API Blueprint
APL
ASL
ASN.1
ASP.NET
ATS
ActionScript
Ada
Alloy
Alpine Abuild
Altium Designer
AngelScript
Ant Build System
ApacheConf
Apex
Apollo Guidance Computer
AppleScript
Arc
AsciiDoc
AspectJ
Assembly
Astro
Asymptote
Augeas
AutoHotkey
AutoIt
AutoIt3
AutoItScript
Avro IDL
Awk
BASIC
Ballerina
Batchfile
Beef
Befunge
BibTeX
Bicep
Bison
BitBake
Blade
BlitzBasic
BlitzMax
Boo
Boogie
Brainfuck
Brightscript
Browserslist
C
C#
C++
C-ObjDump
C2hs Haskell
CIL
CLIPS
CMake
COBOL
CODEOWNERS
COLLADA
CSON
CSS
CSV
CUE
CWeb
Cabal Config
Cabal
Cap'n Proto
Carto
CartoCSS
Ceylon
Chapel
Charity
ChucK
Cirru
Clarion
Classic ASP
Clean
Click
Clojure
Closure Templates
Cloud Firestore Security Rules
CoNLL
CoNLL-U
CoNLL-X
ColdFusion CFC
ColdFusion
Common Lisp
Common Workflow Language
Component Pascal
Containerfile
Cool
Coq
Cpp-ObjDump
Crystal
Csound Document
Csound Score
Csound
Cuda
Cue Sheet
Cycript
Cython
D-ObjDump
DIGITAL Command Language
DM
DTrace
Dafny
Darcs Patch
Dart
DataWeave
Dhall
Diff
Dlang
Dockerfile
Dogescript
Dylan
E
E-mail
EBNF
ECL
ECLiPSe
EJS
EQ
Eagle
Earthly
Easybuild
Ecere Projects
EditorConfig
Eiffel
Elixir
Elm
Emacs Lisp
EmberScript
Erlang
F#
F*
FIGfont
FIGlet Font
FLUX
Factor
Fancy
Fantom
Faust
Fennel
Filebench WML
Filterscript
Fluent
Formatted
Forth
Fortran Free Form
Fortran
FreeBasic
Frege
Futhark
G-code
GAML
GAMS
GAP
GCC Machine Description
GDB
GDScript
GEDCOM
GLSL
GN
Game Maker Language
Gemfile.lock
Genie
Genshi
Gentoo Eclass
Gerber Image
Gettext Catalog
Gherkin
Git Config
Glyph Bitmap Distribution Format
Glyph
Gnuplot
Go Checksums
Go Module
Go
Golo
Gosu
Grace
Gradle
Grammatical Framework
Graph Modeling Language
GraphQL
Graphviz (DOT)
Groovy Server Pages
Groovy
HAProxy
HCL
HTML
HTML+ECR
HTML+EEX
HTML+ERB
HTML+PHP
HTML+Razor
HTTP
HXML
Hack
Haml
Handlebars
Harbour
HashiCorp Configuration Language
Haskell
Haxe
HiveQL
HolyC
Hy
IDL
IGOR Pro
IPython Notebook
Idris
Ignore List
ImageJ Macro
Inform 7
Io
Ioke
Isabelle ROOT
Isabelle
J
JAR Manifest
JFlex
JSON with Comments
JSON
JSON5
JSONLD
JSONiq
Jasmin
Java Properties
Java Server Pages
Java
JavaScript
JavaScript+ERB
Jest Snapshot
Jinja
Jison Lex
Jison
Jolie
Jsonnet
Julia
Jupyter Notebook
Kaitai Struct
KakouneScript
KiCad Layout
KiCad Legacy Layout
KiCad Schematic
Kit
Kotlin
Kusto
LFE
LLVM
LOLCODE
LSL
LTspice Symbol
LabVIEW
Lark
Lasso
Lean
Less
Lex
LilyPond
Limbo
Linker Script
Linux Kernel Module
Liquid
Literate Agda
Literate CoffeeScript
Literate Haskell
LiveScript
Logos
Logtalk
LookML
LoomScript
Lua
M
M4
M4Sugar
MATLAB
MAXScript
MLIR
MQL4
MQL5
MTML
MUF
Macaulay2
Makefile
Mako
Markdown
Marko
Mathematica
Max
Mercury
Meson
Metal
Microsoft Developer Studio Project
Microsoft Visual Studio Solution
MiniD
Mirah
Modelica
Modula-2
Modula-3
Module Management System
Monkey
Moocode
MoonScript
Motoko
Motorola 68K Assembly
Muse
Myghty
NASL
NCL
NEON
NPM Config
NSIS
NWScript
Nearley
Nemerle
NeoSnippet
NetLinx
NetLinx+ERB
NetLogo
NewLisp
Nextflow
Nginx
Ninja
Nit
Nix
NumPy
Nunjucks
ObjDump
Object Data Instance Notation
ObjectScript
Objective-C
Objective-C++
Objective-J
Odin
Omgrofl
Opa
Opal
Open Policy Agent
OpenCL
OpenEdge ABL
OpenQASM
OpenRC runscript
OpenSCAD
OpenStep Property List
OpenType Feature File
Org
Ox
Oxygene
Oz
P4
PEG.js
PHP
PLpgSQL
POV-Ray SDL
Pan
Papyrus
Parrot Assembly
Parrot Internal Representation
Parrot
Pascal
Pawn
Pep8
Perl
Pickle
PicoLisp
PigLatin
Pike
PlantUML
Pod 6
Pod
PogoScript
Pony
PostCSS
PostScript
PowerShell
Prisma
Processing
Proguard
Prolog
Promela
Propeller Spin
Protocol Buffer
Protocol Buffers
Public Key
Pug
Puppet
Pure Data
PureBasic
PureScript
Python
Q#
QMake
Qt Script
Quake
R
RAML
RDoc
REALbasic
REXX
RMarkdown
RPC
RPM Spec
Racket
Ragel
Raw token data
ReScript
Readline Config
Reason
Rebol
Record Jar
Red
Redirect Rules
Regular Expression
RenderScript
Rich Text Format
Ring
Riot
RobotFramework
Roff
Rouge
Rscript
Ruby
Rust
SAS
SCSS
SELinux Kernel Policy Language
SELinux Policy
SMT
SPARQL
SQF
SQL
SQLPL
SRecode Template
SSH Config
STON
SVG
SWIG
Sage
SaltStack
Sass
Scala
Scaml
Scheme
Scilab
Self
ShaderLab
Shell
ShellCheck Config
Sieve
Singularity
Slash
Slice
Slim
SmPL
Smalltalk
SnipMate
Solidity
Soong
SourcePawn
Spline Font Database
Squirrel
Stan
Standard ML
Starlark
StringTemplate
Stylus
SubRip Text
SugarSS
SuperCollider
Svelte
Swift
SystemVerilog
TI Program
TLA
TOML
TSQL
TSV
TSX
TXL
Tcl
Tcsh
TeX
Tea
Terra
Texinfo
Text
TextMate Properties
Textile
Thrift
Turing
Turtle
Twig
Type Language
TypeScript
UltiSnip
UltiSnips
Unified Parallel C
Unity3D Asset
Unix Assembly
Uno
UnrealScript
Ur
Ur/Web
UrWeb
V
VBA
VCL
VHDL
Vala
Valve Data Format
Verilog
Vim Help File
Vim Script
Vim Snippet
Visual Basic .NET
Vue
Wavefront Material
Wavefront Object
Web Ontology Language
WebAssembly
WebVTT
Wget Config
Wikitext
Windows Registry Entries
Wollok
World of Warcraft Addon Data
X BitMap
X Font Directory Index
X PixMap
X10
XC
XCompose
XML Property List
XML
XPages
XProc
XQuery
XS
XSLT
Xojo
Xonsh
Xtend
YAML
YANG
YARA
YASnippet
Yacc
ZAP
ZIL
Zeek
ZenScript
Zephir
Zig
Zimpl
abl
abuild
acfm
aconf
actionscript 3
actionscript3
ada2005
ada95
adobe composite font metrics
adobe multiple font metrics
advpl
ags
ahk
altium
amfm
amusewiki
apache
apkbuild
arexx
as3
asm
asp
aspx
aspx-vb
ats2
au3
autoconf
b3d
bash session
bash
bat
batch
bazel
blitz3d
blitzplus
bmax
bplus
bro
bsdmake
byond
bzl
c++-objdump
c2hs
cURL Config
cake
cakescript
cfc
cfm
cfml
chpl
clipper
coccinelle
coffee
coffee-script
coldfusion html
console
cperl
cpp
csharp
csound-csd
csound-orc
csound-sco
cucumber
curlrc
cwl
dcl
delphi
desktop
dircolors
django
dosbatch
dosini
dpatch
dtrace-script
eC
ecr
editor-config
edn
eeschema schematic
eex
elisp
emacs muse
emacs
email
eml
erb
fb
fish
flex
foxpro
fsharp
fstar
ftl
fundamental
gf
git-ignore
gitattributes
gitconfig
gitignore
gitmodules
go mod
go sum
go.mod
go.sum
golang
groff
gsp
hbs
heex
help
html+django
html+jinja
html+ruby
htmlbars
htmldjango
hylang
i7
ignore
igor
igorpro
ijm
inc
inform7
inputrc
irc logs
irc
java server page
jq
jruby
js
jsonc
jsp
kak
kakscript
keyvalues
ksy
lassoscript
latex
leex
lhaskell
lhs
lisp
litcoffee
live-script
ls
m2
m68k
mIRC Script
macruby
mail
make
man page
man
man-page
manpage
markojs
max/msp
maxmsp
mbox
mcfunction
mdoc
mediawiki
mf
mma
mumps
mupad
nanorc
nasm
ne-on
nesC
nette object notation
nginx configuration file
nixos
njk
node
npmrc
nroff
nush
nvim
obj-c
obj-c++
obj-j
objc
objc++
objectivec
objectivec++
objectivej
objectpascal
objj
octave
odin-lang
odinlang
oncrpc
ooc
openedge
openrc
osascript
pandoc
pasm
pcbnew
perl-6
perl6
pir
plain text
posh
postscr
pot
pov-ray
povray
progress
protobuf
pwsh
pycon
pyrex
python3
q
ql
qsharp
ragel-rb
ragel-ruby
rake
raw
razor
rb
rbx
reStructuredText
readline
red/system
redirects
regex
regexp
renpy
rhtml
robots txt
robots
robots.txt
rpcgen
rs
rs-274x
rss
rst
rusthon
salt
saltstate
sed
sepolicy
sh
shell-script
shellcheckrc
sml
snippet
sourcemod
soy
specfile
splus
squeak
terraform
tl
tm-properties
troff
ts
udiff
vb .net
vb.net
vb6
vbnet
vdf
vim
vimhelp
viml
visual basic 6
visual basic for applications
visual basic
vlang
wasm
wast
wdl
wgetrc
wiki
winbatch
wisp
wl
wolfram lang
wolfram language
wolfram
wsdl
xBase
xbm
xdr
xhtml
xml+genshi
xml+kid
xpm
xsd
xsl
xten
yas
yml
zsh

const: input

const: dropdown

required: label options

const: checkboxes


key: then

description:
Markdown
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#markdown


key: attributes

description:
Markdown attributes
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes


key: value

description:
A markdown code
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes


description:
Textarea
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#textarea


key: id

description:
A textarea id
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#keys


description:
Textarea attributes
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-1


key: label

description:
A short textarea description
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-1


key: description

description:
A long textarea description
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-1


key: placeholder

description:
A textarea placeholder
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-1


description:
A textarea value
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-1


key: render

description:
A textarea syntax highlighting mode
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-1


key: validations

description:
Textarea validations
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#validations


description:
Input
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#input


description:
An input id
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#keys


description:
Input attributes
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-2


description:
A short input description
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-2


description:
A long input description
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-2


description:
An input placeholder
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-2


description:
An input value
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-2


description:
Input validations
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#validations-1


description:
dropdown
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#dropdown


description:
A dropdown id
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#keys


description:
Dropdown attributes
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-3


description:
A short dropdown description
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-3


description:
A long dropdown description
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-3


key: multiple

description:
Specify whether allow a multiple choices
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-3


key: options

description:
Dropdown choices
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-3


description:
Dropdown validations
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#validations-2


description:
Checkboxes
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#checkboxes


description:
Checkbox list id
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#keys


description:
Checkbox list attributes
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-4


description:
A short checkbox list description
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-4


description:
A long checkbox list description
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-4


description:
Checkbox list choices
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-4


key: items

description:
Checkbox list choice
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-4


description:
A short checkbox list choice description
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-4


key: required

description:
Specify whether a choise is required
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-4


key: name

description:
An issue template name
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms#top-level-syntax


description:
An issue template description
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms#top-level-syntax


key: body

description:
An issue template body
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms#top-level-syntax


key: assignees

description:
An issue template assignees
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms#top-level-syntax


key: labels

description:
An issue template labels
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms#top-level-syntax

examples:
Sample label
bug
documentation
duplicate
enhancement
good first issue
help wanted
invalid
question
wontfix


key: title

description:
An issue template title
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms#top-level-syntax

examples:
Sample title
Bug:
Feature:


description: The schema for `docker-seq`

enum: always missing never


key: image

description: The docker image name


key: workdir

description: Working directory inside the container


key: user

description: Username or UID (format: <name|uid>[:<group|gid>])


description: Disables the `user` option and runs the container with the hosts uid and gid.


key: tty

description: Allocate a pseudo-TTY


key: interactive

description: Keep STDIN open even if not attached


key: pull

description: Pull image before running ("always"|"missing"|"never") (default "missing")


key: rm

description: Automatically remove the container when it exits


key: init

description: Run an init inside the container that forwards signals and reaps processes


key: volumes

description: Bind mount volumes


key: publish

description: Publish a container's port(s) to the host


key: env

description: Set environment variables


description: Read in files of environment variables


key: cpus

description: Number of CPUs


key: memory

description: Memory limit in bytes


key: entrypoint

description: Overwrite the default ENTRYPOINT of the image


key: name

description: Assign a name to the container


key: privileged

description: Give extended privileges to this container


key: mount

description: Attach a filesystem mount to the container


description: Mount the container's root filesystem as read only


key: platform

description: Set platform if server is multi-platform capable


key: runtime

description: Runtime to use for this container


description: Security Options


key: ulimit

description: Ulimit options


description: Mount volumes from the specified container(s)


description: Task with which to keep the container alive while executing commands


description: Shell in which to execute each sequence step command


key: Step

description: One step in the command sequence


key: workdir

description: Working directory inside the container


key: user


description: Disables the `user` option and executes these commands with the hosts uid and gid.


key: tty

description: Allocate a pseudo-TTY


description: Give extended privileges to the commands


key: interactive

description: Keep STDIN open even if not attached


key: commands

description: A list of commands to execute within the container


description: The configuration file of the SAP Cloud SDK Continuous Delivery Toolkit. For more information please visit https://github.com/SAP/cloud-s4-sdk-pipeline

default: lite

required: host account application runtime runtimeVersion

default: master

enum: on off

default: off

required: alias credentialId

type: integer string

required: successCoverage unstableCoverage

enum: checkDeploymentDescriptors checkResilience checkServices checkFrontendCodeCoverage checkBackendCodeCoverage


key: dockerImage

description: The image used in the step or stage.


key: org

description: Cloud Foundry organization.


key: space

description: Cloud Foundry space.


key: appName

description: Name of the application.


key: manifest

description: Manifest file that needs to be used.


key: credentialsId

description: ID to the credentials that will be used.


key: apiEndpoint

description: URL to the Cloud Foundry endpoint.


key: mtaExtensionDescriptor

description: (Only for MTA-projects) Path to the mta extension description file. For more information on how to use those extension files please visit the SAP HANA Developer Guide.


key: mtaExtensionCredentials

description: (Only for MTA-projects) Map of credentials that need to be replaced in the mtaExtensionDescriptor. This map needs to be created as value-to-be-replaced:id-of-a-credential-in-jenkins


key: host

description: Host of the region you want to deploy to, see Regions.


key: account

description: Identifier of the subaccount.


key: application

description: Name of the application in your account.


key: environment

description: Map of environment variables in the form of KEY: VALUE.


key: vmArguments

description: String of VM arguments passed to the JVM.


key: size

description: Size of the JVM, e.g. lite, pro, prem, prem-plus.


key: runtime

description: Name of the runtime: neo-java-web, neо-javaee6-wp, neо-javaee7-wp. See the runtime for more information.


key: runtimeVersion

description: Version of the runtime. See runtime-version for more information.


key: url

description: The URLs under which the app is available after deployment. Each appUrl can be a string with the URL or a map containing a property url and a property credentialId.


key: credentialId

description: ID to the credentials that will be used to connect to the SAP Cloudplatform account.


key: parameters

description: Additional parameters can be passed for each end-to-end test deployment by specifying optional parameters for an application URL. These parameters are appended to the npm command during execution. These parameters must be a list of strings, where each string corresponds to one element of the parameters. For example, if the parameter `--tag scenario1` should be passed to the test, specify parameters: ['--tag', 'scenario1'].


key: cloudFoundry

description: A map specifying the Cloud Foundry specific parameters.


key: sendNotification

description: The sendNotification post-build action can be used to send notifications to project members in case of an unsuccessful build outcome or if the build goes back to normal. By default, an email is sent to the list of users who committed a change since the last non-broken build. Additionally, a set of recipients can be defined that should always receive notifications.


key: enabled

description: If set to true, notifications will be sent.


key: skipFeatureBranches

description: If set to true, notifications will only be sent for the productive branch as defined in the general configuration section.


key: recipients

description: List of email addresses that should be notified in addition to the standard recipients.


key: customDefaults

description: List of paths or URLs to YAML files with custom defaults to consider. These defaults override built-in defaults, and can be shared across multiple projects. Project configuration takes precedence.


key: general

description: The general configuration of the pipeline


key: productiveBranch

description: The name of your default branch. This branch will be used for deploying your application. Other branches will skip deployment.


key: projectName

description: Name of the project. Will be used as identifier e.g. when creating a hdi container or executing code scans.


key: globalExtensionsRepository

description: Git url of the repository containing the extensions.


key: globalExtensionsVersion

description: Version of the extensions which should be used, e.g. the tag name


key: globalExtensionsRepositoryCredentialsId

description: Credentials required to clone the repository


key: collectTelemetryData

description: No personal data is collected. For details, consult the analytics documentation.


key: unsafeMode

description: Enable unsafe mode to skip checking environment variables for insecure elements. Only use this for demo purposes, never for productive usage.


key: features

description: Allows enabling or disable certain optional features.


key: parallelTestExecution

description: Run E2E Tests in parallel. This feature is disabled by default because it is not supported in Blue Ocean. If this feature is enabled, we suggest not using the Blue Ocean interface and rely on the classic UI instead.


key: jenkinsKubernetes

description: If the Jenkins is running on a kubernetes cluster as a pod, we can use the dynamic scaling feature in the pipeline. In order to enable this, an environment variable ON_K8S has to be set to true on the jenkins.


key: jnlpAgent

description: Docker image for jnlp agent to be used.


key: stages

description: Configuration, which will modify the behaviour of stages in the SAP Cloud SDK Pipeline.

required: url repository

required: product credentialsId


key: retry

description: The number of times that integration tests will retry before aborting the build. Note: This will consume more time for the jenkins build.


key: forkCount

description: The number of JVM processes that are spawned to run the tests in parallel in case of using a maven based project structure. For more details visit the surefire documentation.


key: credentials

description: The list of system credentials to be injected during integration tests. The following example will provide the username and password for the systems with the aliases ERP and SFSF. For this, it will use the Jenkins credentials entries erp-credentials and successfactors-credentials. You have to ensure that corresponding credential entries exist in your Jenkins configuration.


key: sidecarImage

description: Name of the Docker image that should be used.


key: sidecarName

description: On Docker: Name of the container in the local network. On Kubernetes: Name of the container.


key: sidecarReadyCommand

description: Command executed inside the container, which returns exit code 0 when the container is ready to be used.


key: sidecarEnvVars

description: Environment variables to set in the container.


key: enableZeroDowntimeDeployment

description: It is possible to activate zero downtime deployment in end-to-end tests with the option enableZeroDowntimeDeployment. This will lead to a blue-green-deployment on SCP Cloud Foundry respectively to a rolling update on SCP Neo. By default, this feature is turned off.


key: onlyRunInProductiveBranch

description: Running end-to-end tests can be restricted to the productiveBranch with the option onlyRunInProductiveBranch. This might be useful when the end-to-end tests slow down development, and build failure on the productiveBranch is acceptable. By default, this feature is turned off.


key: npmAudit

description: This stage uses the npm audit command to check for known vulnerabilities in dependencies.


key: auditedAdvisories

description: In case you audited an advisory, and it turns out to be a false positive, you can mark it as audited by adding its id to the auditedAdvisories in the stage configuration. A false positive in this case is when you are confident your application is not affected in any way by the underlying bug or vulnerability.


key: jacocoExcludes

description: A list of exclusions expressed as an Ant-style pattern relative to the application folder. An example can be found below.


key: customOdataServices

description: We recommend only using OData services listed in the in SAP API Business Hub. Despite that for using custom business objects you can add those APIs here.


key: nonErpDestinations

description: List of destination names that do not refer to ERP systems. Use this parameter to exclude specific destinations from being checked in context of ERP API whitelists.


key: nonErpUrls

description: List of URLs that are not defined as destinations. Use this parameter to exclude specific URLs from being checked in context of ERP API whitelists.


key: codeCoverageFrontend

description: A map containing the thresholds unstable and failing. If the code coverage is lower than what is configured in unstable, the pipeline result is unstable. If it is lower than what is configured in failing, the pipeline will fail.


key: threshold

description: This setting allows the code coverage to be stricter compared to the default values. By default, the pipeline will fail if the coverage is below 65% line coverage (unstableCoverage), and will be unstable if it is less than 70% (successCoverage). If lower numbers are configured, or this configuration is left out, the default values are applied.


key: disabledChecks

description: A list of checks which should not be executed. Possible values are: checkDeploymentDescriptors (Check for insecure options, such as ALLOW_MOCKED_AUTH_HEADER in deployment descriptors), checkResilience(Check that application is resilient to faults in the network), checkServices (Check that only official APIs are used), checkFrontendCodeCoverage (Ensures high frontend code coverage), checkBackendCodeCoverage (Ensures high backend code coverage)


key: checkmarxScan

description: Checkmarx is one of the security analysis tools which is supported by the pipeline.


key: groupId

description: Checkmarx Group ID


key: checkMarxProjectName

description: Name of the project on Checkmarx server.


key: filterPattern

description: Files which needs to be skipped during scanning.


key: fullScansScheduled

description: Toggle to enable or disable full scan on a certain schedule.


key: incremental

description: Perform incremental scan with every run. If turned false, complete project is scanned on every submission.


key: vulnerabilityThresholdMedium

description: The threshold for medium level threats. If the findings are greater than this value, pipeline execution will result in failure.


key: vulnerabilityThresholdLow

description: The threshold for low level threats. If the findings are greater than this value, pipeline execution will result in failure.


key: preset

description: Name or numerical ID of Checkmarx preset to be used when scanning this project. When a name (string) is specified, the pipeline will try to discover the corresponding numerical ID via the Checkmarx API. Please also make sure to specify checkmarxCredentialsId and checkmarxServerUrl in such a case. For determining available presets in your Checkmarx webclient, go to Checkmarx -> Management -> Scan Settings -> Preset Manager. Alternatively, you can determine the numerical ID of your targeted preset by following those guides: Token-based Authentication and Get All Preset Details.


key: checkmarxCredentialsId

description: The Credential ID to connect to Checkmarx server. The credentials must be type username with password. This property becomes mandatory if the credentials are not configured in the Jenkins plugin itself.


key: checkmarxServerUrl

description: An URL to Checkmarx server. This property becomes mandatory if the URL to the Checkmarx server is not configured in the Jenkins plugin itself or if the checkmarxCredentialsId is configured.


key: generatePdfReport

description: Possibility to generate PDF reports of the scan.


key: artifactDeployment

description: The deployment of artifacts to nexus can be configured with a map containing the following properties.


key: version

description: Version of nexus. Can be nexus2 or nexus3.


key: url

description: URL of the nexus. The scheme part of the URL will not be considered, because only http is supported.


key: mavenRepository

description: Name of the nexus repository for Maven and MTA artifacts. Ignored if the project does not contain pom.xml or mta.yml in the project root.