dataunitylab/json-schema-descriptions · Datasets at Hugging Face

schema stringclasses 471 values	key stringlengths 0 203	description stringlengths 0 4.37k	object stringlengths 2 322k
entity.beef.json	databaseCustomerMapper	Otherwise, by default, a 'Mapper' will be generated.	{"type": "boolean"}
entity.beef.json	entityFrameworkName	Defaults to the 'CodeGeneration.EntityFrameworkName' configuration property (its default value is 'IEfDb').	{"type": "string"}
entity.beef.json	entityFrameworkMapperInheritsFrom	Defaults to 'Model.{Name}'; i.e. an entity with the same name in the 'Model' namespace.	{"type": "string"}
entity.beef.json	entityFrameworkCustomMapper	Otherwise, by default, a 'Mapper' will be generated.	{"type": "boolean"}
entity.beef.json	cosmosName	Defaults to the 'CodeGeneration.CosmosName' configuration property (its default value is 'ICosmosDb').	{"type": "string"}
entity.beef.json	cosmosPartitionKey	Defaults to 'PartitionKey.None'.	{"type": "string"}
entity.beef.json	cosmosCustomMapper	Otherwise, by default, a 'Mapper' will be generated.	{"type": "boolean"}
entity.beef.json	odataName	Defaults to the 'CodeGeneration.ODataName' configuration property (its default value is 'IOData').	{"type": "string"}
entity.beef.json	odataCollectionName	The underlying 'Simple.OData.Client' will attempt to infer.	{"type": "string"}
entity.beef.json	odataCustomMapper	Otherwise, by default, a 'Mapper' will be generated.	{"type": "boolean"}
entity.beef.json	httpAgentName	Defaults to 'CodeGeneration.HttpAgentName' configuration property (its default value is 'IHttpAgent').	{"type": "string"}
entity.beef.json	httpAgentRoutePrefix	This is the base (prefix) 'URI' for the HTTP Agent endpoint and can be further extended when defining the underlying 'Operation'(s).	{"type": "string"}
entity.beef.json	httpAgentModel	This can be overridden within the 'Operation'(s).	{"type": "string"}
entity.beef.json	httpAgentReturnModel	This can be overridden within the 'Operation'(s).	{"type": "string"}
entity.beef.json	dataSvcCaching	Defaults to 'true'.	{"type": "boolean"}
entity.beef.json	dataSvcCtor	Defaults to 'Public'.	{"type": "string", "enum": ["Public", "Private", "Protected"]}
entity.beef.json	dataSvcCtorParams	Each constructor parameter should be formatted as 'Type' + '^' + 'Name'; e.g. 'IConfiguration^Config'. Where the 'Name' portion is not specified it will be inferred. Where the 'Type' matches an already inferred value it will be ignored.	{"type": "array", "items": {"type": "string"}}
entity.beef.json	dataSvcExtensions	This can be overridden using 'Operation.DataSvcExtensions'.	{"type": "boolean"}
entity.beef.json	eventPublish	Defaults to the 'CodeGeneration.EventPublish' configuration property (inherits) where not specified. Used to enable the sending of messages to the likes of EventGrid, Service Broker, SignalR, etc. This can be overridden within the 'Operation'(s).	{"type": "string", "enum": ["None", "DataSvc", "Data"]}
entity.beef.json	eventOutbox	Defaults to 'CodeGeneration.EventOutbox' configuration property (inherits) where not specified. A value of 'Database' will result in the 'DatabaseEventOutboxInvoker' being used to orchestrate.	{"type": "string", "enum": ["None", "Database"]}
entity.beef.json	eventSource	Defaults to 'Name' (as lowercase) appended with the '/{$key}' placeholder. Note: when used in code-generation the 'CodeGeneration.EventSourceRoot' will be prepended where specified. To include the entity id/key include a '{$key}' placeholder ('Create', 'Update' or 'Delete' operation only); for example: 'person/{$key}'. This can be overridden for the 'Operation'.	{"type": "string"}
entity.beef.json	eventSubjectFormat	Defaults to 'CodeGeneration.EventSubjectFormat'.	{"type": "string", "enum": ["NameOnly", "NameAndKey"]}
entity.beef.json	eventCasing	Defaults to 'CodeGeneration.EventCasing'.	{"type": "string", "enum": ["None", "Lower", "Upper"]}
entity.beef.json	eventTransaction	Usage will force a rollback of any underlying data transaction (where the provider supports TransactionScope) on failure, such as an 'EventPublish' error. This is by no means implying a Distributed Transaction (DTC) should be invoked; this is only intended for a single data source that supports a TransactionScope to guarantee reliable event publishing. Defaults to 'CodeGeneration.EventTransaction'. This essentially defaults the 'Operation.DataSvcTransaction' where not otherwise specified. This should only be used where 'EventPublish' is 'DataSvc' and a transactionally-aware data source is being used.	{"type": "boolean"}
entity.beef.json	managerCtor	Defaults to 'Public'.	{"type": "string", "enum": ["Public", "Private", "Protected"]}
entity.beef.json	managerCtorParams	Each constructor parameter should be formatted as 'Type' + '^' + 'Name'; e.g. 'IConfiguration^Config'. Where the 'Name' portion is not specified it will be inferred. Where the 'Type' matches an already inferred value it will be ignored.	{"type": "array", "items": {"type": "string"}}
entity.beef.json	managerExtensions	This can be overridden using 'Operation.ManagerExtensions'.	{"type": "boolean"}
entity.beef.json	validator	Only used for defaulting the 'Create' and 'Update' operation types ('Operation.Type') where not specified explicitly.	{"type": "string"}
entity.beef.json	iValidator	Only used for defaulting the 'Create' and 'Update' operation types ('Operation.Type') where not specified explicitly.	{"type": "string"}
entity.beef.json	webApiRoutePrefix	This is the base (prefix) 'URI' for the entity and can be further extended when defining the underlying 'Operation'(s). The 'CodeGeneration.WebApiRoutePrefix' will be prepended where specified.	{"type": "string"}
entity.beef.json	webApiAuthorize	Defaults to the 'CodeGeneration.WebApiAuthorize' configuration property (inherits) where not specified; can be overridden at the 'Operation' level also.	{"type": "string"}
entity.beef.json	webApiCtor	Defaults to 'Public'.	{"type": "string", "enum": ["Public", "Private", "Protected"]}
entity.beef.json	webApiCtorParams	Each constructor parameter should be formatted as 'Type' + '^' + 'Name'; e.g. 'IConfiguration^Config'. Where the 'Name' portion is not specified it will be inferred. Where the 'Type' matches an already inferred value it will be ignored.	{"type": "array", "items": {"type": "string"}}
entity.beef.json	webApiAutoLocation	This will automatically set the 'Operation.WebApiLocation' for an 'Operation' named 'Create' where there is a corresponding named 'Get'. This is defaulted from the 'CodeGen.WebApiAutoLocation'.	{"type": "boolean"}
entity.beef.json	webApiConcurrency	This provides an alternative where the underlying data source does not natively support optimistic concurrency (native support should always be leveraged as a priority). Where the 'Operation.Type' is 'Update' or 'Patch', the request ETag will be matched against the response for a corresponding 'Get' operation to verify no changes have been made prior to updating. For this to function correctly the .NET response Type for the 'Get' must be the same as that returned from the corresponding 'Create', 'Update' and 'Patch' (where applicable) as the generated ETag is a SHA256 hash of the resulting JSON. This defaults the 'Operation.WebApiConcurrency'.	{"type": "boolean"}
entity.beef.json	webApiGetOperation	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'.	{"type": "string"}
entity.beef.json	dataModel	The model will be generated with 'OmitEntityBase = true'. Any reference data properties will be defined using their 'RefDataType' intrinsic 'Type' versus their corresponding (actual) reference data 'Type'.	{"type": "boolean"}
entity.beef.json	excludeAll	Is a shorthand means for setting all of the other 'Exclude*' properties (with the exception of 'ExcludeEntity') to exclude.	{"type": "boolean"}
entity.beef.json	excludeData	Defaults to 'Include' indicating _not_ to exlude. A value of 'Exclude' indicates to exclude all output; alternatively, 'RequiresMapper' indicates to at least output the corresponding 'Mapper' class.	{"type": "string", "enum": ["Include", "Exclude", "RequiresMapper"]}
entity.beef.json	authRole	Used where not overridden specifically for an 'Operation'; i.e. acts as the default.	{"type": "string"}
entity.beef.json	grpc	gRPC support is an explicit opt-in model (see 'CodeGeneration.Grpc' configuration); therefore, each corresponding 'Property' and 'Operation' will also need to be opted-in specifically.	{"type": "boolean"}
entity.beef.json	Property	The 'Property' object defines an 'Entity' property and its charateristics.	{"type": "object", "properties": {"name": {"type": "string"}, "text": {"type": "string"}, "modelText": {"type": "string"}, "type": {"type": "string"}, "nullable": {"type": "boolean"}, "inherited": {"type": "boolean"}, "privateName": {"type": "string"}, "argumentName": {"type": "string"}, "uniqueKey": {"type": "boolean"}, "isEntity": {"type": "boolean"}, "immutable": {"type": "boolean"}, "dateTimeTransform": {"type": "string", "enum": ["UseDefault", "None", "DateOnly", "DateTimeLocal", "DateTimeUtc", "DateTimeUnspecified"]}, "stringTrim": {"type": "string", "enum": ["UseDefault", "None", "Start", "End", "Both"]}, "stringTransform": {"type": "string", "enum": ["UseDefault", "None", "NullToEmpty", "EmptyToNull"]}, "autoCreate": {"type": "boolean"}, "default": {"type": "string"}, "partitionKey": {"type": "boolean"}, "secondaryPropertyChanged": {"type": "string"}, "bubblePropertyChanges": {"type": "boolean"}, "excludeCleanup": {"type": "boolean"}, "internalOnly": {"type": "boolean"}, "refDataType": {"type": "string", "enum": ["string", "int", "Guid"]}, "refDataList": {"type": "boolean"}, "refDataText": {"type": "boolean"}, "refDataMapping": {"type": "boolean"}, "jsonName": {"type": "string"}, "jsonDataModelName": {"type": "string"}, "serializationIgnore": {"type": "boolean"}, "serializationEmitDefault": {"type": "boolean"}, "dataModelJsonName": {"type": "string"}, "identifierGenerator": {"type": "string"}, "dataName": {"type": "string"}, "dataConverter": {"type": "string"}, "dataConverterIsGeneric": {"type": "boolean"}, "dataMapperIgnore": {"type": "boolean"}, "dataAutoGenerated": {"type": "boolean"}, "dataOperationTypes": {"type": "string", "enum": ["Any", "AnyExceptCreate", "AnyExceptUpdate", "AnyExceptGet", "Get", "Create", "Update", "Delete"]}, "databaseMapper": {"type": "string"}, "databaseIgnore": {"type": "boolean"}, "databaseDbType": {"type": "string"}, "entityFrameworkMapper": {"type": "string", "enum": ["Map", "Ignore", "Skip"]}, "cosmosMapper": {"type": "string", "enum": ["Map", "Ignore", "Skip"]}, "odataMapper": {"type": "string", "enum": ["Map", "Ignore", "Skip"]}, "httpAgentMapper": {"type": "string", "enum": ["Map", "Ignore", "Skip"]}, "displayName": {"type": "string"}, "annotation1": {"type": "string"}, "annotation2": {"type": "string"}, "annotation3": {"type": "string"}, "webApiQueryStringConverter": {"type": "string"}, "grpcFieldNo": {"type": "integer"}, "grpcType": {"type": "string"}}, "required": ["name"]}
entity.beef.json	text	By default the 'Text' will be the 'Name' reformatted as sentence casing. Depending on whether the 'Type' is 'bool', will appear in one of the two generated sentences. Where not 'bool' it will be: Gets or sets a value indicating whether {text}.'. Otherwise, it will be: Gets or sets the {text}.'. To create a '<see cref="XXX"/>' within use moustache shorthand (e.g. {{Xxx}}).	{"type": "string"}
entity.beef.json	modelText	By default the 'ModelText' will be the 'Name' reformatted as sentence casing. Depending on whether the 'Type' is 'bool', will appear in one of the two generated sentences. Where not 'bool' it will be: Gets or sets a value indicating whether {text}.'. Otherwise, it will be: Gets or sets the {text}.'. To create a '<see cref="XXX"/>' within use moustache shorthand (e.g. {{Xxx}}).	{"type": "string"}
entity.beef.json	type	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.'	{"type": "string"}
entity.beef.json	privateName	Overrides the 'Name' to be used for private fields. By default reformatted from 'Name'; e.g. 'FirstName' as '_firstName'.	{"type": "string"}
entity.beef.json	argumentName	Overrides the 'Name' to be used for argument parameters. By default reformatted from 'Name'; e.g. 'FirstName' as 'firstName'.	{"type": "string"}
entity.beef.json	uniqueKey	This is also used to simplify the parameter specification for an Entity Operation by inferrence.	{"type": "boolean"}
entity.beef.json	isEntity	Will be inferred (default to 'true') where the 'Type' is 'ChangeLog' or the 'Type' is found as another 'Entity' within the code-generation configuration file.	{"type": "boolean"}
entity.beef.json	dateTimeTransform	Defaults to 'UseDefault'. This is only applied where the 'Type' is 'DateTime'.	{"type": "string", "enum": ["UseDefault", "None", "DateOnly", "DateTimeLocal", "DateTimeUtc", "DateTimeUnspecified"]}
entity.beef.json	stringTrim	Defaults to 'UseDefault'. This is only applied where the 'Type' is 'string'.	{"type": "string", "enum": ["UseDefault", "None", "Start", "End", "Both"]}
entity.beef.json	stringTransform	Defaults to 'UseDefault'. This is only applied where the 'Type' is 'string'.	{"type": "string", "enum": ["UseDefault", "None", "NullToEmpty", "EmptyToNull"]}
entity.beef.json	default	Where the 'Type' is 'string' then the specified default value will need to be delimited. Any valid value assignment C# code can be used.	{"type": "string"}
entity.beef.json	partitionKey	This will implement 'IPartitionKey' for the generated entity.	{"type": "boolean"}
entity.beef.json	bubblePropertyChanges	Note that the 'IsEntity' property is also required to enable.	{"type": "boolean"}
entity.beef.json	internalOnly	This is only applicable where the 'Entity.EntityScope' is 'Autonomous'. In this instance the 'Property' will be excluded from the 'Common' entity declaration.	{"type": "boolean"}
entity.beef.json	refDataType	Defaults to 'string' (being the 'ReferenceDataBase.Code') where not specified and the corresponding 'Type' starts with (prefix) 'RefDataNamespace.' or '^'. Note: an 'Id' of type 'string' is currently not supported; the use of the 'Code' is the recommended approach.	{"type": "string", "enum": ["string", "int", "Guid"]}
entity.beef.json	refDataList	This is required to enable a list of Reference Data values (as per 'RefDataType') to be passed as an argument for example.	{"type": "boolean"}
entity.beef.json	refDataText	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"}
entity.beef.json	refDataMapping	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.	{"type": "boolean"}
entity.beef.json	jsonName	Defaults to 'ArgumentName' where not specified (i.e. camelCase); however, where the property is 'ETag' it will default to the 'Config.ETagJsonName'.	{"type": "string"}
entity.beef.json	jsonDataModelName	Defaults to 'JsonName' where not specified.	{"type": "string"}
entity.beef.json	serializationIgnore	All properties are serialized by default.	{"type": "boolean"}
entity.beef.json	dataModelJsonName	Defaults to 'JsonName' where not specified.	{"type": "string"}
entity.beef.json	identifierGenerator	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.	{"type": "string"}
entity.beef.json	dataName	Defaults to the property 'Name'. Represents the column name for a 'Database', or the correspinding property name for the other options.	{"type": "string"}
entity.beef.json	dataConverter	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'.	{"type": "string"}
entity.beef.json	dataMapperIgnore	All properties are included by default.	{"type": "boolean"}
entity.beef.json	dataOperationTypes	Defaults to 'Any'.	{"type": "string", "enum": ["Any", "AnyExceptCreate", "AnyExceptUpdate", "AnyExceptGet", "Get", "Create", "Update", "Delete"]}
entity.beef.json	databaseMapper	A 'Mapper' is used to map a data source value to/from a .NET complex 'Type' (i.e. class with one or more properties).	{"type": "string"}
entity.beef.json	databaseDbType	Overrides the inferred database type; i.e. can specify 'Date' or 'DateTime2', for .NET Type 'System.DateTime'.	{"type": "string"}
entity.beef.json	entityFrameworkMapper	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.	{"type": "string", "enum": ["Map", "Ignore", "Skip"]}
entity.beef.json	cosmosMapper	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.	{"type": "string", "enum": ["Map", "Ignore", "Skip"]}
entity.beef.json	odataMapper	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.	{"type": "string", "enum": ["Map", "Ignore", "Skip"]}
entity.beef.json	httpAgentMapper	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.	{"type": "string", "enum": ["Map", "Ignore", "Skip"]}
entity.beef.json	displayName	Defaults to the 'Name' as sentence case.	{"type": "string"}
entity.beef.json	Operation	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", "properties": {"name": {"type": "string"}, "type": {"type": "string", "enum": ["Get", "GetColl", "Create", "Update", "Patch", "Delete", "Custom"]}, "text": {"type": "string"}, "uniqueKey": {"type": "boolean"}, "paging": {"type": "boolean"}, "valueType": {"type": "string"}, "returnType": {"type": "string"}, "returnTypeNullable": {"type": "boolean"}, "returnText": {"type": "string"}, "privateName": {"type": "string"}, "autoImplement": {"type": "string", "enum": ["Database", "EntityFramework", "Cosmos", "OData", "HttpAgent", "None"]}, "dataEntityMapper": {"type": "string"}, "dataExtensions": {"type": "boolean"}, "dataTransaction": {"type": "boolean"}, "databaseStoredProc": {"type": "string"}, "cosmosContainerId": {"type": "string"}, "cosmosPartitionKey": {"type": "string"}, "odataCollectionName": {"type": "string"}, "httpAgentRoute": {"type": "string"}, "httpAgentMethod": {"type": "string", "enum": ["HttpGet", "HttpPost", "HttpPut", "HttpDelete", "HttpPatch"]}, "httpAgentModel": {"type": "string"}, "httpAgentReturnModel": {"type": "string"}, "managerCustom": {"type": "boolean"}, "managerTransaction": {"type": "boolean"}, "managerExtensions": {"type": "boolean"}, "validator": {"type": "string"}, "iValidator": {"type": "string"}, "managerOperationType": {"type": "string", "enum": ["Create", "Read", "Update", "Delete", "Unspecified"]}, "dataSvcCustom": {"type": "boolean"}, "dataSvcTransaction": {"type": "boolean"}, "dataSvcExtensions": {"type": "boolean"}, "eventPublish": {"type": "string", "enum": ["None", "DataSvc", "Data"]}, "eventOutbox": {"type": "string", "enum": ["None", "Database"]}, "eventSource": {"type": "string"}, "eventSubject": {"type": "string"}, "webApiRoute": {"type": "string"}, "webApiAuthorize": {"type": "string"}, "webApiMethod": {"type": "string", "enum": ["HttpGet", "HttpPost", "HttpPut", "HttpDelete"]}, "webApiStatus": {"type": "string", "enum": ["OK", "Accepted", "Created", "NoContent", "NotFound"]}, "webApiAlternateStatus": {"type": "string", "enum": ["OK", "Accepted", "Created", "NoContent", "NotFound", "ThrowException"]}, "webApiLocation": {"type": "string"}, "webApiConcurrency": {"type": "boolean"}, "webApiGetOperation": {"type": "string"}, "webApiUpdateOperation": {"type": "string"}, "authPermission": {"type": "string"}, "authRole": {"type": "string"}, "excludeAll": {"type": "boolean"}, "excludeIData": {"type": "boolean"}, "excludeData": {"type": "boolean"}, "excludeIDataSvc": {"type": "boolean"}, "excludeDataSvc": {"type": "boolean"}, "excludeIManager": {"type": "boolean"}, "excludeManager": {"type": "boolean"}, "excludeWebApi": {"type": "boolean"}, "excludeWebApiAgent": {"type": "boolean"}, "excludeGrpcAgent": {"type": "boolean"}, "grpc": {"type": "boolean"}, "parameters": {"type": "array", "items": {}}}, "required": ["name"]}
entity.beef.json	text	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}}).	{"type": "string"}
entity.beef.json	uniqueKey	This simplifies the specification of these properties versus having to declare each specifically.	{"type": "boolean"}
entity.beef.json	valueType	Defaults to the parent 'Entity.Name' where the 'Operation.Type' options are 'Create' or 'Update'.	{"type": "string"}
entity.beef.json	returnType	Defaults to the parent 'Entity.Name' where the 'Operation.Type' options are 'Get', 'GetColl', 'Create' or 'Update'; otherwise, defaults to 'void'.	{"type": "string"}
entity.beef.json	returnTypeNullable	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 '?'.	{"type": "boolean"}
entity.beef.json	returnText	A default will be created where not specified. To create a '<see cref="XXX"/>' within use moustache shorthand (e.g. {{Xxx}}).	{"type": "string"}
entity.beef.json	privateName	Overrides the 'Name' to be used for private usage. By default reformatted from 'Name'; e.g. 'GetByArgs' as '_getByArgs'.	{"type": "string"}
entity.beef.json	autoImplement	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'.	{"type": "string", "enum": ["Database", "EntityFramework", "Cosmos", "OData", "HttpAgent", "None"]}
entity.beef.json	dataEntityMapper	Used where the default generated 'Mapper' is not applicable.	{"type": "string"}
entity.beef.json	dataExtensions	Defaults to 'Entity.DataExtensions'.	{"type": "boolean"}
entity.beef.json	dataTransaction	Where using an 'EventOutbox' this is ignored as it is implied through its usage.	{"type": "boolean"}
entity.beef.json	databaseStoredProc	Defaults to 'sp' + 'Entity.Name' + 'Operation.Name'; e.g. 'spPersonCreate'.	{"type": "string"}
entity.beef.json	cosmosContainerId	Overrides the 'Entity.CosmosContainerId'.	{"type": "string"}
entity.beef.json	cosmosPartitionKey	Overrides the 'Entity.CosmosPartitionKey'.	{"type": "string"}
entity.beef.json	odataCollectionName	Overriddes the 'Entity.ODataCollectionName'; otherwise, the underlying 'Simple.OData.Client' will attempt to infer.	{"type": "string"}
entity.beef.json	httpAgentRoute	This is appended to the 'Entity.HttpAgentRoutePrefix'.	{"type": "string"}
entity.beef.json	httpAgentMethod	Defaults to 'Operation.WebApiMethod'.	{"type": "string", "enum": ["HttpGet", "HttpPost", "HttpPut", "HttpDelete", "HttpPatch"]}
entity.beef.json	httpAgentModel	This can be overridden within the 'Operation'(s).	{"type": "string"}
entity.beef.json	httpAgentReturnModel	Defaults to 'Operation.HttpAgentModel' where the 'Operation.ReturnType' is equal to 'Entity.Name' (same type). This can be overridden within the 'Operation'(s).	{"type": "string"}
entity.beef.json	managerExtensions	Defaults to 'Entity.ManagerExtensions'.	{"type": "boolean"}
entity.beef.json	validator	Defaults to the 'Entity.Validator' where not specified explicitly. Only used for 'Operation.Type' options 'Create' or 'Update'.	{"type": "string"}
entity.beef.json	iValidator	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'.	{"type": "string"}
entity.beef.json	managerOperationType	The default will be inferred from the 'Operation.Type'; however, where the 'Operation.Type' is 'Custom' it will default to 'Unspecified'.	{"type": "string", "enum": ["Create", "Read", "Update", "Delete", "Unspecified"]}

