schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
airlock-microgateway-3.2.json | content | This regular expression pattern defines the content to rewrite. | {} |
airlock-microgateway-3.2.json | content_type | A response from the back-end server is rewritten only if the response header «Content-Type» matches this regular expression. | {"type": "string", "default": "^(?:text|application)/(?:html|xhtml)"} |
airlock-microgateway-3.2.json | to | This is the target string which will replace the string matched by Content Pattern | {"type": ["string", "null"]} |
airlock-microgateway-3.2.json | html | Rewriting HTML content may be necessary to modify URLs in the HTML content if the application creates absolute or incorrect links because it is not reverse proxy compatible | {"type": "array", "items": {"type": "object", "properties": {"options": {"default": "[ url ]", "type": "array", "items": {"type": "string", "enum": ["url", "event", "embedded"], "default": "[ url ]"}}, "to": {"type": ["string", "null"]}, "url": {"allOf": [{}, {}]}}, "additionalProperties": false}} |
airlock-microgateway-3.2.json | options | This list defines the content to rewrite. Possible values are 'url', event', 'embedded'. | {"default": "[ url ]", "type": "array", "items": {"type": "string", "enum": ["url", "event", "embedded"], "default": "[ url ]"}} |
airlock-microgateway-3.2.json | to | This is the target string which will replace the string matched by URL Pattern | {"type": ["string", "null"]} |
airlock-microgateway-3.2.json | url | The URL pattern. | {} |
airlock-microgateway-3.2.json | json | Rewrite the json body of http responses. | {"type": "array", "items": {"type": "object", "properties": {"content": {"allOf": [{}, {}]}, "path": {"type": "string"}, "replace": {"type": "string"}}, "additionalProperties": false}} |
airlock-microgateway-3.2.json | content | This regular expression pattern defines the content to rewrite. | {} |
airlock-microgateway-3.2.json | path | The json path of the the property to rewrite. | {"type": "string"} |
airlock-microgateway-3.2.json | replace | This is the target content to replace the matched part with. | {"type": "string"} |
airlock-microgateway-3.2.json | location_header | Rewrite option to modify the HTTP redirect location header sent from the back-end server before it is sent to the client. | {"type": "array", "items": {"type": "object", "properties": {"to": {"type": ["string", "null"]}, "url": {"allOf": [{}, {}]}}, "additionalProperties": false}} |
airlock-microgateway-3.2.json | to | This is the target string which will replace the string matched by URL Pattern | {"type": ["string", "null"]} |
airlock-microgateway-3.2.json | url | The redirect URL pattern. | {} |
airlock-microgateway-3.2.json | session_handling | Allowed values are: enforce_session, optional_session, optional_session_no_refresh, ignore_session | {"anyOf": [{"type": "null"}, {"type": "string", "enum": ["enforce_session", "optional_session", "optional_session_no_refresh", "ignore_session"]}], "default": "ignore_session"} |
airlock-microgateway-3.2.json | threat_handling | Allowed values are: block, terminate_session, notify. | {"anyOf": [{"type": "null"}, {"type": "string", "enum": ["terminate_session", "block", "notify"]}], "default": "block"} |
airlock-microgateway-3.2.json | backend_http_response | Defines the time in seconds Airlock Microgateway will wait for the back-end HTTP response. In case the request runs into the timeout, Airlock Microgateway will deliver an error page with the corresponding HTTP 503 status code. | {"type": ["integer", "null"], "default": "120"} |
airlock-microgateway-3.2.json | idle_session | Defines the minimum session idle time in seconds for this mapping. The value will be ignored if minimum session idle timeout is smaller or equal to the global session idle timeout setting. | {"type": ["integer", "null"], "default": "0"} |
airlock-microgateway-3.2.json | aliases | Additional hostnames which refer to this virtual host. | {"type": "array", "items": {"type": "string"}} |
airlock-microgateway-3.2.json | ca_selection | The concatenated certificates of the CAs which are sent to the client during the SSL handshake, in PEM format. | {"type": ["string", "null"]} |
airlock-microgateway-3.2.json | ca_selection_file | The file containing the selection CA certificates. | {"type": ["string", "null"], "default": "/secret/auth/client_certificate/selection.crt"} |
airlock-microgateway-3.2.json | ca_validation | The concatenated certificates of the CAs which are used as trust anchor during chain validation, in PEM format. | {"type": ["string", "null"]} |
airlock-microgateway-3.2.json | ca_validation_file | The file containing the validation CA certificates. | {"type": ["string", "null"], "default": "/secret/auth/client_certificate/validation.crt"} |
airlock-microgateway-3.2.json | crl | PEM representation of certificate revocation lists. If a client certificate is on such a list it will not be accepted. Although Airlock provides this functionality, it is recommended to check certificates against CRLs and other types of blacklists within the authentication service and not in Airlock. | {"type": ["string", "null"]} |
airlock-microgateway-3.2.json | crl_file | The file containing the crl. | {"type": ["string", "null"], "default": "/secret/auth/client_certificate/client.crl"} |
airlock-microgateway-3.2.json | verification | Defines the default verification mode for client certificates on this virtual host. Possible values are 'off', 'optional' or 'required'. | {"type": "string", "enum": ["off", "optional", "required"], "default": "off"} |
airlock-microgateway-3.2.json | verification_depth | Maximum number of intermediate certificate issuers. | {"type": "integer", "default": "1"} |
airlock-microgateway-3.2.json | ca_chain | List of certificates of the CA chain for the certificate. | {"type": ["string", "null"]} |
airlock-microgateway-3.2.json | ca_chain_file | The CA chain file path. | {"type": ["string", "null"], "default": "/secret/tls/frontend-server-ca.crt"} |
airlock-microgateway-3.2.json | certificate | The certificate in PEM format. | {"type": ["string", "null"]} |
airlock-microgateway-3.2.json | certificate_file | The certificate file path. | {"type": ["string", "null"], "default": "/secret/tls/frontend-server.crt"} |
airlock-microgateway-3.2.json | privatekey | The private key for the certificate in PEM format. | {"type": ["string", "null"]} |
airlock-microgateway-3.2.json | privatekey_file | The private key file path | {"type": ["string", "null"], "default": "/secret/tls/frontend-server.key"} |
airlock-microgateway-3.2.json | encoded_slashes | Specifies whether encoded slashes (%2F) are allowed in URL path. Attention: combinations of client certificates per mapping and enabled encoded slashes in the same virtual host might result in configurations where client certificate evaluation might be evaded. | {"type": "boolean", "default": "false"} |
airlock-microgateway-3.2.json | hostname | The hostname of the virtual host. | {"type": "string", "default": "microgateway"} |
airlock-microgateway-3.2.json | http2_enabled | Specifies whether HTTP/2 connections are enabled for this host. | {"type": "boolean", "default": "true"} |
airlock-microgateway-3.2.json | http_enabled | Specifies whether HTTP connections are enabled for this host. | {"type": "boolean", "default": "true"} |
airlock-microgateway-3.2.json | http_port | Specifies the port on which this host listens for HTTP connections. | {"type": "integer", "default": "8080", "minimum": 1, "maximum": 65535} |
airlock-microgateway-3.2.json | https_enabled | Specifies whether HTTPS connections are enabled for this host. | {"type": "boolean", "default": "true"} |
airlock-microgateway-3.2.json | https_port | Specifies the port on which this host listens for HTTPS connections. | {"type": "integer", "default": "8443", "minimum": 1, "maximum": 65535} |
airlock-microgateway-3.2.json | name | The logical name of the virtual host. | {"type": "string", "default": "microgateway"} |
airlock-microgateway-3.2.json | dest | The destination can be relative to the current virtual host or an absolute URL including protocol and host. Relative redirect paths are extended with the incoming scheme and host header. | {"type": "string", "minLength": 1, "pattern": "^(http://|https://|ftp://|/)\\S*?$"} |
airlock-microgateway-3.2.json | path | The absolute path starting with '/' as a regular expression from which to redirect. | {} |
airlock-microgateway-3.2.json | status_code | The returned status code. Must be one of: [301, 302, 303, 307, 308] | {"type": "integer", "default": "303", "minimum": 301, "maximum": 308} |
airlock-microgateway-3.2.json | session_cookie_domain | Specifies the domain for Airlock's session cookie if the cookie is created inside this virtual host. | {"type": ["string", "null"]} |
airlock-microgateway-3.2.json | session_cookie_path | Specifies the cookie path for Airlock's session cookie if the cookie is created inside this virtual host. | {"type": "string", "default": "/"} |
airlock-microgateway-3.2.json | strict_fqdn | Specifies whether a virtual host should reply only to requests that match the hostname or any of its server alias names. | {"type": "boolean", "default": "false"} |
airlock-microgateway-3.2.json | deny_rule_groups | Custom deny rule groups that can be referenced in mappings on top of the built in Airlock deny rules. | {"type": "array", "items": {"type": "object", "properties": {"deny_rules": {"type": "array", "items": {"type": "object", "properties": {"content_type": {}, "header_name": {}, "header_value": {}, "method": {}, "name": {"type": "string", "pattern": "^(?![ \\t\\n]*\\(default(.*)\\))[\\s\\S]*"}, "parameter_name": {}, "parameter_value": {}, "path": {}, "rule_key": {"type": "string", "pattern": "^(?![ \\t\\n]*\\(default(.*)\\))[\\s\\S]*"}}, "additionalProperties": false}}, "name": {"type": "string", "pattern": "^(?![ \\t\\n]*\\(default(.*)\\))[\\s\\S]*"}, "rule_group_key": {"type": "string", "pattern": "^(?![ \\t\\n]*\\(default(.*)\\))[\\s\\S]*"}}, "additionalProperties": false}} |
airlock-microgateway-3.2.json | deny_rules | Filter rule that blocks requests based on the evaluation of different request attributes. | {"type": "array", "items": {"type": "object", "properties": {"content_type": {}, "header_name": {}, "header_value": {}, "method": {}, "name": {"type": "string", "pattern": "^(?![ \\t\\n]*\\(default(.*)\\))[\\s\\S]*"}, "parameter_name": {}, "parameter_value": {}, "path": {}, "rule_key": {"type": "string", "pattern": "^(?![ \\t\\n]*\\(default(.*)\\))[\\s\\S]*"}}, "additionalProperties": false}} |
airlock-microgateway-3.2.json | name | Unique name. In order to prevent overriding built-in deny rules, the name may not start with '(default)'. | {"type": "string", "pattern": "^(?![ \\t\\n]*\\(default(.*)\\))[\\s\\S]*"} |
airlock-microgateway-3.2.json | rule_key | Unique short name. In order to prevent overriding built-in deny rules, the name may not start with '(default)'. | {"type": "string", "pattern": "^(?![ \\t\\n]*\\(default(.*)\\))[\\s\\S]*"} |
airlock-microgateway-3.2.json | name | Unique name. In order to prevent overriding built-in deny rule group, the name may not start with '(default)'. | {"type": "string", "pattern": "^(?![ \\t\\n]*\\(default(.*)\\))[\\s\\S]*"} |
airlock-microgateway-3.2.json | rule_group_key | Unique short name. In order to prevent overriding built-in deny rule group, the name may not start with '(default)'. | {"type": "string", "pattern": "^(?![ \\t\\n]*\\(default(.*)\\))[\\s\\S]*"} |
airlock-microgateway-3.2.json | jwks_providers | JWKS Providers which can be referenced in apps[].mappings[].access_token. | {"type": ["object", "null"], "properties": {"local": {"default": "[]", "type": "array", "items": {"type": "object", "properties": {"issuer": {"type": ["string", "null"]}, "jwks": {"type": ["string", "null"]}, "jwks_file": {"type": ["string", "null"]}, "name": {"type": "string"}}, "required": ["name"], "additionalProperties": false, "default": "[]"}}, "refresh_interval": {"type": "integer", "default": "86400"}, "remote": {"default": "[]", "type": "array", "items": {"type": "object", "properties": {"issuer": {"type": ["string", "null"]}, "name": {"type": "string"}, "service_url": {"type": "string"}, "tls": {"type": "object", "properties": {"cipher_suite": {"type": "string", "default": "DEFAULT"}, "client": {"type": ["object", "null"], "properties": {"ca_chain": {"type": ["string", "null"]}, "ca_chain_file": {"type": ["string", "null"], "default": "/secret/auth/jwks/tls/client/client-ca.crt"}, "certificate": {"type": ["string", "null"]}, "certificate_file": {"type": ["string", "null"], "default": "/secret/auth/jwks/tls/client/client.crt"}, "privatekey": {"type": ["string", "null"]}, "privatekey_file": {"type": ["string", "null"], "default": "/secret/auth/jwks/tls/client/client.key"}}, "additionalProperties": false}, "force_new_session": {"type": "boolean", "default": "false"}, "protocol": {"type": "string", "enum": ["DEFAULT", "TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3"], "default": "DEFAULT"}, "server": {"type": ["object", "null"], "properties": {"ca_validation": {"type": ["string", "null"]}, "ca_validation_file": {"type": ["string", "null"], "default": "/secret/auth/jwks/tls/server/server-validation.crt"}, "host_name_verification": {"type": "boolean", "default": "false"}}, "additionalProperties": false}}, "additionalProperties": false}}, "required": ["name", "service_url"], "additionalProperties": false, "default": "[]"}}}, "additionalProperties": false} |
airlock-microgateway-3.2.json | local | JWKS providers that are configured statically. | {"default": "[]", "type": "array", "items": {"type": "object", "properties": {"issuer": {"type": ["string", "null"]}, "jwks": {"type": ["string", "null"]}, "jwks_file": {"type": ["string", "null"]}, "name": {"type": "string"}}, "required": ["name"], "additionalProperties": false, "default": "[]"}} |
airlock-microgateway-3.2.json | issuer | Name of JWKS issuer. Corresponds to the 'Issuer' field in JWT. | {"type": ["string", "null"]} |
airlock-microgateway-3.2.json | jwks | JSON Object that represents the set of JWKS. | {"type": ["string", "null"]} |
airlock-microgateway-3.2.json | jwks_file | JSON file with the definitions of JWKS. | {"type": ["string", "null"]} |
airlock-microgateway-3.2.json | name | Name by which provider is referenced. Must be unique. | {"type": "string"} |
airlock-microgateway-3.2.json | refresh_interval | Refresh interval for fetching from remote JWKS providers in seconds. | {"type": "integer", "default": "86400"} |
airlock-microgateway-3.2.json | remote | Remote JWKS providers which are fetched according to the jwks_providers.refresh_interval. | {"default": "[]", "type": "array", "items": {"type": "object", "properties": {"issuer": {"type": ["string", "null"]}, "name": {"type": "string"}, "service_url": {"type": "string"}, "tls": {"type": "object", "properties": {"cipher_suite": {"type": "string", "default": "DEFAULT"}, "client": {"type": ["object", "null"], "properties": {"ca_chain": {"type": ["string", "null"]}, "ca_chain_file": {"type": ["string", "null"], "default": "/secret/auth/jwks/tls/client/client-ca.crt"}, "certificate": {"type": ["string", "null"]}, "certificate_file": {"type": ["string", "null"], "default": "/secret/auth/jwks/tls/client/client.crt"}, "privatekey": {"type": ["string", "null"]}, "privatekey_file": {"type": ["string", "null"], "default": "/secret/auth/jwks/tls/client/client.key"}}, "additionalProperties": false}, "force_new_session": {"type": "boolean", "default": "false"}, "protocol": {"type": "string", "enum": ["DEFAULT", "TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3"], "default": "DEFAULT"}, "server": {"type": ["object", "null"], "properties": {"ca_validation": {"type": ["string", "null"]}, "ca_validation_file": {"type": ["string", "null"], "default": "/secret/auth/jwks/tls/server/server-validation.crt"}, "host_name_verification": {"type": "boolean", "default": "false"}}, "additionalProperties": false}}, "additionalProperties": false}}, "required": ["name", "service_url"], "additionalProperties": false, "default": "[]"}} |
airlock-microgateway-3.2.json | issuer | Name of JWKS issuer. This value is used to restrict the usage of the JWKS to JWTs with a matching issuer (claim 'iss'). | {"type": ["string", "null"]} |
airlock-microgateway-3.2.json | name | Name by which provider is referenced. Must be unique. | {"type": "string"} |
airlock-microgateway-3.2.json | service_url | URL of JWKS service provider. | {"type": "string"} |
airlock-microgateway-3.2.json | cipher_suite | The TLS cipher suite to use. For documentation visit www.openssl.org and search for 'ciphers'. | {"type": "string", "default": "DEFAULT"} |
airlock-microgateway-3.2.json | ca_chain | List of certificates of the CA chain for the certificate. | {"type": ["string", "null"]} |
airlock-microgateway-3.2.json | ca_chain_file | The CA chain file path. | {"type": ["string", "null"], "default": "/secret/auth/jwks/tls/client/client-ca.crt"} |
airlock-microgateway-3.2.json | certificate | The certificate in PEM format. | {"type": ["string", "null"]} |
airlock-microgateway-3.2.json | certificate_file | The certificate file path. | {"type": ["string", "null"], "default": "/secret/auth/jwks/tls/client/client.crt"} |
airlock-microgateway-3.2.json | privatekey | The private key for the certificate in PEM format. | {"type": ["string", "null"]} |
airlock-microgateway-3.2.json | privatekey_file | The private key file path | {"type": ["string", "null"], "default": "/secret/auth/jwks/tls/client/client.key"} |
airlock-microgateway-3.2.json | force_new_session | Force new session for each request. | {"type": "boolean", "default": "false"} |
airlock-microgateway-3.2.json | protocol | The TLS protocol to use. For the description of the default values see the Gateway documentation for 'Supported SSL/TLS versions'. | {"type": "string", "enum": ["DEFAULT", "TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3"], "default": "DEFAULT"} |
airlock-microgateway-3.2.json | ca_validation | The concatenated certificates of the CAs which are used as trust anchor during chain validation, in PEM format. | {"type": ["string", "null"]} |
airlock-microgateway-3.2.json | ca_validation_file | The file containing the validation CA certificates. | {"type": ["string", "null"], "default": "/secret/auth/jwks/tls/server/server-validation.crt"} |
airlock-microgateway-3.2.json | host_name_verification | Verification which involves a server identity check to mitigate man in the middle attacks. | {"type": "boolean", "default": "false"} |
airlock-microgateway-3.2.json | license | The encoded license. | {"type": ["string", "null"]} |
airlock-microgateway-3.2.json | license_file | The license file path. | {"type": ["string", "null"], "default": "/secret/license"} |
airlock-microgateway-3.2.json | level | Allowed values are: info, trace | {"type": "string", "enum": ["info", "trace"], "default": "info"} |
airlock-microgateway-3.2.json | metrics | Configuration for metrics sending. | {"type": "object", "properties": {"statsd": {"type": "object", "properties": {"enabled": {"type": "boolean", "default": "true"}}, "additionalProperties": false}}, "additionalProperties": false} |
airlock-microgateway-3.2.json | statsd | Use this to enable sending metrics using the statsd protocol. | {"type": "object", "properties": {"enabled": {"type": "boolean", "default": "true"}}, "additionalProperties": false} |
airlock-microgateway-3.2.json | enabled | Enable sending of statsd metrics. Default is 'true' | {"type": "boolean", "default": "true"} |
airlock-microgateway-3.2.json | header | If set, Airlock Microgateway will treat the value of this header field as the useragent IP address.<br />Common values are 'X-Forwarded-For' or 'X-Client-IP'.<br /><strong>Warning</strong>: Make sure that internal_proxies is correctly configured for your setup. | {"type": "string"} |
airlock-microgateway-3.2.json | internal_proxies | List of hostnames, IP addresses or IP address ranges (e.g. 10.0.0.0/8) to trust as presenting a valid Remote-IP header. | {"type": "array", "items": {"type": "string"}} |
airlock-microgateway-3.2.json | encryption_passphrase | Specifies the passphrase for the passphrase based encryption mechanism (PBE). | {"type": ["string", "null"]} |
airlock-microgateway-3.2.json | encryption_passphrase_file | The path of the passphrase file. | {"type": ["string", "null"], "default": "/secret/passphrase"} |
airlock-microgateway-3.2.json | idle_timeout | Specifies the amount of idle time in seconds, after which an Airlock Microgateway session is terminated. This timeout should be smaller than all other session timeouts of your back-end applications. Even if the timeout can be configured in seconds, per default the resolution of the idle session timeout check is 5 seconds only. | {"type": "integer", "default": "600"} |
airlock-microgateway-3.2.json | lifetime | Specifies the absolute lifetime of an Airlock Microgateway session in seconds. After this time a session will be terminated. | {"type": "integer", "default": "28800"} |
airlock-microgateway-3.2.json | redis_hosts | Name of the hosts running the Redis Server. | {"default": "[]", "type": "array", "items": {"type": "string", "default": "[]"}} |
airlock-microgateway-3.2.json | store_mode | Defines the redis session store connection mode. By default, the Microgateway tries to determine the connection mode depending on the number of redis hosts configured:<br />- server mode if only one host is configured<br />- cluster mode if several hosts are configured<br /><br />Allowed values are: server, cluster and disabled. | {"type": "string", "enum": ["server", "cluster", "disabled"]} |
stylecop.schema.json | Configuration file for StyleCop Analyzers | {"$schema": "http://json-schema.org/draft-04/schema#", "id": "https://raw.githubusercontent.com/DotNetAnalyzers/StyleCopAnalyzers/master/StyleCop.Analyzers/StyleCop.Analyzers/Settings/stylecop.schema.json", "type": "object", "properties": {"settings": {"type": "object", "additionalProperties": false, "properties": {"indentation": {"type": "object", "additionalProperties": false, "properties": {"indentationSize": {"type": "integer", "minimum": 0, "default": 4}, "tabSize": {"type": "integer", "minimum": 0, "default": 4}, "useTabs": {"type": "boolean", "default": false}}}, "spacingRules": {"type": "object", "additionalProperties": false, "properties": {}}, "readabilityRules": {"type": "object", "additionalProperties": false, "properties": {"allowBuiltInTypeAliases": {"type": "boolean", "default": false}}}, "orderingRules": {"type": "object", "additionalProperties": false, "properties": {"elementOrder": {"type": "array", "default": ["kind", "accessibility", "constant", "static", "readonly"], "items": {"type": "string", "enum": ["accessibility", "kind", "constant", "static", "readonly"]}, "uniqueItems": true}, "systemUsingDirectivesFirst": {"type": "boolean", "default": true}, "usingDirectivesPlacement": {"type": "string", "enum": ["insideNamespace", "outsideNamespace", "preserve"], "default": "insideNamespace"}, "blankLinesBetweenUsingGroups": {"type": "string", "enum": ["allow", "require", "omit"], "default": "allow"}}}, "namingRules": {"type": "object", "additionalProperties": false, "properties": {"allowCommonHungarianPrefixes": {"type": "boolean", "default": true}, "allowedHungarianPrefixes": {"type": "array", "default": [], "items": {"type": "string", "pattern": "^[a-z]{1,2}$", "uniqueItems": true}}, "allowedNamespaceComponents": {"type": "array", "default": [], "items": {"type": "string", "uniqueItems": true}}, "includeInferredTupleElementNames": {"type": "boolean", "default": false}, "tupleElementNameCasing": {"type": "string", "enum": ["camelCase", "PascalCase"], "default": "PascalCase"}}}, "maintainabilityRules": {"type": "object", "additionalProperties": false, "properties": {"topLevelTypes": {"type": "array", "default": ["class"], "items": {"type": "string", "enum": ["class", "interface", "struct", "delegate", "enum"]}, "uniqueItems": true}}}, "layoutRules": {"type": "object", "additionalProperties": false, "properties": {"newlineAtEndOfFile": {"type": "string", "enum": ["allow", "require", "omit"], "default": "allow"}, "allowConsecutiveUsings": {"type": "boolean", "default": true}, "allowDoWhileOnClosingBrace": {"type": "boolean", "default": false}}}, "documentationRules": {"type": "object", "additionalProperties": false, "properties": {"documentExposedElements": {"type": "boolean", "default": true}, "documentInternalElements": {"type": "boolean", "default": true}, "documentPrivateElements": {"type": "boolean", "default": false}, "documentInterfaces": {"type": "boolean", "default": true}, "documentPrivateFields": {"type": "boolean", "default": false}, "companyName": {"type": "string", "default": "PlaceholderCompany"}, "copyrightText": {"type": "string", "default": "Copyright (c) {companyName}. All rights reserved."}, "variables": {"type": "object", "patternProperties": {"^[a-zA-Z0-9]+$": {"type": "string"}}, "additionalProperties": false}, "xmlHeader": {"type": "boolean", "default": true}, "headerDecoration": {"type": "string", "default": null}, "fileNamingConvention": {"type": "string", "default": "stylecop", "enum": ["stylecop", "metadata"]}, "documentationCulture": {"type": "string", "default": "en-US"}, "excludeFromPunctuationCheck": {"type": "array", "default": ["seealso"]}}}}}}} |
|
stylecop.schema.json | settings | The top-level object containing configuration properties for built-in rules. | {"type": "object", "additionalProperties": false, "properties": {"indentation": {"type": "object", "additionalProperties": false, "properties": {"indentationSize": {"type": "integer", "minimum": 0, "default": 4}, "tabSize": {"type": "integer", "minimum": 0, "default": 4}, "useTabs": {"type": "boolean", "default": false}}}, "spacingRules": {"type": "object", "additionalProperties": false, "properties": {}}, "readabilityRules": {"type": "object", "additionalProperties": false, "properties": {"allowBuiltInTypeAliases": {"type": "boolean", "default": false}}}, "orderingRules": {"type": "object", "additionalProperties": false, "properties": {"elementOrder": {"type": "array", "default": ["kind", "accessibility", "constant", "static", "readonly"], "items": {"type": "string", "enum": ["accessibility", "kind", "constant", "static", "readonly"]}, "uniqueItems": true}, "systemUsingDirectivesFirst": {"type": "boolean", "default": true}, "usingDirectivesPlacement": {"type": "string", "enum": ["insideNamespace", "outsideNamespace", "preserve"], "default": "insideNamespace"}, "blankLinesBetweenUsingGroups": {"type": "string", "enum": ["allow", "require", "omit"], "default": "allow"}}}, "namingRules": {"type": "object", "additionalProperties": false, "properties": {"allowCommonHungarianPrefixes": {"type": "boolean", "default": true}, "allowedHungarianPrefixes": {"type": "array", "default": [], "items": {"type": "string", "pattern": "^[a-z]{1,2}$", "uniqueItems": true}}, "allowedNamespaceComponents": {"type": "array", "default": [], "items": {"type": "string", "uniqueItems": true}}, "includeInferredTupleElementNames": {"type": "boolean", "default": false}, "tupleElementNameCasing": {"type": "string", "enum": ["camelCase", "PascalCase"], "default": "PascalCase"}}}, "maintainabilityRules": {"type": "object", "additionalProperties": false, "properties": {"topLevelTypes": {"type": "array", "default": ["class"], "items": {"type": "string", "enum": ["class", "interface", "struct", "delegate", "enum"]}, "uniqueItems": true}}}, "layoutRules": {"type": "object", "additionalProperties": false, "properties": {"newlineAtEndOfFile": {"type": "string", "enum": ["allow", "require", "omit"], "default": "allow"}, "allowConsecutiveUsings": {"type": "boolean", "default": true}, "allowDoWhileOnClosingBrace": {"type": "boolean", "default": false}}}, "documentationRules": {"type": "object", "additionalProperties": false, "properties": {"documentExposedElements": {"type": "boolean", "default": true}, "documentInternalElements": {"type": "boolean", "default": true}, "documentPrivateElements": {"type": "boolean", "default": false}, "documentInterfaces": {"type": "boolean", "default": true}, "documentPrivateFields": {"type": "boolean", "default": false}, "companyName": {"type": "string", "default": "PlaceholderCompany"}, "copyrightText": {"type": "string", "default": "Copyright (c) {companyName}. All rights reserved."}, "variables": {"type": "object", "patternProperties": {"^[a-zA-Z0-9]+$": {"type": "string"}}, "additionalProperties": false}, "xmlHeader": {"type": "boolean", "default": true}, "headerDecoration": {"type": "string", "default": null}, "fileNamingConvention": {"type": "string", "default": "stylecop", "enum": ["stylecop", "metadata"]}, "documentationCulture": {"type": "string", "default": "en-US"}, "excludeFromPunctuationCheck": {"type": "array", "default": ["seealso"]}}}}} |
stylecop.schema.json | indentation | Indentation configuration | {"type": "object", "additionalProperties": false, "properties": {"indentationSize": {"type": "integer", "minimum": 0, "default": 4}, "tabSize": {"type": "integer", "minimum": 0, "default": 4}, "useTabs": {"type": "boolean", "default": false}}} |
stylecop.schema.json | indentationSize | Specifies the indentation size. | {"type": "integer", "minimum": 0, "default": 4} |
stylecop.schema.json | tabSize | Specifies the tab width. | {"type": "integer", "minimum": 0, "default": 4} |
stylecop.schema.json | useTabs | Specifies whether indentation should use hard tabs instead of spaces. | {"type": "boolean", "default": false} |
stylecop.schema.json | spacingRules | Configuration for spacing rules (SA1000-) | {"type": "object", "additionalProperties": false, "properties": {}} |
stylecop.schema.json | readabilityRules | Configuration for readability rules (SA1100-) | {"type": "object", "additionalProperties": false, "properties": {"allowBuiltInTypeAliases": {"type": "boolean", "default": false}}} |
stylecop.schema.json | allowBuiltInTypeAliases | When true, diagnostics will not be reported for using aliases of built-in types. | {"type": "boolean", "default": false} |
stylecop.schema.json | orderingRules | Configuration for ordering rules (SA1200-) | {"type": "object", "additionalProperties": false, "properties": {"elementOrder": {"type": "array", "default": ["kind", "accessibility", "constant", "static", "readonly"], "items": {"type": "string", "enum": ["accessibility", "kind", "constant", "static", "readonly"]}, "uniqueItems": true}, "systemUsingDirectivesFirst": {"type": "boolean", "default": true}, "usingDirectivesPlacement": {"type": "string", "enum": ["insideNamespace", "outsideNamespace", "preserve"], "default": "insideNamespace"}, "blankLinesBetweenUsingGroups": {"type": "string", "enum": ["allow", "require", "omit"], "default": "allow"}}} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.