lsdlschema.json

description: Linguistic Schema Definition Language schema

title: LSDL Schema


title: .fossa.yaml

description: .fossa.yaml specification for FOSSA CLI 2.x or greater

type: object

description: The project fields allow you to configure settings for the project you are interacting with through the FOSSA API.

type: string

description:
The project ID defines a unique ID that the FOSSA API will use to reference this project. The project ID can be found in the UI on the project settings page listed as the `Project Locator` underneath the `Project Title` setting.

By default, it will use git remote origin url as project id if it's git repository. If it does not recognize version control system (vcs), project directory's name will be used.

description: The name field sets the projects visible name in the FOSSA dashboard. By default, this will be set to the project's ID.

description: The name of the team in your FOSSA organization to associate this project with.

type: integer

description: The id of the policy in your FOSSA organization to associate this project with. Mutually excludes `project.policy`.

description: An external link that will appear in the FOSSA UI for this specific project.

description: The URL of your project that will appear in FOSSA. This URL is intended to be the URL to the repository of this project.

description: The Jira Project Key to associate with your project for improved issue triage. Refer to https://docs.fossa.com/docs/atlassian-jira#linking-fossa-projects-to-jira-projects for more information.

description: The name of release group.

description: The release associated with the release group

description: The `name:` and `release:` of the release group's release to add your project to in the FOSSA dashboard. If you choose to associate a project with a release group, you **must** supply both name and release.

required: name release

type: array

description: A list of labels that are assigned to the project

description: The telemetry fields are used to configure telemetry data collection and it's destination.

const: full

description: Collects and sends ends telemetry data to server.

const: off

description: Does not send telemetry data to server.

description: project branch is an optional setting used for organizing project revisions in the FOSSA UI. The branch field is intended to function similar to how Git defines a branch.

description: The commit is used to identify a specific scan for a project (determined by project.id). This is intended to be used identically to how Git treats commit hashes. If not provided, cli will parse current HEAD state from .git directory. If project does not have version control system, unix timestamp will be used.

description: The revision fields are used to help FOSSA differentiate between one upload for a project and another, just as GitHub uses commit hashes and branch names.

const: bundler

description: For bundler targets (ruby)

const: cargo

description: For cargo targets (rust)

const: carthage

description: For carthage targets (ios, objective-c)

const: cocoapods

description: For cocoapod targets (ios, objective-c, swift)

const: composer

description: For composer targets (php)

const: conda

description: For conda targets

const: glide

description: For glide targets (golang)

const: godep

description: For godep targets (golang)

const: gradle

description: For gradle targets (kotlin and java)

const: leiningen

description: For leiningen targets (clojure)

const: maven

description: For maven targets (kotlin and java)

const: mix

description: For mix targets (elixir)

const: npm

description: For npm targets (javascript)

const: nimble

description: For nimble targets (nim)

const: pub

description: For pub targets (dart, flutter)

description: For rebar3 targets (erlang)

const: rpm

description: For rpm targets

const: renv

description: For renv targets (r)

const: scala

description: For scala targets

const: swift

description: For swift targets

const: yarn

description: For yarn targets (javascript)

const: repomanifest

description: For repomanifest

const: cabal

description: For cabal targets (haskell)

const: stack

description: For stack targets (haskell)

const: nuspec

description: For nuspec targets (dotnet)

const: packagereference

description: For package reference targets (dotnet)

const: paket

description: For paket targets (dotnet)

const: projectassetjson

description: For project asset json targets (dotnet)

const: pipenv

description: For pipenv targets (python)

const: poetry

description: For poetry targets (python)

const: setuptools

description: For setuptools targets (python)

const: perl

description: For perl targets (using *META.{json,yml})

const: pnpm

description: For pnpm targets (javascript)

const: pdm

description: For pdm targets (python)

description: Target (package manager)

description: Associated path with target type (if any)

description: Experimental preferences with fossa cli.

description: Gradle preferences for all targets

description: Configurations to only include in analysis (by default excludes any other configurations not listed)

description: the vendoredDependencies fields allow you to configure vendored dependency scans. Vendored dependency scans are described in https://github.com/fossas/fossa-cli/blob/master/docs/features/vendored-dependencies.md

type: boolean

description: If true, forces a re-scan of all vendored dependencies on every run. If false or not present, then we do not re-scan vendored dependencies that have been previously scanned. A vendored dependency has been previously scanned if a dependency with the same name and version has already been scanned by your organization. If no version is provided, then any change in the files being scanned will result in a rescan.

const: ArchiveUpload

description: Vendored dependencies are scanned by the "Archive Upload" method, as described in https://github.com/fossas/fossa-cli/blob/master/docs/features/vendored-dependencies.md

const: CLILicenseScan

description: Vendored dependencies are scanned by the "CLI-side license scan" method, as described in https://github.com/fossas/fossa-cli/blob/master/docs/features/vendored-dependencies.md

description: licenseScanPathFilters allows you to filter which files are scanned when doing a CLILicenseScan. This setting does not apply if you use the ArchiveUpload method of scanning vendoredDependencies.

description: A list of globs that will be used to filter paths. If there are any entries in the `only` list, then only paths that match one or more of the globs in the `only` list will be scanned for licenses.

description: A list of globs that will be used to filter paths. If there are any entries in the `exclude` list, then paths that match any of the `exclude` entries will not be scanned for licenses.

description:
Specifies the version of configuration file. Versions 1 and 2 were used by CLI versions up until CLI 2.0.0 and are no longer supported.

CLI 2.x and greater only supports version 3.

description:
Sets the endpoint that the CLI will send requests to. This field should only be modified if your FOSSA account lives on a different server than app.fossa.com.

This is most commonly needed with on-premise instances of FOSSA.

description: Sets the https://docs.fossa.com/docs/api-reference#api-tokens that is required for accessing the FOSSA API and uploading data (e.g. `fossa analyze`) or retrieving information (e.g. `fossa test`) about a project.

$ref: #/$defs/project

$ref: #/$defs/telemetry

$ref: #/$defs/vendoredDependencies

$ref: #/$defs/revision

description: The targets filtering allows you to specify the exact targets which be should be scanned.

description: The list of `only` targets that should be scanned.

$ref: #/$defs/targetFilter

description:
The list of `exclude` targets which should be excluded from scanning. The targets listed in the exclude section will override the targets listed in the only sections.

This feature is used most effectively to remove specific targets from a directory.

description: The paths filtering section allows you to specify which paths should be scanned and which should not. The paths should be listed as their location from the root of your project.

description: The list of paths to only allow scanning within.

description: The list of paths to exclude from scanning in your directory.