entity.beef.json

databaseCustomerMapper

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

{"type": "boolean"}

entity.beef.json

entityFrameworkName

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

{"type": "string"}

entity.beef.json

entityFrameworkMapperInheritsFrom

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

{"type": "string"}

entity.beef.json

entityFrameworkCustomMapper

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

{"type": "boolean"}

entity.beef.json

cosmosName

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

{"type": "string"}

entity.beef.json

cosmosPartitionKey

Defaults to 'PartitionKey.None'.

{"type": "string"}

entity.beef.json

cosmosCustomMapper

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

{"type": "boolean"}

entity.beef.json

odataName

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

{"type": "string"}

entity.beef.json

odataCollectionName

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

{"type": "string"}

entity.beef.json

odataCustomMapper

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

{"type": "boolean"}

entity.beef.json

httpAgentName

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

{"type": "string"}

entity.beef.json

httpAgentRoutePrefix

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

{"type": "string"}

entity.beef.json

httpAgentModel

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

{"type": "string"}

entity.beef.json

httpAgentReturnModel

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

{"type": "string"}

entity.beef.json

dataSvcCaching

Defaults to 'true'.

{"type": "boolean"}

entity.beef.json

dataSvcCtor

Defaults to 'Public'.

{"type": "string", "enum": ["Public", "Private", "Protected"]}

