schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
sarif-external-property-file-2.1.0-rtm.2.json | graphs | An array of graph objects that will merged with an external run. | {"type": "array", "minItems": 0, "default": [], "uniqueItems": true, "items": {}} |
sarif-external-property-file-2.1.0-rtm.2.json | externalizedProperties | Key/value pairs that provide additional information that will be merged with an external run. | {} |
sarif-external-property-file-2.1.0-rtm.2.json | artifacts | An array of artifact objects that will be merged with an external run. | {"type": "array", "minItems": 0, "uniqueItems": true, "items": {}} |
sarif-external-property-file-2.1.0-rtm.2.json | invocations | Describes the invocation of the analysis tool that will be merged with an external run. | {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}} |
sarif-external-property-file-2.1.0-rtm.2.json | logicalLocations | An array of logical locations such as namespaces, types or functions that will be merged with an external run. | {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}} |
sarif-external-property-file-2.1.0-rtm.2.json | threadFlowLocations | An array of threadFlowLocation objects that will be merged with an external run. | {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}} |
sarif-external-property-file-2.1.0-rtm.2.json | results | An array of result objects that will be merged with an external run. | {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}} |
sarif-external-property-file-2.1.0-rtm.2.json | taxonomies | Tool taxonomies that will be merged with an external run. | {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}} |
sarif-external-property-file-2.1.0-rtm.2.json | driver | The analysis tool object that will be merged with an external run. | {} |
sarif-external-property-file-2.1.0-rtm.2.json | extensions | Tool extensions that will be merged with an external run. | {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}} |
sarif-external-property-file-2.1.0-rtm.2.json | policies | Tool policies that will be merged with an external run. | {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}} |
sarif-external-property-file-2.1.0-rtm.2.json | translations | Tool translations that will be merged with an external run. | {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}} |
sarif-external-property-file-2.1.0-rtm.2.json | addresses | Addresses that will be merged with with an external run. | {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}} |
sarif-external-property-file-2.1.0-rtm.2.json | webRequests | Requests that will be merged with an external run. | {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}} |
sarif-external-property-file-2.1.0-rtm.2.json | webResponses | Responses that will be merged with an external run. | {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}} |
sarif-external-property-file-2.1.0-rtm.2.json | properties | Key/value pairs that provide additional information about the external properties. | {} |
entity.beef-5.json | CodeGeneration | The 'CodeGeneration' object defines global properties that are used to drive the underlying entity-driven code generation. | {"type": "object", "properties": {"withResult": {"type": "boolean"}, "preprocessorDirectives": {"type": "boolean"}, "refDataNamespace": {"type": "string"}, "refDataCommonNamespace": {"type": "string"}, "refDataText": {"type": "boolean"}, "refDataWebApiRoute": {"type": "string"}, "refDataDataCtorParams": {"type": "array", "items": {"type": "string"}}, "jsonSerializer": {"type": "string", "enum": ["SystemText", "Newtonsoft"]}, "etagJsonName": {"type": "string", "enum": ["etag", "eTag", "_etag", "_eTag", "ETag", "ETAG"]}, "usingNamespace1": {"type": "string"}, "usingNamespace2": {"type": "string"}, "usingNamespace3": {"type": "string"}, "webApiAuthorize": {"type": "string"}, "webApiAutoLocation": {"type": "boolean"}, "webApiRoutePrefix": {"type": "string"}, "managerCleanUp": {"type": "boolean"}, "validationFramework": {"type": "string", "enum": ["CoreEx", "FluentValidation"]}, "databaseName": {"type": "string"}, "databaseSchema": {"type": "string"}, "databaseProvider": {"type": "string", "enum": ["SqlServer", "MySQL"]}, "entityFrameworkName": {"type": "string"}, "cosmosName": {"type": "string"}, "odataName": {"type": "string"}, "httpAgentName": {"type": "string"}, "etagDefaultMapperConverter": {"type": "string"}, "refDataDefaultMapperConverter": {"type": "string", "enum": ["ReferenceDataCodeConverter", "ReferenceDataCodeConverter{T}", "ReferenceDataCodeConverter<T>", "ReferenceDataIdConverter{T, int}", "ReferenceDataIdConverter<T, int>", "ReferenceDataIdConverter{T, int?}", "ReferenceDataIdConverter<T, int?>", "ReferenceDataIdConverter{T, long}", "ReferenceDataIdConverter<T, long>", "ReferenceDataIdConverter{T, long?}", "ReferenceDataIdConverter<T, long?>", "ReferenceDataIdConverter{T, Guid}", "ReferenceDataIdConverter<T, Guid>", "ReferenceDataIdConverter{T, Guid?}", "ReferenceDataIdConverter<T, Guid?>", "ReferenceDataInt32IdConverter", "ReferenceDataInt32IdConverter{T}", "ReferenceDataInt32IdConverter<T>", "ReferenceDataNullableInt32IdConverter", "ReferenceDataNullableInt32IdConverter{T}", "ReferenceDataNullableInt32IdConverter<T>", "ReferenceDataInt64IdConverter", "ReferenceDataInt64IdConverter{T}", "ReferenceDataInt64IdConverter<T>", "ReferenceDataNullableInt64IdConverter", "ReferenceDataNullableInt64IdConverter{T}", "ReferenceDataNullableInt64IdConverter<T>", "ReferenceDataGuidIdConverter", "ReferenceDataGuidIdConverter{T}", "ReferenceDataGuidIdConverter<T>", "ReferenceDataNullableGuidIdConverter", "ReferenceDataNullableGuidIdConverter{T}", "ReferenceDataNullableGuidIdConverter<T>"]}, "refDataCodeDataName": {"type": "string"}, "refDataTextDataName": {"type": "string"}, "refDataIsActiveDataName": {"type": "string"}, "refDataSortOrderDataName": {"type": "string"}, "refDataETagDataName": {"type": "string"}, "eventPublish": {"type": "string", "enum": ["None", "DataSvc", "Data"]}, "eventSourceRoot": {"type": "string"}, "eventSourceKind": {"type": "string", "enum": ["None", "Absolute", "Relative", "RelativeOrAbsolute"]}, "eventSubjectRoot": {"type": "string"}, "eventSubjectSeparator": {"type": "string"}, "eventActionFormat": {"type": "string", "enum": ["None", "PastTense"]}, "eventTransaction": {"type": "boolean"}, "grpc": {"type": "boolean"}, "pathBase": {"type": "string"}, "pathCommon": {"type": "string"}, "pathBusiness": {"type": "string"}, "pathApi": {"type": "string"}, "namespaceBase": {"type": "string"}, "namespaceCommon": {"type": "string"}, "namespaceBusiness": {"type": "string"}, "namespaceApi": {"type": "string"}, "entities": {"type": "array", "items": {}}}} |
entity.beef-5.json | withResult | Defaults to 'true'. This can be overridden within the 'Entity'(s) and/or 'Operation'(s). | {"type": "boolean"} |
entity.beef-5.json | refDataNamespace | Defaults to 'Company' + '.' (literal) + AppName + '.Business.Entities' (literal). | {"type": "string"} |
entity.beef-5.json | refDataCommonNamespace | Defaults to 'Company' + '.' (literal) + AppName + '.Common.Entities' (literal). | {"type": "string"} |
entity.beef-5.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'). This can be further configured on the 'Entity' and for each 'Property'. | {"type": "boolean"} |
entity.beef-5.json | refDataDataCtorParams | 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-5.json | jsonSerializer | Defaults to 'SystemText'. This can be overridden within the 'Entity'(s). | {"type": "string", "enum": ["SystemText", "Newtonsoft"]} |
entity.beef-5.json | etagJsonName | Defaults to 'etag'. Note that the 'JsonName' can be set individually per property where required. | {"type": "string", "enum": ["etag", "eTag", "_etag", "_eTag", "ETag", "ETAG"]} |
entity.beef-5.json | usingNamespace1 | Typically used where referening a 'Type' from a Namespace that is not generated by default. | {"type": "string"} |
entity.beef-5.json | usingNamespace2 | Typically used where referening a 'Type' from a Namespace that is not generated by default. | {"type": "string"} |
entity.beef-5.json | usingNamespace3 | Typically used where referening a 'Type' from a Namespace that is not generated by default. | {"type": "string"} |
entity.beef-5.json | webApiAuthorize | This can be overridden within the 'Entity'(s) and/or their corresponding 'Operation'(s). | {"type": "string"} |
entity.beef-5.json | webApiAutoLocation | 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). | {"type": "boolean"} |
entity.beef-5.json | webApiRoutePrefix | This is the base (prefix) 'URI' prepended to all entity and underlying 'Operation'(s). | {"type": "string"} |
entity.beef-5.json | managerCleanUp | This can be overridden within the 'Entity'(s) and 'Operation'(s). | {"type": "boolean"} |
entity.beef-5.json | validationFramework | Defaults to 'CoreEx' (literal). This can be overridden within the 'Entity'(s), 'Operation'(s) and 'Parameter'(s). | {"type": "string", "enum": ["CoreEx", "FluentValidation"]} |
entity.beef-5.json | databaseName | Defaults to 'IDatabase'. This can be overridden within the 'Entity'(s). | {"type": "string"} |
entity.beef-5.json | databaseSchema | Defaults to 'dbo'. | {"type": "string"} |
entity.beef-5.json | databaseProvider | Defaults to 'SqlServer'. Enables specific database provider functionality/formatting/etc. where applicable. | {"type": "string", "enum": ["SqlServer", "MySQL"]} |
entity.beef-5.json | entityFrameworkName | Defaults to 'IEfDb'. This can be overridden within the 'Entity'(s). | {"type": "string"} |
entity.beef-5.json | cosmosName | Defaults to 'ICosmosDb'. This can be overridden within the 'Entity'(s). | {"type": "string"} |
entity.beef-5.json | odataName | Defaults to 'IOData'. This can be overridden within the 'Entity'(s). | {"type": "string"} |
entity.beef-5.json | httpAgentName | Defaults to 'IHttpAgent'. This can be overridden within the 'Entity'(s). | {"type": "string"} |
entity.beef-5.json | etagDefaultMapperConverter | Defaults to 'StringToBase64Converter'. | {"type": "string"} |
entity.beef-5.json | refDataDefaultMapperConverter | Defaults to 'ReferenceDataCodeConverter<T>'. Where this value is suffixed by '<T>' or '{T}' this will automatically be set to the 'Type'. | {"type": "string", "enum": ["ReferenceDataCodeConverter", "ReferenceDataCodeConverter{T}", "ReferenceDataCodeConverter<T>", "ReferenceDataIdConverter{T, int}", "ReferenceDataIdConverter<T, int>", "ReferenceDataIdConverter{T, int?}", "ReferenceDataIdConverter<T, int?>", "ReferenceDataIdConverter{T, long}", "ReferenceDataIdConverter<T, long>", "ReferenceDataIdConverter{T, long?}", "ReferenceDataIdConverter<T, long?>", "ReferenceDataIdConverter{T, Guid}", "ReferenceDataIdConverter<T, Guid>", "ReferenceDataIdConverter{T, Guid?}", "ReferenceDataIdConverter<T, Guid?>", "ReferenceDataInt32IdConverter", "ReferenceDataInt32IdConverter{T}", "ReferenceDataInt32IdConverter<T>", "ReferenceDataNullableInt32IdConverter", "ReferenceDataNullableInt32IdConverter{T}", "ReferenceDataNullableInt32IdConverter<T>", "ReferenceDataInt64IdConverter", "ReferenceDataInt64IdConverter{T}", "ReferenceDataInt64IdConverter<T>", "ReferenceDataNullableInt64IdConverter", "ReferenceDataNullableInt64IdConverter{T}", "ReferenceDataNullableInt64IdConverter<T>", "ReferenceDataGuidIdConverter", "ReferenceDataGuidIdConverter{T}", "ReferenceDataGuidIdConverter<T>", "ReferenceDataNullableGuidIdConverter", "ReferenceDataNullableGuidIdConverter{T}", "ReferenceDataNullableGuidIdConverter<T>"]} |
entity.beef-5.json | refDataCodeDataName | Defaults to 'Code' (literal). | {"type": "string"} |
entity.beef-5.json | refDataTextDataName | Defaults to 'Text' (literal). | {"type": "string"} |
entity.beef-5.json | refDataIsActiveDataName | Defaults to 'IsActive' (literal). | {"type": "string"} |
entity.beef-5.json | refDataSortOrderDataName | Defaults to 'SortOrder' (literal). | {"type": "string"} |
entity.beef-5.json | refDataETagDataName | Defaults to 'RowVersion' (literal). | {"type": "string"} |
entity.beef-5.json | eventPublish | 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). | {"type": "string", "enum": ["None", "DataSvc", "Data"]} |
entity.beef-5.json | eventSourceRoot | The event source is only updated where an 'EventSourceKind' is not 'None'. This can be extended within the 'Entity'(s). | {"type": "string"} |
entity.beef-5.json | eventSourceKind | Defaults to 'None' (being the event source is not updated). | {"type": "string", "enum": ["None", "Absolute", "Relative", "RelativeOrAbsolute"]} |
entity.beef-5.json | eventSubjectRoot | Used to enable the sending of messages to the likes of EventHub, ServiceBus, SignalR, etc. This can be overridden within the 'Entity'(s). | {"type": "string"} |
entity.beef-5.json | eventSubjectSeparator | Defaults to '.'. Used only where the subject is automatically inferred. | {"type": "string"} |
entity.beef-5.json | eventActionFormat | Defaults to 'None' (no formatting required, i.e. as-is)'. | {"type": "string", "enum": ["None", "PastTense"]} |
entity.beef-5.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 '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. | {"type": "boolean"} |
entity.beef-5.json | grpc | 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. | {"type": "boolean"} |
entity.beef-5.json | pathBase | Defaults to 'Company' (runtime parameter) + '.' + 'AppName' (runtime parameter). For example 'Beef.Demo'. | {"type": "string"} |
entity.beef-5.json | pathCommon | Defaults to 'PathBase' + '.Common' (literal). For example 'Beef.Demo.Common'. | {"type": "string"} |
entity.beef-5.json | pathBusiness | Defaults to 'PathBase' + '.Business' (literal). For example 'Beef.Demo.Business'. | {"type": "string"} |
entity.beef-5.json | pathApi | Defaults to 'PathBase' + '.' + 'ApiName' (runtime parameter). For example 'Beef.Demo.Api'. | {"type": "string"} |
entity.beef-5.json | namespaceBase | Defaults to 'Company' (runtime parameter) + '.' + 'AppName' (runtime parameter). For example 'Beef.Demo'. | {"type": "string"} |
entity.beef-5.json | namespaceCommon | Defaults to 'NamespaceBase' + '.Common' (literal). For example 'Beef.Demo.Common'. | {"type": "string"} |
entity.beef-5.json | namespaceBusiness | Defaults to 'NamespaceBase' + '.Business' (literal). For example 'Beef.Demo.Business'. | {"type": "string"} |
entity.beef-5.json | namespaceApi | Defaults to 'NamespaceBase' + '.' + 'ApiName' (runtime parameter). For example 'Beef.Demo.Api'. | {"type": "string"} |
entity.beef-5.json | Entity | The 'Entity' is used as the primary configuration for driving the entity-driven code generation. | {"type": "object", "properties": {"name": {"type": "string"}, "text": {"type": "string"}, "fileName": {"type": "string"}, "privateName": {"type": "string"}, "argumentName": {"type": "string"}, "constType": {"type": "string", "enum": ["int", "long", "Guid", "string"]}, "isInitialOverride": {"type": "boolean"}, "withResult": {"type": "boolean"}, "refDataType": {"type": "string", "enum": ["int", "long", "Guid", "string"]}, "refDataText": {"type": "boolean"}, "refDataSortOrder": {"type": "string", "enum": ["SortOrder", "Id", "Code", "Text"]}, "inherits": {"type": "string"}, "implements": {"type": "string"}, "implementsAutoInfer": {"type": "boolean"}, "abstract": {"type": "boolean"}, "genericWithT": {"type": "boolean"}, "namespace": {"type": "string"}, "omitEntityBase": {"type": "boolean"}, "jsonSerializer": {"type": "string", "enum": ["SystemText", "Newtonsoft"]}, "internalOnly": {"type": "boolean"}, "collection": {"type": "boolean"}, "collectionResult": {"type": "boolean"}, "collectionType": {"type": "string", "enum": ["Standard", "Keyed", "Dictionary"]}, "collectionInherits": {"type": "string"}, "collectionResultInherits": {"type": "string"}, "get": {"type": "boolean"}, "getAll": {"type": "boolean"}, "create": {"type": "boolean"}, "update": {"type": "boolean"}, "patch": {"type": "boolean"}, "delete": {"type": "boolean"}, "autoImplement": {"type": "string", "enum": ["Database", "EntityFramework", "Cosmos", "OData", "HttpAgent", "None"]}, "dataCtor": {"type": "string", "enum": ["Public", "Private", "Protected"]}, "dataCtorParams": {"type": "array", "items": {"type": "string"}}, "dataExtensions": {"type": "boolean"}, "refDataIdDataName": {"type": "string"}, "refDataCodeDataName": {"type": "string"}, "refDataTextDataName": {"type": "string"}, "refDataIsActiveDataName": {"type": "string"}, "refDataSortOrderDataName": {"type": "string"}, "refDataETagDataName": {"type": "string"}, "refDataStoredProcedureName": {"type": "string"}, "databaseName": {"type": "string"}, "databaseSchema": {"type": "string"}, "databaseMapperInheritsFrom": {"type": "string"}, "databaseCustomerMapper": {"type": "boolean"}, "entityFrameworkName": {"type": "string"}, "entityFrameworkModel": {"type": "string"}, "entityFrameworkCustomMapper": {"type": "boolean"}, "entityFrameworkMapperBase": {"type": "string"}, "cosmosName": {"type": "string"}, "cosmosModel": {"type": "string"}, "cosmosContainerId": {"type": "string"}, "cosmosPartitionKey": {"type": "string"}, "cosmosValueContainer": {"type": "boolean"}, "cosmosCustomMapper": {"type": "boolean"}, "cosmosMapperBase": {"type": "string"}, "odataName": {"type": "string"}, "odataModel": {"type": "string"}, "odataCollectionName": {"type": "string"}, "odataCustomMapper": {"type": "boolean"}, "httpAgentName": {"type": "string"}, "httpAgentRoutePrefix": {"type": "string"}, "httpAgentModel": {"type": "string"}, "httpAgentReturnModel": {"type": "string"}, "httpAgentCode": {"type": "string"}, "httpAgentMapperBase": {"type": "string"}, "dataSvcCaching": {"type": "boolean"}, "dataSvcCtor": {"type": "string", "enum": ["Public", "Private", "Protected"]}, "dataSvcCtorParams": {"type": "array", "items": {"type": "string"}}, "dataSvcExtensions": {"type": "boolean"}, "eventPublish": {"type": "string", "enum": ["None", "DataSvc", "Data"]}, "eventSource": {"type": "string"}, "eventTransaction": {"type": "boolean"}, "managerCtor": {"type": "string", "enum": ["Public", "Private", "Protected"]}, "managerCtorParams": {"type": "array", "items": {"type": "string"}}, "managerExtensions": {"type": "boolean"}, "validator": {"type": "string"}, "identifierGenerator": {"type": "boolean"}, "managerCleanUp": {"type": "boolean"}, "validationFramework": {"type": "string", "enum": ["CoreEx", "FluentValidation"]}, "webApiRoutePrefix": {"type": "string"}, "webApiAuthorize": {"type": "string"}, "webApiCtor": {"type": "string", "enum": ["Public", "Private", "Protected"]}, "webApiCtorParams": {"type": "array", "items": {"type": "string"}}, "webApiAutoLocation": {"type": "boolean"}, "webApiConcurrency": {"type": "boolean"}, "webApiGetOperation": {"type": "string"}, "dataModel": {"type": "boolean"}, "excludeEntity": {"type": "boolean"}, "excludeAll": {"type": "boolean"}, "excludeIData": {"type": "boolean"}, "excludeData": {"type": "string", "enum": ["Include", "Exclude", "RequiresMapper"]}, "excludeIDataSvc": {"type": "boolean"}, "excludeDataSvc": {"type": "boolean"}, "excludeIManager": {"type": "boolean"}, "excludeManager": {"type": "boolean"}, "excludeWebApi": {"type": "boolean"}, "excludeWebApiAgent": {"type": "boolean"}, "excludeGrpcAgent": {"type": "boolean"}, "authRole": {"type": "string"}, "grpc": {"type": "boolean"}, "properties": {"type": "array", "items": {}}, "operations": {"type": "array", "items": {}}, "consts": {"type": "array", "items": {}}}, "required": ["name"]} |
entity.beef-5.json | text | 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}}). | {"type": "string"} |
entity.beef-5.json | fileName | Overrides the Name as the code-generated file name. | {"type": "string"} |
entity.beef-5.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-5.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-5.json | constType | The .NET Type to be used for the 'const' values. Defaults to 'string'. | {"type": "string", "enum": ["int", "long", "Guid", "string"]} |
entity.beef-5.json | isInitialOverride | Set to either 'true' or 'false' to override as specified; otherwise, 'null' to check each property. Defaults to 'null'. | {"type": "boolean"} |
entity.beef-5.json | withResult | Defaults to 'CodeGeneration.WithResult'. This can be overridden within the Operation'(s). | {"type": "boolean"} |
entity.beef-5.json | refDataType | Required to identify an entity as being Reference Data. Specifies the underlying .NET Type used for the Reference Data identifier. | {"type": "string", "enum": ["int", "long", "Guid", "string"]} |
entity.beef-5.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'). Defaults from 'CodeGeneration.RefDataText'. | {"type": "boolean"} |
entity.beef-5.json | refDataSortOrder | Specifies the default sort order for the underlying Reference Data collection. Defaults to 'SortOrder'. | {"type": "string", "enum": ["SortOrder", "Id", "Code", "Text"]} |
entity.beef-5.json | inherits | 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. | {"type": "string"} |
entity.beef-5.json | implementsAutoInfer | Will attempt to infer the following: 'IIdentifier<Guid>', 'IIdentifier<int>', 'IIdentifier<long>', 'IIdentifier<string>', 'IETag' and 'IChangeLog'. Defaults to 'true'. | {"type": "boolean"} |
entity.beef-5.json | namespace | Appended to the end of the standard structure as follows: '{Company}.{AppName}.Business.Entities.{Namespace}'. | {"type": "string"} |
entity.beef-5.json | omitEntityBase | 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. | {"type": "boolean"} |
entity.beef-5.json | jsonSerializer | Defaults to the 'CodeGeneration.JsonSerializer' configuration property where specified; otherwise, 'SystemText'. | {"type": "string", "enum": ["SystemText", "Newtonsoft"]} |
entity.beef-5.json | collectionResult | Enables the likes of additional paging state to be stored with the underlying collection. | {"type": "boolean"} |
entity.beef-5.json | collectionInherits | Defaults to 'EntityBaseCollection' or 'EntityBaseKeyedCollection' depending on 'CollectionKeyed'. For Reference Data it will default to 'ReferenceDataCollectionBase'. | {"type": "string"} |
entity.beef-5.json | collectionResultInherits | Defaults to 'EntityCollectionResult'. | {"type": "string"} |
entity.beef-5.json | autoImplement | Defaults to 'None'. Indicates that the implementation for the underlying 'Operations' will be auto-implemented using the selected data source (unless explicity overridden). When selected some of the related attributes will also be required (as documented). Additionally, the 'AutoImplement' indicator must be selected for each underlying 'Operation' that is to be auto-implemented. | {"type": "string", "enum": ["Database", "EntityFramework", "Cosmos", "OData", "HttpAgent", "None"]} |
entity.beef-5.json | dataCtor | Defaults to 'Public'. | {"type": "string", "enum": ["Public", "Private", "Protected"]} |
entity.beef-5.json | dataCtorParams | 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-5.json | dataExtensions | This can be overridden using 'Operation.DataExtensions'. | {"type": "boolean"} |
entity.beef-5.json | refDataIdDataName | Defaults to 'Name' + 'Id' (literal). | {"type": "string"} |
entity.beef-5.json | refDataCodeDataName | Defaults to 'Code' (literal). | {"type": "string"} |
entity.beef-5.json | refDataTextDataName | Defaults to 'Text' (literal). | {"type": "string"} |
entity.beef-5.json | refDataIsActiveDataName | Defaults to 'IsActive' (literal). | {"type": "string"} |
entity.beef-5.json | refDataSortOrderDataName | Defaults to 'SortOrder' (literal). | {"type": "string"} |
entity.beef-5.json | refDataETagDataName | Defaults to 'RowVersion' (literal). | {"type": "string"} |
entity.beef-5.json | refDataStoredProcedureName | Defaults to 'sp' (literal) + 'Name' + 'GetAll' (literal). | {"type": "string"} |
entity.beef-5.json | databaseName | Defaults to the 'CodeGeneration.DatabaseName' configuration property (its default value is 'IDatabase'). | {"type": "string"} |
entity.beef-5.json | databaseSchema | Defaults to 'dbo'. | {"type": "string"} |
entity.beef-5.json | databaseCustomerMapper | Otherwise, by default, a 'Mapper' will be generated. | {"type": "boolean"} |
entity.beef-5.json | entityFrameworkName | Defaults to 'CodeGeneration.EntityFrameworkName'. | {"type": "string"} |
entity.beef-5.json | entityFrameworkCustomMapper | Otherwise, by default, a 'Mapper' will be generated. | {"type": "boolean"} |
entity.beef-5.json | cosmosName | Defaults to the 'CodeGeneration.CosmosName' configuration property (its default value is 'ICosmosDb'). | {"type": "string"} |
entity.beef-5.json | cosmosPartitionKey | The value 'PartitionKey.None' can be specified. Literals will need to be quoted. | {"type": "string"} |
entity.beef-5.json | cosmosCustomMapper | Otherwise, by default, a 'Mapper' will be generated. | {"type": "boolean"} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.