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

type: boolean


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

type: string


key: jsonDataModelName

description: Defaults to 'JsonName' where not specified.


key: serializationIgnore

description: All properties are serialized by default.


key: dataModelJsonName


key: identifierGenerator

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.


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


key: dataMapperIgnore

description: All properties are included by default.


key: dataOperationTypes

description: Defaults to 'Any'.

enum: Any AnyExceptCreate AnyExceptUpdate AnyExceptGet Get Create Update Delete


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

enum: Map Ignore Skip


key: cosmosMapper


key: odataMapper


key: httpAgentMapper


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.

type: object

enum: Get GetColl Create Update Patch Delete Custom

enum: Database EntityFramework Cosmos OData HttpAgent None

enum: HttpGet HttpPost HttpPut HttpDelete HttpPatch

enum: Create Read Update Delete Unspecified

enum: None DataSvc Data

enum: HttpGet HttpPost HttpPut HttpDelete

enum: OK Accepted Created NoContent NotFound

enum: OK Accepted Created NoContent NotFound ThrowException

type: array


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: uniqueKey

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


key: dataEntityMapper

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


key: dataExtensions

description: Defaults to 'Entity.DataExtensions'.


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: 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: managerExtensions

description: Defaults to 'Entity.ManagerExtensions'.


key: validator

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


key: iValidator

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


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


key: eventOutbox

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.


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', 'NoContent' for 'Operation.Type' value 'GetColl', 'Create', 'Update' or 'Patch'; otherwise, 'ThrowException' which will result in an 'InvalidOperationException'.


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: string int Guid

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: iValidator

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


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 'UniqueKey' 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 the standard data type conversion is not applicable.


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: JSON Schema for the tsoa configuration file

enum: express hapi koa

default: npm package author email

default: npm package author

default: npm package author url

enum: http https ws wss

default: 'immediate'

enum: deepmerge immediate recursive

type: number

enum: header query


key: controllerPathGlobs

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


key: entryFile

description: The entry point to your API


key: ignore

description: Directories to ignore during TypeScript metadata scan


key: noImplicitAdditionalProperties

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.


key: routes

description: Route generation configuration object


key: spec

description: Swagger generation configuration object


key: authenticationModule

description: Authentication Module for express, hapi and koa


key: basePath

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


key: iocModule

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


key: middleware

description: Middleware provider.


key: middlewareTemplate

description: Override the Middleware template


key: routesDir

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


key: routesFileName

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


key: contact

description: Contact Information


key: email

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


key: name

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


key: url

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


key: description

description: API description; defaults to npm package description


key: host

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


key: license

description: API license; defaults to npm package license


description: API name; defaults to npm package name


key: outputDirectory

description: Generated SwaggerConfig.json will output here


key: securityDefinitions

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.


key: spec

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


key: specMerging

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.


key: specVersion

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.


key: tags

description: Swagger Tags Information for your API


key: version

description: API version number; defaults to npm package version


key: full

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


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


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.


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


key: capl-test-case

description: Function name of the CAPL test case.


key: id

description: Identifier of the CAPL test case.


key: title

description: Title of the CAPL test case.


description: Description of the CAPL test case.


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


key: capl-test-sequence

description: Function name of the CAPL test sequence.


description: Title of the CAPL test sequence.


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


key: test-group

description: Name of the test group.


description: Description of the test group.


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


key: test-fixture

description: Name of the test fixture.


key: description

description: Description of the test fixture.


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


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


description: Schema for bundleconfig.json files

enum: ignore makeAllSafe makeImmediateSafe

default: ignore

enum: hex major noSwap strict

default: strict

enum: none all hacks important

default: important

type: integer

enum: multipleLines singleLine none

default: singleLine

required: outputFileName inputFiles


key: sourceMap

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


key: sourceMapRootPath

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


key: alwaysEscapeNonAscii

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.


key: evalTreatment

description: JavaScript only.


key: preserveImportantComments

description: JavaScript only.


key: renameLocals

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


key: termSemicolons

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


key: colorNames

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


key: commentMode

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.


key: adjustRelativePaths

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


key: collapseBooleanAttributes

description: HTML only. Remove values from boolean attributes.


key: collapseWhitespace

description: HTML only. Indicating whether to collapse whitespaces.


key: isFragmentOnly

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


key: keepOneSpaceWhenCollapsing

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


key: minifyEmbeddedCssCode

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


key: minifyEmbeddedJsCode

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


key: minifyInlineCssCode

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


key: preserveCase

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


key: removeHtmlComments

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


key: removeOptionalEndTags

description: HTML only. Remove optional end tags.


key: removeQuotedAttributes

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


key: indentSize

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


key: outputMode

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


key: includeInProject

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.


key: inputFiles

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


key: minify

description: Specify options for minification of the output file.


key: gzip

description: Produce a .gz file after minification.


key: outputFileName

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


key: node-config

description: topology node configuration container

enum: always Always never Never ifnotpresent IfNotPresent

enum: docker ignite


key: image

description: container image to use for this node


key: image-pull-policy

description: policy for pulling the referenced cotnainer image


key: SANs

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


key: kind

description: kind of this node


key: license

description: path to a license file


key: type

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


key: group

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


key: startup-config

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


key: startup-delay

description: Optional startup delay (seconds) to apply


key: enforce-startup-config

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


key: auto-remove

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


key: exec

description: list of commands to execute post deploy


key: binds

description: list of file/directory bindings


key: ports

description: list of port mappings


key: env

description: environment variables


key: user

description: user to use within the container


key: entrypoint

description: container's entrypoint


key: cmd

description: command to launch container with


key: publish

description: list of ports to publish


key: labels

description: container labels


key: runtime

description: Runtime used to launch the container node


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


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


key: network-mode

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


key: cpu

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


key: memory

description: memory limit for this node/container


key: cpu-set

description: CPU cores to use by this node/container


key: sandbox

description: ignite's sandbox image name


key: kernel

description: ignite's kernel image name


key: wait-for

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


key: type

description: type of a node


key: link-config

description: link configuration container


key: endpoints

description: endpoints list


key: vars

description: link-scoped variables used by config engine


key: extras-config

description: node's extra configurations


key: srl-agents

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


key: mysocket-proxy

description: http/s proxy to be used by mysocketctl


key: config-config

description: containerlab config engine parameters


description: config variables passed to config engine


key: certificate-config

description: Node's Certificate configuration option


key: issue

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


key: dns-config

description: Node's DNS configuration option


key: servers

description: DNS server addresses


key: search

description: DNS search domains


key: options

description: DNS options


key: certificate-authority-config

description: Certificate Authority

required: cert key


key: cert

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


key: key

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


key: key-size

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


key: validity-duration

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


key: name

description: topology name


key: prefix

description: lab prefix


key: mgmt

description: configuration container for management network


key: network

description: management network name