compose-spec.json

title: Compose Specification

description: The Compose file is a YAML file defining a multi-containers based application.

description: declared for backward compatibility, ignored.

description: define the Compose project name, until user defines one explicitly.

$ref: #/definitions/include

description: compose sub-projects to be included.

$ref: #/definitions/service

$ref: #/definitions/network

$ref: #/definitions/volume

$ref: #/definitions/secret

$ref: #/definitions/config

$ref: #/definitions/deployment

type: integer string

enum: host private

$ref: #/definitions/command

type: number string

type: string number

format: expose

$ref: #/definitions/healthcheck

enum: always never if_not_present build missing


entity.beef.json

title: JSON Schema for Beef Entity code-generation (https://github.com/Avanade/Beef).

title: 'CodeGeneration' object (entity-driven)

description: The 'CodeGeneration' object defines global properties that are used to drive the underlying entity-driven code generation.

title: The namespace for the Reference Data entities (adds as a c# 'using' statement).

description: Defaults to 'Company' + '.' (literal) + AppName + '.' (literal) + 'EntityUsing' + '.Entities' (literal).

title: The namespace for the Reference Data common entities (adds as a c# 'using' statement).

description: Defaults to 'Company' + '.' (literal) + AppName + '.Common.Entities' (literal).

title: Indicates whether a corresponding 'Text' property is added when generating a Reference Data 'Property' for an 'Entity'.

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').

title: The 'RouteAtttribute' for the Reference Data Web API controller required for named pre-fetching. The 'WebApiRoutePrefix' will be prepended where specified.

title: The cache used for the ReferenceData providers.

description: Defaults to 'ReferenceDataCache'. A value of 'ReferenceDataCache' specifies a single-tenant cache; otherwise, 'ReferenceDataMultiTenantCache' for a multi-tenant cache leverageing the 'ExecutionContext.TenantId'.

title: The Reference Data entity namespace appended to end of the standard 'company.appname.Common.Entities.{AppendToNamespace}'.

description: Defaults to 'null'; being nothing to append.

title: The namespace for the Reference Data entities (adds as a c# 'using' statement) for additional business-layer inclusion where requried.

title: The entity scope option.

description: Defaults to 'Common' for backwards compatibility; 'Autonomous' is **recommended**. Determines where the entity is scoped/defined, being 'Common' or 'Business' (i.e. not externally visible). Additionally, there is the special case of 'Autonomous' where both a 'Common' and 'Business' entity are generated (where only the latter inherits from 'EntityBase', etc).

enum: Common Business Autonomous

title: The namespace for the non Reference Data entities (adds as a c# <c>using</c> statement).

description: Defaults to 'Common' (unless 'EntityScope' is 'Autonomous' and then it will default to 'Business') which will add '.Common.Entities'. Additionally, 'Business' to add '.Business.Entities', 'All' to add both, and 'None' to exclude any. This can be overridden for each 'Entity'.

enum: Common Business All None

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

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

title: The default JSON name for the 'ETag' property.

description: Defaults to 'etag'. Note that the 'JsonName' can be set individually per property where required.

enum: etag eTag _etag _eTag ETag ETAG

title: The additional Namespace using statement to be added to the generated 'Entity' code.

description: Typically used where referening a 'Type' from a Namespace that is not generated by default.

title: The authorize attribute value to be used for the corresponding entity Web API controller; generally either 'Authorize' or 'AllowAnonymous'.

description: This can be overridden within the 'Entity'(s) and/or their corresponding 'Operation'(s).

title: Indicates whether to create and use a domain-specific 'WebApi.WebApiAgentArgs' to simplify dependency injection usage.

title: Indicates whether the HTTP Response Location Header route ('Operation.WebApiLocation') is automatically inferred.

description: This will automatically set the 'Operation.WebApiLocation' for an 'Operation' named 'Create' where there is a corresponding named 'Get'. This can be overridden within the 'Entity'(s).

title: The 'RoutePrefixAtttribute' for the corresponding entity Web API controller.

description: This is the base (prefix) 'URI' prepended to all entity and underlying 'Operation'(s).

description: Defaults to 'Business'. A value of 'Business' indicates that the Validators will be defined within the 'Business' namespace/assembly; otherwise, defined within the 'Common' namespace/assembly.

enum: Business Common

title: The .NET database interface name (used where 'Operation.AutoImplement' is 'Database').

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

title: The default database schema name.

description: Defaults to 'dbo'.

title: The .NET Entity Framework interface name used where 'Operation.AutoImplement' is 'EntityFramework'.

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

title: The .NET Entity Framework interface name used where 'Operation.AutoImplement' is 'Cosmos'.

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

title: The .NET OData interface name used where 'Operation.AutoImplement' is 'OData'.

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

title: The default .NET HTTP Agent interface name used where 'Operation.AutoImplement' is 'HttpAgent'.

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

title: The default Reference Data property 'Converter' used by the generated 'Mapper'(s) where not specifically defined.

description: Defaults to 'ReferenceDataCodeConverter<T>'. Where this value is suffixed by '<T>' or '{T}' this will automatically set 'Property.DataConverterIsGeneric' to 'true'.

title: The additional Namespace using statement to be added to the generated 'Data' code.

title: The additional Namespace using statement to be added to the generated 'Data' code where 'Operation.AutoImplement' is 'Database'.

title: The additional Namespace using statement to be added to the generated 'Data' code where 'Operation.AutoImplement' is 'EntityFramework'.

title: additional Namespace using statement to be added to the generated 'Data' code where 'Operation.AutoImplement' is 'Cosmos'.

title: additional Namespace using statement to be added to the generated 'Data' code where 'Operation.AutoImplement' is 'OData'.

title: The layer to add logic to publish an event for a 'Create', 'Update' or 'Delete' operation.

description: Defaults to 'DataSvc'; unless the 'EventOutbox' is not 'None' where it will default to 'Data'. Used to enable the sending of messages to the likes of EventHub, Service Broker, SignalR, etc. This can be overridden within the 'Entity'(s).

enum: None DataSvc Data

title: The the data-tier event outbox persistence technology (where the events will be transactionally persisted in an outbox as part of the data-tier processing).

description: Defaults to 'None'. A value of 'Database' will result in the 'DatabaseEventOutboxInvoker' being used to orchestrate.

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

description: The event source is only updated where an 'EventSourceKind' is not 'None'. This can be extended within the 'Entity'(s).

title: The URI kind for the event source URIs.

description: Defaults to 'None' (being the event source is not updated).

enum: None Absolute Relative RelativeOrAbsolute

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

description: Used to enable the sending of messages to the likes of EventHub, Service Broker, SignalR, etc. This can be overridden within the 'Entity'(s).

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

description: Defaults to 'NameAndKey' (being the event subject name appended with the corresponding unique key.)'.

enum: NameOnly NameAndKey

title: The subject path separator.

description: Defaults to '.'. Used only where the subject is automatically inferred.

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

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

title: The casing for the Subject and Action (with the exception of the key)

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

enum: None Lower Upper

title: Indicates whether a 'System.TransactionScope' should be created and orchestrated at the 'DataSvc'-layer whereever generating event publishing logic.

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 'false'. This essentially defaults the 'Entity.EventTransaction' where not otherwise specified. This should only be used where 'EventPublish' is 'DataSvc' and a transactionally-aware data source is being used.

title: Indicates whether gRPC support (more specifically service-side) is required.

description: gRPC support is an explicit opt-in model. Must be set to 'true' for any of the subordinate gRPC capabilities to be code-generated. Will require each 'Entity', and corresponding 'Property' and 'Operation' to be opted-in specifically.

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

description: Defaults to 'Company' (runtime parameter) + '.' + 'AppName' (runtime parameter). For example 'Beef.Demo'.

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

description: Defaults to 'PathBase' + '.Common' (literal). For example 'Beef.Demo.Common'.

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

description: Defaults to 'PathBase' + '.Business' (literal). For example 'Beef.Demo.Business'.

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

description: Defaults to 'PathBase' + '.' + 'ApiName' (runtime parameter). For example 'Beef.Demo.Api'.

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

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

description: Defaults to 'NamespaceBase' + '.Common' (literal). For example 'Beef.Demo.Common'.

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

description: Defaults to 'NamespaceBase' + '.Business' (literal). For example 'Beef.Demo.Business'.

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

description: Defaults to 'NamespaceBase' + '.' + 'ApiName' (runtime parameter). For example 'Beef.Demo.Api'.

title: The corresponding 'Entity' collection.

$ref: #/definitions/Entity

title: 'Entity' object (entity-driven)

description: The 'Entity' is used as the primary configuration for driving the entity-driven code generation.

title: The unique entity name.

title: The overriding text for use in comments.

description: Overrides the Name (as sentence text) for the summary comments. It will be formatted as: 'Represents the {Text} entity.'. To create a '<see cref="XXX"/>' within use moustache shorthand (e.g. {{Xxx}}).

title: The overriding file name.

description: Overrides the Name as the code-generated file name.

title: The entity scope option.

description: Defaults to the 'CodeGeneration.EntityScope'. Determines where the entity is scoped/defined, being 'Common' or 'Business' (i.e. not externally visible). Additionally, there is a special case of 'Autonomous' where both a 'Common' and 'Business' entity are generated (where only the latter inherits from 'EntityBase', etc).

description: Defaults to 'EntityScope' ('Autonomous' will result in 'Business'). A value of 'Common' will add '.Common.Entities', 'Business' will add '.Business.Entities', 'All' to add both, and 'None' to exclude any.

title: The overriding private name.

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

title: The overriding argument name.

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

title: The Const .NET Type option.

description: The .NET Type to be used for the 'const' values. Defaults to 'string'.

enum: int long Guid string

title: Indicates whether to override the 'ICleanup.IsInitial' property.

description: Set to either 'true' or 'false' to override as specified; otherwise, 'null' to check each property. Defaults to 'null'.

title: The Reference Data identifier Type option.

description: Required to identify an entity as being Reference Data. Specifies the underlying .NET Type used for the Reference Data identifier.

title: Indicates whether a corresponding 'Text' property is added when generating a Reference Data 'Property' overriding the 'CodeGeneration.RefDataText' selection.

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').

title: The Reference Data sort order option.

description: Specifies the default sort order for the underlying Reference Data collection. Defaults to 'SortOrder'.

enum: SortOrder Id Code Text

title: The Reference Data 'ToString' composite format.

description: The string format supports the standard composite formatting; where the following indexes are used: '{0}' for 'Id', '{1}' for 'Code' and '{2}' for 'Text'. Defaults to '{2}'.

title: The base class that the entity inherits from.

description: Defaults to 'EntityBase' for a standard entity. For Reference Data it will default to 'ReferenceDataBaseXxx' depending on the corresponding 'RefDataType' value. See 'OmitEntityBase' if the desired outcome is to not inherit from any of the aforementioned base classes.

title: The list of comma separated interfaces that are to be declared for the entity class.

title: Indicates whether to automatically infer the interface implements for the entity from the properties declared.

description: Will attempt to infer the following: 'IGuidIdentifier', 'IInt32Identifier', 'IInt64Identifier', 'IStringIdentifier', 'IETag' and 'IChangeLog'. Defaults to 'true'.

title: Indicates whether the class should be defined as abstract.

title: Indicates whether the class should be defined as a generic with a single parameter 'T'.

title: The entity namespace to be appended.

description: Appended to the end of the standard structure as follows: '{Company}.{AppName}.Common.Entities.{Namespace}'.

title: Indicates that the entity should not inherit from 'EntityBase'.

description: As such any of the 'EntityBase' related capabilites are not supported (are omitted from generation). The intention for this is more for the generation of simple internal entities.

description: Defaults to the 'CodeGeneration.JsonSerializer' configuration property where specified; otherwise, 'Newtonsoft'.

title: Indicates whether a corresponding entity collection class should be created.

title: Indicates whether a corresponding entity collection result class should be created

description: Enables the likes of additional paging state to be stored with the underlying collection.

title: Indicates whether the entity collection is keyed using the properties defined as forming part of the unique key.

title: The base class that a 'Collection' inherits from.

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

title: The base class that a 'CollectionResult' inherits from.

description: Defaults to 'EntityCollectionResult'.

title: Indicates that a 'Get' operation will be automatically generated where not otherwise explicitly specified.

title: Indicates that a 'GetAll' operation will be automatically generated where not otherwise explicitly specified.

title: Indicates that a 'Create' operation will be automatically generated where not otherwise explicitly specified.

title: Indicates that a 'Update' operation will be automatically generated where not otherwise explicitly specified.

title: Indicates that a 'Patch' operation will be automatically generated where not otherwise explicitly specified.

title: Indicates that a 'Delete' operation will be automatically generated where not otherwise explicitly specified.

title: The data source auto-implementation option.

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

title: The access modifier for the generated 'Data' constructor.

description: Defaults to 'Public'.

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

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

title: Indicates whether the 'Data' extensions logic should be generated.

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

title: The .NET database interface name (used where 'AutoImplement' is 'Database').

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

title: The database schema name (used where 'AutoImplement' is 'Database').

description: Defaults to 'dbo'.

title: The name of the 'Mapper' that the generated Database 'Mapper' inherits from.

title: Indicates that a custom Database 'Mapper' will be used; i.e. not generated.

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

title: The .NET Entity Framework interface name used where 'AutoImplement' is 'EntityFramework'.

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

title: The corresponding Entity Framework model name (required where 'AutoImplement' is 'EntityFramework').

title: The name of the 'Mapper  that the generated Entity Framework 'Mapper' inherits from.

description: Defaults to 'Model.{Name}'; i.e. an entity with the same name in the 'Model' namespace.

title: Indicates that a custom Entity Framework 'Mapper' will be used; i.e. not generated.

title: The .NET Cosmos interface name used where 'AutoImplement' is 'Cosmos'.

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

title: The corresponding Cosmos model name (required where 'AutoImplement' is 'Cosmos').

title: The Cosmos 'ContainerId' required where 'AutoImplement' is 'Cosmos'.

title: The C# code to be used for setting the optional Cosmos 'PartitionKey' where 'AutoImplement' is 'Cosmos'.

description: Defaults to 'PartitionKey.None'.

title: Indicates whether the 'CosmosDbValueContainer' is to be used; otherwise, 'CosmosDbContainer'.

title: The name of the 'Mapper' that the generated Cosmos 'Mapper' inherits from.

title: Indicates that a custom Cosmos 'Mapper' will be used; i.e. not generated.

title: The .NET OData interface name used where 'AutoImplement' is 'OData'.

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

title: The corresponding OData model name (required where 'AutoImplement' is 'OData').

title: The name of the underlying OData collection where 'AutoImplement' is 'OData'.

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

title: The name of the 'Mapper' that the generated OData 'Mapper' inherits from.

title: Indicates that a custom OData 'Mapper' will be used; i.e. not generated.

title: The .NET HTTP Agent interface name used where 'Operation.AutoImplement' is 'HttpAgent'.

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

title: The base HTTP Agent API route where 'Operation.AutoImplement' is 'HttpAgent'.

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

title: The corresponding HTTP Agent model name (required where 'AutoImplement' is 'HttpAgent').

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

title: Indicates whether request-based 'IRequestCache' caching is to be performed at the 'DataSvc' layer to improve performance (i.e. reduce chattiness).

description: Defaults to 'true'.

title: The access modifier for the generated 'DataSvc' constructor.

description: Defaults to 'Public'.

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

title: Indicates whether the 'DataSvc' extensions logic should be generated.

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

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).

description: Defaults to 'CodeGeneration.EventOutbox' configuration property (inherits) where not specified. A value of 'Database' will result in the 'DatabaseEventOutboxInvoker' being used to orchestrate.

title: The Event Source.

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'.

description: Defaults to 'CodeGeneration.EventSubjectFormat'.

description: Defaults to 'CodeGeneration.EventCasing'.

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 'EventPublish' is 'DataSvc' and a transactionally-aware data source is being used.

title: The access modifier for the generated 'Manager' constructor.

description: Defaults to 'Public'.

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

title: Indicates whether the 'Manager' extensions logic should be generated.

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

title: The name of the .NET 'Type' that will perform the validation.

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

title: The name of the .NET Interface that the 'Validator' implements/inherits.

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.

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

title: The access modifier for the generated Web API 'Controller' constructor.

description: Defaults to 'Public'.

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

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'.

title: Indicates whether the Web API is responsible for managing (simulating) concurrency via auto-generated ETag.

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'.

title: The corresponding 'Get' method name (in the 'XxxManager') where the 'Operation.Type' is 'Update' and 'SimulateConcurrency' is 'true'.

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'.

title: Indicates whether a data 'model' version of the entity should also be generated (output to '.\Business\Data\Model').

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'.

title: Indicates whether to exclude the generation of the 'Entity' class ('Xxx.cs').

title: Indicates whether to exclude the generation of all 'Operation' related artefacts; excluding the 'Entity' class.

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

title: Indicates whether to exclude the generation of the 'Data' interface ('IXxxData.cs').

title: The option to exclude the generation of the 'Data' class ('XxxData.cs').

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.

title: Indicates whether to exclude the generation of the 'DataSvc' interface ('IXxxDataSvc.cs').

title: Indicates whether to exclude the generation of the 'DataSvc' class ('XxxDataSvc.cs').

title: Indicates whether to exclude the generation of the 'Manager' interface ('IXxxManager.cs').

title: Indicates whether to exclude the generation of the 'Manager' class ('XxxManager.cs').

title: The option to exclude the generation of the WebAPI 'Controller' class ('XxxController.cs').

title: Indicates whether to exclude the generation of the WebAPI consuming 'Agent' class ('XxxAgent.cs').

title: Indicates whether to exclude the generation of the gRPC consuming 'Agent' class ('XxxAgent.cs').

title: The role (permission) used by the 'ExecutionContext.IsInRole(role)' for each 'Operation'.

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

title: Indicates whether gRPC support (more specifically service-side) is required for the Entity.

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.

title: The corresponding 'Property' collection.

title: The corresponding 'Operation' collection.

title: The corresponding 'Consts' collection.

title: 'Property' object (entity-driven)

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

title: The unique property name.

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}}).

title: The overriding model text for use in comments.

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}}).

