schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
collection.json | proxy-config | Using the Proxy, you can configure your custom proxy into the postman for particular url match | {"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": {"match": {"default": "http+https://*/*", "type": "string"}, "host": {"type": "string"}, "port": {"type": "integer", "minimum": 0, "default": 8080}, "tunnel": {"default": false, "type": "boolean"}, "disabled": {"type": "boolean", "default": false}}} |
collection.json | match | The Url match for which the proxy config is defined | {"default": "http+https://*/*", "type": "string"} |
collection.json | host | The proxy server host | {"type": "string"} |
collection.json | port | The proxy server port | {"type": "integer", "minimum": 0, "default": 8080} |
collection.json | tunnel | The tunneling details for the proxy config | {"default": false, "type": "boolean"} |
collection.json | disabled | When set to true, ignores this proxy configuration entity | {"type": "boolean", "default": false} |
collection.json | request | A request represents an HTTP request. If a string, the string is assumed to be the request URL and the method is assumed to be 'GET'. | {"$schema": "http://json-schema.org/draft-07/schema#", "oneOf": [{"type": "object", "properties": {"url": {}, "auth": {"oneOf": [{"type": "null"}, {}]}, "proxy": {}, "certificate": {}, "method": {"anyOf": [{"type": "string", "enum": ["GET", "PUT", "POST", "PATCH", "DELETE", "COPY", "HEAD", "OPTIONS", "LINK", "UNLINK", "PURGE", "LOCK", "UNLOCK", "PROPFIND", "VIEW"]}, {"type": "string"}]}, "header": {"oneOf": [{}, {"type": "string"}]}, "body": {"oneOf": [{"type": "object", "properties": {"mode": {"enum": ["raw", "urlencoded", "formdata", "file", "graphql"]}, "raw": {"type": "string"}, "graphql": {"type": "object"}, "urlencoded": {"type": "array", "items": {"type": "object", "properties": {"key": {"type": "string"}, "value": {"type": "string"}, "disabled": {"type": "boolean", "default": false}}, "required": ["key"]}}, "formdata": {"type": "array", "items": {"type": "object", "anyOf": [{"properties": {"key": {"type": "string"}, "value": {"type": "string"}, "disabled": {"type": "boolean", "default": false}, "type": {"type": "string", "const": "text"}, "contentType": {"type": "string"}}, "required": ["key"]}, {"properties": {"key": {"type": "string"}, "src": {"type": ["array", "string", "null"]}, "disabled": {"type": "boolean", "default": false}, "type": {"type": "string", "const": "file"}, "contentType": {"type": "string"}}, "required": ["key"]}]}}, "file": {"type": "object", "properties": {"src": {"oneOf": [{"type": "string"}, {"type": "null"}]}, "content": {"type": "string"}}}, "options": {"type": "object"}, "disabled": {"type": "boolean", "default": false}}}, {"type": "null"}]}}}, {"type": "string"}]} |
collection.json | method | The Standard HTTP method associated with this request. | {"type": "string", "enum": ["GET", "PUT", "POST", "PATCH", "DELETE", "COPY", "HEAD", "OPTIONS", "LINK", "UNLINK", "PURGE", "LOCK", "UNLOCK", "PROPFIND", "VIEW"]} |
collection.json | method | The Custom HTTP method associated with this request. | {"type": "string"} |
collection.json | body | This field contains the data usually contained in the request body. | {"type": "object", "properties": {"mode": {"enum": ["raw", "urlencoded", "formdata", "file", "graphql"]}, "raw": {"type": "string"}, "graphql": {"type": "object"}, "urlencoded": {"type": "array", "items": {"type": "object", "properties": {"key": {"type": "string"}, "value": {"type": "string"}, "disabled": {"type": "boolean", "default": false}}, "required": ["key"]}}, "formdata": {"type": "array", "items": {"type": "object", "anyOf": [{"properties": {"key": {"type": "string"}, "value": {"type": "string"}, "disabled": {"type": "boolean", "default": false}, "type": {"type": "string", "const": "text"}, "contentType": {"type": "string"}}, "required": ["key"]}, {"properties": {"key": {"type": "string"}, "src": {"type": ["array", "string", "null"]}, "disabled": {"type": "boolean", "default": false}, "type": {"type": "string", "const": "file"}, "contentType": {"type": "string"}}, "required": ["key"]}]}}, "file": {"type": "object", "properties": {"src": {"oneOf": [{"type": "string"}, {"type": "null"}]}, "content": {"type": "string"}}}, "options": {"type": "object"}, "disabled": {"type": "boolean", "default": false}}} |
collection.json | mode | Postman stores the type of data associated with this request in this field. | {"enum": ["raw", "urlencoded", "formdata", "file", "graphql"]} |
collection.json | disabled | When set to true, prevents this form data entity from being sent. | {"type": "boolean", "default": false} |
collection.json | contentType | Override Content-Type header of this form data entity. | {"type": "string"} |
collection.json | disabled | When set to true, prevents this form data entity from being sent. | {"type": "boolean", "default": false} |
collection.json | contentType | Override Content-Type header of this form data entity. | {"type": "string"} |
collection.json | src | Contains the name of the file to upload. _Not the path_. | {"type": "string"} |
collection.json | src | A null src indicates that no file has been selected as a part of the request body | {"type": "null"} |
collection.json | options | Additional configurations and options set for various body modes. | {"type": "object"} |
collection.json | disabled | When set to true, prevents request body from being sent. | {"type": "boolean", "default": false} |
collection.json | response | A response represents an HTTP response. | {"$schema": "http://json-schema.org/draft-07/schema#", "properties": {"id": {"type": "string"}, "originalRequest": {}, "responseTime": {"type": ["null", "string", "number"]}, "timings": {"type": ["object", "null"]}, "header": {"oneOf": [{"type": "array", "items": {"oneOf": [{}, {"type": "string"}]}}, {"type": ["string", "null"]}]}, "cookie": {"type": "array", "items": {}}, "body": {"type": ["null", "string"]}, "status": {"type": "string"}, "code": {"type": "integer"}}} |
collection.json | id | A unique, user defined identifier that can be used to refer to this response from requests. | {"type": "string"} |
collection.json | responseTime | The time taken by the request to complete. If a number, the unit is milliseconds. If the response is manually created, this can be set to `null`. | {"type": ["null", "string", "number"]} |
collection.json | timings | Set of timing information related to request and response in milliseconds | {"type": ["object", "null"]} |
collection.json | header | No HTTP request is complete without its headers, and the same is true for a Postman request. This field is an array containing all the headers. | {"type": "array", "items": {"oneOf": [{}, {"type": "string"}]}} |
collection.json | body | The raw text of the response. | {"type": ["null", "string"]} |
collection.json | status | The response status, e.g: '200 OK' | {"type": "string"} |
collection.json | code | The numerical response code, example: 200, 201, 404, etc. | {"type": "integer"} |
collection.json | script | A script is a snippet of Javascript code that can be used to to perform setup or teardown operations on a particular response. | {"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": {"id": {"type": "string"}, "type": {"type": "string"}, "exec": {"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "string"}]}, "src": {}, "name": {"type": "string"}}} |
collection.json | id | A unique, user defined identifier that can be used to refer to this script from requests. | {"type": "string"} |
collection.json | type | Type of the script. E.g: 'text/javascript' | {"type": "string"} |
collection.json | exec | This is an array of strings, where each line represents a single line of code. Having lines separate makes it possible to easily track changes made to scripts. | {"type": "array", "items": {"type": "string"}} |
collection.json | name | Script name | {"type": "string"} |
collection.json | url | If object, contains the complete broken-down URL for this request. If string, contains the literal request URL. | {"$schema": "http://json-schema.org/draft-07/schema#", "oneOf": [{"type": "object", "properties": {"raw": {"type": "string"}, "protocol": {"type": "string"}, "host": {"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}, "path": {"oneOf": [{"type": "string"}, {"type": "array", "items": {"oneOf": [{"type": "string"}, {"type": "object", "properties": {"type": {"type": "string"}, "value": {"type": "string"}}}]}}]}, "port": {"type": "string"}, "query": {"type": "array", "items": {"type": "object", "properties": {"key": {"type": ["string", "null"]}, "value": {"type": ["string", "null"]}, "disabled": {"type": "boolean", "default": false}}}}, "hash": {"type": "string"}, "variable": {"type": "array", "items": {}}}}, {"type": "string"}]} |
collection.json | raw | The string representation of the request URL, including the protocol, host, path, hash, query parameter(s) and path variable(s). | {"type": "string"} |
collection.json | protocol | The protocol associated with the request, E.g: 'http' | {"type": "string"} |
collection.json | host | The host for the URL, E.g: api.yourdomain.com. Can be stored as a string or as an array of strings. | {"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]} |
collection.json | host | The host, split into subdomain strings. | {"type": "array", "items": {"type": "string"}} |
collection.json | path | The complete path of the current url, broken down into segments. A segment could be a string, or a path variable. | {"type": "array", "items": {"oneOf": [{"type": "string"}, {"type": "object", "properties": {"type": {"type": "string"}, "value": {"type": "string"}}}]}} |
collection.json | port | The port number present in this URL. An empty value implies 80/443 depending on whether the protocol field contains http/https. | {"type": "string"} |
collection.json | query | An array of QueryParams, which is basically the query string part of the URL, parsed into separate variables | {"type": "array", "items": {"type": "object", "properties": {"key": {"type": ["string", "null"]}, "value": {"type": ["string", "null"]}, "disabled": {"type": "boolean", "default": false}}}} |
collection.json | disabled | If set to true, the current query parameter will not be sent with the request. | {"type": "boolean", "default": false} |
collection.json | hash | Contains the URL fragment (if any). Usually this is not transmitted over the network, but it could be useful to store this in some cases. | {"type": "string"} |
collection.json | variable | Postman supports path variables with the syntax `/path/:variableName/to/somewhere`. These variables are stored in this field. | {"type": "array", "items": {}} |
collection.json | variable-list | Collection variables allow you to define a set of variables, that are a *part of the collection*, as opposed to environments, which are separate entities.
*Note: Collection variables must not contain any sensitive information.* | {"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}} |
collection.json | variable | Using variables in your Postman requests eliminates the need to duplicate requests, which can save a lot of time. Variables can be defined, and referenced to from any part of a request. | {"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": {"id": {"type": "string"}, "key": {"type": "string"}, "value": {}, "type": {"type": "string", "enum": ["string", "boolean", "any", "number"]}, "name": {"type": "string"}, "system": {"type": "boolean", "default": false}, "disabled": {"type": "boolean", "default": false}}, "anyOf": [{"required": ["id"]}, {"required": ["key"]}, {"required": ["id", "key"]}]} |
collection.json | id | A variable ID is a unique user-defined value that identifies the variable within a collection. In traditional terms, this would be a variable name. | {"type": "string"} |
collection.json | key | A variable key is a human friendly value that identifies the variable within a collection. In traditional terms, this would be a variable name. | {"type": "string"} |
collection.json | value | The value that a variable holds in this collection. Ultimately, the variables will be replaced by this value, when say running a set of requests from a collection | {} |
collection.json | type | A variable may have multiple types. This field specifies the type of the variable. | {"type": "string", "enum": ["string", "boolean", "any", "number"]} |
collection.json | name | Variable name | {"type": "string"} |
collection.json | system | When set to true, indicates that this variable has been set by Postman | {"type": "boolean", "default": false} |
collection.json | version | Postman allows you to version your collections as they grow, and this field holds the version number. While optional, it is recommended that you use this field to its fullest extent! | {"$schema": "http://json-schema.org/draft-07/schema#", "oneOf": [{"type": "object", "properties": {"major": {"minimum": 0, "type": "integer"}, "minor": {"minimum": 0, "type": "integer"}, "patch": {"minimum": 0, "type": "integer"}, "identifier": {"type": "string", "maxLength": 10}, "meta": {}}, "required": ["major", "minor", "patch"]}, {"type": "string"}]} |
collection.json | major | Increment this number if you make changes to the collection that changes its behaviour. E.g: Removing or adding new test scripts. (partly or completely). | {"minimum": 0, "type": "integer"} |
collection.json | minor | You should increment this number if you make changes that will not break anything that uses the collection. E.g: removing a folder. | {"minimum": 0, "type": "integer"} |
collection.json | patch | Ideally, minor changes to a collection should result in the increment of this number. | {"minimum": 0, "type": "integer"} |
collection.json | identifier | A human friendly identifier to make sense of the version numbers. E.g: 'beta-3' | {"type": "string", "maxLength": 10} |
block-metadata.json | author | The name of the author of the block | {"type": "string"} |
block-metadata.json | blockType | The type of block this is (e.g. custom element, React) | {"properties": {"entryPoint": {"enum": ["custom-element", "html", "react"], "type": "string"}, "tagName": {"type": "string"}}, "required": ["entryPoint"], "type": "object"} |
block-metadata.json | commit | The commit hash of the source this block was built from. If specified, 'repository' must also be specified. | {"type": "string"} |
block-metadata.json | description | A short description of the block, to help users understand its capabilities | {"type": "string"} |
block-metadata.json | devReloadEndpoint | URL of a web socket that reports updates in locally developed blocks. To be used by EAs to auto reload. | {"type": "string"} |
block-metadata.json | displayName | The display name used for a block | {"type": "string"} |
block-metadata.json | examples | A list of examples property objects which comply with the block's schema, for demonstration purposes | {"items": {}, "type": "array"} |
block-metadata.json | externals | The dependencies a block relies on but expects the embedding application to provide, e.g. { "react": "^18.0.0" } | {} |
block-metadata.json | icon | An icon for the block, to be displayed when the user is selecting from available blocks (as well as elsewhere as appropriate, e.g. in a website listing the block). | {"type": "string"} |
block-metadata.json | image | A preview image of the block for users to see it in action before using it. This would ideally have a 3:2 width:height ratio and be a minimum of 900x1170px. | {"type": "string"} |
block-metadata.json | license | The license the block is made available under (e.g. MIT). | {"type": "string"} |
block-metadata.json | name | A unique, slugified name for the block. | {"type": "string"} |
block-metadata.json | protocol | The applicable block protocol version, e.g. 0.3 | {"type": "string"} |
block-metadata.json | repository | Specify the place where your block's code lives. This is helpful for people who want to explore the source, or contribute to your block's development. | {} |
block-metadata.json | schema | The versioned URL to the block's schema, e.g. https://blockprotocol.org/@blockprotocol/types/entity-type/thing/v/2 | {"type": "string"} |
block-metadata.json | source | The path or URL to the entrypoint source file (e.g. index.html, index.js). | {"type": "string"} |
block-metadata.json | variants | A list which represents different variants of the block that the user can create. | {"items": {"properties": {"examples": {"items": {}, "type": "array"}, "icon": {"type": "string"}, "name": {"type": "string"}, "properties": {}}, "required": ["name", "properties"], "type": "object"}, "type": "array"} |
block-metadata.json | version | The version of the block, which should use semantic versioning (@see https://semver.org/). | {"type": "string"} |
project-1.0.0-rc2.json | compilationOptions | [Deprecated] Options that are passed to the compiler. Use 'buildOptions' instead. | {"type": "object", "properties": {"define": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "nowarn": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "warningsAsErrors": {"type": "boolean", "default": false}, "allowUnsafe": {"type": "boolean", "default": false}, "emitEntryPoint": {"type": "boolean", "default": false}, "optimize": {"type": "boolean", "default": false}, "platform": {"type": "string", "enum": ["anycpu", "anycpu32bitpreferred", "ARM", "x86", "x64", "Itanium"]}, "languageVersion": {"type": "string", "enum": ["csharp1", "csharp2", "csharp3", "csharp4", "csharp5", "csharp6", "experimental"]}, "keyFile": {"type": "string"}, "delaySign": {"type": "boolean", "default": false}, "publicSign": {"type": "boolean", "default": false}, "debugType": {"type": "string", "enum": ["portable", "full", "none"]}, "preserveCompilationContext": {"type": "boolean"}, "outputName": {"type": "string"}}} |
project-1.0.0-rc2.json | preserveCompilationContext | Set this option to preserve reference assemblies and other context data to allow for runtime compilation | {"type": "boolean"} |
project-1.0.0-rc2.json | buildOptions | Options that are passed to the compiler. | {"type": "object", "properties": {"define": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "nowarn": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "warningsAsErrors": {"type": "boolean", "default": false}, "allowUnsafe": {"type": "boolean", "default": false}, "emitEntryPoint": {"type": "boolean", "default": false}, "optimize": {"type": "boolean", "default": false}, "platform": {"type": "string", "enum": ["anycpu", "anycpu32bitpreferred", "ARM", "x86", "x64", "Itanium"]}, "languageVersion": {"type": "string", "enum": ["csharp1", "csharp2", "csharp3", "csharp4", "csharp5", "csharp6", "experimental"]}, "keyFile": {"type": "string"}, "delaySign": {"type": "boolean", "default": false}, "publicSign": {"type": "boolean", "default": false}, "debugType": {"type": "string", "enum": ["portable", "full", "none"]}, "preserveCompilationContext": {"type": "boolean"}, "outputName": {"type": "string"}, "compilerName": {"type": "string", "default": "csc"}, "compile": {"type": ["string", "array", "object"], "items": {"type": "string"}, "properties": {"include": {"type": ["string", "array"], "items": {"type": "string"}}, "exclude": {"type": ["string", "array"], "items": {"type": "string"}}, "includeFiles": {"type": ["string", "array"], "items": {"type": "string"}}, "excludeFiles": {"type": ["string", "array"], "items": {"type": "string"}}, "builtIns": {"type": ["string", "array", "object"], "items": {"type": "string"}, "properties": {"include": {"type": ["string", "array"], "items": {"type": "string"}}, "exclude": {"type": ["string", "array"], "items": {"type": "string"}}}}, "mappings": {"type": "object"}}}, "embed": {"allOf": [{}, {}]}, "copyToOutput": {"allOf": [{}, {}]}, "xmlDoc": {"type": "boolean"}, "additionalArguments": {"type": "array", "items": {"type": "string"}}}} |
project-1.0.0-rc2.json | preserveCompilationContext | Set this option to preserve reference assemblies and other context data to allow for runtime compilation. | {"type": "boolean"} |
project-1.0.0-rc2.json | compile | Defines glob patterns and file path to include for compilation. | {"type": ["string", "array", "object"], "items": {"type": "string"}, "properties": {"include": {"type": ["string", "array"], "items": {"type": "string"}}, "exclude": {"type": ["string", "array"], "items": {"type": "string"}}, "includeFiles": {"type": ["string", "array"], "items": {"type": "string"}}, "excludeFiles": {"type": ["string", "array"], "items": {"type": "string"}}, "builtIns": {"type": ["string", "array", "object"], "items": {"type": "string"}, "properties": {"include": {"type": ["string", "array"], "items": {"type": "string"}}, "exclude": {"type": ["string", "array"], "items": {"type": "string"}}}}, "mappings": {"type": "object"}}} |
project-1.0.0-rc2.json | include | List of file globbing patterns to be included. | {"type": ["string", "array"], "items": {"type": "string"}} |
project-1.0.0-rc2.json | exclude | List of file globbing patterns to be excluded. | {"type": ["string", "array"], "items": {"type": "string"}} |
project-1.0.0-rc2.json | includeFiles | List of file paths to be included. | {"type": ["string", "array"], "items": {"type": "string"}} |
project-1.0.0-rc2.json | excludeFiles | List of file paths to be excluded. | {"type": ["string", "array"], "items": {"type": "string"}} |
project-1.0.0-rc2.json | include | List of file globbing patterns to be included. | {"type": ["string", "array"], "items": {"type": "string"}} |
project-1.0.0-rc2.json | exclude | List of file globbing patterns to be included. | {"type": ["string", "array"], "items": {"type": "string"}} |
project-1.0.0-rc2.json | mappings | Pairs of destination folders and glob patterns specifying additional files to include/exclude. | {"type": "object"} |
project-1.0.0-rc2.json | embed | Defines glob patterns and file paths of resource files to include for compilation. | {} |
project-1.0.0-rc2.json | copyToOutput | Defines glob patterns and file paths to include for copying to build output. | {} |
project-1.0.0-rc2.json | System.GC.Server | Enables/disables server garbage collection. | {"type": "boolean", "default": false} |
project-1.0.0-rc2.json | System.GC.Concurrent | Enables/disables concurrent garbage collection. | {"type": "boolean", "default": true} |
project-1.0.0-rc2.json | System.GC.HeapCount | Limits the number of heaps created by the garbage collector. | {"type": "integer", "minimum": 0} |
project-1.0.0-rc2.json | System.GC.HeapAffinitizeMask | Specifies the exact processors that garbage collector threads should use. | {"type": "integer", "minimum": 0} |
project-1.0.0-rc2.json | System.GC.GCHeapAffinitizeRanges | Specifies the list of processors to use for garbage collector threads. | {"type": "string", "minLength": 1} |
project-1.0.0-rc2.json | System.GC.NoAffinitize | Specifies whether to affinitize garbage collection threads with processors. To affinitize a GC thread means that it can only run on its specific CPU. A heap is created for each GC thread. | {"type": "boolean", "default": false} |
project-1.0.0-rc2.json | System.GC.HeapHardLimit | Specifies the maximum commit size, in bytes, for the GC heap and GC bookkeeping. | {"type": "string"} |
project-1.0.0-rc2.json | System.GC.HeapHardLimitPercent | Specifies the GC heap usage as a percentage of the total memory. | {"type": "number"} |
project-1.0.0-rc2.json | System.GC.RetainVM | Configures whether segments that should be deleted are put on a standby list for future use or are released back to the operating system (OS). | {"type": "boolean", "default": false} |
project-1.0.0-rc2.json | System.GC.LOHThreshold | Specifies the threshold size, in bytes, that causes objects to go on the large object heap (LOH). | {"type": "integer", "default": 85000} |
project-1.0.0-rc2.json | System.Threading.ThreadPool.MinThreads | Sets the minimum number of threads for the thread pool. | {"type": "integer", "minimum": 1} |
project-1.0.0-rc2.json | System.Threading.ThreadPool.MaxThreads | Sets the maximum number of threads for the thread pool. | {"type": "integer", "minimum": 1} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.