key: bridge

description: Set bridge 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


description: IPv6 subnet to use 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


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


key: mtu

description: MTU for the custom network


key: topology

description: topology configuration container


key: nodes

description: topology nodes configuration container


key: kinds

description: topology kinds configuration container


key: links

description: topology links section


key: settings

description: Global containerlab settings


key: apiVersion

description:
The version of the Block API used by the block. The most recent version is 3 and it was introduced in WordPress 6.3.

 See the API versions documentation at https://developer.wordpress.org/block-editor/reference-guides/block-api/block-api-versions/ for more details.


description: The name for a block is a unique string that identifies a block. Names have to be structured as `namespace/block-name`, where namespace is the name of your plugin or theme.


description: The name of the experiment this block is a part of, or boolean true if there is no specific experiment name.


key: title

description: This is the display title for your block, which can be translated with our translation functions. The block inserter will show this name.


key: category

description:
Blocks are grouped into categories to help users browse and discover them.
 Core provided categories are: text, media, design, widgets, theme, embed

Plugins and Themes can also register custom block categories.

https://developer.wordpress.org/block-editor/reference-guides/filters/block-filters/#managing-block-categories

enum: text media design widgets theme embed


key: parent

description: Setting parent lets a block require that it is only available when nested within the specified blocks. For example, you might want to allow an ‘Add to Cart’ block to only be available within a ‘Product’ block.


key: ancestor

description: The `ancestor` property makes a block available inside the specified block types at any position of the ancestor block subtree. That allows, for example, to place a ‘Comment Content’ block inside a ‘Column’ block, as long as ‘Column’ is somewhere within a ‘Comment Template’ block.


key: icon

description: An icon property should be specified to make it easier to identify a block. These can be any of WordPress’ Dashicons (slug serving also as a fallback in non-js contexts).


key: description

description: This is a short description for your block, which can be translated with our translation functions. This will be shown in the block inspector.


key: keywords

description: Sometimes a block could have aliases that help users discover it while searching. For example, an image block could also want to be discovered by photo. You can do so by providing an array of unlimited terms (which are translated).


key: version

description: The current version number of the block, such as 1.0 or 1.0.3. It’s similar to how plugins are versioned. This field might be used with block assets to control cache invalidation, and when the block author omits it, then the installed version of WordPress is used instead.


key: textdomain

description:
The gettext text domain of the plugin/block. More information can be found in the Text Domain section of the How to Internationalize your Plugin page.

https://developer.wordpress.org/plugins/internationalization/how-to-internationalize-your-plugin/


key: attributes

description:
Attributes provide the structured data needs of a block. They can exist in different forms when they are serialized, but they are declared together under a common interface.

See the attributes documentation at https://developer.wordpress.org/block-editor/reference-guides/block-api/block-attributes/ for more details.

enum: null boolean object array string integer number

enum: attribute text html raw query meta


key: type

description:
The type indicates the type of data that is stored by the attribute. It does not indicate where the data is stored, which is defined by the source field.

A type is required, unless an enum is provided. A type can be used with an enum.

Note that the validity of an object is determined by your source. For an example, see the query details below.


key: enum

description: An attribute can be defined as one of a fixed set of values. This is specified by an enum, which contains an array of allowed values:


key: source

description: Attribute sources are used to define how the attribute values are extracted from saved post content. They provide a mechanism to map from the saved markup to a JavaScript representation of a block.


key: selector

description:
The selector can be an HTML tag, or anything queryable with querySelector, such as a class or id attribute. Examples are given below.

For example, a selector of img will match an img element, and img.class will match an img element that has a class of class.


key: attribute

description:
Use an attribute source to extract the value from an attribute in the markup. The attribute is specified by the attribute field, which must be supplied.

Example: Extract the src attribute from an image found in the block’s markup.


key: multiline

description: Use the multiline property to extract the inner HTML of matching tag names for the use in RichText with the multiline prop.


key: query

description: Use query to extract an array of values from markup. Entries of the array are determined by the selector argument, where each matched element within the block will have an entry structured corresponding to the second argument, an object of attribute sources.


key: meta

description:
Although attributes may be obtained from a post’s meta, meta attribute sources are considered deprecated; EntityProvider and related hook APIs should be used instead, as shown in the Create Meta Block how-to here:

https://developer.wordpress.org/block-editor/how-to-guides/metabox/#step-2-add-meta-block


key: default

description:
A block attribute can contain a default value, which will be used if the type and source do not match anything within the block content.

The value is provided by the default field, and the value should match the expected format of the attribute.


key: providesContext

description:
Context provided for available access by descendants of blocks of this type, in the form of an object which maps a context name to one of the block’s own attribute.

See the block context documentation at https://developer.wordpress.org/block-editor/reference-guides/block-api/block-context/ for more details.


key: usesContext

description:
Array of the names of context values to inherit from an ancestor provider.

See the block context documentation at https://developer.wordpress.org/block-editor/reference-guides/block-api/block-context/ for more details.


key: supports

description: It contains as set of options to control features used in the editor. See the supports documentation at https://developer.wordpress.org/block-editor/reference-guides/block-api/block-supports/ for more details.

enum: wide full left center right

enum: constrained grid flex

enum: right center space-between left stretch

enum: horizontal vertical

enum: wrap nowrap

enum: top center bottom space-between stretch

enum: top right left bottom

enum: vertical horizontal


key: anchor

description: Anchors let you link directly to a specific block on a page. This property adds a field to define an id for the block and a button to copy the direct link.


key: align

description: This property adds block controls which allow to change block’s alignment.


key: alignWide

description: This property allows to enable wide alignment for your theme. To disable this behavior for a single block, set this flag to false.


key: ariaLabel

description: ARIA-labels let you define an accessible label for elements. This property allows enabling the definition of an aria-label for the block, without exposing a UI field.


key: behaviors

description: Behaviors are a way to add additional functionality to a block. They are defined as an object with a name and a set of properties. Curently, only one behavior is supported: lightbox.


key: lightbox

description: This property adds a 'lightbox' behavior to the block. It allows to open the block's content in a lightbox when clicking on it.


key: className

description: By default, the class .wp-block-your-block-name is added to the root element of your saved markup. This helps having a consistent mechanism for styling blocks that themes and plugins can rely on. If, for whatever reason, a class is not desired on the markup, this functionality can be disabled.


key: color

description:
This value signals that a block supports some of the properties related to color. When it does, the block editor will show UI controls for the user to set their values.

Note that the background and text keys have a default value of true, so if the color property is present they’ll also be considered enabled


key: background

description:
This property adds UI controls which allow the user to apply a solid background color to a block.

When color support is declared, this property is enabled by default (along with text), so simply setting color will enable background color.

To disable background support while keeping other color supports enabled, set to false.

When the block declares support for color.background, its attributes definition is extended to include two new attributes: backgroundColor and style