entity.beef.json

dataSvcCtorParams

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

{"type": "array", "items": {"type": "string"}}

entity.beef.json

dataSvcExtensions

This can be overridden using 'Operation.DataSvcExtensions'.

{"type": "boolean"}

entity.beef.json

eventPublish

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

{"type": "string", "enum": ["None", "DataSvc", "Data"]}

entity.beef.json

eventOutbox

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

{"type": "string", "enum": ["None", "Database"]}

entity.beef.json

eventSource

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

{"type": "string"}

entity.beef.json

eventSubjectFormat

Defaults to 'CodeGeneration.EventSubjectFormat'.

{"type": "string", "enum": ["NameOnly", "NameAndKey"]}

entity.beef.json

eventCasing

Defaults to 'CodeGeneration.EventCasing'.

{"type": "string", "enum": ["None", "Lower", "Upper"]}

entity.beef.json

eventTransaction

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

{"type": "boolean"}

entity.beef.json

managerCtor

Defaults to 'Public'.

{"type": "string", "enum": ["Public", "Private", "Protected"]}

entity.beef.json

managerCtorParams

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

{"type": "array", "items": {"type": "string"}}

entity.beef.json

managerExtensions

This can be overridden using 'Operation.ManagerExtensions'.

{"type": "boolean"}

