ntangle.json

title: NTangle - https://github.com/Avanade/ntangle

title: The 'Root' object (database-driven)

description: The 'RootConfig' object defines the global properties that are used to drive the underlying database-driven CDC-oriented code-generation.

title: The default 'Schema' name where the existing tables are defined within the database.

description: This is used as the default 'Schema' for all child objects. Defaults to 'dbo' (literal).

title: The schema name for the _ntangle_ generated 'CDC'-related database artefacts.

description: Defaults to 'NTangle' (literal).

title: Indicates whether to create the 'CdcSchema' within the database.

description: Defaults to 'false'.

title: The table name for the 'Cdc'-VersionTracking.

description: Defaults to 'VersionTracking' (literal).

title: Indicates whether to enable 'Cdc' within the database for the tables that participate.

description: Defaults to 'false'. This option can be overridden for each underlying table referenced.

title: Indicates whether to include the generation of the generic 'CDC'-IdentifierMapping database capabilities.

description: Where set to 'true' each underlying 'Table' and corresponding 'Join' must set 'IdentifierMapping' explicitly.

title: The type for the identifier mapping value.

description: Defaults to 'String'.

enum: String Int Long Guid

title: The table name for the 'Cdc'-IdentifierMapping.

description: Defaults to 'IdentifierMapping' (literal).

title: The stored procedure name for the 'Cdc'-IdentifierMapping create.

description: Defaults to 'spIdentifierMappingCreate' (literal).

title: The column name for the 'IsDeleted' (logical delete) capability (if any).

description: Defaults to 'IsDeleted'.

title: The option to automatically rename the SQL Tables and Columns for use in .NET.

description: Defaults to 'SnakeKebabToPascalCase' which will remove any underscores or hyphens separating each word and capitalize the first character of each; e.g. 'internal-customer_id' would be renamed as 'InternalCustomerId'. The 'PascalCase' option will capatilize the first character only.

enum: None PascalCase SnakeKebabToPascalCase

title: The default list of 'Column' names that should be excluded from the generated ETag (used for the likes of duplicate send tracking)

title: The JSON Serializer to use for JSON property attribution.

description: Defaults to 'SystemText'.

enum: SystemText Newtonsoft

title: The type of service that manages the underlying orchestrator.

description: Defaults to 'None'. A 'HostedService' is an 'IHostedService' implementation enabling long-running execution; whereas, 'Service' is intended for self-managed execution.

enum: None HostedService Service

title: The root for the event name by prepending to all event subject names via CDC.

title: The default formatting for the Subject when an Event is published via CDC.

description: Defaults to 'NameOnly'.

enum: NameOnly NameAndKey NameAndTableKey

title: The formatting for the Action when an Event is published via CDC.

description: Defaults to 'None' (no formatting required, i.e. as-is).

title: The URI kind for the event source URIs for CDC.

description: Defaults to 'Relative' (being a relative path).

enum: None Absolute Relative RelativeOrAbsolute

title: The URI root for the event source by prepending to all event source URIs for CDC.

description: The event source is only updated where an 'EventSourceKind' is not 'None'.

title: The default formatting for the Source when an Event is published via CDC.

description: Defaults to 'NameAndTableKey' (being the child 'Cdc.ModelName' appended with the corresponding table key).

title: The root for the event type by prepending to all event type names via CDC.

description: Used to enable the sending of messages to the likes of EventHubs, Service Broker, Kafka, etc. Defaults to 'EventSubjectRoot'.

title: Indicates whether to generate the event outbox SQL and .NET artefacts.

description: Defaults to 'false'.

title: The schema name of the event outbox table.

description: Defaults to 'Outbox' (literal).

title: Indicates whether to create the 'OutboxSchema' within the database.

description: Defaults to 'false'.

title: The name of the event outbox table.

description: Defaults to 'EventOutbox' (literal).

title: The stored procedure name for the event outbox enqueue.

description: Defaults to 'spEventOutboxEnqueue' (literal).

title: The stored procedure name for the event outbox dequeue.

description: Defaults to 'spEventOutboxDequeue' (literal).

title: The base path (directory) prefix for the Database-related artefacts; other 'Path*' properties append to this value when they are not specifically overridden.

description: Defaults to 'AppName' (runtime parameter). For example 'Avanade.Application'.

title: The path (directory) for the Schema Database-related artefacts.

description: Defaults to 'PathBase' + '.Database' (literal). For example 'Avanade.Application.Database'.

description: Defaults to 'PathDatabase' + '/Schema' (literal). For example 'Avanade.Application.Database/Schema'.

description: Defaults to 'PathDatabase' + '/Migrations' (literal). For example 'Avanade.Application.Database/Migrations'.

title: The path (directory) for the CDC-related (.NET) artefacts.

description: Defaults to 'PathBase' + '.Publisher' (literal). For example 'Avanade.Application.Publisher'.

title: The base Namespace (root) for the .NET artefacts.

title: The Namespace (root) for the CDC-related Publisher .NET artefacts.

description: Defaults to 'NamespaceBase' + '.Publisher' (literal). For example 'Avanade.Application.Publisher'.

title: The Namespace (root) for the Outbox-related Publisher .NET artefacts.

description: Defaults to 'NamespacePublisher'.

title: The corresponding 'Table' collection.

description: A 'Table' object provides the primary database table configuration for Change Data Capture (CDC), including multiple child table joins to form a composite entity.

$ref: #/definitions/Table

title: 'Table' object (database-driven)

description: The 'Table' object enables the definition of the primary table, one-or-more child tables and their respective join relationships, to enable Change Data Capture (CDC) event publishing. The 'IncludeColumns' and 'ExcludeColumns' provide a shorthand to include or exclude selected columns; with the 'AliasColumns' providing a means to rename where required.

title: The name of the primary table.

title: The default schema name used where not otherwise explicitly specified.

description: Defaults to 'Root.Schema'.

title: The name of the primary table.

description: Defaults to 'Name'. This is used to specify the actual underlying database table name (required where the 'Name' has been changed to enable uniqueness).

title: The table alias name (must be unique).

description: Will automatically default where not specified; for example a table named 'Person' will default to 'p'.

title: The list of 'Column' names to be included in the underlying generated output.

description: Where not specified this indicates that all 'Columns' are to be included.

title: The list of 'Column' names to be excluded from the underlying generated output.

description: Where not specified this indicates no 'Columns' are to be excluded.

title: The list of 'Column' and 'Alias' pairs (split by a '^' lookup character) to enable column aliasing/renaming.

description: Each alias value should be formatted as 'Column' + '^' + 'Alias'; e.g. 'PCODE^ProductCode'.

title: The 'CDC' _execute_ batch stored procedure name.

description: Defaults to 'sp' (literal) + 'Name' + 'BatchExecute' (literal); e.g. 'spNameBatchExecute'.

title: The 'CDC' _complete_ batch stored procedure name.

description: Defaults to 'sp' (literal) + 'Name' + 'BatchComplete' (literal); e.g. 'spNameBatchComplete'.

title: The schema name for the generated 'CDC'-related database artefacts.

description: Defaults to 'Root.CdcSchema'.

title: The corresponding 'CDC' Batch tracking table name.

description: Defaults to 'Name' + 'BatchTracking' (literal).

title: The .NET model name.

description: Defaults to 'Name'.

title: The list of additional (non-default) Dependency Injection (DI) parameters for the generated CDC 'Orchestrator' constructor.