title: The .NET '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.'

title: Indicates whether the .NET 'Type' should be declared as nullable; e.g. 'string?'. Will be inferred where the 'Type' is denoted as nullable; i.e. suffixed by a '?'.

title: Indicates whether the property is inherited and therefore should not be output within the generated Entity class.

title: The overriding private name.

title: The overriding argument name.

title: Indicates whether the property is considered part of the unique (primary) key.

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

title: Indicates that the property 'Type' is another generated entity / collection and therefore specific capabilities can be assumed (e.g. 'CopyFrom' and 'Clone').

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.

title: Indicates that the value is immutable and therefore cannot be changed once set.

title: The 'DateTime' transformation to be performed on 'Set' and 'CleanUp'.

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

enum: UseDefault None DateOnly DateTimeLocal DateTimeUtc DateTimeUnspecified

title: The 'string' trimming of white space characters to be performed on 'Set' and 'CleanUp'.

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

title: The 'string' transformation to be performed on 'Set' and 'CleanUp'.

title: Indicates whether an instance of the 'Type' is to be automatically created/instantiated when the property is first accessed (i.e. lazy instantiation).

title: The C# code to default the value.

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.

title: Indicates whether the property is considered part of the Partition Key.

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

title: The names of the secondary property(s), comma delimited, that are to be notified on a property change.