entity.beef.json

validator

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

{"type": "string"}

entity.beef.json

iValidator

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

{"type": "string"}

entity.beef.json

webApiRoutePrefix

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

{"type": "string"}

entity.beef.json

webApiAuthorize

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

{"type": "string"}

entity.beef.json

webApiCtor

Defaults to 'Public'.

{"type": "string", "enum": ["Public", "Private", "Protected"]}

entity.beef.json

webApiCtorParams

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

{"type": "array", "items": {"type": "string"}}

entity.beef.json

webApiAutoLocation

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

{"type": "boolean"}

entity.beef.json

webApiConcurrency

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

{"type": "boolean"}

entity.beef.json

webApiGetOperation

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

{"type": "string"}

entity.beef.json

dataModel

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

{"type": "boolean"}

entity.beef.json

excludeAll

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

{"type": "boolean"}

entity.beef.json

excludeData

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

{"type": "string", "enum": ["Include", "Exclude", "RequiresMapper"]}

entity.beef.json

authRole

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

{"type": "string"}

entity.beef.json

grpc

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

{"type": "boolean"}

entity.beef.json

Property

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

{"type": "object", "properties": {"name": {"type": "string"}, "text": {"type": "string"}, "modelText": {"type": "string"}, "type": {"type": "string"}, "nullable": {"type": "boolean"}, "inherited": {"type": "boolean"}, "privateName": {"type": "string"}, "argumentName": {"type": "string"}, "uniqueKey": {"type": "boolean"}, "isEntity": {"type": "boolean"}, "immutable": {"type": "boolean"}, "dateTimeTransform": {"type": "string", "enum": ["UseDefault", "None", "DateOnly", "DateTimeLocal", "DateTimeUtc", "DateTimeUnspecified"]}, "stringTrim": {"type": "string", "enum": ["UseDefault", "None", "Start", "End", "Both"]}, "stringTransform": {"type": "string", "enum": ["UseDefault", "None", "NullToEmpty", "EmptyToNull"]}, "autoCreate": {"type": "boolean"}, "default": {"type": "string"}, "partitionKey": {"type": "boolean"}, "secondaryPropertyChanged": {"type": "string"}, "bubblePropertyChanges": {"type": "boolean"}, "excludeCleanup": {"type": "boolean"}, "internalOnly": {"type": "boolean"}, "refDataType": {"type": "string", "enum": ["string", "int", "Guid"]}, "refDataList": {"type": "boolean"}, "refDataText": {"type": "boolean"}, "refDataMapping": {"type": "boolean"}, "jsonName": {"type": "string"}, "jsonDataModelName": {"type": "string"}, "serializationIgnore": {"type": "boolean"}, "serializationEmitDefault": {"type": "boolean"}, "dataModelJsonName": {"type": "string"}, "identifierGenerator": {"type": "string"}, "dataName": {"type": "string"}, "dataConverter": {"type": "string"}, "dataConverterIsGeneric": {"type": "boolean"}, "dataMapperIgnore": {"type": "boolean"}, "dataAutoGenerated": {"type": "boolean"}, "dataOperationTypes": {"type": "string", "enum": ["Any", "AnyExceptCreate", "AnyExceptUpdate", "AnyExceptGet", "Get", "Create", "Update", "Delete"]}, "databaseMapper": {"type": "string"}, "databaseIgnore": {"type": "boolean"}, "databaseDbType": {"type": "string"}, "entityFrameworkMapper": {"type": "string", "enum": ["Map", "Ignore", "Skip"]}, "cosmosMapper": {"type": "string", "enum": ["Map", "Ignore", "Skip"]}, "odataMapper": {"type": "string", "enum": ["Map", "Ignore", "Skip"]}, "httpAgentMapper": {"type": "string", "enum": ["Map", "Ignore", "Skip"]}, "displayName": {"type": "string"}, "annotation1": {"type": "string"}, "annotation2": {"type": "string"}, "annotation3": {"type": "string"}, "webApiQueryStringConverter": {"type": "string"}, "grpcFieldNo": {"type": "integer"}, "grpcType": {"type": "string"}}, "required": ["name"]}

