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
entity.beef.json
dataSvcExtensions
Defaults to 'Entity.ManagerExtensions'.
{"type": "boolean"}
entity.beef.json
eventPublish
Defaults to the 'Entity.EventPublish' configuration property (inherits) where not specified. Used to enable the sending of messages to the likes of EventGrid, Service Broker, SignalR, etc.
{"type": "string", "enum": ["None", "DataSvc", "Data"]}
entity.beef.json
eventOutbox
Defaults to 'Entity.EventOutbox' configuration property (inherits) where not specified and 'EventPublish' is 'Data'; otherwise, 'None'. A value of 'Database' will result in the 'DatabaseEventOutboxInvoker' being used to orchestrate.
{"type": "string", "enum": ["None", "Database"]}
entity.beef.json
eventSource
Defaults to 'Entity.EventSource'. Note: when used in code-generation the 'CodeGeneration.EventSourceRoot' will be prepended where specified. To include the entity id/key include a '{$key}' placeholder ('Create', 'Update' or 'Delete' operation only); for example: 'person/{$key}'.
{"type": "string"}
entity.beef.json
eventSubject
The event subject template defaults to '{AppName}.{Entity.Name}', plus each of the unique key placeholders comma separated; e.g. 'Domain.Entity.{id1},{id2}' (depending on whether 'Entity.EventSubjectFormat' is 'NameAndKey' or 'NameOnly'). The event action defaults to 'WebApiOperationType' or 'Operation.Type' where not specified. Multiple events can be raised by specifying more than one subject/action pair separated by a semicolon. E.g. 'Demo.Person.{id}:Create;Demo.Other.{id}:Update'.
{"type": "string"}
entity.beef.json
webApiAuthorize
Where not specified no attribute output will occur; it will then inherit as supported by .NET.
{"type": "string"}
entity.beef.json
webApiMethod
The value defaults as follows: 'HttpGet' for 'Operation.Type' value 'Get' or 'GetColl', 'HttpPost' for 'Operation.Type' value 'Create' or 'Custom', 'HttpPut' for 'Operation.Type' value 'Update', and 'HttpDelete' for 'Operation.Type' value 'Delete'. An 'Operation.Type' value 'Patch' can not be specified and will always default to 'HttpPatch'.
{"type": "string", "enum": ["HttpGet", "HttpPost", "HttpPut", "HttpDelete"]}
entity.beef.json
webApiStatus
The value defaults as follows: 'OK' for 'Operation.Type' value 'Get', 'GetColl', 'Update', 'Delete' or 'Custom', 'Created' for 'Operation.Type' value 'Create'.
{"type": "string", "enum": ["OK", "Accepted", "Created", "NoContent", "NotFound"]}
entity.beef.json
webApiAlternateStatus
The value defaults as follows: 'NotFound' for 'Operation.Type' value 'Get', 'NoContent' for 'Operation.Type' value 'GetColl', 'Create', 'Update' or 'Patch'; otherwise, 'ThrowException' which will result in an 'InvalidOperationException'.
{"type": "string", "enum": ["OK", "Accepted", "Created", "NoContent", "NotFound", "ThrowException"]}
entity.beef.json
webApiLocation
This uses similar formatting to the 'WebApiRoute'. The response value is accessed using 'r.' notation to access underlying properties; for example '{r.Id}' or 'person/{r.Id}'. The 'Entity.WebApiRoutePrefix' will be prepended automatically; however, to disable set the first character to '!', e.g. '!person/{r.Id}'. The URI can be inferred from another 'Operation' by using a lookup '^'; for example '^Get' indicates to infer from the named 'Get' operation (where only '^' is specified this is shorthand for '^Get' as this is the most common value). The Location URI will ensure the first character is a '/' so it acts a 'relative URL absolute path'.
{"type": "string"}
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. Defaults to 'Entity.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
webApiUpdateOperation
Defaults to 'Update'. Specify either just the method name (e.g. 'OperationName') or, interface and method name (e.g. 'IXxxManager.OperationName') to be invoked where in a different 'YyyManager.OperationName'.
{"type": "string"}
entity.beef.json
excludeAll
Is a shorthand means for setting all of the other 'Exclude*' properties to 'true'.
{"type": "boolean"}
entity.beef.json
grpc
gRPC support is an explicit opt-in model (see 'CodeGeneration.Grpc' configuration); therefore, each corresponding 'Entity', 'Property' and 'Operation' will also need to be opted-in specifically.
{"type": "boolean"}
entity.beef.json
Parameter
The 'Parameter' object defines an 'Operation' parameter and its charateristics.
{"type": "object", "properties": {"name": {"type": "string"}, "text": {"type": "string"}, "type": {"type": "string"}, "nullable": {"type": "boolean"}, "default": {"type": "string"}, "privateName": {"type": "string"}, "argumentName": {"type": "string"}, "property": {"type": "string"}, "refDataType": {"type": "string", "enum": ["string", "int", "Guid"]}, "refDataList": {"type": "boolean"}, "validator": {"type": "string"}, "iValidator": {"type": "string"}, "validatorCode": {"type": "string"}, "isMandatory": {"type": "boolean"}, "layerPassing": {"type": "string", "enum": ["All", "ToManagerSet", "ToManagerCollSet"]}, "dataConverter": {"type": "string"}, "dataConverterIsGeneric": {"type": "boolean"}, "webApiFrom": {"type": "string", "enum": ["FromQuery", "FromBody", "FromRoute", "FromEntityProperties"]}, "grpcType": {"type": "string"}}, "required": ["name"]}
entity.beef.json
text
By default the 'Text' will be the 'Name' reformatted as sentence casing.
{"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
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
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
refDataType
Defaults to 'string' where not specified and the corresponding 'Type' starts with (prefix) 'RefDataNamespace.'.
{"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
iValidator
Defaults to 'IValidator<{Type}>' where the '{Type}' is 'Type'.
{"type": "string"}
entity.beef.json
layerPassing
Defaults to 'All'. To further describe, 'All' passes the parameter through all layeys, 'ToManagerSet' only passes the parameter to the 'Manager' layer and overrides the same named property within the corresponding 'value' parameter, 'ToManagerCollSet' only passes the parameter to the 'Manager' layer and overrides the same named property within the corresponding 'value' collection parameter. Where using the 'UniqueKey' option to automatically set 'Parameters', and the 'Operation.Type' is 'Create' or 'Update' it will default to 'ToManagerSet'.
{"type": "string", "enum": ["All", "ToManagerSet", "ToManagerCollSet"]}
entity.beef.json
dataConverter
A 'Converter' is used to convert a data source value to/from a .NET 'Type' where the standard data type conversion is not applicable.
{"type": "string"}
entity.beef.json
webApiFrom
Defaults to 'FromQuery'; unless the parameter 'Type' has also been defined as an 'Entity' within the code-gen config file then it will default to 'FromEntityProperties'. Specifies that the parameter will be declared with corresponding 'FromQueryAttribute', 'FromBodyAttribute' or 'FromRouteAttribute' for the Web API method. The 'FromEntityProperties' will declare all properties of the 'Entity' as query parameters.
{"type": "string", "enum": ["FromQuery", "FromBody", "FromRoute", "FromEntityProperties"]}
entity.beef.json
Const
The 'Const' object is used to define a .NET (C#) constant value for an 'Entity'.
{"type": "object", "properties": {"name": {"type": "string"}, "value": {"type": "string"}, "text": {"type": "string"}}, "required": ["name", "value"]}
entity.beef.json
value
The code generation will ensure the value is delimited properly to output correctly formed (delimited) .NET (C#) code.
{"type": "string"}
entity.beef.json
text
By default the 'Text' will be the 'Name' reformatted as sentence casing. It will be formatted as: 'Represents a {text} constant value.' To create a '<see cref="XXX"/>' within use moustache shorthand (e.g. '{{Xxx}}').
{"type": "string"}
tsoa.json
JSON Schema for the tsoa configuration file
{"$schema": "http://json-schema.org/draft-04/schema#", "allOf": [{}, {"properties": {"controllerPathGlobs": {"items": {"type": "string"}, "type": "array"}, "entryFile": {"type": "string"}, "ignore": {"items": {"type": "string"}, "type": "array"}, "noImplicitAdditionalProperties": {"enum": ["ignore", "silently-remove-extras", "throw-on-extras"], "type": "string"}, "routes": {}, "spec": {}}}], "definitions": {"RoutesConfig": {"properties": {"authenticationModule": {"type": "string"}, "basePath": {"type": "string"}, "iocModule": {"type": "string"}, "middleware": {"enum": ["express", "hapi", "koa"], "type": "string"}, "middlewareTemplate": {"type": "string"}, "routesDir": {"type": "string"}, "routesFileName": {"type": "string"}}, "type": "object"}, "SpecConfig": {"properties": {"basePath": {"type": "string"}, "contact": {"properties": {"email": {"default": "npm package author email", "type": "string"}, "name": {"default": "npm package author", "type": "string"}, "url": {"default": "npm package author url", "type": "string"}}, "type": "object"}, "host": {"type": "string"}, "license": {"type": "string"}, "name": {"type": "string"}, "outputDirectory": {"type": "string"}, "schemes": {"items": {"enum": ["http", "https", "ws", "wss"], "type": "string"}, "type": "array"}, "securityDefinitions": {"additionalProperties": {"anyOf": [{}, {}, {}, {}, {}, {}, {}, {}]}, "type": "object"}, "spec": {}, "specMerging": {"default": "'immediate'", "enum": ["deepmerge", "immediate", "recursive"], "type": "string"}, "specVersion": {"enum": [2, 3], "type": "number"}, "tags": {"items": {}, "type": "array"}, "version": {"type": "string"}, "yaml": {"type": "boolean"}}, "type": "object"}, "Swagger.ApiKeySecurity": {"properties": {"in": {"enum": ["header", "query"], "type": "string"}, "name": {"type": "string"}, "type": {"enum": ["apiKey"], "type": "string"}}, "type": "object"}, "Swagger.BasicSecurity": {"properties": {"type": {"enum": ["basic"], "type": "string"}}, "type": "object"}, "Swagger.BasicSecurity3": {"properties": {"scheme": {"enum": ["basic"], "type": "string"}, "type": {"enum": ["http"], "type": "string"}}, "type": "object"}, "Swagger.ExternalDocs": {"properties": {"url": {"type": "string"}}, "type": "object"}, "Swagger.OAuth2AccessCodeSecurity": {"properties": {"authorizationUrl": {"type": "string"}, "flow": {"enum": ["accessCode"], "type": "string"}, "scopes": {}, "tokenUrl": {"type": "string"}, "type": {"enum": ["oauth2"], "type": "string"}}, "type": "object"}, "Swagger.OAuth2ApplicationSecurity": {"properties": {"flow": {"enum": ["application"], "type": "string"}, "scopes": {}, "tokenUrl": {"type": "string"}, "type": {"enum": ["oauth2"], "type": "string"}}, "type": "object"}, "Swagger.OAuth2ImplicitSecurity": {"properties": {"authorizationUrl": {"type": "string"}, "flow": {"enum": ["implicit"], "type": "string"}, "scopes": {}, "type": {"enum": ["oauth2"], "type": "string"}}, "type": "object"}, "Swagger.OAuth2PasswordSecurity": {"properties": {"flow": {"enum": ["password"], "type": "string"}, "scopes": {}, "tokenUrl": {"type": "string"}, "type": {"enum": ["oauth2"], "type": "string"}}, "type": "object"}, "Swagger.OAuth2Security3": {"properties": {"flows": {}, "type": {"enum": ["oauth2"], "type": "string"}}, "type": "object"}, "Swagger.OAuth2SecurityFlow3": {"properties": {"authorizationUrl": {"type": "string"}, "scopes": {}, "tokenUrl": {"type": "string"}}, "type": "object"}, "Swagger.OAuthFlow": {"properties": {"authorizationCode": {}, "clientCredentials": {}, "implicit": {}, "password": {}}, "type": "object"}, "Swagger.OAuthScope": {"additionalProperties": {"type": "string"}, "type": "object"}, "Swagger.Tag": {"properties": {"externalDocs": {}, "name": {"type": "string"}}, "type": "object"}}, "id": "https://json.schemastore.org/tsoa", "type": "object"}
tsoa.json
controllerPathGlobs
An array of path globs that point to your route controllers that you would like to have tsoa include.
{"items": {"type": "string"}, "type": "array"}
tsoa.json
entryFile
The entry point to your API
{"type": "string"}
tsoa.json
ignore
Directories to ignore during TypeScript metadata scan
{"items": {"type": "string"}, "type": "array"}
tsoa.json
noImplicitAdditionalProperties
Modes that allow you to prevent input data from entering into your API. This will document your decision in the swagger.yaml and it will turn on excess-property validation (at runtime) in your routes.
{"enum": ["ignore", "silently-remove-extras", "throw-on-extras"], "type": "string"}
tsoa.json
routes
Route generation configuration object
{}
tsoa.json
spec
Swagger generation configuration object
{}
tsoa.json
authenticationModule
Authentication Module for express, hapi and koa
{"type": "string"}
tsoa.json
basePath
Base API path; e.g. the '/v1' in https://myapi.com/v1
{"type": "string"}
tsoa.json
iocModule
IOC module; e.g. './inversify/ioc' where IOC container named `iocContainer` is defined (https://github.com/inversify/InversifyJS)
{"type": "string"}
tsoa.json
middleware
Middleware provider.
{"enum": ["express", "hapi", "koa"], "type": "string"}
tsoa.json
middlewareTemplate
Override the Middleware template
{"type": "string"}
tsoa.json
routesDir
Routes directory; generated routes.ts (which contains the generated code wiring up routes using middleware of choice) will be dropped here
{"type": "string"}
tsoa.json
routesFileName
Routes filename; the filename of the generated route file ('routes.ts' by default)
{"type": "string"}
tsoa.json
basePath
Base API path; e.g. the 'v1' in https://myapi.com/v1
{"type": "string"}
tsoa.json
contact
Contact Information
{"properties": {"email": {"default": "npm package author email", "type": "string"}, "name": {"default": "npm package author", "type": "string"}, "url": {"default": "npm package author url", "type": "string"}}, "type": "object"}
tsoa.json
email
The email address of the contact person/organization.
{"default": "npm package author email", "type": "string"}
tsoa.json
name
The identifying name of the contact person/organization.
{"default": "npm package author", "type": "string"}
tsoa.json
url
API Info url The URL pointing to the contact information.
{"default": "npm package author url", "type": "string"}
tsoa.json
description
API description; defaults to npm package description
{"type": "string"}
tsoa.json
host
API host, expressTemplate.g. localhost:3000 or myapi.com
{"type": "string"}
tsoa.json
license
API license; defaults to npm package license
{"type": "string"}
tsoa.json
name
API name; defaults to npm package name
{"type": "string"}
tsoa.json
outputDirectory
Generated SwaggerConfig.json will output here
{"type": "string"}
tsoa.json
securityDefinitions
Security Definitions Object A declaration of the security schemes available to be used in the specification. This does not enforce the security schemes on the operations and only serves to provide the relevant details for each scheme.
{"additionalProperties": {"anyOf": [{}, {}, {}, {}, {}, {}, {}, {}]}, "type": "object"}
tsoa.json
spec
Extend generated swagger spec with this object Note that generated properties will always take precedence over what get specified here
{}
tsoa.json
specMerging
Alter how the spec is merged to generated swagger spec. Possible values: - 'immediate' is overriding top level elements only thus you can not append a new path or alter an existing value without erasing same level elements. - 'recursive' proceed to a deep merge and will concat every branches or override or create new values if needed. @see https://www.npmjs.com/package/merge - 'deepmerge' uses `deepmerge` to merge, which will concat object branches and concat arrays as well @see https://www.npmjs.com/package/deepmerge The default is set to immediate so it is not breaking previous versions.
{"default": "'immediate'", "enum": ["deepmerge", "immediate", "recursive"], "type": "string"}
tsoa.json
specVersion
Major OpenAPI version to generate; defaults to version 2 when not specified Possible values: - 2: generates OpenAPI version 2. - 3: generates OpenAPI version 3.
{"enum": [2, 3], "type": "number"}
tsoa.json
tags
Swagger Tags Information for your API
{"items": {}, "type": "array"}
tsoa.json
version
API version number; defaults to npm package version
{"type": "string"}
vtesttree-schema.json
full
Json schema version for the vtesttree.yaml file. Acceptance criteria: equal major version, less/equal minor and patch version.
{"$schema": "http://json-schema.org/draft-07/schema#", "const": "1.0.0", "type": "string", "examples": ["1.0.0"]}
vtesttree-schema.json
full
Definition of a test tree consisting of test groups, CAPL test cases and CAPL test sequences.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}}
vtesttree-schema.json
full
Json schema version for the vtesttree.yaml file. Acceptance criteria: equal major version, less/equal minor and patch version.
{"$schema": "http://json-schema.org/draft-07/schema#", "const": "2.0.0", "type": "string", "examples": ["2.0.0"]}
vtesttree-schema.json
full
Definition of a test tree consisting of test fixtures, CAPL test cases and CAPL test sequences.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}}
vtesttree-schema.json
full
Element of a test tree or test group.
{"oneOf": [{}, {}, {}]}
vtesttree-schema.json
full
Element of a test tree or test fixture.
{"oneOf": [{}, {}, {}]}
vtesttree-schema.json
full
Definition of a call to a CAPL test case.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "required": ["capl-test-case"], "additionalProperties": false, "properties": {"capl-test-case": {"type": "string"}, "id": {"type": "string"}, "params": {}}}
vtesttree-schema.json
capl-test-case
Function name of the CAPL test case.
{"type": "string"}
vtesttree-schema.json
id
Identifier of the CAPL test case.
{"type": "string"}
vtesttree-schema.json
title
Title of the CAPL test case.
{"type": "string"}
vtesttree-schema.json
description
Description of the CAPL test case.
{"type": "string"}
vtesttree-schema.json
full
Definition of a call to a CAPL test sequence.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "required": ["capl-test-sequence"], "additionalProperties": false, "properties": {"capl-test-sequence": {"type": "string"}, "params": {}}}
vtesttree-schema.json
capl-test-sequence
Function name of the CAPL test sequence.
{"type": "string"}
vtesttree-schema.json
title
Title of the CAPL test sequence.
{"type": "string"}
vtesttree-schema.json
full
Definition of a test group containing other test groups, CAPL test cases and CAPL test sequences.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "required": ["test-group"], "additionalProperties": false, "properties": {"test-group": {"type": "string"}, "elements": {"type": "array", "items": {}}}}
vtesttree-schema.json
test-group
Name of the test group.
{"type": "string"}
vtesttree-schema.json
description
Description of the test group.
{"type": "string"}
vtesttree-schema.json
full
Definition of a call to a CAPL test sequence.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "required": ["capl-test-sequence"], "additionalProperties": false, "properties": {"capl-test-sequence": {"type": "string"}, "params": {}}}
vtesttree-schema.json
capl-test-sequence
Function name of the CAPL test sequence.
{"type": "string"}
vtesttree-schema.json
title
Title of the CAPL test sequence.
{"type": "string"}
vtesttree-schema.json
full
Definition of a test fixture containing other test fixtures, CAPL test cases and CAPL test sequences.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "required": ["test-fixture"], "additionalProperties": false, "properties": {"test-fixture": {"type": "string"}, "elements": {"type": "array", "items": {}}}}
vtesttree-schema.json
test-fixture
Name of the test fixture.
{"type": "string"}
vtesttree-schema.json
description
Description of the test fixture.
{"type": "string"}
vtesttree-schema.json
full
List of parameter values for a CAPL test case or CAPL test sequence.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}}
vtesttree-schema.json
full
Parameter value for a CAPL test case or CAPL test sequence.
{"$schema": "http://json-schema.org/draft-07/schema#", "anyOf": [{"type": "number"}, {"type": "string"}]}
bundleconfig.json
Schema for bundleconfig.json files
{"$schema": "http://json-schema.org/draft-04/schema#", "definitions": {"jsBundle": {"properties": {"outputFileName": {"pattern": "\\.js$"}, "sourceMap": {"type": "boolean"}, "sourceMapRootPath": {"type": "string", "default": ""}, "minify": {"type": "object", "properties": {"alwaysEscapeNonAscii": {"type": "boolean", "default": false}, "evalTreatment": {"enum": ["ignore", "makeAllSafe", "makeImmediateSafe"], "default": "ignore"}, "preserveImportantComments": {"type": "boolean", "default": true}, "renameLocals": {"type": "boolean", "default": true}, "termSemicolons": {"type": "boolean", "default": true}}, "allOf": [{}]}}}, "cssBundle": {"properties": {"outputFileName": {"pattern": "\\.css$"}, "minify": {"type": "object", "properties": {"colorNames": {"enum": ["hex", "major", "noSwap", "strict"], "default": "strict"}, "commentMode": {"enum": ["none", "all", "hacks", "important"], "default": "important"}, "adjustRelativePaths": {"type": "boolean", "default": true}, "termSemicolons": {"type": "boolean", "default": false}}, "allOf": [{}]}}}, "htmlBundle": {"properties": {"outputFileName": {"pattern": "\\.(html|htm)$"}, "minify": {"type": "object", "properties": {"collapseBooleanAttributes": {"type": "boolean", "default": true}, "collapseWhitespace": {"type": "boolean", "default": true}, "isFragmentOnly": {"type": "boolean", "default": true}, "keepOneSpaceWhenCollapsing": {"type": "boolean", "default": false}, "minifyEmbeddedCssCode": {"type": "boolean", "default": true}, "minifyEmbeddedJsCode": {"type": "boolean", "default": true}, "minifyInlineCssCode": {"type": "boolean", "default": true}, "preserveCase": {"type": "boolean", "default": false}, "removeHtmlComments": {"type": "boolean", "default": true}, "removeOptionalEndTags": {"type": "boolean", "default": false}, "removeQuotedAttributes": {"type": "boolean", "default": true}}}}}, "ajaxminBaseSettings": {"properties": {"indentSize": {"type": "integer", "default": 2}, "outputMode": {"enum": ["multipleLines", "singleLine", "none"], "default": "singleLine"}}}, "bundle": {"required": ["outputFileName", "inputFiles"], "properties": {"includeInProject": {"type": "boolean", "default": true}, "inputFiles": {"type": "array", "items": {"type": "string"}}, "minify": {"type": "object", "required": ["enabled"], "properties": {"enabled": {"type": "boolean"}, "gzip": {"type": "boolean", "default": false}}}, "outputFileName": {"type": "string", "minLength": 1}}, "oneOf": [{}, {}, {}]}}, "id": "https://json.schemastore.org/bundleconfig.json", "items": {}, "type": "array"}
bundleconfig.json
sourceMap
JavaScript only. Set to true to produce a source map.
{"type": "boolean"}
bundleconfig.json
sourceMapRootPath
JavaScript only. Sets a root path for source maps.
{"type": "string", "default": ""}
bundleconfig.json
alwaysEscapeNonAscii
JavaScript only. Gets or sets a flag indicating whether to always escape non-ASCII characters as \uXXXX or to let the output encoding object handle that via the JsEncoderFallback object for the specified output encoding format.
{"type": "boolean", "default": false}
bundleconfig.json
evalTreatment
JavaScript only.
{"enum": ["ignore", "makeAllSafe", "makeImmediateSafe"], "default": "ignore"}
bundleconfig.json
preserveImportantComments
JavaScript only.
{"type": "boolean", "default": true}
bundleconfig.json
renameLocals
JavaScript only. Controls if local variables should be shortened.
{"type": "boolean", "default": true}
bundleconfig.json
termSemicolons
Forces all rules to be terminated with semicolons if set to true.
{"type": "boolean", "default": true}
bundleconfig.json
colorNames
CSS only. If no color names are to be used, set this value to 'hex'. If a set of colors recognized by all major browser is okay to use (W3C-strict validation is not required), set this value to 'major'.
{"enum": ["hex", "major", "noSwap", "strict"], "default": "strict"}
bundleconfig.json
commentMode
CSS only. How to treat comments in the code. The default is 'none', which will strip all comments except 'important' comments. 'all' will leave all comments, and 'hacks' will only leave certain known comment-based hacks.
{"enum": ["none", "all", "hacks", "important"], "default": "important"}
bundleconfig.json
adjustRelativePaths
CSS only. Adjust relative paths inside the url() function.
{"type": "boolean", "default": true}
bundleconfig.json
termSemicolons
Forces all rules to be terminated with semicolons if set to true.
{"type": "boolean", "default": false}
bundleconfig.json
collapseBooleanAttributes
HTML only. Remove values from boolean attributes.
{"type": "boolean", "default": true}
bundleconfig.json
collapseWhitespace
HTML only. Indicating whether to collapse whitespaces.
{"type": "boolean", "default": true}
bundleconfig.json
isFragmentOnly
HTML only. Indicating whether the parsing is occurring on an HTML fragment, to avoid creating missing tags (like html, body, head).
{"type": "boolean", "default": true}