key: collectionInherits

description: Defaults to 'EntityBaseCollection' or 'EntityBaseKeyedCollection' depending on 'CollectionKeyed'. For Reference Data it will default to 'ReferenceDataCollectionBase'.


key: collectionResultInherits

description: Defaults to 'EntityCollectionResult'.

type: string


key: autoImplement

description: Defaults to 'None'. Indicates that the implementation for the underlying 'Operations' will be auto-implemented using the selected data source (unless explicity overridden). When selected some of the related attributes will also be required (as documented). Additionally, the 'AutoImplement' indicator must be selected for each underlying 'Operation' that is to be auto-implemented.

enum: Database EntityFramework Cosmos OData HttpAgent None


key: dataCtor

description: Defaults to 'Public'.

enum: Public Private Protected


key: dataCtorParams

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. Where the 'Type' matches an already inferred value it will be ignored.

type: array


key: dataExtensions

description: This can be overridden using 'Operation.DataExtensions'.

type: boolean


key: refDataIdDataName

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


key: refDataCodeDataName

description: Defaults to 'Code' (literal).


key: refDataTextDataName

description: Defaults to 'Text' (literal).


key: refDataIsActiveDataName

description: Defaults to 'IsActive' (literal).


key: refDataSortOrderDataName

description: Defaults to 'SortOrder' (literal).


key: refDataETagDataName

description: Defaults to 'RowVersion' (literal).


key: refDataStoredProcedureName

description: Defaults to 'sp' (literal) + 'Name' + 'GetAll' (literal).


key: databaseName

description: Defaults to the 'CodeGeneration.DatabaseName' configuration property (its default value is 'IDatabase').


key: databaseSchema

description: Defaults to 'dbo'.


key: databaseCustomerMapper

description: Otherwise, by default, a 'Mapper' will be generated.


key: entityFrameworkName

description: Defaults to 'CodeGeneration.EntityFrameworkName'.


key: entityFrameworkCustomMapper


key: cosmosName

description: Defaults to the 'CodeGeneration.CosmosName' configuration property (its default value is 'ICosmosDb').


key: cosmosPartitionKey

description: The value 'PartitionKey.None' can be specified. Literals will need to be quoted.


key: cosmosCustomMapper


key: odataName

description: Defaults to the 'CodeGeneration.ODataName' configuration property (its default value is 'IOData').


key: odataCollectionName

description: The underlying 'Simple.OData.Client' will attempt to infer.


key: odataCustomMapper


key: httpAgentName

description: Defaults to 'CodeGeneration.HttpAgentName' configuration property (its default value is 'IHttpAgent').


key: httpAgentRoutePrefix

description: This is the base (prefix) 'URI' for the HTTP Agent endpoint and can be further extended when defining the underlying 'Operation'(s).


key: httpAgentModel

description: This can be overridden within the 'Operation'(s).


key: httpAgentReturnModel


key: httpAgentCode

description: Prepended to 'Operation.HttpAgentCode' where specified to enable standardized functionality.


key: dataSvcCaching

description: Defaults to 'true'.


key: dataSvcCtor

description: Defaults to 'Public'.


key: dataSvcCtorParams


key: dataSvcExtensions

description: This can be overridden using 'Operation.DataSvcExtensions'.


key: eventPublish

description: Defaults to the 'CodeGeneration.EventPublish' configuration property (inherits) where not specified. Used to enable the sending of messages to the likes of EventGrid, Service Broker, SignalR, etc. This can be overridden within the 'Operation'(s).

enum: None DataSvc Data


key: eventSource

description: Defaults to 'Name' (as lowercase) appended with the '/{$key}' placeholder. Note: when used in code-generation the 'CodeGeneration.EventSourceRoot' will be prepended where specified. To include the entity id/key include a '{$key}' placeholder ('Create', 'Update' or 'Delete' operation only); for example: 'person/{$key}'. This can be overridden for the 'Operation'.


key: eventTransaction

description: Usage will force a rollback of any underlying data transaction (where the provider supports TransactionScope) on failure, such as an 'EventPublish' error. This is by no means implying a Distributed Transaction (DTC) should be invoked; this is only intended for a single data source that supports a TransactionScope to guarantee reliable event publishing. Defaults to 'CodeGeneration.EventTransaction'. This essentially defaults the 'Operation.DataSvcTransaction' where not otherwise specified. This should only be used where a transactionally-aware data source is being used.


key: managerCtor

description: Defaults to 'Public'.


key: managerCtorParams

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. Where the 'Type' matches an already inferred value it will be ignored.


key: managerExtensions

description: This can be overridden using 'Operation.ManagerExtensions'.


key: validator

description: Only used for defaulting the 'Create' and 'Update' operation types ('Operation.Type') where not specified explicitly.


key: managerCleanUp

description: This can be overridden within the 'CodeGeneration' and 'Operation'(s).


key: validationFramework

description: Defaults to 'CodeGeneration.ValidationFramework'. This can be overridden within the 'Operation'(s) and 'Parameter'(s).

enum: CoreEx FluentValidation


key: webApiRoutePrefix

description: This is the base (prefix) 'URI' for the entity and can be further extended when defining the underlying 'Operation'(s). The 'CodeGeneration.WebApiRoutePrefix' will be prepended where specified.


key: webApiAuthorize

description: Defaults to the 'CodeGeneration.WebApiAuthorize' configuration property (inherits) where not specified; can be overridden at the 'Operation' level also.


key: webApiCtor

description: Defaults to 'Public'.


key: webApiCtorParams


key: webApiAutoLocation

description: This will automatically set the 'Operation.WebApiLocation' for an 'Operation' named 'Create' where there is a corresponding named 'Get'. This is defaulted from the 'CodeGen.WebApiAutoLocation'.


key: webApiConcurrency

description: This provides an alternative where the underlying data source does not natively support optimistic concurrency (native support should always be leveraged as a priority). Where the 'Operation.Type' is 'Update' or 'Patch', the request ETag will be matched against the response for a corresponding 'Get' operation to verify no changes have been made prior to updating. For this to function correctly the .NET response Type for the 'Get' must be the same as that returned from the corresponding 'Create', 'Update' and 'Patch' (where applicable) as the generated ETag is a SHA256 hash of the resulting JSON. This defaults the 'Operation.WebApiConcurrency'.


key: webApiGetOperation

description: Defaults to 'Get'. Specify either just the method name (e.g. 'OperationName') or, interface and method name (e.g. 'IXxxManager.OperationName') to be invoked where in a different 'YyyManager.OperationName'.


key: dataModel

description: The model will be generated with 'OmitEntityBase = true'. Any reference data properties will be defined using their 'RefDataType' intrinsic 'Type' versus their corresponding (actual) reference data 'Type'.


key: excludeAll

description: Is a shorthand means for setting all of the other 'Exclude*' properties (with the exception of 'ExcludeEntity') to exclude.


key: excludeData

description: Defaults to 'Include' indicating _not_ to exlude. A value of 'Exclude' indicates to exclude all output; alternatively, 'RequiresMapper' indicates to at least output the corresponding 'Mapper' class.

enum: Include Exclude RequiresMapper


key: authRole

description: Used where not overridden specifically for an 'Operation'; i.e. acts as the default.


key: grpc

description: gRPC support is an explicit opt-in model (see 'CodeGeneration.Grpc' configuration); therefore, each corresponding 'Property' and 'Operation' will also need to be opted-in specifically.


key: Property

description: The 'Property' object defines an 'Entity' property and its charateristics.

type: object

enum: UseDefault None DateOnly DateTimeLocal DateTimeUtc DateTimeUnspecified

enum: UseDefault None Start End Both

enum: UseDefault None NullToEmpty EmptyToNull

enum: UseDefault None Lower Upper Title

enum: string int Guid

enum: Optional Always Never

enum: Any AnyExceptCreate AnyExceptUpdate AnyExceptGet Get Create Update Delete

enum: Set Ignore Map Flatten

enum: Map Ignore Skip

type: integer


key: text

description: By default the 'Text' will be the 'Name' reformatted as sentence casing. Depending on whether the 'Type' is 'bool', will appear in one of the two generated sentences. Where not 'bool' it will be: Gets or sets a value indicating whether {text}.'. Otherwise, it will be: Gets or sets the {text}.'. To create a '<see cref="XXX"/>' within use moustache shorthand (e.g. {{Xxx}}).


key: modelText

description: By default the 'ModelText' will be the 'Name' reformatted as sentence casing. Depending on whether the 'Type' is 'bool', will appear in one of the two generated sentences. Where not 'bool' it will be: Gets or sets a value indicating whether {text}.'. Otherwise, it will be: Gets or sets the {text}.'. To create a '<see cref="XXX"/>' within use moustache shorthand (e.g. {{Xxx}}).


key: type

description: Defaults to 'string'. To reference a Reference Data 'Type' always prefix with 'RefDataNamespace' (e.g. 'RefDataNamespace.Gender') or shortcut '^' (e.g. '^Gender'). This will ensure that the appropriate Reference Data 'using' statement is used. _Shortcut:_ Where the 'Type' starts with (prefix) 'RefDataNamespace.' or '^', and the correspondong 'RefDataType' attribute is not specified it will automatically default the 'RefDataType' to 'string.'


key: privateName

description: Overrides the 'Name' to be used for private fields. By default reformatted from 'Name'; e.g. 'FirstName' as '_firstName'.


key: argumentName

description: Overrides the 'Name' to be used for argument parameters. By default reformatted from 'Name'; e.g. 'FirstName' as 'firstName'.


key: primaryKey

description: This is also used to simplify the parameter specification for an Entity Operation by inferrence.


key: isEntity

description: Will be inferred (default to 'true') where the 'Type' is 'ChangeLog' or the 'Type' is found as another 'Entity' within the code-generation configuration file.


key: dateTimeTransform

