Datasets:
dataunitylab
/
json-schema-descriptions

Dataset card Data Studio Files Community
1
schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
fossa-yml.v3.schema.json
type
For pipenv targets (python)
{"const": "pipenv"}
fossa-yml.v3.schema.json
type
For poetry targets (python)
{"const": "poetry"}
fossa-yml.v3.schema.json
type
For setuptools targets (python)
{"const": "setuptools"}
fossa-yml.v3.schema.json
type
For perl targets (using *META.{json,yml})
{"const": "perl"}
fossa-yml.v3.schema.json
type
For pnpm targets (javascript)
{"const": "pnpm"}
fossa-yml.v3.schema.json
type
For pdm targets (python)
{"const": "pdm"}
fossa-yml.v3.schema.json
path
Associated path with target type (if any)
{"type": "string"}
fossa-yml.v3.schema.json
experimental
Experimental preferences with fossa cli.
{"type": "object", "properties": {"gradle": {"type": "object", "properties": {"configurations-only": {"type": "array", "items": {"type": "string"}, "minItems": 1, "uniqueItems": true}}}}}
fossa-yml.v3.schema.json
gradle
Gradle preferences for all targets
{"type": "object", "properties": {"configurations-only": {"type": "array", "items": {"type": "string"}, "minItems": 1, "uniqueItems": true}}}
fossa-yml.v3.schema.json
configurations-only
Configurations to only include in analysis (by default excludes any other configurations not listed)
{"type": "array", "items": {"type": "string"}, "minItems": 1, "uniqueItems": true}
fossa-yml.v3.schema.json
vendoredDependencies
the vendoredDependencies fields allow you to configure vendored dependency scans. Vendored dependency scans are described in https://github.com/fossas/fossa-cli/blob/master/docs/features/vendored-dependencies.md
{"type": "object", "properties": {"forceRescans": {"type": "boolean"}, "scanMethod": {"type": "string", "oneOf": [{"const": "ArchiveUpload"}, {"const": "CLILicenseScan"}]}, "licenseScanPathFilters": {"type": "object", "properties": {"only": {"type": "array", "items": {"type": "string"}}, "exclude": {"type": "array", "items": {"type": "string"}}}}}}
fossa-yml.v3.schema.json
forceRescans
If true, forces a re-scan of all vendored dependencies on every run. If false or not present, then we do not re-scan vendored dependencies that have been previously scanned. A vendored dependency has been previously scanned if a dependency with the same name and version has already been scanned by your organization. If no version is provided, then any change in the files being scanned will result in a rescan.
{"type": "boolean"}
fossa-yml.v3.schema.json
scanMethod
Vendored dependencies are scanned by the "Archive Upload" method, as described in https://github.com/fossas/fossa-cli/blob/master/docs/features/vendored-dependencies.md
{"const": "ArchiveUpload"}
fossa-yml.v3.schema.json
scanMethod
Vendored dependencies are scanned by the "CLI-side license scan" method, as described in https://github.com/fossas/fossa-cli/blob/master/docs/features/vendored-dependencies.md
{"const": "CLILicenseScan"}
fossa-yml.v3.schema.json
licenseScanPathFilters
licenseScanPathFilters allows you to filter which files are scanned when doing a CLILicenseScan. This setting does not apply if you use the ArchiveUpload method of scanning vendoredDependencies.
{"type": "object", "properties": {"only": {"type": "array", "items": {"type": "string"}}, "exclude": {"type": "array", "items": {"type": "string"}}}}
fossa-yml.v3.schema.json
only
A list of globs that will be used to filter paths. If there are any entries in the `only` list, then only paths that match one or more of the globs in the `only` list will be scanned for licenses.
{"type": "array", "items": {"type": "string"}}
fossa-yml.v3.schema.json
exclude
A list of globs that will be used to filter paths. If there are any entries in the `exclude` list, then paths that match any of the `exclude` entries will not be scanned for licenses.
{"type": "array", "items": {"type": "string"}}
fossa-yml.v3.schema.json
version
Specifies the version of configuration file. Versions 1 and 2 were used by CLI versions up until CLI 2.0.0 and are no longer supported. CLI 2.x and greater only supports version 3.
{"type": "integer", "const": 3}
fossa-yml.v3.schema.json
server
Sets the endpoint that the CLI will send requests to. This field should only be modified if your FOSSA account lives on a different server than app.fossa.com. This is most commonly needed with on-premise instances of FOSSA.
{"type": "string", "minLength": 1}
fossa-yml.v3.schema.json
apiKey
Sets the https://docs.fossa.com/docs/api-reference#api-tokens that is required for accessing the FOSSA API and uploading data (e.g. `fossa analyze`) or retrieving information (e.g. `fossa test`) about a project.
{"type": "string", "minLength": 1}
fossa-yml.v3.schema.json
targets
The targets filtering allows you to specify the exact targets which be should be scanned.
{"type": "object", "properties": {"only": {"type": "array", "items": {}}, "exclude": {"type": "array", "items": {}}}}
fossa-yml.v3.schema.json
only
The list of `only` targets that should be scanned.
{"type": "array", "items": {}}
fossa-yml.v3.schema.json
exclude
The list of `exclude` targets which should be excluded from scanning. The targets listed in the exclude section will override the targets listed in the only sections. This feature is used most effectively to remove specific targets from a directory.
{"type": "array", "items": {}}
fossa-yml.v3.schema.json
paths
The paths filtering section allows you to specify which paths should be scanned and which should not. The paths should be listed as their location from the root of your project.
{"type": "object", "properties": {"only": {"type": "array", "items": {"type": "string"}}, "exclude": {"type": "array", "items": {"type": "string"}}}}
fossa-yml.v3.schema.json
only
The list of paths to only allow scanning within.
{"type": "array", "items": {"type": "string"}}
fossa-yml.v3.schema.json
exclude
The list of paths to exclude from scanning in your directory.
{"type": "array", "items": {"type": "string"}}
compose-spec.json
The Compose file is a YAML file defining a multi-containers based application.
{"$schema": "https://json-schema.org/draft/2019-09/schema#", "id": "compose_spec.json", "type": "object", "properties": {"version": {"type": "string"}, "name": {"type": "string", "pattern": "^[a-z0-9][a-z0-9_-]*$"}, "include": {"type": "array", "items": {"type": "object"}}, "services": {"id": "#/properties/services", "type": "object", "patternProperties": {"^[a-zA-Z0-9._-]+$": {}}, "additionalProperties": false}, "networks": {"id": "#/properties/networks", "type": "object", "patternProperties": {"^[a-zA-Z0-9._-]+$": {}}}, "volumes": {"id": "#/properties/volumes", "type": "object", "patternProperties": {"^[a-zA-Z0-9._-]+$": {}}, "additionalProperties": false}, "secrets": {"id": "#/properties/secrets", "type": "object", "patternProperties": {"^[a-zA-Z0-9._-]+$": {}}, "additionalProperties": false}, "configs": {"id": "#/properties/configs", "type": "object", "patternProperties": {"^[a-zA-Z0-9._-]+$": {}}, "additionalProperties": false}}, "patternProperties": {"^x-": {}}, "additionalProperties": false, "definitions": {"service": {"id": "#/definitions/service", "type": "object", "properties": {"deploy": {}, "annotations": {}, "attach": {"type": "boolean"}, "build": {"oneOf": [{"type": "string"}, {"type": "object", "properties": {"context": {"type": "string"}, "dockerfile": {"type": "string"}, "dockerfile_inline": {"type": "string"}, "args": {}, "ssh": {}, "labels": {}, "cache_from": {"type": "array", "items": {"type": "string"}}, "cache_to": {"type": "array", "items": {"type": "string"}}, "no_cache": {"type": "boolean"}, "additional_contexts": {}, "network": {"type": "string"}, "pull": {"type": "boolean"}, "target": {"type": "string"}, "shm_size": {"type": ["integer", "string"]}, "extra_hosts": {}, "isolation": {"type": "string"}, "privileged": {"type": "boolean"}, "secrets": {}, "tags": {"type": "array", "items": {"type": "string"}}, "platforms": {"type": "array", "items": {"type": "string"}}}, "additionalProperties": false, "patternProperties": {"^x-": {}}}]}, "blkio_config": {"type": "object", "properties": {"device_read_bps": {"type": "array", "items": {}}, "device_read_iops": {"type": "array", "items": {}}, "device_write_bps": {"type": "array", "items": {}}, "device_write_iops": {"type": "array", "items": {}}, "weight": {"type": "integer"}, "weight_device": {"type": "array", "items": {}}}, "additionalProperties": false}, "cap_add": {"type": "array", "items": {"type": "string"}, "uniqueItems": true}, "cap_drop": {"type": "array", "items": {"type": "string"}, "uniqueItems": true}, "cgroup": {"type": "string", "enum": ["host", "private"]}, "cgroup_parent": {"type": "string"}, "command": {}, "configs": {}, "container_name": {"type": "string"}, "cpu_count": {"type": "integer", "minimum": 0}, "cpu_percent": {"type": "integer", "minimum": 0, "maximum": 100}, "cpu_shares": {"type": ["number", "string"]}, "cpu_quota": {"type": ["number", "string"]}, "cpu_period": {"type": ["number", "string"]}, "cpu_rt_period": {"type": ["number", "string"]}, "cpu_rt_runtime": {"type": ["number", "string"]}, "cpus": {"type": ["number", "string"]}, "cpuset": {"type": "string"}, "credential_spec": {"type": "object", "properties": {"config": {"type": "string"}, "file": {"type": "string"}, "registry": {"type": "string"}}, "additionalProperties": false, "patternProperties": {"^x-": {}}}, "depends_on": {"oneOf": [{}, {"type": "object", "additionalProperties": false, "patternProperties": {"^[a-zA-Z0-9._-]+$": {"type": "object", "additionalProperties": false, "properties": {"restart": {"type": "boolean"}, "required": {"type": "boolean", "default": true}, "condition": {"type": "string", "enum": ["service_started", "service_healthy", "service_completed_successfully"]}}, "required": ["condition"]}}}]}, "device_cgroup_rules": {}, "devices": {"type": "array", "items": {"type": "string"}, "uniqueItems": true}, "dns": {}, "dns_opt": {"type": "array", "items": {"type": "string"}, "uniqueItems": true}, "dns_search": {}, "domainname": {"type": "string"}, "entrypoint": {}, "env_file": {}, "environment": {}, "expose": {"type": "array", "items": {"type": ["string", "number"], "format": "expose"}, "uniqueItems": true}, "extends": {"oneOf": [{"type": "string"}, {"type": "object", "properties": {"service": {"type": "string"}, "file": {"type": "string"}}, "required": ["service"], "additionalProperties": false}]}, "external_links": {"type": "array", "items": {"type": "string"}, "uniqueItems": true}, "extra_hosts": {}, "group_add": {"type": "array", "items": {"type": ["string", "number"]}, "uniqueItems": true}, "healthcheck": {}, "hostname": {"type": "string"}, "image": {"type": "string"}, "init": {"type": "boolean"}, "ipc": {"type": "string"}, "isolation": {"type": "string"}, "labels": {}, "links": {"type": "array", "items": {"type": "string"}, "uniqueItems": true}, "logging": {"type": "object", "properties": {"driver": {"type": "string"}, "options": {"type": "object", "patternProperties": {"^.+$": {"type": ["string", "number", "null"]}}}}, "additionalProperties": false, "patternProperties": {"^x-": {}}}, "mac_address": {"type": "string"}, "mem_limit": {"type": ["number", "string"]}, "mem_reservation": {"type": ["string", "integer"]}, "mem_swappiness": {"type": "integer"}, "memswap_limit": {"type": ["number", "string"]}, "network_mode": {"type": "string"}, "networks": {"oneOf": [{}, {"type": "object", "patternProperties": {"^[a-zA-Z0-9._-]+$": {"oneOf": [{"type": "object", "properties": {"aliases": {}, "ipv4_address": {"type": "string"}, "ipv6_address": {"type": "string"}, "link_local_ips": {}, "priority": {"type": "number"}}, "additionalProperties": false, "patternProperties": {"^x-": {}}}, {"type": "null"}]}}, "additionalProperties": false}]}, "oom_kill_disable": {"type": "boolean"}, "oom_score_adj": {"type": "integer", "minimum": -1000, "maximum": 1000}, "pid": {"type": ["string", "null"]}, "pids_limit": {"type": ["number", "string"]}, "platform": {"type": "string"}, "ports": {"type": "array", "items": {"oneOf": [{"type": "number", "format": "ports"}, {"type": "string", "format": "ports"}, {"type": "object", "properties": {"mode": {"type": "string"}, "host_ip": {"type": "string"}, "target": {"type": "integer"}, "published": {"type": ["string", "integer"]}, "protocol": {"type": "string"}}, "additionalProperties": false, "patternProperties": {"^x-": {}}}]}, "uniqueItems": true}, "privileged": {"type": "boolean"}, "profiles": {}, "pull_policy": {"type": "string", "enum": ["always", "never", "if_not_present", "build", "missing"]}, "read_only": {"type": "boolean"}, "restart": {"type": "string"}, "runtime": {"type": "string"}, "scale": {"type": "integer"}, "security_opt": {"type": "array", "items": {"type": "string"}, "uniqueItems": true}, "shm_size": {"type": ["number", "string"]}, "secrets": {}, "sysctls": {}, "stdin_open": {"type": "boolean"}, "stop_grace_period": {"type": "string", "format": "duration"}, "stop_signal": {"type": "string"}, "storage_opt": {"type": "object"}, "tmpfs": {}, "tty": {"type": "boolean"}, "ulimits": {"type": "object", "patternProperties": {"^[a-z]+$": {"oneOf": [{"type": "integer"}, {"type": "object", "properties": {"hard": {"type": "integer"}, "soft": {"type": "integer"}}, "required": ["soft", "hard"], "additionalProperties": false, "patternProperties": {"^x-": {}}}]}}}, "user": {"type": "string"}, "uts": {"type": "string"}, "userns_mode": {"type": "string"}, "volumes": {"type": "array", "items": {"oneOf": [{"type": "string"}, {"type": "object", "required": ["type"], "properties": {"type": {"type": "string"}, "source": {"type": "string"}, "target": {"type": "string"}, "read_only": {"type": "boolean"}, "consistency": {"type": "string"}, "bind": {"type": "object", "properties": {"propagation": {"type": "string"}, "create_host_path": {"type": "boolean"}, "selinux": {"type": "string", "enum": ["z", "Z"]}}, "additionalProperties": false, "patternProperties": {"^x-": {}}}, "volume": {"type": "object", "properties": {"nocopy": {"type": "boolean"}}, "additionalProperties": false, "patternProperties": {"^x-": {}}}, "tmpfs": {"type": "object", "properties": {"size": {"oneOf": [{"type": "integer", "minimum": 0}, {"type": "string"}]}, "mode": {"type": "number"}}, "additionalProperties": false, "patternProperties": {"^x-": {}}}}, "additionalProperties": false, "patternProperties": {"^x-": {}}}]}, "uniqueItems": true}, "volumes_from": {"type": "array", "items": {"type": "string"}, "uniqueItems": true}, "working_dir": {"type": "string"}}, "patternProperties": {"^x-": {}}, "additionalProperties": false}, "healthcheck": {"id": "#/definitions/healthcheck", "type": "object", "properties": {"disable": {"type": "boolean"}, "interval": {"type": "string", "format": "duration"}, "retries": {"type": "number"}, "test": {"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}, "timeout": {"type": "string", "format": "duration"}, "start_period": {"type": "string", "format": "duration"}, "start_interval": {"type": "string", "format": "duration"}}, "additionalProperties": false, "patternProperties": {"^x-": {}}}, "deployment": {"id": "#/definitions/deployment", "type": ["object", "null"], "properties": {"mode": {"type": "string"}, "endpoint_mode": {"type": "string"}, "replicas": {"type": "integer"}, "labels": {}, "rollback_config": {"type": "object", "properties": {"parallelism": {"type": "integer"}, "delay": {"type": "string", "format": "duration"}, "failure_action": {"type": "string"}, "monitor": {"type": "string", "format": "duration"}, "max_failure_ratio": {"type": "number"}, "order": {"type": "string", "enum": ["start-first", "stop-first"]}}, "additionalProperties": false, "patternProperties": {"^x-": {}}}, "update_config": {"type": "object", "properties": {"parallelism": {"type": "integer"}, "delay": {"type": "string", "format": "duration"}, "failure_action": {"type": "string"}, "monitor": {"type": "string", "format": "duration"}, "max_failure_ratio": {"type": "number"}, "order": {"type": "string", "enum": ["start-first", "stop-first"]}}, "additionalProperties": false, "patternProperties": {"^x-": {}}}, "resources": {"type": "object", "properties": {"limits": {"type": "object", "properties": {"cpus": {"type": ["number", "string"]}, "memory": {"type": "string"}, "pids": {"type": "integer"}}, "additionalProperties": false, "patternProperties": {"^x-": {}}}, "reservations": {"type": "object", "properties": {"cpus": {"type": ["number", "string"]}, "memory": {"type": "string"}, "generic_resources": {}, "devices": {}}, "additionalProperties": false, "patternProperties": {"^x-": {}}}}, "additionalProperties": false, "patternProperties": {"^x-": {}}}, "restart_policy": {"type": "object", "properties": {"condition": {"type": "string"}, "delay": {"type": "string", "format": "duration"}, "max_attempts": {"type": "integer"}, "window": {"type": "string", "format": "duration"}}, "additionalProperties": false, "patternProperties": {"^x-": {}}}, "placement": {"type": "object", "properties": {"constraints": {"type": "array", "items": {"type": "string"}}, "preferences": {"type": "array", "items": {"type": "object", "properties": {"spread": {"type": "string"}}, "additionalProperties": false, "patternProperties": {"^x-": {}}}}, "max_replicas_per_node": {"type": "integer"}}, "additionalProperties": false, "patternProperties": {"^x-": {}}}}, "additionalProperties": false, "patternProperties": {"^x-": {}}}, "generic_resources": {"id": "#/definitions/generic_resources", "type": "array", "items": {"type": "object", "properties": {"discrete_resource_spec": {"type": "object", "properties": {"kind": {"type": "string"}, "value": {"type": "number"}}, "additionalProperties": false, "patternProperties": {"^x-": {}}}}, "additionalProperties": false, "patternProperties": {"^x-": {}}}}, "devices": {"id": "#/definitions/devices", "type": "array", "items": {"type": "object", "properties": {"capabilities": {}, "count": {"type": ["string", "integer"]}, "device_ids": {}, "driver": {"type": "string"}, "options": {}}, "additionalProperties": false, "patternProperties": {"^x-": {}}}}, "include": {"id": "#/definitions/include", "oneOf": [{"type": "string"}, {"type": "object", "properties": {"path": {}, "env_file": {}, "project_directory": {"type": "string"}}, "additionalProperties": false}]}, "network": {"id": "#/definitions/network", "type": ["object", "null"], "properties": {"name": {"type": "string"}, "driver": {"type": "string"}, "driver_opts": {"type": "object", "patternProperties": {"^.+$": {"type": ["string", "number"]}}}, "ipam": {"type": "object", "properties": {"driver": {"type": "string"}, "config": {"type": "array", "items": {"type": "object", "properties": {"subnet": {"type": "string", "format": "subnet_ip_address"}, "ip_range": {"type": "string"}, "gateway": {"type": "string"}, "aux_addresses": {"type": "object", "additionalProperties": false, "patternProperties": {"^.+$": {"type": "string"}}}}, "additionalProperties": false, "patternProperties": {"^x-": {}}}}, "options": {"type": "object", "additionalProperties": false, "patternProperties": {"^.+$": {"type": "string"}}}}, "additionalProperties": false, "patternProperties": {"^x-": {}}}, "external": {"type": ["boolean", "object"], "properties": {"name": {"deprecated": true, "type": "string"}}, "additionalProperties": false, "patternProperties": {"^x-": {}}}, "internal": {"type": "boolean"}, "enable_ipv6": {"type": "boolean"}, "attachable": {"type": "boolean"}, "labels": {}}, "additionalProperties": false, "patternProperties": {"^x-": {}}}, "volume": {"id": "#/definitions/volume", "type": ["object", "null"], "properties": {"name": {"type": "string"}, "driver": {"type": "string"}, "driver_opts": {"type": "object", "patternProperties": {"^.+$": {"type": ["string", "number"]}}}, "external": {"type": ["boolean", "object"], "properties": {"name": {"deprecated": true, "type": "string"}}, "additionalProperties": false, "patternProperties": {"^x-": {}}}, "labels": {}}, "additionalProperties": false, "patternProperties": {"^x-": {}}}, "secret": {"id": "#/definitions/secret", "type": "object", "properties": {"name": {"type": "string"}, "environment": {"type": "string"}, "file": {"type": "string"}, "external": {"type": ["boolean", "object"], "properties": {"name": {"type": "string"}}}, "labels": {}, "driver": {"type": "string"}, "driver_opts": {"type": "object", "patternProperties": {"^.+$": {"type": ["string", "number"]}}}, "template_driver": {"type": "string"}}, "additionalProperties": false, "patternProperties": {"^x-": {}}}, "config": {"id": "#/definitions/config", "type": "object", "properties": {"name": {"type": "string"}, "file": {"type": "string"}, "external": {"type": ["boolean", "object"], "properties": {"name": {"deprecated": true, "type": "string"}}}, "labels": {}, "template_driver": {"type": "string"}}, "additionalProperties": false, "patternProperties": {"^x-": {}}}, "command": {"oneOf": [{"type": "null"}, {"type": "string"}, {"type": "array", "items": {"type": "string"}}]}, "string_or_list": {"oneOf": [{"type": "string"}, {}]}, "list_of_strings": {"type": "array", "items": {"type": "string"}, "uniqueItems": true}, "list_or_dict": {"oneOf": [{"type": "object", "patternProperties": {".+": {"type": ["string", "number", "boolean", "null"]}}, "additionalProperties": false}, {"type": "array", "items": {"type": "string"}, "uniqueItems": true}]}, "blkio_limit": {"type": "object", "properties": {"path": {"type": "string"}, "rate": {"type": ["integer", "string"]}}, "additionalProperties": false}, "blkio_weight": {"type": "object", "properties": {"path": {"type": "string"}, "weight": {"type": "integer"}}, "additionalProperties": false}, "service_config_or_secret": {"type": "array", "items": {"oneOf": [{"type": "string"}, {"type": "object", "properties": {"source": {"type": "string"}, "target": {"type": "string"}, "uid": {"type": "string"}, "gid": {"type": "string"}, "mode": {"type": "number"}}, "additionalProperties": false, "patternProperties": {"^x-": {}}}]}}, "constraints": {"service": {"id": "#/definitions/constraints/service", "anyOf": [{"required": ["build"]}, {"required": ["image"]}], "properties": {"build": {"required": ["context"]}}}}}}
compose-spec.json
version
declared for backward compatibility, ignored.
{"type": "string"}
compose-spec.json
name
define the Compose project name, until user defines one explicitly.
{"type": "string", "pattern": "^[a-z0-9][a-z0-9_-]*$"}
compose-spec.json
include
compose sub-projects to be included.
{"type": "array", "items": {"type": "object"}}
entity.beef.json
CodeGeneration
The 'CodeGeneration' object defines global properties that are used to drive the underlying entity-driven code generation.
{"type": "object", "properties": {"refDataNamespace": {"type": "string"}, "refDataCommonNamespace": {"type": "string"}, "refDataText": {"type": "boolean"}, "refDataWebApiRoute": {"type": "string"}, "refDataCache": {"type": "string", "enum": ["ReferenceDataCache", "ReferenceDataMultiTenantCache"]}, "refDataAppendToNamespace": {"type": "string"}, "refDataBusNamespace": {"type": "string"}, "entityScope": {"type": "string", "enum": ["Common", "Business", "Autonomous"]}, "entityUsing": {"type": "string", "enum": ["Common", "Business", "All", "None"]}, "jsonSerializer": {"type": "string", "enum": ["None", "Newtonsoft"]}, "etagJsonName": {"type": "string", "enum": ["etag", "eTag", "_etag", "_eTag", "ETag", "ETAG"]}, "usingNamespace1": {"type": "string"}, "usingNamespace2": {"type": "string"}, "usingNamespace3": {"type": "string"}, "webApiAuthorize": {"type": "string"}, "appBasedAgentArgs": {"type": "boolean"}, "webApiAutoLocation": {"type": "boolean"}, "webApiRoutePrefix": {"type": "string"}, "validatorLayer": {"type": "string", "enum": ["Business", "Common"]}, "databaseName": {"type": "string"}, "databaseSchema": {"type": "string"}, "entityFrameworkName": {"type": "string"}, "cosmosName": {"type": "string"}, "odataName": {"type": "string"}, "httpAgentName": {"type": "string"}, "refDataDefaultMapperConverter": {"type": "string", "enum": ["ReferenceDataCodeConverter", "ReferenceDataCodeConverter{T}", "ReferenceDataCodeConverter<T>", "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>"]}, "dataUsingNamespace": {"type": "string"}, "databaseUsingNamespace": {"type": "string"}, "entityFrameworkUsingNamespace": {"type": "string"}, "cosmosUsingNamespace": {"type": "string"}, "odataUsingNamespace": {"type": "string"}, "eventPublish": {"type": "string", "enum": ["None", "DataSvc", "Data"]}, "eventOutbox": {"type": "string", "enum": ["None", "Database"]}, "eventSourceRoot": {"type": "string"}, "eventSourceKind": {"type": "string", "enum": ["None", "Absolute", "Relative", "RelativeOrAbsolute"]}, "eventSubjectRoot": {"type": "string"}, "eventSubjectFormat": {"type": "string", "enum": ["NameOnly", "NameAndKey"]}, "eventSubjectSeparator": {"type": "string"}, "eventActionFormat": {"type": "string", "enum": ["None", "PastTense"]}, "eventCasing": {"type": "string", "enum": ["None", "Lower", "Upper"]}, "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.json
refDataNamespace
Defaults to 'Company' + '.' (literal) + AppName + '.' (literal) + 'EntityUsing' + '.Entities' (literal).
{"type": "string"}
entity.beef.json
refDataCommonNamespace
Defaults to 'Company' + '.' (literal) + AppName + '.Common.Entities' (literal).
{"type": "string"}
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
refDataCache
Defaults to 'ReferenceDataCache'. A value of 'ReferenceDataCache' specifies a single-tenant cache; otherwise, 'ReferenceDataMultiTenantCache' for a multi-tenant cache leverageing the 'ExecutionContext.TenantId'.
{"type": "string", "enum": ["ReferenceDataCache", "ReferenceDataMultiTenantCache"]}
entity.beef.json
refDataAppendToNamespace
Defaults to 'null'; being nothing to append.
{"type": "string"}
entity.beef.json
entityScope
Defaults to 'Common' for backwards compatibility; 'Autonomous' is **recommended**. Determines where the entity is scoped/defined, being 'Common' or 'Business' (i.e. not externally visible). Additionally, there is the special case of 'Autonomous' where both a 'Common' and 'Business' entity are generated (where only the latter inherits from 'EntityBase', etc).
{"type": "string", "enum": ["Common", "Business", "Autonomous"]}
entity.beef.json
entityUsing
Defaults to 'Common' (unless 'EntityScope' is 'Autonomous' and then it will default to 'Business') which will add '.Common.Entities'. Additionally, 'Business' to add '.Business.Entities', 'All' to add both, and 'None' to exclude any. This can be overridden for each 'Entity'.
{"type": "string", "enum": ["Common", "Business", "All", "None"]}
entity.beef.json
jsonSerializer
Defaults to 'Newtonsoft'. This can be overridden within the 'Entity'(s).
{"type": "string", "enum": ["None", "Newtonsoft"]}
entity.beef.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.json
usingNamespace1
Typically used where referening a 'Type' from a Namespace that is not generated by default.
{"type": "string"}
entity.beef.json
usingNamespace2
Typically used where referening a 'Type' from a Namespace that is not generated by default.
{"type": "string"}
entity.beef.json
usingNamespace3
Typically used where referening a 'Type' from a Namespace that is not generated by default.
{"type": "string"}
entity.beef.json
webApiAuthorize
This can be overridden within the 'Entity'(s) and/or their corresponding 'Operation'(s).
{"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 can be overridden within the 'Entity'(s).
{"type": "boolean"}
entity.beef.json
webApiRoutePrefix
This is the base (prefix) 'URI' prepended to all entity and underlying 'Operation'(s).
{"type": "string"}
entity.beef.json
validatorLayer
Defaults to 'Business'. A value of 'Business' indicates that the Validators will be defined within the 'Business' namespace/assembly; otherwise, defined within the 'Common' namespace/assembly.
{"type": "string", "enum": ["Business", "Common"]}
entity.beef.json
databaseName
Defaults to 'IDatabase'. This can be overridden within the 'Entity'(s).
{"type": "string"}
entity.beef.json
databaseSchema
Defaults to 'dbo'.
{"type": "string"}
entity.beef.json
entityFrameworkName
Defaults to 'IEfDb'. This can be overridden within the 'Entity'(s).
{"type": "string"}
entity.beef.json
cosmosName
Defaults to 'ICosmosDb'. This can be overridden within the 'Entity'(s).
{"type": "string"}
entity.beef.json
odataName
Defaults to 'IOData'. This can be overridden within the 'Entity'(s).
{"type": "string"}
entity.beef.json
httpAgentName
Defaults to 'IHttpAgent'. This can be overridden within the 'Entity'(s).
{"type": "string"}
entity.beef.json
refDataDefaultMapperConverter
Defaults to 'ReferenceDataCodeConverter<T>'. Where this value is suffixed by '<T>' or '{T}' this will automatically set 'Property.DataConverterIsGeneric' to 'true'.
{"type": "string", "enum": ["ReferenceDataCodeConverter", "ReferenceDataCodeConverter{T}", "ReferenceDataCodeConverter<T>", "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.json
eventPublish
Defaults to 'DataSvc'; unless the 'EventOutbox' is not 'None' where it will default to 'Data'. Used to enable the sending of messages to the likes of EventHub, Service Broker, SignalR, etc. This can be overridden within the 'Entity'(s).
{"type": "string", "enum": ["None", "DataSvc", "Data"]}
entity.beef.json
eventOutbox
Defaults to 'None'. A value of 'Database' will result in the 'DatabaseEventOutboxInvoker' being used to orchestrate.
{"type": "string", "enum": ["None", "Database"]}
entity.beef.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.json
eventSourceKind
Defaults to 'None' (being the event source is not updated).
{"type": "string", "enum": ["None", "Absolute", "Relative", "RelativeOrAbsolute"]}
entity.beef.json
eventSubjectRoot
Used to enable the sending of messages to the likes of EventHub, Service Broker, SignalR, etc. This can be overridden within the 'Entity'(s).
{"type": "string"}
entity.beef.json
eventSubjectFormat
Defaults to 'NameAndKey' (being the event subject name appended with the corresponding unique key.)'.
{"type": "string", "enum": ["NameOnly", "NameAndKey"]}
entity.beef.json
eventSubjectSeparator
Defaults to '.'. Used only where the subject is automatically inferred.
{"type": "string"}
entity.beef.json
eventActionFormat
Defaults to 'None' (no formatting required, i.e. as-is)'.
{"type": "string", "enum": ["None", "PastTense"]}
entity.beef.json
eventCasing
Defaults to 'None' (no casing required, i.e. as-is)'.
{"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 '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.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.json
pathBase
Defaults to 'Company' (runtime parameter) + '.' + 'AppName' (runtime parameter). For example 'Beef.Demo'.
{"type": "string"}
entity.beef.json
pathCommon
Defaults to 'PathBase' + '.Common' (literal). For example 'Beef.Demo.Common'.
{"type": "string"}
entity.beef.json
pathBusiness
Defaults to 'PathBase' + '.Business' (literal). For example 'Beef.Demo.Business'.
{"type": "string"}
entity.beef.json
pathApi
Defaults to 'PathBase' + '.' + 'ApiName' (runtime parameter). For example 'Beef.Demo.Api'.
{"type": "string"}
entity.beef.json
namespaceBase
Defaults to 'Company' (runtime parameter) + '.' + 'AppName' (runtime parameter). For example 'Beef.Demo'.
{"type": "string"}
entity.beef.json
namespaceCommon
Defaults to 'NamespaceBase' + '.Common' (literal). For example 'Beef.Demo.Common'.
{"type": "string"}
entity.beef.json
namespaceBusiness
Defaults to 'NamespaceBase' + '.Business' (literal). For example 'Beef.Demo.Business'.
{"type": "string"}
entity.beef.json
namespaceApi
Defaults to 'NamespaceBase' + '.' + 'ApiName' (runtime parameter). For example 'Beef.Demo.Api'.
{"type": "string"}
entity.beef.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"}, "entityScope": {"type": "string", "enum": ["Common", "Business", "Autonomous"]}, "entityUsing": {"type": "string", "enum": ["Common", "Business", "All", "None"]}, "privateName": {"type": "string"}, "argumentName": {"type": "string"}, "constType": {"type": "string", "enum": ["int", "long", "Guid", "string"]}, "isInitialOverride": {"type": "boolean"}, "refDataType": {"type": "string", "enum": ["int", "long", "Guid", "string"]}, "refDataText": {"type": "boolean"}, "refDataSortOrder": {"type": "string", "enum": ["SortOrder", "Id", "Code", "Text"]}, "refDataStringFormat": {"type": "string"}, "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": ["None", "Newtonsoft"]}, "collection": {"type": "boolean"}, "collectionResult": {"type": "boolean"}, "collectionKeyed": {"type": "boolean"}, "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"}, "databaseName": {"type": "string"}, "databaseSchema": {"type": "string"}, "databaseMapperInheritsFrom": {"type": "string"}, "databaseCustomerMapper": {"type": "boolean"}, "entityFrameworkName": {"type": "string"}, "entityFrameworkModel": {"type": "string"}, "entityFrameworkMapperInheritsFrom": {"type": "string"}, "entityFrameworkCustomMapper": {"type": "boolean"}, "cosmosName": {"type": "string"}, "cosmosModel": {"type": "string"}, "cosmosContainerId": {"type": "string"}, "cosmosPartitionKey": {"type": "string"}, "cosmosValueContainer": {"type": "boolean"}, "cosmosMapperInheritsFrom": {"type": "string"}, "cosmosCustomMapper": {"type": "boolean"}, "odataName": {"type": "string"}, "odataModel": {"type": "string"}, "odataCollectionName": {"type": "string"}, "odataMapperInheritsFrom": {"type": "string"}, "odataCustomMapper": {"type": "boolean"}, "httpAgentName": {"type": "string"}, "httpAgentRoutePrefix": {"type": "string"}, "httpAgentModel": {"type": "string"}, "httpAgentReturnModel": {"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"]}, "eventOutbox": {"type": "string", "enum": ["None", "Database"]}, "eventSource": {"type": "string"}, "eventSubjectFormat": {"type": "string", "enum": ["NameOnly", "NameAndKey"]}, "eventCasing": {"type": "string", "enum": ["None", "Lower", "Upper"]}, "eventTransaction": {"type": "boolean"}, "managerCtor": {"type": "string", "enum": ["Public", "Private", "Protected"]}, "managerCtorParams": {"type": "array", "items": {"type": "string"}}, "managerExtensions": {"type": "boolean"}, "validator": {"type": "string"}, "iValidator": {"type": "string"}, "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.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.json
fileName
Overrides the Name as the code-generated file name.
{"type": "string"}
entity.beef.json
entityScope
Defaults to the 'CodeGeneration.EntityScope'. Determines where the entity is scoped/defined, being 'Common' or 'Business' (i.e. not externally visible). Additionally, there is a special case of 'Autonomous' where both a 'Common' and 'Business' entity are generated (where only the latter inherits from 'EntityBase', etc).
{"type": "string", "enum": ["Common", "Business", "Autonomous"]}
entity.beef.json
entityUsing
Defaults to 'EntityScope' ('Autonomous' will result in 'Business'). A value of 'Common' will add '.Common.Entities', 'Business' will add '.Business.Entities', 'All' to add both, and 'None' to exclude any.
{"type": "string", "enum": ["Common", "Business", "All", "None"]}
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
constType
The .NET Type to be used for the 'const' values. Defaults to 'string'.
{"type": "string", "enum": ["int", "long", "Guid", "string"]}
entity.beef.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.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.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
refDataSortOrder
Specifies the default sort order for the underlying Reference Data collection. Defaults to 'SortOrder'.
{"type": "string", "enum": ["SortOrder", "Id", "Code", "Text"]}
entity.beef.json
refDataStringFormat
The string format supports the standard composite formatting; where the following indexes are used: '{0}' for 'Id', '{1}' for 'Code' and '{2}' for 'Text'. Defaults to '{2}'.
{"type": "string"}
entity.beef.json
inherits
Defaults to 'EntityBase' for a standard entity. For Reference Data it will default to 'ReferenceDataBaseXxx' depending on the corresponding 'RefDataType' value. See 'OmitEntityBase' if the desired outcome is to not inherit from any of the aforementioned base classes.
{"type": "string"}
entity.beef.json
implementsAutoInfer
Will attempt to infer the following: 'IGuidIdentifier', 'IInt32Identifier', 'IInt64Identifier', 'IStringIdentifier', 'IETag' and 'IChangeLog'. Defaults to 'true'.
{"type": "boolean"}
entity.beef.json
namespace
Appended to the end of the standard structure as follows: '{Company}.{AppName}.Common.Entities.{Namespace}'.
{"type": "string"}
entity.beef.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.json
jsonSerializer
Defaults to the 'CodeGeneration.JsonSerializer' configuration property where specified; otherwise, 'Newtonsoft'.
{"type": "string", "enum": ["None", "Newtonsoft"]}
entity.beef.json
collectionResult
Enables the likes of additional paging state to be stored with the underlying collection.
{"type": "boolean"}
entity.beef.json
collectionInherits
Defaults to 'EntityBaseCollection' or 'EntityBaseKeyedCollection' depending on 'CollectionKeyed'. For Reference Data it will default to 'ReferenceDataCollectionBase'.
{"type": "string"}
entity.beef.json
collectionResultInherits
Defaults to 'EntityCollectionResult'.
{"type": "string"}
entity.beef.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.json
dataCtor
Defaults to 'Public'.
{"type": "string", "enum": ["Public", "Private", "Protected"]}
entity.beef.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.json
dataExtensions
This can be overridden using 'Operation.DataExtensions'.
{"type": "boolean"}
entity.beef.json
databaseName
Defaults to the 'CodeGeneration.DatabaseName' configuration property (its default value is 'IDatabase').
{"type": "string"}
entity.beef.json
databaseSchema
Defaults to 'dbo'.
{"type": "string"}