key: gradients

description:
This property adds UI controls which allow the user to apply a gradient background to a block.

Gradient presets are sourced from editor-gradient-presets theme support.

When the block declares support for color.gradient, its attributes definition is extended to include two new attributes: gradient and style


key: link

description:
This property adds block controls which allow the user to set link color in a block, link color is disabled by default.

Link color presets are sourced from the editor-color-palette theme support.

When the block declares support for color.link, its attributes definition is extended to include the style attribute


key: text

description:
This property adds block controls which allow the user to set text color in a block.

When color support is declared, this property is enabled by default (along with background), so simply setting color will enable text color.

Text color presets are sourced from the editor-color-palette theme support.

When the block declares support for color.text, its attributes definition is extended to include two new attributes: textColor and style


key: enableContrastChecker

description:
Determines whether the contrast checker widget displays in the block editor UI.

The contrast checker appears only if the block declares support for color. It tests the readability of color combinations and warns if there is a potential issue. The property is enabled by default.

Set to `false` to explicitly disable.


key: customClassName

description: This property adds a field to define a custom className for the block’s wrapper.


key: defaultStylePicker

description: When the style picker is shown, a dropdown is displayed so the user can select a default style for this block type. If you prefer not to show the dropdown, set this property to false.


key: dimensions

description:
This value signals that a block supports some of the CSS style properties related to dimensions. When it does, the block editor will show UI controls for the user to set their values if the theme declares support.

When the block declares support for a specific dimensions property, its attributes definition is extended to include the style attribute.


key: minHeight

description: Allow blocks to define a minimum height value.


key: filter

description:
This value signals that a block supports some of the properties related to filters. When it does, the block editor will show UI controls for the user to set their values if the theme declares support.

When the block declares support for a specific filter property, its attributes definition is extended to include the style attribute.


key: duotone

description: Allow blocks to define a duotone filter.


key: html

description: By default, a block’s markup can be edited individually. To disable this behavior, set html to false.


key: inserter

description: By default, all blocks will appear in the inserter, block transforms menu, Style Book, etc. To hide a block from all parts of the user interface so that it can only be inserted programmatically, set inserter to false.


key: layout

description: This value only applies to blocks that are containers for inner blocks. If set to `true` the layout type will be `flow`. For other layout types it's necessary to set the `type` explicitly inside the `default` object.


key: default

description: Allows setting the `type` property to define what layout type is default for the block, and also default values for any properties inherent to that layout type, e.g., for a `flex` layout, a default value can be set for `flexWrap`.


key: type

description: The layout type.


key: contentSize

description: The content size used on all children.


key: wideSize

description: The wide size used on alignwide children.


key: justifyContent

description: Content justification value.


key: orientation

description: The orientation of the layout.


key: flexWrap

description: The flex wrap value.


key: verticalAlignment

description: The vertical alignment value.


key: minimumColumnWidth

description: The minimum column width value.


key: columnCount

description: The column count value.


key: allowSwitching

description: Exposes a switcher control that allows toggling between all existing layout types.


key: allowEditing

description: Determines display of layout controls in the block sidebar. If set to false, layout controls will be hidden.


key: allowInheriting

description: For the `flow` layout type only, determines display of the `Inner blocks use content width` toggle.


key: allowSizingOnChildren

description: For the `flex` layout type only, determines display of sizing controls (Fit/Fill/Fixed) on all child blocks of the flex block.


key: allowVerticalAlignment

description: For the `flex` layout type only, determines display of vertical alignment controls in the block toolbar.


key: allowJustification

description: For the `flex` layout type, determines display of justification controls in the block toolbar and block sidebar. For the `constrained` layout type, determines display of justification control in the block sidebar.


key: allowOrientation

description: For the `flex` layout type only, determines display of the orientation control in the block toolbar.


key: multiple

description: A non-multiple block can be inserted into each post, one time only. For example, the built-in ‘More’ block cannot be inserted again if it already exists in the post being edited. A non-multiple block’s icon is automatically dimmed (unclickable) to prevent multiple instances.


key: reusable

description: A block may want to disable the ability of being converted into a reusable block. By default all blocks can be converted to a reusable block. If supports reusable is set to false, the option to convert the block into a reusable block will not appear.


key: lock

description: A block may want to disable the ability to toggle the lock state. It can be locked/unlocked by a user from the block 'Options' dropdown by default. To disable this behavior, set lock to false.


key: position

description:
This value signals that a block supports some of the CSS style properties related to position. When it does, the block editor will show UI controls for the user to set their values if the theme declares support.

When the block declares support for a specific position property, its attributes definition is extended to include the style attribute.


key: sticky

description: Allow blocks to stick to their immediate parent when scrolling the page.


key: spacing

description:
This value signals that a block supports some of the CSS style properties related to spacing. When it does, the block editor will show UI controls for the user to set their values if the theme declares support.

When the block declares support for a specific spacing property, its attributes definition is extended to include the style attribute.


key: typography

description:
This value signals that a block supports some of the CSS style properties related to typography. When it does, the block editor will show UI controls for the user to set their values if the theme declares support.

When the block declares support for a specific typography property, its attributes definition is extended to include the style attribute.


key: fontSize

description:
This value signals that a block supports the font-size CSS style property. When it does, the block editor will show an UI control for the user to set its value.

The values shown in this control are the ones declared by the theme via the editor-font-sizes theme support, or the default ones if none is provided.

When the block declares support for fontSize, its attributes definition is extended to include two new attributes: fontSize and style


key: lineHeight

description:
This value signals that a block supports the line-height CSS style property. When it does, the block editor will show an UI control for the user to set its value if the theme declares support.

When the block declares support for lineHeight, its attributes definition is extended to include a new attribute style of object type with no default assigned. It stores the custom value set by the user. The block can apply a default style by specifying its own style attribute with a default


key: selectors

description: Provides custom CSS selectors and mappings for the block. Selectors may be set for the block itself or per-feature e.g. typography. Custom selectors per feature or sub-feature, allow different block styles to be applied to different elements within the block.


key: root

description: The primary CSS class to apply to the block. This replaces the `.wp-block-name` class if set.


key: border

description: Custom CSS selector used to generate rules for the block's theme.json border styles.


key: color

description: Custom CSS selector used to generate rules for the block's theme.json color styles.


key: dimensions

description: Custom CSS selector used to generate rules for the block's theme.json dimensions styles.


description: Custom CSS selector used to generate rules for the block's theme.json spacing styles.


description: Custom CSS selector used to generate rules for the block's theme.json typography styles.


key: styles

description:
Block styles can be used to provide alternative styles to block. It works by adding a class name to the block’s wrapper. Using CSS, a theme developer can target the class name for the block style if it is selected.

Plugins and Themes can also register custom block style for existing blocks.

https://developer.wordpress.org/block-editor/reference-guides/block-api/block-styles