title: Indicates whether the value should bubble up property changes versus only recording within the sub-entity itself.

description: Note that the 'IsEntity' property is also required to enable.

title: Indicates that 'CleanUp' is not to be performed for the property within the 'Entity.CleanUp' method.

title: Indicates whether the property is for internal use only; declared in Business entities only.

description: This is only applicable where the 'Entity.EntityScope' is 'Autonomous'. In this instance the 'Property' will be excluded from the 'Common' entity declaration.

title: The underlying Reference Data Type that is also used as the Reference Data serialization identifier (SID).

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.

title: Indicates that the Reference Data property is to be a serializable list ('ReferenceDataSidList').

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

title: Indicates whether a corresponding 'Text' property is added when generating a Reference Data property, overriding the 'Entity.RefDataText' selection.

title: Indicates whether the property should use the underlying Reference Data mapping capabilities.

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.

title: The JSON property name.

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

title: The JSON property name for the corresponding data model (see 'Entity.DataModel').

description: Defaults to 'JsonName' where not specified.

title: Indicates whether the property is not to be serialized.

description: All properties are serialized by default.

title: Indicates whether to emit the default value when serializing.

title: The override JSON property name where outputting as a data model.

title: The Identifier Generator Type to generate the identifier on create via Dependency Injection.

description: Should be formatted as 'Type' + '^' + 'Name'; e.g. 'IGuidIdentifierGenerator^GuidIdGen'. Where the 'Name' portion is not specified it will be inferred. Where the 'Type' matches an already inferred value it will be ignored. See 'Beef.Entities.IInt32IdentifierGenerator', 'Beef.Entities.IInt64IdentifierGenerator', 'Beef.Entities.IGuidIdentifierGenerator' or 'Beef.Entities.IStringIdentifierGenerator' for underlying implementation requirements.