entity.beef.json

text

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

{"type": "string"}

entity.beef.json

modelText

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

{"type": "string"}

entity.beef.json

type

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

{"type": "string"}

entity.beef.json

privateName

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

{"type": "string"}

entity.beef.json

argumentName

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

{"type": "string"}

entity.beef.json

uniqueKey

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

{"type": "boolean"}

entity.beef.json

isEntity

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

{"type": "boolean"}

entity.beef.json

dateTimeTransform

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

{"type": "string", "enum": ["UseDefault", "None", "DateOnly", "DateTimeLocal", "DateTimeUtc", "DateTimeUnspecified"]}

entity.beef.json

stringTrim

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

{"type": "string", "enum": ["UseDefault", "None", "Start", "End", "Both"]}

entity.beef.json

stringTransform

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

{"type": "string", "enum": ["UseDefault", "None", "NullToEmpty", "EmptyToNull"]}

entity.beef.json

default

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

{"type": "string"}

entity.beef.json

partitionKey

This will implement 'IPartitionKey' for the generated entity.

{"type": "boolean"}

entity.beef.json

bubblePropertyChanges

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

{"type": "boolean"}

entity.beef.json

internalOnly

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

{"type": "boolean"}

entity.beef.json

refDataType

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

{"type": "string", "enum": ["string", "int", "Guid"]}