description: Defaults to 'UseDefault'. This is only applied where the 'Type' is 'DateTime'.


key: stringTrim

description: Defaults to 'UseDefault'. This is only applied where the 'Type' is 'string'.


key: stringTransform


key: stringCasing


key: default

description: Where the 'Type' is 'string' then the specified default value will need to be delimited. Any valid value assignment C# code can be used.


key: partitionKey

description: This will implement 'IPartitionKey' for the generated entity.


key: internalOnly

description: In this instance the 'Property' will be excluded from the 'Common' entity declaration and 'Business' JSON serialization.


key: refDataType

description: Defaults to 'string' (being the 'ReferenceDataBase.Code') where not specified and the corresponding 'Type' starts with (prefix) 'RefDataNamespace.' or '^'. Note: an 'Id' of type 'string' is currently not supported; the use of the 'Code' is the recommended approach.


key: refDataList

description: This is required to enable a list of Reference Data values (as per 'RefDataType') to be passed as an argument for example.


key: refDataText

description: This is used where serializing within the Web API 'Controller' and the 'ExecutionContext.IsRefDataTextSerializationEnabled' is set to 'true' (which is automatically set where the url contains '$text=true').'Optional' indicates when 'ExecutionContext.IsRefDataTextSerializationEnabled' is set to 'true' then a value is output, 'Always' indicates that the value is _always_ output, and 'Never' indicates that feature is turned off.


key: refDataMapping

description: Mapped properties are a special Reference Data property type that ensure value uniqueness; this allows the likes of additional to/from mappings to occur between systems where applicable.


key: jsonName

description: Defaults to 'ArgumentName' where not specified (i.e. camelCase); however, where the property is 'ETag' it will default to the 'Config.ETagJsonName'.


key: jsonDataModelName

description: Defaults to 'JsonName' where not specified.


key: serializationIgnore

description: All properties are serialized by default.


key: dataModelIgnore

description: All properties are included in the data model by default.


key: dataModelSerializationIgnore


key: dataName

description: Defaults to the property 'Name'. Represents the column name for a 'Database', or the correspinding property name for the other options.


key: dataConverter

description: A 'Converter' is used to convert a data source value to/from a .NET 'Type' where no standard data conversion can be applied. Where this value is suffixed by '<T>' or '{T}' this will automatically set 'Type'.


key: dataMapperIgnore

description: All properties are included by default.


key: dataOperationTypes

description: Defaults to 'Any'.


key: databaseMapper

description: A 'Mapper' is used to map a data source value to/from a .NET complex 'Type' (i.e. class with one or more properties).


key: databaseDbType

description: Overrides the inferred database type; i.e. can specify 'Date' or 'DateTime2', for .NET Type 'System.DateTime'.


key: entityFrameworkMapper

description: Defaults to 'Set'.


key: cosmosMapper

description: Defaults to 'Set'.


key: odataMapper

description: Defaults to 'Map' which indicates the property will be explicitly mapped. A value of 'Ignore' will explicitly 'Ignore', whilst a value of 'Skip' will skip code-generated mapping altogether.


key: httpAgentMapper

description: Defaults to 'Set'.


key: displayName

description: Defaults to the 'Name' as sentence case.


key: Operation

description: The code generation for an 'Operation' is primarily driven by the 'Type' property. This encourages (enforces) a consistent implementation for the standardised **CRUD** (Create, Read, Update and Delete) actions, as well as supporting fully customised operations as required.

enum: Get GetColl Create Update Patch Delete Custom

enum: HttpGet HttpPost HttpPut HttpDelete HttpPatch

enum: Create Read Update Delete Unspecified

enum: HttpGet HttpPost HttpPut HttpDelete

enum: OK Accepted Created NoContent NotFound


key: text

description: The 'Text' will be defaulted for all the 'Operation.Type' options with the exception of 'Custom'. To create a '<see cref="XXX"/>' within use moustache shorthand (e.g. {{Xxx}}).


key: primaryKey

description: This simplifies the specification of these properties versus having to declare each specifically.


key: valueType

description: Defaults to the parent 'Entity.Name' where the 'Operation.Type' options are 'Create' or 'Update'.


key: returnType

description: Defaults to the parent 'Entity.Name' where the 'Operation.Type' options are 'Get', 'GetColl', 'Create' or 'Update'; otherwise, defaults to 'void'.


key: returnTypeNullable

description: This is only applicable for an 'Operation.Type' of 'Custom'. Will be inferred where the 'ReturnType' is denoted as nullable; i.e. suffixed by a '?'.


key: returnText

description: A default will be created where not specified. To create a '<see cref="XXX"/>' within use moustache shorthand (e.g. {{Xxx}}).


key: privateName

description: Overrides the 'Name' to be used for private usage. By default reformatted from 'Name'; e.g. 'GetByArgs' as '_getByArgs'.


key: withResult

description: Defaults to 'Entity.WilhResult'.


key: autoImplement

description: Defaults to 'Entity.AutoImplement'. The corresponding 'Entity.AutoImplement' must be defined for this to be enacted. Auto-implementation is applicable for all 'Operation.Type' options with the exception of 'Custom'.

enum: Database EntityFramework Cosmos OData HttpAgent None


key: dataEntityMapper

description: Used where the default generated 'Mapper' is not applicable.


key: dataExtensions

description: Defaults to 'Entity.DataExtensions'.


key: dataInvoker

description: Where 'Dataransaction' or 'EventPublish' is 'Data' then orchestration will default to 'true'.


key: dataTransaction

description: Where using an 'EventOutbox' this is ignored as it is implied through its usage.


key: databaseStoredProc

description: Defaults to 'sp' + 'Entity.Name' + 'Operation.Name'; e.g. 'spPersonCreate'.


key: entityFrameworkModel

description: Overrides the 'Entity.EntityFrameworkModel'.


key: cosmosModel

description: Overrides the 'Entity.CosmosModel'.


key: cosmosContainerId

description: Overrides the 'Entity.CosmosContainerId'.


key: cosmosPartitionKey

description: Overrides the 'Entity.CosmosPartitionKey'.


key: odataCollectionName

description: Overriddes the 'Entity.ODataCollectionName'; otherwise, the underlying 'Simple.OData.Client' will attempt to infer.


key: httpAgentRoute

description: This is appended to the 'Entity.HttpAgentRoutePrefix'.


key: httpAgentMethod

description: Defaults to 'Operation.WebApiMethod'.


key: httpAgentModel

description: This can be overridden within the 'Operation'(s).


key: httpAgentReturnModel

description: Defaults to 'Operation.HttpAgentModel' where the 'Operation.ReturnType' is equal to 'Entity.Name' (same type). This can be overridden within the 'Operation'(s).


key: httpAgentCode

description: Appended to 'Entity.HttpAgentCode' where specified to extend.


key: managerExtensions

description: Defaults to 'Entity.ManagerExtensions'.


key: validator

description: Defaults to the 'Entity.Validator' where not specified explicitly (where 'Operation.Type' options 'Create' or 'Update').


key: validationFramework

description: Defaults to 'Entity.ValidationFramework'. This can be overridden within the 'Parameter'(s).

enum: CoreEx FluentValidation


key: managerOperationType

description: The default will be inferred from the 'Operation.Type'; however, where the 'Operation.Type' is 'Custom' it will default to 'Unspecified'.


key: managerCleanUp

description: This can be overridden within the 'CodeGeneration' and 'Entity'.


key: dataSvcInvoker

description: Where 'DataSvcTransaction' or 'EventPublish' is 'DataSvc' then orchestration will default to 'true'.


key: dataSvcExtensions

description: Defaults to 'Entity.ManagerExtensions'.


key: eventPublish

description: Defaults to the 'Entity.EventPublish' configuration property (inherits) where not specified. Used to enable the sending of messages to the likes of EventGrid, Service Broker, SignalR, etc.

enum: None DataSvc Data


key: eventSource

description: Defaults to 'Entity.EventSource'. Note: when used in code-generation the 'CodeGeneration.EventSourceRoot' will be prepended where specified. To include the entity id/key include a '{$key}' placeholder ('Create', 'Update' or 'Delete' operation only); for example: 'person/{$key}'.


key: eventSubject

description: The event subject template defaults to '{AppName}.{Entity.Name}', plus each of the unique key placeholders comma separated; e.g. 'Domain.Entity.{id1},{id2}' (depending on whether 'Entity.EventSubjectFormat' is 'NameAndKey' or 'NameOnly'). The event action defaults to 'WebApiOperationType' or 'Operation.Type' where not specified. Multiple events can be raised by specifying more than one subject/action pair separated by a semicolon. E.g. 'Demo.Person.{id}:Create;Demo.Other.{id}:Update'.


key: webApiAuthorize

description: Where not specified no attribute output will occur; it will then inherit as supported by .NET.


key: webApiMethod

description: The value defaults as follows: 'HttpGet' for 'Operation.Type' value 'Get' or 'GetColl', 'HttpPost' for 'Operation.Type' value 'Create' or 'Custom', 'HttpPut' for 'Operation.Type' value 'Update', and 'HttpDelete' for 'Operation.Type' value 'Delete'. An 'Operation.Type' value 'Patch' can not be specified and will always default to 'HttpPatch'.


key: webApiStatus

description: The value defaults as follows: 'OK' for 'Operation.Type' value 'Get', 'GetColl', 'Update', 'Delete' or 'Custom', 'Created' for 'Operation.Type' value 'Create'.


key: webApiAlternateStatus

description: The value defaults as follows: 'NotFound' for 'Operation.Type' value 'Get' and 'NoContent' for 'Operation.Type' value 'GetColl'; otherwise, 'null'.


key: webApiLocation

