{ "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { }, "description": "Portman by Apideck allows you to port your OpenApi Spec to a Postman Collection, inject a powerful test suite, and run your tests with Newman. Details about all configuration options can be found at http://getportman.com.", "properties": { "$schema": { "type": "string" }, "assignVariables": { "items": { "additionalProperties": false, "properties": { "collectionVariables": { "items": { "additionalProperties": false, "properties": { "name": { "type": "string" }, "requestBodyProp": { "type": "string" }, "responseBodyProp": { "type": "string" }, "responseHeaderProp": { "type": "string" }, "value": {} }, "type": "object" }, "type": "array" }, "excludeForOperations": { "items": { "type": "string" }, "type": "array" }, "openApiOperation": { "type": "string" }, "openApiOperationId": { "type": "string" }, "openApiOperationIds": { "items": { "type": "string" }, "type": "array" } }, "required": [ "collectionVariables" ], "type": "object" }, "type": "array" }, "globals": { "additionalProperties": false, "properties": { "collectionPreRequestScripts": { "items": { "type": "string" }, "type": "array" }, "collectionTestScripts": { "items": { "type": "string" }, "type": "array" }, "collectionVariables": { "additionalProperties": {}, "type": "object" }, "keyValueReplacements": { "additionalProperties": {}, "type": "object" }, "orderOfOperations": { "items": { "type": "string" }, "type": "array" }, "orderOfFolders": { "items": { "type": "string" }, "type": "array" }, "portmanReplacements": { "items": { "additionalProperties": false, "properties": { "replaceWith": { "type": "string" }, "searchFor": { "type": "string" } }, "required": [ "searchFor", "replaceWith" ], "type": "object" }, "type": "array" }, "rawReplacements": { "items": { "additionalProperties": false, "properties": { "replaceWith": { "type": "string" }, "searchFor": { "type": "string" } }, "required": [ "searchFor", "replaceWith" ], "type": "object" }, "type": "array" }, "securityOverwrites": { "additionalProperties": false, "properties": { "apiKey": { "additionalProperties": false, "properties": { "in": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "value" ], "type": "object" }, "awsv4": { "items": { "additionalProperties": false, "properties": { "key": { "type": "string" }, "type": { "type": "string" }, "value": { } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "basic": { "additionalProperties": false, "properties": { "password": { "type": "string" }, "username": { "type": "string" } }, "required": [ "username", "password" ], "type": "object" }, "bearer": { "additionalProperties": false, "properties": { "token": { "type": "string" } }, "required": [ "token" ], "type": "object" }, "digest": { "items": { "additionalProperties": false, "properties": { "key": { "type": "string" }, "type": { "type": "string" }, "value": { } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "edgegrid": { "items": { "additionalProperties": false, "properties": { "key": { "type": "string" }, "type": { "type": "string" }, "value": { } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "hawk": { "items": { "additionalProperties": false, "properties": { "key": { "type": "string" }, "type": { "type": "string" }, "value": { } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "ntlm": { "items": { "additionalProperties": false, "properties": { "key": { "type": "string" }, "type": { "type": "string" }, "value": { } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "oauth1": { "items": { "additionalProperties": false, "properties": { "key": { "type": "string" }, "type": { "type": "string" }, "value": { } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "oauth2": { "items": { "additionalProperties": false, "properties": { "key": { "type": "string" }, "type": { "type": "string" }, "value": { } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "other": { "additionalProperties": { "anyOf": [ {}, { "items": {}, "type": "array" } ] }, "properties": { "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "remove": { "type": "boolean" } }, "type": "object" }, "separatorSymbol": { "type": "string" }, "stripResponseExamples": { "type": "boolean" }, "valueReplacements": { "additionalProperties": {}, "type": "object" }, "variableCasing": { "enum": [ "camelCase", "pascalCase", "kebabCase", "trainCase", "snakeCase", "adaCase", "constantCase", "cobolCase", "dotNotation", "lowerCase", "upperCase" ], "type": "string" } }, "type": "object" }, "operationPreRequestScripts": { "items": { "additionalProperties": false, "properties": { "excludeForOperations": { "items": { "type": "string" }, "type": "array" }, "openApiOperation": { "type": "string" }, "openApiOperationId": { "type": "string" }, "openApiOperationIds": { "items": { "type": "string" }, "type": "array" }, "scripts": { "items": { "type": "string" }, "type": "array" } }, "required": [ "scripts" ], "type": "object" }, "type": "array" }, "overwrites": { "items": { "additionalProperties": false, "properties": { "excludeForOperations": { "items": { "type": "string" }, "type": "array" }, "openApiOperation": { "type": "string" }, "openApiOperationId": { "type": "string" }, "openApiOperationIds": { "items": { "type": "string" }, "type": "array" }, "overwriteRequestBaseUrl": { "additionalProperties": false, "properties": { "overwrite": { "type": "boolean" }, "remove": { "type": "boolean" }, "value": { "type": "string" } }, "type": "object" }, "overwriteRequestBody": { "items": { "additionalProperties": false, "properties": { "description": { "type": "string" }, "disable": { "type": "boolean" }, "insert": { "type": "boolean" }, "key": { "type": "string" }, "overwrite": { "type": "boolean" }, "remove": { "type": "boolean" }, "value": {} }, "required": [ "key" ], "type": "object" }, "type": "array" }, "overwriteRequestHeaders": { "items": { "additionalProperties": false, "properties": { "description": { "type": "string" }, "disable": { "type": "boolean" }, "insert": { "type": "boolean" }, "key": { "type": "string" }, "overwrite": { "type": "boolean" }, "remove": { "type": "boolean" }, "value": { "type": "string" } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "overwriteRequestPathIdVariables": { "items": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "type": "array" }, "overwriteRequestPathVariables": { "items": { "additionalProperties": false, "properties": { "description": { "type": "string" }, "disable": { "type": "boolean" }, "insert": { "type": "boolean" }, "key": { "type": "string" }, "overwrite": { "type": "boolean" }, "remove": { "type": "boolean" }, "value": { "type": "string" } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "overwriteRequestQueryParams": { "items": { "additionalProperties": false, "properties": { "description": { "type": "string" }, "disable": { "type": "boolean" }, "insert": { "type": "boolean" }, "key": { "type": "string" }, "overwrite": { "type": "boolean" }, "remove": { "type": "boolean" }, "value": { "type": "string" } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "overwriteRequestSecurity": { "additionalProperties": false, "properties": { "apiKey": { "additionalProperties": false, "properties": { "in": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "value" ], "type": "object" }, "awsv4": { "items": { "additionalProperties": false, "properties": { "key": { "type": "string" }, "type": { "type": "string" }, "value": { } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "basic": { "additionalProperties": false, "properties": { "password": { "type": "string" }, "username": { "type": "string" } }, "required": [ "username", "password" ], "type": "object" }, "bearer": { "additionalProperties": false, "properties": { "token": { "type": "string" } }, "required": [ "token" ], "type": "object" }, "digest": { "items": { "additionalProperties": false, "properties": { "key": { "type": "string" }, "type": { "type": "string" }, "value": { } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "edgegrid": { "items": { "additionalProperties": false, "properties": { "key": { "type": "string" }, "type": { "type": "string" }, "value": { } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "hawk": { "items": { "additionalProperties": false, "properties": { "key": { "type": "string" }, "type": { "type": "string" }, "value": { } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "ntlm": { "items": { "additionalProperties": false, "properties": { "key": { "type": "string" }, "type": { "type": "string" }, "value": { } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "oauth1": { "items": { "additionalProperties": false, "properties": { "key": { "type": "string" }, "type": { "type": "string" }, "value": { } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "oauth2": { "items": { "additionalProperties": false, "properties": { "key": { "type": "string" }, "type": { "type": "string" }, "value": { } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "other": { "additionalProperties": { "anyOf": [ {}, { "items": {}, "type": "array" } ] }, "properties": { "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "remove": { "type": "boolean" } }, "type": "object" } }, "type": "object" }, "type": "array" }, "tests": { "additionalProperties": false, "properties": { "contentTests": { "items": { "additionalProperties": false, "properties": { "excludeForOperations": { "items": { "type": "string" }, "type": "array" }, "openApiOperation": { "type": "string" }, "openApiOperationId": { "type": "string" }, "openApiOperationIds": { "items": { "type": "string" }, "type": "array" }, "responseBodyTests": { "items": { "additionalProperties": false, "properties": { "assert": { "type": "string" }, "contains": { "type": "string" }, "key": { "type": "string" }, "length": { "type": [ "string", "number" ] }, "maxLength": { "type": [ "string", "number" ] }, "minLength": { "type": [ "string", "number" ] }, "notExist": { "type": "boolean" }, "oneOf": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "items": { "type": "number" }, "type": "array" }, { "items": { "type": "boolean" }, "type": "array" } ] }, "value": { "type": [ "string", "number", "boolean", "null" ] } }, "required": [ "key" ], "type": "object" }, "type": "array" }, "responseHeaderTests": { "items": { "additionalProperties": false, "properties": { "assert": { "type": "string" }, "contains": { "type": "string" }, "key": { "type": "string" }, "length": { "type": [ "string", "number" ] }, "maxLength": { "type": [ "string", "number" ] }, "minLength": { "type": [ "string", "number" ] }, "notExist": { "type": "boolean" }, "oneOf": { "items": { "type": "string" }, "type": "array" }, "value": { "type": [ "string", "number", "boolean" ] } }, "required": [ "key" ], "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" }, "contractTests": { "items": { "additionalProperties": false, "properties": { "additionalProperties": { "additionalProperties": false, "properties": { "additionalProperties": { "type": "boolean" }, "enabled": { "type": "boolean" }, "excludeForOperations": { "items": { "type": "string" }, "type": "array" } }, "required": [ "enabled" ], "type": "object" }, "contentType": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "excludeForOperations": { "items": { "type": "string" }, "type": "array" } }, "required": [ "enabled" ], "type": "object" }, "excludeForOperations": { "items": { "type": "string" }, "type": "array" }, "headersPresent": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "excludeForOperations": { "items": { "type": "string" }, "type": "array" } }, "required": [ "enabled" ], "type": "object" }, "jsonBody": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "excludeForOperations": { "items": { "type": "string" }, "type": "array" } }, "required": [ "enabled" ], "type": "object" }, "openApiOperation": { "type": "string" }, "openApiOperationId": { "type": "string" }, "openApiOperationIds": { "items": { "type": "string" }, "type": "array" }, "openApiRequest": { "type": "string" }, "openApiResponse": { "type": "string" }, "responseTime": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "excludeForOperations": { "items": { "type": "string" }, "type": "array" }, "maxMs": { "type": "number" } }, "required": [ "enabled", "maxMs" ], "type": "object" }, "schemaValidation": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "excludeForOperations": { "items": { "type": "string" }, "type": "array" }, "additionalProperties": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "statusCode": { "additionalProperties": false, "properties": { "code": { "type": "number" }, "enabled": { "type": "boolean" }, "excludeForOperations": { "items": { "type": "string" }, "type": "array" } }, "required": [ "enabled" ], "type": "object" }, "statusSuccess": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "excludeForOperations": { "items": { "type": "string" }, "type": "array" } }, "required": [ "enabled" ], "type": "object" } }, "type": "object" }, "type": "array" }, "extendTests": { "items": { "additionalProperties": false, "properties": { "append": { "type": "boolean" }, "excludeForOperations": { "items": { "type": "string" }, "type": "array" }, "openApiOperation": { "type": "string" }, "openApiOperationId": { "type": "string" }, "openApiOperationIds": { "items": { "type": "string" }, "type": "array" }, "overwrite": { "type": "boolean" }, "tests": { "items": { "type": "string" }, "type": "array" } }, "required": [ "tests" ], "type": "object" }, "type": "array" }, "integrationTests": { "items": { "additionalProperties": false, "properties": { "name": { "type": "string" }, "operations": { "items": { "additionalProperties": false, "properties": { "openApiOperationId": { "type": "string" }, "openApiResponse": { "type": "string" }, "openApiRequest": { "type": "string" }, "variations": { "items": { "additionalProperties": false, "properties": { "assignVariables": { "items": { "additionalProperties": false, "properties": { "collectionVariables": { "items": { "additionalProperties": false, "properties": { "name": { "type": "string" }, "requestBodyProp": { "type": "string" }, "responseBodyProp": { "type": "string" }, "responseHeaderProp": { "type": "string" }, "value": {} }, "type": "object" }, "type": "array" }, "excludeForOperations": { "items": { "type": "string" }, "type": "array" }, "openApiOperation": { "type": "string" }, "openApiOperationId": { "type": "string" }, "openApiOperationIds": { "items": { "type": "string" }, "type": "array" } }, "required": [ "collectionVariables" ], "type": "object" }, "type": "array" }, "extendTests": { "items": { "additionalProperties": false, "properties": { "append": { "type": "boolean" }, "excludeForOperations": { "items": { "type": "string" }, "type": "array" }, "openApiOperation": { "type": "string" }, "openApiOperationId": { "type": "string" }, "openApiOperationIds": { "items": { "type": "string" }, "type": "array" }, "overwrite": { "type": "boolean" }, "tests": { "items": { "type": "string" }, "type": "array" } }, "required": [ "tests" ], "type": "object" }, "type": "array" }, "fuzzing": { "items": { "additionalProperties": false, "properties": { "requestBody": { "items": { "additionalProperties": false, "properties": { "maxLengthFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "maximumNumberFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "minLengthFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "minimumNumberFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "requiredFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" } }, "type": "object" }, "type": "array" }, "requestHeaders": { "items": { "additionalProperties": false, "properties": { "maxLengthFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "maximumNumberFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "minLengthFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "minimumNumberFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "requiredFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" } }, "type": "object" }, "type": "array" }, "requestQueryParams": { "items": { "additionalProperties": false, "properties": { "maxLengthFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "maximumNumberFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "minLengthFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "minimumNumberFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "requiredFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" }, "name": { "type": "string" }, "openApiResponse": { "type": "string" }, "openApiRequest": { "type": "string" }, "operationPreRequestScripts": { "items": { "additionalProperties": false, "properties": { "excludeForOperations": { "items": { "type": "string" }, "type": "array" }, "openApiOperation": { "type": "string" }, "openApiOperationId": { "type": "string" }, "openApiOperationIds": { "items": { "type": "string" }, "type": "array" }, "scripts": { "items": { "type": "string" }, "type": "array" } }, "required": [ "scripts" ], "type": "object" }, "type": "array" }, "overwrites": {}, "tests": {} }, "required": [ "name", "tests" ], "type": "object" }, "type": "array" } }, "required": [ "openApiOperationId", "variations" ], "type": "object" }, "type": "array" } }, "required": [ "name", "operations" ], "type": "object" }, "type": "array" }, "variationTests": { "items": { "additionalProperties": false, "properties": { "excludeForOperations": { "items": { "type": "string" }, "type": "array" }, "openApiOperation": { "type": "string" }, "openApiOperationId": { "type": "string" }, "openApiOperationIds": { "items": { "type": "string" }, "type": "array" }, "openApiResponse": { "type": "string" }, "openApiRequest": { "type": "string" }, "variations": { "items": { "additionalProperties": false, "properties": { "assignVariables": { "items": { "additionalProperties": false, "properties": { "collectionVariables": { "items": { "additionalProperties": false, "properties": { "name": { "type": "string" }, "requestBodyProp": { "type": "string" }, "responseBodyProp": { "type": "string" }, "responseHeaderProp": { "type": "string" }, "value": {} }, "type": "object" }, "type": "array" }, "excludeForOperations": { "items": { "type": "string" }, "type": "array" }, "openApiOperation": { "type": "string" }, "openApiOperationId": { "type": "string" }, "openApiOperationIds": { "items": { "type": "string" }, "type": "array" } }, "required": [ "collectionVariables" ], "type": "object" }, "type": "array" }, "extendTests": { "items": { "additionalProperties": false, "properties": { "append": { "type": "boolean" }, "excludeForOperations": { "items": { "type": "string" }, "type": "array" }, "openApiOperation": { "type": "string" }, "openApiOperationId": { "type": "string" }, "openApiOperationIds": { "items": { "type": "string" }, "type": "array" }, "overwrite": { "type": "boolean" }, "tests": { "items": { "type": "string" }, "type": "array" } }, "required": [ "tests" ], "type": "object" }, "type": "array" }, "fuzzing": { "items": { "additionalProperties": false, "properties": { "requestBody": { "items": { "additionalProperties": false, "properties": { "maxLengthFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "maximumNumberFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "minLengthFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "minimumNumberFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "requiredFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" } }, "type": "object" }, "type": "array" }, "requestHeaders": { "items": { "additionalProperties": false, "properties": { "maxLengthFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "maximumNumberFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "minLengthFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "minimumNumberFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "requiredFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" } }, "type": "object" }, "type": "array" }, "requestQueryParams": { "items": { "additionalProperties": false, "properties": { "maxLengthFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "maximumNumberFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "minLengthFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "minimumNumberFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" }, "requiredFields": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "type": "object" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" }, "name": { "type": "string" }, "openApiRequest": { "type": "string" }, "openApiResponse": { "type": "string" }, "operationPreRequestScripts": { "items": { "additionalProperties": false, "properties": { "excludeForOperations": { "items": { "type": "string" }, "type": "array" }, "openApiOperation": { "type": "string" }, "openApiOperationId": { "type": "string" }, "openApiOperationIds": { "items": { "type": "string" }, "type": "array" }, "scripts": { "items": { "type": "string" }, "type": "array" } }, "required": [ "scripts" ], "type": "object" }, "type": "array" }, "overwrites": {}, "tests": {} }, "required": [ "name", "tests" ], "type": "object" }, "type": "array" } }, "required": [ "variations" ], "type": "object" }, "type": "array" } }, "type": "object" }, "version": { "type": "number" } }, "type": "object" }