description: Each constructor parameter should be formatted as 'Type' + '^' + 'Name'; e.g. 'IConfiguration^Config'. Where the 'Name' portion is not specified it will be inferred.

title: The .NET database 'IDatabase' Type name used in the constructor for Dependency Injection (DI).

description: Defaults to 'IDatabase'.

title: The list of 'Column' names that should be included (in addition to the primary key) for a logical delete.

description: Where a column is not specified in this list its corresponding .NET property will be automatically cleared by the 'CdcDataOrchestrator' as the data is technically considered as non-existing.

description: Defaults to 'Root.Service'. A 'HostedService' is an 'IHostedService' implementation enabling long-running execution; whereas, 'Service' is intended for self-managed execution.

title: The list of 'Column' names that should be excluded from the generated ETag (used for the likes of duplicate send tracking).

description: Defaults to 'Root.CdcExcludeColumnsFromETag'.

title: The list of 'Column' names that represent the tenant identifier.

title: The partition key.

description: A partition key can be specified using either 'PartitionKey' or 'PartitionKeyColumns'.

title: The list of 'Column' names that represent the partition key.

title: The Event Source.

description: Defaults to 'Schema' + '/' (literal) + 'Name' (as lowercase). Note: when used in code-generation the 'Root.EventSourceRoot' will be prepended where specified.

title: The default formatting for the Source when an Event is published.

description: Defaults to 'Root.EventSourceFormat'.

title: The Event Subject.

description: Defaults to 'ModelName'. Note: when used in code-generation the 'Root.EventSubjectRoot' will be prepended where specified.

title: The default formatting for the Subject when an Event is published.

description: Defaults to 'Root.EventSubjectFormat'.

title: The Event Type.

description: Defaults to 'ModelName'. Note: when used in code-generation the 'Root.EventTypeRoot' will be prepended where specified.

title: Indicates whether to perform Identifier Mapping (mapping to 'GlobalId') for the primary key.

description: This indicates whether to create a new 'GlobalId' property on the _entity_ to house the global mapping identifier to be the reference outside of the specific database realm as a replacement to the existing primary key column(s).

title: The JSON name for the 'GlobalId' property where 'IdentifierMapping' is 'true'. Defaults to 'globalId'.

description: Defaults to 'Root.ColumnIsDeleted'.

title: The corresponding 'Join' collection.

description: A 'Join' object provides the configuration for a table join.

$ref: #/definitions/Join

title: The corresponding 'Where' collection.

description: A 'Where' object provides the configuration for a table where clause.

$ref: #/definitions/Where

title: The corresponding 'TableMapping' collection.

$ref: #/definitions/TableMapping

title: 'Join' object (database-driven)

description: The 'Join' object defines a join to another (or same) table within the logical CDC entity.  The 'IncludeColumns' and 'ExcludeColumns' provide a shorthand to include or exclude selected columns; with the 'AliasColumns' providing a means to rename where required.

title: The unique name.

description: A unique name is required where the same 'Table' is referenced more than once within a logical CDC entity. However, generally, this will represent the unique name of the table within the database.

title: The schema name of the table to join.

description: Defaults to 'Cdc.Schema'; i.e. same schema.

title: The name of the table to join.

title: The 'Schema' and 'Table' alias name.

description: Will automatically default where not specified.

title: The SQL join type.

description: Defaults to 'Cdc'. The 'Cdc' value indicates this is a related secondary table (within a logical CDC entity) that also has Change Data Capture turned on and equally needs to be monitored for changes.

enum: Cdc Inner Left Right Full

title: The name of the table to join to (must be previously specified).

description: Defaults to parent 'Table.Name'.

title: The join cardinality being whether there is a One-to-Many or One-to-One relationship.

description: Defaults to 'OneToMany'. This represents the Parent ('JoinTo') to child (_this_) relationship.

title: The query size multiplier for the CDC-Join.

description: Defaults to '1.0'. This is applied to the execute stored procedure '@MaxQuerySize' parameter to allow tailoring on the join query ('TOP') sizes to optimize selection. Must be greater than zero and less than or equal to 100.

title: The list of 'Column' and 'Alias' pairs (split by a '^' lookup character) to enable column renaming.

title: The .NET model name.

description: Defaults to 'Name'.

title: The .NET property name.

description: Defaults to 'Model' where 'JoinCardinality' is 'OneToOne'; otherwise, it will be the 'Model' pluralized.

description: Defaults to 'CodeGeneration.CdcExcludeColumnsFromETag'.

title: The corresponding 'JoinOn' collection.

title: The corresponding 'JoinMapping' collection.

title: 'JoinOn' object (database-driven)

description: The 'JoinOn' object defines the join on characteristics for a 'Join' object.

title: The name of the join column (from the 'Join' table).

title: The name of the join to column.

description: Defaults to 'Name'; i.e. assumes same name.

title: The SQL statement for the join on bypassing the corresponding 'ToColumn' specification.

title: 'JoinMapping' object (database-driven)

description: The 'JoinMapping' object defines one or more related table identifier mappings.

title: The name of of the existing column that requires identifier mapping.

title: The schema name of the related table.

description: Defaults to the owning (parent) table schema.

title: The name of the related table.

title: 'Where' object (database-driven)

description: This should only be used where the column value is largely immutable; otherwise, unintended side-effects may occur. _NTangle_ uses the condition explictily and does not attempt to handle value change to infer creation or deletion of data as a result of the underlying change; as such, this should be used cautiously. Note that the 'where' is applied when querying the 'cdc.fn_cdc_get_all_changes_...' function, not the underlying table itself.

title: The column name.

description: The column name.

title: The where nullability clause operator

