server.json

title: Server Configuration

description: The event horizon server configuration

description: The configuration for the interaction server

description: Whether or not the interaction server is enabled

description: The port to use for exposing the interaction server

description: The unix socket to use for exposing the interaction server on

description: The port to use for exposing the management server

description: The unix socket to use for exposing the management server on

required: interaction management


gateway-config-schema.json

title: Gateway configuration

type: object

title: Services

type: array


drupal-permissions.json

title: Permission definition

title: The human-readable name of the permission

type: string

title: A description of what the permission does

title: Restrict access to this permission to trusted users

description: This should be used for permissions that have inherent security risks across a variety of potential use cases (for example, the "administer filters" and "bypass node access" permissions provided by Drupal core).

type: boolean

title: List of permission callbacks

title: A callback that return array of permissions

title: JSON schema for Drupal permissions file


$ref: #/definitions/is-parallel-true

description: The hemtt.json or hemtt.toml file is used to configure your HEMTT Project. All examples are done using JSON, but both files support every feature of HEMTT. hemtt.toml will be used if both files are present.

$id: #/properties/name

title: The Name Schema

description: Long name of your project.

$id: #/properties/prefix

title: The Prefix Schema

description: Prefix used for CBA macros and the release directory name.

$id: #/properties/author

title: The Author Schema

description: Author of the project.

$id: #/properties/version

title: The Version Schema

description: HEMTT will look for ```addons/main/script_version.hpp``` and use it for the version number. If you are not using the CBA project structure or do not have that file you can add a version number in the HEMTT project file.

$id: #/properties/files

title: The Files Schema

description: HEMTT will copy the files to the release directory after a successful release build. Supports glob patterns.

$id: #/properties/files/items

title: The Items Schema

$id: #/properties/include

title: The Include Schema

description: HEMTT will include matching relative or absolute paths when building.

$id: #/properties/include/items

title: The Items Schema

$id: #/properties/exclude

title: The Exclude Schema

description: HEMTT will exclude matching files when building.

$id: #/properties/exclude/items

title: The Items Schema

$id: #/properties/optionals

title: The Optionals Schema

description: HEMTT will build the specified addons from the ./optionals folder.

$id: #/properties/optionals/items

title: The Items Schema

examples: tracers particles

title: The Folder_optionals Schema

description: HEMTT will by default build optionals into their own mod folders, which can be directly launched by the user. This can be turned off to build optional PBOs directly into optionals folder.

$id: #/properties/skip

title: The Skip Schema

description: HEMTT will skip building the specified addons.

$id: #/properties/skip/items

title: The Items Schema

examples: hearing zeus

$id: #/properties/headerexts

title: The Headerexts Schema

description: HEMTT will apply specified header extensions to each PBO. Supports templating.

$id: #/properties/headerexts/items

title: The Items Schema

$id: #/properties/modname

title: The Modname Schema

description: HEMTT will use the specified mod name (without @) to form @mod folder. Supports templating.

$id: #/properties/keyname

title: The Keyname Schema

description: HEMTT will use the specified key name for .bikey and .biprivatekey names. Supports templating.

$id: #/properties/signame

title: The Signame Schema

description: HEMTT will use the specified signature name as part of the full signature (.bisign) name. Supports templating.

$id: #/properties/sigversion

type: integer

title: The Sigversion Schema

description: HEMTT will use the specified signature version. Currently Supported: V2, V3 (Experimental).

title: The Reuse_private_key Schema

description: If set to true, HEMTT will use (and re-use) releases/keys/{keyname}.biprivatekey. It will be generated if it doesn't exist. The default behaviour is to generate a new private key each time and discard it immediately. HEMTT strongly recommends that you only re-use the key if you are making a client-side mod where it will not matter if clients are running different versions of the mod.

$id: #/properties/postbuild

title: The Postbuild Schema

$id: #/properties/postbuild/items

title: The Items Schema

$id: #/properties/prebuild

title: The Prebuild Schema

$id: #/properties/prebuild/items

title: The Items Schema

$id: #/properties/releasebuild

title: The Releasebuild Schema

$id: #/properties/releasebuild/items

title: The Items Schema

$id: #/properties/scripts

title: The Scripts Schema

$id: #/properties/scripts/properties/

title: The  Schema

title: The Steps Schema

title: The Items Schema

examples: echo {{addon}} took {{time}} ms to build.

title: The Steps_linux Schema

description: steps_windows and steps_linux can be used to run different steps on the respective platforms.

title: The Items Schema

title: The Steps_windows Schema

title: The Items Schema

title: The Show_output Schema

description: All output is hidden by default. Setting show_output will display the command being executed and its output.

title: The Foreach Schema

description: Scripts can be ran for each addons. Inside prebuild the script will be ran for each addon that HEMTT will build, including addons that will be skipped if they are already built. Inside postbuild and releasebuild only addons that were successfully built with be used, excluding addons that were skipped for being up to date.

title: The Parallel Schema

description: Requires foreach to be true. If a script is thread safe parallel can be used to process multiple addons at a time.

required: name prefix author

title: The Root Schema


minecraft-texture-mcmeta.json

description: A mcmeta file for an animated texture for a Minecraft resource pack config schema

description: Animation

title: Minecraft Resource Pack Texture Mcmeta


shopware-extension-schema.json

title: shopware-cli

$ref: #/definitions/Config

description: shopware cli extension configuration definition file

title: .shopware-extension.yml

$ref: #/definitions/Build

$ref: #/definitions/Store

$ref: #/definitions/Changelog

title: changelog

description: Enables the changelog generation.

description: Enables the changelog generation with OpenAI (Requires OPENAI_TOKEN environment variable).

description: Limit with RegEx which commits should be considered for the changelog generation.

description: Allows to override the Go template which renders the Changelog.

description: Allows to write RegEx groups into variables which can be used in the template.

title: build

description: Overrides the shopware version constraint in the composer.json/manifest.xml file.

title: store

description: Specifies the Path to the icon (128x128 px) for store.

description: Specifies the visibility in stores.