required: name label


key: example

description:
It provides structured example data for the block. This data is used to construct a preview for the block to be shown in the Inspector Help Panel when the user mouses over the block.

See the example documentation at https://developer.wordpress.org/block-editor/reference-guides/block-api/block-registration/#example-optional for more details.


key: viewportWidth

description: The viewportWidth controls the width of the iFrame container in which the block preview will get rendered


key: attributes

description: Set the attributes for the block example


key: innerBlocks

description:
Set the inner blocks that should be used within the block example. The blocks should be defined as a nested array like this:

 [ [ 'core/heading', { content: 'This is an Example' }, [] ] ]

 Where each block itself is an array that contains the block name, the block attributes, and the blocks inner blocks.


key: editorScript

description: Block type editor script definition. It will only be enqueued in the context of the editor.


key: script

description: Block type frontend and editor script definition. It will be enqueued both in the editor and when viewing the content on the front of the site.


key: viewScript

description: Block type frontend script definition. It will be enqueued only when viewing the content on the front of the site.


key: editorStyle

description: Block type editor style definition. It will only be enqueued in the context of the editor.


key: style

description: Block type frontend style definition. It will be enqueued both in the editor and when viewing the content on the front of the site.


key: variations

description: Block Variations is the API that allows a block to have similar versions of it, but all these versions share some common functionality.

required: name title

enum: inserter block transform

default: inserter block


key: name

description: The unique and machine-readable name.


key: title

description: A human-readable variation title.


key: description

description: A detailed variation description.


key: category

description: A category classification, used in search interfaces to arrange block types by category.


key: icon

description: An icon helping to visualize the variation. It can have the same shape as the block type.


key: isDefault

description: Indicates whether the current variation is the default one.


description: Values that override block attributes.


description: Initial configuration of nested blocks.


description: Example provides structured data for the block preview. You can set to undefined to disable the preview shown for the block type.


key: scope

description: The list of scopes where the variation is applicable.


key: keywords

description: An array of terms (which can be translated) that help users discover the variation while searching.


key: isActive

description: The list of attributes that should be compared. Each attributes will be matched and the variation will be active if all of them are matching.


key: render

description: Template file loaded on the server when rendering a block.


description: Error-Pages config file schema.

examples: {"error": true, "code": {{ code | json }}, "message": {{ message | json }}}

examples: <?xml version="1.0" encoding="utf-8"?><error><code>{{ code }}</code><message>{{ message }}</message></error>


key: templates

description: Templates list


key: items

description: Template properties


key: path

description: Path to the template file


description: Template name (optional, if path is defined)


key: content

description: Template content, if path is not defined


key: formats

description: Responses, based on requested content-type format


key: json

description: JSON format


description: JSON response body (template tags are allowed here)


key: xml

description: XML format


description: XML response body (template tags are allowed here)


key: pages

description: Error pages (codes)


description: Error page (code)


key: message

description: Error page message (title)


key: description

description: Error page description

examples: The server did not understand the request


description: Bozr test suite schema definition

enum: GET POST PUT DELETE HEAD OPTIONS PATCH CONNECT TRACE

enum: application/json application/xml text/xml text/csv

required: method url

required: on expect


key: name

description: Short name of the test that will be used in reports.


description: Long description of the test.


key: ignore

description: Ignore test due to a reason


description:
A repository of the current user
https://github.com/DannyBen/secret_hub#bulk-operations

examples: SECRET PASSWORD


description:
Secrets of the current repository
https://github.com/DannyBen/secret_hub#bulk-operations


description:
A secret of the current repository
https://github.com/DannyBen/secret_hub#bulk-operations


key: info

description: This is a REST API reference for the Keycloak Admin


key: get

description:
/
Get accessible realms

Returns a list of accessible realms. The list is filtered based on what realms the caller is allowed to view.

briefRepresentation

in: query


description: Success


key: post

description:
/
Import a realm

Imports a realm from a full representation of that realm.  Realm name must be unique.


Success


key: /{realm}

description: /{realm}

realm

in: path


description:
/
Get the top-level representation of the realm

It will not include nested information like User and Client representations.


key: put

description:
/
Update the top-level information of the realm

Any user, roles or client information in the representation
will be ignored.  This will only update top-level attributes of the realm.


key: delete

description:
/
Delete the realm

/


key: parameters

description: realm name (not id!)


description:
/
Get admin events

Returns all admin events, or filters events based on URL query parameters listed here


description: user id


description: Maximum results size (defaults to 100)


description:
/
Delete all admin events

/


description:
/
Clear any user login failures for all users

This can release temporary disabled users

/


description:
/
Get status of a username in brute force detection


description: Success


description:
/
Clear any user login failures for the user

This can release temporary disabled user


description:
/
Get authenticator providers

Returns a stream of authenticator providers.
/


description: Success


description:
/
Get client authenticator providers

Returns a stream of client authenticator providers.
/


description:
/
Create new authenticator configuration


Success


description:
/
Get authenticator provider's configuration description
/


description:
/
Get authenticator configuration


description:
/
Delete authenticator configuration


description:
/
Update authenticator configuration


description: realm name (not id!)


description: Configuration id


description:
/
Add new authentication execution


description:
/
Get Single Execution
/


description:
/
Delete execution


description:
/
Update execution with new configuration


description: Execution id


description:
/
Get execution's configuration


description:
/
Lower execution's priority


description:
/
Raise execution's priority


description:
/
Get authentication flows

Returns a stream of authentication flows.
/


description: Success


description:
/
Create a new authentication flow


Success


description:
/
Copy existing authentication flow under a new name

The new name is given as 'newName' attribute of the passed JSON object


description: Name of the existing authentication flow


description:
/
Get authentication executions for a flow


description:
/
Update authentication executions of a Flow


description: realm name (not id!)


description: Flow alias


description:
/
Add new authentication execution to a flow


description: Alias of parent flow


description:
/
Add new flow with new execution to existing flow


description: Alias of parent authentication flow


description:
/
Get authentication flow for id


description:
/
Update an authentication flow


description:
/
Delete an authentication flow


description: Flow id


description:
/
Get form action providers

Returns a stream of form action providers.
/


description: Success


description:
/
Get form providers

Returns a stream of form providers.
/


description:
/
Get configuration descriptions for all clients
/


description: Success


description:
/
Register a new required actions


Success


description: realm name (not id!)


description:
/
Get required actions

Returns a stream of required actions.
/


description: Success


description:
/
Get required action for alias


description:
/
Update required action


description:
/
Delete required action


description: Alias of required action


description:
/
Lower required action's priority


description:
/
Raise required action's priority


description:
/
Get unregistered required actions

Returns a stream of unregistered required actions.
/


description: Success


description:
/
Base path for importing clients under this realm.


description:
/
Base path for the admin REST API for one particular realm.