description: This uses similar formatting to the 'WebApiRoute'. The response value is accessed using 'r.' notation to access underlying properties; for example '{r.Id}' or 'person/{r.Id}'. The 'Entity.WebApiRoutePrefix' will be prepended automatically; however, to disable set the first character to '!', e.g. '!person/{r.Id}'. The URI can be inferred from another 'Operation' by using a lookup '^'; for example '^Get' indicates to infer from the named 'Get' operation (where only '^' is specified this is shorthand for '^Get' as this is the most common value). The Location URI will ensure the first character is a '/' so it acts a 'relative URL absolute path'.


key: webApiConcurrency

description: This provides an alternative where the underlying data source does not natively support optimistic concurrency (native support should always be leveraged as a priority). Where the 'Operation.Type' is 'Update' or 'Patch', the request ETag will be matched against the response for a corresponding 'Get' operation to verify no changes have been made prior to updating. For this to function correctly the .NET response Type for the 'Get' must be the same as that returned from the corresponding 'Create', 'Update' and 'Patch' (where applicable) as the generated ETag is a SHA256 hash of the resulting JSON. Defaults to 'Entity.WebApiConcurrency'.


key: webApiGetOperation

description: Defaults to 'Get'. Specify either just the method name (e.g. 'OperationName') or, interface and method name (e.g. 'IXxxManager.OperationName') to be invoked where in a different 'YyyManager.OperationName'.


key: webApiUpdateOperation

description: Defaults to 'Update'. Specify either just the method name (e.g. 'OperationName') or, interface and method name (e.g. 'IXxxManager.OperationName') to be invoked where in a different 'YyyManager.OperationName'.


key: excludeAll

description: Is a shorthand means for setting all of the other 'Exclude*' properties to 'true'.


key: grpc

description: gRPC support is an explicit opt-in model (see 'CodeGeneration.Grpc' configuration); therefore, each corresponding 'Entity', 'Property' and 'Operation' will also need to be opted-in specifically.


key: Parameter

description: The 'Parameter' object defines an 'Operation' parameter and its charateristics.

enum: All ToManagerSet ToManagerCollSet

enum: FromQuery FromBody FromRoute FromEntityProperties


key: text

description: By default the 'Text' will be the 'Name' reformatted as sentence casing.


key: type

description: Defaults to 'string'. To reference a Reference Data 'Type' always prefix with 'RefDataNamespace' (e.g. 'RefDataNamespace.Gender') or shortcut '^' (e.g. '^Gender'). This will ensure that the appropriate Reference Data 'using' statement is used. _Shortcut:_ Where the 'Type' starts with (prefix) 'RefDataNamespace.' or '^', and the correspondong 'RefDataType' attribute is not specified it will automatically default the 'RefDataType' to 'string.'


key: default

description: Where the 'Type' is 'string' then the specified default value will need to be delimited. Any valid value assignment C# code can be used.


key: privateName

description: Overrides the 'Name' to be used for private fields. By default reformatted from 'Name'; e.g. 'FirstName' as '_firstName'.


key: argumentName

description: Overrides the 'Name' to be used for argument parameters. By default reformatted from 'Name'; e.g. 'FirstName' as 'firstName'.


key: refDataType

description: Defaults to 'string' where not specified and the corresponding 'Type' starts with (prefix) 'RefDataNamespace.'.


key: refDataList

description: This is required to enable a list of Reference Data values (as per 'RefDataType') to be passed as an argument for example.


key: validationFramework

description: Defaults to 'Operation.ValidationFramework'.


key: layerPassing

description: Defaults to 'All'. To further describe, 'All' passes the parameter through all layeys, 'ToManagerSet' only passes the parameter to the 'Manager' layer and overrides the same named property within the corresponding 'value' parameter, 'ToManagerCollSet' only passes the parameter to the 'Manager' layer and overrides the same named property within the corresponding 'value' collection parameter. Where using the 'PrimaryKey' option to automatically set 'Parameters', and the 'Operation.Type' is 'Create' or 'Update' it will default to 'ToManagerSet'.


key: dataConverter

description: A 'Converter' is used to convert a data source value to/from a .NET 'Type' where no standard data conversion can be applied. Where this value is suffixed by '<T>' or '{T}' this will automatically set 'Type'.


key: webApiFrom

description: Defaults to 'FromQuery'; unless the parameter 'Type' has also been defined as an 'Entity' within the code-gen config file then it will default to 'FromEntityProperties'. Specifies that the parameter will be declared with corresponding 'FromQueryAttribute', 'FromBodyAttribute' or 'FromRouteAttribute' for the Web API method. The 'FromEntityProperties' will declare all properties of the 'Entity' as query parameters.


key: Const