entity.beef.json

refDataList

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

{"type": "boolean"}

entity.beef.json

refDataText

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"}

entity.beef.json

refDataMapping

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.

{"type": "boolean"}

entity.beef.json

jsonName

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

{"type": "string"}

entity.beef.json

jsonDataModelName

Defaults to 'JsonName' where not specified.

{"type": "string"}

entity.beef.json

serializationIgnore

All properties are serialized by default.

{"type": "boolean"}

entity.beef.json

dataModelJsonName

Defaults to 'JsonName' where not specified.

{"type": "string"}

entity.beef.json

identifierGenerator

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.

{"type": "string"}

entity.beef.json

dataName

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

{"type": "string"}

entity.beef.json

dataConverter

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

{"type": "string"}

entity.beef.json

dataMapperIgnore

All properties are included by default.

{"type": "boolean"}

entity.beef.json

dataOperationTypes

Defaults to 'Any'.

{"type": "string", "enum": ["Any", "AnyExceptCreate", "AnyExceptUpdate", "AnyExceptGet", "Get", "Create", "Update", "Delete"]}

entity.beef.json

databaseMapper

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

{"type": "string"}

entity.beef.json

databaseDbType

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

{"type": "string"}

entity.beef.json

entityFrameworkMapper

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.

{"type": "string", "enum": ["Map", "Ignore", "Skip"]}