enum: German International

description: Specifies the languages the extension is translated.

description: Specifies the categories in which the extension can be found.

enum: Administration SEOOptimierung Bonitaetsprüfung Rechtssicherheit Auswertung KommentarFeedback Tracking Integration PreissuchmaschinenPortale Warenwirtschaft Versand Bezahlung StorefrontDetailanpassungen Sprache Suche HeaderFooter Detailseite MenueKategorien Bestellprozess KundenkontoPersonalisierung Sonderfunktionen Themes Branche Home+Furnishings FashionBekleidung GartenNatur KosmetikGesundheit EssenTrinken KinderPartyGeschenke SportLifestyleReisen TechnikIT IndustrieGroßhandel MigrationTools Einkaufswelten ConversionOptimierung Extensions MarketingTools B2BExtensions Blog emailMarketing promotionsAndVoucher loyalityAndRewards recommendations otherMarketingCommercials socialCommerce middlewareAndConnectors pim dam cms crm personalization

description: Specifies the type of this extension.

enum: extension theme

description: Specifies whether the extension should automatically be set compatible with Shopware bugfix versions.

description: Specifies the links of YouTube-Videos to show or describe the extension.

description: Specifies the tags of the extension.

description: Specifies the highlights of the extension.

description: Specifies the features of the extension.

description: Specifies Frequently Asked Questions for the extension.

$ref: #/definitions/StoreInfoFaqQuestion

description: Specifies the description of the extension in store.

description: Use string or set path to a file with prefix `file:` containing the description, f.e. `file:src/store/manual_de.md`

description: Use string or set path to a file with prefix `file:` containing the description, f.e. `file:src/store/manual_en.md`

description: Installation manual of the extension in store.

description: Specifies images for the extension in the store.

required: file priority

description: File path to image relative from root of the extension

description: Specifies whether the image is active in the language.

description: Specifies whether the image is a preview in the language.

description: Specifies the order of the image ascending the given priority.

title: StoreInfoFaqQuestion

required: question answer


ifstate.conf.schema.json

title: ifstate.conf

description: IfState 1.8.2 Configuration Schema

description: list of ip address prefixes to be ignored

description: ip address with prefix length

description: interface names matching this list of regex will be ignored

description: regex to match interface name

examples: ^br-[\da-f]{12} ^docker\d+ ^lo$ ^ppp\d+$ ^veth ^virbr\d+ ^vrrp\d*\.\d+$

description: filter routes by options

type: integer string

default: boot

default: main

description: filter rules by options

description: the type of this rule

enum: to_tbl blackhole unreachable prohibit

description: the priority of this rule

description: select the source prefix to match

description: select the destination prefix to match

description: select the incoming device to match

description: select the outgoing device to match

default: unspec

description: routing protocol number (`/etc/iproute2/rt_protos`)

description: select the *fwmark* value to match

description: select the ip protocol to match

description: link mac address (xx:xx:xx:xx:xx:xx)

description: specifies a device group name or index

description: specifies a parent device name or index

description: specifies a master device name or index

description: change the mtu of the device

description: set device state

enum: up down

description: the transmit queue length of the device

description: symbolic name for easy reference

description: remote IPv4 address of the tunnel

description: local IPv4 address of the tunnel

description: remote IPv4 address of the tunnel

description: local IPv4 address of the tunnel

description: interface to use for tunnel endpoint communication

description: configures [per interface sysctl settings](https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt)

description: settings in `/proc/sys/net/ipv4/*/conf/`

description: settings in `/proc/sys/net/ipv6/*/conf/`

description: qdisc id

description: protocol selector

description: priority

description: traffic control queueing discipline

description: unique id

description: generic classless qdisc

description: qdisk type

enum: gred hhf mqprio multiq netem pfifo_fast pie red sfb sfq tbf

