schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
yamllint.json | new-lines | Use this rule to force the type of new line characters. | {"anyOf": [{}, {"type": "boolean"}, {"type": "object", "properties": {"type": {"type": "string", "enum": ["unix", "dos", "platform"], "default": "unix"}}}], "default": "enable"} |
yamllint.json | type | Unix to use UNIX-typed new line characters (
), or dos to use DOS-typed new line characters (
). | {"type": "string", "enum": ["unix", "dos", "platform"], "default": "unix"} |
yamllint.json | octal-values | Use this rule to prevent values with octal numbers. | {"anyOf": [{}, {"type": "boolean"}, {"type": "object", "properties": {"forbid-implicit-octal": {"type": "boolean", "default": true}, "forbid-explicit-octal": {"type": "boolean", "default": true}}}], "default": "disable"} |
yamllint.json | forbid-implicit-octal | Prevent numbers starting with 0. | {"type": "boolean", "default": true} |
yamllint.json | forbid-explicit-octal | Prevent numbers starting with 0o. | {"type": "boolean", "default": true} |
yamllint.json | quoted-strings | Use this rule to forbid any string values that are not quoted, or to prevent quoted strings without needing it. | {"anyOf": [{}, {"type": "boolean"}, {"type": "object", "properties": {"quote-type": {"type": "string", "enum": ["single", "double", "any"], "default": "any"}, "required": {"anyOf": [{"type": "boolean"}, {"type": "string", "enum": ["only-when-needed"]}], "default": true}, "extra-required": {"type": "array", "items": {"type": "string"}, "default": []}, "extra-allowed": {"type": "array", "items": {"type": "string"}, "default": []}}}], "default": "disable"} |
yamllint.json | quote-type | Defines allowed quotes. | {"type": "string", "enum": ["single", "double", "any"], "default": "any"} |
yamllint.json | required | Defines whether using quotes in string values is required. | {"anyOf": [{"type": "boolean"}, {"type": "string", "enum": ["only-when-needed"]}], "default": true} |
yamllint.json | extra-required | List of PCRE regexes to force string values to be quoted, if they match any regex. | {"type": "array", "items": {"type": "string"}, "default": []} |
yamllint.json | extra-allowed | List of PCRE regexes to allow quoted string values, even if required: only-when-needed is set. | {"type": "array", "items": {"type": "string"}, "default": []} |
yamllint.json | trailing-spaces | Use this rule to forbid trailing spaces at the end of lines. | {"anyOf": [{}, {"type": "boolean"}, {"type": "object"}], "default": "enable"} |
yamllint.json | truthy | Use this rule to forbid non-explictly typed truthy values other than allowed ones (by default: true and false), for example YES or off. | {"anyOf": [{}, {"type": "boolean"}, {"type": "object", "properties": {"allowed-values": {"type": "array", "items": {"type": "string", "enum": ["TRUE", "True", "true", "FALSE", "False", "false", "YES", "Yes", "yes", "NO", "No", "no", "ON", "On", "on", "OFF", "Off", "off"]}, "default": ["true", "false"]}, "check-keys": {"type": "boolean", "default": true}}}], "default": {"level": "warning"}} |
yamllint.json | allowed-values | Defines the list of truthy values which will be ignored during linting. | {"type": "array", "items": {"type": "string", "enum": ["TRUE", "True", "true", "FALSE", "False", "false", "YES", "Yes", "yes", "NO", "No", "no", "ON", "On", "on", "OFF", "Off", "off"]}, "default": ["true", "false"]} |
yamllint.json | check-keys | Disables verification for keys in mappings. | {"type": "boolean", "default": true} |
pocketmine-plugin.json | children | The child permissions. Toggling the parent permission will toggle all child permissions too. | {} |
pocketmine-plugin.json | default | Indicates whether players have this permission by default. | {"enum": ["!admin", "!op", "!operator", "admin", false, "false", "isadmin", "isop", "isoperator", "notadmin", "notop", "notoperator", "op", "operator", true, "true"]} |
pocketmine-plugin.json | description | Description of the permission | {"type": "string"} |
pocketmine-plugin.json | VersionConstraint | The name of the extension, or a mapping of the extension to the required version constraint. | {"pattern": "\\*|((<=|le|<>|!=|ne|<|lt|==|=|eq|>=|ge|>|gt).*)", "type": "string"} |
pocketmine-plugin.json | api | The PocketMine API version(s) supported by the plugin. The array should be minimized such that no two API versions. | {"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "string"}]} |
pocketmine-plugin.json | author | The author name | {"type": "string"} |
pocketmine-plugin.json | authors | The author names, will be appended to `author` if both are present | {"items": {"type": "string"}, "type": "array"} |
pocketmine-plugin.json | commands | The commands to be registered automatically. The keys are command name. Commands can also be dynamically registered with the server CommandMap. | {"additionalProperties": {"properties": {"aliases": {"items": {"type": "string"}, "type": "array"}, "permission": {"type": "string"}, "permission-message": {"type": "string"}, "usage": {"type": "string"}}, "type": "object"}, "type": "object"} |
pocketmine-plugin.json | aliases | Aliases of the command | {"items": {"type": "string"}, "type": "array"} |
pocketmine-plugin.json | description | Description of the command as shown in /help | {"type": "string"} |
pocketmine-plugin.json | permission | Name of the permission to check for, or multiple permissions separated | {"type": "string"} |
pocketmine-plugin.json | permission-message | Message to send to users if permission checks fail. Occurrences of <permission> are replaced with the `permission` property. | {"type": "string"} |
pocketmine-plugin.json | usage | Usage message of the command | {"type": "string"} |
pocketmine-plugin.json | depend | Plugin(s) in `depend` must be present and will be loaded BEFORE this plugin. | {"anyOf": [{"items": {"type": "string", "pattern": "^[A-Za-z0-9 _.-]+$"}, "type": "array"}, {"type": "string", "pattern": "^[A-Za-z0-9 _.-]+$"}]} |
pocketmine-plugin.json | description | The detailed description of the plugin | {"type": "string"} |
pocketmine-plugin.json | extensions | Extension(s) required to load this plugin. Can be one extension name, a list of extension names or a mapping of extension name to version constraints. | {"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"additionalProperties": {"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "string"}]}, "type": "object"}, {"type": "string"}]} |
pocketmine-plugin.json | load | The point of loading the plugin, defaults to POSTWORLD | {"enum": ["POSTWORLD", "STARTUP"], "type": "string"} |
pocketmine-plugin.json | loadbefore | Plugin(s) in `loadbefore` will be loaded AFTER this plugin if they are present. | {"anyOf": [{"items": {"type": "string", "pattern": "^[A-Za-z0-9 _.-]+$"}, "type": "array"}, {"type": "string", "pattern": "^[A-Za-z0-9 _.-]+$"}]} |
pocketmine-plugin.json | main | The fully-qualified name of the main class that extends PluginBase | {"pattern": "([A-Za-z_]\\w+\\\\)*([A-Za-z_]\\w+)", "type": "string"} |
pocketmine-plugin.json | mcpe-protocols | The MCPE protocol versions supported by the plugin. If supported, | {"anyOf": [{"items": {"type": "integer"}, "type": "array"}, {"type": "integer"}]} |
pocketmine-plugin.json | name | Name of the plugin | {"pattern": "^[A-Za-z0-9 _.-]+$", "type": "string"} |
pocketmine-plugin.json | permissions | Permissions to be registered by this plugin automatically. Permissions can still be registered dynamically. | {} |
pocketmine-plugin.json | prefix | The plugin prefix used in the logger, defaults to plugin name | {"type": "string"} |
pocketmine-plugin.json | softdepend | Plugin(s) in `softdepend` will be loaded BEFORE this plugin if they are present, but nothing special happens if they are not present. | {"anyOf": [{"items": {"type": "string", "pattern": "^[A-Za-z0-9 _.-]+$"}, "type": "array", "pattern": "^[A-Za-z0-9 _.-]+$"}, {"type": "string"}]} |
pocketmine-plugin.json | version | Plugin version | {"type": "string"} |
pocketmine-plugin.json | website | The plugin's website | {"format": "iri", "type": "string"} |
collection.json | item | Items are the basic unit for a Postman collection. You can think of them as corresponding to a single API endpoint. Each Item has one request and may have multiple API responses associated with it. | {"type": "array", "items": {"oneOf": [{}, {}]}} |
collection.json | auth-attribute | Represents an attribute for any authorization method provided by Postman. For example `username` and `password` are set as auth attributes for Basic Authentication method. | {"type": "object", "properties": {"key": {"type": "string"}, "value": {}, "type": {"type": "string"}}, "required": ["key"]} |
collection.json | auth | Represents authentication helpers provided by Postman | {"type": "object", "properties": {"type": {"type": "string", "enum": ["apikey", "awsv4", "basic", "bearer", "digest", "edgegrid", "hawk", "noauth", "oauth1", "oauth2", "ntlm"]}, "noauth": {}, "apikey": {"type": "array", "items": {}}, "awsv4": {"type": "array", "items": {}}, "basic": {"type": "array", "items": {}}, "bearer": {"type": "array", "items": {}}, "digest": {"type": "array", "items": {}}, "edgegrid": {"type": "array", "items": {}}, "hawk": {"type": "array", "items": {}}, "ntlm": {"type": "array", "items": {}}, "oauth1": {"type": "array", "items": {}}, "oauth2": {"type": "array", "items": {}}}, "required": ["type"]} |
collection.json | apikey | The attributes for API Key Authentication. | {"type": "array", "items": {}} |
collection.json | awsv4 | The attributes for [AWS Auth](http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html). | {"type": "array", "items": {}} |
collection.json | basic | The attributes for [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication). | {"type": "array", "items": {}} |
collection.json | bearer | The helper attributes for [Bearer Token Authentication](https://tools.ietf.org/html/rfc6750) | {"type": "array", "items": {}} |
collection.json | digest | The attributes for [Digest Authentication](https://en.wikipedia.org/wiki/Digest_access_authentication). | {"type": "array", "items": {}} |
collection.json | edgegrid | The attributes for [Akamai EdgeGrid Authentication](https://developer.akamai.com/legacy/introduction/Client_Auth.html). | {"type": "array", "items": {}} |
collection.json | hawk | The attributes for [Hawk Authentication](https://github.com/hueniverse/hawk) | {"type": "array", "items": {}} |
collection.json | ntlm | The attributes for [NTLM Authentication](https://msdn.microsoft.com/en-us/library/cc237488.aspx) | {"type": "array", "items": {}} |
collection.json | oauth1 | The attributes for [OAuth2](https://oauth.net/1/) | {"type": "array", "items": {}} |
collection.json | oauth2 | Helper attributes for [OAuth2](https://oauth.net/2/) | {"type": "array", "items": {}} |
collection.json | certificate-list | A representation of a list of ssl certificates | {"type": "array", "items": {}} |
collection.json | certificate | A representation of an ssl certificate | {"type": "object", "properties": {"name": {"type": "string"}, "matches": {"type": "array", "items": {"type": "string"}}, "key": {"type": "object", "properties": {"src": {}}}, "cert": {"type": "object", "properties": {"src": {}}}, "passphrase": {"type": "string"}}} |
collection.json | name | A name for the certificate for user reference | {"type": "string"} |
collection.json | matches | A list of Url match pattern strings, to identify Urls this certificate can be used for. | {"type": "array", "items": {"type": "string"}} |
collection.json | items | An Url match pattern string | {"type": "string"} |
collection.json | key | An object containing path to file containing private key, on the file system | {"type": "object", "properties": {"src": {}}} |
collection.json | src | The path to file containing key for certificate, on the file system | {} |
collection.json | cert | An object containing path to file certificate, on the file system | {"type": "object", "properties": {"src": {}}} |
collection.json | src | The path to file containing key for certificate, on the file system | {} |
collection.json | passphrase | The passphrase for the certificate | {"type": "string"} |
collection.json | cookie-list | A representation of a list of cookies | {"type": "array", "items": {}} |
collection.json | cookie | A Cookie, that follows the [Google Chrome format](https://developer.chrome.com/extensions/cookies) | {"type": "object", "properties": {"domain": {"type": "string"}, "expires": {"type": ["string", "null"]}, "maxAge": {"type": "string"}, "hostOnly": {"type": "boolean"}, "httpOnly": {"type": "boolean"}, "name": {"type": "string"}, "path": {"type": "string"}, "secure": {"type": "boolean"}, "session": {"type": "boolean"}, "value": {"type": "string"}, "extensions": {"type": "array"}}, "required": ["domain", "path"]} |
collection.json | domain | The domain for which this cookie is valid. | {"type": "string"} |
collection.json | expires | When the cookie expires. | {"type": ["string", "null"]} |
collection.json | hostOnly | True if the cookie is a host-only cookie. (i.e. a request's URL domain must exactly match the domain of the cookie). | {"type": "boolean"} |
collection.json | httpOnly | Indicates if this cookie is HTTP Only. (if True, the cookie is inaccessible to client-side scripts) | {"type": "boolean"} |
collection.json | name | This is the name of the Cookie. | {"type": "string"} |
collection.json | path | The path associated with the Cookie. | {"type": "string"} |
collection.json | secure | Indicates if the 'secure' flag is set on the Cookie, meaning that it is transmitted over secure connections only. (typically HTTPS) | {"type": "boolean"} |
collection.json | session | True if the cookie is a session cookie. | {"type": "boolean"} |
collection.json | value | The value of the Cookie. | {"type": "string"} |
collection.json | extensions | Custom attributes for a cookie go here, such as the [Priority Field](https://code.google.com/p/chromium/issues/detail?id=232693) | {"type": "array"} |
collection.json | description | A Description can be a raw text, or be an object, which holds the description along with its format. | {"$schema": "http://json-schema.org/draft-07/schema#", "oneOf": [{"type": "object", "properties": {"content": {"type": "string"}, "type": {"type": "string"}, "version": {}}}, {"type": "string"}, {"type": "null"}]} |
collection.json | content | The content of the description goes here, as a raw string. | {"type": "string"} |
collection.json | type | Holds the mime type of the raw description content. E.g: 'text/markdown' or 'text/html'.
The type is used to correctly render the description when generating documentation, or in the Postman app. | {"type": "string"} |
collection.json | version | Description can have versions associated with it, which should be put in this property. | {} |
collection.json | event-list | Postman allows you to configure scripts to run when specific events occur. These scripts are stored here, and can be referenced in the collection by their ID. | {"type": "array", "$schema": "http://json-schema.org/draft-07/schema#", "items": {}} |
collection.json | event | Defines a script associated with an associated event name | {"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": {"id": {"type": "string"}, "listen": {"type": "string"}, "script": {}, "disabled": {"type": "boolean", "default": false}}, "required": ["listen"]} |
collection.json | id | A unique identifier for the enclosing event. | {"type": "string"} |
collection.json | listen | Can be set to `test` or `prerequest` for test scripts or pre-request scripts respectively. | {"type": "string"} |
collection.json | disabled | Indicates whether the event is disabled. If absent, the event is assumed to be enabled. | {"type": "boolean", "default": false} |
collection.json | header-list | A representation for a list of headers | {"type": "array", "items": {}} |
collection.json | header | Represents a single HTTP Header | {"type": "object", "properties": {"key": {"type": "string"}, "value": {"type": "string"}, "disabled": {"type": "boolean", "default": false}}, "required": ["key", "value"]} |
collection.json | key | This holds the LHS of the HTTP Header, e.g ``Content-Type`` or ``X-Custom-Header`` | {"type": "string"} |
collection.json | value | The value (or the RHS) of the Header is stored in this field. | {"type": "string"} |
collection.json | disabled | If set to true, the current header will not be sent with requests. | {"type": "boolean", "default": false} |
collection.json | info | Detailed description of the info block | {"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": {"name": {"type": "string"}, "_postman_id": {"type": "string"}, "version": {}, "schema": {"type": "string"}}, "required": ["name", "schema"]} |
collection.json | name | A collection's friendly name is defined by this field. You would want to set this field to a value that would allow you to easily identify this collection among a bunch of other collections, as such outlining its usage or content. | {"type": "string"} |
collection.json | _postman_id | Every collection is identified by the unique value of this field. The value of this field is usually easiest to generate using a UID generator function. If you already have a collection, it is recommended that you maintain the same id since changing the id usually implies that is a different collection than it was originally.
*Note: This field exists for compatibility reasons with Collection Format V1.* | {"type": "string"} |
collection.json | schema | This should ideally hold a link to the Postman schema that is used to validate this collection. E.g: https://schema.getpostman.com/collection/v1 | {"type": "string"} |
collection.json | item-group | One of the primary goals of Postman is to organize the development of APIs. To this end, it is necessary to be able to group requests together. This can be achived using 'Folders'. A folder just is an ordered set of requests. | {"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": {"name": {"type": "string"}, "variable": {}, "item": {"type": "array", "items": {"anyOf": [{}, {}]}}, "event": {}, "auth": {"oneOf": [{"type": "null"}, {}]}, "protocolProfileBehavior": {}}, "required": ["item"]} |
collection.json | name | A folder's friendly name is defined by this field. You would want to set this field to a value that would allow you to easily identify this folder. | {"type": "string"} |
collection.json | item | Items are entities which contain an actual HTTP request, and sample responses attached to it. Folders may contain many items. | {"type": "array", "items": {"anyOf": [{}, {}]}} |
collection.json | item | Items are entities which contain an actual HTTP request, and sample responses attached to it. | {"type": "object", "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "variable": {}, "event": {}, "request": {}, "response": {"type": "array", "items": {}}, "protocolProfileBehavior": {}}, "required": ["request"]} |
collection.json | id | A unique ID that is used to identify collections internally | {"type": "string"} |
collection.json | name | A human readable identifier for the current item. | {"type": "string"} |
collection.json | protocol-profile-behavior | Set of configurations used to alter the usual behavior of sending the request | {"$schema": "http://json-schema.org/draft-07/schema#", "type": "object"} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.