entity.beef.json

cosmosMapper

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.

{"type": "string", "enum": ["Map", "Ignore", "Skip"]}

entity.beef.json

odataMapper

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.

{"type": "string", "enum": ["Map", "Ignore", "Skip"]}

entity.beef.json

httpAgentMapper

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.

{"type": "string", "enum": ["Map", "Ignore", "Skip"]}

entity.beef.json

displayName

Defaults to the 'Name' as sentence case.

{"type": "string"}

entity.beef.json

Operation

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", "properties": {"name": {"type": "string"}, "type": {"type": "string", "enum": ["Get", "GetColl", "Create", "Update", "Patch", "Delete", "Custom"]}, "text": {"type": "string"}, "uniqueKey": {"type": "boolean"}, "paging": {"type": "boolean"}, "valueType": {"type": "string"}, "returnType": {"type": "string"}, "returnTypeNullable": {"type": "boolean"}, "returnText": {"type": "string"}, "privateName": {"type": "string"}, "autoImplement": {"type": "string", "enum": ["Database", "EntityFramework", "Cosmos", "OData", "HttpAgent", "None"]}, "dataEntityMapper": {"type": "string"}, "dataExtensions": {"type": "boolean"}, "dataTransaction": {"type": "boolean"}, "databaseStoredProc": {"type": "string"}, "cosmosContainerId": {"type": "string"}, "cosmosPartitionKey": {"type": "string"}, "odataCollectionName": {"type": "string"}, "httpAgentRoute": {"type": "string"}, "httpAgentMethod": {"type": "string", "enum": ["HttpGet", "HttpPost", "HttpPut", "HttpDelete", "HttpPatch"]}, "httpAgentModel": {"type": "string"}, "httpAgentReturnModel": {"type": "string"}, "managerCustom": {"type": "boolean"}, "managerTransaction": {"type": "boolean"}, "managerExtensions": {"type": "boolean"}, "validator": {"type": "string"}, "iValidator": {"type": "string"}, "managerOperationType": {"type": "string", "enum": ["Create", "Read", "Update", "Delete", "Unspecified"]}, "dataSvcCustom": {"type": "boolean"}, "dataSvcTransaction": {"type": "boolean"}, "dataSvcExtensions": {"type": "boolean"}, "eventPublish": {"type": "string", "enum": ["None", "DataSvc", "Data"]}, "eventOutbox": {"type": "string", "enum": ["None", "Database"]}, "eventSource": {"type": "string"}, "eventSubject": {"type": "string"}, "webApiRoute": {"type": "string"}, "webApiAuthorize": {"type": "string"}, "webApiMethod": {"type": "string", "enum": ["HttpGet", "HttpPost", "HttpPut", "HttpDelete"]}, "webApiStatus": {"type": "string", "enum": ["OK", "Accepted", "Created", "NoContent", "NotFound"]}, "webApiAlternateStatus": {"type": "string", "enum": ["OK", "Accepted", "Created", "NoContent", "NotFound", "ThrowException"]}, "webApiLocation": {"type": "string"}, "webApiConcurrency": {"type": "boolean"}, "webApiGetOperation": {"type": "string"}, "webApiUpdateOperation": {"type": "string"}, "authPermission": {"type": "string"}, "authRole": {"type": "string"}, "excludeAll": {"type": "boolean"}, "excludeIData": {"type": "boolean"}, "excludeData": {"type": "boolean"}, "excludeIDataSvc": {"type": "boolean"}, "excludeDataSvc": {"type": "boolean"}, "excludeIManager": {"type": "boolean"}, "excludeManager": {"type": "boolean"}, "excludeWebApi": {"type": "boolean"}, "excludeWebApiAgent": {"type": "boolean"}, "excludeGrpcAgent": {"type": "boolean"}, "grpc": {"type": "boolean"}, "parameters": {"type": "array", "items": {}}}, "required": ["name"]}

