schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
staticwebapp.config.json | networking | Networking configuration | {"type": "object", "properties": {"allowedIpRanges": {"type": "array", "items": {"type": "string"}, "examples": [["10.0.0.0/24", "192.1.1.1/10"]]}}, "additionalProperties": false} |
staticwebapp.config.json | allowedIpRanges | Restrict access to one or more IPv4 ranges. Supports CIDR notation (e.g., "192.168.100.14/24") | {"type": "array", "items": {"type": "string"}, "examples": [["10.0.0.0/24", "192.1.1.1/10"]]} |
staticwebapp.config.json | forwardingGateway | Forwarding gateway configuration | {"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} |
staticwebapp.config.json | allowedForwardedHosts | The value of `X-Forwarded-Host` to allow to be used when generating redirect URLs | {"type": "array", "items": {"type": "string"}, "examples": [["example.org", "www.example.org", "staging.example.org"]]} |
staticwebapp.config.json | requiredHeaders | HTTP header name/value pairs that are required for access | {"type": "object", "examples": [{"X-Azure-FDID": "10dd26ef"}], "additionalProperties": true} |
staticwebapp.config.json | platform | Platform configuration | {"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} |
staticwebapp.config.json | apiRuntime | Language runtime for the managed functions API | {"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"]} |
staticwebapp.config.json | trailingSlash | Trailing slash configuration | {"type": "string", "enum": ["always", "never", "auto"]} |
staticwebapp.config.json | $schema | JSON schema | {"type": "string", "default": "https://json.schemastore.org/staticwebapp.config.json"} |
deployed.json | JSON schema for the deployed cli config file.
See also: https://hyhello.github.io/deployed
| {"$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": {"privateKey": {"type": ["string", "object"]}, "passphrase": {"type": "string", "minLength": 1}, "script": {"type": "string", "minLength": 1}, "backupName": {"type": "string", "minLength": 1}, "removeLocalDir": {"type": "boolean"}, "clearRemoteDir": {"type": "boolean"}}, "properties": {"projectName": {"type": "string", "minLength": 1}, "cluster": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "privateKey": {}, "passphrase": {}, "script": {}, "backupName": {}, "removeLocalDir": {}, "clearRemoteDir": {}, "modeList": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {"type": "object", "required": ["mode", "name", "host", "port", "username", "localPath", "remotePath"], "additionalProperties": false, "properties": {"mode": {"type": "string", "minLength": 1}, "name": {"type": "string", "minLength": 1}, "host": {"type": "string", "minLength": 1}, "port": {"type": "integer", "minimum": 1}, "username": {"type": "string", "minLength": 1}, "password": {"type": "string", "minLength": 1}, "remotePath": {"type": "string", "minLength": 2}, "localPath": {"type": "string", "minLength": 1}, "backupPath": {"type": "string", "minLength": 2}, "privateKey": {}, "passphrase": {}, "script": {}, "backupName": {}, "removeLocalDir": {}, "clearRemoteDir": {}}}}, "plugin": {"type": "array", "uniqueItems": true, "items": {"type": ["string", "array"], "items": [{"type": "string"}, {"type": "object"}]}}, "$schema": {"type": "string", "minLength": 1}}, "required": ["projectName", "modeList"], "type": "object"} |
|
deployed.json | privateKey | Buffer or string that contains a private key for either key-based or hostbased user authentication (OpenSSH format). | {"type": ["string", "object"]} |
deployed.json | passphrase | For an encrypted privateKey, this is the passphrase used to decrypt it. | {"type": "string", "minLength": 1} |
deployed.json | script | Execute script commands. | {"type": "string", "minLength": 1} |
deployed.json | backupName | Old version backup name. | {"type": "string", "minLength": 1} |
deployed.json | removeLocalDir | Delete localpath after deployment. | {"type": "boolean"} |
deployed.json | clearRemoteDir | Empty the old version before deploying the new version. | {"type": "boolean"} |
deployed.json | projectName | Name of project to be released. | {"type": "string", "minLength": 1} |
deployed.json | cluster | Alias collection of environment to be deployed. | {"type": "array", "uniqueItems": true, "items": {"type": "string"}} |
deployed.json | mode | Deployment environment alias. | {"type": "string", "minLength": 1} |
deployed.json | name | Deployment environment name. | {"type": "string", "minLength": 1} |
deployed.json | host | Hostname or IP address of the server. | {"type": "string", "minLength": 1} |
deployed.json | port | Port number of the server. | {"type": "integer", "minimum": 1} |
deployed.json | username | Username for authentication. | {"type": "string", "minLength": 1} |
deployed.json | password | Password for password-based user authentication. | {"type": "string", "minLength": 1} |
deployed.json | remotePath | Deployment path. | {"type": "string", "minLength": 2} |
deployed.json | localPath | Local upload path. | {"type": "string", "minLength": 1} |
deployed.json | backupPath | Backup path. | {"type": "string", "minLength": 2} |
deployed.json | plugin | List of plugins to load and use. | {"type": "array", "uniqueItems": true, "items": {"type": ["string", "array"], "items": [{"type": "string"}, {"type": "object"}]}} |
deployed.json | items | The name of the plugin. | {"type": "string"} |
deployed.json | items | The options of the plugin. | {"type": "object"} |
deployed.json | $schema | JSON Schema for deployed. | {"type": "string", "minLength": 1} |
pyproject.json | poetry-author-pattern | Pattern that matches `Name <email>` like 'King Arthur' or 'Miss Islington <[email protected]>'. | {"type": "string", "pattern": "^(?:\\S+?\\s)+?(?:<(?:[a-z\\d!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z\\d!#$%&'*+/=?^_`{|}~-]+)*|\"(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21\\x23-\\x5b\\x5d-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])*\")@(?:(?:[a-z\\d](?:[a-z\\d-]*[a-z\\d])?\\.)+[a-z\\d](?:[a-z\\d-]*[a-z\\d])?|\\[(?:(?:25[0-5]|2[0-4][\\d]|[01]?[\\d][\\d]?)\\.){3}(?:25[0-5]|2[0-4][\\d]|[01]?[\\d][\\d]?|[a-z\\d-]*[a-z\\d]:(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21-\\x5a\\x53-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])+)\\])>)?$"} |
pyproject.json | poetry-authors | List of authors that contributed to the package. This is typically the main maintainers, not the full list. | {"type": "array", "items": {}} |
pyproject.json | poetry-maintainers | List of maintainers, other than the original author(s), that upkeep the package. | {"type": "array", "items": {}} |
pyproject.json | poetry-include-path | Path to file or directory to include. | {"type": "string"} |
pyproject.json | poetry-package-format | A Python packaging format. | {"type": "string", "enum": ["sdist", "wheel"]} |
pyproject.json | poetry-package-formats | The format(s) for which the package must be included. | {"oneOf": [{}, {"type": "array", "items": {}}]} |
pyproject.json | poetry-pep440-version | A version constraint. Validates against the PEP 440's version pattern. | {"type": "string"} |
pyproject.json | python | The python versions for which the dependency should be installed. | {"type": "string"} |
pyproject.json | platform | The platform(s) for which the dependency should be installed. | {"type": "string"} |
pyproject.json | markers | The PEP 508 compliant environment markers for which the dependency should be installed. | {"type": "string"} |
pyproject.json | allow-prereleases | Whether the dependency allows prereleases or not. | {"type": "boolean"} |
pyproject.json | allows-prereleases | Whether the dependency allows prereleases or not. | {"type": "boolean"} |
pyproject.json | optional | Whether the dependency is optional or not. | {"type": "boolean"} |
pyproject.json | extras | The required extras for this dependency. | {"type": "array", "items": {"type": "string"}} |
pyproject.json | source | The exclusive source used to search for this dependency. | {"type": "string"} |
pyproject.json | git | The url of the git repository. | {"type": "string", "format": "uri"} |
pyproject.json | branch | The branch to checkout. | {"type": "string"} |
pyproject.json | tag | The tag to checkout. | {"type": "string"} |
pyproject.json | rev | The revision to checkout. | {"type": "string"} |
pyproject.json | subdirectory | The relative path to the directory where the package is located. | {"type": "string"} |
pyproject.json | python | The python versions for which the dependency should be installed. | {"type": "string"} |
pyproject.json | platform | The platform(s) for which the dependency should be installed. | {"type": "string"} |
pyproject.json | markers | The PEP 508 compliant environment markers for which the dependency should be installed. | {"type": "string"} |
pyproject.json | allow-prereleases | Whether the dependency allows prereleases or not. | {"type": "boolean"} |
pyproject.json | allows-prereleases | Whether the dependency allows prereleases or not. | {"type": "boolean"} |
pyproject.json | optional | Whether the dependency is optional or not. | {"type": "boolean"} |
pyproject.json | extras | The required extras for this dependency. | {"type": "array", "items": {"type": "string"}} |
pyproject.json | develop | Whether to install the dependency in development mode. | {"type": "boolean"} |
pyproject.json | file | The path to the file. | {"type": "string"} |
pyproject.json | python | The python versions for which the dependency should be installed. | {"type": "string"} |
pyproject.json | platform | The platform(s) for which the dependency should be installed. | {"type": "string"} |
pyproject.json | markers | The PEP 508 compliant environment markers for which the dependency should be installed. | {"type": "string"} |
pyproject.json | optional | Whether the dependency is optional or not. | {"type": "boolean"} |
pyproject.json | extras | The required extras for this dependency. | {"type": "array", "items": {"type": "string"}} |
pyproject.json | path | The path to the dependency. | {"type": "string"} |
pyproject.json | python | The python versions for which the dependency should be installed. | {"type": "string"} |
pyproject.json | platform | The platform(s) for which the dependency should be installed. | {"type": "string"} |
pyproject.json | markers | The PEP 508 compliant environment markers for which the dependency should be installed. | {"type": "string"} |
pyproject.json | optional | Whether the dependency is optional or not. | {"type": "boolean"} |
pyproject.json | extras | The required extras for this dependency. | {"type": "array", "items": {"type": "string"}} |
pyproject.json | develop | Whether to install the dependency in development mode. | {"type": "boolean"} |
pyproject.json | url | The url to the file. | {"type": "string"} |
pyproject.json | python | The python versions for which the dependency should be installed. | {"type": "string"} |
pyproject.json | platform | The platform(s) for which the dependency should be installed. | {"type": "string"} |
pyproject.json | markers | The PEP 508 compliant environment markers for which the dependency should be installed. | {"type": "string"} |
pyproject.json | optional | Whether the dependency is optional or not. | {"type": "boolean"} |
pyproject.json | extras | The required extras for this dependency. | {"type": "array", "items": {"type": "string"}} |
pyproject.json | poetry-script-legacy | A simple script pointing to a callable object. | {"type": "string"} |
pyproject.json | poetry-extra-scripts | Either a console entry point or a script file that'll be included in the distribution package. | {"type": "object", "additionalProperties": false, "properties": {"reference": {"type": "string"}, "type": {"type": "string", "enum": ["file", "console"]}, "extras": {"type": "array", "items": {"type": "string"}}}, "required": ["reference", "type"]} |
pyproject.json | reference | If type is file this is the relative path of the script file, if console it is the module name. | {"type": "string"} |
pyproject.json | type | Value can be either file or console. | {"type": "string", "enum": ["file", "console"]} |
pyproject.json | extras | The required extras for this script. Only applicable if type is console. | {"type": "array", "items": {"type": "string"}} |
pyproject.json | poetry-extra-script-legacy | A script that should be installed only if extras are activated. | {"type": "object", "additionalProperties": false, "properties": {"callable": {}, "extras": {"type": "array", "items": {"type": "string"}}}} |
pyproject.json | callable | The entry point of the script. Deprecated in favour of reference. | {} |
pyproject.json | extras | The required extras for this script. | {"type": "array", "items": {"type": "string"}} |
pyproject.json | poetry-build-script | The python script file used to build extensions. | {"type": "string"} |
pyproject.json | poetry-build-config | Build specific configurations. | {"type": "object", "additionalProperties": false, "properties": {"generate-setup-file": {"type": "boolean", "default": true}, "script": {}}} |
pyproject.json | generate-setup-file | Generate and include a setup.py file in sdist. | {"type": "boolean", "default": true} |
pyproject.json | BuildSystem | Build-related data.
| {"type": "object", "x-taplo": {"links": {"key": "https://www.python.org/dev/peps/pep-0518/#build-system-table"}}, "additionalProperties": false, "required": ["requires"], "properties": {"requires": {"type": "array", "items": {"type": "string"}, "x-taplo": {"links": {"key": "https://www.python.org/dev/peps/pep-0518/#build-system-table"}}, "examples": ["setuptools >= 64.0"]}, "build-backend": {"type": "string", "x-taplo": {"links": {"key": "https://www.python.org/dev/peps/pep-0517/"}}, "examples": ["setuptools.build_meta", "my_build_backend:backend"]}, "backend-path": {"type": "array", "items": {"type": "string"}}}} |
pyproject.json | requires | A list of strings representing [PEP 508](https://www.python.org/dev/peps/pep-0508) dependencies required to execute the build system.
| {"type": "array", "items": {"type": "string"}, "x-taplo": {"links": {"key": "https://www.python.org/dev/peps/pep-0518/#build-system-table"}}, "examples": ["setuptools >= 64.0"]} |
pyproject.json | build-backend | Python path to project's build backend | {"type": "string", "x-taplo": {"links": {"key": "https://www.python.org/dev/peps/pep-0517/"}}, "examples": ["setuptools.build_meta", "my_build_backend:backend"]} |
pyproject.json | backend-path | paths to prepend to 'sys.path' when loading the build backend, relative to project root | {"type": "array", "items": {"type": "string"}} |
pyproject.json | tool | A table for tool configurations.
Every tool that is used by the project can have its own sub-table for its configuration.
| {"type": "object", "additionalProperties": {"type": "object"}, "x-taplo": {"links": {"key": "https://www.python.org/dev/peps/pep-0518/#id28"}}, "properties": {"ruff": {}, "poetry": {"type": "object", "additionalProperties": true, "required": ["name", "version", "description", "authors"], "properties": {"name": {"type": "string"}, "version": {"type": "string"}, "keywords": {"type": "array", "items": {"type": "string"}}, "homepage": {"type": "string", "format": "uri"}, "repository": {"type": "string", "format": "uri"}, "documentation": {"type": "string", "format": "uri"}, "license": {"type": "string"}, "authors": {}, "maintainers": {}, "readme": {"anyOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}, "classifiers": {"type": "array"}, "packages": {"type": "array", "items": {"type": "object", "additionalProperties": false, "required": ["include"], "properties": {"include": {}, "from": {"type": "string"}, "format": {}}}}, "include": {"type": "array", "items": {"anyOf": [{}, {"type": "object", "additionalProperties": false, "required": ["path"], "properties": {"path": {}, "format": {}}}]}}, "exclude": {"type": "array"}, "dependencies": {"type": "object", "required": ["python"], "properties": {"python": {"type": "string"}}, "patternProperties": {"^(?!python$)[a-zA-Z-_.0-9]+$": {}}}, "dev-dependencies": {"type": "object", "patternProperties": {"^[a-zA-Z-_.0-9]+$": {}}}, "extras": {"type": "object", "patternProperties": {"^[a-zA-Z-_.0-9]+$": {"type": "array", "items": {"type": "string"}}}}, "group": {"type": "object", "patternProperties": {"^[a-zA-Z-_.0-9]+$": {"type": "object", "required": ["dependencies"], "properties": {"optional": {"type": "boolean"}, "dependencies": {"type": "object", "patternProperties": {"^[a-zA-Z-_.0-9]+$": {}}, "additionalProperties": false}}, "additionalProperties": false}}}, "build": {}, "scripts": {"type": "object", "patternProperties": {"^[a-zA-Z-_.0-9]+$": {"oneOf": [{}, {}]}}}, "plugins": {"type": "object", "patternProperties": {"^[a-zA-Z-_.0-9]+$": {"type": "object", "patternProperties": {"^[a-zA-Z-_.0-9]+$": {"type": "string"}}}}}, "urls": {"type": "object", "patternProperties": {"^.+$": {"type": "string"}}}}}}, "examples": [{"tool": {"isort": {"profile": "black"}}}]} |
pyproject.json | name | Package name. | {"type": "string"} |
pyproject.json | version | Version of the package. It should follow semantic versioning, but it is not enforced. | {"type": "string"} |
pyproject.json | description | Short package description. | {"type": "string", "pattern": "^[^\n]*$"} |
pyproject.json | items | A tag/keyword that this package relates to. | {"type": "string"} |
pyproject.json | homepage | Homepage URL for the project. | {"type": "string", "format": "uri"} |
pyproject.json | repository | Repository URL for the project. | {"type": "string", "format": "uri"} |
Subsets and Splits