title: The data name where Entity.AutoImplement is selected.

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

title: The data 'Converter' class name where 'Entity.AutoImplement' is selected.

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 'DataConverterIsGeneric' to 'true'.

title: Indicates whether the data 'Converter' is a generic class and will automatically use the corresponding property 'Type' as the generic 'T'.

title: Indicates whether the property should be ignored (excluded) from the 'Data'-layer / data 'Mapper' generated output.

description: All properties are included by default.

title: Indicates whether the 'UniqueKey' property value is automatically generated by the data source on 'Create'.

title: The operations types ('ExecutionContext.OperationType') selection to enable inclusion and exclusion of property mapping.

description: Defaults to 'Any'.

enum: Any AnyExceptCreate AnyExceptUpdate AnyExceptGet Get Create Update Delete

title: The database property 'Mapper' class name where 'Entity.AutoImplement' is selected.

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).

title: Indicates whether the property should be ignored (excluded) from the database 'Mapper' generated output.

title: The database 'DbType' override (versus inferring from the corresponding .NET Type).

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

title: The Entity Framework 'Mapper' approach for the property.

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.

title: The Cosmos 'Mapper' approach for the property.

title: The OData 'Mapper' approach for the property.

title: The HttpAgent 'Mapper' approach for the property.

title: The display name used in the likes of error messages for the property.

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

title: The property annotation (e.g. attribute) declaration code.

title: The 'IPropertyMapperConverter' to perform 'Type' to 'string' conversion for writing to and parsing from the query string.

title: The unique (immutable) field number required to enable gRPC support.

title: The underlying gRPC data type; will be inferred where not specified.

title: 'CodeGeneration' object (entity-driven)

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.

title: The unique operation name.

title: The type of operation that is to be code-generated.

enum: Get GetColl Create Update Patch Delete Custom

title: The text for use in comments.

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}}).

title: Indicates whether the properties marked as a unique key ('Property.UniqueKey') are to be used as the parameters.

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

title: Indicates whether a 'PagingArgs' argument is to be added to the operation to enable (standardized) paging related logic.

title: The .NET value parameter 'Type' for the operation.

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

title: The .NET return 'Type' for the operation.

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

title: Indicates whether the 'ReturnType' is nullable for the operation.

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 '?'.

title: The text for use in comments to describe the 'ReturnType'.

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

title: The overriding private name.

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

title: The operation override for the 'Entity.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'.

title: The override for the data entity 'Mapper'.

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

description: Defaults to 'Entity.DataExtensions'.

title: Indicates whether a 'System.TransactionScope' should be created and orchestrated at the 'Data'-layer.

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

title: The database stored procedure name used where 'Operation.AutoImplement' is 'Database'.

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

title: The Cosmos 'ContainerId' override used where 'Operation.AutoImplement' is 'Cosmos'.

description: Overrides the 'Entity.CosmosContainerId'.

title: The C# code override to be used for setting the optional Cosmos 'PartitionKey' used where 'Operation.AutoImplement' is 'Cosmos'.

description: Overrides the 'Entity.CosmosPartitionKey'.

title: The override name of the underlying OData collection where 'Operation.AutoImplement' is 'OData'.

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

title: The HTTP Agent API route where 'Operation.AutoImplement' is 'HttpAgent'.

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

title: The HTTP Agent Method for the operation.

description: Defaults to 'Operation.WebApiMethod'.

enum: HttpGet HttpPost HttpPut HttpDelete HttpPatch

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

title: Indicates whether the 'Manager' logic is a custom implementation; i.e. no auto-'DataSvc' invocation logic is to be generated.

title: Indicates whether a 'System.TransactionScope' should be created and orchestrated at the 'Manager'-layer.

description: Defaults to 'Entity.ManagerExtensions'.

title: The name of the .NET Type that will perform the validation.

description: Defaults to the 'Entity.Validator' where not specified explicitly. Only used for 'Operation.Type' options 'Create' or 'Update'.

description: Defaults to the 'Entity.IValidator' where specified; otherwise, defaults to 'IValidator<{Type}>' where the '{Type}' is 'ValueType'. Only used 'Operation.Type' options 'Create' or 'Update'.

title: The 'ExecutionContext.OperationType' (CRUD denotation) defined at the 'Manager'-layer.

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

title: Indicates whether the 'DataSvc' logic is a custom implementation; i.e. no auto-'DataSvc' invocation logic is to be generated.

title: Indicates whether a 'System.TransactionScope' should be created and orchestrated at the 'DataSvc'-layer.

description: Defaults to 'Entity.ManagerExtensions'.

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.

description: Defaults to 'Entity.EventOutbox' configuration property (inherits) where not specified and 'EventPublish' is 'Data'; otherwise, 'None'. A value of 'Database' will result in the 'DatabaseEventOutboxInvoker' being used to orchestrate.