description: The 'Const' object is used to define a .NET (C#) constant value for an 'Entity'.

required: name value


key: value

description: The code generation will ensure the value is delimited properly to output correctly formed (delimited) .NET (C#) code.


description: By default the 'Text' will be the 'Name' reformatted as sentence casing. It will be formatted as: 'Represents a {text} constant value.' To create a '<see cref="XXX"/>' within use moustache shorthand (e.g. '{{Xxx}}').


description: The driving file of a Fleet bundle


key: selector

description: A selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty selector matches all objects


key: matchExpressions

description: matchExpressions is An array of label selector requirements. The requirements are ANDed


key: key

description: key is the label key that the selector applies to


key: operator

description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist


key: values

description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty


key: items

description: The value of the label that must be compared to according to the selected operator


key: matchLabels

description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed


key: diff

description: An array of diff options to consider when comparing the current state of the bundle to the desired one.


key: comparePatches

description: An array of compare patches; how the diff should be calculated and eventually ignored. See ref: https://fleet.rancher.io/next/ref-crds#comparepatch


key: apiVersion

description: The apiVersion of the resource to compare


key: jsonPointers

description: An array of custom JSONPointers. See ref: https://jsonpatch.com/#json-pointer


key: kind

description: The kind of the resource to compare


key: name

description: The name of the resource to compare


key: namespace

description: The namespace of the resource to compare


key: operations

description: An array of operations to consider when comparing the current state of the resource to the desired one. See example: https://fleet.rancher.io/next/bundle-diffs#combining-it-all-together


key: op

description: The operation to perform. See ref: https://jsonpatch.com/#operations


key: path

description: The path to the field to compare. See ref: https://jsonpatch.com/#json-pointer


key: value

description: The value to add or replace


key: atomic

description: Set the Helm --atomic flag when upgrading. Default: false


key: chart

description: Use a custom location for the Helm chart. This can refer to any go-getter URL, OCI registry based helm chart URL e.g. "oci://ghcr.io/fleetrepoci/guestbook" or a local/remote tgz file. This allows one to download charts from most any location.  Also know that go-getter URL supports adding a digest to validate the download. If repo is set below this field is the name of the chart to lookup


key: force

description: Set the Helm --force flag when upgrading. This could be dangerous (sic). Default: false


key: maxHistory

description: Set the Helm --max-history flag when upgrading


key: releaseName

description: A custom release name to deploy the chart as. If not specified a release name will be generated by combining the invoking GitRepo.name + GitRepo.path


key: repo

description: A https URL to a Helm repo to download the chart from. If repo is used the value of `chart` will be used as the chart name to lookup in the Helm repository


key: takeOwnership

description: Makes helm skip the check for its own annotations. Defailt: false


key: timeoutSeconds

description: Set the Helm --timeout flag when upgrading.


key: values

description: Any values that should be placed in the `values.yaml` and passed to helm during install. Cluster labels can also be used here, see https://fleet.rancher.io/next/gitrepo-structure#reference for more info


key: valuesFiles

description: Path to any values files that need to be passed to helm during install


key: items

description: Path to the value file


key: valuesFrom

description: An array of of configmap or secrets references defined in the downstream clusters to get values for the chart.


key: configMapKeyRef

description: A reference to a configmap key


key: key

description: The key to get from the configmap


key: name

description: The name of the configmap


key: namespace

description: The namespace of the configmap


key: secretKeyRef

description: A reference to a secret key


description: The key to get from the secret


description: The name of the secret


description: The namespace of the secret


key: version

description: The version of the chart or semver constraint of the chart to find. If a constraint is specified it is evaluated each time git changes. The version also determines which chart to download from OCI registries


key: dir

description: Custom folder for kustomize resources. This folder must contain a kustomization.yaml file. Path is relative to repository root


key: defaultNamespace

description: The default namespace to be applied to resources. This field is not used to enforce or lock down the deployment to a specific namespace, but instead provide the default value of the namespace field if one is not specified in the manifests. Default: default


key: dependsOn

description: An array of dependencies to other Bundles.


description: Format: <GITREPO-NAME>-<BUNDLE_PATH> with all path separators replaced by "-". Example: A Gitrepo named "one", with a Bundle path "/multi-cluster/hello-world" => "one-multi-cluster-hello-world"


key: helm

description: Helm overrides for the bundle. When changes are applied to the values.yaml from multiple sources at the same time, the values will update in the following order: helm.values -> helm.valuesFiles -> helm.valuesFrom


key: kustomize

description: Kustomize options for the bundle.


key: labels

description: Labels to apply to the bundle. These labels can be used to select bundles by using the dependsOn keyword


description: All resources will be assigned to this namespace and if any cluster scoped resource exists the deployment will fail. Default: ""


key: paused

description: A paused bundle will not update downstream clusters but instead mark the bundle as OutOfSync. One can then manually confirm that a bundle should be deployed to the downstream clusters. Default: false


key: autoPartitionSize

description: A number of percentage of how to automatically partition clusters if not specific partitioning strategy is configured. Default: 25%


key: maxUnavailable

description: A number or percentage of clusters that can be unavailable during an update of a bundle. This follows the same basic approach as a deployment rollout strategy. Once the number of clusters meets unavailable state update will be  paused. Default value is 100% which doesn't take effect on update. Default: 100%


key: maxUnavailablePartitions

description: A number or percentage of cluster partitions that can be unavailable during an update of a bundle. Default: 0


key: partitions

description: An array of definitions of partitions. If any target clusters do not match the configuration they are added to partitions at the end following the autoPartitionSize


key: clusterGroup

description: A cluster group name to include in this partition


key: clusterGroupSelector

description: Selector matching cluster group labels to include in this partition


key: clusterName

description: A cluster name to include in this partition


key: clusterSelector

description: Selector matching cluster labels to include in this partition


description: A number or percentage of clusters that can be unavailable in this partition before this partition is treated as done.Default: 10%


key: name

description: A user friend name given to the partition used for Display (optional). Default: ""


key: serviceAccount

description: The Service account which will be used for the BundleDeployments. Default: ""


key: targetCustomizations

description: Target customization are used to determine how resources should be modified per target. Targets are evaluated in order and the first one to match a cluster is used for that cluster


description: A cluster group name to select


description: Selector matching cluster group labels to select


description: Selector matching cluster labels to select


key: defaultNamespace

description: Custom defaultNamespace value overriding the value at the root


description: Custom helm options overriding the options at the root


description: Custom kustomize options overriding the options at the root


description: The name of target. If not specified a default name of the format "target000" will be used. This value is mostly for display


key: namespace

description: Custom namespace value overriding the value at the root


description: Custom serviceAccount value overriding the value at the root


key: yaml

description: If using raw YAML these are names that map to overlays/{name} that will be used to replace or patch a resource. If you wish to customize the file ./subdir/resource.yaml then a file ./overlays/myoverlay/subdir/resource.yaml will replace the base file. A file named ./overlays/myoverlay/subdir/resource_patch.yaml will patch the base file. A patch can in JSON Patch or JSON Merge format or a strategic merge patch for builtin Kubernetes types. Refer to "Raw YAML Resource Customization" (https://fleet.rancher.io/next/gitrepo-structure#raw-yaml-resource-customization) for more information


key: overlays

description: An array of overlays to apply to the resource. The overlays are applied in the order they are listed


key: items

description: An overlay to apply to the resource. The overlay can be a patch or a replacement. It should point to the folder containing the overlay file(s)


key: imageScans

description: ImageScans is An array of images repositories to scan for, so the corresponding repositories may be automatically updated with the specified image


key: image

description: The image to scan for


key: interval

description: The scan interval


key: policy

description: An array of policies on how to retrieve the latest image. Can be semver or alphabetical


key: alphabetical

description: The alphabetical policy specifics


key: order

description: The order of the images to use. Can be ascending or descending


key: semver

description: The semver policy specifics


key: range

description: Semver string to evaluate latest image. For more details on how to use semver, see https://github.com/Masterminds/semver


key: secretRef

description: The secret reference to use for the image repository


key: name

description: The name of the secret. It must be located in the same namespace as the GitRepo


key: tagName

description: The tag name used in the manifest files, to be replaced with the latest image. Must be unique per Bundle


description: Configuration file defining a recipe for a data pack for Minecraft.

type: object array

type: number

enum: building redstone equipment misc

enum: food blocks misc


key: then

description: Represents a recipe in a blast furnace.


description: Represents a recipe in a campfire.


description: Represents a shaped crafting recipe in a crafting table.


key: pattern

description: A list of single-character keys used to describe a pattern for shaped crafting.


key: key

description: All keys used for this shaped crafting recipe.


key: additionalProperties

description: The ingredient corresponding to this key.


key: item

description: An item ID.


key: tag

description: An item tag.


description: Represents a shapeless crafting recipe in a crafting table.


key: ingredients

description: A list of entries for this shapeless crafting recipe.


key: items

description: An entry made of a single ingredient.


description: An entry made of a list of acceptable ingredients.


description: Represents a recipe in a furnace.


description: Represents a recipe in a smithing table.


key: base

description: Ingredient specifying an item to be upgraded.


description: Represents a recipe in a smoker.


description: Represents a recipe in a stonecutter.


description: The ingredient for the recipe.


description: The list of ingredients for the recipe.


key: result

description: An item ID. The output item of the recipe.


key: count

description: The amount of the output item.


key: ingredient

description: An acceptable ingredient.


key: type

description: A namespaced ID indicating the type of serializer of the recipe.


key: group

description: A string identifier. Used to group multiple recipes together in the recipe book.


description: If a notification is shown when the recipe is unlocked.


description: The ingredients.


key: experience

description: The output experience of the recipe.


key: cookingtime

description: The cook time of the recipe in ticks.


key: commonRecipeCategory

description: Category of common recipes (in recipe book).


key: cookingRecipeCategory

description: Category of cooking recipes (in recipe book).


description: The output item of the recipe.


description: The amount of the item.


description: An item ID.


description: The type of recipe.


description: The configuration format for build cache nodes

required: key value hashCode()

enum: read readwrite

required: level password

const: fixed

const: maxAvailable

const: disabled

const: generated

const: open

required: password username

const: secure

enum: none read readwrite

enum: fixed maxAvailable

format: uri

required: key nodeAddress secret serverAddress

enum: disabled open secure generated


key: NodeCacheUser

description: A user of the build cache


key: level

description: The level of the access for the build cache user


key: note

description: Some optional free text


key: password

description: The hashed password of the user


key: TargetSizeFixed

description: Use a fixed target cache size


key: size

description: The total available size of the cache in MiB


key: TargetSizeMaxAvailable

description: Set the target cache size dynamically based on the disk volume's capacity


key: UiAccessDisabled

description: Access to the build cache node UI is disabled


key: UiAccessGenerated

description: Generated as startup credentials used for secure access to cache node UI


key: UiAccessOpen

description: Access to the build cache node UI is open for anyone


key: UiAccessSecure

description: Credentials used for secure access to cache node UI


description: The hashed password for securing the cache node UI


key: username

description: The username for securing the cache node UI


key: version

description: The version of the config file model (must be 5).


key: cache

description: Settings around cache size and access


key: accessControl

description: These credentials are used to restrict access to the build cache


key: anonymousLevel

description: The level of the access for anonymous users


key: users

description: The users of the cache and their access level


description: The credentials for reading and writing to the cache


key: freeSpaceBufferSize

description: The free space buffer to reserve in MiB


key: maxArtifactSize

description: The maximum size of a single artifact in the cache in MiB


key: maxEntryAgeInHours

description: The maximum age of an artifact in the cache in hours, if enabled


description: The cache settings


key: registration

description: Settings for connecting to Gradle Enterprise


key: key

description: The key of the node (can be found on the nodes screen of Gradle Enterprise)


key: nodeAddress

description: The URI of this build cache node


key: secret

description: The secret of the node (can be found on the nodes screen of Gradle Enterprise)


key: serverAddress

description: The URI of the Gradle Enterprise instance


description: The registration details to connect to Gradle Enterprise


key: Level

description: Disability degree. Value must be between 1.0 (fully disabled) and 0


key: License

description: Kind of driver licence, i.e.: A, B1, etc


key: IdDocument

description: Identification document, I.e.: passport

required: Country Document Id


key: Document

description: Document name. It could be a national document name, or passport


key: Given Name

description: Given name. It can be multiple words for compound names


key: Family Name

description: Family name. Depending on cultures, this field can be very different


key: Native Language

description: First learned language. Or preferred language if you had many


key: Avatar

description: Avatar. Image used to represent you without being an actual photo


key: Nationalities

description: Set of nationalities. If none is supplied, the birth of country is used


key: Region

description: Country region. If set, can not be blank


key: City

description: City. If set, can not be blank


key: Postcode

description: Postcode. If set, can not be blank


key: Address

description: Street address. If set, can not be blank


key: Organization

description: Organization data (can be used for companies, educational institutions, etc.)


key: Name

description: Name of the organization. If set can not be blank


key: Type

description: Organization's type (NGO, educational, government, etc.). If set can not be blank


key: Industry

description: Industry (financial, industry, etc.). If set can not be blank


key: NullableOrganization


key: Company

description: Permanent role company. If null, it means this is a contractor experience


key: Title

description: Course title. Can not be blank


key: From

description: Start date of the course. It must be a date before the end date


key: To

description: End date of the course. Should be set to a date before today


key: Website

description: URL with more information about the course. The URL must return a success code


key: Area

description: Course subject. If set, it cannot be blank


key: Summary

description: Brief description of the course. Blank values other than 'null' aren't allowed


key: Hours

description: Number of effective hours of this course. If set, should be greater than zero


key: Achievement

description: Professional achievement. Achievement accomplished at a given date. Publications must be owned by external parties in order to be an achievement, posts on social networks or personal blogs are listed in other CV sections

required: Type Title Date

enum: certification award publication presentation conference workshop other


description: Descriptive title of the achievement. Cannot be blank


key: Date

description: Data in which the achievement was accomplished. Cannot be after today


description: Link with further information of the achievement, I.e.: the URL of a publication. The URL must exist and be readable


description: Detailed description of the achievement. It cannot be blank


key: Full Name

description: Referrer's name. Can not be blank


description: Reference details in plain text. Can not be blank


key: Cv

description: CV data grouped by topics. Most of the fields are optional. When the model is rendered, the fields are passed to the template context with the names in camel case. Read only properties are meant only for use in templates, and cannot be defined in the document

format: URI

enum:
active search
open to challenges
not moving


key: $schema

description: Used to deal with different versions. It also eases the use on some editors


key: Locale

description: Locale representing the CV's content. If not set, it will be `en`


key: Resources

description: List of resources to be included in this CV. Allows CV modularization. Resources' content will be overwritten with the CV document content


key: Templates

description: Templates used to render this CV. Templates for different media types are supported using the template extension to select the appropriate one


key: Variables

description: Configuration added to the context when the CV is rendered. Map keys must be in camel case


key: Goals

description: Professional goals. It cannot contain any blank item


description:
********************************
Batch Jobs
Currently we only support:
- CSV as DataFormat type
- a clean database for every batch job
- CSV files with a header row, because the header is needed to get the field names
*******************************


key: id

description: the UUIDv4 of the job, generated upon creation


description: the UUIDv4 of the STRM Privacy project


key: handle

description: constraint: handle should already exist


key: name

description: constraints: generic name constraint, unique within handle


key: version

description: constraints: semantic version, e.g. 1.12.3


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

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

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

enum: CONSENT_LEVEL_TYPE_UNSPECIFIED 0 CUMULATIVE 1 GRANULAR 2

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


description:
(-- api-linter: core::0122::name-suffix=disabled
     aip.dev/not-precedent: We think file_name is a better name. --)


description: If omitted, files are read from the root of the bucket.


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

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


description: Default Murmurhash3 if empty


key: seed

description: hashing seed


key: field

description: generic field name


key: format

description: Java Time Format template, see https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html


description:
Represents a time zone from the
 [IANA Time Zone Database](https://www.iana.org/time-zones).


description: IANA Time Zone Database time zone, e.g. "America/New_York".


description: Optional. IANA Time Zone Database version number, e.g. "2019a".


description: Portman by Apideck allows you to port your OpenApi Spec to a Postman Collection, inject a powerful test suite, and run your tests with Newman. Details about all configuration options can be found at http://getportman.com.

required: searchFor replaceWith

required: username password


key: ignores

description: list of path from the current template to ignore


key: imports

description: list of template to import and to apply as part of this template


key: scripts

description: list of the scripts to apply at end of generation


description: set to true if the template content is under a `template` folder (not mixed with metadata)


key: variables

description: list of variables/parameters of the template


key: ImportCfg

description: define a template layer to import


key: label

description: display of the value (in select)


key: value

description: the value


key: cmd

description: command to execute


default answer for confirmation of execution


key: message

description: message to display


key: ask

description: sentence to ask the value (default to the name on variable)


optionnal default value


key: hidden

description: is the variable hidden to the user (could be usefull to cache shared variable/data)


description: name of variable used in the template


if non-empty then the value should selected into the list of value


description: A machine-friendly project name.

examples: apex-site apex-api ping-app


key: description

description: An optional project description.

examples:
Marketing site
Public API


key: type

description: The type of project.

default: server

enum: static server


key: profile

description: AWS credentials profile name, these are stored in ~/.aws/credentials.

examples: apex-prod apex-dev personal


key: regions

description: List of target AWS regions for deployment.

examples: us-west-2 us-* eu-* *


key: items

description: AWS region.


key: accelerate

description: Enable S3 acceleration for faster uploads via the CloudFront CDN.


key: warm

description: Active warming mitigates cold starts when enabled.


description: Active warming sends requests to your application at this interval.


description: Number of concurrent containers to warm.


key: memory

description: Lambda memory size.


key: domain

description: Domain hostname for the stage.


key: build

description: Hook command(s) to run.


key: clean

description: Hook command(s) to run.


key: prebuild

description: Hook command(s) to run.


key: postbuild

description: Hook command(s) to run.


key: predeploy

description: Hook command(s) to run.


key: postdeploy

description: Hook command(s) to run.


key: dir

description: Path to directory from which assets are served.

examples: public ./dist


key: prefix

description: Optional URL path prefix.

examples: /public/ /static/


key: command

description: Command run to start your application.

default: ./server


key: timeout

description: Timeout in seconds per request.


description: Timeout in seconds Up will wait for your app to boot and listen on `PORT`.


description: Timeout in seconds Up will wait after sending a SIGINT to your server, before sending a SIGKILL.


key: min

description: Minimum time in milliseconds before retrying.


key: max

description: Maximum time in milliseconds before retrying.


key: factor

description: Factor applied to each attempt.


key: attempts

description: Attempts made before failing.


key: jitter

description: Apply jitter.


key: disable

description: Disable default error pages.


description: Path to directory from which error pages are served.


description: Support email for contact link.


key: color

description: Theme color.


key: enable

description: Enable Cross-Origin Resource Sharing.


key: items

description: A list of origins a cross-domain request can be executed from. Use `*` to allow any origin, or a wildcard such as `http://*.domain.com`.


description: A list of methods the client is allowed to use with cross-domain requests.

examples: GET HEAD


description: A list of headers the client is allowed to use with cross-domain requests. If the special `*` value is present in the list, all headers will be allowed.


description: A list of headers which are safe to expose to the API of a CORS response.


description: A number indicating how long (in seconds) the results of a preflight request can be cached.


description: A boolean indicating whether the request can include user credentials such as cookies, HTTP authentication or client side SSL certificates. Defaults to true.


key: name

description: Name of the action for reference from alert definitions.


key: type

description: Type of action to perform.

examples: email sms


description: Email addresses when using the email action.


description: Phone numbers when using the sms action.


key: metric

description: Name of the metric.


key: statistic

description: Name of statistic to perform.

enum: min max avg sum count

examples: avg sum


key: threshold

description: Threshold which is compared to the operator.


key: action

description: Name of the action to perform.


key: period

description: Period is the alert query time-span.

type: integer string


description: Number of periods to evaluate over.


key: operator

description: Operator is the comparison operator.


key: namespace

description: Metric namespace.


key: description

description: Informative alert description, displayed in the email, sms, or slack.


description: Disable the alert.


description: Configuration file for saucectl.

enum: apitest cypress espresso imagerunner playwright puppeteer-replay testcafe xcuitest playwright-cucumberjs

const: cypress

enum: always fail never pass

required: when match directory

default: .sauceignore

default: team

const: public

const: public restricted

const: share

const: team

const: private

const: fail rate

examples: dot nyan

required: configFile version

enum: chrome firefox microsoftedge

enum:
macOS 11.00
macOS 12
macOS 13
Windows 10
Windows 11

enum: concurrency spec

required: name browser config

required: apiVersion kind cypress suites


key: then

description: Configuration file for cypress using saucectl


description: Subschema for controlling artifacts


key: artifacts

description: Manage test output, such as logs, videos, and screenshots.


key: cleanup

description: Whether to remove all contents of artifacts directory


key: download

description: Settings related to downloading test artifacts from Sauce Labs.


key: match

description: Specifies which artifacts to download based on whether they match the file pattern provided. Supports the wildcard character '*'.


key: when

description: Specifies when and under what circumstances to download artifacts.


key: directory

description: Specifies the path to the folder in which to download artifacts. A separate subdirectory is generated in this location for each suite.


description: Subschema for npm specific settings


key: npm

description: Settings specific to npm.


key: packages

description: Specifies any npm packages that are required to run tests.


key: dependencies

description: Specify local npm dependencies for saucectl to upload. These dependencies must already be installed in the local node_modules directory.


key: registry

description: Override the default and official NPM registry URL with a custom one.


key: strictSSL

description: Whether or not to do SSL key validation when making requests to the registry via https.


key: registries

description: Specify all the registries you want to configure


key: scope

description: Scope for the registry entry


key: url

description: URL for the registry entry


key: authToken

description: authToken for the registry entry


description: Subschema for sauce specific settings


key: sauce

description: All settings related to how tests are run and identified in the Sauce Labs platform.


key: concurrency

description: Sets the maximum number of suites to execute at the same time. Excess suites are queued and run in order as each suite completes.


key: metadata

description: The set of properties that allows you to provide additional information about your project that helps you distinguish it in the various environments in which it is used and reviewed.


key: build

description: Sauce Labs can aggregate all jobs under one view based on their association with a build.


key: tags

description: Tag your jobs so you can find them easier in Sauce Labs.


key: region

description: Which Sauce Labs data center to target.


key: sauceignore

description: Path to the .sauceignore file.


key: tunnel

description: SauceCTL supports using Sauce Connect to establish a secure connection when running your tests on Sauce Labs. To do so, launch a tunnel; then provide the identifier in this property.


key: name

description: The tunnel name.


key: owner

description: The owner (username) of the tunnel. Must be specified if the user that created the tunnel differs from the user that is running the tests.


key: retries

description: The number of times to retry a failing suite.


key: visibility

description: Set the visibility level of test results for suites run on Sauce Labs.


key: launchOrder

description: Control starting order of suites. The default is the order in which suites are written in the config file.


key: then

description: Subschema for reporters specific settings


key: junit

description: The JUnit reporter merges test results from all jobs in the JUnit format into a single report.


key: enabled

description: Toggles the reporter on/off.


key: filename

description: Filename for the generated JUnit report.


key: json

description: The JSON reporter merges test results from all jobs in the JSON format into a single report.


key: webhookURL

description: Webhook URL to pass JSON report.


description: Filename for the generated JSON report.


key: showConsoleLog

description: Shows suites console.log locally. By default console.log is only shown on failures.


key: defaults

description: Settings that are applied onto every suite by default, if no value is set on a suite explicitly.


key: rootDir

description: The directory of files that need to be bundled and uploaded for the tests to run.


key: cypress

description: Contains details specific to the Cypress project.


key: configFile

description: The designated cypress configuration file. SauceCTL determines related files based on the location of the config file. By default saucectl defers to the test file location defined in cypress.json.


key: key

description: The secret key that grants permission to record your tests in the Cypress dashboard.


key: record

description: Whether to record your test results in the Cypress dashboard.


key: reporters

description: Set of reporter to use.


key: name

description: Name of the reporter. You may have to install the associated npm dependency through npm.packages field.


key: options

description: Options to pass to the reporter.


key: env

description: Set one or more environment variables. Values can be environment variables themselves. Not supported when running espresso/xcuitest!


key: suites

description: The set of properties providing details about the test suites to run.


description: The name of the test suite, which will be reflected in the test results in Sauce Labs.


key: browserVersion

description: Which version of the browser to use.


key: screenResolution

description: Specifies a browser window screen resolution, which may be useful if you are attempting to simulate a browser on a particular device type.


key: config

description: Provides details related to the Cypress test configuration.


key: testFiles

description: One or more paths to the Cypress test files to run for this suite, if not otherwise specified explicitly in cypress.json.


key: shard

description: When sharding is configured, saucectl automatically splits the tests (e.g. by spec or concurrency) so that they can easily run in parallel.


key: headless

description: Controls whether or not tests are run in headless mode (default: false)


key: preExec

description: Specifies which commands to execute before starting the tests.


key: timeZone

description: Specifies the timeZone for the suite.


key: passThreshold

description: The minimum number of successful attempts for a suite to be considered as 'passed'.


key: smartRetry

description: Optimize suite retries by configuring the strategy.


key: failedOnly

description: Optimize suite retries by retrying failed tests, classes or spec files only.


key: then

description: Configuration file for cypress using saucectl

enum: chrome firefox microsoftedge webkit


description: Subschema for controlling artifacts


key: artifacts

description: Manage test output, such as logs, videos, and screenshots.


key: cleanup

description: Whether to remove all contents of artifacts directory


key: download

description: Settings related to downloading test artifacts from Sauce Labs.


key: match

description: Specifies which artifacts to download based on whether they match the file pattern provided. Supports the wildcard character '*'.


key: when

description: Specifies when and under what circumstances to download artifacts.


key: directory

description: Specifies the path to the folder in which to download artifacts. A separate subdirectory is generated in this location for each suite.


description: Subschema for npm specific settings


key: npm

description: Settings specific to npm.


key: packages

description: Specifies any npm packages that are required to run tests.


key: dependencies

description: Specify local npm dependencies for saucectl to upload. These dependencies must already be installed in the local node_modules directory.


key: registry

description: Override the default and official NPM registry URL with a custom one.


key: strictSSL

description: Whether or not to do SSL key validation when making requests to the registry via https.


key: registries

description: Specify all the registries you want to configure


key: scope

description: Scope for the registry entry


key: url

description: URL for the registry entry


key: authToken

description: authToken for the registry entry


description: Subschema for sauce specific settings


key: sauce

description: All settings related to how tests are run and identified in the Sauce Labs platform.


key: concurrency

description: Sets the maximum number of suites to execute at the same time. Excess suites are queued and run in order as each suite completes.


key: metadata

description: The set of properties that allows you to provide additional information about your project that helps you distinguish it in the various environments in which it is used and reviewed.


key: build

description: Sauce Labs can aggregate all jobs under one view based on their association with a build.


key: tags

description: Tag your jobs so you can find them easier in Sauce Labs.


key: region

description: Which Sauce Labs data center to target.


key: sauceignore

description: Path to the .sauceignore file.


key: tunnel

description: SauceCTL supports using Sauce Connect to establish a secure connection when running your tests on Sauce Labs. To do so, launch a tunnel; then provide the identifier in this property.


key: name

description: The tunnel name.


key: owner

description: The owner (username) of the tunnel. Must be specified if the user that created the tunnel differs from the user that is running the tests.


key: retries

description: The number of times to retry a failing suite.


key: visibility

description: Set the visibility level of test results for suites run on Sauce Labs.


key: launchOrder

description: Control starting order of suites. The default is the order in which suites are written in the config file.


key: then

description: Subschema for reporters specific settings


key: junit

description: The JUnit reporter merges test results from all jobs in the JUnit format into a single report.


key: enabled

description: Toggles the reporter on/off.


key: filename

description: Filename for the generated JUnit report.


key: json

description: The JSON reporter merges test results from all jobs in the JSON format into a single report.


key: webhookURL

description: Webhook URL to pass JSON report.


description: Filename for the generated JSON report.


key: showConsoleLog

description: Shows suites console.log locally. By default console.log is only shown on failures.


key: defaults

description: Settings that are applied onto every suite by default, if no value is set on a suite explicitly.


key: timeout

description: Instructs how long (in ms, s, m, or h) saucectl should wait for a suite to complete.


key: rootDir

description: The directory of files that need to be bundled and uploaded for the tests to run.


key: cypress

description: Contains details specific to the Cypress project.


key: configFile

description: The designated cypress configuration file.


key: key

description: The secret key that grants permission to record your tests in the Cypress dashboard.


key: record

description: Whether to record your test results in the Cypress dashboard.


key: version

description: Which framework version to use.


key: reporters

description: Set of reporter to use.


key: name

description: Name of the reporter. You may have to install the associated npm dependency through npm.packages field.


key: options

description: Options to pass to the reporter.


key: env

description: Set one or more environment variables. Values can be environment variables themselves. Not supported when running espresso/xcuitest!


key: suites

description: The set of properties providing details about the test suites to run.


description: The name of the test suite, which will be reflected in the test results in Sauce Labs.


key: browser

description: The name of the browser in which to run the tests.


key: browserVersion

description: Which version of the browser to use.


key: platformName

description: A specific operating system on which to run the tests. Sauce Labs will try to choose a reasonable default if not explicitly specified.


key: screenResolution

description: Specifies a browser window screen resolution, which may be useful if you are attempting to simulate a browser on a particular device type.


key: config

description: Provides details related to the Cypress test configuration.


key: testingType

description: Specify the type of tests to execute; either e2e or component. Defaults to e2e


key: specPattern

description: One or more paths to the Cypress test files to run for this suite.


key: excludeSpecPattern

description: Exclude test files for this suite.


key: shard

description: When sharding is configured, saucectl automatically splits the tests (e.g. by spec or concurrency) so that they can easily run in parallel.


key: shardGrepEnabled

description: When sharding is configured and the suite is configured to filter using cypress-grep, let saucectl filter tests before executing.


key: headless

description: Controls whether or not tests are run in headless mode (default: false)


key: preExec

description: Specifies which commands to execute before starting the tests.


key: timeZone

description: Specifies the timeZone for the suite.


key: passThreshold

description: The minimum number of successful attempts for a suite to be considered as 'passed'.


key: smartRetry

description: Optimize suite retries by configuring the strategy.


key: failedOnly

description: Optimize suite retries by retrying failed tests, classes or spec files only.


key: then

description: Configuration file for espresso using saucectl

const: espresso

required: app testApp

enum: small medium large

enum: landscape portrait

required: name platformVersions

examples:
Google Pixel .*
Samsung .*

enum: ANY PHONE TABLET

required: apiVersion kind espresso suites


key: defaults

description: Settings that are applied onto every suite by default, if no value is set on a suite explicitly.


key: espresso

description: Contains details specific to the Espresso project.


key: app

description: Local path or remote url to the application. If a remote url is defined, the app will be downloaded to a local temp directory before uploading to the SauceLabs Mobile App Storage service. Supports environment variables as values.


key: appDescription

description: Description for the app


key: testApp

description: Local path or remote url to the test application. If a remote url is defined, the app will be downloaded to a local temp directory before uploading to the SauceLabs Mobile App Storage service. Supports environment variables as values.


key: testAppDescription

description: Description for the testApp


key: otherApps

description: A list of applications to be installed alongside the main app. Applications can be defined as a local path or a remote url. If a remote url is defined, the app will be downloaded to a local temp directory before uploading to the SauceLabs Mobile App Storage service. Supports environment variables as values.


key: suites

description: The set of properties providing details about the test suites to run.


key: name

description: The name of the test suite, which will be reflected in the test results in Sauce Labs.


key: testOptions

description: Allows you to control various details on how tests are executed.


key: class

description: Only run the specified classes.


key: notClass

description: Run all classes except those specified here.


key: func

description: Run all test classes that extend InstrumentationTestCase.


key: unit

description: Run all test classes that do not extend either InstrumentationTestCase or PerformanceTestCase.


key: perf

description: Run all test classes that extend PerformanceTestCase.


key: package

description: Only run tests in the specified package.


key: notPackage

description: Run all tests except those in this package.


key: size

description: Run only tests that are annotated with the matching size value.


key: annotation

description: Only run tests with this annotation.


key: notAnnotation

description: Run all tests except those with this annotation.


key: filter

description: Only run tests that pass all of the custom filters.


key: runnerBuilder

description: Use custom builders to run tests.


key: listener

description: Observe the test run with one or more RunListener.


key: newRunListenerMode

description: Use the new list of RunListeners during a test run.


key: numShards

description: When sharding is configured, saucectl automatically creates the sharded jobs for each of the devices defined for the suite based on the number of shards you specify. For example, for a suite testing a single emulator version that specifies 2 shards, saucectl clones the suite and runs one shard index on the first suite, and the other shard index on the identical clone suite.


key: clearPackageData

description: Removes all shared states from the testing device's CPU and memory at the completion of each test. Real devices only. Has to be used in conjunction with the 'useTestOrchestrator' flag.


key: useTestOrchestrator

description: Run each of your tests in its own Instrumentation instance to remove most of the app's shared state from the device CPU and memory between tests. Real devices only. Use this setting in conjunction with clearPackageData: true to completely remove all shared state.


key: emulators

description: Defines details for running this suite on virtual devices using an emulator.


key: name

description: The name of the emulator. To ensure name accuracy, check the list of supported virtual devices (https://app.saucelabs.com/live/web-testing/virtual).


key: orientation

description: The screen orientation to use.


key: platformVersions

description: The set of one or more versions of the device platform on which to run the test suite.


key: devices

description: Define details for running this suite on real devices.


key: id

description: Request a specific device for this test suite by its ID. You can look up device IDs in the Sauce Labs app or using our Devices API (https://docs.saucelabs.com/dev/api/rdc#get-devices).


description: Match the device name in full or partially (regex), which may provide a larger pool of available devices of the type you want.


key: platformVersion

description: The version of the Android operating system.


key: options

description: Further specify desired device attributes within the pool of devices that match the name and version criteria.


key: carrierConnectivity

description: Limit the device selection to those that are connected to a cellular network.


key: deviceType

description: Limit the device selection to a specific type of device.


key: private

description: Limit the device selection to only match from your organization's private pool.


key: appSettings

description: Overwrite real device settings.


key: audioCapture

description: Overwrite app settings for real device to capture audio.


key: instrumentation

description: Overwrite app settings for real device instrumentation.


key: networkCapture

description: Overwrite app settings for real device to capture network.


key: then

description: Configuration file for playwright using saucectl

const: playwright

enum: chromium firefox webkit chrome

required: name params testMatch

required: apiVersion kind playwright suites


key: defaults

description: Settings that are applied onto every suite by default, if no value is set on a suite explicitly.


key: playwright

description: Contains details specific to the Playwright project.


key: configFile

description: The path to playwright config file


key: suites

description: The set of properties providing details about the test suites to run.


key: name

description: The name of the test suite, which will be reflected in the test results in Sauce Labs.


key: testMatch

description: Paths to the playwright test files. Regex values are supported to indicate all files of a certain type or in a certain directory, etc.


key: excludedTestFiles

description: Exclude test files to skip the tests.


key: params

description: Details any additional parameters you wish to set for the test suite.


key: headless

description: Run tests in headless mode.


key: globalTimeout

description: Total timeout in milliseconds for the whole test run.


key: timeout

description: Changes the timeout for the test (milliseconds).


key: grep

description: Patterns to run tests based on their title.


key: grepInvert

description: Patterns to skip tests based on their title.


key: repeatEach

description: The number of times to repeat each test.


key: retries

description: The maximum number of retry attempts given to failed tests.


key: maxFailures

description: The maximum number of test failures for this test run. After reaching this number, testing will stop and exit with an error. Setting to zero (default) disables this behavior.


key: project

description: Specify playwright project


key: updateSnapshots

description: Whether to update expected snapshots with the actual results produced by the test run


key: workers

description: Set the maximum number of parallel worker processes (default: 1)


key: numShards

description: When sharding is configured, saucectl automatically creates the sharded jobs based on the number of shards you specify. For example, for a suite that specifies 2 shards, saucectl clones the suite and runs shard 1/2 on the first suite, and the other shard 2/2 on the identical clone suite.


key: shard

description: When sharding is configured, saucectl automatically splits the tests (e.g. by spec or concurrency) so that they can easily run in parallel.


key: shardGrepEnabled

description: When sharding is configured and the suite is configured to filter using grep/grepInvert, let saucectl filter specs before executing.


key: then

description: Configuration file for puppeteer-replay using saucectl

const: puppeteer-replay

required: name recordings

required: apiVersion kind suites


key: defaults

description: Settings that are applied onto every suite by default, if no value is set on a suite explicitly.


key: suites

description: The set of properties providing details about the test suites to run.


key: name

description: The name of the test suite, which will be reflected in the test results in Sauce Labs.


key: recordings

description: Relative paths to the chrome devtools recordings.


key: platform

description: A specific operating system on which to run the tests. Sauce Labs will try to choose a reasonable default if not explicitly specified.


description: Configuration file for testcafe using saucectl

const: testcafe

enum: chrome firefox microsoftedge safari

required: name browserName src

required: apiVersion kind testcafe suites


key: testcafe

description: Contains details specific to the TestCafe project.


key: browserArgs

description: Browser specific arguments.


key: headless

description: Controls whether or not tests are run in headless mode (default: false)


key: assertionTimeout

description: Specifies the time (in milliseconds) TestCafe attempts to successfully execute an assertion if a selector property or a client function was passed as an actual value.


key: clientScripts

description: Injects scripts into pages visited during the tests.


key: compilerOptions

description: Specifies the typescript compiler options to be used when running the tests.


key: typescript

description: Specifies the TypeScript options.


key: configPath

description: Specifies the path to the TypeScript tsconfig.json file.


key: customCompilerModulePath

description: Specifies the path to a custom TypeScript compiler module.


key: options

description: Specifies TypeScript compiler options. Full reference: https://www.typescriptlang.org/tsconfig#compilerOptions


key: disablePageCaching

description: Prevents the browser from caching page content.


key: disableScreenshots

description: Prevents TestCafe from taking screenshots.


key: disableVideo

description: Disable video recording.


key: filter

description: Allows you to specify which tests or fixtures to run.


key: test

description: Runs a test with the specified name.


key: testGrep

description: Runs tests whose names match the specified grep pattern.


key: testMeta

description: Runs tests whose metadata matches the specified key-value pair.


key: fixture

description: Runs a test with the specified fixture name.


key: fixtureGrep

description: Runs tests whose fixture names match the specified grep pattern.


key: fixtureMeta

description: Runs tests whose fixture’s metadata matches the specified key-value pair.


key: pageLoadTimeout

description:
Specifies the time (in milliseconds) passed after the DOMContentLoaded event, within which TestCafe waits for the window.load event to fire.

After the timeout passes or the window.load event is raised (whichever happens first), TestCafe starts the test.


key: quarantineMode

description: Enable quarantine mode to eliminate false negatives and detect unstable tests. TestCafe quarantines tests that fail, and repeats them until they yield conclusive results.


key: successThreshold

description: The number of successful attempts necessary to confirm a test’s success. The option value should be greater than 0.


key: attemptLimit

description: The maximum number of test execution attempts. The option value must be larger than the value of the successThreshold.


key: screenshots

description: Allows you to specify the screenshot options.


key: takeOnFails

description: Specifies that a screenshot should be taken whenever a test fails.


key: fullPage

description: Specifies that the full page should be captured, including content that is not visible due to overflow.


key: selectorTimeout

description: Specifies the time (in milliseconds) within which selectors attempt to return a node.


key: ajaxRequestTimeout

description: Specifies wait time (in milliseconds) for fetch/XHR requests.


key: pageRequestTimeout

description: Specifies time (in milliseconds) to wait for HTML pages.


key: browserInitTimeout

description: Time (in milliseconds) for browsers to connect to TestCafe and report that they are ready to test.


key: testExecutionTimeout

description: Maximum test execution time (in milliseconds).


key: runExecutionTimeout

description: Maximum test run execution time (in milliseconds).


key: simulators

description: Run tests against the simulators defined here.


key: name

description: The name of the simulator.


key: platformName

description: The name of the simulator platform.


key: platformVersions

description: Which platform versions (OS versions) should be used. Multiple values are treated as 'AND', thus tests run across multiple versions.


key: skipJsErrors

description: Determines whether to ignore JavaScript errors on a webpage.


key: skipUncaughtErrors

description: Ignores uncaught errors and unhandled promise rejections in test code.


key: speed

description: Specifies the test execution speed. Provide a number between 1 (the fastest) and 0.01 (the slowest).


key: src

description: Specifies files or directories from which to run tests.


key: stopOnFirstFail

description: Stops a test run if a test fails.


key: then

description: Configuration file for xcuitest using saucectl

const: xcuitest

enum: Yes No

examples:
iPad .*
iPhone .*


key: defaults

description: Settings that are applied onto every suite by default, if no value is set on a suite explicitly.


key: xcuitest

description: Contains details specific to the XCUITest project.


key: app

description: Local path or remote url to the application. If a remote url is defined, the app will be downloaded to a local temp directory before uploading to the SauceLabs Mobile App Storage service. Supports environment variables as values.


key: appDescription

description: Description for the app.


key: testApp

description: Local path or remote url to the test application. If a remote url is defined, the app will be downloaded to a local temp directory before uploading to the SauceLabs Mobile App Storage service. Supports environment variables as values.


key: testAppDescription

description: Description for the testApp.


key: otherApps

description: A list of applications to be installed alongside the main app. Applications can be defined as a local path or a remote url. If a remote url is defined, the app will be downloaded to a local temp directory before uploading to the SauceLabs Mobile App Storage service. Supports environment variables as values. When targeting simulators, a maximum of 2 otherApps is supported.


key: suites

description: The set of properties providing details about the test suites to run.


key: name

description: The name of the test suite, which will be reflected in the test results in Sauce Labs.


key: testOptions

description: Allows you to control various details on how tests are executed.


key: class

description: Only run the specified classes.


key: notClass

description: Run all classes except those specified here.


key: testLanguage

description: Specifies ISO 639-1 language during testing. Supported on Simulators only.


key: testRegion

description: Specifies ISO 3166-1 region during testing.


key: testTimeoutsEnabled

description: By default there is no timeout, if enabled, then the timeout is 600 seconds. This can be changed by adding the defaultTestExecutionTimeAllowance value. Supported on Simulators only.


key: maximumTestExecutionTimeAllowance

description: The maximum execution time, in seconds, an individual test is given to execute, regardless of the test's preferred allowance. Supported on Simulators only.


key: defaultTestExecutionTimeAllowance

description: The default execution time, in seconds, an individual test is given to execute if test timeouts are enabled. Supported on Simulators only.


key: simulators

description: Defines details for running this suite on virtual devices using a simulator.


description: The name of the simulator. To ensure name accuracy, check the list of supported virtual devices (https://app.saucelabs.com/live/web-testing/virtual).


key: platformVersions

description: The set of one or more versions of the device platform on which to run the test suite.


key: devices

description: Define details for running this suite on real devices.


key: id

description: Request a specific device for this test suite by its ID. You can look up device IDs in the Sauce Labs app or using our Devices API (https://docs.saucelabs.com/dev/api/rdc#get-devices).


description: Match the device name in full or partially (regex), which may provide a larger pool of available devices of the type you want.


key: platformVersion

description: The version of the iOS operating system.


key: options

description: Further specify desired device attributes within the pool of devices that match the name and version criteria.


key: carrierConnectivity

description: Limit the device selection to those that are connected to a cellular network.


key: deviceType

description: Limit the device selection to a specific type of device.


key: private

description: Limit the device selection to only match from your organization's private pool.


key: shard

description: When shard is configured as concurrency, saucectl automatically splits the tests by concurrency so that they can easily run in parallel.


key: testListFile

description: This file containing tests will be used in sharding by concurrency.


key: then

description: Configuration file for api testing using saucectl

const: apitest

required: projectName name


key: suites

description: The set of properties providing details about the test suites to run.


key: name

description: The name of the test suite, which will be reflected in the test results in Sauce Labs.


key: projectName

description: Your project's name.


key: tests

description: A list of test IDs to run for the project defined by hookId.


key: tags

description: A test tag to run for the project defined by hookId.


key: useRemoteTests

description: Use tests stored in the cloud instead of the local ones.


description: Configuration file for cucumber using saucectl

const: playwright-cucumberjs


key: defaults

description: Settings that are applied onto every suite by default, if no value is set on a suite explicitly.


key: playwright

description: Contains details specific to the playwright.


key: version

description: Which framework version to use.


key: browserName

description: The name of the browser in which to run the tests.


key: options

description: Provides details related to the Cucumberjs test configuration.


key: config

description: Provides the location of the configuration file.


description: Regular expressions of which cucumber scenario names should match one of to be run.


key: paths

description: Paths to where your feature files are.


key: backtrace

description: Show the full backtrace for errors.


key: require

description: Paths to where your support code is, for CommonJS.


key: import

description: Paths to where your support code is, for ESM.


description: Tag expression to filter which scenarios should be run.


key: format

description: Name/path and (optionally) output file path of each formatter to use.


key: formatOptions

description: Options to be provided to cucumber formatters.


key: parallel

description: Run tests in parallel with the given number of worker processes.


key: shard

description: When sharding is configured, saucectl automatically splits the tests (e.g. by spec or concurrency) so that they can easily run in parallel.


key: then

description: Configuration file for running container images using saucectl

enum: webdriver other

required: name workload

const: imagerunner


key: sauce

description: All settings related to how tests are run and identified in the Sauce Labs platform.


key: region

description: Which Sauce Labs data center to target.


key: tunnel

description: SauceCTL supports using Sauce Connect to establish a secure connection when running your tests on Sauce Labs. To do so, launch a tunnel; then provide the identifier in this property.


key: name

description: The tunnel name.


key: owner

description: The owner (username) of the tunnel. Must be specified if the user that created the tunnel differs from the user that is running the tests.


key: suite

description: The set of properties providing details about how to run the container.


description: The name of the test suite.


key: image

description: The name of the container image.


key: imagePullAuth

description: Container registry credentials for accessing the image.


key: user

description: The username.


key: token

description: The access token.


key: entrypoint

description: The command line arguments to launch the image with.


key: files

description: List of files that you'd like saucectl to upload and mount within the container.


key: src

description: Path to the local file.


key: dst

description: Path within the container that the file should be mounted at.


key: artifacts

description: List of file paths within the container to be made available as downloadable artifacts.


key: env

description: Set one or more environment variables.


key: timeout

description: Instructs how long (in ms, s, m, or h) saucectl should wait for a suite to complete.


key: workload

description: Sets the kind of workload that is being executed


key: resourceProfile

description: Sets the CPU/memory limits of the container. Format is <CPU><level><mem><level>. Default to c1m1.


key: metadata

description: Supply additional metadata to your runner.


key: defaults

description: Settings that are applied onto every suite as a default value.


key: suites

description: List of suites


description: Spec contains pipeline configuration


key: name

description: Name defines a pipeline name


key: pipelineid

description: PipelineID allows to identify a full pipeline run, this value is propagated into each target if not defined at that level


key: autodiscovery

description: AutoDiscovery defines parameters to the autodiscovery feature


key: crawlers

description: Crawlers defines a map of crawler configuration where the key represent the crawler type


key: golang/gomod

description: Spec defines the parameters which can be provided to the Golang autodiscovery builder.


key: rootdir

description: rootDir defines the root directory used to recursively search for golang go.mod


key: ignore

description: ignore allows to specify "rule" to ignore autodiscovery a specific go.mod rule


key: items

description: MatchingRule allows to specifies rules to identify manifest


key: path

description: Path specifies a go.mod path pattern, the pattern requires to match all of name, not just a substring.


key: modules

description: Modules specifies a list of module pattern.


key: goversion

description: GoVersions specifies a list of version pattern.


key: only

description: `only` allows to specify rule to "only" autodiscover manifest for a specific golang rule


key: versionfilter

description:
`versionfilter` provides parameters to specify the version pattern to use when generating manifest.

		kind - semver
			versionfilter of kind `semver` uses semantic versioning as version filtering
			pattern accepts one of:
				`patch` - patch only update patch version
				`minor` - minor only update minor version
				`major` - major only update major versions
				`a version constraint` such as `>= 1.0.0`

		kind - regex
			versionfilter of kind `regex` uses regular expression as version filtering
			pattern accepts a valid regular expression

		example:
		```
			versionfilter:
				kind: semver
				pattern: minor
		```

		and its type like regex, semver, or just latest.


key: kind

description: specifies the version kind such as semver, regex, or latest


key: pattern

description: specifies the version pattern according the version kind


key: strict

description: strict enforce strict versioning rule. Only used for semantic versioning at this time


key: helm

description: Spec defines the Helm parameters.


key: auths

description:
auths provides a map of registry credentials where the key is the registry URL without scheme
		if empty, updatecli relies on OCI credentials such as the one used by Docker.


description: InlineKeyChain defines a keychain with OCI registry credentials


key: username

description:
username specifies the container registry username to use for authentication.

		compatible:
			* source
			* condition
			* target

		default:
			by default credentials are fetch from the local environment such as `~/.docker/config.json`.

		remark:
			Not compatible with token


key: password

description:
password specifies the container registry password to use for authentication. Not compatible with token

		compatible:
			* source
			* condition
			* target

		default:
			by default credentials are fetch from the local environment such as `~/.docker/config.json`.

		remark:
			Not compatible with token


key: token

description:
token specifies the container registry token to use for authentication.

		compatible:
			* source
			* condition
			* target

		default:
			by default credentials are fetch from the local environment such as `~/.docker/config.json`.

		remark:
			Not compatible with username/password


key: ignorecontainer

description: ignorecontainer disables OCI container tag update when set to true


key: ignorechartdependency

description: ignorechartdependency disables Helm chart dependencies update when set to true


key: ignore

description: Ignore specifies rule to ignore Helm chart update.


key: items

description: MatchingRule allows to specifies rules to identify manifest


key: path

description: Path specifies a Helm chart path pattern, the pattern requires to match all of name, not just a subpart of the path.


key: rootdir

description: rootdir defines the root directory used to recursively search for Helm Chart


description: only specify required rule(s) to restrict Helm chart update.


description:
versionfilter provides parameters to specify the version pattern used when generating manifest.

		kind - semver
			versionfilter of kind `semver` uses semantic versioning as version filtering
			pattern accepts one of:
				`patch` - patch only update patch version
				`minor` - minor only update minor version
				`major` - major only update major versions
				`a version constraint` such as `>= 1.0.0`

		kind - regex
			versionfilter of kind `regex` uses regular expression as version filtering
			pattern accepts a valid regular expression

		example:
		```
			versionfilter:
				kind: semver
				pattern: minor
		```

		and its type like regex, semver, or just latest.


key: versionincrement

description: [target] Defines if a Chart changes, triggers, or not, a Chart version update, accepted values is a comma separated list of "none,major,minor,patch"


key: helmfile

description: Spec defines the Helmfile parameters.


description: rootdir defines the root directory used to recursively search for Helmfile manifest


description: Ignore allows to specify rule to ignore "autodiscovery" a specific Helmfile based on a rule


description: Path specifies a Helmfile chart path pattern, the pattern requires to match all of name, not just a subpart of the path.


key: only

description: Only allows to specify rule to only "autodiscovery" manifest for a specific Helmfile based on a rule


description: Auths provides a map of registry credentials where the key is the registry URL without scheme


description: InlineKeyChain defines a keychain with OCI registry credentials


description:
username specifies the container registry username to use for authentication.

		compatible:
			* source
			* condition
			* target

		default:
			by default credentials are fetch from the local environment such as `~/.docker/config.json`.

		remark:
			Not compatible with token


description:
password specifies the container registry password to use for authentication. Not compatible with token

		compatible:
			* source
			* condition
			* target

		default:
			by default credentials are fetch from the local environment such as `~/.docker/config.json`.

		remark:
			Not compatible with token


description:
token specifies the container registry token to use for authentication.

		compatible:
			* source
			* condition
			* target

		default:
			by default credentials are fetch from the local environment such as `~/.docker/config.json`.

		remark:
			Not compatible with username/password


key: kind

description: specifies the version kind such as semver, regex, or latest


key: pattern

description: specifies the version pattern according the version kind


key: strict

description: strict enforce strict versioning rule. Only used for semantic versioning at this time


key: cargo

description: Spec defines the Cargo parameters.


description: RootDir defines the root directory used to recursively search for Cargo.toml


description: Ignore specifies rule to ignore Cargo.toml update.


description: MatchingRule allows to specifies rules to identify manifest


description: Path specifies a Cargo crate path pattern, the pattern requires to match all of name, not just a subpart of the path.


description: Only specify required rule to restrict Cargo.toml update.


key: registries


key: auth

description: [A][S][C] Auth specifies the cargo registry auth to use for authentication.


description: [A][S][C] Token specifies the cargo registry token to use for authentication.


key: headerformat

description: [A][S][C] HeaderFormat specifies the cargo registry header format to use for authentication (defaults to `Bearer`).


key: url

description: [A][S][C] URL specifies the cargo registry URL to use for authentication.


description: [A][S][C] RootDir specifies the cargo registry root directory to use as FS index.


key: scmid

description: [A] SCMID specifies the cargo registry scmId to use as FS index.