description: This enables statements such as 'WHERE (COL IS NULL)' or 'WHERE (COL IS NULL OR COL = VALUE)' (where .

title: The where clause equality operator

description: Defaults to 'EQ' where 'Value' is specified.

title: The comparison value

description: This must be valid formatted/escaped SQL.

title: 'TableMapping' object (database-driven)

description: The 'TableMapping' object defines one or more related table identifier mappings.

title: The schema name of the related table.

title: The name of the related table.


mycode.json

enum: MyCode LibraryCode UnrelatedCode

type: array

type: string

description: Script that is executed by passing a string to the host-provided eval function.

default: MyCode

$ref: #/definitions/classification

description: Script that is executed by passing a string to the 'Function' constructor.

default: LibraryCode

description: Script that is executed by passing a string to the 'setTimeout', 'setImmediate', or 'setInterval' functions.

default: UnrelatedCode

description: An array of urls or files that are classified as 'MyCode'.

$ref: #/definitions/includes

description: An array of urls or files that are classified as 'LibraryCode'.

description: An array of urls or files that are classified as 'UnrelatedCode'.

title: JSON schema for mycode.js files

type: object


nlu.schema.json

title: JSON schema for NLU (npm-link-up) library.

type: boolean

$ref: #/definitions/PackagesMap


mimetypes.json

description: A file extension

title: Mime types


ort-configuration-schema.json

title: ORT configuration

description: The main configuration file for the OSS-Review-Toolkit (ORT). A full list of all available options can be found at https://github.com/oss-review-toolkit/ort/blob/main/model/src/main/resources/reference.yml.

$ref: #/definitions/LicenseFilePatterns

$ref: #/definitions/Severity

$ref: #/definitions/Analyzer

$ref: #/definitions/Advisor

$ref: #/definitions/Downloader

$ref: #/definitions/Scanner

$ref: #/definitions/Reporter

$ref: #/definitions/Notifier

$ref: #/definitions/NexusIq

$ref: #/definitions/OssIndex

$ref: #/definitions/VulnerableCode

$ref: #/definitions/GitHubDefects

$ref: #/definitions/Osv

$ref: #/definitions/AdvisorOptions

type: integer

format: uri

$ref: #/definitions/SourceCodeOrigins

$ref: #/definitions/Mail

$ref: #/definitions/Jira

$ref: #/definitions/ReporterOptions

$ref: #/definitions/Archive

$ref: #/definitions/DetectedLicenseMapping

$ref: #/definitions/FileListStorage

$ref: #/definitions/ScannerOptions

$ref: #/definitions/Storages

$ref: #/definitions/StorageTypes

$ref: #/definitions/ProvenanceStorage

$ref: #/definitions/FileStorage

$ref: #/definitions/PostgresConfig


codeship-services.json

$ref: #/definitions/ExternalService

title: CodeShip Pro Service

description: The definition of a service in a CodeShip Pro build, which can have steps run on it or have other services depend on it

description: If true, the docker socket will be exposed in this service.

description: How to build the image for this service. Mutually exclusive with 'image'. Can either be just a path containing a Dockerfile, or a build definition.

$ref: #/definitions/externalBuild

description: Whether the image for this service should be rebuilt from scratch for each run, or if the latest build of the service's image from the configured cache branch (defaulting to 'master') should be used.

description: The command to run when launching the service, overriding the 'CMD' in the image. Optional.

description: The branch to use for caching. Defaults to 'master'

description: The name of another defined service that provides the Docker configuration for building and running this service. Optional.

description: A specific Dockerfile to use, rather than the one in the build context

description: The location of a Docker configuration file encrypted by Jet to be used with building and running this service. Optional.

description: The location of one or more files, encrypted with Jet, containing environment variables to be made available to this service and steps running on it. Optional.

description: A list of encrypted key/value pairs to be used in the environment for this service and steps running on it. Optional.

description: The location of one or more files containing environment variables to be made available to this service and steps running on it. Optional.

description: Either a map of key/value pairs or a list of 'KEY=VALUE' pairs to be used in the environment for this service and steps running on it. Optional.

description: A pre-existing image to use for this service. Mutually exclusive with 'build'

description: A list of other services that this service depends on. Use this instead of 'links'

description: A list of ports that should be exposed to other services. The ports should be defined like '9999', as strings

description: A list of origin/destination pairs of directories or files relative to the build context and where they should be mounted in the service. Optional.

description: A list of other services which should have their defined volumes mounted into this service as well. Optional.

title: Image Build

description: Configuration of how to build the image for this service

description: DEPRECATED: Use 'context' instead.

description: DEPRECATED: Use 'dockerfile' instead

description: The output image name for this image. Optional.

description: The directory used as the Docker build context. Defaults to the same directory as the codeship-services.yml file

description: A specific Dockerfile to use rather than the 'Dockerfile' present in the build context. Optional.

$ref: #/definitions/externalBuildConfigure

description: Build args to pass to Docker. Optional.

description: One or more files, encrypted with Jet, to have their contents decrypted and passed to Docker as build args. Optional.

description: A list of encrypted key/value pairs to be used as build args to Docker. Optional.

description: codeship-services.yml is where you configure each service you need to run your CI/CD builds with CodeShip.

title: CodeShip Pro services configuration


description: The package unique identifier

description: The package version

description: The package meta-data locale

description: Optional Url type

description: Package moniker or tag

description: The distribution channel

title: Platform

description: The installer supported operating system

description: The installer minimum operating system version

enum: msix msi appx exe zip inno nullsoft wix burn pwa

description: Enumeration of supported installer types

enum: user machine

description: Scope indicates if the installer is per user or per machine

title: InstallModes

enum: interactive silent silentWithProgress

description: List of supported installer modes

description: Silent is the value that should be passed to the installer when user chooses a silent or quiet install

description: SilentWithProgress is the value that should be passed to the installer when user chooses a non-interactive install

description: Interactive is the value that should be passed to the installer when user chooses an interactive install

description: InstallLocation is the value passed to the installer for custom install location. <INSTALLPATH> token can be included in the switch value so that winget will replace the token with user provided path

description: Log is the value passed to the installer for custom log file path. <LOGPATH> token can be included in the switch value so that winget will replace the token with user provided path

description: Upgrade is the value that should be passed to the installer when user chooses an upgrade

description: Custom switches will be passed directly to the installer by winget

description: List of additional non-zero installer success exit codes other than known default values by winget

enum: install uninstallPrevious

description: The upgrade method

description: List of commands or aliases to run the package

description: List of protocols the package provides a handler for

description: List of file extensions the package could support

description: List of Windows feature dependencies

description: List of Windows library dependencies

$ref: #/definitions/PackageIdentifier

$ref: #/definitions/PackageVersion

description: List of package dependencies from current source

description: List of external package dependencies

description: PackageFamilyName for appx or msix installer. Could be used for correlation of packages across sources

description: ProductCode could be used for correlation of packages across sources

description: List of appx or msix installer capabilities

description: List of appx or msix installer restricted capabilities

$ref: #/definitions/Locale

$ref: #/definitions/Platform

$ref: #/definitions/MinimumOSVersion

description: The installer target architecture

$ref: #/definitions/InstallerType

$ref: #/definitions/Scope

description: The installer Url

description: Sha256 is required. Sha256 of the installer

description: SignatureSha256 is recommended for appx or msix. It is the sha256 of signature file inside appx or msix. Could be used during streaming install if applicable

$ref: #/definitions/InstallModes

$ref: #/definitions/InstallerSwitches

$ref: #/definitions/InstallerSuccessCodes

$ref: #/definitions/UpgradeBehavior

$ref: #/definitions/Commands

$ref: #/definitions/Protocols

$ref: #/definitions/FileExtensions

$ref: #/definitions/Dependencies

$ref: #/definitions/PackageFamilyName

$ref: #/definitions/ProductCode

$ref: #/definitions/Capabilities

$ref: #/definitions/RestrictedCapabilities

description: A representation of a single-file manifest representing an app in the OWC. v1.0.0

description: The package meta-data locale

description: The publisher name

$ref: #/definitions/Url

description: The publisher home page

description: The publisher support page

description: The publisher privacy page or the package privacy page

description: The package author

description: The package name

description: The package home page

description: The package license

description: The license page

description: The package copyright

description: The package copyright page

description: The short package description

description: The full package description

$ref: #/definitions/Tag

description: The most common package term

description: List of additional package search terms

$ref: #/definitions/Channel

$ref: #/definitions/Installer

default: singleton

const: singleton

description: The manifest type

description: The manifest syntax version

required: PackageIdentifier PackageVersion PackageLocale Publisher PackageName License ShortDescription Installers ManifestType ManifestVersion


schema-app.json

title: JSON schema for Outblocks App configuration files

$ref: #/definitions/OutblocksApp

title: OutblocksApp

description: Name of the app. Defaults to directory name.

description: Type of the app.

enum: static function service

description: Environment variables common for all operations.

description: Working directory of the app where all commands will be run. Defaults to location of this yaml. All other dirs will be relative to this one.

description: External URL of the app.

description: Path redirect rewrites URL to specified path. URL path from 'url' field will be stripped and replaced with value below.

description: Application dependencies to inject.

$ref: #/definitions/Needs

description: Run config used for dev builds during run.

$ref: #/definitions/Run

description: CDN settings.

$ref: #/definitions/CDN

const: static

description: Routing type. Defaults to 'react'.

enum: react gatsby disabled

description: Remove trailing slash with permanent redirect. Currently used only for deployments. Defaults to 'true' when gatsby routing is used, 'false' otherwise.

description: Static application basic authentication config. Currently used only for deployments.

$ref: #/definitions/StaticBasicAuth

description: Static application build config used for deployment builds.

$ref: #/definitions/StaticBuild

description: Static deploy config.

$ref: #/definitions/StaticDeploy

const: service

description: Marks app as private - won't allow unauthenticated access.

description: Service application build config used for deployment builds.

$ref: #/definitions/ServiceBuild

description: Service application container config used for docker based deployments/runs.

$ref: #/definitions/ServiceContainer

description: Service deploy config.

$ref: #/definitions/ServiceDeploy

description: Service scheduler config.

$ref: #/definitions/Scheduler

const: function

description: The runtime in which the function is going to run, refer to cloud provider docs for possible options.

description: Name of the function that will be executed when the function is triggered. Not all deployment plugins support it. Defaults to application name.

description: Function application build config used for deployment builds.

$ref: #/definitions/FunctionBuild

description: Function deploy config.

$ref: #/definitions/FunctionDeploy

description: Function package config.

$ref: #/definitions/FunctionPackage

description: Function scheduler config.

title: Needs

title: Run config

description: Run plugin override. Defaults to first supported plugin available.

description: Command to be run to for dev mode.

description: Port override, by default just assigns next port starting from listen-port.

description: Additional environment variables available local run.

title: Static deploy config

description: Deploy plugin override. Defaults to first supported plugin available.

description: Minimum scale of container deployment (used if deployment uses a container).

description: Maximum scale of container deployment (used if deployment uses a container).

description: Execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period.

description: File/dir patterns to exclude (or force include if starts with '!').

title: Service deploy config

description: Additional environment variables.

description: CPU limit of container deployment. 1.0 means 1 full core of CPU will be used.

type: number

description: Memory limit in MiB of container deployment.

description: Minimum scale of container deployment.

description: Maximum scale of container deployment.

description: Service application container config used for docker based deployments.

title: Scheduler config

description: Scheduler cron, e.g. */30 * * * * runs every 30 minutes.

description: Name of cron (just for information purpose).

description: HTTP method to use. Defaults to 'GET'.

enum: GET POST HEAD PUT DELETE PATCH OPTIONS

description: Path to call in current app url.

description: Additional headers to use for this call.

title: Function deploy config

description: Additional environment variables.

description: Memory limit in MiB of function deployment.

title: Function package config

description: Package patterns to exclude (or force include if starts with '!').

title: CDN

title: Static app basic auth config

description: Basic auth realm name, defaults to 'restricted'.

description: Basic auth users in form of `user: password` where password is either in plain text or in a form of apr1 hash (used by htpasswd).

title: Build static app

description: Additional environment variables available during build.

description: Command to be run to generate output files.

description: Output dir to where static files end up.

title: Service app build definition

description: Docker image to use. If specified, will try to pull this image if skip-build is enabled.

description: Skip this image build phase. If enabled, requires image to be either present on docker host or custom image to be possible to pull.

description: Skip this image dependencies pull phase. As a result, doesn't check for newer versions of tagged dependencies. Useful if dependencies do not exist outside of local docker.

description: Docker build-args.

description: Docker context directory, relative to application dir.

description: Dockerfile to use, relative to context path. Defaults to 'Dockerfile'.

title: Build function app

description: Output dir to where built files end up.

title: Service app container definition

description: Docker container port to use.

description: Docker command (CMD) to override.

description: Docker entrypoint (ENTRYPOINT) to override.


powerpages-web-template-manifest.json

type: functional

displayName: Card Template

description: renders the gallery card

displayName: Display name

description: Main heading of the web template

displayName: Items per row

description: No of items to be displayed per row

type: table

displayName: Select table

title: type

description: The web template type. Use 'functional' for custom site components and 'layout' for custom layouts.

enum: functional layout

description: The display name of the web template

description: The description of the web template

description: An array of table logical names that are used in the web template

title: params

description: The editable properties of the web template. These will be customizable in Studio

title: id

description: The id of the param. This correlates with the liquid tag's key for this property

examples: name count specifiedTable

description: The label displayed when editing a property in Studio. If no displayName is given, the label will fallback on the id

examples:
Display name
Items per row
Selected table

description: The description to be displayed in the tooltip when editing a property in Studio. If no description is given, no tooltip will be displayed

examples:
Main heading of the web template
No of items to be displayed per row

description: Used to specify a property that correlates to a table's logical name

description: Main heading of the web template

description: Main heading of the web template

description: No of items to be displayed per row

title: Root Schema


httpmockrc.json

description: A tool for mock local requests or proxy remote requests.

default: mocks

description: Root of mock files

description: Custom request header

description: Custom response header

description: Parse post body by express.json()

description: Rules for proxy and mock

description: Rule of Matching route

description: Where Mock result file located

description: Whether to ignore this rule, generally used for remote interfaces instead of mock in the local

description: How many milliseconds are delayed to return a request, general used for control the request sequence

description: Validate params in body by key and typeof value

required: mockFileName routes

title: Http-mocker configuration.


minecraft-loot-table.json

title: Type

description: The number provider type.

enum: minecraft:constant minecraft:uniform minecraft:binomial minecraft:score

description: A constant value.

title: Value

description: The exact value.

description: A random number following a uniform distribution between two values (inclusive).

title: Minimum

description: The minimum value.

type: number object

$ref: #/definitions/numberProvider

title: Max

description: The maximum value.

description: A random number following a binomial distribution.

title: n

description: The amount of trials.

type: integer object

title: p

description: The probability of success on an individual trial.

description: A scoreboard value.

title: Target

description: Scoreboard name provider.

type: string object

title: Type

description: Resource location.

enum: fixed context

const: fixed

title: Name

description: A UUID or player name.

const: context

title: Target

title: Score

description: The scoreboard objective.

title: Scale

description: Scale to multiply the score before returning it.

description: Configuration file defining a loot table for a data pack for Minecraft.

title: Type

enum: minecraft:empty empty minecraft:entity entity minecraft:block block minecraft:chest chest minecraft:fishing fishing minecraft:gift gift minecraft:advancement_reward advancement_reward minecraft:barter barter minecraft:command command minecraft:selector selector minecraft:advancement_entity advancement_entity minecraft:generic generic

title: Functions

description: Applies functions to all item stacks produced by this table. Functions are applied in order, so for example looting_enchant must be after set_count to work correctly.

description: A function.

title: Function

description: Namespaced ID of the function to apply.

title: Conditions

description: Determines conditions for this function to be applied. If multiple conditions are specified, all must pass.

description: A function.

title: Condition

description: Namespaced ID of condition.

title: Pools

description: A list of all pools for this loot table. Each pool used generates items from its list of items based on the number of rolls. Pools are applied in order.

description: A pool.

title: Conditions

description: Determines conditions for this pool to be used. If multiple conditions are specified, all must pass.

description: A condition.

title: Condition

description: Namespaced ID of condition.

title: Functions

description: Applies functions to all item stacks produced by this pool. Functions are applied in order, so for example looting_enchant must be after set_count to work correctly.

description: A function.

title: Function

description: Namespaced ID of the function to apply.

title: Conditions

description: A condition.

title: Condition

description: Namespaced ID of condition.

title: Rolls

description: Specifies the number of rolls on the pool.

title: Bonus Rolls

description: Specifies the number of bonus rolls on the pool per point of luck. Rounded down after multiplying.

title: Entries

description: A list of all things that can be produced by this pool. One entry is chosen per roll as a weighted random selection from all entries without failing conditions.

description: An entry.

title: Conditions

description: Determines conditions for this entry to be used. If multiple conditions are specified, all must pass.

description: A condition.

title: Condition

description: Namespaced ID of condition.

title: Functions

description: Applies functions to the item stack or item stacks being produced. Functions are applied in order, so for example looting_enchant must be after set_count to work correctly.

description: A function.

title: Function

description: Namespaced ID of the function to apply.

title: Conditions

description: A condition.

title: Condition

description: Namespaced ID of condition.

title: Type

description: Namespaced ID type of entry.

enum: minecraft:item minecraft:tag minecraft:loot_table minecraft:group minecraft:alternatives minecraft:sequence minecraft:dynamic minecraft:empty

title: Name

title: Children

title: Expand

description: For type 'tag', if set to true, it chooses one item of the tag, each with the same weight and quality. If false, it generates one of each of the items in the tag.

title: Weight

description: Determines how often this entry is chosen out of all the entries in the pool. Entries with higher weights are used more often (chance is this entry's weight⁄total of all considered entries' weights).

title: Quality

description: Modifies the entry's weight based on the killing/opening/fishing player's luck attribute. Formula is floor( weight + (quality * generic.luck)).

title: Minecraft Data Pack Loot Table


tokenlist.schema.json

title: Uniswap Token List

description: Schema for lists of tokens compatible with the Uniswap Interface

description: The version of the list, used in change detection

description: The major version of the list. Must be incremented when tokens are removed from the list or token addresses are changed.

description: The minor version of the list. Must be incremented when tokens are added to the list.

description: The patch version of the list. Must be incremented for any changes to the list.

required: major minor patch

description: The unique identifier of a tag

examples: compound stablecoin

description: The name of a token extension property

examples: color is_fee_on_transfer aliases

description: An object containing any arbitrary or vendor-specific token metadata

$ref: #/definitions/ExtensionIdentifier

$ref: #/definitions/ExtensionValue

$ref: #/definitions/ExtensionPrimitiveValue

description: Definition of a tag that can be associated with a token via its identifier

description: The name of the tag

description: A user-friendly description of the tag

required: name description

Stablecoin

description: A token with value pegged to another asset

description: Metadata for a single token in a token list

description: The chain ID of the Ethereum network where this token is deployed

description: The checksummed address of the token on the specified chain ID

description: The number of decimals for the token balance

description: The name of the token

description: The symbol for the token

description: A URI to the token logo asset; if not set, interface will attempt to find a logo based on the token address; suggest SVG or PNG of size 64x64

description: An array of tag identifiers associated with the token; tags are defined at the list level

$ref: #/definitions/TagIdentifier

examples: stablecoin compound

$ref: #/definitions/ExtensionMap

required: chainId address decimals name symbol

description: The name of the token list

format: date-time

description: The timestamp of this list version; i.e. when this immutable version of the list was created

$ref: #/definitions/Version

description: The list of tokens included in the list

$ref: #/definitions/TokenInfo

description: A mapping of key 'chainId_tokenAddress' to its corresponding token object

Uniswap

symbol: UNI

description: Keywords associated with the contents of the list; may be used in list discoverability

description: A keyword to describe the contents of the list

examples:
compound
lending
personal tokens

description: A mapping of tag identifiers to their name and description

$ref: #/definitions/TagDefinition

description: A URI for the logo of the token list; prefer SVG or PNG of size 256x256

required: name timestamp version tokens


theme.json

title: JSON schema for WordPress block theme global settings and styles

description: Settings related to the lightbox behavior.

description: Allow users to enable the lightbox behavior.

description: Set lightbox animation. Possible values: `fade`, `zoom`, `''` (empty string).

enum: fade zoom

description: A reference to another property value. e.g. `styles.color.text`

description:
Setting that enables the following UI tools:

- border: color, radius, style, width
- color: link
- dimensions: minHeight
- position: sticky
- spacing: blockGap, margin, padding
- typography: lineHeight

description:
_**Note:** Since WordPress 6.1._

Enables root padding (the values from `styles.spacing.padding`) to be applied to the contents of full-width blocks instead of the root block.

Please note that when using this setting, `styles.spacing.padding` should always be set as an object with `top`, `right`, `bottom`, `left` values declared separately.

description: Settings related to borders.

description: Allow users to set custom border colors.

description: Allow users to set custom border radius.

description: Allow users to set custom border styles.

description: Allow users to set custom border widths.

description: Settings related to shadows.

description: Allow users to choose shadows from the default shadow presets.

description:
Shadow presets for the shadow picker.
Generates a single custom property (`--wp--preset--shadow--{slug}`) per preset value.

description: Name of the shadow preset, translatable.

description: Kebab-case unique identifier for the shadow preset.

description: CSS box-shadow value

required: name slug shadow

description: Settings related to colors.

description: Allow users to set background colors.

description: Allow users to select custom colors.

description: Allow users to create custom duotone filters.

description: Allow users to create custom gradients.

description: Allow users to choose filters from the default duotone filter presets.

description: Allow users to choose colors from the default gradients.

description: Allow users to choose colors from the default palette.

description:
Duotone presets for the duotone picker.
Doesn't generate classes or properties.

description: Name of the duotone preset, translatable.

description: Kebab-case unique identifier for the duotone preset.

description: List of colors from dark to light.

description: CSS hex or rgb string.

required: name slug colors

description:
Gradient presets for the gradient picker.
Generates a single class (`.has-{slug}-background`) and custom property (`--wp--preset--gradient--{slug}`) per preset value.

description: Name of the gradient preset, translatable.

description: Kebab-case unique identifier for the gradient preset.

description: CSS gradient string.

required: name slug gradient

description: Allow users to set link colors.

description:
Color palette presets for the color picker.
Generates three classes (`.has-{slug}-color`, `.has-{slug}-background-color`, and `.has-{slug}-border-color`) and a single custom property (`--wp--preset--color--{slug}`) per preset value.

description: Name of the color preset, translatable.

description: Kebab-case unique identifier for the color preset.

description: CSS hex or rgb(a) string.

required: name slug color

description: Allow users to set text colors.

description: Settings related to dimensions.

description: Allow users to set custom minimum height.

description: Settings related to layout.

description: Sets the max-width of the content.

description: Sets the max-width of wide (`.alignwide`) content. Also used as the maximum viewport when calculating fluid font sizes

description: Disable the layout UI controls.

description: Settings related to position.

description: Allow users to set sticky position.

description: Settings related to spacing.

description:
Enables `--wp--style--block-gap` to be generated from styles.spacing.blockGap.
A value of `null` instead of `false` further disables layout styles from being generated.

description: Allow users to set a custom margin.

description: Allow users to set a custom padding.

description: List of units the user can use for spacing values.

default: px em rem vh vw %

description: Allow users to set custom space sizes.

description:
Space size presets for the space size selector.
Generates a custom property (`--wp--preset--spacing--{slug}`) per preset value.

description: Name of the space size preset, translatable.

description: Unique identifier for the space size preset. For best cross theme compatibility these should be in the form '10','20','30','40','50','60', etc. with '50' representing the 'Medium' size step.

description: CSS space-size value, including units.

description:
Settings to auto-generate space size presets for the space size selector.
Generates a custom property (--wp--preset--spacing--{slug}`) per preset value.

description: With + or * depending on whether scale is generated by increment or multiplier.

description: The amount to increment each step by.

description: Number of steps to generate in scale.

description: The value to medium setting in the scale.

description: Unit that the scale uses, eg. rem, em, px.

enum: px em rem vh vw %

default: rem

description: Settings related to typography.

description: Allow users to set custom font sizes.

description: Allow users to set custom font styles.

description: Allow users to set custom font weights.

description: Enables fluid typography and allows users to set global fluid typography parameters.

description: Allow users to set a global minimum font size boundary in px, rem or em. Custom font sizes below this value will not be clamped, and all calculated minimum font sizes will be, at a minimum, this value.

description: Allow users to set custom a max viewport width in px, rem or em, used to set the maximum size boundary of a fluid font size.

description: Allow users to set a custom min viewport width in px, rem or em, used to set the minimum size boundary of a fluid font size.

description: Allow users to set custom letter spacing.

description: Allow users to set custom line height.

description: Allow users to set the number of text columns.

description: Allow users to set custom text decorations.

description: Allow users to set the writing mode.

description: Allow users to set custom text transforms.

description: Enable drop cap.

description:
Font size presets for the font size selector.
Generates a single class (`.has-{slug}-color`) and custom property (`--wp--preset--font-size--{slug}`) per preset value.

description: Name of the font size preset, translatable.

description: Kebab-case unique identifier for the font size preset.

description: CSS font-size value, including units.

description: Specifies the minimum and maximum font size value of a fluid font size. Set to `false` to bypass fluid calculations and use the static `size` value.

description: A min font size for fluid font size calculations in px, rem or em.

description: A max font size for fluid font size calculations in px, rem or em.

description:
Font family presets for the font family selector.
Generates a single custom property (`--wp--preset--font-family--{slug}`) per preset value.

description: Name of the font family preset, translatable.

description: Kebab-case unique identifier for the font family preset.

description: CSS font-family value.

description: Array of font-face declarations.

description: CSS font-family value.

description: CSS font-style value.

description: List of available font weights, separated by a space.

description: CSS font-display value.

description: Paths or URLs to the font files.

description: CSS font-stretch value.

description: CSS ascent-override value.

description: CSS descent-override value.

description: CSS font-variant value.

description: CSS font-feature-settings value.

description: CSS font-variation-settings value.

description: CSS line-gap-override value.

description: CSS size-adjust value.

description: CSS unicode-range value.

description: Generate custom CSS custom properties of the form `--wp--custom--{key}--{nested-key}: {value};`. `camelCased` keys are transformed to `kebab-case` as to follow the CSS property naming schema. Keys at different depth levels are separated by `--`, so keys should not include `--` in the name.

description: Settings related to behaviors.

description: Allow users to enable/disable lightbox.

description: Border styles.

description: Sets the `border-color` CSS property.

description: Sets the `border-radius` CSS property.

description: Sets the `border-top-left-radius` CSS property.

description: Sets the `border-top-right-radius` CSS property.

description: Sets the `border-bottom-left-radius` CSS property.

description: Sets the `border-bottom-right-radius` CSS property.

description: Sets the `border-style` CSS property.

description: Sets the `border-width` CSS property.

description: Sets the `border-top-color` CSS property.

description: Sets the `border-top-style` CSS property.

description: Sets the `border-top-width` CSS property.

description: Sets the `border-right-color` CSS property.

description: Sets the `border-right-style` CSS property.

description: Sets the `border-right-width` CSS property.

description: Sets the `border-bottom-color` CSS property.

description: Sets the `border-bottom-style` CSS property.

description: Sets the `border-bottom-width` CSS property.

description: Sets the `border-left-color` CSS property.

description: Sets the `border-left-style` CSS property.

description: Sets the `border-left-width` CSS property.

description: Color styles.

description: Sets the `background-color` CSS property.

description: Sets the `background` CSS property.

description: Sets the `color` CSS property.

description: Dimensions styles

description: Sets the `min-height` CSS property.

description: Spacing styles.

description: Sets the `--wp--style--block-gap` CSS custom property when settings.spacing.blockGap is true.

description: Margin styles.

description: Sets the `margin-top` CSS property.

description: Sets the `margin-right` CSS property.

description: Sets the `margin-bottom` CSS property.

description: Sets the `margin-left` CSS property.

description: Padding styles.

description: Sets the `padding-top` CSS property.

description: Sets the `padding-right` CSS property.

description: Sets the `padding-bottom` CSS property.

description: Sets the `padding-left` CSS property.

description: Typography styles.

description: Sets the `font-family` CSS property.

description: Sets the `font-size` CSS property.

description: Sets the `font-style` CSS property.

description: Sets the `font-weight` CSS property.

description: Sets the `letter-spacing` CSS property.

description: Sets the `line-height` CSS property.

description: Sets the `column-count` CSS property.

description: Sets the `text-decoration` CSS property.

description: Sets the `writing-mode` CSS property.

description: Sets the `text-transform` CSS property.

description: CSS and SVG filter styles.

description: Sets the duotone filter.

description: Box shadow styles.

description: Outline styles.

description: Sets the `outline-color` CSS property.

description: Sets the `outline-offset` CSS property.

description: Sets the `outline-style` CSS property.

description: Sets the `outline-width` CSS property.

description: Sets custom CSS to apply styling not covered by other theme.json properties.

description: JSON schema URI for theme.json.

description: Version of theme.json to use.

description: Title of the global styles variation. If not defined, the file name will be used.

description: Description of the global styles variation.

description: A list of blocks that have behaviors. This setting controls the display of the Behaviors UI in the block editor.

description:
Settings for the block editor and individual blocks. These include things like:
- Which customization options should be available to the user.
- The default colors, font sizes... available to the user.
- CSS custom properties and class names used in styles.
- And the default layout of the editor (widths and available alignments).

description: Settings defined on a per-block basis.

description: Organized way to set CSS properties. Styles in the top-level will be added in the `body` selector.

description: Styles defined on a per-element basis using the element's selector.

description: Styles defined on a per-block basis using the block's selector.

description: Additional metadata for custom templates defined in the templates folder.

description: Filename, without extension, of the template in the templates folder.

description: Title of the template, translatable.

description: List of post types that can use this custom template.

description: Additional metadata for template parts defined in the parts folder.

description: Filename, without extension, of the template in the parts folder.

description: Title of the template, translatable.

description: The area the template part is used for. Block variations for `header` and `footer` values exist and will be used when the area is set to one of those.

description: An array of pattern slugs to be registered from the Pattern Directory.


enum: direct indirect all production development

description: All explicitly defined dependencies.

description: Dependencies of direct dependencies (also known as sub-dependencies, or transient dependencies).

description: All explicitly defined dependencies. For bundler, pip, composer, cargo, also the dependencies of direct dependencies.

description: Only dependencies in the 'Product dependency group'.

description: Only dependencies in the 'Development dependency group'.

enum: allow deny

enum: lockfile-only auto widen increase increase-if-necessary

description: Only create pull requests to update lockfiles updates. Ignore any new versions that would require package manifest changes.

description: Follow the default strategy described above.

description: Relax the version requirement to include both the new and old version, when possible.

description: Always increase the version requirement to match the new version.

description: Increase the version requirement only when required by the new version.

enum: bundler cargo composer docker elm gitsubmodule github-actions gomod gradle maven mix npm nuget pip pub terraform

enum: monday tuesday wednesday thursday friday saturday sunday

enum: daily weekly monthly

description: Customize which updates are allowed

$ref: #/definitions/dependency-type

description: Assignees to set on pull requests

description: Commit message preferences

default: scope

description: Location of package manifests

description: Ignore certain dependencies or versions

$ref: #/definitions/update-types

description: Allow or deny code execution in manifest files

description: Labels to set on pull requests

description: Milestone to set on pull requests

description: Limit number of open pull requests for version updates

description: Package manager to use

$ref: #/definitions/package-ecosystem

description: Pull request branch name preferences

description: Change separator for PR branch name

description: Disable automatic rebasing

enum: auto disabled

default: auto

description: Reviewers to set on pull requests

description: Schedule preferences

$ref: #/definitions/schedule-interval

$ref: #/definitions/schedule-day

description: Specify an alternative day to check for updates

description: Specify an alternative time of day to check for updates (format: hh:mm)

description: The time zone identifier must be from the Time Zone database maintained by IANA

description: Branch to create pull requests against

description: Update vendored or cached dependencies

description: How to update manifest version requirements

$ref: #/definitions/versioning-strategy

required: package-ecosystem directory schedule

title: registries

description: The top-level registries key is optional. It allows you to specify authentication details that Dependabot can use to access private package registries.

description: Identifies the type of registry.

enum: composer-repository docker-registry git hex-organization hex-repository maven-repository npm-registry nuget-feed python-index rubygems-server terraform-registry

description: The URL to use to access the dependencies in this registry. The protocol is optional. If not specified, https:// is assumed. Dependabot adds or ignores trailing slashes as required.

description: The username that Dependabot uses to access the registry.

description: A reference to a Dependabot secret containing the password for the specified user.

description: A reference to a Dependabot secret containing an access key for this registry.

description: A reference to a Dependabot secret containing an access token for this registry.

description: For registries with type: python-index, if the boolean value is true, pip resolves dependencies by using the specified URL rather than the base URL of the Python Package Index (by default https://pypi.org/simple).

description: Enable ecosystems that have beta-level support

title: Package Ecosystem

description: Element for each one package manager that you want GitHub Dependabot to monitor for new versions

$ref: #/definitions/update

$ref: #/definitions/registry

required: version updates

title: GitHub Dependabot v2 config


dart-test.json

$ref: #/definitions/runnerConfiguration

title: No timeout

description: Indicates that tests should never time out.

title: Exact timeout

description: Exact timeout duration for a test.

title: Multiplicative timeout

description: Timeout is applied as a multiple of the default value (30 seconds)

title: Skip the test if true

title: Reason for skipping the test

description: The executable to run. Can be a plain basename, an absolute path or a relative path on Windows.

title: Settings for browsers and Node.js

title: Extra arguments to the executable

description: The arguments are parsed in the same way as the POSIX shell

$ref: #/definitions/executable

title: Run the browser in headless mode

$ref: #/definitions/timeout

title: Remove internal stack frames

description: This field controls whether or not traces caused by errors are trimmed to remove internal stack frames. This includes frames from the Dart core libraries, the stack_trace package, and the test package itself.

title: Whether stack traces are chained

description: Disabling stack trace chaining will improve performance for heavily async code at the cost of debuggability.

title: Convert JS traces to Dart traces

description: Whether or not stack traces caused by errors while running Dart compiled to JS are converted back to Dart style.

$ref: #/definitions/skip

description: This field controls how many times a test is retried upon failure.

description: Adds additional tags. This is usually used in a tag definition to enable tag inheritance.

$comment: presets and on_os can have different properties when used in a test vs runner configuration. We make runnerConfiguration extend from testConfiguration, so this configuration is used when we're definitely in a non-runner configuration context.

$ref: #/definitions/testConfiguration

description: A preset used in a test configuration can contain test configuration.

description: Applies test options when a specific operating system is used

$comment: Runner configurations are a superset of test configurations

description: Filename pattern that the test runner uses to find test files in directories.

description: Only run tests whose names match the given regular expressions A test's name must match all regular expressions in names in order to be run.

description: This field causes the runner to only run tests whose names contain the given strings. A test's name must contain all strings in order to be run.

description: This field causes the runner to only run tests whose tags match the given boolean selector. This takes precedence over include_tags

description: The platforms on which tests should be run.

description: The default number of test suites to run in parallel. This defaults to approximately half the number of processors on the current machine. Setting it to 1 will disable concurrency

description: Indicates that the test runner should pause for debugging after each test suite is loaded but before its tests are executed. This disables concurrency and timeouts.

description: Run tests even if they're marked as skipped.

description: This field indicates the default reporter to use.

examples: compact expanded json

description: Specifies additional reporters that will write their output to a file rather than stdout

$ref: #/definitions/foldStackFrameOptions

description: This field specifies the path of the HTML template to be used for tests run in an HTML environment.

description: Commonly used in a preset, it can be used to enable present inheritance by adding the configuration from another preset.

description: Applies test or runner options when a specific operating system is used

$ref: #/definitions/browserAndNodeSettings

description: Configuration for Dart tests

title: dart_test.yaml


jsinspectrc.json

description: A flag indicating whether to limit the search to nodes with matching identifiers

description: A regular expression used for matching paths to ignore

description: A flag indicating whether to process JSX files

default: default

description: The name of the reporter to be used

enum: default json pmd

description: The number of lines at which diffs should be suppressed. A value of 0 is off.

description: A threshold determining the smallest subset of nodes to analyze

title: JSON schema for JSInspect configuration files


sfdx-hardis.jsonschema.json

description: Configuration file definition for sfdx-hardis Salesforce DX plugin

$id: #/properties/allowedOrgTypes

description: Types of orgs allowed for config & development. If not set, sandbox and scratch are allowed by default

enum: sandbox scratch

title: Allowed org types

$id: #/properties/autoCleanTypes

description: When saving a sfdx-hardis task, the list of cleanings will be automatically applied to sfdx sources

enum: caseentitlement dashboards datadotcom destructivechanges localfields listViewsMine minimizeProfiles productrequest systemDebug

title: Auto-Cleaning types

$id: #/properties/autoRemoveUserPermissions

description: When saving a sfdx-hardis task, these permissions will be removed from profiles

title: Auto-Remove User Permissions on profiles

$id: #/properties/autoRetrieveWhenPull

description: When calling hardis:scratch:pull, if you define metadatas (named or not), they will also be retrieved using force:source:retrieve

title: Auto-Retrieve when pull

description: Minimum percentage of apex code coverage accepted

title: Minimum apex test coverage %

$id: #/properties/availableProjects

description: List of business projects that are managed in the same repository. Will be used to build git branch name when using hardis:work:new

title: Available projects

$id: #/properties/availableTargetBranches

description: List of git branches that can be used as target for merge requests

title: Available target branches

$id: #/properties/branchPrefixChoices

description: When calling hardis:work:new, you can override the default branch prefixes. Input title, value and description for each of them

title: Feature

value: feat

description: New feature, evolution of an existing feature... If you don't know, just select Feature

title: Debug

value: fix

description: A bug has been identified and you are the right person to solve it !

title: Feature

title: Debug

title: New branches prefixes choices

$id: #/properties/cleanXmlPatterns

description: List of patterns to automatically clean XML files

$id: #/properties/cleanXmlPatterns/items

description: Clean XML pattern and xpaths

description: Glob pattern to identify XML files to clean

title: Glob pattern

description: XPaths to identify elements to remove

title: XPath list

required: globPattern xpaths

title: Clean XML Patterns

$id: #/properties/customCommands

description: List of custom commands for VsCode SFDX-Hardis extension

label: Custom commands

label: Generate manifest

tooltip: Generates a manifest package.xml using local sfdx source files

command: sfdx force:source:manifest:create --sourcepath force-app --manifestname myNewManifest

label: List all orgs

tooltip: List all orgs that has already been authenticated using sfdx

command: sfdx force:org:list --all

label: Another custom menu

label: Echo something

tooltip: Useless commands just to show that we can use not sfdx commands too

command: echo "Something"

$id: #/properties/customCommands/items

description: Custom command definition

description: Identifier of the menu (can be any string)

title: Id

description: Label of the menu

title: Label

description: List of commands of the menu

description: Custom command definition

description: Identifier of the command (can be any string)

title: Id

description: Label of the command that will appear in menu

title: Label

description: Icon (can be any of svg icons of this list: https://github.com/hardisgroupcom/vscode-sfdx-hardis/tree/master/resources

title: Icon

description: Text that will appear when user will hover the command

title: Tooltip

description: Command line to run when clicking on the menu

title: Command

description: URL for help page of the command

title: Help url

required: id label command

title: Label

required: id label

title: Custom commands

$id: #/properties/customCommandsPosition

description: Position of custom commands in the menu (first or last)

default: first

enum: first last

examples: first last

title: Custom commands position

$id: #/properties/customOrgColors

description: Custom colors set by VsCode SFDX Hardis

title: Custom Org Colors

$id: #/properties/customPlugins

description: List of additional plugins that will be displayed in VsCode SFDX-Hardis Dependencies panel

$id: #/properties/customPlugins/items

description: Plugin definition

description: Name of the plugin npm package

examples: mo-dx-plugin shane-sfdx-plugins

title: Name

description: Url of plugin documentation

title: Name

title: Plugin

title: Custom plugins

$id: #/properties/dataPackages

description: List of data packages

$id: #/properties/dataPackages/items

description: Data package

description: Path to SFDMU project

title: SFDMU Data project path

description: Path to SFDMU project

title: SFDMU Data project path

required: dataPath importInScratchOrgs

title: Data packages

description: When generating a new package version protected with password, use this value as default package installation key

title: Defaut package installation key

$id: #/properties/developmentBranch

default: developpement

description: When creating a new sfdx-hardis task, this git branch is used as base to create the feature/debug sub branch. The merge request will later have this branch as target.

examples: developpement dev_lot2 hotfixes

title: Default pull/merge request target org

$id: #/properties/deploymentPlan

description: Deployment plan that will be performed during deployments. Can be based on packageXmlFile for sources or on dataPath for sfdmu data deployments

label: Import EmailTemplate records

dataPath: scripts/data/EmailTemplate

label: Deploy EmailTemplate

label: Deploy Flow-Workflow

description: During deployment, main package.xml will be split into these packages. Can also contain data packages

description: Source or data package to deploy

title: Path to SFDMU data project to deploy

examples:
Deploy EmailTemplate
Import EmailTemplate records

title: Source or data package label

title: Execution order in deployment plan

title: Path to package.xml file to use for deployment

description: Delay to wait before installing the next package

title: Wait after install (seconds)

required: label order

title: List of packages to deploy

title: Deployment plan

description: Dev Hub alias, usually DevHub_ProjectName

title: Dev Hub org alias

description: Dev Hub username, used to authenticate to DevHub from CI jobs

title: Dev Hub Username

description: You can base your local sfdx-hardis configuration on a remote config file. That allows you to have the same config base for all your projects

title: Extends remote configuration URL

description: When creating a scratch org, Admin user will be automatically assigned to those permission sets

description: Permission Set or Permission Set Group

description: Permission Set or Permission Set Group name

title: Name

title: Initial Permission Sets

description: Defines the list of packages installed on the project. Use

SubscriberPackageName: Declarative Lookup Rollup Summaries Tool

description: Salesforce package info (managed, unlocked or unmanaged)

title: (unused) PackageId

title: Subscriber Package Id

title: Subscriber Package Name

title: Subscriber Package NameSpace

title: Subscriber Version Id (IMPORTANT)

title: Subscriber Version Name

title: Subscriber Version Number

description: If true, during deployments this package will be installed in target org if not installed yet

title: Install during deployments

description: If true, this package will be installed when creating a new scratch org with sfdx-hardis

title: Install on scratch orgs

description: Installation key for key-protected package

title: Package installation key

title: Salesforce package

title: Installed Packages

description: When calling deployment check command, installs any package referred within installedPackages property

title: Install packages during deployment checks

description: Salesforce instance URL used by CI for deployment or backups

title: Instance URL

description: List of ListView items to set to Mine after a delivery (that does not accept value 'Everything')

title: List views to set to Mine

description: List of metadata to retrieve for retrofit job

title: Metadata to retrofit

description: Url of the Ms Teams channel Web Hook that can be used to send ALL notifications

title: MsTeams WebHook Url (ALL)

description: Url of the Ms Teams channel Web Hook that can be used to send CRITICAL notifications

title: MsTeams WebHook Url (CRITICAL)

description: Url of the Ms Teams channel Web Hook that can be used to send SEVERE notifications

title: MsTeams WebHook Url (SEVERE)

description: Url of the Ms Teams channel Web Hook that can be used to send WARNING notifications

title: MsTeams WebHook Url (WARNING)

description: Url of the Ms Teams channel Web Hook that can be used to send INFO notifications

title: MsTeams WebHook Url (INFO)

description: Configuration allowing to generate and fetch scratch orgs from scratch org pool

title: Scratch org pool configuration

description: When pool scratch org is less than this number, it is deleted and another one is created

title: Min scratch org remaining days

description: Maximum number of active scratch orgs in the scratch org pool

title: Maximum number of scratch orgs

description: Maximum number of scratch orgs to create in one CI job

title: Maximum number of scratch orgs to create once

description: Remote service allowing to store scratch org pool details

title: Storage service for scratch org pool

description: Name of the git branch corresponding to production environment

title: Production branch name

description: Identifier for the project (can be the client and project)

title: Project Name

description: Name of the git branch where retrofit merge requests targets to

title: Retrofit branch name

description: When calling hardis:org:retrieve:sources:retrofit, list of files to ignore (discard just after retrieve)

title: Retrofit ignored files

description: Apex scripts to call after scratch org initialization

title: Scratch org init apex scripts

description: Instance host name to allow SFDMU to deploy data in a production org

title: SFDMU can modify

description: Defines if sfdx-hardis will propose to upgrade local .forceignore file

title: Skip update .forceignore file

description: Defines if sfdx-hardis will propose to upgrade local .gitignore file

title: Skip update .gitignore file

description: Salesforce username used by CI for deployment or backups

title: Target Username

description: Ignore profiles or permission sets

title: Linter ignore permission set or/and profile

title: sfdx-hardis configuration