description:
/
Base path for retrieve providers with the configProperties properly filled


description:
/
Get client scopes belonging to the realm

Returns a list of client scopes belonging to the realm
/


description:
/
Create a new client scope

Client Scope's name must be unique!


Success


description: realm name (not id!)


description:
/
Update the client scope


description:
/
Get representation of the client scope


description:
/
Delete the client scope
/


description: id of client scope (not name)


description:
/
Create multiple mappers

/


description:
/
Create a mapper


description:
/
Get mappers


description: Success


description:
/
Get mappers by name for a specific protocol


description:
/
Get all scope mappings for the client


description:
/
Get the roles associated with a client's scope

Returns roles for the client.


description:
/
Add client-level roles to the client's scope


description:
/
Remove client-level roles from the client's scope.


description:
/
The available client-level roles

Returns the roles for the client that can be associated with the client's scope


description:
/
Get effective client roles

Returns the roles for the client that are associated with the client's scope.


description: if false, return roles with their attributes


description: realm name (not id!)


description:
/
Get realm-level roles associated with the client's scope


description:
/
Add a set of realm-level roles to the client's scope


Success


description:
/
Remove a set of realm-level roles from the client's scope


description: id of client scope (not name)


description:
/
Get realm-level roles that are available to attach to this client's scope


description:
/
Get effective realm-level roles associated with the client's scope

What this does is recurse
any composite roles associated with the client's scope and adds the roles to this lists.  The method is really
to show a comprehensive total view of realm-level roles associated with the client.


description: Success


description:
/
Get mapper by id


description:
/
Update the mapper


description:
/
Delete the mapper


description: Mapper id


description:
/
Get client session stats

Returns a JSON map.  The key is the client id, the value is the number of sessions that currently are active
with that client.  Only clients that actually have a session associated with them will be in this map.


description: Success


description:
/
Update the client scope


description:
/
Delete the client scope
/


description: realm name (not id!)


description:
/
Create multiple mappers

/


description:
/
Create a mapper


Success


description:
/
Get mappers


description: id of client scope (not name)


description:
/
Get all scope mappings for the client


description:
/
Get clients belonging to the realm.

If a client can't be retrieved from the storage due to a problem with the underlying storage,
it is silently removed from the returned list.
This ensures that concurrent modifications to the list don't prevent callers from retrieving this list.


description: filter by clientId


description: filter clients that cannot be viewed in full by admin


description: whether this is a search query or a getClientById query


description: the first result


description: the max results to return


description: Success


description:
/
Create a new client

Client's client_id must be unique!


description:
/
Create a new initial access token.


description:
/
Base path for managing client initial access tokens


description: realm name (not id!)


description:
/
Update the client


description:
/
Get representation of the client


Success


description:
/
Delete the client

/


description: id of client (not client-id)


description:
/
Get key info


description:
/
Get a keystore file for the client, containing private key and public certificate


description: Success

format: binary


description:
/
Generate a new certificate with new key pair


description:
/
Generate a new keypair and certificate, and get the private key file

Generates a keypair and certificate and serves the private key in a specified keystore format.
Only generated public certificate is saved in Keycloak DB - the private key is not.


description:
/
Upload certificate and eventually private key


description:
/
Upload only certificate, not private key


description:
/
Generate a new secret for the client


description:
/
Get the client secret


description:
/
Invalidate the rotated secret for the client


description:
/
Get the rotated client secret


description: realm name (not id!)


description:
/
Get default client scopes.  Only name and ids are returned.


description: Success


description:
/
Base path for managing a specific client.


Success


description: id of client (not client-id)


description:
/
Create JSON with payload of example access token


description:
/
Create JSON with payload of example id token


description:
/
Create JSON with payload of example user info


description: Success


description:
/
Return list of all protocol mappers, which will be used when generating tokens issued for particular client. This means
protocol mappers assigned to this client directly and protocol mappers assigned to all client scopes of this client.


description:
/
Get effective scope mapping of all roles of particular role container, which this client is defacto allowed to have in the accessToken issued for him.

This contains scope mappings, which this client has directly, as well as scope mappings, which are granted to all client scopes,
which are linked with this client.


description: either realm name OR client UUID


