schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
openfin.json | preloadScripts | An array of scripts to download and run before other scripts in the page. | {"type": "array", "items": {"required": ["url"], "properties": {"url": {"type": "string"}}}} |
openfin.json | url | URL from which to fetch the script. | {"type": "string"} |
openfin.json | resizable | A flag to drop to allow the user to resize the window. | {"type": "boolean", "default": true} |
openfin.json | resizeRegion | Define the attributes of the window's resize region. | {"additionalProperties": false, "properties": {"bottomRightCorner": {"type": "number", "default": 4}, "size": {"type": "number", "default": 2}}} |
openfin.json | bottomRightCorner | Defines a region in pixels of an additional square at the bottom right corner of a frameless window. | {"type": "number", "default": 4} |
openfin.json | size | Defines a region in pixels that will respond to user mouse interaction for resizing a frameless window. | {"type": "number", "default": 2} |
openfin.json | saveWindowState | A flag to cache the location of the window or not. | {"type": "boolean", "default": true} |
openfin.json | showTaskbarIcon | A flag to show the Window's icon in the taskbar. | {"type": "boolean", "default": true} |
openfin.json | state | A string that sets the window to be "minimized", "maximized", or "normal" on creation. | {"type": "string", "enum": ["maximized", "minimized", "normal"], "default": "normal"} |
openfin.json | taskbarIcon | The URL of an icon to be shown on the desktop. Support formats: Portable Network Graphic (PNG); Size: 256 x 256. | {"type": "string"} |
openfin.json | taskbarIconGroup | Group your OpenFin apps in the Taskbar. v5.0+ | {"type": "string"} |
openfin.json | url | The URL of the window. | {"type": "string"} |
openfin.json | uuid | The UUID of the application, unique within the set of all other Applications running in OpenFin Runtime. | {"type": "string"} |
openfin.json | waitForPageLoad | When set to false, the page will render before the "load" event is fired on the window. Caution, when false you will see an initial empty white window. | {"type": "boolean", "default": true} |
openfin.json | supportInformation | An optional object to customize error messages. | {"additionalProperties": false, "required": ["company", "email", "product"], "properties": {"company": {"type": "string"}, "email": {"type": "string"}, "enableErrorReporting": {"type": "boolean", "default": true}, "forwardErrorReports": {"type": "boolean", "default": false}, "product": {"type": "string"}}} |
openfin.json | company | Displays the company name in the title bar for the support error dialog that appears when an application fails to load. | {"type": "string"} |
openfin.json | email | Displays the email to contact in the support error dialog that appears when an application fails to load. | {"type": "string"} |
openfin.json | enableErrorReporting | To disable the error reporting feature, set this value to false. | {"type": "boolean", "default": true} |
openfin.json | forwardErrorReports | When set to true, prompts end users with a dialog when a deployment error occurs from within the RVM and enables them send along log files from their machine. Error reports are delivered to your email address set in supportInformation. | {"type": "boolean", "default": false} |
openfin.json | product | Displays the product name or application name in the support error dialog that appears when an application fails to load. | {"type": "string"} |
stale.json | A GitHub app that closes abandoned issues and pull requests | {"$schema": "http://json-schema.org/draft-04/schema#", "definitions": {"configuration": {"properties": {"daysUntilStale": {"type": "number", "default": 60}, "daysUntilClose": {"type": ["integer", "boolean"], "default": 7}, "onlyLabels": {"type": "array", "items": {"type": "string"}, "default": []}, "exemptLabels": {"type": "array", "items": {"type": "string"}, "default": []}, "exemptProjects": {"type": "boolean", "default": false}, "exemptAssignees": {"type": "boolean", "default": false}, "staleLabel": {"type": "string", "default": "wontfix"}, "markComment": {"type": ["string", "boolean"], "default": "This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions."}, "unmarkComment": {"type": ["string", "boolean"]}, "closeComment": {"type": ["string", "boolean"]}, "limitPerRun": {"type": "number", "minimum": 1, "maximum": 30, "default": 30}, "only": {"enum": ["issues", "pulls"]}}}}, "id": "https://json.schemastore.org/stale.json", "properties": {"pulls": {}, "issues": {}}, "type": "object"} |
|
stale.json | daysUntilStale | Number of days of inactivity before an Issue or Pull Request becomes stale. | {"type": "number", "default": 60} |
stale.json | daysUntilClose | Number of days of inactivity before an Issue or Pull Request with the stale label is closed. | {"type": ["integer", "boolean"], "default": 7} |
stale.json | onlyLabels | Only issues or pull requests with all of these labels are check if stale. | {"type": "array", "items": {"type": "string"}, "default": []} |
stale.json | exemptLabels | Issues or Pull Requests with these labels will never be considered stale. | {"type": "array", "items": {"type": "string"}, "default": []} |
stale.json | exemptProjects | Set to true to ignore issues in a milestone. | {"type": "boolean", "default": false} |
stale.json | exemptAssignees | Set to true to ignore issues with an assignee. | {"type": "boolean", "default": false} |
stale.json | staleLabel | Label to use when marking as stale. | {"type": "string", "default": "wontfix"} |
stale.json | markComment | Comment to post when marking as stale. | {"type": ["string", "boolean"], "default": "This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions."} |
stale.json | unmarkComment | Comment to post when removing the stale label. | {"type": ["string", "boolean"]} |
stale.json | closeComment | Comment to post when closing a stale issue or pull request. | {"type": ["string", "boolean"]} |
stale.json | limitPerRun | Limit the number of actions per hour. | {"type": "number", "minimum": 1, "maximum": 30, "default": 30} |
stale.json | only | Limit to only issues or pulls requests. | {"enum": ["issues", "pulls"]} |
stale.json | pulls | Specify configuration settings that are specific to pull requests. | {} |
stale.json | issues | Specify configuration settings that are specific to issues. | {} |
github-workflow-template-properties.json | name | A workflow template name
https://docs.github.com/en/actions/using-workflows/creating-starter-workflows-for-your-organization#creating-a-starter-workflow | {"type": "string", "minLength": 1, "examples": ["Sample name"]} |
github-workflow-template-properties.json | description | A workflow template description
https://docs.github.com/en/actions/using-workflows/creating-starter-workflows-for-your-organization#creating-a-starter-workflow | {"type": "string", "minLength": 1, "examples": ["Sample description"]} |
github-workflow-template-properties.json | iconName | A workflow template icon
Must be the name of an SVG file, without the file name extension, stored in the workflow-templates directory
https://docs.github.com/en/actions/using-workflows/creating-starter-workflows-for-your-organization#creating-a-starter-workflow | {"type": "string", "minLength": 1, "examples": ["Sample icon"]} |
github-workflow-template-properties.json | categories | A workflow category
https://docs.github.com/en/actions/using-workflows/creating-starter-workflows-for-your-organization#creating-a-starter-workflow | {"type": "array", "uniqueItems": true, "minItems": 1, "items": {"type": "string", "enum": ["1C Enterprise", "4D", "ABAP CDS", "ABAP", "ABNF", "AFDKO", "AGS Script", "AIDL", "AL", "AMPL", "ANTLR", "API Blueprint", "APL", "ASL", "ASN.1", "ASP.NET", "ATS", "ActionScript", "Ada", "Alloy", "Alpine Abuild", "Altium Designer", "AngelScript", "Ant Build System", "ApacheConf", "Apex", "Apollo Guidance Computer", "AppleScript", "Arc", "AsciiDoc", "AspectJ", "Assembly", "Astro", "Asymptote", "Augeas", "AutoHotkey", "AutoIt", "AutoIt3", "AutoItScript", "Avro IDL", "Awk", "BASIC", "Ballerina", "Batchfile", "Beef", "Befunge", "BibTeX", "Bicep", "Bison", "BitBake", "Blade", "BlitzBasic", "BlitzMax", "Boo", "Boogie", "Brainfuck", "Brightscript", "Browserslist", "C", "C#", "C++", "C-ObjDump", "C2hs Haskell", "CIL", "CLIPS", "CMake", "COBOL", "CODEOWNERS", "COLLADA", "CSON", "CSS", "CSV", "CUE", "CWeb", "Cabal Config", "Cabal", "Cap'n Proto", "Carto", "CartoCSS", "Ceylon", "Chapel", "Charity", "ChucK", "Cirru", "Clarion", "Classic ASP", "Clean", "Click", "Clojure", "Closure Templates", "Cloud Firestore Security Rules", "CoNLL", "CoNLL-U", "CoNLL-X", "ColdFusion CFC", "ColdFusion", "Common Lisp", "Common Workflow Language", "Component Pascal", "Containerfile", "Cool", "Coq", "Cpp-ObjDump", "Crystal", "Csound Document", "Csound Score", "Csound", "Cuda", "Cue Sheet", "Cycript", "Cython", "D-ObjDump", "DIGITAL Command Language", "DM", "DTrace", "Dafny", "Darcs Patch", "Dart", "DataWeave", "Dhall", "Diff", "Dlang", "Dockerfile", "Dogescript", "Dylan", "E", "E-mail", "EBNF", "ECL", "ECLiPSe", "EJS", "EQ", "Eagle", "Earthly", "Easybuild", "Ecere Projects", "EditorConfig", "Eiffel", "Elixir", "Elm", "Emacs Lisp", "EmberScript", "Erlang", "F#", "F*", "FIGfont", "FIGlet Font", "FLUX", "Factor", "Fancy", "Fantom", "Faust", "Fennel", "Filebench WML", "Filterscript", "Fluent", "Formatted", "Forth", "Fortran Free Form", "Fortran", "FreeBasic", "Frege", "Futhark", "G-code", "GAML", "GAMS", "GAP", "GCC Machine Description", "GDB", "GDScript", "GEDCOM", "GLSL", "GN", "Game Maker Language", "Gemfile.lock", "Genie", "Genshi", "Gentoo Eclass", "Gerber Image", "Gettext Catalog", "Gherkin", "Git Config", "Glyph Bitmap Distribution Format", "Glyph", "Gnuplot", "Go Checksums", "Go Module", "Go", "Golo", "Gosu", "Grace", "Gradle", "Grammatical Framework", "Graph Modeling Language", "GraphQL", "Graphviz (DOT)", "Groovy Server Pages", "Groovy", "HAProxy", "HCL", "HTML", "HTML+ECR", "HTML+EEX", "HTML+ERB", "HTML+PHP", "HTML+Razor", "HTTP", "HXML", "Hack", "Haml", "Handlebars", "Harbour", "HashiCorp Configuration Language", "Haskell", "Haxe", "HiveQL", "HolyC", "Hy", "IDL", "IGOR Pro", "IPython Notebook", "Idris", "Ignore List", "ImageJ Macro", "Inform 7", "Io", "Ioke", "Isabelle ROOT", "Isabelle", "J", "JAR Manifest", "JFlex", "JSON with Comments", "JSON", "JSON5", "JSONLD", "JSONiq", "Jasmin", "Java Properties", "Java Server Pages", "Java", "JavaScript", "JavaScript+ERB", "Jest Snapshot", "Jinja", "Jison Lex", "Jison", "Jolie", "Jsonnet", "Julia", "Jupyter Notebook", "Kaitai Struct", "KakouneScript", "KiCad Layout", "KiCad Legacy Layout", "KiCad Schematic", "Kit", "Kotlin", "Kusto", "LFE", "LLVM", "LOLCODE", "LSL", "LTspice Symbol", "LabVIEW", "Lark", "Lasso", "Lean", "Less", "Lex", "LilyPond", "Limbo", "Linker Script", "Linux Kernel Module", "Liquid", "Literate Agda", "Literate CoffeeScript", "Literate Haskell", "LiveScript", "Logos", "Logtalk", "LookML", "LoomScript", "Lua", "M", "M4", "M4Sugar", "MATLAB", "MAXScript", "MLIR", "MQL4", "MQL5", "MTML", "MUF", "Macaulay2", "Makefile", "Mako", "Markdown", "Marko", "Mathematica", "Max", "Mercury", "Meson", "Metal", "Microsoft Developer Studio Project", "Microsoft Visual Studio Solution", "MiniD", "Mirah", "Modelica", "Modula-2", "Modula-3", "Module Management System", "Monkey", "Moocode", "MoonScript", "Motoko", "Motorola 68K Assembly", "Muse", "Myghty", "NASL", "NCL", "NEON", "NPM Config", "NSIS", "NWScript", "Nearley", "Nemerle", "NeoSnippet", "NetLinx", "NetLinx+ERB", "NetLogo", "NewLisp", "Nextflow", "Nginx", "Ninja", "Nit", "Nix", "NumPy", "Nunjucks", "ObjDump", "Object Data Instance Notation", "ObjectScript", "Objective-C", "Objective-C++", "Objective-J", "Odin", "Omgrofl", "Opa", "Opal", "Open Policy Agent", "OpenCL", "OpenEdge ABL", "OpenQASM", "OpenRC runscript", "OpenSCAD", "OpenStep Property List", "OpenType Feature File", "Org", "Ox", "Oxygene", "Oz", "P4", "PEG.js", "PHP", "PLpgSQL", "POV-Ray SDL", "Pan", "Papyrus", "Parrot Assembly", "Parrot Internal Representation", "Parrot", "Pascal", "Pawn", "Pep8", "Perl", "Pickle", "PicoLisp", "PigLatin", "Pike", "PlantUML", "Pod 6", "Pod", "PogoScript", "Pony", "PostCSS", "PostScript", "PowerShell", "Prisma", "Processing", "Proguard", "Prolog", "Promela", "Propeller Spin", "Protocol Buffer", "Protocol Buffers", "Public Key", "Pug", "Puppet", "Pure Data", "PureBasic", "PureScript", "Python", "Q#", "QMake", "Qt Script", "Quake", "R", "RAML", "RDoc", "REALbasic", "REXX", "RMarkdown", "RPC", "RPM Spec", "Racket", "Ragel", "Raw token data", "ReScript", "Readline Config", "Reason", "Rebol", "Record Jar", "Red", "Redirect Rules", "Regular Expression", "RenderScript", "Rich Text Format", "Ring", "Riot", "RobotFramework", "Roff", "Rouge", "Rscript", "Ruby", "Rust", "SAS", "SCSS", "SELinux Kernel Policy Language", "SELinux Policy", "SMT", "SPARQL", "SQF", "SQL", "SQLPL", "SRecode Template", "SSH Config", "STON", "SVG", "SWIG", "Sage", "SaltStack", "Sass", "Scala", "Scaml", "Scheme", "Scilab", "Self", "ShaderLab", "Shell", "ShellCheck Config", "Sieve", "Singularity", "Slash", "Slice", "Slim", "SmPL", "Smalltalk", "SnipMate", "Solidity", "Soong", "SourcePawn", "Spline Font Database", "Squirrel", "Stan", "Standard ML", "Starlark", "StringTemplate", "Stylus", "SubRip Text", "SugarSS", "SuperCollider", "Svelte", "Swift", "SystemVerilog", "TI Program", "TLA", "TOML", "TSQL", "TSV", "TSX", "TXL", "Tcl", "Tcsh", "TeX", "Tea", "Terra", "Texinfo", "Text", "TextMate Properties", "Textile", "Thrift", "Turing", "Turtle", "Twig", "Type Language", "TypeScript", "UltiSnip", "UltiSnips", "Unified Parallel C", "Unity3D Asset", "Unix Assembly", "Uno", "UnrealScript", "Ur", "Ur/Web", "UrWeb", "V", "VBA", "VCL", "VHDL", "Vala", "Valve Data Format", "Verilog", "Vim Help File", "Vim Script", "Vim Snippet", "Visual Basic .NET", "Vue", "Wavefront Material", "Wavefront Object", "Web Ontology Language", "WebAssembly", "WebVTT", "Wget Config", "Wikitext", "Windows Registry Entries", "Wollok", "World of Warcraft Addon Data", "X BitMap", "X Font Directory Index", "X PixMap", "X10", "XC", "XCompose", "XML Property List", "XML", "XPages", "XProc", "XQuery", "XS", "XSLT", "Xojo", "Xonsh", "Xtend", "YAML", "YANG", "YARA", "YASnippet", "Yacc", "ZAP", "ZIL", "Zeek", "ZenScript", "Zephir", "Zig", "Zimpl", "abl", "abuild", "acfm", "aconf", "actionscript 3", "actionscript3", "ada2005", "ada95", "adobe composite font metrics", "adobe multiple font metrics", "advpl", "ags", "ahk", "altium", "amfm", "amusewiki", "apache", "apkbuild", "arexx", "as3", "asm", "asp", "aspx", "aspx-vb", "ats2", "au3", "autoconf", "b3d", "bash session", "bash", "bat", "batch", "bazel", "blitz3d", "blitzplus", "bmax", "bplus", "bro", "bsdmake", "byond", "bzl", "c++-objdump", "c2hs", "cURL Config", "cake", "cakescript", "cfc", "cfm", "cfml", "chpl", "clipper", "coccinelle", "coffee", "coffee-script", "coldfusion html", "console", "cperl", "cpp", "csharp", "csound-csd", "csound-orc", "csound-sco", "cucumber", "curlrc", "cwl", "dcl", "delphi", "desktop", "dircolors", "django", "dosbatch", "dosini", "dpatch", "dtrace-script", "eC", "ecr", "editor-config", "edn", "eeschema schematic", "eex", "elisp", "emacs muse", "emacs", "email", "eml", "erb", "fb", "fish", "flex", "foxpro", "fsharp", "fstar", "ftl", "fundamental", "gf", "git-ignore", "gitattributes", "gitconfig", "gitignore", "gitmodules", "go mod", "go sum", "go.mod", "go.sum", "golang", "groff", "gsp", "hbs", "heex", "help", "html+django", "html+jinja", "html+ruby", "htmlbars", "htmldjango", "hylang", "i7", "ignore", "igor", "igorpro", "ijm", "inc", "inform7", "inputrc", "irc logs", "irc", "java server page", "jq", "jruby", "js", "jsonc", "jsp", "kak", "kakscript", "keyvalues", "ksy", "lassoscript", "latex", "leex", "lhaskell", "lhs", "lisp", "litcoffee", "live-script", "ls", "m2", "m68k", "mIRC Script", "macruby", "mail", "make", "man page", "man", "man-page", "manpage", "markojs", "max/msp", "maxmsp", "mbox", "mcfunction", "mdoc", "mediawiki", "mf", "mma", "mumps", "mupad", "nanorc", "nasm", "ne-on", "nesC", "nette object notation", "nginx configuration file", "nixos", "njk", "node", "npmrc", "nroff", "nush", "nvim", "obj-c", "obj-c++", "obj-j", "objc", "objc++", "objectivec", "objectivec++", "objectivej", "objectpascal", "objj", "octave", "odin-lang", "odinlang", "oncrpc", "ooc", "openedge", "openrc", "osascript", "pandoc", "pasm", "pcbnew", "perl-6", "perl6", "pir", "plain text", "posh", "postscr", "pot", "pov-ray", "povray", "progress", "protobuf", "pwsh", "pycon", "pyrex", "python3", "q", "ql", "qsharp", "ragel-rb", "ragel-ruby", "rake", "raw", "razor", "rb", "rbx", "reStructuredText", "readline", "red/system", "redirects", "regex", "regexp", "renpy", "rhtml", "robots txt", "robots", "robots.txt", "rpcgen", "rs", "rs-274x", "rss", "rst", "rusthon", "salt", "saltstate", "sed", "sepolicy", "sh", "shell-script", "shellcheckrc", "sml", "snippet", "sourcemod", "soy", "specfile", "splus", "squeak", "terraform", "tl", "tm-properties", "troff", "ts", "udiff", "vb .net", "vb.net", "vb6", "vbnet", "vdf", "vim", "vimhelp", "viml", "visual basic 6", "visual basic for applications", "visual basic", "vlang", "wasm", "wast", "wdl", "wgetrc", "wiki", "winbatch", "wisp", "wl", "wolfram lang", "wolfram language", "wolfram", "wsdl", "xBase", "xbm", "xdr", "xhtml", "xml+genshi", "xml+kid", "xpm", "xsd", "xsl", "xten", "yas", "yml", "zsh"]}} |
github-workflow-template-properties.json | filePatterns | A file name pattern to match against repository to enable this workflow when match is succeed
https://docs.github.com/en/actions/using-workflows/creating-starter-workflows-for-your-organization#creating-a-starter-workflow | {"type": "array", "minItems": 1, "uniqueItems": true, "items": {"type": "string", "minLength": 1, "examples": ["*.sample"]}} |
minecraft-particle.json | A particle for a Minecraft resource pack config schema | {"$schema": "http://json-schema.org/draft-07/schema#", "properties": {"textures": {"type": "array", "items": {"type": "string"}}}, "required": ["textures"], "type": "object"} |
|
minecraft-trim-material.json | A trim material for a Minecraft data pack config schema | {"$schema": "http://json-schema.org/draft-07/schema#", "properties": {"asset_name": {"type": "string"}, "ingredient": {"type": "string"}, "item_model_index": {"type": "number"}}, "required": ["asset_name", "description", "ingredient", "item_model_index"], "type": "object"} |
|
staticwebapp.config.json | Documentation: https://aka.ms/swa/config-schema | {"$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": false, "default": {"navigationFallback": {"rewrite": "/index.html"}}, "definitions": {"route": {"type": "object", "required": ["route"], "properties": {"route": {"type": "string"}, "methods": {"type": "array", "items": {"anyOf": [{"type": "string", "enum": ["GET", "HEAD", "POST", "PUT", "DELETE", "PATCH", "CONNECT", "OPTIONS", "TRACE"]}]}}, "allowedRoles": {"type": "array", "items": {"anyOf": [{"type": "string", "examples": ["anonymous", "authenticated"]}]}}, "headers": {"type": "object", "additionalProperties": true}, "redirect": {"type": "string"}, "statusCode": {"type": "integer"}, "rewrite": {"type": "string"}}, "additionalProperties": false}, "auth": {"type": "object", "required": ["identityProviders"], "properties": {"rolesSource": {"type": "string"}, "identityProviders": {"type": "object", "properties": {"azureActiveDirectory": {"type": "object", "required": ["registration"], "properties": {"enabled": {"type": "boolean", "default": true}, "registration": {"type": "object", "required": ["openIdIssuer", "clientSecretSettingName"], "properties": {"openIdIssuer": {"type": "string"}, "clientIdSettingName": {"type": "string"}, "clientSecretSettingName": {"type": "string"}}, "additionalProperties": false}, "login": {"type": "object", "properties": {"loginParameters": {"type": "array", "items": {"type": "string"}}}, "additionalProperties": false}, "userDetailsClaim": {"type": "string"}}, "additionalProperties": false}, "apple": {"type": "object", "required": ["registration"], "properties": {"enabled": {"type": "boolean", "default": true}, "registration": {"type": "object", "required": ["clientSecretSettingName"], "properties": {"clientIdSettingName": {"type": "string"}, "clientSecretSettingName": {"type": "string"}}, "additionalProperties": false}, "login": {"type": "object", "properties": {"scopes": {"type": "array", "items": {"type": "string"}}}, "additionalProperties": false}, "userDetailsClaim": {"type": "string"}}, "additionalProperties": false}, "facebook": {"type": "object", "required": ["registration"], "properties": {"enabled": {"type": "boolean", "default": true}, "registration": {"type": "object", "required": ["appSecretSettingName"], "properties": {"appIdSettingName": {"type": "string"}, "appSecretSettingName": {"type": "string"}}, "additionalProperties": false}, "login": {"type": "object", "properties": {"scopes": {"type": "array", "items": {"type": "string"}}}, "additionalProperties": false}, "userDetailsClaim": {"type": "string"}}, "additionalProperties": false}, "github": {"type": "object", "required": ["registration"], "properties": {"enabled": {"type": "boolean", "default": true}, "registration": {"type": "object", "required": ["clientSecretSettingName"], "properties": {"clientIdSettingName": {"type": "string"}, "clientSecretSettingName": {"type": "string"}}, "additionalProperties": false}, "login": {"type": "object", "properties": {"scopes": {"type": "array", "items": {"type": "string"}}}, "additionalProperties": false}, "userDetailsClaim": {"type": "string"}}, "additionalProperties": false}, "google": {"type": "object", "required": ["registration"], "properties": {"enabled": {"type": "boolean", "default": true}, "registration": {"type": "object", "required": ["clientSecretSettingName"], "properties": {"clientIdSettingName": {"type": "string"}, "clientSecretSettingName": {"type": "string"}}, "additionalProperties": false}, "login": {"type": "object", "properties": {"scopes": {"type": "array", "items": {"type": "string"}}}, "additionalProperties": false}, "userDetailsClaim": {"type": "string"}}, "additionalProperties": false}, "twitter": {"type": "object", "required": ["registration"], "properties": {"enabled": {"type": "boolean", "default": true}, "registration": {"type": "object", "required": ["consumerSecretSettingName"], "properties": {"consumerKeySettingName": {"type": "string"}, "consumerSecretSettingName": {"type": "string"}}, "additionalProperties": false}, "userDetailsClaim": {"type": "string"}}, "additionalProperties": false}, "customOpenIdConnectProviders": {"type": "object", "patternProperties": {".*": {"required": ["registration", "login"], "properties": {"enabled": {"type": "boolean", "default": true}, "registration": {"type": "object", "required": ["clientCredential", "openIdConnectConfiguration"], "properties": {"clientIdSettingName": {"type": "string"}, "clientCredential": {"type": "object", "required": ["clientSecretSettingName"], "properties": {"clientSecretSettingName": {"type": "string"}}}, "openIdConnectConfiguration": {"type": "object", "properties": {"authorizationEndpoint": {"type": "string"}, "tokenEndpoint": {"type": "string"}, "issuer": {"type": "string"}, "certificationUri": {"type": "string"}, "wellKnownOpenIdConfiguration": {"type": "string"}}}}, "additionalProperties": false}, "login": {"type": "object", "properties": {"nameClaimType": {"type": "string"}, "scopes": {"type": "array", "items": {"type": "string"}}, "loginParameterNames": {"type": "array", "items": {"type": "string"}}}, "additionalProperties": false}}, "additionalProperties": false}}}}, "additionalProperties": false}}, "additionalProperties": false}}, "id": "https://json.schemastore.org/staticwebapp.config.json", "properties": {"routes": {"type": "array", "default": [{"route": "/example", "rewrite": "/example.html"}], "items": {"examples": [{"route": "/example", "rewrite": "/example.html"}, {"route": "/login", "redirect": "/.auth/login/github"}], "anyOf": [{"allOf": [{}]}]}}, "navigationFallback": {"type": "object", "default": {"rewrite": "/index.html"}, "required": ["rewrite"], "properties": {"rewrite": {"type": "string", "default": "/index.html"}, "exclude": {"type": "array", "examples": [["*.{jpg,gif,png}", "assets/*"]]}}, "additionalProperties": false}, "responseOverrides": {"type": "object", "examples": [{"404": {"rewrite": "/custom_404.html", "statusCode": 200}}], "propertyNames": {"pattern": "^\\d+$"}, "patternProperties": {".*": {"oneOf": [{"type": "object", "properties": {"redirect": {"type": "string"}, "statusCode": {"type": "integer"}, "rewrite": {"type": "string"}}}]}}}, "mimeTypes": {"type": "object", "default": {}, "examples": [{".config": "application/xml"}], "patternProperties": {"^\\..+$": {"type": "string"}}, "additionalProperties": false}, "globalHeaders": {"type": "object", "additionalProperties": true}, "auth": {}, "networking": {"type": "object", "properties": {"allowedIpRanges": {"type": "array", "items": {"type": "string"}, "examples": [["10.0.0.0/24", "192.1.1.1/10"]]}}, "additionalProperties": false}, "forwardingGateway": {"type": "object", "properties": {"allowedForwardedHosts": {"type": "array", "items": {"type": "string"}, "examples": [["example.org", "www.example.org", "staging.example.org"]]}, "requiredHeaders": {"type": "object", "examples": [{"X-Azure-FDID": "10dd26ef"}], "additionalProperties": true}}, "additionalProperties": false}, "platform": {"type": "object", "properties": {"apiRuntime": {"type": "string", "enum": ["dotnet:3.1", "dotnet:6.0", "dotnet-isolated:6.0", "dotnet-isolated:7.0", "node:12", "node:14", "node:16", "node:18", "python:3.8", "python:3.9", "python:3.10"]}}, "additionalProperties": false}, "trailingSlash": {"type": "string", "enum": ["always", "never", "auto"]}, "$schema": {"type": "string", "default": "https://json.schemastore.org/staticwebapp.config.json"}}, "type": "object"} |
|
staticwebapp.config.json | route | Request route pattern to match. May contain valid wildcards. See documentation: https://aka.ms/swa/config-schema | {"type": "string"} |
staticwebapp.config.json | methods | Request method(s) to match | {"type": "array", "items": {"anyOf": [{"type": "string", "enum": ["GET", "HEAD", "POST", "PUT", "DELETE", "PATCH", "CONNECT", "OPTIONS", "TRACE"]}]}} |
staticwebapp.config.json | allowedRoles | Roles that are allowed to access this route. If not empty, only role(s) listed are authorized to access the route. Roles are only used for authorization; they are not used to evaluate whether the route matches the request. | {"type": "array", "items": {"anyOf": [{"type": "string", "examples": ["anonymous", "authenticated"]}]}} |
staticwebapp.config.json | headers | Override any matching global headers | {"type": "object", "additionalProperties": true} |
staticwebapp.config.json | redirect | Redirect to a relative or absolute path, or an external URI. Default status code is 302, override with 301. | {"type": "string"} |
staticwebapp.config.json | statusCode | Status code override | {"type": "integer"} |
staticwebapp.config.json | rewrite | A path to rewrite the request route to | {"type": "string"} |
staticwebapp.config.json | rolesSource | Route to API function for assigning roles. For example, "/api/GetRoles". See https://aka.ms/swa-roles-function | {"type": "string"} |
staticwebapp.config.json | enabled | <false> if the azureActiveDirectory provider is not enabled, <true> otherwise | {"type": "boolean", "default": true} |
staticwebapp.config.json | openIdIssuer | The endpoint for the OpenID configuration of the AAD tenant | {"type": "string"} |
staticwebapp.config.json | clientIdSettingName | The name of the application setting containing the Application (client) ID for the Azure AD app registration | {"type": "string"} |
staticwebapp.config.json | clientSecretSettingName | The name of the application setting containing the client secret for the Azure AD app registration | {"type": "string"} |
staticwebapp.config.json | login | {"type": "object", "properties": {"loginParameters": {"type": "array", "items": {"type": "string"}}}, "additionalProperties": false} |
|
staticwebapp.config.json | userDetailsClaim | The name of the claim from which we should read user details | {"type": "string"} |
staticwebapp.config.json | enabled | <false> if the apple provider is not enabled, <true> otherwise | {"type": "boolean", "default": true} |
staticwebapp.config.json | clientIdSettingName | The name of the application setting containing the Client ID | {"type": "string"} |
staticwebapp.config.json | clientSecretSettingName | The name of the application setting containing the Client Secret | {"type": "string"} |
staticwebapp.config.json | login | {"type": "object", "properties": {"scopes": {"type": "array", "items": {"type": "string"}}}, "additionalProperties": false} |
|
staticwebapp.config.json | userDetailsClaim | The name of the claim from which we should read user details | {"type": "string"} |
staticwebapp.config.json | enabled | <false> if the facebook provider is not enabled, <true> otherwise | {"type": "boolean", "default": true} |
staticwebapp.config.json | appIdSettingName | The name of the application setting containing the App ID | {"type": "string"} |
staticwebapp.config.json | appSecretSettingName | The name of the application setting containing the App Secret | {"type": "string"} |
staticwebapp.config.json | login | {"type": "object", "properties": {"scopes": {"type": "array", "items": {"type": "string"}}}, "additionalProperties": false} |
|
staticwebapp.config.json | userDetailsClaim | The name of the claim from which we should read user details | {"type": "string"} |
staticwebapp.config.json | enabled | <false> if the gitHub provider is not enabled, <true> otherwise | {"type": "boolean", "default": true} |
staticwebapp.config.json | clientIdSettingName | The name of the application setting containing the Client ID | {"type": "string"} |
staticwebapp.config.json | clientSecretSettingName | The name of the application setting containing the Client Secret | {"type": "string"} |
staticwebapp.config.json | login | {"type": "object", "properties": {"scopes": {"type": "array", "items": {"type": "string"}}}, "additionalProperties": false} |
|
staticwebapp.config.json | userDetailsClaim | The name of the claim from which we should read user details | {"type": "string"} |
staticwebapp.config.json | enabled | <false> if the google provider is not enabled, <true> otherwise | {"type": "boolean", "default": true} |
staticwebapp.config.json | clientIdSettingName | The name of the application setting containing the Client ID | {"type": "string"} |
staticwebapp.config.json | clientSecretSettingName | The name of the application setting containing the Client Secret | {"type": "string"} |
staticwebapp.config.json | login | {"type": "object", "properties": {"scopes": {"type": "array", "items": {"type": "string"}}}, "additionalProperties": false} |
|
staticwebapp.config.json | userDetailsClaim | The name of the claim from which we should read user details | {"type": "string"} |
staticwebapp.config.json | enabled | <false> if the twitter provider is not enabled, <true> otherwise | {"type": "boolean", "default": true} |
staticwebapp.config.json | consumerKeySettingName | The name of the application setting containing the Consumer Key | {"type": "string"} |
staticwebapp.config.json | consumerSecretSettingName | The name of the application setting containing the Consumer Secret | {"type": "string"} |
staticwebapp.config.json | userDetailsClaim | The name of the claim from which we should read user details | {"type": "string"} |
staticwebapp.config.json | enabled | <false> if the custom OpenID Connect provider is not enabled, <true> otherwise | {"type": "boolean", "default": true} |
staticwebapp.config.json | clientIdSettingName | The name of the application setting containing the Client ID | {"type": "string"} |
staticwebapp.config.json | clientSecretSettingName | The name of the application setting containing the Client Secret | {"type": "string"} |
staticwebapp.config.json | authorizationEndpoint | The path to the authorization endpoint | {"type": "string"} |
staticwebapp.config.json | tokenEndpoint | The path to the token endpoint | {"type": "string"} |
staticwebapp.config.json | issuer | The path to the issuer endpoint | {"type": "string"} |
staticwebapp.config.json | certificationUri | The path to the jwks uri | {"type": "string"} |
staticwebapp.config.json | wellKnownOpenIdConfiguration | The path to the well known configuration endpoint | {"type": "string"} |
staticwebapp.config.json | login | {"type": "object", "properties": {"nameClaimType": {"type": "string"}, "scopes": {"type": "array", "items": {"type": "string"}}, "loginParameterNames": {"type": "array", "items": {"type": "string"}}}, "additionalProperties": false} |
|
staticwebapp.config.json | routes | Route definitions to modify routing behavior | {"type": "array", "default": [{"route": "/example", "rewrite": "/example.html"}], "items": {"examples": [{"route": "/example", "rewrite": "/example.html"}, {"route": "/login", "redirect": "/.auth/login/github"}], "anyOf": [{"allOf": [{}]}]}} |
staticwebapp.config.json | navigationFallback | A default file to return if the request does not match a resource | {"type": "object", "default": {"rewrite": "/index.html"}, "required": ["rewrite"], "properties": {"rewrite": {"type": "string", "default": "/index.html"}, "exclude": {"type": "array", "examples": [["*.{jpg,gif,png}", "assets/*"]]}}, "additionalProperties": false} |
staticwebapp.config.json | rewrite | The default file to return if the request does not match a resource | {"type": "string", "default": "/index.html"} |
staticwebapp.config.json | exclude | Paths to exclude from the fallback route. May use valid wildcards. https://aka.ms/swa/config-schema | {"type": "array", "examples": [["*.{jpg,gif,png}", "assets/*"]]} |
staticwebapp.config.json | responseOverrides | Custom error pages or redirects | {"type": "object", "examples": [{"404": {"rewrite": "/custom_404.html", "statusCode": 200}}], "propertyNames": {"pattern": "^\\d+$"}, "patternProperties": {".*": {"oneOf": [{"type": "object", "properties": {"redirect": {"type": "string"}, "statusCode": {"type": "integer"}, "rewrite": {"type": "string"}}}]}}} |
staticwebapp.config.json | redirect | Redirect to a relative or absolute path, or an external URI. Default status code is 302, override with 301. | {"type": "string"} |
staticwebapp.config.json | statusCode | Status code | {"type": "integer"} |
staticwebapp.config.json | rewrite | A path to rewrite the request route to | {"type": "string"} |
staticwebapp.config.json | mimeTypes | Custom mime types configuration | {"type": "object", "default": {}, "examples": [{".config": "application/xml"}], "patternProperties": {"^\\..+$": {"type": "string"}}, "additionalProperties": false} |
staticwebapp.config.json | globalHeaders | Default headers to set on all responses | {"type": "object", "additionalProperties": true} |
Subsets and Splits