Postman collection schema v2.0 vs v2.1

Created Diff never expires
{
{
"$schema": "http://json-schema.org/draft-04/schema#",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "https://schema.getpostman.com/json/collection/v2.0.0/",
"id": "https://schema.getpostman.com/json/collection/v2.1.0/",
"type": "object",
"type": "object",
"properties": {
"properties": {
"info": {
"info": {
"$ref": "#/definitions/info"
"$ref": "#/definitions/info"
},
},
"item": {
"item": {
"type": "array",
"type": "array",
"description": "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.",
"description": "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.",
"items": {
"items": {
"title": "Items",
"title": "Items",
"oneOf": [
"oneOf": [
{
{
"$ref": "#/definitions/item"
"$ref": "#/definitions/item"
},
},
{
{
"$ref": "#/definitions/item-group"
"$ref": "#/definitions/item-group"
}
}
]
]
}
}
},
},
"event": {
"event": {
"$ref": "#/definitions/event-list"
"$ref": "#/definitions/event-list"
},
},
"variable": {
"variable": {
"$ref": "#/definitions/variable-list"
"$ref": "#/definitions/variable-list"
},
},
"auth": {
"auth": {
"oneOf": [
"oneOf": [
{
{
"type": "null"
"type": "null"
},
},
{
{
"$ref": "#/definitions/auth"
"$ref": "#/definitions/auth"
}
}
]
]
},
},
"protocolProfileBehavior": {
"protocolProfileBehavior": {
"$ref": "#/definitions/protocol-profile-behavior"
"$ref": "#/definitions/protocol-profile-behavior"
}
}
},
},
"required": [
"required": [
"info",
"info",
"item"
"item"
],
],
"definitions": {
"definitions": {
"auth-attribute": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Auth",
"id": "#/definitions/auth-attribute",
"description": "Represents an attribute for any authorization method provided by Postman. For example `username` and `password` are set as auth attributes for Basic Authentication method.",
"properties": {
"key": {
"type": "string"
},
"value": {},
"type": {
"type": "string"
}
},
"required": [
"key"
]
},
"auth": {
"auth": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"type": "object",
"title": "Auth",
"title": "Auth",
"id": "#/definitions/auth",
"id": "#/definitions/auth",
"description": "Represents authentication helpers provided by Postman",
"description": "Represents authentication helpers provided by Postman",
"properties": {
"properties": {
"type": {
"type": {
"type": "string",
"type": "string",
"enum": [
"enum": [
"apikey",
"apikey",
"awsv4",
"awsv4",
"basic",
"basic",
"bearer",
"bearer",
"digest",
"digest",
"edgegrid",
"edgegrid",
"hawk",
"hawk",
"ntlm",
"noauth",
"noauth",
"oauth1",
"oauth1",
"oauth2"
"oauth2",
"ntlm"
]
]
},
},
"noauth": {},
"noauth": {},
"apikey": {
"apikey": {
"type": "object",
"type": "array",
"title": "API Key Authentication",
"title": "API Key Authentication",
"description": "The attributes for API Key Authentication. e.g. key, value, in."
"description": "The attributes for API Key Authentication.",
"items": {
"$ref": "#/definitions/auth-attribute"
}
},
},
"awsv4": {
"awsv4": {
"type": "object",
"type": "array",
"title": "AWS Signature v4",
"title": "AWS Signature v4",
"description": "The attributes for [AWS Auth](http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html). e.g. accessKey, secretKey, region, service."
"description": "The attributes for [AWS Auth](http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html).",
"items": {
"$ref": "#/definitions/auth-attribute"
}
},
},
"basic": {
"basic": {
"type": "object",
"type": "array",
"title": "Basic Authentication",
"title": "Basic Authentication",
"description": "The attributes for [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication). e.g. username, password."
"description": "The attributes for [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication).",
"items": {
"$ref": "#/definitions/auth-attribute"
}
},
},
"bearer": {
"bearer": {
"type": "object",
"type": "array",
"title": "Bearer Token Authentication",
"title": "Bearer Token Authentication",
"description": "The attributes for [Bearer Token Authentication](https://tools.ietf.org/html/rfc6750). e.g. token."
"description": "The helper attributes for [Bearer Token Authentication](https://tools.ietf.org/html/rfc6750)",
"items": {
"$ref": "#/definitions/auth-attribute"
}
},
},
"digest": {
"digest": {
"type": "object",
"type": "array",
"title": "Digest Authentication",
"title": "Digest Authentication",
"description": "The attributes for [Digest Authentication](https://en.wikipedia.org/wiki/Digest_access_authentication). e.g. username, password, realm, nonce, nonceCount, algorithm, qop, opaque, clientNonce."
"description": "The attributes for [Digest Authentication](https://en.wikipedia.org/wiki/Digest_access_authentication).",
"items": {
"$ref": "#/definitions/auth-attribute"
}
},
},
"edgegrid": {
"edgegrid": {
"type": "object",
"type": "array",
"title": "EdgeGrid Authentication",
"title": "EdgeGrid Authentication",
"description": "The attributes for [Akamai EdgeGrid Authentication](https://developer.akamai.com/legacy/introduction/Client_Auth.html). e.g. accessToken, clientToken, clientSecret, baseURL, nonce, timestamp, headersToSign."
"description": "The attributes for [Akamai EdgeGrid Authentication](https://developer.akamai.com/legacy/introduction/Client_Auth.html).",
"items": {
"$ref": "#/definitions/auth-attribute"
}
},
},
"hawk": {
"hawk": {
"type": "object",
"type": "array",
"title": "Hawk Authentication",
"title": "Hawk Authentication",
"description": "The attributes for [Hawk Authentication](https://github.com/hueniverse/hawk). e.g. authId, authKey, algorith, user, nonce, extraData, appId, delegation, timestamp."
"description": "The attributes for [Hawk Authentication](https://github.com/hueniverse/hawk)",
"items": {
"$ref": "#/definitions/auth-attribute"
}
},
},
"ntlm": {
"ntlm": {
"type": "object",
"type": "array",
"title": "NTLM Authentication",
"title": "NTLM Authentication",
"description": "The attributes for [NTLM Authentication](https://msdn.microsoft.com/en-us/library/cc237488.aspx). e.g. username, password, domain, workstation."
"description": "The attributes for [NTLM Authentication](https://msdn.microsoft.com/en-us/library/cc237488.aspx)",
"items": {
"$ref": "#/definitions/auth-attribute"
}
},
},
"oauth1": {
"oauth1": {
"type": "object",
"type": "array",
"title": "OAuth1",
"title": "OAuth1",
"description": "The attributes for [OAuth1](https://oauth.net/1/). e.g. consumerKey, consumerSecret, token, tokenSecret, signatureMethod, timestamp, nonce, version, realm, encodeOAuthSign."
"description": "The attributes for [OAuth2](https://oauth.net/1/)",
"items": {
"$ref": "#/definitions/auth-attribute"
}
},
},
"oauth2": {
"oauth2": {
"type": "object",
"type": "array",
"title": "OAuth2",
"title": "OAuth2",
"description": "The attributes for [OAuth2](https://oauth.net/2/). e.g. accessToken, addTokenTo."
"description": "Helper attributes for [OAuth2](https://oauth.net/2/)",
"items": {
"$ref": "#/definitions/auth-attribute"
}
}
}
},
},
"required": [
"required": [
"type"
"type"
]
]
},
},
"certificate-list": {
"certificate-list": {
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "#/definitions/certificate-list",
"id": "#/definitions/certificate-list",
"title": "Certificate List",
"title": "Certificate List",
"description": "A representation of a list of ssl certificates",
"description": "A representation of a list of ssl certificates",
"type": "array",
"type": "array",
"items": {
"items": {
"$ref": "#/definitions/certificate"
"$ref": "#/definitions/certificate"
}
}
},
},
"certificate": {
"certificate": {
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "#/definitions/certificate",
"id": "#/definitions/certificate",
"title": "Certificate",
"title": "Certificate",
"description": "A representation of an ssl certificate",
"description": "A representation of an ssl certificate",
"type": "object",
"type": "object",
"properties": {
"properties": {
"name": {
"name": {
"description": "A name for the certificate for user reference",
"description": "A name for the certificate for user reference",
"type": "string"
"type": "string"
},
},
"matches": {
"matches": {
"description": "A list of Url match pattern strings, to identify Urls this certificate can be used for.",
"description": "A list of Url match pattern strings, to identify Urls this certificate can be used for.",
"type": "array",
"type": "array",
"items": {
"items": {
"type": "string",
"type": "string",
"description": "An Url match pattern string"
"description": "An Url match pattern string"
}
}
},
},
"key": {
"key": {
"description": "An object containing path to file containing private key, on the file system",
"description": "An object containing path to file containing private key, on the file system",
"type": "object",
"type": "object",
"properties": {
"properties": {
"src": {
"src": {
"description": "The path to file containing key for certificate, on the file system"
"description": "The path to file containing key for certificate, on the file system"
}
}
}
}
},
},
"cert": {
"cert": {
"description": "An object containing path to file certificate, on the file system",
"description": "An object containing path to file certificate, on the file system",
"type": "object",
"type": "object",
"properties": {
"properties": {
"src": {
"src": {
"description": "The path to file containing key for certificate, on the file system"
"description": "The path to file containing key for certificate, on the file system"
}
}
}
}
},
},
"passphrase": {
"passphrase": {
"description": "The passphrase for the certificate",
"description": "The passphrase for the certificate",
"type": "string"
"type": "string"
}
}
}
}
},
},
"cookie-list": {
"cookie-list": {
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "#/definitions/cookie-list",
"id": "#/definitions/cookie-list",
"title": "Certificate List",
"title": "Certificate List",
"description": "A representation of a list of cookies",
"description": "A representation of a list of cookies",
"type": "array",
"type": "array",
"items": {
"items": {
"$ref": "#/definitions/cookie"
"$ref": "#/definitions/cookie"
}
}
},
},
"cookie": {
"cookie": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"type": "object",
"title": "Cookie",
"title": "Cookie",
"id": "#/definitions/cookie",
"id": "#/definitions/cookie",
"description": "A Cookie, that follows the [Google Chrome format](https://developer.chrome.com/extensions/cookies)",
"description": "A Cookie, that follows the [Google Chrome format](https://developer.chrome.com/extensions/cookies)",
"properties": {
"properties": {
"domain": {
"domain": {
"type": "string",
"type": "string",
"description": "The domain for which this cookie is valid."
"description": "The domain for which this cookie is valid."
},
},
"expires": {
"expires": {
"oneOf": [
"oneOf": [
{
{
"type": "string"
"type": "string"
},
},
{
{
"type": "number"
"type": "number"
}
}
],
],
"description": "When the cookie expires."
"description": "When the cookie expires."
},
},
"maxAge": {
"maxAge": {
"type": "string"
"type": "string"
},
},
"hostOnly": {
"hostOnly": {
"type": "boolean",
"type": "boolean",
"description": "True if the cookie is a host-only cookie. (i.e. a request's URL domain must exactly match the domain of the cookie)."
"description": "True if the cookie is a host-only cookie. (i.e. a request's URL domain must exactly match the domain of the cookie)."
},
},
"httpOnly": {
"httpOnly": {
"type": "boolean",
"type": "boolean",
"description": "Indicates if this cookie is HTTP Only. (if True, the cookie is inaccessible to client-side scripts)"
"description": "Indicates if this cookie is HTTP Only. (if True, the cookie is inaccessible to client-side scripts)"
},
},
"name": {
"name": {
"type": "string",
"type": "string",
"description": "This is the name of the Cookie."
"description": "This is the name of the Cookie."
},
},
"path": {
"path": {
"type": "string",
"type": "string",
"description": "The path associated with the Cookie."
"description": "The path associated with the Cookie."
},
},
"secure": {
"secure": {
"type": "boolean",
"type": "boolean",
"description": "Indicates if the 'secure' flag is set on the Cookie, meaning that it is transmitted over secure connections only. (typically HTTPS)"
"description": "Indicates if the 'secure' flag is set on the Cookie, meaning that it is transmitted over secure connections only. (typically HTTPS)"
},
},
"session": {
"session": {
"type": "boolean",
"type": "boolean",
"description": "True if the cookie is a session cookie."
"description": "True if the cookie is a session cookie."
},
},
"value": {
"value": {
"type": "string",
"type": "string",
"description": "The value of the Cookie."
"description": "The value of the Cookie."
},
},
"extensions": {
"extensions": {
"type": "array",
"type": "array",
"description": "Custom attributes for a cookie go here, such as the [Priority Field](https://code.google.com/p/chromium/issues/detail?id=232693)"
"description": "Custom attributes for a cookie go here, such as the [Priority Field](https://code.google.com/p/chromium/issues/detail?id=232693)"
}
}
},
},
"required": [
"required": [
"domain",
"domain",
"path"
"path"
]
]
},
},
"description": {
"description": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "#/definitions/description",
"id": "#/definitions/description",
"description": "A Description can be a raw text, or be an object, which holds the description along with its format.",
"description": "A Description can be a raw text, or be an object, which holds the description along with its format.",
"oneOf": [
"oneOf": [
{
{
"type": "object",
"type": "object",
"title": "Description",
"title": "Description",
"properties": {
"properties": {
"content": {
"content": {
"type": "string",
"type": "string",
"description": "The content of the description goes here, as a raw string."
"description": "The content of the description goes here, as a raw string."
},
},
"type": {
"type": {
"type": "string",
"type": "string",
"description": "Holds the mime type of the raw description content. E.g: 'text/markdown' or 'text/html'.\nThe type is used to correctly render the description when generating documentation, or in the Postman app."
"description": "Holds the mime type of the raw description content. E.g: 'text/markdown' or 'text/html'.\nThe type is used to correctly render the description when generating documentation, or in the Postman app."
},
},
"version": {
"version": {
"description": "Description can have versions associated with it, which should be put in this property."
"description": "Description can have versions associated with it, which should be put in this property."
}
}
}
}
},
},
{
{
"type": "string"
"type": "string"
},
},
{
{
"type": "null"
"type": "null"
}
}
]
]
},
},
"event-list": {
"event-list": {
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "#/definitions/event-list",
"id": "#/definitions/event-list",
"title": "Event List",
"title": "Event List",
"type": "array",
"type": "array",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "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.",
"description": "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.",
"items": {
"items": {
"$ref": "#/definitions/event"
"$ref": "#/definitions/event"
}
}
},
},
"event": {
"event": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "#/definitions/event",
"id": "#/definitions/event",
"title": "Event",
"title": "Event",
"description": "Defines a script associated with an associated event name",
"description": "Defines a script associated with an associated event name",
"type": "object",
"type": "object",
"properties": {
"properties": {
"id": {
"id": {
"type": "string",
"type": "string",
"description": "A unique identifier for the enclosing event."
"description": "A unique identifier for the enclosing event."
},
},
"listen": {
"listen": {
"type": "string",
"type": "string",
"description": "Can be set to `test` or `prerequest` for test scripts or pre-request scripts respectively."
"description": "Can be set to `test` or `prerequest` for test scripts or pre-request scripts respectively."
},
},
"script": {
"script": {
"$ref": "#/definitions/script"
"$ref": "#/definitions/script"
},
},
"disabled": {
"disabled": {
"type": "boolean",
"type": "boolean",
"default": false,
"default": false,
"description": "Indicates whether the event is disabled. If absent, the event is assumed to be enabled."
"description": "Indicates whether the event is disabled. If absent, the event is assumed to be enabled."
}
}
},
},
"required": [
"required": [
"listen"
"listen"
]
]
},
},
"header-list": {
"header-list": {
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "#/definitions/header-list",
"id": "#/definitions/header-list",
"title": "Header List",
"title": "Header List",
"description": "A representation for a list of headers",
"description": "A representation for a list of headers",
"type": "array",
"type": "array",
"items": {
"items": {
"$ref": "#/definitions/header"
"$ref": "#/definitions/header"
}
}
},
},
"header": {
"header": {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"type": "object",
"title": "Header",
"title": "Header",
"id": "#/definitions/header",
"id": "#/definitions/header",
"description": "Represents a single HTTP Header",
"description": "Represents a single HTTP Header",
"properties": {
"properties": {
"key": {
"key": {
"description": "This holds the LHS of the HTTP Header, e.g ``Content-Type`` or ``X-Custom-Header``",
"description": "This holds the LHS of the HTTP Header, e.g ``Content-Type`` or ``X-Custom-Header``",
"type": "string"
"type": "string"
},
},
"value": {
"value": {
"type": "string",
"type": "string",
"description": "The value (or the RHS) of the Header is stored in this field."
"description": "The value (or the RHS) of the Header is stored in this field."
},
},
"disabled": {
"disabled": {
"type": "boolean",
"type": "boolean",
"default": false,
"default": false,
"description": "If set to true, the current header will not be sent with requests."
"description": "If set to true, the current header will not be sent with requests."
},
},
"description": {
"description": {
"$ref": "#/definitions/description"
"$ref": "#/definitions/description"
}
}
},
},
"required": [
"required": [
"key",
"key",
"value"
"value"
]
]
},
},
"info": {
"info": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "#/definitions/info",
"id": "#/definitions/info",
"title": "Information",
"title": "Information",
"description": "Detailed description of the info block",
"description": "Detailed description of the info block",
"type": "object",
"type": "object",
"properties": {
"properties": {
"name": {
"name": {
"type": "string",
"type": "string",
"title": "Name of the collection",
"title": "Name of the collection",
"description": "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."
"description": "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."
},
},
"_postman_id": {
"_postman_id": {
"type": "string",
"type": "string",
"description": "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.\n *Note: This field exists for compatibility reasons with Collection Format V1.*"
"description": "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.\n *Note: This field exists for compatibility reasons with Collection Format V1.*"
},
},
"description": {
"description": {
"$ref": "#/definitions/description"
"$ref": "#/definitions/description"
},
},
"version": {
"version": {
"$ref": "#/definitions/version"
"$ref": "#/definitions/version"
},
},
"schema": {
"schema": {
"description": "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",
"description": "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"
"type": "string"
}
}
},
},
"required": [
"required": [
"name",
"name",
"schema"
"schema"
]
]
},
},
"item-group": {
"item-group": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Folder",
"title": "Folder",
"id": "#/definitions/item-group",
"id": "#/definitions/item-group",
"description": "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.",
"description": "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.",
"type": "object",
"type": "object",
"properties": {
"properties": {
"name": {
"name": {
"type": "string",
"type": "string",
"description": "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."
"description": "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."
},
},
"description": {
"description": {
"$ref": "#/definitions/description"
"$ref": "#/definitions/description"
},
},
"variable": {
"variable": {
"$ref": "#/definitions/variable-list"
"$ref": "#/definitions/variable-list"
},
},
"item": {
"item": {
"description": "Items are entities which contain an actual HTTP request, and sample responses attached to it. Folders may contain many items.",
"description": "Items are entities which contain an actual HTTP request, and sample responses attached to it. Folders may contain many items.",
"type": "array",
"type": "array",
"items": {
"items": {
"title": "Items",
"title": "Items",
"anyOf": [
"anyOf": [
{
{
"$ref": "#/definitions/item"
"$ref": "#/definitions/item"
},
},
{
{
"$ref": "#/definitions/item-group"
"$ref": "#/definitions/item-group"
}
}
]
]
}
}
},
},
"event": {
"event": {
"$ref": "#/definitions/event-list"
"$ref": "#/definitions/event-list"
},
},
"auth": {
"auth": {
"oneOf": [
"oneOf": [
{
{
"type": "null"
"type": "null"
},
},
{
{
"$ref": "#/definitions/auth"
"$ref": "#/definitions/auth"
}
}
]
]
},
},
"protocolProfileBehavior": {
"protocolProfileBehavior": {
"$ref": "#/definitions/protocol-profile-behavior"
"$ref": "#/definitions/protocol-profile-behavior"
}
}
},
},
"required": [
"required": [
"item"
"item"
]
]
},
},
"item": {
"item": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"type": "object",
"title": "Item",
"title": "Item",
"id": "#/definitions/item",
"id": "#/definitions/item",
"description": "Items are entities which contain an actual HTTP request, and sample responses attached to it.",
"description": "Items are entities which contain an actual HTTP request, and sample responses attached to it.",
"properties": {
"properties": {
"id": {
"id": {
"type": "string",
"type": "string",
"description": "A unique ID that is used to identify collections internally"
"description": "A unique ID that is used to identify collections internally"
},
},
"name": {
"name": {
"type": "string",
"type": "string",
"description": "A human readable identifier for the current item."
"description": "A human readable identifier for the current item."
},
},
"description": {
"description": {
"$ref": "#/definitions/description"
"$ref": "#/definitions/description"
},
},
"variable": {
"variable": {
"$ref": "#/definitions/variable-list"
"$ref": "#/definitions/variable-list"
},
},
"event": {
"event": {
"$ref": "#/definitions/event-list"
"$ref": "#/definitions/event-list"
},
},
"request": {
"request": {
"$ref": "#/definitions/request"
"$ref": "#/definitions/request"
},
},
"response": {
"response": {
"type": "array",
"type": "array",
"title": "Responses",
"title": "Responses",
"items": {
"items": {
"$ref": "#/definitions/response"
"$ref": "#/definitions/response"
}
}
},
},
"protocolProfileBehavior": {
"protocolProfileBehavior": {
"$ref": "#/definitions/protocol-profile-behavior"
"$ref": "#/definitions/protocol-profile-behavior"
}
}
},
},
"required": [
"required": [
"request"
"request"
]
]
},
},
"protocol-profile-behavior": {
"protocol-profile-behavior": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"type": "object",
"title": "Protocol Profile Behavior",
"title": "Protocol Profile Behavior",
"id": "#/definitions/protocol-profile-behavior",
"id": "#/definitions/protocol-profile-behavior",
"description": "Set of configurations used to alter the usual behavior of sending the request"
"description": "Set of configurations used to alter the usual behavior of sending the request"
},
},
"proxy-config": {
"proxy-config": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "#/definitions/proxy-config",
"id": "#/definitions/proxy-config",
"title": "Proxy Config",
"title": "Proxy Config",
"description": "Using the Proxy, you can configure your custom proxy into the postman for particular url match",
"description": "Using the Proxy, you can configure your custom proxy into the postman for particular url match",
"type": "object",
"type": "object",
"properties": {
"properties": {
"match": {
"match": {
"default": "http+https://*/*",
"default": "http+https://*/*",
"description": "The Url match for which the proxy config is defined",
"description": "The Url match for which the proxy config is defined",
"type": "string"
"type": "string"
},
},
"host": {
"host": {
"type": "string",
"type": "string",
"description": "The proxy server host"
"description": "The proxy server host"
},
},
"port": {
"port": {
"type": "integer",
"type": "integer",
"minimum": 0,
"minimum": 0,
"default": 8080,
"default": 8080,
"description": "The proxy server port"
"description": "The proxy server port"
},
},
"tunnel": {
"tunnel": {
"description": "The tunneling details for the proxy config",
"description": "The tunneling details for the proxy config",
"default": false,
"default": false,
"type": "boolean"
"type": "boolean"
},
},
"disabled": {
"disabled": {
"type": "boolean",
"type": "boolean",
"default": false,
"default": false,
"description": "When set to true, ignores this proxy configuration entity"
"description": "When set to true, ignores this proxy configuration entity"
}
}
}
}
},
},
"request": {
"request": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "#/definitions/request",
"id": "#/definitions/request",
"title": "Request",
"title": "Request",
"description": "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'.",
"description": "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'.",
"oneOf": [
"oneOf": [
{
{
"type": "object",
"type": "object",
"title": "Request",
"title": "Request",
"properties": {
"properties": {
"url": {
"url": {
"$ref": "#/definitions/url"
"$ref": "#/definitions/url"
},
},
"auth": {
"auth": {
"oneOf": [
"oneOf": [
{
{
"type": "null"
"type": "null"
},
},
{
{
"$ref": "#/definitions/auth"
"$ref": "#/definitions/auth"
}
}
]
]
},
},
"proxy": {
"proxy": {
"$ref": "#/definitions/proxy-config"
"$ref": "#/definitions/proxy-c
},
"certificate": {
"$ref": "#/definitions/certificate"
},
"method": {
"anyOf": [
{
"description": "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"
]
},
{
"description": "The Custom HTTP method associated with this request.",
"type": "string"
}
]
},
"description": {
"$ref": "#/definitions/description"
},
"header": {
"oneOf":