portman.json

Portman's configuration file

Type object
File match portman-config.json portman.json
Schema URL https://catalog.lintel.tools/schemas/schemastore/portman-json/latest.json
Source https://raw.githubusercontent.com/apideck-libraries/portman/main/src/utils/portman-config-schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

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 string
assignVariables object[]
globals object
13 nested properties
collectionPreRequestScripts string[]
collectionTestScripts string[]
collectionVariables Record<string, any>
keyValueReplacements Record<string, any>
orderOfOperations string[]
orderOfFolders string[]
portmanReplacements object[]
rawReplacements object[]
securityOverwrites object
12 nested properties
apiKey object
3 nested properties
value string required
in string
key string
awsv4 object[]
basic object
2 nested properties
password string required
username string required
bearer object
1 nested properties
token string required
digest object[]
edgegrid object[]
hawk object[]
ntlm object[]
oauth1 object[]
oauth2 object[]
other Record<string, array>
1 nested properties
type string required
remove boolean
separatorSymbol string
stripResponseExamples boolean
valueReplacements Record<string, any>
variableCasing string
Values: "camelCase" "pascalCase" "kebabCase" "trainCase" "snakeCase" "adaCase" "constantCase" "cobolCase" "dotNotation" "lowerCase" "upperCase"
operationPreRequestScripts object[]
overwrites object[]
tests object
5 nested properties
contentTests object[]
contractTests object[]
extendTests object[]
integrationTests object[]
variationTests object[]
version number