schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
hugo.json | taxonomies | The taxonomy options
https://gohugo.io/content-management/taxonomies#configure-taxonomies | {"type": "object", "default": {"category": "categories", "tag": "tags"}, "properties": {"tag": {"type": "string", "default": "tags", "minLength": 1}, "category": {"type": "string", "default": "categories", "minLength": 1}}, "patternProperties": {"^(?!tag|category)$": {"type": "string", "minLength": 1}}} |
hugo.json | tag | The default taxonomy
https://gohugo.io/content-management/taxonomies#configure-taxonomies | {"type": "string", "default": "tags", "minLength": 1} |
hugo.json | category | The default taxonomy
https://gohugo.io/content-management/taxonomies#configure-taxonomies | {"type": "string", "default": "categories", "minLength": 1} |
hugo.json | ^(?!tag|category)$ | The custom taxonomy
https://gohugo.io/content-management/taxonomies#configure-taxonomies | {"type": "string", "minLength": 1} |
hugo.json | theme | ERROR: type should be string, got "\nhttps://gohugo.io/hugo-modules/configuration/#module-config-imports" | {"type": "string", "minLength": 1} |
hugo.json | themesDir | The directory where themes are stored
https://gohugo.io/getting-started/configuration/#themesdir | {"type": "string", "default": "themes", "minLength": 1} |
hugo.json | timeout | The timeout for generating page contents
https://gohugo.io/getting-started/configuration/#timeout | {"type": "string", "default": "30s", "pattern": "^\\d+s$"} |
hugo.json | timeZone | The time zone
https://gohugo.io/getting-started/configuration/#timezone | {"type": "string", "enum": ["Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmara", "Africa/Asmera", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Timbuktu", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/Buenos_Aires", "America/Argentina/Catamarca", "America/Argentina/ComodRivadavia", "America/Argentina/Cordoba", "America/Argentina/Jujuy", "America/Argentina/La_Rioja", "America/Argentina/Mendoza", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Atikokan", "America/Atka", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Buenos_Aires", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Catamarca", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Coral_Harbour", "America/Cordoba", "America/Costa_Rica", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Ensenada", "America/Fort_Nelson", "America/Fort_Wayne", "America/Fortaleza", "America/Glace_Bay", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Indianapolis", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Jujuy", "America/Juneau", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Knox_IN", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Louisville", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Mendoza", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montreal", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nipigon", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Nuuk", "America/Ojinaga", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Acre", "America/Porto_Velho", "America/Puerto_Rico", "America/Punta_Arenas", "America/Rainy_River", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Rosario", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Shiprock", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Virgin", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/South_Pole", "Antarctica/Syowa", "Antarctica/Troll", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Ashkhabad", "Asia/Atyrau", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Barnaul", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Calcutta", "Asia/Chita", "Asia/Choibalsan", "Asia/Chongqing", "Asia/Chungking", "Asia/Colombo", "Asia/Dacca", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Famagusta", "Asia/Gaza", "Asia/Harbin", "Asia/Hebron", "Asia/Ho_Chi_Minh", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Istanbul", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Katmandu", "Asia/Khandyga", "Asia/Kolkata", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macao", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Asia/Qyzylorda", "Asia/Rangoon", "Asia/Riyadh", "Asia/Saigon", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Srednekolymsk", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Tel_Aviv", "Asia/Thimbu", "Asia/Thimphu", "Asia/Tokyo", "Asia/Tomsk", "Asia/Ujung_Pandang", "Asia/Ulaanbaatar", "Asia/Ulan_Bator", "Asia/Urumqi", "Asia/Ust-Nera", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yangon", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faeroe", "Atlantic/Faroe", "Atlantic/Jan_Mayen", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/ACT", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Canberra", "Australia/Currie", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/LHI", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/North", "Australia/NSW", "Australia/Perth", "Australia/Queensland", "Australia/South", "Australia/Sydney", "Australia/Tasmania", "Australia/Victoria", "Australia/West", "Australia/Yancowinna", "Brazil/Acre", "Brazil/DeNoronha", "Brazil/East", "Brazil/West", "Canada/Atlantic", "Canada/Central", "Canada/Eastern", "Canada/Mountain", "Canada/Newfoundland", "Canada/Pacific", "Canada/Saskatchewan", "Canada/Yukon", "Chile/Continental", "Chile/EasterIsland", "Cuba", "Egypt", "Eire", "Etc/GMT", "Etc/GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT0", "Etc/Greenwich", "Etc/UCT", "Etc/Universal", "Etc/UTC", "Etc/Zulu", "Europe/Amsterdam", "Europe/Andorra", "Europe/Astrakhan", "Europe/Athens", "Europe/Belfast", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Busingen", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Kirov", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Nicosia", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Saratov", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Tiraspol", "Europe/Ulyanovsk", "Europe/Uzhgorod", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zaporozhye", "Europe/Zurich", "GB", "GB-Eire", "Hongkong", "Iceland", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "Iran", "Israel", "Jamaica", "Japan", "Kwajalein", "Libya", "Mexico/BajaNorte", "Mexico/BajaSur", "Mexico/General", "Navajo", "NZ", "NZ-CHAT", "Pacific/Apia", "Pacific/Auckland", "Pacific/Bougainville", "Pacific/Chatham", "Pacific/Chuuk", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Johnston", "Pacific/Kanton", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Pohnpei", "Pacific/Ponape", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Samoa", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Truk", "Pacific/Wake", "Pacific/Wallis", "Pacific/Yap", "Poland", "Portugal", "PRC", "ROC", "Singapore", "US/Alaska", "US/Aleutian", "US/Arizona", "US/Central", "US/East-Indiana", "US/Eastern", "US/Hawaii", "US/Indiana-Starke", "US/Michigan", "US/Mountain", "US/Pacific", "US/Samoa"]} |
hugo.json | title | The site title
https://gohugo.io/getting-started/configuration/#title | {"type": "string"} |
hugo.json | titleCaseStyle | The title case style
https://gohugo.io/getting-started/configuration/#titlecasestyle | {"type": "string", "default": "AP", "enum": ["AP", "Chicago", "Go"]} |
hugo.json | uglyURLs | Enable/disable adding file extensions to urls
https://gohugo.io/getting-started/configuration/#uglyurls | {"type": "boolean"} |
hugo.json | watch | Enable/disable watching filesystem for changes and recreating as needed
https://gohugo.io/getting-started/configuration/#watch | {"type": "boolean", "default": false} |
ui5.yaml.json | Schema for UI5 Tooling Configuration File (ui5.yaml) | {"$schema": "http://json-schema.org/draft-07/schema", "type": "object", "required": ["specVersion"], "properties": {"specVersion": {"enum": ["3.1", "3.0", "2.6", "2.5", "2.4", "2.3", "2.2", "2.1", "2.0", "1.1", "1.0", "0.1"], "errorMessage": "Unsupported \"specVersion\"\nYour UI5 CLI installation might be outdated.\nSupported specification versions: \"3.1\", \"3.0\", \"2.6\", \"2.5\", \"2.4\", \"2.3\", \"2.2\", \"2.1\", \"2.0\", \"1.1\", \"1.0\", \"0.1\"\nFor details, see: https://sap.github.io/ui5-tooling/pages/Configuration/#specification-versions"}}, "if": {"properties": {"specVersion": {"enum": ["3.1", "3.0", "2.6", "2.5", "2.4", "2.3", "2.2", "2.1", "2.0"]}}}, "then": {"type": "object", "required": ["specVersion"], "properties": {"specVersion": {"enum": ["3.1", "3.0", "2.6", "2.5", "2.4", "2.3", "2.2", "2.1", "2.0"]}, "kind": {"enum": ["project", "extension", null]}}, "if": {"properties": {"kind": {"enum": ["project", null]}}}, "then": {"type": "object", "required": ["specVersion", "type"], "properties": {"specVersion": {"enum": ["3.1", "3.0", "2.6", "2.5", "2.4", "2.3", "2.2", "2.1", "2.0"]}, "kind": {"enum": ["project", null]}, "type": {"enum": ["application", "library", "theme-library", "module"]}}, "if": {"properties": {"type": {"const": null}}}, "then": {}, "else": {"if": {"properties": {"type": {"const": "application"}}}, "then": {"type": "object", "required": ["specVersion", "type", "metadata"], "if": {"properties": {"specVersion": {"enum": ["3.0", "3.1"]}}}, "then": {"additionalProperties": false, "properties": {"specVersion": {"enum": ["3.0", "3.1"]}, "kind": {"enum": ["project", null]}, "type": {"enum": ["application"]}, "metadata": {}, "framework": {}, "resources": {}, "builder": {}, "server": {}, "customConfiguration": {"type": "object", "additionalProperties": true}}}, "else": {"if": {"properties": {"specVersion": {"enum": ["2.6"]}}}, "then": {"additionalProperties": false, "properties": {"specVersion": {"enum": ["2.6"]}, "kind": {"enum": ["project", null]}, "type": {"enum": ["application"]}, "metadata": {}, "framework": {}, "resources": {}, "builder": {}, "server": {}, "customConfiguration": {"type": "object", "additionalProperties": true}}}, "else": {"if": {"properties": {"specVersion": {"enum": ["2.5"]}}}, "then": {"additionalProperties": false, "properties": {"specVersion": {"enum": ["2.5"]}, "kind": {"enum": ["project", null]}, "type": {"enum": ["application"]}, "metadata": {}, "framework": {}, "resources": {}, "builder": {}, "server": {}, "customConfiguration": {"type": "object", "additionalProperties": true}}}, "else": {"if": {"properties": {"specVersion": {"enum": ["2.4"]}}}, "then": {"additionalProperties": false, "properties": {"specVersion": {"enum": ["2.4"]}, "kind": {"enum": ["project", null]}, "type": {"enum": ["application"]}, "metadata": {}, "framework": {}, "resources": {}, "builder": {}, "server": {}, "customConfiguration": {"type": "object", "additionalProperties": true}}}, "else": {"if": {"properties": {"specVersion": {"enum": ["2.3"]}}}, "then": {"additionalProperties": false, "properties": {"specVersion": {"enum": ["2.3"]}, "kind": {"enum": ["project", null]}, "type": {"enum": ["application"]}, "metadata": {}, "framework": {}, "resources": {}, "builder": {}, "server": {}, "customConfiguration": {"type": "object", "additionalProperties": true}}}, "else": {"if": {"properties": {"specVersion": {"enum": ["2.1", "2.2"]}}}, "then": {"additionalProperties": false, "properties": {"specVersion": {"enum": ["2.1", "2.2"]}, "kind": {"enum": ["project", null]}, "type": {"enum": ["application"]}, "metadata": {}, "framework": {}, "resources": {}, "builder": {}, "server": {}, "customConfiguration": {"type": "object", "additionalProperties": true}}}, "else": {"additionalProperties": false, "properties": {"specVersion": {"enum": ["2.0"]}, "kind": {"enum": ["project", null]}, "type": {"enum": ["application"]}, "metadata": {}, "framework": {}, "resources": {}, "builder": {}, "server": {}}}}}}}}, "definitions": {"resources": {"type": "object", "additionalProperties": false, "properties": {"configuration": {"type": "object", "additionalProperties": false, "properties": {"propertiesFileSourceEncoding": {}, "paths": {"type": "object", "additionalProperties": false, "properties": {"webapp": {"type": "string"}}}}}}}, "builder": {"type": "object", "additionalProperties": false, "properties": {"resources": {}, "cachebuster": {"type": "object", "additionalProperties": false, "properties": {"signatureType": {"enum": ["time", "hash"]}}}, "bundles": {}, "componentPreload": {}, "customTasks": {}}}, "builder-specVersion-2.3": {"type": "object", "additionalProperties": false, "properties": {"resources": {}, "cachebuster": {"type": "object", "additionalProperties": false, "properties": {"signatureType": {"enum": ["time", "hash"]}}}, "bundles": {}, "componentPreload": {}, "customTasks": {}}}, "builder-specVersion-2.4": {"type": "object", "additionalProperties": false, "properties": {"resources": {}, "cachebuster": {"type": "object", "additionalProperties": false, "properties": {"signatureType": {"enum": ["time", "hash"]}}}, "bundles": {}, "componentPreload": {}, "customTasks": {}}}, "builder-specVersion-2.5": {"type": "object", "additionalProperties": false, "properties": {"resources": {}, "cachebuster": {"type": "object", "additionalProperties": false, "properties": {"signatureType": {"enum": ["time", "hash"]}}}, "bundles": {}, "componentPreload": {}, "customTasks": {}, "settings": {}}}, "builder-specVersion-2.6": {"type": "object", "additionalProperties": false, "properties": {"resources": {}, "cachebuster": {"type": "object", "additionalProperties": false, "properties": {"signatureType": {"enum": ["time", "hash"]}}}, "bundles": {}, "componentPreload": {}, "customTasks": {}, "minification": {}, "settings": {}}}, "builder-specVersion-3.0": {"type": "object", "additionalProperties": false, "properties": {"resources": {}, "cachebuster": {"type": "object", "additionalProperties": false, "properties": {"signatureType": {"enum": ["time", "hash"]}}}, "bundles": {}, "componentPreload": {}, "customTasks": {}, "minification": {}, "settings": {}}}}}, "else": {"if": {"properties": {"type": {"const": "library"}}}, "then": {"type": "object", "required": ["specVersion", "type", "metadata"], "if": {"properties": {"specVersion": {"enum": ["3.0", "3.1"]}}}, "then": {"additionalProperties": false, "properties": {"specVersion": {"enum": ["3.0", "3.1"]}, "kind": {"enum": ["project", null]}, "type": {"enum": ["library"]}, "metadata": {}, "framework": {}, "resources": {}, "builder": {}, "server": {}, "customConfiguration": {"type": "object", "additionalProperties": true}}}, "else": {"if": {"properties": {"specVersion": {"enum": ["2.6"]}}}, "then": {"additionalProperties": false, "properties": {"specVersion": {"enum": ["2.6"]}, "kind": {"enum": ["project", null]}, "type": {"enum": ["library"]}, "metadata": {}, "framework": {}, "resources": {}, "builder": {}, "server": {}, "customConfiguration": {"type": "object", "additionalProperties": true}}}, "else": {"if": {"properties": {"specVersion": {"enum": ["2.5"]}}}, "then": {"additionalProperties": false, "properties": {"specVersion": {"enum": ["2.5"]}, "kind": {"enum": ["project", null]}, "type": {"enum": ["library"]}, "metadata": {}, "framework": {}, "resources": {}, "builder": {}, "server": {}, "customConfiguration": {"type": "object", "additionalProperties": true}}}, "else": {"if": {"properties": {"specVersion": {"enum": ["2.4"]}}}, "then": {"additionalProperties": false, "properties": {"specVersion": {"enum": ["2.4"]}, "kind": {"enum": ["project", null]}, "type": {"enum": ["library"]}, "metadata": {}, "framework": {}, "resources": {}, "builder": {}, "server": {}, "customConfiguration": {"type": "object", "additionalProperties": true}}}, "else": {"if": {"properties": {"specVersion": {"enum": ["2.3"]}}}, "then": {"additionalProperties": false, "properties": {"specVersion": {"enum": ["2.3"]}, "kind": {"enum": ["project", null]}, "type": {"enum": ["library"]}, "metadata": {}, "framework": {}, "resources": {}, "builder": {}, "server": {}, "customConfiguration": {"type": "object", "additionalProperties": true}}}, "else": {"if": {"properties": {"specVersion": {"enum": ["2.1", "2.2"]}}}, "then": {"additionalProperties": false, "properties": {"specVersion": {"enum": ["2.1", "2.2"]}, "kind": {"enum": ["project", null]}, "type": {"enum": ["library"]}, "metadata": {}, "framework": {}, "resources": {}, "builder": {}, "server": {}, "customConfiguration": {"type": "object", "additionalProperties": true}}}, "else": {"additionalProperties": false, "properties": {"specVersion": {"enum": ["2.0"]}, "kind": {"enum": ["project", null]}, "type": {"enum": ["library"]}, "metadata": {}, "framework": {}, "resources": {}, "builder": {}, "server": {}}}}}}}}, "definitions": {"resources": {"type": "object", "additionalProperties": false, "properties": {"configuration": {"type": "object", "additionalProperties": false, "properties": {"propertiesFileSourceEncoding": {}, "paths": {"type": "object", "additionalProperties": false, "properties": {"src": {"type": "string"}, "test": {"type": "string"}}}}}}}, "builder-jsdoc": {"type": "object", "additionalProperties": false, "properties": {"excludes": {"type": "array", "items": {"type": "string"}}}}, "builder": {"type": "object", "additionalProperties": false, "properties": {"resources": {}, "jsdoc": {}, "bundles": {}, "componentPreload": {}, "customTasks": {}}}, "builder-specVersion-2.3": {"type": "object", "additionalProperties": false, "properties": {"resources": {}, "jsdoc": {}, "bundles": {}, "componentPreload": {}, "libraryPreload": {}, "customTasks": {}}}, "builder-specVersion-2.4": {"type": "object", "additionalProperties": false, "properties": {"resources": {}, "jsdoc": {}, "bundles": {}, "componentPreload": {}, "libraryPreload": {}, "customTasks": {}}}, "builder-specVersion-2.5": {"type": "object", "additionalProperties": false, "properties": {"resources": {}, "jsdoc": {}, "bundles": {}, "componentPreload": {}, "libraryPreload": {}, "customTasks": {}, "settings": {}}}, "builder-specVersion-2.6": {"type": "object", "additionalProperties": false, "properties": {"resources": {}, "jsdoc": {}, "bundles": {}, "componentPreload": {}, "libraryPreload": {}, "customTasks": {}, "minification": {}, "settings": {}}}, "builder-specVersion-3.0": {"type": "object", "additionalProperties": false, "properties": {"resources": {}, "jsdoc": {}, "bundles": {}, "componentPreload": {}, "libraryPreload": {}, "customTasks": {}, "minification": {}, "settings": {}}}}}, "else": {"if": {"properties": {"type": {"const": "theme-library"}}}, "then": {"type": "object", "required": ["specVersion", "type", "metadata"], "if": {"properties": {"specVersion": {"enum": ["3.0", "3.1"]}}}, "then": {"additionalProperties": false, "properties": {"specVersion": {"enum": ["3.0", "3.1"]}, "kind": {"enum": ["project", null]}, "type": {"enum": ["theme-library"]}, "metadata": {}, "framework": {}, "resources": {}, "builder": {}, "server": {}, "customConfiguration": {"type": "object", "additionalProperties": true}}}, "else": {"if": {"properties": {"specVersion": {"enum": ["2.5", "2.6"]}}}, "then": {"additionalProperties": false, "properties": {"specVersion": {"enum": ["2.5", "2.6"]}, "kind": {"enum": ["project", null]}, "type": {"enum": ["theme-library"]}, "metadata": {}, "framework": {}, "resources": {}, "builder": {}, "server": {}, "customConfiguration": {"type": "object", "additionalProperties": true}}}, "else": {"if": {"properties": {"specVersion": {"enum": ["2.1", "2.2", "2.3", "2.4"]}}}, "then": {"additionalProperties": false, "properties": {"specVersion": {"enum": ["2.1", "2.2", "2.3", "2.4"]}, "kind": {"enum": ["project", null]}, "type": {"enum": ["theme-library"]}, "metadata": {}, "framework": {}, "resources": {}, "builder": {}, "server": {}, "customConfiguration": {"type": "object", "additionalProperties": true}}}, "else": {"additionalProperties": false, "properties": {"specVersion": {"enum": ["2.0"]}, "kind": {"enum": ["project", null]}, "type": {"enum": ["theme-library"]}, "metadata": {}, "framework": {}, "resources": {}, "builder": {}, "server": {}}}}}, "definitions": {"builder": {"type": "object", "additionalProperties": false, "properties": {"resources": {}, "customTasks": {}}}, "builder-specVersion-2.5": {"type": "object", "additionalProperties": false, "properties": {"resources": {}, "customTasks": {}, "settings": {}}}}}, "else": {"if": {"properties": {"type": {"const": "module"}}}, "then": {"type": "object", "required": ["specVersion", "type", "metadata"], "if": {"properties": {"specVersion": {"enum": ["3.1"]}}}, "then": {"additionalProperties": false, "properties": {"specVersion": {"enum": ["3.1"]}, "kind": {"enum": ["project", null]}, "type": {"enum": ["module"]}, "metadata": {}, "resources": {}, "builder": {}, "server": {}, "customConfiguration": {"type": "object", "additionalProperties": true}}}, "else": {"if": {"properties": {"specVersion": {"enum": ["3.0"]}}}, "then": {"additionalProperties": false, "properties": {"specVersion": {"enum": ["3.0"]}, "kind": {"enum": ["project", null]}, "type": {"enum": ["module"]}, "metadata": {}, "resources": {}, "builder": {}, "server": {}, "customConfiguration": {"type": "object", "additionalProperties": true}}}, "else": {"if": {"properties": {"specVersion": {"enum": ["2.5", "2.6"]}}}, "then": {"additionalProperties": false, "properties": {"specVersion": {"enum": ["2.5", "2.6"]}, "kind": {"enum": ["project", null]}, "type": {"enum": ["module"]}, "metadata": {}, "resources": {}, "builder": {}, "server": {}, "customConfiguration": {"type": "object", "additionalProperties": true}}}, "else": {"if": {"properties": {"specVersion": {"enum": ["2.1", "2.2", "2.3", "2.4"]}}}, "then": {"additionalProperties": false, "properties": {"specVersion": {"enum": ["2.1", "2.2", "2.3", "2.4"]}, "kind": {"enum": ["project", null]}, "type": {"enum": ["module"]}, "metadata": {}, "resources": {}, "customConfiguration": {"type": "object", "additionalProperties": true}}}, "else": {"additionalProperties": false, "properties": {"specVersion": {"enum": ["2.0"]}, "kind": {"enum": ["project", null]}, "type": {"enum": ["module"]}, "metadata": {}, "resources": {}}}}}}, "definitions": {"resources": {"type": "object", "additionalProperties": false, "properties": {"configuration": {"type": "object", "additionalProperties": false, "properties": {"paths": {"type": "object", "additionalProperties": false, "patternProperties": {".+": {"type": "string"}}}}}}}, "builder-specVersion-2.5": {"type": "object", "additionalProperties": false, "properties": {"settings": {}}}, "builder-specVersion-3.1": {"type": "object", "additionalProperties": false, "properties": {"resources": {}, "settings": {}}}}}}}}}, "definitions": {"metadata": {"type": "object", "required": ["name"], "additionalProperties": false, "properties": {"name": {"type": "string"}, "copyright": {"type": "string"}, "deprecated": {"type": "boolean", "default": false}, "sapInternal": {"type": "boolean", "default": false}, "allowSapInternal": {"type": "boolean", "default": false}}}, "metadata-3.0": {"type": "object", "required": ["name"], "additionalProperties": false, "properties": {"name": {"type": "string", "minLength": 3, "maxLength": 80, "pattern": "^(?:@[0-9a-z-_.]+\\/)?[a-z][0-9a-z-_.]*$", "errorMessage": "Not a valid project name. It must consist of lowercase alphanumeric characters, dash, underscore, and period only. Additionally, it may contain an npm-style package scope. For details, see: https://sap.github.io/ui5-tooling/stable/pages/Configuration/#name"}, "copyright": {"type": "string"}, "deprecated": {"type": "boolean", "default": false}, "sapInternal": {"type": "boolean", "default": false}, "allowSapInternal": {"type": "boolean", "default": false}}}, "resources-configuration-propertiesFileSourceEncoding": {"enum": ["UTF-8", "ISO-8859-1"], "default": "UTF-8"}, "builder-resources": {"type": "object", "additionalProperties": false, "properties": {"excludes": {"type": "array", "items": {"type": "string"}}}}, "builder-bundles": {"type": "array", "additionalProperties": false, "items": {"type": "object", "additionalProperties": false, "properties": {"bundleDefinition": {}, "bundleOptions": {}}}}, "builder-bundles-2.4": {"type": "array", "additionalProperties": false, "items": {"type": "object", "additionalProperties": false, "properties": {"bundleDefinition": {}, "bundleOptions": {}}}}, "builder-bundles-3.0": {"type": "array", "additionalProperties": false, "items": {"type": "object", "additionalProperties": false, "properties": {"bundleDefinition": {}, "bundleOptions": {}}}}, "builder-bundles-bundleDefinition": {"type": "object", "additionalProperties": false, "required": ["name"], "properties": {"name": {"type": "string"}, "defaultFileTypes": {"type": "array", "items": {"type": "string"}}, "sections": {"type": "array", "items": {"type": "object", "additionalProperties": false, "required": ["mode", "filters"], "properties": {"name": {"type": "string"}, "mode": {"enum": ["raw", "preload", "require", "provided"]}, "filters": {"type": "array", "items": {"type": "string"}}, "resolve": {"type": "boolean", "default": false}, "resolveConditional": {"type": "boolean", "default": false}, "renderer": {"type": "boolean", "default": false}, "sort": {"type": "boolean", "default": true}, "declareRawModules": {"type": "boolean", "default": false}}}}}}, "builder-bundles-bundleDefinition-2.4": {"type": "object", "additionalProperties": false, "required": ["name"], "properties": {"name": {"type": "string"}, "defaultFileTypes": {"type": "array", "items": {"type": "string"}}, "sections": {"type": "array", "items": {"type": "object", "additionalProperties": false, "required": ["mode", "filters"], "properties": {"name": {"type": "string"}, "mode": {"enum": ["raw", "preload", "require", "provided", "bundleInfo"]}, "filters": {"type": "array", "items": {"type": "string"}}, "resolve": {"type": "boolean", "default": false}, "resolveConditional": {"type": "boolean", "default": false}, "renderer": {"type": "boolean", "default": false}, "sort": {"type": "boolean", "default": true}, "declareRawModules": {"type": "boolean", "default": false}}}}}}, "builder-bundles-bundleOptions": {"type": "object", "additionalProperties": false, "properties": {"optimize": {"type": "boolean", "default": false}, "decorateBootstrapModule": {"type": "boolean", "default": true}, "addTryCatchRestartWrapper": {"type": "boolean", "default": false}, "usePredefineCalls": {"type": "boolean", "default": false}, "numberOfParts": {"type": "number", "default": 1}}}, "builder-bundles-bundleOptions-3.0": {"type": "object", "additionalProperties": false, "properties": {"optimize": {"type": "boolean", "default": true}, "decorateBootstrapModule": {"type": "boolean", "default": true}, "addTryCatchRestartWrapper": {"type": "boolean", "default": false}, "usePredefineCalls": {"type": "boolean", "default": false}, "numberOfParts": {"type": "number", "default": 1}, "sourceMap": {"type": "boolean", "default": true}}}, "builder-componentPreload": {"type": "object", "additionalProperties": false, "properties": {"paths": {"type": "array", "items": {"type": "string"}}, "namespaces": {"type": "array", "items": {"type": "string"}}}}, "builder-componentPreload-specVersion-2.3": {"type": "object", "additionalProperties": false, "properties": {"paths": {"type": "array", "items": {"type": "string"}}, "namespaces": {"type": "array", "items": {"type": "string"}}, "excludes": {"type": "array", "items": {"type": "string"}}}}, "builder-libraryPreload": {"type": "object", "additionalProperties": false, "properties": {"excludes": {"type": "array", "items": {"type": "string"}}}}, "server": {"type": "object", "additionalProperties": false, "properties": {"settings": {"type": "object", "additionalProperties": false, "properties": {"httpPort": {"type": "number"}, "httpsPort": {"type": "number"}}}, "customMiddleware": {"type": "array", "items": {"oneOf": [{"type": "object", "additionalProperties": false, "required": ["name", "beforeMiddleware"], "properties": {"name": {"type": "string"}, "mountPath": {"type": "string"}, "beforeMiddleware": {"type": "string"}, "configuration": {}}}, {"type": "object", "additionalProperties": false, "required": ["name", "afterMiddleware"], "properties": {"name": {"type": "string"}, "mountPath": {"type": "string"}, "afterMiddleware": {"type": "string"}, "configuration": {}}}]}}}}, "framework": {"type": "object", "additionalProperties": false, "required": ["name"], "properties": {"name": {"enum": ["OpenUI5", "SAPUI5"]}, "version": {"type": "string", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$", "errorMessage": "Not a valid version according to the Semantic Versioning specification (https://semver.org/)"}, "libraries": {"type": "array", "items": {"type": "object", "additionalProperties": false, "required": ["name"], "properties": {"name": {"type": "string"}, "optional": {"type": "boolean", "default": false}, "development": {"type": "boolean", "default": false}}, "if": {"not": {"anyOf": [{"properties": {"optional": {"enum": [false, null]}}}, {"properties": {"development": {"enum": [false, null]}}}, {"not": {"properties": {"optional": {"type": "boolean"}}}}, {"not": {"properties": {"development": {"type": "boolean"}}}}]}}, "then": {"additionalProperties": false, "properties": {"name": {"type": "string"}}, "errorMessage": "Either \"development\" or \"optional\" can be true, but not both"}}}}}, "customTasks": {"type": "array", "items": {"oneOf": [{"type": "object", "additionalProperties": false, "required": ["name", "beforeTask"], "properties": {"name": {"type": "string"}, "beforeTask": {"type": "string"}, "configuration": {}}}, {"type": "object", "additionalProperties": false, "required": ["name", "afterTask"], "properties": {"name": {"type": "string"}, "afterTask": {"type": "string"}, "configuration": {}}}]}}, "builder-settings": {"type": "object", "additionalProperties": false, "properties": {"includeDependency": {"type": "array", "items": {"type": "string"}}, "includeDependencyRegExp": {"type": "array", "items": {"type": "string"}}, "includeDependencyTree": {"type": "array", "items": {"type": "string"}}}}, "builder-minification": {"type": "object", "additionalProperties": false, "properties": {"excludes": {"type": "array", "items": {"type": "string"}}}}}}, "else": {"if": {"properties": {"kind": {"enum": ["extension"]}}}, "then": {"type": "object", "required": ["specVersion", "kind", "type", "metadata"], "properties": {"specVersion": {"enum": ["3.1", "3.0", "2.6", "2.5", "2.4", "2.3", "2.2", "2.1", "2.0"]}, "kind": {"enum": ["extension"]}, "type": {"enum": ["task", "server-middleware", "project-shim"]}, "metadata": {}}, "if": {"properties": {"type": {"const": null}}}, "then": {}, "else": {"if": {"properties": {"type": {"const": "task"}}}, "then": {"type": "object", "required": ["specVersion", "kind", "type", "metadata", "task"], "if": {"properties": {"specVersion": {"enum": ["3.0", "3.1"]}}}, "then": {"additionalProperties": false, "properties": {"specVersion": {"enum": ["3.0", "3.1"]}, "kind": {"enum": ["extension"]}, "type": {"enum": ["task"]}, "metadata": {}, "task": {}, "customConfiguration": {"type": "object", "additionalProperties": true}}}, "else": {"if": {"properties": {"specVersion": {"enum": ["2.1", "2.2", "2.3", "2.4", "2.5", "2.6"]}}}, "then": {"additionalProperties": false, "properties": {"specVersion": {"enum": ["2.1", "2.2", "2.3", "2.4", "2.5", "2.6"]}, "kind": {"enum": ["extension"]}, "type": {"enum": ["task"]}, "metadata": {}, "task": {}, "customConfiguration": {"type": "object", "additionalProperties": true}}}, "else": {"additionalProperties": false, "properties": {"specVersion": {"enum": ["2.0"]}, "kind": {"enum": ["extension"]}, "type": {"enum": ["task"]}, "metadata": {}, "task": {}}}}, "definitions": {"task": {"type": "object", "additionalProperties": false, "properties": {"path": {"type": "string"}}}}}, "else": {"if": {"properties": {"type": {"const": "server-middleware"}}}, "then": {"type": "object", "required": ["specVersion", "kind", "type", "metadata", "middleware"], "if": {"properties": {"specVersion": {"enum": ["3.0", "3.1"]}}}, "then": {"additionalProperties": false, "properties": {"specVersion": {"enum": ["3.0", "3.1"]}, "kind": {"enum": ["extension"]}, "type": {"enum": ["server-middleware"]}, "metadata": {}, "middleware": {}, "customConfiguration": {"type": "object", "additionalProperties": true}}}, "else": {"if": {"properties": {"specVersion": {"enum": ["2.1", "2.2", "2.3", "2.4", "2.5", "2.6"]}}}, "then": {"additionalProperties": false, "properties": {"specVersion": {"enum": ["2.1", "2.2", "2.3", "2.4", "2.5", "2.6"]}, "kind": {"enum": ["extension"]}, "type": {"enum": ["server-middleware"]}, "metadata": {}, "middleware": {}, "customConfiguration": {"type": "object", "additionalProperties": true}}}, "else": {"additionalProperties": false, "properties": {"specVersion": {"enum": ["2.0"]}, "kind": {"enum": ["extension"]}, "type": {"enum": ["server-middleware"]}, "metadata": {}, "middleware": {}}}}, "definitions": {"middleware": {"type": "object", "additionalProperties": false, "properties": {"path": {"type": "string"}}}}}, "else": {"if": {"properties": {"type": {"const": "project-shim"}}}, "then": {"type": "object", "required": ["specVersion", "kind", "type", "metadata", "shims"], "if": {"properties": {"specVersion": {"enum": ["3.0", "3.1"]}}}, "then": {"additionalProperties": false, "properties": {"specVersion": {"enum": ["3.0", "3.1"]}, "kind": {"enum": ["extension"]}, "type": {"enum": ["project-shim"]}, "metadata": {}, "shims": {}, "customConfiguration": {"type": "object", "additionalProperties": true}}}, "else": {"if": {"properties": {"specVersion": {"enum": ["2.1", "2.2", "2.3", "2.4", "2.5", "2.6"]}}}, "then": {"additionalProperties": false, "properties": {"specVersion": {"enum": ["2.1", "2.2", "2.3", "2.4", "2.5", "2.6"]}, "kind": {"enum": ["extension"]}, "type": {"enum": ["project-shim"]}, "metadata": {}, "shims": {}, "customConfiguration": {"type": "object", "additionalProperties": true}}}, "else": {"additionalProperties": false, "properties": {"specVersion": {"enum": ["2.0"]}, "kind": {"enum": ["extension"]}, "type": {"enum": ["project-shim"]}, "metadata": {}, "shims": {}}}}, "definitions": {"shims": {"type": "object", "additionalProperties": false, "properties": {"configurations": {"type": "object", "additionalProperties": false, "patternProperties": {".+": {"type": "object"}}}, "dependencies": {"type": "object", "additionalProperties": false, "patternProperties": {".+": {"type": "array", "items": {"type": "string"}}}}, "collections": {"type": "object", "additionalProperties": false, "patternProperties": {".+": {"type": "object", "additionalProperties": false, "properties": {"modules": {"type": "object", "additionalProperties": false, "patternProperties": {".+": {"type": "string"}}}}}}}}}}}}}}, "definitions": {"metadata": {"type": "object", "required": ["name"], "additionalProperties": false, "properties": {"name": {"type": "string"}, "copyright": {"type": "string"}}}, "metadata-3.0": {"type": "object", "required": ["name"], "additionalProperties": false, "properties": {"name": {"type": "string", "minLength": 3, "maxLength": 80, "pattern": "^(?:@[0-9a-z-_.]+\\/)?[a-z][0-9a-z-_.]*$", "errorMessage": "Not a valid extension name. It must consist of lowercase alphanumeric characters, dash, underscore, and period only. Additionally, it may contain an npm-style package scope. For details, see: https://sap.github.io/ui5-tooling/stable/pages/Configuration/#name"}, "copyright": {"type": "string"}}}}}}}, "else": {"if": {"properties": {"specVersion": {"enum": ["1.1", "1.0", "0.1"]}}}, "then": {"additionalProperties": true}}} |
|
ui5.yaml.json | name | Unique identifier for the project, for example: organization.product.project | {"type": "string", "minLength": 3, "maxLength": 80, "pattern": "^(?:@[0-9a-z-_.]+\\/)?[a-z][0-9a-z-_.]*$", "errorMessage": "Not a valid project name. It must consist of lowercase alphanumeric characters, dash, underscore, and period only. Additionally, it may contain an npm-style package scope. For details, see: https://sap.github.io/ui5-tooling/stable/pages/Configuration/#name"} |
ui5.yaml.json | resources-configuration-propertiesFileSourceEncoding | By default, the UI5 Tooling expects *.properties files to be UTF-8 encoded. | {"enum": ["UTF-8", "ISO-8859-1"], "default": "UTF-8"} |
ui5.yaml.json | version | Framework version to use in this project | {"type": "string", "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$", "errorMessage": "Not a valid version according to the Semantic Versioning specification (https://semver.org/)"} |
ui5.yaml.json | name | Unique identifier for the extension, for example: ui5-task-fearless-rock | {"type": "string", "minLength": 3, "maxLength": 80, "pattern": "^(?:@[0-9a-z-_.]+\\/)?[a-z][0-9a-z-_.]*$", "errorMessage": "Not a valid extension name. It must consist of lowercase alphanumeric characters, dash, underscore, and period only. Additionally, it may contain an npm-style package scope. For details, see: https://sap.github.io/ui5-tooling/stable/pages/Configuration/#name"} |
jsdoc-1.0.0.json | plugins | Enables plugins for JSDoc | {"type": "array", "default": [], "examples": [["plugins/markdown", "plugins/summarize"]]} |
jsdoc-1.0.0.json | recurseDepth | Controls recursion depth for source files and tutorials | {"type": "integer", "default": 10} |
jsdoc-1.0.0.json | source | Determines the set of input files | {"type": "object", "properties": {"include": {"examples": [["myProject/a.js", "myProject/lib", "myProject/_private"]], "type": "array"}, "exclude": {"examples": [["myProject/lib/ignore.js"]], "type": "array"}, "includePattern": {"type": "string", "default": ".+\\.js(doc|x)?$"}, "excludePattern": {"type": "string", "default": "(^|\\/|\\\\)_"}}, "additionalProperties": false} |
jsdoc-1.0.0.json | include | An array of paths to input files | {"examples": [["myProject/a.js", "myProject/lib", "myProject/_private"]], "type": "array"} |
jsdoc-1.0.0.json | exclude | An array of paths to exclude from input | {"examples": [["myProject/lib/ignore.js"]], "type": "array"} |
jsdoc-1.0.0.json | includePattern | Forces input filenames to match regular expression | {"type": "string", "default": ".+\\.js(doc|x)?$"} |
jsdoc-1.0.0.json | excludePattern | Forces input filenames to match regular expression | {"type": "string", "default": "(^|\\/|\\\\)_"} |
jsdoc-1.0.0.json | sourceType | Determines how input files are parsed | {"type": "string", "enum": ["module", "script"], "default": "module"} |
jsdoc-1.0.0.json | opts | Determines flags that `jsdoc` command will be invoked with | {"type": "object", "additionalProperties": false, "properties": {"access": {"default": "all", "enum": ["all", "private", "protected", "public", "undefined"], "type": "string"}, "debug": {"type": "boolean"}, "destination": {"default": "./out/", "type": "string"}, "encoding": {"default": "utf8", "type": "string"}, "package": {"type": "string"}, "pedantic": {"default": false, "type": "boolean"}, "readme": {"type": "string"}, "recurse": {"default": false, "type": "boolean"}, "template": {"default": "templates/default", "type": "string"}, "test": {"default": false, "type": "boolean"}, "tutorials": {"examples": ["path/to/tutorials", "./docs/tutorials"], "type": "string"}}} |
jsdoc-1.0.0.json | access | Only display symbols with the given `access` property | {"default": "all", "enum": ["all", "private", "protected", "public", "undefined"], "type": "string"} |
jsdoc-1.0.0.json | debug | Log information that can help debug issues in JSDoc itself | {"type": "boolean"} |
jsdoc-1.0.0.json | destination | The path to the output folder for the generated documentation | {"default": "./out/", "type": "string"} |
jsdoc-1.0.0.json | encoding | Assume this encoding when reading all source files | {"default": "utf8", "type": "string"} |
jsdoc-1.0.0.json | package | The `package.json` file that contains the project name, version, and other details | {"type": "string"} |
jsdoc-1.0.0.json | pedantic | Treat errors as fatal errors, and treat warnings as errors | {"default": false, "type": "boolean"} |
jsdoc-1.0.0.json | readme | The README.md file to include in the generated documentation | {"type": "string"} |
jsdoc-1.0.0.json | recurse | Recurses to subdirectories when searching input files | {"default": false, "type": "boolean"} |
jsdoc-1.0.0.json | template | The path to the template to use for generating output | {"default": "templates/default", "type": "string"} |
jsdoc-1.0.0.json | test | Run JSDoc's test suite, and print the results to the console | {"default": false, "type": "boolean"} |
jsdoc-1.0.0.json | tutorials | Directory in which JSDoc should search for tutorials | {"examples": ["path/to/tutorials", "./docs/tutorials"], "type": "string"} |
jsdoc-1.0.0.json | tags | Controls allowed JSDoc tags and their interpretation | {"additionalProperties": false, "properties": {"allowUnknownTags": {"default": true, "items": {"type": "string"}, "type": ["boolean", "array"], "uniqueItems": true}, "dictionaries": {"items": {"default": ["jsdoc", "closure"], "enum": ["jsdoc", "closure"], "type": "string"}, "type": "array"}}, "type": "object"} |
jsdoc-1.0.0.json | allowUnknownTags | Determines how to handle unrecognized tags | {"default": true, "items": {"type": "string"}, "type": ["boolean", "array"], "uniqueItems": true} |
jsdoc-1.0.0.json | dictionaries | Controls which tags JSDoc recognizes and how they are interpreted | {"items": {"default": ["jsdoc", "closure"], "enum": ["jsdoc", "closure"], "type": "string"}, "type": "array"} |
jsdoc-1.0.0.json | templates | Affects the appearance and content of generated documentation | {"properties": {"cleverLinks": {"default": false, "type": "boolean"}, "default": {"properties": {"includeDate": {"default": true, "type": "boolean"}, "layoutFile": {"default": "layout.tmpl", "type": "string"}, "outputSourceFiles": {"default": true, "type": "boolean"}, "staticFiles": {"additionalProperties": false, "properties": {"exclude": {"items": {"type": "string"}, "type": "array"}, "excludePattern": {"type": "string"}, "include": {"items": {"type": "string"}, "type": "array"}, "includePattern": {"type": "string"}}, "type": "object"}, "useLongnameInNav": {"default": false, "type": "boolean"}}}, "monospaceLinks": {"default": false, "type": "boolean"}}, "type": "object"} |
jsdoc-1.0.0.json | cleverLinks | Controls @link tag text rendering | {"default": false, "type": "boolean"} |
jsdoc-1.0.0.json | includeDate | Controls if current date is displayed in the footer of documentation | {"default": true, "type": "boolean"} |
jsdoc-1.0.0.json | layoutFile | Path to layout file to use for documentation template | {"default": "layout.tmpl", "type": "string"} |
jsdoc-1.0.0.json | outputSourceFiles | Disables pretty-printed source files | {"default": true, "type": "boolean"} |
jsdoc-1.0.0.json | exclude | An array of paths that should not be copied to the output directory | {"items": {"type": "string"}, "type": "array"} |
jsdoc-1.0.0.json | excludePattern | A regular expression indicating which files to skip | {"type": "string"} |
jsdoc-1.0.0.json | include | An array of paths whose contents should be copied to the output directory | {"items": {"type": "string"}, "type": "array"} |
jsdoc-1.0.0.json | includePattern | A regular expression indicating which files to copy | {"type": "string"} |
jsdoc-1.0.0.json | useLongnameInNav | Controls if shortened or longhand version of a symbol will be shown in documentation | {"default": false, "type": "boolean"} |
jsdoc-1.0.0.json | monospaceLinks | Controls @link tag text rendering | {"default": false, "type": "boolean"} |
2021-07.json | Root Schema of options for Cloudtoid GatewayCore | {"$schema": "http://json-schema.org/draft-04/schema", "id": "https://json.schemastore.org/gatewaycore-options-2021-07", "type": "object", "additionalProperties": false, "properties": {"system": {"type": "object", "additionalProperties": false, "properties": {"routeCacheMaxCount": {"type": "integer", "default": 100000}}}, "routes": {"type": "object", "additionalProperties": {"type": "object", "additionalProperties": false, "properties": {"proxy": {"type": "object", "additionalProperties": false, "properties": {"to": {"type": "string", "examples": ["http://example.com:85/api/"]}, "proxyName": {"type": "string", "default": "gwcore"}, "upstreamRequest": {"type": "object", "additionalProperties": false, "properties": {"httpVersion": {"type": "string", "default": "HTTP/2.0"}, "headers": {"type": "object", "additionalProperties": false, "properties": {"discardInboundHeaders": {"type": "boolean", "default": false}, "discardEmpty": {"type": "boolean", "default": false}, "discardUnderscore": {"type": "boolean", "default": false}, "addExternalAddress": {"type": "boolean", "default": false}, "skipVia": {"type": "boolean", "default": false}, "skipForwarded": {"type": "boolean", "default": false}, "appends": {"type": "object", "additionalProperties": {"type": "array", "items": {"type": "string"}}}, "overrides": {"type": "object", "additionalProperties": {"type": "array", "items": {"type": "string"}}}, "discards": {"type": "array", "items": {"type": "string"}}}}, "sender": {"type": "object", "additionalProperties": false, "properties": {"httpClientName": {"type": "string"}, "timeoutInMilliseconds": {"type": ["string", "integer"], "default": 240000}, "connectTimeoutInMilliseconds": {"type": "integer"}, "expect100ContinueTimeoutInMilliseconds": {"type": "integer", "default": 1000}, "pooledConnectionIdleTimeoutInMilliseconds": {"type": "integer", "default": 2000}, "pooledConnectionLifetimeInMilliseconds": {"type": "integer"}, "responseDrainTimeoutInMilliseconds": {"type": "integer", "default": 2000}, "maxAutomaticRedirections": {"type": "integer", "default": 50}, "maxConnectionsPerServer": {"type": "integer"}, "maxResponseDrainSizeInBytes": {"type": "integer", "default": 1048576}, "maxResponseHeadersLengthInKilobytes": {"type": "integer", "default": 64}, "allowAutoRedirect": {"type": "boolean", "default": false}, "useCookies": {"type": "boolean", "default": false}}}}}, "downstreamResponse": {"type": "object", "additionalProperties": false, "properties": {"headers": {"type": "object", "additionalProperties": false, "properties": {"discardInboundHeaders": {"type": "boolean", "default": false}, "discardEmpty": {"type": "boolean", "default": false}, "discardUnderscore": {"type": "boolean", "default": false}, "addServer": {"type": "boolean", "default": false}, "addVia": {"type": "boolean", "default": false}, "cookies": {"type": "object", "additionalProperties": {"type": "object", "properties": {"secure": {"type": "boolean", "default": false}, "httpOnly": {"type": "boolean", "default": false}, "sameSite": {"type": "string", "enum": ["none", "lax", "strict"], "default": "lax"}, "domain": {"type": "string", "examples": ["example.com"]}}}}, "appends": {"type": "object", "additionalProperties": {"type": "array", "items": {"type": "string"}}}, "overrides": {"type": "object", "additionalProperties": {"type": "array", "items": {"type": "string"}}}, "discards": {"type": "array", "items": {"type": "string"}}}}}}}, "required": ["to"]}}}}}} |
|
2021-07.json | system | This section that contains all system wide configurations. | {"type": "object", "additionalProperties": false, "properties": {"routeCacheMaxCount": {"type": "integer", "default": 100000}}} |
2021-07.json | routeCacheMaxCount | The maximum number of mappings between "inbound downstream request path" and "outbound upstream request URL" that can be cached in memory. | {"type": "integer", "default": 100000} |
2021-07.json | routes | This is the section in which proxy routes are defined. | {"type": "object", "additionalProperties": {"type": "object", "additionalProperties": false, "properties": {"proxy": {"type": "object", "additionalProperties": false, "properties": {"to": {"type": "string", "examples": ["http://example.com:85/api/"]}, "proxyName": {"type": "string", "default": "gwcore"}, "upstreamRequest": {"type": "object", "additionalProperties": false, "properties": {"httpVersion": {"type": "string", "default": "HTTP/2.0"}, "headers": {"type": "object", "additionalProperties": false, "properties": {"discardInboundHeaders": {"type": "boolean", "default": false}, "discardEmpty": {"type": "boolean", "default": false}, "discardUnderscore": {"type": "boolean", "default": false}, "addExternalAddress": {"type": "boolean", "default": false}, "skipVia": {"type": "boolean", "default": false}, "skipForwarded": {"type": "boolean", "default": false}, "appends": {"type": "object", "additionalProperties": {"type": "array", "items": {"type": "string"}}}, "overrides": {"type": "object", "additionalProperties": {"type": "array", "items": {"type": "string"}}}, "discards": {"type": "array", "items": {"type": "string"}}}}, "sender": {"type": "object", "additionalProperties": false, "properties": {"httpClientName": {"type": "string"}, "timeoutInMilliseconds": {"type": ["string", "integer"], "default": 240000}, "connectTimeoutInMilliseconds": {"type": "integer"}, "expect100ContinueTimeoutInMilliseconds": {"type": "integer", "default": 1000}, "pooledConnectionIdleTimeoutInMilliseconds": {"type": "integer", "default": 2000}, "pooledConnectionLifetimeInMilliseconds": {"type": "integer"}, "responseDrainTimeoutInMilliseconds": {"type": "integer", "default": 2000}, "maxAutomaticRedirections": {"type": "integer", "default": 50}, "maxConnectionsPerServer": {"type": "integer"}, "maxResponseDrainSizeInBytes": {"type": "integer", "default": 1048576}, "maxResponseHeadersLengthInKilobytes": {"type": "integer", "default": 64}, "allowAutoRedirect": {"type": "boolean", "default": false}, "useCookies": {"type": "boolean", "default": false}}}}}, "downstreamResponse": {"type": "object", "additionalProperties": false, "properties": {"headers": {"type": "object", "additionalProperties": false, "properties": {"discardInboundHeaders": {"type": "boolean", "default": false}, "discardEmpty": {"type": "boolean", "default": false}, "discardUnderscore": {"type": "boolean", "default": false}, "addServer": {"type": "boolean", "default": false}, "addVia": {"type": "boolean", "default": false}, "cookies": {"type": "object", "additionalProperties": {"type": "object", "properties": {"secure": {"type": "boolean", "default": false}, "httpOnly": {"type": "boolean", "default": false}, "sameSite": {"type": "string", "enum": ["none", "lax", "strict"], "default": "lax"}, "domain": {"type": "string", "examples": ["example.com"]}}}}, "appends": {"type": "object", "additionalProperties": {"type": "array", "items": {"type": "string"}}}, "overrides": {"type": "object", "additionalProperties": {"type": "array", "items": {"type": "string"}}}, "discards": {"type": "array", "items": {"type": "string"}}}}}}}, "required": ["to"]}}}} |
2021-07.json | additionalProperties | This is the url path pattern that if matched, the request is proxied to the address defined by its `to` property. | {"type": "object", "additionalProperties": false, "properties": {"proxy": {"type": "object", "additionalProperties": false, "properties": {"to": {"type": "string", "examples": ["http://example.com:85/api/"]}, "proxyName": {"type": "string", "default": "gwcore"}, "upstreamRequest": {"type": "object", "additionalProperties": false, "properties": {"httpVersion": {"type": "string", "default": "HTTP/2.0"}, "headers": {"type": "object", "additionalProperties": false, "properties": {"discardInboundHeaders": {"type": "boolean", "default": false}, "discardEmpty": {"type": "boolean", "default": false}, "discardUnderscore": {"type": "boolean", "default": false}, "addExternalAddress": {"type": "boolean", "default": false}, "skipVia": {"type": "boolean", "default": false}, "skipForwarded": {"type": "boolean", "default": false}, "appends": {"type": "object", "additionalProperties": {"type": "array", "items": {"type": "string"}}}, "overrides": {"type": "object", "additionalProperties": {"type": "array", "items": {"type": "string"}}}, "discards": {"type": "array", "items": {"type": "string"}}}}, "sender": {"type": "object", "additionalProperties": false, "properties": {"httpClientName": {"type": "string"}, "timeoutInMilliseconds": {"type": ["string", "integer"], "default": 240000}, "connectTimeoutInMilliseconds": {"type": "integer"}, "expect100ContinueTimeoutInMilliseconds": {"type": "integer", "default": 1000}, "pooledConnectionIdleTimeoutInMilliseconds": {"type": "integer", "default": 2000}, "pooledConnectionLifetimeInMilliseconds": {"type": "integer"}, "responseDrainTimeoutInMilliseconds": {"type": "integer", "default": 2000}, "maxAutomaticRedirections": {"type": "integer", "default": 50}, "maxConnectionsPerServer": {"type": "integer"}, "maxResponseDrainSizeInBytes": {"type": "integer", "default": 1048576}, "maxResponseHeadersLengthInKilobytes": {"type": "integer", "default": 64}, "allowAutoRedirect": {"type": "boolean", "default": false}, "useCookies": {"type": "boolean", "default": false}}}}}, "downstreamResponse": {"type": "object", "additionalProperties": false, "properties": {"headers": {"type": "object", "additionalProperties": false, "properties": {"discardInboundHeaders": {"type": "boolean", "default": false}, "discardEmpty": {"type": "boolean", "default": false}, "discardUnderscore": {"type": "boolean", "default": false}, "addServer": {"type": "boolean", "default": false}, "addVia": {"type": "boolean", "default": false}, "cookies": {"type": "object", "additionalProperties": {"type": "object", "properties": {"secure": {"type": "boolean", "default": false}, "httpOnly": {"type": "boolean", "default": false}, "sameSite": {"type": "string", "enum": ["none", "lax", "strict"], "default": "lax"}, "domain": {"type": "string", "examples": ["example.com"]}}}}, "appends": {"type": "object", "additionalProperties": {"type": "array", "items": {"type": "string"}}}, "overrides": {"type": "object", "additionalProperties": {"type": "array", "items": {"type": "string"}}}, "discards": {"type": "array", "items": {"type": "string"}}}}}}}, "required": ["to"]}}} |
2021-07.json | proxy | The proxy configuration. | {"type": "object", "additionalProperties": false, "properties": {"to": {"type": "string", "examples": ["http://example.com:85/api/"]}, "proxyName": {"type": "string", "default": "gwcore"}, "upstreamRequest": {"type": "object", "additionalProperties": false, "properties": {"httpVersion": {"type": "string", "default": "HTTP/2.0"}, "headers": {"type": "object", "additionalProperties": false, "properties": {"discardInboundHeaders": {"type": "boolean", "default": false}, "discardEmpty": {"type": "boolean", "default": false}, "discardUnderscore": {"type": "boolean", "default": false}, "addExternalAddress": {"type": "boolean", "default": false}, "skipVia": {"type": "boolean", "default": false}, "skipForwarded": {"type": "boolean", "default": false}, "appends": {"type": "object", "additionalProperties": {"type": "array", "items": {"type": "string"}}}, "overrides": {"type": "object", "additionalProperties": {"type": "array", "items": {"type": "string"}}}, "discards": {"type": "array", "items": {"type": "string"}}}}, "sender": {"type": "object", "additionalProperties": false, "properties": {"httpClientName": {"type": "string"}, "timeoutInMilliseconds": {"type": ["string", "integer"], "default": 240000}, "connectTimeoutInMilliseconds": {"type": "integer"}, "expect100ContinueTimeoutInMilliseconds": {"type": "integer", "default": 1000}, "pooledConnectionIdleTimeoutInMilliseconds": {"type": "integer", "default": 2000}, "pooledConnectionLifetimeInMilliseconds": {"type": "integer"}, "responseDrainTimeoutInMilliseconds": {"type": "integer", "default": 2000}, "maxAutomaticRedirections": {"type": "integer", "default": 50}, "maxConnectionsPerServer": {"type": "integer"}, "maxResponseDrainSizeInBytes": {"type": "integer", "default": 1048576}, "maxResponseHeadersLengthInKilobytes": {"type": "integer", "default": 64}, "allowAutoRedirect": {"type": "boolean", "default": false}, "useCookies": {"type": "boolean", "default": false}}}}}, "downstreamResponse": {"type": "object", "additionalProperties": false, "properties": {"headers": {"type": "object", "additionalProperties": false, "properties": {"discardInboundHeaders": {"type": "boolean", "default": false}, "discardEmpty": {"type": "boolean", "default": false}, "discardUnderscore": {"type": "boolean", "default": false}, "addServer": {"type": "boolean", "default": false}, "addVia": {"type": "boolean", "default": false}, "cookies": {"type": "object", "additionalProperties": {"type": "object", "properties": {"secure": {"type": "boolean", "default": false}, "httpOnly": {"type": "boolean", "default": false}, "sameSite": {"type": "string", "enum": ["none", "lax", "strict"], "default": "lax"}, "domain": {"type": "string", "examples": ["example.com"]}}}}, "appends": {"type": "object", "additionalProperties": {"type": "array", "items": {"type": "string"}}}, "overrides": {"type": "object", "additionalProperties": {"type": "array", "items": {"type": "string"}}}, "discards": {"type": "array", "items": {"type": "string"}}}}}}}, "required": ["to"]} |
2021-07.json | to | This is an expression that defines the URL of the upstream server to which the downstream request is forwarded to. | {"type": "string", "examples": ["http://example.com:85/api/"]} |
2021-07.json | proxyName | This is an expression that defines the name of this proxy. This value is used in the Via HTTP header send on the outbound upstream request, and the outbound downstream response. If a value is specified, an `x-gwcore-proxy-name` header with this value is also added to the outbound upstream request. | {"type": "string", "default": "gwcore"} |
2021-07.json | upstreamRequest | The options that control the upstream requests. | {"type": "object", "additionalProperties": false, "properties": {"httpVersion": {"type": "string", "default": "HTTP/2.0"}, "headers": {"type": "object", "additionalProperties": false, "properties": {"discardInboundHeaders": {"type": "boolean", "default": false}, "discardEmpty": {"type": "boolean", "default": false}, "discardUnderscore": {"type": "boolean", "default": false}, "addExternalAddress": {"type": "boolean", "default": false}, "skipVia": {"type": "boolean", "default": false}, "skipForwarded": {"type": "boolean", "default": false}, "appends": {"type": "object", "additionalProperties": {"type": "array", "items": {"type": "string"}}}, "overrides": {"type": "object", "additionalProperties": {"type": "array", "items": {"type": "string"}}}, "discards": {"type": "array", "items": {"type": "string"}}}}, "sender": {"type": "object", "additionalProperties": false, "properties": {"httpClientName": {"type": "string"}, "timeoutInMilliseconds": {"type": ["string", "integer"], "default": 240000}, "connectTimeoutInMilliseconds": {"type": "integer"}, "expect100ContinueTimeoutInMilliseconds": {"type": "integer", "default": 1000}, "pooledConnectionIdleTimeoutInMilliseconds": {"type": "integer", "default": 2000}, "pooledConnectionLifetimeInMilliseconds": {"type": "integer"}, "responseDrainTimeoutInMilliseconds": {"type": "integer", "default": 2000}, "maxAutomaticRedirections": {"type": "integer", "default": 50}, "maxConnectionsPerServer": {"type": "integer"}, "maxResponseDrainSizeInBytes": {"type": "integer", "default": 1048576}, "maxResponseHeadersLengthInKilobytes": {"type": "integer", "default": 64}, "allowAutoRedirect": {"type": "boolean", "default": false}, "useCookies": {"type": "boolean", "default": false}}}}} |
2021-07.json | httpVersion | An expression that defines the HTTP protocol version of outbound upstream requests. | {"type": "string", "default": "HTTP/2.0"} |
2021-07.json | headers | The options that control the upstream request headers. | {"type": "object", "additionalProperties": false, "properties": {"discardInboundHeaders": {"type": "boolean", "default": false}, "discardEmpty": {"type": "boolean", "default": false}, "discardUnderscore": {"type": "boolean", "default": false}, "addExternalAddress": {"type": "boolean", "default": false}, "skipVia": {"type": "boolean", "default": false}, "skipForwarded": {"type": "boolean", "default": false}, "appends": {"type": "object", "additionalProperties": {"type": "array", "items": {"type": "string"}}}, "overrides": {"type": "object", "additionalProperties": {"type": "array", "items": {"type": "string"}}}, "discards": {"type": "array", "items": {"type": "string"}}}} |
2021-07.json | discardInboundHeaders | Specifies if downstream inbound request and content headers should be discarded and not forwarded to the upstream. | {"type": "boolean", "default": false} |
2021-07.json | discardEmpty | Specifies if inbound headers with empty value should be discarded. | {"type": "boolean", "default": false} |
2021-07.json | discardUnderscore | Specifies if inbound headers with an underscore in their name should be discarded. | {"type": "boolean", "default": false} |
2021-07.json | addExternalAddress | Specifies if a `x-gwcore-external-address` header with the IP address of the immediate caller should be added to the outbound upstream request. | {"type": "boolean", "default": false} |
2021-07.json | skipVia | Specifies if the `via` header should be skipped from the outbound request. | {"type": "boolean", "default": false} |
2021-07.json | skipForwarded | Specifies if `forwarded` header and `x-forwarded-*` headers should be skipped from the outbound requests. | {"type": "boolean", "default": false} |
2021-07.json | appends | The headers to be appended to the outbound upstream requests. If the header already exists, it is kept and the new value is appended. The value can be either text or an expression. | {"type": "object", "additionalProperties": {"type": "array", "items": {"type": "string"}}} |
2021-07.json | items | The value can be either text or an expression. | {"type": "string"} |
2021-07.json | overrides | The headers to be added to the outbound upstream requests. If the header already exists, its value is replaced. The value can be either text or an expression. | {"type": "object", "additionalProperties": {"type": "array", "items": {"type": "string"}}} |
2021-07.json | items | The value can be either text or an expression. | {"type": "string"} |
2021-07.json | items | Specifies the inbound downstream headers that should be discarded. | {"type": "string"} |
2021-07.json | sender | The options that control connection to the upstream server. | {"type": "object", "additionalProperties": false, "properties": {"httpClientName": {"type": "string"}, "timeoutInMilliseconds": {"type": ["string", "integer"], "default": 240000}, "connectTimeoutInMilliseconds": {"type": "integer"}, "expect100ContinueTimeoutInMilliseconds": {"type": "integer", "default": 1000}, "pooledConnectionIdleTimeoutInMilliseconds": {"type": "integer", "default": 2000}, "pooledConnectionLifetimeInMilliseconds": {"type": "integer"}, "responseDrainTimeoutInMilliseconds": {"type": "integer", "default": 2000}, "maxAutomaticRedirections": {"type": "integer", "default": 50}, "maxConnectionsPerServer": {"type": "integer"}, "maxResponseDrainSizeInBytes": {"type": "integer", "default": 1048576}, "maxResponseHeadersLengthInKilobytes": {"type": "integer", "default": 64}, "allowAutoRedirect": {"type": "boolean", "default": false}, "useCookies": {"type": "boolean", "default": false}}} |
2021-07.json | httpClientName | The name of the .NET HttpClient that will be used to send the request. The default value is a system generated unique name. | {"type": "string"} |
2021-07.json | timeoutInMilliseconds | The total timeout in milliseconds to wait for the outbound upstream request to complete. This can be a number or an expression. | {"type": ["string", "integer"], "default": 240000} |
2021-07.json | connectTimeoutInMilliseconds | The connect timeout in milliseconds. No timeout is set by default. | {"type": "integer"} |
2021-07.json | expect100ContinueTimeoutInMilliseconds | The expect 100 continue timeout in milliseconds. | {"type": "integer", "default": 1000} |
2021-07.json | pooledConnectionIdleTimeoutInMilliseconds | Specifies how long a connection can be idle in the pool to be considered reusable. | {"type": "integer", "default": 2000} |
2021-07.json | pooledConnectionLifetimeInMilliseconds | Specifies how long a connection can live in the connection pool. By default, no timeout is set and the connection can stay in the pool. | {"type": "integer"} |
2021-07.json | responseDrainTimeoutInMilliseconds | Specifies the response drain timeout. | {"type": "integer", "default": 2000} |
2021-07.json | maxAutomaticRedirections | The maximum number of allowed HTTP redirects. | {"type": "integer", "default": 50} |
2021-07.json | maxConnectionsPerServer | The maximum number of simultaneous TCP connections allowed to a single server. No caps are set by default. | {"type": "integer"} |
2021-07.json | maxResponseDrainSizeInBytes | The maximum size of data that can be drained from responses in bytes. | {"type": "integer", "default": 1048576} |
2021-07.json | maxResponseHeadersLengthInKilobytes | The maximum length, in kilobytes (1024 bytes), of the response headers. | {"type": "integer", "default": 64} |
2021-07.json | allowAutoRedirect | Indicates whether the HTTP handler used by the outbound upstream request sender should follow redirection responses. | {"type": "boolean", "default": false} |
2021-07.json | useCookies | Indicates whether the HTTP handler used by the outbound upstream request sender should store server cookies and use these cookies when sending requests. | {"type": "boolean", "default": false} |
2021-07.json | downstreamResponse | The options that control the downstream responses sent to the clients. | {"type": "object", "additionalProperties": false, "properties": {"headers": {"type": "object", "additionalProperties": false, "properties": {"discardInboundHeaders": {"type": "boolean", "default": false}, "discardEmpty": {"type": "boolean", "default": false}, "discardUnderscore": {"type": "boolean", "default": false}, "addServer": {"type": "boolean", "default": false}, "addVia": {"type": "boolean", "default": false}, "cookies": {"type": "object", "additionalProperties": {"type": "object", "properties": {"secure": {"type": "boolean", "default": false}, "httpOnly": {"type": "boolean", "default": false}, "sameSite": {"type": "string", "enum": ["none", "lax", "strict"], "default": "lax"}, "domain": {"type": "string", "examples": ["example.com"]}}}}, "appends": {"type": "object", "additionalProperties": {"type": "array", "items": {"type": "string"}}}, "overrides": {"type": "object", "additionalProperties": {"type": "array", "items": {"type": "string"}}}, "discards": {"type": "array", "items": {"type": "string"}}}}}} |
2021-07.json | headers | The options that control the downstream response headers sent to the clients. | {"type": "object", "additionalProperties": false, "properties": {"discardInboundHeaders": {"type": "boolean", "default": false}, "discardEmpty": {"type": "boolean", "default": false}, "discardUnderscore": {"type": "boolean", "default": false}, "addServer": {"type": "boolean", "default": false}, "addVia": {"type": "boolean", "default": false}, "cookies": {"type": "object", "additionalProperties": {"type": "object", "properties": {"secure": {"type": "boolean", "default": false}, "httpOnly": {"type": "boolean", "default": false}, "sameSite": {"type": "string", "enum": ["none", "lax", "strict"], "default": "lax"}, "domain": {"type": "string", "examples": ["example.com"]}}}}, "appends": {"type": "object", "additionalProperties": {"type": "array", "items": {"type": "string"}}}, "overrides": {"type": "object", "additionalProperties": {"type": "array", "items": {"type": "string"}}}, "discards": {"type": "array", "items": {"type": "string"}}}} |
2021-07.json | discardInboundHeaders | Specifies if upstream inbound response, content, and trailing headers should be discarded and not forwarded to the downstream client. | {"type": "boolean", "default": false} |
2021-07.json | discardEmpty | Specifies if inbound headers with empty value should be discarded. | {"type": "boolean", "default": false} |
2021-07.json | discardUnderscore | Specifies if inbound headers with an underscore in their name should be discarded. | {"type": "boolean", "default": false} |
2021-07.json | addServer | Specifies if a `server` header should be added. The value of this header is set to `gwcore`. | {"type": "boolean", "default": false} |
2021-07.json | addVia | Specifies if the `via` header should be added to the outbound response. | {"type": "boolean", "default": false} |
2021-07.json | cookies | The options that are applied to the `set-cookie` headers in the inbound upstream response. If the cookie name is symbol '*', then the settings are applied to all `set-cookie` headers. | {"type": "object", "additionalProperties": {"type": "object", "properties": {"secure": {"type": "boolean", "default": false}, "httpOnly": {"type": "boolean", "default": false}, "sameSite": {"type": "string", "enum": ["none", "lax", "strict"], "default": "lax"}, "domain": {"type": "string", "examples": ["example.com"]}}}} |
2021-07.json | secure | It limits the scope of the cookie to 'secure' channels. A secure cookie is only sent to the server when a request is made using HTTPS. | {"type": "boolean", "default": false} |
2021-07.json | httpOnly | It limits the scope of the cookie to HTTP requests, forbidding JavaScript from accessing the cookie. | {"type": "boolean", "default": false} |
2021-07.json | sameSite | It asserts that a cookie must not be sent with cross-origin requests, providing some protection against cross-site request forgery attacks. The valid values are `strict`, `lax`, and `none`. | {"type": "string", "enum": ["none", "lax", "strict"], "default": "lax"} |
2021-07.json | domain | It specifies the hosts to which the cookie will be sent and can be an expression. For example, if the value of the Domain attribute is 'example.com', the user agent will include the cookie in the Cookie header when making HTTP requests to example.com, www.example.com, and www.corp.example.com. Use this property to specify or override the domain attribute. Set this value to an empty string ("") to remove the domain attribute from the cookie. | {"type": "string", "examples": ["example.com"]} |
2021-07.json | appends | The headers to be appended to the outbound downstream response. If the header already exists, it is kept and the new value is appended. The value can be either text or an expression. | {"type": "object", "additionalProperties": {"type": "array", "items": {"type": "string"}}} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.