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": {"ty...
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"...
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": "s...
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}