title: The Event Source.

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}'.

title: The event subject template and corresponding event action pair (separated by a colon).

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'.

title: The Web API 'RouteAtttribute' to be appended to the 'Entity.WebApiRoutePrefix'.

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

title: The HTTP Method for the operation.

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'.

title: The primary HTTP Status Code that will be returned for the operation where there is a non-'null' return value.

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

title: The primary HTTP Status Code that will be returned for the operation where there is a 'null' return value.

description: The value defaults as follows: 'NotFound' for 'Operation.Type' value 'Get', 'NoContent' for 'Operation.Type' value 'GetColl', 'Create', 'Update' or 'Patch'; otherwise, 'ThrowException' which will result in an 'InvalidOperationException'.

enum: OK Accepted Created NoContent NotFound ThrowException

title: The HTTP Response Location Header route.

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'.

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'.

title: The corresponding 'Update' method name (in the 'XxxManager') where the 'Operation.Type' is 'Patch'.

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'.

title: The permission used by the 'ExecutionContext.IsAuthorized(AuthPermission)' to determine whether the user is authorized.

title: The permission used by the 'ExecutionContext.IsInRole(AuthRole)' to determine whether the user is authorized.

title: Indicates whether to exclude the generation of all 'Operation' related output.

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

title: Indicates whether to exclude the generation of the operation within the 'Data' interface ('IXxxData.cs') output.

title: Indicates whether to exclude the generation of the operation within the 'Data' class ('XxxData.cs') output.

title: Indicates whether to exclude the generation of the operation within the 'DataSvc' interface ('IXxxDataSvc.cs') output.

title: Indicates whether to exclude the generation of the operation within the 'DataSvc' class ('XxxDataSvc.cs') output.

title: Indicates whether to exclude the generation of the operation within the 'Manager' interface ('IXxxManager.cs') output.

title: Indicates whether to exclude the generation of the operation within the 'Manager' class ('XxxManager.cs') output.

title: Indicates whether to exclude the generation of the operation within the WebAPI 'Controller' class ('XxxController.cs') output.

title: Indicates whether to exclude the generation of the operation within the WebAPI consuming 'Agent' class ('XxxAgent.cs') output.

title: Indicates whether to exclude the generation of the operation within the gRPC consuming 'Agent' class ('XxxAgent.cs') output.

title: Indicates whether gRPC support (more specifically service-side) is required for the Operation.

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.

title: The corresponding 'Parameter' collection.

title: 'Parameter' object (entity-driven)

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

title: The unique parameter name.

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

title: The .NET 'Type'.

title: Indicates whether the .NET 'Type should be declared as nullable; e.g. 'string?'. Will be inferred where the 'Type' is denoted as nullable; i.e. suffixed by a '?'.

title: The C# code to default the value.

title: The overriding private name.

title: The overriding argument name.

title: The 'Property.Name' within the parent 'Entity' to copy (set) the configuration/characteristics from where not already defined.

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

description: Defaults to 'IValidator<{Type}>' where the '{Type}' is 'Type'.

title: The fluent-style method-chaining C# validator code to append to 'IsMandatory' and 'Validator' (where specified).

title: Indicates whether a 'ValidationException' should be thrown when the parameter value has its default value (null, zero, etc).

title: The option that determines the layers in which the parameter is passed.

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 'UniqueKey' option to automatically set 'Parameters', and the 'Operation.Type' is 'Create' or 'Update' it will default to 'ToManagerSet'.

title: The data 'Converter' class name where specific data conversion is required.

description: A 'Converter' is used to convert a data source value to/from a .NET 'Type' where the standard data type conversion is not applicable.

title: The option for how the parameter will be delcared within the Web API Controller.

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.

enum: FromQuery FromBody FromRoute FromEntityProperties

title: 'Const' object (entity-driven)

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

title: The unique constant name.