description:
/
Get roles, which this client doesn't have scope for and can't have them in the accessToken issued for him. Defacto all the
other roles of particular role container, which are not in {


description:
/
Return object stating whether client Authorization permissions have been initialized or not and a reference


description:
/
Register a cluster node with the client

Manually register cluster node to this client - usually it's not needed to call this directly as adapter should handle
by sending registration request to Keycloak


description:
/
Unregister a cluster node from the client


description: realm name (not id!)


description:
/
Get application offline session count

Returns a number of offline user sessions associated with this client

{
"count": number
}


description: Success


description:
/
Get offline sessions for client

Returns a list of offline user sessions associated with this client


description: Paging offset


description: Maximum results size (defaults to 100)


description: Success


description: id of client (not client-id)


description:
/
Get optional client scopes.  Only name and ids are returned.


Success


description:
/
Create multiple mappers

/


description:
/
Create a mapper


description:
/
Get mappers


description:
/
Get mappers by name for a specific protocol


description:
/
Push the client's revocation policy to its admin URL

If the client has an admin URL, push revocation policy to it.
/


description: Success


key: schema

description: GlobalRequestResult


description: realm name (not id!)


description:
/
Generate a new registration access token for the client


description:
/
Get all roles for the realm or client


description:
/
Create a new role for the realm or client


description:
/
Get a role by name


description:
/
Delete a role by name


description:
/
Update a role by name


description: id of client (not client-id)


description: role's name (not id!)


description:
/
Add a composite to the role


Success


description:
/
Get composites of the role


description: Success


description:
/
Remove roles from the role's composite


description:
/
Get client-level roles for the client that are in the role's composite


description:
/
Get realm-level roles of the role's composite


description:
/
Returns a stream of groups that have the specified role name


description: first result to return. Ignored if negative or {@code null}.


description: maximum number of results to return. Ignored if negative or {@code null}.


description: if false, return a full representation of the {@code GroupRepresentation} objects.


description: realm name (not id!)


description: the role name.


description:
/
Return object stating whether role Authorization permissions have been initialized or not and a reference


description:
/
Returns a stream of users that have the specified role name.


description: id of client (not client-id)


description:
/
Get all scope mappings for the client


description:
/
Get the roles associated with a client's scope

Returns roles for the client.


description:
/
Add client-level roles to the client's scope


Success


description:
/
Remove client-level roles from the client's scope.


description:
/
The available client-level roles

Returns the roles for the client that can be associated with the client's scope


description: Success


description:
/
Get effective client roles

Returns the roles for the client that are associated with the client's scope.


description: if false, return roles with their attributes


description:
/
Get realm-level roles associated with the client's scope


description:
/
Add a set of realm-level roles to the client's scope


description:
/
Remove a set of realm-level roles from the client's scope


description: realm name (not id!)


description:
/
Get realm-level roles that are available to attach to this client's scope


description:
/
Get effective realm-level roles associated with the client's scope

What this does is recurse
any composite roles associated with the client's scope and adds the roles to this lists.  The method is really
to show a comprehensive total view of realm-level roles associated with the client.


description:
/
Get a user dedicated to the service account


description: id of client (not client-id)


description:
/
Get application session count

Returns a number of user sessions associated with this client

{
"count": number
}


description: Success


description:
/
Test if registered cluster nodes are available

Tests availability by sending 'ping' request to all cluster nodes.


description: Success


description: GlobalRequestResult


description:
/
Get user sessions for client

Returns a list of user sessions associated with this client


description: Paging offset


description: Maximum results size (defaults to 100)


description: Success


description:
/
Get mapper by id


Success


description:
/
Update the mapper


description:
/
Delete the mapper


description: realm name (not id!)


description: Mapper id


description:
/
Base path for managing components under this realm.


description:
/
List of subcomponent types that are available to configure for a particular parent component.


description:
/
Base path for the admin REST API for one particular realm.


description: Success


description:
/
Get realm default client scopes.  Only name and ids are returned.


description:
/
Get group hierarchy.  Only name and ids are returned.


description:
/
Get realm optional client scopes.  Only name and ids are returned.


description:
/
Get events

Returns all events, or filters them based on URL query parameters listed here


description: The types of events to return


description: App or oauth client name


description: User id


description: From date


description: To date


description: IP address


description: Paging offset


description: Maximum results size (defaults to 100)


description: Success


description:
/
Delete all events

/


Success


description: realm name (not id!)


description:
/
Get the events provider configuration

Returns JSON object with events provider configuration


description:
/
Update the events provider

Change the events provider and/or its configuration


description:
/
create or add a top level realm groupSet or create child.  This will update the group and set the parent if it exists.  Create it and set the parent
if the group doesn't exist.


description:
/
Update group, ignores subgroups.


description:
/
Does not expand hierarchy.  Subgroups will not be set.


description:
/
Set or create child.  This will just set the parent if it exists.  Create it and set the parent
if the group doesn't exist.


description:
/
Return object stating whether client Authorization permissions have been initialized or not and a reference


description:
/
Get users

Returns a stream of users, filtered according to query parameters


description: Pagination offset


description: Only return basic information (only guaranteed to return id, username, created, first and last name,


description:
/
Get role mappings


description:
/
Get client-level role mappings for the user, and the app


description:
/
Add client-level roles to the user role mapping


description:
/
Delete client-level roles from user role mapping


description:
/
Get available client-level roles that can be mapped to the user


description: Success


description: realm name (not id!)


description:
/
Get effective client-level role mappings

This recurses any composite roles


description: if false, return roles with their attributes


description:
/
Get realm-level role mappings


description:
/
Add realm-level role mappings to the user


Success


description:
/
Delete realm-level role mappings


description:
/
Get realm-level roles that can be mapped


description:
/
Get effective realm-level role mappings

This will recurse all composite roles to get the result.


description:
/
Returns the groups counts.


description: Success


description:
/
Import identity provider from uploaded JSON file


description: Success


description:
/
Get identity providers


description:
/
Create a new identity provider


description:
/
Get the identity provider


description:
/
Delete the identity provider


description:
/
Update the identity provider


description: realm name (not id!)


description:
/
Export public broker configuration for identity provider


description: Format to use


description:
/
Get mapper types for identity provider
/


Success


description:
/
Get mappers for identity provider
/


description: Success


description:
/
Add a mapper to identity provider


description:
/
Get mapper by id for the identity provider


description:
/
Update a mapper for the identity provider


description:
/
Delete a mapper for the identity provider


description: Provider id


description:
/
Base path for the admin REST API for one particular realm.


description:
/
Base path for managing localization under this realm.
/


description: Success


description:
/
Import localization from uploaded JSON file
/


description: Success


description: realm name (not id!)


description: Success


description:
/
Removes all user sessions.  Any client that has an admin url will also be told to invalidate any sessions
they have.

/


description: Success


description: GlobalRequestResult


description:
/
Partial export of existing realm into a JSON file.


Success


description:
/
Partial import from a JSON file to an existing realm.


description:
/
Push the realm's revocation policy to any client that has an admin url associated with it.

/


description:
/
Get all roles for the realm or client


description: Success


description:
/
Create a new role for the realm or client


description:
/
Get a specific role's representation


description:
/
Delete the role


description:
/
Update the role


description: id of role


description:
/
Make the role a composite role by associating some child roles


description:
/
Get role's children

Returns a set of role's children provided the role is a composite.


description:
/
Remove a set of roles from the role's composite


description: realm name (not id!)


description:
/
Get client-level roles for the client that are in the role's composite


description:
/
Get realm-level roles that are in the role's composite


description:
/
Return object stating whether role Authoirzation permissions have been initialized or not and a reference


Success


description:
/
Get a role by name


description:
/
Delete a role by name


description:
/
Update a role by name


description: role's name (not id!)


description:
/
Add a composite to the role


description:
/
Get composites of the role


description: Success


description:
/
Remove roles from the role's composite


description:
/
Get realm-level roles of the role's composite


description:
/
Returns a stream of groups that have the specified role name


description: first result to return. Ignored if negative or {@code null}.


description: maximum number of results to return. Ignored if negative or {@code null}.


description: if false, return a full representation of the {@code GroupRepresentation} objects.


description: realm name (not id!)


description: the role name.


description:
/
Return object stating whether role Authorization permissions have been initialized or not and a reference


Success


description:
/
Returns a stream of users that have the specified role name.


description:
/
Remove a specific user session. Any client that has an admin url will also be told to invalidate this
particular session.


description:
/
Test SMTP connection with current logged in user


description:
/
Create a new user

Username must be unique.


description:
/
Get users

Returns a stream of users, filtered according to query parameters.


description: A String contained in username, first or last name, or email


description: A String contained in lastName, or the complete lastName, if param "exact" is true


description: A String contained in firstName, or the complete firstName, if param "exact" is true


description: A String contained in email, or the complete email, if param "exact" is true


description: A String contained in username, or the complete username, if param "exact" is true


description: whether the email has been verified


description: The alias of an Identity Provider linked to the user


description: The userId at an Identity Provider linked to the user


description: Pagination offset


description: Maximum results size (defaults to 100)


description: Boolean representing if user is enabled or not


description: Boolean which defines whether brief representations are returned (default: false)


description: Boolean which defines whether the params "last", "first", "email" and "username" must match exactly


description: A query to search for custom attributes, in the format 'key1:value2 key2:value2'


description: Success


description: realm name (not id!)


description:
/
Base path for the admin REST API for one particular realm.


Success


description:
/
Update the user


description:
/
Get representation of the user


description:
/
Delete the user
/


description: User id


description:
/
Return credential types, which are provided by the user storage where user is stored. Returned values can contain for example "password", "otp" etc.
This will always return empty list for "local" users, which are not backed by any user storage


description: Success


description:
/
Get consents granted by the user


description: Success


description:
/
Revoke consent and offline tokens for particular client from user


description: Client id


description:
/
Remove a credential for a user

/


description:
/
Move a credential to a position behind another credential


description: The credential to move


description: The credential that will be the previous element in the list. If set to null, the moved credential will be the first element in the list.


description:
/
Move a credential to a first position in the credentials list of the user


description: realm name (not id!)


description:
/
Update a credential label for a user
/


Success


description:
/
Disable all credentials for a user of a specific type


description:
/
Send a update account email to the user

An email contains a link the user can click to perform a set of required actions.
The redirectUri and clientId parameters are optional. If no redirect is given, then there will
be no link back to click after actions have completed.  Redirect uri must be a valid uri for the
particular clientId.


description: Redirect uri


description: Client id


description: Number of seconds after which the generated token expires


description: User id


description:
/
Get social logins associated with the user


description: Success


description:
/
Add a social login provider to the user


description:
/
Remove a social login provider from user


description: Social login provider id


description:
/
Get representation of the user


description:
/
Get representation of the user


description:
/
Get representation of the user


description: realm name (not id!)


description:
/
Get representation of the user


description: Success


description:
/
Impersonate the user


description: Success


description:
/
Remove all user sessions associated with the user

Also send notification to all clients that have an admin URL to invalidate the sessions for the particular user.

/


Success


description:
/
Get offline sessions associated with the user and client


description: User id


description:
/
Set up a new password for the user.


description:
/
Send an email to the user with a link they can click to reset their password.
The redirectUri and clientId parameters are optional. The default for the
redirect is the account client.

This endpoint has been deprecated.  Please use the execute-actions-email passing a list with
UPDATE_PASSWORD within it.


description: redirect uri


description: client id


description:
/
Get role mappings


description:
/
Get client-level role mappings for the user, and the app


description: Success


description:
/
Add client-level roles to the user role mapping


description:
/
Delete client-level roles from user role mapping


description: realm name (not id!)


description:
/
Get available client-level roles that can be mapped to the user


description:
/
Get effective client-level role mappings

This recurses any composite roles


description: if false, return roles with their attributes


description:
/
Get realm-level role mappings


description:
/
Add realm-level role mappings to the user


Success


description:
/
Delete realm-level role mappings


description: User id


description:
/
Get realm-level roles that can be mapped


description:
/
Get effective realm-level role mappings

This will recurse all composite roles to get the result.


description:
/
Send an email-verification email to the user

An email contains a link the user can click to verify their email address.
The redirectUri and clientId parameters are optional. The default for the
redirect is the account client.


description: Redirect uri


description: Client id


description:
/
Get sessions associated with the user


description: Success


description:
/
Returns the number of users that match the given criteria.
It can be called in three different ways.
1. Don't specify any criteria and pass {


description: arbitrary search string for all the fields below


description: last name filter


description: first name filter


description: email filter


description: username filter


description: Boolean representing if user is enabled or not


description: Success


description: realm name (not id!)


description:
/
Get representation of the user


description: Success


description:
/
Get representation of the user


Success


key: items

description: ClientPolicyRepresentation


key: use

description: KeyUse


key: type

description: CapabilityType


key: category

description: TokenCategory

enum: INTERNAL ACCESS ID ADMIN USERINFO LOGOUT AUTHORIZATION_RESPONSE


key: additionalProperties

description: ClaimValue


key: policy

description: Policy


key: decisionStrategy

description: DecisionStrategy


key: logic

description: Logic


key: policyEnforcementMode

description: PolicyEnforcementMode


key: bundle

description: Path to a '.d.ts' bundle file (see below). Change this if you want the bundle to be closer to the actual source files. TSD will create the appropriate relative paths.


key: installed

description: A list of installed typings.


key: path

description: Path to the typings directory, the definitions will be installed in the appropriate sub-folders. Change this to have typings in your main code directory, but this is not recommended as the mixed styles used in the definitions it will confuse your inspections and lint-tools.

default: typings


key: ref

description: Branch name or other git reference of the repository. Change this to use legacy branches.

default: master


key: repo

description: GitHub user and repo name of the typings repository. Change this if you want to use TSD from a DefinitelyTyped fork.

default: borisyankov/DefinitelyTyped


key: stats

description: Set to 'false' to disable the stats tracking. Keep in mind the stats are anonymous, help us improve TSD & DT and motivate us to spend our time on development.


key: version

description: Tracks config version for future changes (don't change this).


description: All AsyncAPI JSON Schema documents listed in one file. Needed for serving all documents through schemastore.org


key: subscription

description: A piece of code that you should run.

required: query webhook


key: datamodel

description:
Type definitions for database models, relations, enums and other types
https://v1.prisma.io/docs/1.34/prisma-cli-and-configuration/prisma-yml-5cy7/#reference

type: string array


key: secret

description:
A secure secret for the current API endpoint
https://v1.prisma.io/docs/1.34/prisma-cli-and-configuration/prisma-yml-5cy7/#reference


key: disableAuth

description:
Disable authentication for the current API endpoint
https://v1.prisma.io/docs/1.34/prisma-cli-and-configuration/prisma-yml-5cy7/#reference


key: generate

description:
How and where generate client
https://v1.prisma.io/docs/1.34/prisma-cli-and-configuration/prisma-yml-5cy7/#reference

enum: javascript-client typescript-client flow-client go-client graphql-schema


key: items

description: Files to be generated for the current API endpoint


key: generator

description:
A client name
https://v1.prisma.io/docs/1.34/prisma-cli-and-configuration/prisma-yml-5cy7/#reference


key: output

description:
An output path
https://v1.prisma.io/docs/1.34/prisma-cli-and-configuration/prisma-yml-5cy7/#reference


key: seed

description:
A database seed
https://v1.prisma.io/docs/1.34/prisma-cli-and-configuration/prisma-yml-5cy7/#reference


key: import

description: Commands to run while seeding a service for the current API endpoint


key: run

description: Instructions to run while seeding a service for the current API endpoint


key: subscriptions

description:
Server-side subscriptions
https://v1.prisma.io/docs/1.34/prisma-cli-and-configuration/prisma-yml-5cy7/#reference


key: custom

description:
Fields to use in variable interpolations via `${self:custom.field}`
https://v1.prisma.io/docs/1.34/prisma-cli-and-configuration/prisma-yml-5cy7/#reference


key: hooks

description:
Hooks
https://v1.prisma.io/docs/1.34/prisma-cli-and-configuration/prisma-yml-5cy7/#reference


key: endpoint

description:
An endpoint the service will be reachable at
https://v1.prisma.io/docs/1.34/prisma-cli-and-configuration/prisma-yml-5cy7/#reference


key: databaseType

description:
A relational or document database
https://v1.prisma.io/docs/1.34/prisma-cli-and-configuration/prisma-yml-5cy7/#reference

enum: relational document


key: optimize

description: Optimizes the module.


key: optimizeLevel

description: How much to focus on optimizing code.


key: shrinkLevel

description: How much to focus on shrinking code size.


key: converge

description: Re-optimizes until no further improvements can be made.


key: baseDir

description: Specifies the base directory of input and output files.


key: outFile

description: Specifies the WebAssembly output file (.wasm).


key: textFile

description: Specifies the WebAssembly text output file (.wat).


key: bindings

description: Specified the bindings to generate.

enum: esm raw


key: sourceMap

description: Enables source map generation. Optionally takes the URL.


key: runtime

description: Specifies the runtime variant to include in the program.

enum: incremental minimal stub


key: noUnsafe

description: Disallows the use of unsafe features in user code.


key: debug

description: Enables debug information in emitted binaries.


key: noAssert

description: Replaces assertions with just their value without trapping.


key: noEmit

description: Performs compilation as usual but does not emit code.


key: importMemory

description: Imports the memory provided as 'env.memory'.


key: noExportMemory

description: Does not export the memory as 'memory'.


key: initialMemory

description: Sets the initial memory size in pages.


key: maximumMemory

description: Sets the maximum memory size in pages.


key: sharedMemory

description: Declare memory as shared. Requires maximumMemory.


key: zeroFilledMemory

description: Assume that imported memory is zero filled. Requires importMemory.


key: memoryBase

description: Sets the start offset of compiler-generated static memory.


key: importTable

description: Imports the function table provided as 'env.table'.


key: exportTable

description: Exports the function table as 'table'.


key: exportStart

description: Exports the start function instead of calling it implicitly.


key: lib

description: Adds one or multiple paths to custom library components.


key: path

description: Adds one or multiple paths to package resolution.


key: use

description: Aliases a global object under another name.


key: trapMode

description: Sets the trap mode to use.

enum: allow clamp js


key: runPasses

description: Specifies additional Binaryen passes to run.


key: noValidate

description: Skips validating the module using Binaryen.


key: enable

description: Enables WebAssembly features that are disabled by default.


key: disable

description: Disables WebAssembly features that are enabled by default.


key: transform

description: Specifies the path to a custom transform to 'require'.


key: pedantic

description: Make yourself sad for no good reason.


key: stats

description: Prints measuring information on I/O and compile times.


key: noColors

description: Disables terminal colors.


key: exportRuntime

description: Exports the runtime helpers (__new, __collect etc.).


key: stackSize


key: lowMemoryLimit

description: Enforces very low (<64k) memory constraints.


key: tableBase

description: Sets the start offset of emitted table elements.


key: wasm

description: Uses the specified Wasm binary of the compiler.


key: $schema

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

format: uri


key: version

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


key: guid

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


key: runGuid

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


key: conversion

description: A conversion object that will be merged with an external run.


key: graphs

description: An array of graph objects that will merged with an external run.


key: externalizedProperties

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


key: artifacts

description: An array of artifact objects that will be merged with an external run.


key: invocations

description: Describes the invocation of the analysis tool that will be merged with an external run.


key: logicalLocations

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


key: threadFlowLocations

description: An array of threadFlowLocation objects that will be merged with an external run.


key: results

description: An array of result objects that will be merged with an external run.


key: taxonomies

description: Tool taxonomies that will be merged with an external run.


key: driver

description: The analysis tool object that will be merged with an external run.


key: extensions

description: Tool extensions that will be merged with an external run.


key: policies

description: Tool policies that will be merged with an external run.


key: translations

description: Tool translations that will be merged with an external run.


key: addresses

description: Addresses that will be merged with with an external run.


key: webRequests

description: Requests that will be merged with an external run.


key: webResponses

description: Responses that will be merged with an external run.


key: properties

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


key: CodeGeneration

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

enum: SystemText Newtonsoft

enum: etag eTag _etag _eTag ETag ETAG

enum: CoreEx FluentValidation

enum: SqlServer MySQL

enum: None DataSvc Data

enum: None Absolute Relative RelativeOrAbsolute


key: withResult

description: Defaults to 'true'. This can be overridden within the 'Entity'(s) and/or 'Operation'(s).


key: refDataNamespace

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


key: refDataCommonNamespace

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


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'). This can be further configured on the 'Entity' and for each 'Property'.


key: refDataDataCtorParams

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: jsonSerializer

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


key: etagJsonName

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


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


key: webApiAuthorize

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


key: webApiAutoLocation

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


key: webApiRoutePrefix

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


key: managerCleanUp

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


key: validationFramework

description: Defaults to 'CoreEx' (literal). This can be overridden within the 'Entity'(s), 'Operation'(s) and 'Parameter'(s).


key: databaseName

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


key: databaseSchema

description: Defaults to 'dbo'.


key: databaseProvider

description: Defaults to 'SqlServer'. Enables specific database provider functionality/formatting/etc. where applicable.


key: entityFrameworkName

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


key: cosmosName

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


key: odataName

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


key: httpAgentName

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


key: etagDefaultMapperConverter

description: Defaults to 'StringToBase64Converter'.


key: refDataDefaultMapperConverter

description: Defaults to 'ReferenceDataCodeConverter<T>'. Where this value is suffixed by '<T>' or '{T}' this will automatically be set to the 'Type'.


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: eventPublish

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


key: eventSourceRoot

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


key: eventSourceKind

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


key: eventSubjectRoot

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


key: eventSubjectSeparator

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


key: eventActionFormat

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


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


key: grpc

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.


key: pathBase

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


key: pathCommon

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


key: pathBusiness

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


key: pathApi

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


key: namespaceBase


key: namespaceCommon

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


key: namespaceBusiness

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


key: namespaceApi

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


key: Entity

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

enum: int long Guid string

enum: SortOrder Id Code Text

enum: Standard Keyed Dictionary

enum: Database EntityFramework Cosmos OData HttpAgent None

enum: Public Private Protected


key: text

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


key: fileName

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


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: constType

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


key: isInitialOverride

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


key: withResult

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


key: refDataType

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


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'). Defaults from 'CodeGeneration.RefDataText'.


key: refDataSortOrder

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


key: inherits

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


key: implementsAutoInfer

description: Will attempt to infer the following: 'IIdentifier<Guid>', 'IIdentifier<int>', 'IIdentifier<long>', 'IIdentifier<string>', 'IETag' and 'IChangeLog'. Defaults to 'true'.


key: namespace

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


key: omitEntityBase

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.


key: jsonSerializer

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


key: collectionResult

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