description: [choke](https://man7.org/linux/man-pages/man8/tc-choke.8.html) - choose and keep scheduler

required: kind limit min max avpkt burst probability

description: qdisk type

description: [CoDel](https://man7.org/linux/man-pages/man8/tc-codel.8.html) - Controlled-Delay Active Queue Management algorithm

description: qdisk type

description: [bfifo](https://man7.org/linux/man-pages/man8/tc-bfifo.8.html) - Byte limited First In, First Out queue; [pfifo](https://man7.org/linux/man-pages/man8/tc-pfifo.8.html) - Packet limited First In, First Out queue

description: qdisk type

description: queue size in bytes or packets

description: [fq](https://man7.org/linux/man-pages/man8/tc-fq.8.html) - Fair Queue traffic policing

description: qdisk type

description: hard limit on the real queue size (number of packets)

description: hard limit on the max number of packets per flow

description: [fq_codel](https://man7.org/linux/man-pages/man8/tc-fq_codel.8.html) - Fair Queuing (FQ) with Controlled Delay (CoDel)

description: qdisk type

description: number of flows

description: generic classful qdisc

description: qdisk type

description: classful multiqueue dummy scheduler

description: qdisk type

description: list child qdiscs for each device TX queue

description: child qdiscs for the nth device TX queue

description: [cake](https://man7.org/linux/man-pages/man8/tc-cake.8.html) - common applications kept enhanced (CAKE)

description: qdisk type

description: unique id

description: ACKnowledge filter

description: ATM mode

description: autorate-ingress

description: diffserv mode

description: ingress

description: overhead

description: flow mode

enum: flowblind srchost dsthost hosts flows dual-srchost dual-dsthost triple-isolated

description: fwmark

description: memlimit

description: MPU

description: NAT

description: RAW

description: well-known RTT

enum: datacentre lan metro regional internet oceanic satellite interplanetary

description: manually specify an RTT (us)

description: split GSO

description: target

description: wash

description: traffic control filter action

description: [mirred](https://man7.org/linux/man-pages/man8/tc-mirred.8.html) - mirror/redirect action

description: packet direction

description: copy (`mirror`) or move (`redirect`) packets to the destination interface

description: destination interface where packets are redirected or mirrored to

description: unique action ID

description: force attach mode of the XDP program (`auto`: let the kernel choose, `xdp`: run inside driver, `xdpgeneric`: driver-independent before SKB allocation, `xdpoffload`: offload to SmartNIC co-processor)

description: allowed attach modes of the XDP program (`xdp`: run inside driver, `xdpgeneric`: driver-independent before SKB allocation, `xdpoffload`: offload to SmartNIC co-processor)

description: global configuration settings

description: overrides [per interface sysctl settings](https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt) in `/proc/sys/net/ipv*/conf/all/`

description: default [per interface sysctl settings](https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt) in `/proc/sys/net/ipv*/conf/default/`

description: ignore patterns to skip interface, ip address or routing objects

description: ignore dynamic assigned ip addresses

description: load and pin eBPF programs (i.e. for XDP)

description: BPF program

description: BPF ELF file to load

description: BPF program's section name

description: cshaper templates

description: cshaper profile

description: build a ifb ifname using a regex on the ifname

description: pattern to search

description: replace pattern by string

description: list of interface settings (link settings and ip addresses)

description: name of the interface

description: ip addresses of the interface

description: settings for bridge ports

description: set port priority

description: set port cost

description: filter BPDU packets

description: enable hairpin mode

description: enable multicast fast leave

description: prevent to become a root port

description: allow MAC address learning

description: flood unknown unicasts

description: flood broadcasts

description: flood multicasts

description: clone multicast packets into unicasts

description: enable proxy ARP

description: enable proxy ARP (IEEE 802.11 and Hotspot 2.0)

description: ARP and ND suppression

description: VLAN to tunnel mapping

description: backup bridge port on loss carrier

description: isolated port, can communicate only with non-isolated ports

description: interface depending on vrrp status

description: related vrrp INSTANCE or GROUP name

description: failover type

description: states at which the interface should be configured

description: link settings of the interface

description: Intermediate Functional Block device

description: link type

description: Virtual tunnel interface IPv4|IPv6 over IPv6

description: link type

description: IP over Infiniband device

description: link type

description: Interface for L3 (IPv6/IPv4) based VLANs

description: link type

description: Virtual interface base on link layer address (MAC)

description: link type

description: Virtual interface based on link layer address (MAC) and TAP

description: link type

description: Team network device

description: link type

description: Virtual software device (TUN/TAP)

description: link type

description: device mode (Ethernet headers)

description: provide packet information

description: persistent device; non-persistent devices cannot be created

description: prepend frames with struct virtio_net_hdr

description: enable multiqueue tuntap

description: device owner

description: device group

description: Virtual Routing and Forwarding device

description: link type

description: Virtual tunnel interface over IPv4

description: link type

description: Virtual tunnel interface over IPv6

description: link type

description: Bonding network interface

description: link type

enum: 0 balance-rr 1 active-backup 2 balance-xor 3 broadcast 4 802.3ad 5 balance-tlb 6 balance-alb

description: the bonding policy

description: MII link monitoring frequency in milliseconds

description: time, in milliseconds, to wait before enabling a slave after a link recovery has been detected

description: time, in milliseconds, to wait before disabling a slave after a link failure has been detected

description: use MII or ETHTOOL ioctls vs. netif_carrier_ok() to determine the link status

description: ARP link monitoring frequency in milliseconds

description: arp validation for arp monitoring

description: quantity of arp_ip_targets that must be reachable

description: reselection policy for the primary slave

description: slave mac address selection

description: transmit hash policy to use for slave selection

description: number of IGMP membership reports to be issued after a failover event

description: dropped (0) or delivered (1) duplicate frames

description: number of links that must be active before asserting carrier

description: number of seconds between instances where the bonding driver sends learning packets to each slaves peer switch

description: number of packets to transmit through a slave before moving to the next one

description: requested LACPDU packet rate in 802.3ad mode

description: 802.3ad aggregation selection logic to use

description: dynamic shuffling of flows in tlb mode

description: Bridge network interface

description: link type

description: FDB entry ageing time in milliseconds

description: 802.1q or 802.1ad (Q-in-Q)

description: Physical network interface

description: link type

description: select interface by permanent address [ethtool -P]

description: select interface by bus info [ethtool -i]

description: Dummy network interface

description: link type

description: VETH/VXCAN interface

description: link type

description: VLAN interface

description: link type

description: specifies the VLAN identifier to use

description: 802.1q or 802.1ad (Q-in-Q)

description: VXLAN interface

description: link type

description: specifies the VNI

description: IPIP interface

description: link type

description: SIT interface

description: link type

description: GRE, GRETAP interface

description: link type

description: IP6GRE, IP6GRETAP interface

description: link type

description: GENEVE interface over IPv4

description: link type

description: specifies the VNI to use

description: GENEVE interface over IPv6

description: link type

description: specifies the VNI to use

description: WireGuard interface; WireGuard settings can be configured using a `wireguard` block

description: link type

description: XFRM interface

description: link type

description: underlying interface used to send and receive the transformed traffic

description: lookup key to match xfrm policies

description: static ARP or NDISC cache entries

description: protocol address of the neighbour

description: link layer address of the neighbour

description: [interface sysctl settings](https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt) in `/proc/sys/net/ipv*/conf/{IFACE}/`

description: network driver and hardware settings via [ethtool(8)](https://man7.org/linux/man-pages/man8/ethtool.8.html)

description: pause parameters

description: enable pause autonegotiation

description: enable Rx pause

description: enable Tx pause

description: interrupt coalescing

description: rx/tx ring parameters

description: number of ring entries for the Rx ring

description: number of ring entries for the Rx Mini ring

description: number of ring entries for the Rx Jumbo ring

description: number of ring entries for the Tx ring

description: offload parameters and other features

description: enable RX checksumming

description: enable TX checksumming

description: enable scatter-gather

description: enable TCP segmentation offload

description: enable UDP fragmentation offload

description: enable generic segmentation offload

description: enable generic receive offload

description: enable large receive offload

description: enable RX VLAN acceleration

description: enable TX VLAN acceleration

description: enable Rx ntuple filters and actions

description: enable receive hashing offload

description: device settings

description: speed in Mbps

description: full or half duplex mode

description: device port selection

description: MDI-X mode for port

description: enable autonegotation

description: speed and duplex advertised by autonegotation

description: PHY address

description: transceiver type

description: Wake-on-LAN options

description: SecureOn™ password

description: driver message flags

description: driver message flags by number

description: driver message flags by name

description: flag name

enum: drv probe link timer ifdown ifup rx_err tx_err tx_queued intr tx_done rx_status pktdata hw wol

description: enable flag

description: number of channels

description: number of channels with only receive queues

description: number of channels with only transmit queues

description: number of channels used only for other purposes

description: number of multi-purpose channels

description: Energy-Efficient Ethernet (according to the IEEE 802.3az specifications)

description: enable EEE support

description: assert Tx LPI

description: sets the speed for which EEE should be enabled (see also `change.advertise`)

description: amount of idle time prior asserting Tx LPI (in microseconds)

description: PHY tunable parameters

description: enable downshift

description: enable downshift

description: enable downshift

description: *REQUIRED*

description: PHY downshift re-tries count

description: enable Fast Link Down

description: enable Fast Link Down

description: enable Fast Link Down

description: *REQUIRED*

description: period after which the link is reported as down

description: enable Energy Detect Power Down (EDPD)

description: enable EDPD

description: enable EDPD

description: *REQUIRED*

description: wake-up interval for Tx pulses

description: private flags

description: Forward Error Correction

description: FEC encoding

description: simple shaper setup based on the [cake](https://man7.org/linux/man-pages/man8/tc-cake.8.html) queue discipline; replaces any tc settings

description: target ingress bandwidth

description: target egress bandwidth

description: cshaper profile

description: settings for traffic control

description: enable the ingress qdisc for policing and shaping in ingress

description: root queueing disciplines

description: filter used by qdiscs

description: filter type

description: [basic](https://man7.org/linux/man-pages/man8/tc-basic.8.html) - basic traffic control filter

description: match packets using the [extended match infrastructure](https://man7.org/linux/man-pages/man8/tc-ematch.8.html)

description: [flow](https://man7.org/linux/man-pages/man8/tc-flow.8.html) - flow based traffic control filter

description: offset for the class ID calculation

description: filter mode

description: map to class ID by key

enum: src dst proto proto-src proto-dst iif priority mark nfct nfct-src nfct-dst nfct-proto-src nfct-proto-dst rt-classid sk-uid sk-gid vlan-tag rxhash

description: filter mode

description: hash over keys for class ID calculation

description: rehashing interval (in seconds)

description: [fw](https://man7.org/linux/man-pages/man8/tc-fw.8.html) - fwmark traffic control filter

description: fwmark (iptables) to match

description: [matchall](https://man7.org/linux/man-pages/man8/tc-matchall.8.html) - traffic control filter that matches every packet

description: push matching packets into class

description: process flags (1: SKIP_HW, 2: SKIP_SW)

description: settings for WireGuard interfaces

description: local private key (consider to use the `!include` tag to read the key from file)

description: port for listening

description: fwmark for outgoing packets

description: list of peer definitions

description: the peer's public key

description: preshared key for post-quantum resistance (consider to use the `!include` tag to read the key from file)

description: initial endpoint IP or hostname

description: keepalive interval seconds

description: list of prefixes in CIDR notation

description: settings for XDP ("eXpress Data Path") BPF program

description: remove attached XDP program

description: attach already pinned XDP program

description: path to already pinned XDP program

description: BPF program from ifstate's bpf config section

description: BPF program (key in bpf config section)

description: the type of this route

enum: unicast local broadcast anycast multicast blackhole unreachable prohibit throw nat xresolve

description: the output device name

description: the routing protool identifier of this route

description: the realm to which this route is assigned

description: the scope of the destinations covered by the route prefix

description: the table to add this route to

description: the destination prefix of the route

description: address of the nexthop router

description: the source address to prefer

description: preference of the route

description: the type of this rule

description: the priority of this rule

description: select the source prefix to match

description: select the destination prefix to match

description: select the incoming device to match

description: select the outgoing device to match

description: select the *fwmark* value to match

description: select the ip protocol to match


phraseapp.json

description: ID of the project

description: File format name. See the format guide in the documentation for all supported file formats.

default: yml

description: Locale that should be downloaded. Locale ID or locale name are valid options

description: Enforces a specific encoding on the file contents. Valid options are "UTF-8", "UTF-16" and "ISO-8859-1"

description: Root element of the PhraseApp config

description: Default configuration for API endpoints

default: desc

description: API host URL. Only needs to be changed for OnPremise usage

description: Access Token for authorization. Can be created in the user profile

description: Source files that will be uploaded on push

description: Translation file which will be uploaded

description: Locale upload parameter

description: Branch name

description: List of tags separated by comma to be associated with the new keys contained in the upload

description: Indicates whether existing translations should be updated with the file content

description: Existing key descriptions will be updated with the file content. Empty descriptions overwrite existing descriptions

description: Indicates whether the file contains Emoji symbols that should be converted

description: Indicates whether the upload should not create upload tags

description: Indicates whether the upload should unverify updated translations

$ref: #/definitions/encoding

description: Additional options available for specific formats. See our format guide for complete list

description: Colum separator character

description: List of files that will be downloaded on pull

description: Translation file which will be downloaded

description: Locale download parameter

description: Branch name

description: Limit result to keys tagged with the given tag (identified by its name)

description: Indicates whether keys without translations should be included in the output as well

description: Indicates whether [NOTRANSLATE] tags should be kept

description: Indicates whether Emoji symbols should be converted to actual Emojis

description: Indicates whether the locale file should skip all unverified translations

description: If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the public ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to true

title: JSON schema for PhraseApp configuration files


artifacts.json

title: Artifacts Configuration

description: The artifacts configuration

$ref: #/definitions/artifactsByTypeDefinition

description: The artifacts by type definition

description: The command artifacts of a Feature

$ref: #/definitions/artifactDefinition

description: The event artifacts of a Feature

description: The event source artifacts of a Feature

description: The read model artifacts of a Feature

description: The query artifacts of a Feature

required: commands events eventSources readModels queries

description: The definition of an artifact

description: The artifact generation

type: number

description: The CLR Type represented by the artifact

required: generation type


bamboo-spec.json

$ref: #/definitions/job

title: Deployment projects

description: A deployment project in Bamboo is a container for holding the software project you are deploying: releases that have been built and tested, and the environments to which releases are deployed

title: Docker

description: Builds and deployments are normally run on the Bamboo agent's native operating system

enum: plan-failed plan-completed plan-status-changed plan-comment-added plan-responsibility-changed job-completed job-status-changed job-failed job-error job-first-failed job-hung job-queue-timeout job-queued-without-capable-agents

title: Job

description: A job is a single build unit within a plan and is made up of one or more tasks.

title: Artifact

description: Artifacts are files created by a job build (e.g. JAR files)

description: The relative path to find your artifact; it's a path relative to the workspace directory; do not use absolute paths.

description: Name of the artifact; in case artifact is shared, name must be unique within the plan.

description: Name or Ant pattern of file(s) to keep.

description: You can share an artifact among other jobs or plans.

description: The Test Results Parser task in Bamboo parses test data

$ref: #/definitions/testParser

$ref: #/definitions/script

$ref: #/definitions/docker

$ref: #/definitions/predefinedTask

$ref: #/definitions/job/definitions/task

description: Variables can be used to make values available when building plans in Bamboo.

$ref: #/definitions/events

description: Plan permissions allow a user to control access to the functions of the build plan.

enum: view edit build admin clone deploy

description: A plan defines everything about your continuous integration build process in Bamboo.

enum: inject-variables clean checkout artifact-download

title: Stage

description: Stages group jobs to individual steps within a plan's build process.

description: Will await for execution by user

description: Will be executed regardless of other stages state (pass or fail)

description: A task is a small unit of work, such as source code checkout, or running a script.

description: Execute deployment by schedule.

description: Full spec reference: https://docs.atlassian.com/bamboo-specs-docs/7.2.4/specs.html

title: Default Environment Permissions

description: These permissions apply to all environments defined in this deployment project

title: Deployment

title: Deployment Permissions

description: These permissions apply to the deployment project

title: Environment Permissions

description: Permissions specific to an environment

description: An environment represents the servers or groups of servers where the software release has been deployed to, and the tasks that are needed for the deployment to work smoothly

title: Plan Permissions

description: You can define how releases should be named when they are created by Bamboo

title: Bamboo CI Specification


required: name type

description: The name of property, in camelCase

description: The type of property

enum: bigint.unsigned bigint blob.long blob.medium blob.tiny blob boolean char date decimal enum float id int.unsigned int json manyToMany password relationship smallint.unsigned smallint text timestamp tinyint.unsigned tinyint varchar

description: Set max length to property

description: Set max length to property

description: Set property to nullable

description: Set property to primary key

description: To define property like a index

enum: index unique

description: The name of index, if there are various indexes with the same name, they will be grouped

description: Values for enum type

type: number string boolean

description: Default value for property

description: Example value for property, this value will be used in swagger documentation

description: Total digits of the number and length of the decimal places in the back of the number, example: [10, 2].

description: Set number property as auto increment

$ref: #/definitions/relationship

$ref: #/definitions/webComponent

required: path resolverType httpMethod

description: Path to access api

description: Type of resolver, query or mutation

enum: query mutation

description: Verb of api rest

enum: get post put delete patch

description: Relationship definition for this property

description: The type of web component

enum: many-to-many many-to-one none one-to-many one-to-one

description: Singular name of the property referred to in the relationship, only for one-to-many and many-to-many relationship, example: book

description: Aggregate referring to this relationship, example: LibraryAuthor

description: Path to the module that refers to this relationship, example: library/author

description: Property key that refers to this relationship, only for many-to-one relationship, example: id

description: Field to obtain the relationship data, example: author

description: Avoid constraint rules for this relationship

description: Path to packageName where is the relationship, example: @aurora-ts/core

description: Set many-to-many relationship as denormalized, creating a field to store the selected ids

$ref: #/definitions/pivotTable

description: Web Component that wil be rendered for this property

description: The type of web component

description: Relationship pivot table definition for this relationship

description: AggregateName of Pivot table, example: IamRolesAccounts

description: Module path where table model file will be saved, example: iam/role

description: Filename of pivot table model file, example: roles-accounts

description: Make agile applications without technical debt

description: Schema version

description: The name of the bounded context, singular in kebab-case

description: The name of the module, singular in kebab-case

description: The name of the module, plural in kebab-case

description: The name of the aggregateName, singular in PascalCase

description: Enabled authentication for this module

description: Enabled tenant for this module

description: Enabled auditing for this module

$ref: #/definitions/property

$ref: #/definitions/apiDefinition

required: boundedContextName moduleName moduleNames aggregateName

title: Aurora Agile Meta Framework


workflow.json

description: Serverless Workflow specification - workflow schema

description: Workflow unique identifier

description: Domain-specific workflow identifier

description: Workflow name

description: Workflow description

description: Workflow version

description: List of helpful terms describing the workflows intended purpose, subject areas, or other important qualities

$ref: #/definitions/validationSchema

format: uri

description: URI to a resource containing constants data (json or yaml)

description: Workflow constants data (object type)

$ref: #/definitions/startdef

description: Serverless Workflow schema version

description: Identifies the expression language used for workflow expressions. Default is 'jq'

default: jq

description: If 'true', workflow instances is not terminated when there are no active execution paths. Instance can be terminated via 'terminate end definition' or reaching defined 'workflowExecTimeout'

description: If set to true, actions should automatically be retried on unchecked errors. Default is false

description: State definitions

title: Sleep State

$ref: #/definitions/sleepstate

title: Event State

$ref: #/definitions/eventstate

title: Operation State

$ref: #/definitions/operationstate

title: Parallel State

$ref: #/definitions/parallelstate

title: Switch State

$ref: #/definitions/switchstate

title: Inject State

$ref: #/definitions/injectstate

title: ForEach State

$ref: #/definitions/foreachstate

title: Callback State

$ref: #/definitions/callbackstate

required: id specVersion states

required: key specVersion states

description: Amount of time (ISO 8601 duration format) to sleep before function/subflow invocation. Does not apply if 'eventRef' is defined.

description: Amount of time (ISO 8601 duration format) to sleep after function/subflow invocation. Does not apply if 'eventRef' is defined.

required: before after

description: Cron expression defining when workflow instances should be created (automatically)

description: Repeating interval (cron expression) describing when the workflow instance should be created

description: Specific date and time (ISO 8601 format) when the cron expression invocation is no longer valid

description: Unique id of the workflow to be continue execution as. Entire state data is passed as data input to next execution

description: Unique id of the workflow to continue execution as

description: Version of the workflow to continue execution as

type: string object

description: If string type, an expression which selects parts of the states data output to become the workflow data input of continued execution. If object type, a custom object to become the workflow data input of the continued execution

description: Workflow execution timeout to be used by the workflow continuing execution. Overwrites any specific settings set by that workflow

description: Name of state to transition to

description: Function Reference

description: Name of state to transition to

description: Array of events to be produced before the transition happens

$ref: #/definitions/produceeventdef

description: If set to true, triggers workflow compensation when before this transition is taken. Default is false

description: Reference to a unique workflow error definition. Used of errorRefs is not used

description: References one or more workflow error definitions. Used if errorRef is not used

description: Transition to next state to handle the error.

$ref: #/definitions/transition

description: End workflow execution in case of this error.

$ref: #/definitions/end

required: errorRef transition

required: errorRef end

required: errorRefs transition

required: errorRefs end

description: References one or more unique event names in the defined workflow events

enum: sequential parallel

description: Specifies how actions are to be performed (in sequence or in parallel)

default: sequential

description: Actions to be performed if expression matches

$ref: #/definitions/action

description: Event data filter

$ref: #/definitions/eventdatafilter

description: Unique action definition name

description: References a function to be invoked

$ref: #/definitions/functionref

description: References a `produce` and `consume` reusable event definitions

$ref: #/definitions/eventref

description: References a sub-workflow to invoke

$ref: #/definitions/subflowref

description: Defines time periods workflow execution should sleep before / after function execution

$ref: #/definitions/sleep

description: References a defined workflow retry definition. If not defined the default retry policy is assumed

description: List of unique references to defined workflow errors for which the action should not be retried. Used only when `autoRetries` is set to `true`

description: List of unique references to defined workflow errors for which the action should be retried. Used only when `autoRetries` is set to `false`

description: Action data filter

$ref: #/definitions/actiondatafilter

description: Expression, if defined, must evaluate to true for this action to be performed. If false, action is disregarded

description: Name of the referenced function

description: Function Reference

description: Name of the referenced function

description: Function arguments/inputs

description: Only used if function type is 'graphql'. A string containing a valid GraphQL selection set

enum: sync async

description: Specifies if the function should be invoked sync or async

default: sync

description: Event References

description: Reference to the unique name of a 'produced' event definition

description: Reference to the unique name of a 'consumed' event definition

description: Maximum amount of time (ISO 8601 format) to wait for the result event. If not defined it should default to the actionExecutionTimeout

description: If string type, an expression which selects parts of the states data output to become the data (payload) of the event referenced by 'produceEventRef'. If object type, a custom object to become the data (payload) of the event referenced by 'produceEventRef'.

description: Add additional extension context attributes to the produced event

description: Unique id of the sub-workflow to be invoked

description: Specifies a sub-workflow to be invoked

description: Version of the sub-workflow to be invoked

description: If invoke is 'async', specifies how subflow execution should behave when parent workflow completes. Default is 'terminate'

description: Specifies if the subflow should be invoked sync or async

description: Branch Definition

description: Branch name

description: State specific timeouts

description: Actions to be executed in this branch

description: Causes the workflow execution to sleep for a specified duration

description: State name

description: State type

description: State end definition

description: Duration (ISO 8601 duration format) to sleep

description: Next transition of the workflow after the workflow sleep

description: This state is used to wait for events from event sources, then consumes them and invoke one or more actions to run in sequence or parallel

description: State name

description: State type

description: If true consuming one of the defined events causes its associated actions to be performed. If false all of the defined events must be consumed in order for actions to be performed

description: Define the events to be consumed and optional actions to be performed

description: State specific timeouts

description: State data filter

description: States error handling definitions

description: Next transition of the workflow after all the actions have been performed

description: State end definition

description: Unique Name of a workflow state which is responsible for compensation of this state

description: Defines actions be performed. Does not wait for incoming events

description: State name

description: State type

description: State end definition

description: State data filter

description: Specifies whether actions are performed in sequence or in parallel

description: Actions to be performed

description: State specific timeouts

description: States error handling definitions

description: If true, this state is used to compensate another state. Default is false

description: Consists of a number of states that are executed in parallel

description: State name

description: State type

description: State end definition

description: State data filter

description: State specific timeouts

description: Branch Definitions

description: Option types on how to complete branch execution.

description: Used when completionType is set to 'atLeast' to specify the minimum number of branches that must complete before the state will transition.

description: States error handling definitions

description: Next transition of the workflow after all branches have completed execution

description: Permits transitions to other states based on events

description: State name

description: State type

description: State data filter

description: State specific timeouts

description: Defines conditions evaluated against events

description: States error handling definitions

description: Default transition of the workflow if there is no matching data conditions. Can include a transition or end definition

required: name type eventConditions defaultCondition

description: Permits transitions to other states based on data conditions

description: State name

description: State type

description: State data filter

description: State specific timeouts

description: Defines conditions evaluated against state data

description: States error handling definitions

required: name type dataConditions defaultCondition

description: DefaultCondition definition. Can be either a transition or end definition

description: The optional name of the default condition, used solely for display purposes

description: Switch state data event condition

description: Event condition name

description: References an unique event name in the defined workflow events

description: Next transition of the workflow if there is valid matches

description: Event data filter definition

description: Switch state data event condition

description: Event condition name

description: Explicit transition to end

description: Event data filter definition

description: Switch state data based condition

description: Data condition name

description: Workflow expression evaluated against state data. Must evaluate to true or false

description: Workflow transition if condition is evaluated to true

description: Switch state data based condition

description: Data condition name

description: Workflow end definition

description: Inject static data into state data. Does not perform any actions

description: State name

description: State type

description: State end definition

description: JSON object which can be set as states data input and can be manipulated via filters

description: State data filter

description: Next transition of the workflow after injection has completed

description: Execute a set of defined actions or workflows for each element of a data array

description: State name

description: State type

description: State end definition

description: Workflow expression selecting an array element of the states data

description: Workflow expression specifying an array element of the states data to add the results of each iteration

description: Name of the iteration parameter that can be referenced in actions/workflow. For each parallel iteration, this param should contain an unique element of the inputCollection array

description: Specifies how many iterations may run in parallel at the same time. Used if 'mode' property is set to 'parallel' (default)

description: Actions to be executed for each of the elements of inputCollection

description: State specific timeouts

description: State data filter

description: States error handling definitions

description: Next transition of the workflow after state has completed

description: Specifies how iterations are to be performed (sequentially or in parallel)

required: name type inputCollection actions transition

description: This state performs an action, then waits for the callback event that denotes completion of the action

description: State name

description: State type

description: Defines the action to be executed

description: References an unique callback event name in the defined workflow events

description: State specific timeouts

description: Event data filter

description: State data filter

description: States error handling definitions

description: State end definition

description: Name of the starting workflow state

description: Workflow start definition

description: Name of the starting workflow state

description: Define the time/repeating intervals or cron at which workflow instances should be automatically started.

description: Time interval (must be repeating interval) described with ISO 8601 format. Declares when workflow instances will be automatically created.  (UTC timezone is assumed)

description: Start state schedule definition

description: Timezone name used to evaluate the interval & cron-expression. (default: UTC)

description: State end definition

description: State end definition

description: If true, completes all execution flows in the given workflow instance

description: Defines events that should be produced

description: If set to true, triggers workflow compensation. Default is false

description: Produce an event and set its data

description: References a name of a defined event

description: If String, expression which selects parts of the states data output to become the data of the produced event. If object a custom object to become the data of produced event.

description: Add additional event extension context attributes

description: Workflow expression to filter the state data input

description: Workflow expression that filters the state data output

description: If set to false, event payload is not added/merged to state data. In this case 'data' and 'toStateData' should be ignored. Default is true.

description: Workflow expression that filters the received event payload (default: '${ . }')

description: Workflow expression that selects a state data element to which the filtered event should be added/merged into. If not specified, denotes, the top-level state data element.

description: Workflow expression that selects state data that the state action can use

description: If set to false, action data results are not added/merged to state data. In this case 'results' and 'toStateData' should be ignored. Default is true.

description: Workflow expression that filters the actions data results

description: Workflow expression that selects a state data element to which the action results should be added/merged into. If not specified, denote, the top-level state data element

description: URI of the JSON Schema used to validate the workflow

description: Workflow data input schema definition

description: The JSON Schema object used to validate the workflow

description: Determines if error should be thrown if there are validation errors


Butane-Schema.json

title: Fedora Coreos Butane Schema

required: variant version

$id: #/properties/variant

title: variant (string):

description: Used to differentiate configs for different operating systems. Must be fcos for this specification.

default: fcos

$id: #/properties/version

title: version (string):


schema-table.json

title: JSON schema for Outblocks database table files

$ref: #/definitions/OutblocksTable

title: OutblocksTable

$ref: #/definitions/Fields

title: Fields

description: The type of the field.

description: Default value of the field.


bpkg.json

description:
Where the dependency is located in `deps/`.

See more: https://github.com/bpkg/bpkg#name

description:
The current version of the dependency.

See more: https://github.com/bpkg/bpkg#version-optional

description:
Human-readable description of the functionality of the package.

See more: https://github.com/bpkg/bpkg#description

description:
Whether the package is only intended be installed as a global script. Allows the omission of the `--global` flag when installing.

See more: https://github.com/bpkg/bpkg#global

description:
Shell script used to invoke in the install script. Required if package is being installed as a global script.

See more: https://github.com/bpkg/bpkg#install-1

default: make install

description: An array of scripts to install into a project. See more: https://github.com/bpkg/bpkg#scripts

description: An array of non-script files to install into a project. See more: https://github.com/bpkg/bpkg#files-optional

description:
Hash of dependencies of this project. Use either a tagged release identifier or `master`.

See more: https://github.com/bpkg/bpkg#dependencies-optional

description:
Hash of development dependencies of this project. Use either a tagged release identifier or `master`.

See more: https://github.com/bpkg/bpkg#dependencies-dev-optional

description:
A hash of runnable commands for `bpkg run`.

See more: https://github.com/bpkg/bpkg#commands-optional

description:
A hash of descriptions for each command in `commands`.

See more: https://github.com/bpkg/bpkg#commands-description-optional

required: name description global install scripts


strings.json

title: strings

description:
Strings of the current application
https://bashly.dannyb.co/advanced/strings/#custom-strings

title: usage

description:
A usage caption of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: Usage:

title: options

description:
An option caption of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: Options:

title: arguments

description:
An argument caption of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: Arguments:

title: commands

description:
A command caption of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: Commands:

title: examples

description:
An example caption of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: Examples:

title: environment variables

description:
An environment variable caption of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: Environment Variables:

title: group

description:
A group caption of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: %{group} Commands:

title: command alias

description:
An alias helper of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: Alias: %{alias}

title: default command summary

description:
A default command summary helper of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: %{summary} (default)

title: required

description:
A required helper of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: (required)

title: repeatable

description:
A repeatable helper of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: (repeatable)

title: default

description:
A default helper of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: Default: %{value}

title: allowed

description:
An allowed helper of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: Allowed: %{values}

title: help flag text

description:
A help flag of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: Show this help

title: version flag text

description:
A version flag of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: Show version number

title: flag requires an argument

description:
A missing flag argument error of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: %{name} requires an argument: %{usage}

title: invalid argument

description:
An invalid argument error of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: invalid argument: %s

title: invalid flag

description:
An invalid option error of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: invalid option: %s

title: invalid command

description:
An invalid command error of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: invalid command: %s

title: conflicting flags

description:
A conflicting options error of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: conflicting options: %s cannot be used with %s

title: missing required argument

description:
A missing required argument error of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: missing required argument: %{arg}\nusage: %{usage}

title: missing required flag

description:
A missing required flag error of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: missing required flag: %{usage}

title: missing required environment variable

description:
A missing required environment variable error of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: missing required environment variable: %{var}

title: missing dependency

description:
A missing dependency error of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: missing dependency: %{dependency}

title: disallowed flag

description:
A forbidden flag error of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: %{name} must be one of: %{allowed}

title: disallowed argument

description:
A forbidden argument error of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

title: unsupported bash version

description:
An unsupported Bash version error of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: bash version 4 or higher is required

title: validation error

description:
A validation error of the current script
https://bashly.dannyb.co/advanced/strings/#custom-strings

default: validation error in %s:\n%s


swa-cli.config.json

description: API folder or Azure Functions emulator address

description: API backend port

description: Location of the build output directory relative to the appLocation

description: Location for the static app source code

description: Time to wait(in ms) for the dev server to start

description: CLI host address

description: set the cli port

description: Run a command at startup

description: Serve the app and API over HTTPS

description: SSL certificate (.crt) to use for serving HTTPS

description: SSL key (.key) to use for serving HTTPS


epr-manifest.json

enum: block allow noAuth

description: Relative path to resource.

description: A regular expression for identifying paths to resources.

enum: navigation image stylesheet script xhr other

description: Determines if data is allowed at this path.

description: A fully qualified URL of your website.

description: Set the max age HTTP cache expiration.

$ref: #/definitions/behavior

$ref: #/definitions/rule

title: JSON schema for Entry Point Regulation manifest files


tenants.json

title: Tenants Configuration

description: The tenants configuration

description: The configuration of a tenant


nest-cli.json

$id: #Configuration

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

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

default: tsc

enum: tsc webpack swc

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

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

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

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

$ref: #/definitions/PluginItems

$ref: #/definitions/AssetsOptions

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

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

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

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

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

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

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

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

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

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

$ref: #/definitions/GenerateSpecOptions

$ref: #/definitions/GenerateFlatOptions

$ref: #/definitions/GenerateBaseDirOptions

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

type: boolean object

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

description: Generate spec file for application schematics or not.

description: Disable spec file generation for class schematics.

description: Alias for class

description: Generate spec file for configuration schematics or not.

description: Alias for configuration

description: Generate spec file for controller schematics or not.

description: Alias for controller

description: Generate spec file for decorator schematics or not.

description: Alias fro decorator

description: Generate spec file for filter schematics or not.

description: Alias for filter

description: Generate spec file for gateway schematics or not.

description: Alias for gateway

description: Generate spec file for guard schematics or not.

description: Alias for guard

description: Generate spec file for interceptor schematics or not.

description: Alias for interceptor

description: Generate spec file for interface schematics or not.

description: Generate spec file for middleware schematics or not.

description: Alias for middleware

description: Generate spec file for module schematics or not.

description: Alias for module

description: Generate spec file for pipe schematics or not.

description: Alias for pipe

description: Generate spec file for provider schematics or not.

description: Alias for provider

description: Generate spec file for resolver schematics or not.

description: Alias for resolver

description: Generate spec file for service schematics or not.

description: Alias for resolver

description: Generate spec file for library schematics or not.

description: Alias for library

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

description: Alias for sub-app

description: Generate spec file for resource schematics or not.

description: Alias for resource

description: Base directory

$ref: #/definitions/CompilerOptions

$ref: #/definitions/GenerateOptions

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

$ref: #/definitions/PluginOptions

$ref: #/definitions/GraphQLPluginOptions

$ref: #/definitions/SwaggerPluginOptions

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

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

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

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

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

default: description

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

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

default: ts

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

default: src

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

default: main

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

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

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

title: Nest CLI configuration


github-workflow.json

$ref: #/definitions/globs

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

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

$ref: #/definitions/expressionSyntax

$ref: #/definitions/configuration

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

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

$ref: #/definitions/env

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

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

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

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

$ref: #/definitions/shell

$ref: #/definitions/working-directory

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

enum: read-all write-all

$ref: #/definitions/permissions-event

$ref: #/definitions/permissions-level

enum: read write none

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

description: The environment that the job references

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

description: A deployment URL

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

enum: linux macos windows

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

$ref: #/definitions/branch

$ref: #/definitions/path

required: branches branches-ignore

required: tags tags-ignore

required: paths paths-ignore

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

enum: bash pwsh python sh cmd powershell

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

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

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

$ref: #/definitions/name

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

description: The name of the job displayed on GitHub.

$ref: #/definitions/jobNeeds

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

type: boolean number string

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

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

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

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

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

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

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

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

description: The name of the job displayed on GitHub.

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

description: The environment that the job references.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

enum: created rerequested completed requested_action

default: created rerequested completed requested_action

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

enum: created updated closed reopened edited deleted

default: created updated closed reopened edited deleted

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

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

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

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

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

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

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

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

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

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

enum: published unpublished created edited deleted prereleased released

default: published unpublished created edited deleted prereleased released

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

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

description: Allows workflows to be reused by other workflows.

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

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

description: A string description of the input parameter.

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

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

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

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

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

description: A string identifier to associate with the secret.

description: A string description of the secret parameter.

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

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

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

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

description: A string representing the type of the input.

enum: string choice boolean number environment

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

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

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

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

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

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

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

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