title: The .NET (C#) code for the constant 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}}').


$ref: #/definitions/path

$ref: #/definitions/editor

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

$ref: #/definitions/timezone

title: Common types for all schemas


tsoa.json

description: An array of path globs that point to your route controllers that you would like to have tsoa include.

description: The entry point to your API

description: Directories to ignore during TypeScript metadata scan

description: Modes that allow you to prevent input data from entering into your API. This will document your decision in the swagger.yaml and it will turn on excess-property validation (at runtime) in your routes.

$ref: #/definitions/RoutesConfig

description: Route generation configuration object

$ref: #/definitions/SpecConfig

description: Swagger generation configuration object

description: Authentication Module for express, hapi and koa

description: Base API path; e.g. the '/v1' in https://myapi.com/v1

description: IOC module; e.g. './inversify/ioc' where IOC container named `iocContainer` is defined (https://github.com/inversify/InversifyJS)

description: Middleware provider.

enum: express hapi koa

description: Override the Middleware template

description: Routes directory; generated routes.ts (which contains the generated code wiring up routes using middleware of choice) will be dropped here

description: Routes filename; the filename of the generated route file ('routes.ts' by default)

description: Base API path; e.g. the 'v1' in https://myapi.com/v1

description: Contact Information

default: npm package author email

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

default: npm package author

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

default: npm package author url

description:
API Info url
The URL pointing to the contact information.

description: API description; defaults to npm package description

description: API host, expressTemplate.g. localhost:3000 or myapi.com

description: API license; defaults to npm package license

description: API name; defaults to npm package name

description: Generated SwaggerConfig.json will output here

enum: http https ws wss

description:
Security Definitions Object
A declaration of the security schemes available to be used in the
specification. This does not enforce the security schemes on the operations
and only serves to provide the relevant details for each scheme.

description:
Extend generated swagger spec with this object
Note that generated properties will always take precedence over what get specified here

default: 'immediate'

description:
Alter how the spec is merged to generated swagger spec.
Possible values:
  - 'immediate' is overriding top level elements only thus you can not append a new path or alter an existing value without erasing same level elements.
  - 'recursive' proceed to a deep merge and will concat every branches or override or create new values if needed. @see https://www.npmjs.com/package/merge
  - 'deepmerge' uses `deepmerge` to merge, which will concat object branches and concat arrays as well @see https://www.npmjs.com/package/deepmerge
The default is set to immediate so it is not breaking previous versions.

enum: deepmerge immediate recursive

description:
Major OpenAPI version to generate; defaults to version 2 when not specified
Possible values:
  - 2: generates OpenAPI version 2.
  - 3: generates OpenAPI version 3.

type: number

description: Swagger Tags Information for your API

description: API version number; defaults to npm package version

enum: header query

description: JSON Schema for the tsoa configuration file

title: tsoa


vtesttree-schema.json

title: Json schema for vtesttree.yaml files.

title: Json schema for vtesttree.yaml files.

title: Json schema for vtesttree.yaml files.

title: Version

description: Json schema version for the vtesttree.yaml file. Acceptance criteria: equal major version, less/equal minor and patch version.

title: Test tree

description: Definition of a test tree consisting of test groups, CAPL test cases and CAPL test sequences.

title: Version

title: Test tree

description: Definition of a test tree consisting of test fixtures, CAPL test cases and CAPL test sequences.

description: Element of a test tree or test group.

description: Element of a test tree or test fixture.

title: CAPL test case

description: Definition of a call to a CAPL test case.

description: Function name of the CAPL test case.

description: Identifier of the CAPL test case.

description: Title of the CAPL test case.

description: Description of the CAPL test case.

title: CAPL test sequence

description: Definition of a call to a CAPL test sequence.

description: Function name of the CAPL test sequence.

description: Title of the CAPL test sequence.

title: Test group

description: Definition of a test group containing other test groups, CAPL test cases and CAPL test sequences.

description: Name of the test group.

description: Description of the test group.

title: CAPL test sequence

description: Title of the CAPL test sequence.

title: Test fixture

description: Definition of a test fixture containing other test fixtures, CAPL test cases and CAPL test sequences.

description: Name of the test fixture.

description: Description of the test fixture.

title: CAPL parameter list

description: List of parameter values for a CAPL test case or CAPL test sequence.

title: CAPL parameter

description: Parameter value for a CAPL test case or CAPL test sequence.

title: Numeric Value

title: String Value

title: Json schema for vtesttree.yaml files.


$ref: #/definitions/Function

required: buildpacks builder buildEnvs

$ref: #/definitions/Git

$ref: #/definitions/Env

required: namespace annotations options labels healthEndpoints

$ref: #/definitions/Options

$ref: #/definitions/Label

$ref: #/definitions/HealthEndpoints

required: specVersion name runtime registry image imageDigest created build run deploy

format: date-time

$ref: #/definitions/Invocation

$ref: #/definitions/BuildSpec

$ref: #/definitions/RunSpec

$ref: #/definitions/DeploySpec

$ref: #/definitions/ScaleOptions

$ref: #/definitions/ResourcesOptions

$ref: #/definitions/ResourcesRequestsOptions

$ref: #/definitions/ResourcesLimitsOptions

required: volumes envs

$ref: #/definitions/Volume

enum: concurrency rps

title: secret

title: configmap


bundleconfig.json

description: JavaScript only. Set to true to produce a source map.

description: JavaScript only. Sets a root path for source maps.

description: JavaScript only. Gets or sets a flag indicating whether to always escape non-ASCII characters as \uXXXX or to let the output encoding object handle that via the JsEncoderFallback object for the specified output encoding format.

description: JavaScript only.

enum: ignore makeAllSafe makeImmediateSafe

default: ignore

description: JavaScript only.

description: JavaScript only. Controls if local variables should be shortened.

description: Forces all rules to be terminated with semicolons if set to true.

$ref: #/definitions/ajaxminBaseSettings

description: CSS only. If no color names are to be used, set this value to 'hex'. If a set of colors recognized by all major browser is okay to use (W3C-strict validation is not required), set this value to 'major'.

enum: hex major noSwap strict

default: strict

description: CSS only. How to treat comments in the code. The default is 'none', which will strip all comments except 'important' comments. 'all' will leave all comments, and 'hacks' will only leave certain known comment-based hacks.

enum: none all hacks important

default: important

description: CSS only. Adjust relative paths inside the url() function.

description: HTML only. Remove values from boolean attributes.

description: HTML only. Indicating whether to collapse whitespaces.

description: HTML only. Indicating whether the parsing is occurring on an HTML fragment, to avoid creating missing tags (like html, body, head).

description: HTML only. Indicating whether to keep one space when collapsing.

description: HTML only. Minify CSS code in style tags.

description: HTML only. Minify JS code in script tags.

description: HTML only. Minify CSS code in style attributes.

description: HTML only. Preserve case of tag and attribute names.

description: HTML only. Remove all HTML comments except conditional, noindex, Knockout.js containerless comments and Angular.js comment directives.

description: HTML only. Remove optional end tags.

description: HTML only. Indicating whether to remove quoted attributes when possible.

description: For the multi-line output feature, how many spaces to use when indenting a block (see outputMode).

description: SingleLine minifies everything to a single line. MultipleLines breaks the minified code into multiple lines for easier reading.

enum: multipleLines singleLine none

default: singleLine

required: outputFileName inputFiles

description: Set to true to include the output file in the project. Doesn't work in some Visual Studio project types like ASP.NET Core applications.

description: One or more relative file names or globbing patterns to bundle. Example: "scripts/**/*.js"

description: Specify options for minification of the output file.

description: Produce a .gz file after minification.

description: The relative path to the desired output file name.

$ref: #/definitions/jsBundle

$ref: #/definitions/cssBundle

$ref: #/definitions/htmlBundle

description: Schema for bundleconfig.json files

$ref: #/definitions/bundle


clab.schema.json

title: Containerlab topology definition file

description: topology node configuration container

markdownDescription: topology [node](https://containerlab.dev/manual/nodes/) configuration container

description: container image to use for this node

markdownDescription: container [image](https://containerlab.dev/manual/nodes/#image) to use for this node

description: policy for pulling the referenced cotnainer image

markdownDescription: container [image-pull-policy](https://containerlab.dev/manual/nodes/#image-pull-policy) to use for this node

enum: always Always never Never ifnotpresent IfNotPresent

description: list of subject alternative names (SAN) to use for this node

markdownDescription: list of [subject alternative names](https://containerlab.dev/manual/nodes/#subject-alternative-names) to use for this node

description: kind of this node

markdownDescription: [kind](https://containerlab.dev/manual/nodes/#kind) of this node

description: path to a license file

markdownDescription: path to a [license](https://containerlab.dev/manual/nodes/#license) file

description: type is a per-node property that can select a special type of a node

description: grouping parameter of a node. A free form string that is mainly used in sorting elements when graphing

markdownDescription: path to a [license](https://containerlab.dev/manual/nodes/#group) file

description: path to a startup config file (if supported by the kind)

markdownDescription: path to a startup [config file](https://containerlab.dev/manual/nodes/#startup-config) (if supported by the kind)

description: Optional startup delay (seconds) to apply

markdownDescription: Optional [startup delay](https://containerlab.dev/manual/nodes/#startup-delay) in seconds

description: Set to `true` to make the node to boot with a startup-config even if the config file is present in the lab directory

markdownDescription: Set to `true` to [make the node to boot with a startup-config](https://containerlab.dev/manual/nodes/#enforce-startup-config) even if the config file is present in the lab directory

description: Set to `true` to remove the node automatically, instead of auto-restarting

markdownDescription: Set to `true` to [remove the node/container automatically](https://containerlab.dev/manual/nodes/#auto-remove), instead of auto-restarting it

description: list of commands to execute post deploy

markdownDescription: list of [commands to execute](https://containerlab.dev/manual/nodes/#exec) post deploy

description: list of file/directory bindings

markdownDescription: list of file/directory [bindings](https://containerlab.dev/manual/nodes/#binds)

description: list of port mappings

markdownDescription: list of [port](https://containerlab.dev/manual/nodes/#ports) mappings

description: environment variables

description: user to use within the container

markdownDescription: [user](https://containerlab.dev/manual/nodes/#user) to use within the container

description: container's entrypoint

description: command to launch container with

markdownDescription: [command](https://containerlab.dev/manual/nodes/#cmd) to launch container with

description: list of ports to publish

markdownDescription: list of ports to [publish](https://containerlab.dev/manual/nodes/#publish)

description: container labels

description: Runtime used to launch the container node

markdownDescription: [Runtime](https://containerlab.dev/manual/nodes/#runtime) for the node

enum: docker ignite

description: IPv4 management address of the node (e.g. 172.10.10.11)

markdownDescription: [IPv4 management address](https://containerlab.dev/manual/nodes/#mgmt-ipv4) of the node (e.g. 172.10.10.11)

description: IPv6 management address of the node (e.g. 172.10.10.11)

markdownDescription: [IPv6 management address](https://containerlab.dev/manual/nodes/#mgmt-ipv6) of the node (e.g. 172.10.10.11)

description: node network mode (can only be set host, defaults to bridge)

markdownDescription: node [network mode](https://containerlab.dev/manual/nodes/#network-mode) (can only be set host, defaults to bridge)

description: number of vcpu to allocate for this node/container

markdownDescription: Allowed [CPU](https://containerlab.dev/manual/nodes/#cpu) usage by the node/container

description: memory limit for this node/container

markdownDescription: Allowed [Memory](https://containerlab.dev/manual/nodes/#memory) usage by the node/container

description: CPU cores to use by this node/container

markdownDescription: [CPU cores](https://containerlab.dev/manual/nodes/#cpu-set) to be used by the node/container

description: ignite's sandbox image name

description: ignite's kernel image name

$ref: #/definitions/extras-config

$ref: #/definitions/config-config

description: Define which nodes should be started before this node will start

markdownDescription: [wait-for](https://containerlab.dev/manual/nodes/#cmd) defines which nodes should be started before this node will start

$ref: #/definitions/dns-config

$ref: #/definitions/certificate-config

description: type of a node

description: link configuration container

markdownDescription: link configuration container

description: endpoints list

description: link-scoped variables used by config engine

markdownDescription: link-scoped variables used by config engine

description: node's extra configurations

description: list of SR Linux agent's config files to be copied to the NOS filesystem

markdownDescription: list of [SR Linux agent's config files](https://containerlab.dev/manual/kinds/srl/#user-defined-custom-agents-for-sr-linux-nodes) to be copied to the NOS filesystem

description: http/s proxy to be used by mysocketctl

description: containerlab config engine parameters

description: config variables passed to config engine

markdownDescription: config variables passed to config engine

description: Node's Certificate configuration option

markdownDescription: Node's [Certificate configuration options](https://containerlab.dev/manual/nodes/#certificate)

description: Set to `true` to generate a TLS certificate for the node

markdownDescription: Set to `true` to [generate a TLS certificate for the node](https://containerlab.dev/manual/nodes/#certificate)

description: Node's DNS configuration option

markdownDescription: Node's [DNS configuration options](https://containerlab.dev/manual/nodes/#dns)

description: DNS server addresses

description: DNS search domains

description: DNS options

description: Certificate Authority

description: Path to the CA certificate file. If set, it is expected that the CA certificate already exists by that path

description: Path to the CA key file. If set, it is expected that the CA certificate already exists by that path

description: Key size. Can only be set if the external CA certificate is not provided

description: CA certificate validity duration. Can only be set if the external CA certificate is not provided

required: cert key

description: topology name

description: lab prefix

description: configuration container for management network

markdownDescription: configuration container for [management network](https://containerlab.dev/manual/network/#management-network)

description: management network name

description: Set bridge to use for the management network (instead of the default generated bridge).

markdownDescription: Set [bridge](https://containerlab.dev/manual/network/#bridge-name) to use for the management network (instead of the default generated bridge).

description: IPv4 subnet to use for the custom management network. e.g. 172.100.100.0/24

markdownDescription: [IPv4 subnet](https://containerlab.dev/manual/network/#user-defined-addresses) to use for the custom management network. e.g. 172.100.100.0/24

description: IPv6 subnet to use for the custom management network. e.g. 2001:172:100:100::/64

markdownDescription: [IPv6 subnet](https://containerlab.dev/manual/network/#user-defined-addresses) to be used for the custom management network. e.g. 2001:172:100:100::/64

description: IPv4 gateway address that will be set on a bridge used for the management network. Will be set to the first available IP address by default

description: IPv6 gateway address that will be set on a bridge used for the management network. Will be set to the first available IP address by default

description: IPv4 range out of the ipv4-subnet to use for the custom management network. e.g. 172.100.100.128/25

markdownDescription: [IPv4 range](https://containerlab.dev/manual/network/#ip-range) out of the ipv4-subnet to use for the custom management network. e.g. 172.100.100.128/25

description: IPv6 range out of the ipv6-subnet to use for the custom management network. e.g. 2001:172:100:100:8000::/65

markdownDescription: [IPv6 range](https://containerlab.dev/manual/network/#ip-range) out of the ipv6-subnet to use for the custom management network. e.g. 2001:172:100:100:8000::/65

description: MTU for the custom network

markdownDescription: [MTU](https://containerlab.dev/manual/network/#mtu) in Bytes for the custom management network

description: topology configuration container

description: topology nodes configuration container

markdownDescription: topology [nodes](https://containerlab.dev/manual/nodes/) configuration container

$ref: #/definitions/node-config

description: topology kinds configuration container

markdownDescription: topology [kinds](https://containerlab.dev/manual/topo-def-file/#kinds) configuration container

description: topology links section

description: Global containerlab settings