entity.beef.json

text

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

{"type": "string"}

entity.beef.json

uniqueKey

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

{"type": "boolean"}

entity.beef.json

valueType

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

{"type": "string"}

entity.beef.json

returnType

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

{"type": "string"}

entity.beef.json

returnTypeNullable

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

{"type": "boolean"}

entity.beef.json

returnText

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

{"type": "string"}

entity.beef.json

privateName

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

{"type": "string"}

entity.beef.json

autoImplement

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

{"type": "string", "enum": ["Database", "EntityFramework", "Cosmos", "OData", "HttpAgent", "None"]}

entity.beef.json

dataEntityMapper

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

{"type": "string"}

entity.beef.json

dataExtensions

Defaults to 'Entity.DataExtensions'.

{"type": "boolean"}

entity.beef.json

dataTransaction

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

{"type": "boolean"}

entity.beef.json

databaseStoredProc

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

{"type": "string"}

entity.beef.json

cosmosContainerId

Overrides the 'Entity.CosmosContainerId'.

{"type": "string"}

entity.beef.json

cosmosPartitionKey

Overrides the 'Entity.CosmosPartitionKey'.

{"type": "string"}

entity.beef.json

odataCollectionName

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

{"type": "string"}

entity.beef.json

httpAgentRoute

This is appended to the 'Entity.HttpAgentRoutePrefix'.

{"type": "string"}

entity.beef.json

httpAgentMethod

Defaults to 'Operation.WebApiMethod'.

{"type": "string", "enum": ["HttpGet", "HttpPost", "HttpPut", "HttpDelete", "HttpPatch"]}

entity.beef.json

httpAgentModel

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

{"type": "string"}

entity.beef.json

httpAgentReturnModel

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

{"type": "string"}

entity.beef.json

managerExtensions

Defaults to 'Entity.ManagerExtensions'.

{"type": "boolean"}

entity.beef.json

validator

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

{"type": "string"}

entity.beef.json

iValidator

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

{"type": "string"}

entity.beef.json

managerOperationType

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

{"type": "string", "enum": ["Create", "Read", "Update", "Delete", "Unspecified"]}