JSON schema for Portman's configuration file Json Format

Use this form to visualize JSON schema for Portman's configuration file.

assignVariables assignVariables

#	openApiOperation	openApiOperationId	Actions
{{$index+1}}.	{{row.openApiOperation}}	{{row.openApiOperationId}}

.globals

_

globals.collectionPreRequestScripts collectionPreRequestScripts

#	Values	Actions
{{$index+1}}.

.globals.keyValueReplacements

_

globals.orderOfOperations orderOfOperations

#	Values	Actions
{{$index+1}}.

globals.portmanReplacements portmanReplacements

#	replaceWith	searchFor	Actions
{{$index+1}}.

globals.rawReplacements rawReplacements

#	replaceWith	searchFor	Actions
{{$index+1}}.

.globals.securityOverwrites

_

.globals.securityOverwrites.apiKey

_

globals.securityOverwrites.apiKey.in

globals.securityOverwrites.apiKey.key

globals.securityOverwrites.apiKey.value

.globals.securityOverwrites.basic

_

globals.securityOverwrites.basic.password

globals.securityOverwrites.basic.username

.globals.securityOverwrites.bearer

_

globals.securityOverwrites.bearer.token

.globals.securityOverwrites.other

_

globals.securityOverwrites.other.type

.globals.valueReplacements

_

operationPreRequestScripts operationPreRequestScripts

#	openApiOperation	openApiOperationId	Actions
{{$index+1}}.	{{row.openApiOperation}}	{{row.openApiOperationId}}

overwrites overwrites

#	openApiOperation	openApiOperationId	overwriteRequestSecurity.apiKey.in	overwriteRequestSecurity.apiKey.key	overwriteRequestSecurity.apiKey.value	overwriteRequestSecurity.basic.password	overwriteRequestSecurity.basic.username	overwriteRequestSecurity.bearer.token	overwriteRequestSecurity.other.type	Actions
{{$index+1}}.	{{row.openApiOperation}}	{{row.openApiOperationId}}	{{row.overwriteRequestSecurity.apiKey.in}}	{{row.overwriteRequestSecurity.apiKey.key}}	{{row.overwriteRequestSecurity.apiKey.value}}	{{row.overwriteRequestSecurity.basic.password}}	{{row.overwriteRequestSecurity.basic.username}}	{{row.overwriteRequestSecurity.bearer.token}}	{{row.overwriteRequestSecurity.other.type}}

.tests

_

version

tests.contentTests contentTests

#	openApiOperation	openApiOperationId	Actions
{{$index+1}}.	{{row.openApiOperation}}	{{row.openApiOperationId}}

tests.contractTests contractTests

#	contentType.enabled	headersPresent.enabled	jsonBody.enabled	openApiOperation	openApiOperationId	responseTime.enabled	responseTime.maxMs	schemaValidation.enabled	statusCode.code	statusCode.enabled	Actions
{{$index+1}}.	{{row.contentType.enabledSelected.DisplayText}}	{{row.headersPresent.enabledSelected.DisplayText}}	{{row.jsonBody.enabledSelected.DisplayText}}	{{row.openApiOperation}}	{{row.openApiOperationId}}	{{row.responseTime.enabledSelected.DisplayText}}	{{row.responseTime.maxMs}}	{{row.schemaValidation.enabledSelected.DisplayText}}	{{row.statusCode.code}}	{{row.statusCode.enabledSelected.DisplayText}}

tests.extendTests extendTests

#	append	openApiOperation	openApiOperationId	overwrite	Actions
{{$index+1}}.	{{row.appendSelected.DisplayText}}	{{row.openApiOperation}}	{{row.openApiOperationId}}	{{row.overwriteSelected.DisplayText}}

tests.integrationTests integrationTests

#	name	Actions
{{$index+1}}.	{{row.name}}

tests.variationTests variationTests

#	openApiOperation	openApiOperationId	Actions
{{$index+1}}.	{{row.openApiOperation}}	{{row.openApiOperationId}}

openApiOperation

openApiOperationId

collectionVariables collectionVariables

#	name	requestBodyProp	responseBodyProp	responseHeaderProp	Actions
{{$index+1}}.

excludeForOperations excludeForOperations

#	Values	Actions
{{$index+1}}.

openApiOperationIds openApiOperationIds

#	Values	Actions
{{$index+1}}.

openApiOperation

openApiOperationId

excludeForOperations excludeForOperations

#	Values	Actions
{{$index+1}}.

openApiOperationIds openApiOperationIds

#	Values	Actions
{{$index+1}}.

scripts scripts

#	Values	Actions
{{$index+1}}.

openApiOperation

openApiOperationId

excludeForOperations excludeForOperations

#	Values	Actions
{{$index+1}}.

openApiOperationIds openApiOperationIds

#	Values	Actions
{{$index+1}}.

overwriteRequestBody overwriteRequestBody

#	key	overwrite	remove	Actions
{{$index+1}}.

overwriteRequestHeaders overwriteRequestHeaders

#	disable	key	overwrite	remove	value	Actions
{{$index+1}}.

overwriteRequestPathIdVariables overwriteRequestPathIdVariables

#	enabled	Actions
{{$index+1}}.

overwriteRequestPathVariables overwriteRequestPathVariables

#	key	overwrite	value	Actions
{{$index+1}}.

overwriteRequestQueryParams overwriteRequestQueryParams

#	disable	key	overwrite	remove	value	Actions
{{$index+1}}.

.overwriteRequestSecurity

_overwrites

.overwriteRequestSecurity.apiKey

_overwrites

overwriteRequestSecurity.apiKey.in

overwriteRequestSecurity.apiKey.key

overwriteRequestSecurity.apiKey.value

.overwriteRequestSecurity.basic

_overwrites

overwriteRequestSecurity.basic.password

overwriteRequestSecurity.basic.username

.overwriteRequestSecurity.bearer

_overwrites

overwriteRequestSecurity.bearer.token

.overwriteRequestSecurity.other

_overwrites

overwriteRequestSecurity.other.type

openApiOperation

openApiOperationId

excludeForOperations excludeForOperations

#	Values	Actions
{{$index+1}}.

openApiOperationIds openApiOperationIds

#	Values	Actions
{{$index+1}}.

responseBodyTests responseBodyTests

#	key	Actions
{{$index+1}}.

.contentType

_tests_contractTests

contentType.enabled

contentType.excludeForOperations excludeForOperations

#	Values	Actions
{{$index+1}}.

excludeForOperations excludeForOperations

#	Values	Actions
{{$index+1}}.

.headersPresent

_tests_contractTests

headersPresent.enabled

headersPresent.excludeForOperations excludeForOperations

#	Values	Actions
{{$index+1}}.

.jsonBody

_tests_contractTests

jsonBody.enabled

openApiOperation

openApiOperationId

jsonBody.excludeForOperations excludeForOperations

#	Values	Actions
{{$index+1}}.

openApiOperationIds openApiOperationIds

#	Values	Actions
{{$index+1}}.

.responseTime

_tests_contractTests

responseTime.enabled

responseTime.maxMs

responseTime.excludeForOperations excludeForOperations

#	Values	Actions
{{$index+1}}.

.schemaValidation

_tests_contractTests

schemaValidation.enabled

schemaValidation.excludeForOperations excludeForOperations

#	Values	Actions
{{$index+1}}.

.statusCode

_tests_contractTests

statusCode.code

statusCode.enabled

statusCode.excludeForOperations excludeForOperations

#	Values	Actions
{{$index+1}}.

.statusSuccess

_tests_contractTests

statusSuccess.enabled

statusSuccess.excludeForOperations excludeForOperations

#	Values	Actions
{{$index+1}}.

append

openApiOperation

openApiOperationId

overwrite

excludeForOperations excludeForOperations

#	Values	Actions
{{$index+1}}.

openApiOperationIds openApiOperationIds

#	Values	Actions
{{$index+1}}.

tests tests

#	Values	Actions
{{$index+1}}.

name

operations operations

#	openApiOperationId	Actions
{{$index+1}}.	{{row.openApiOperationId}}

openApiOperationId

variations variations

#	name	openApiResponse	Actions
{{$index+1}}.	{{row.name}}	{{row.openApiResponse}}

name

openApiResponse

assignVariables assignVariables

#	openApiOperation	openApiOperationId	Actions
{{$index+1}}.	{{row.openApiOperation}}	{{row.openApiOperationId}}

extendTests extendTests

#	append	openApiOperation	openApiOperationId	overwrite	Actions
{{$index+1}}.	{{row.appendSelected.DisplayText}}	{{row.openApiOperation}}	{{row.openApiOperationId}}	{{row.overwriteSelected.DisplayText}}

operationPreRequestScripts operationPreRequestScripts

#	openApiOperation	openApiOperationId	Actions
{{$index+1}}.	{{row.openApiOperation}}	{{row.openApiOperationId}}

append

openApiOperation

openApiOperationId

overwrite

excludeForOperations excludeForOperations

#	Values	Actions
{{$index+1}}.

openApiOperationIds openApiOperationIds

#	Values	Actions
{{$index+1}}.

tests tests

#	Values	Actions
{{$index+1}}.

openApiOperation

openApiOperationId

excludeForOperations excludeForOperations

#	Values	Actions
{{$index+1}}.

openApiOperationIds openApiOperationIds

#	Values	Actions
{{$index+1}}.

variations variations

#	name	openApiResponse	Actions
{{$index+1}}.	{{row.name}}	{{row.openApiResponse}}

ToolMatter

Your Apps in Action

Use this form to visualize JSON schema for Portman's configuration file.

{{repoTitle.MainEntity}}

assignVariables assignVariables

_

globals.collectionPreRequestScripts collectionPreRequestScripts

_

globals.orderOfOperations orderOfOperations

globals.portmanReplacements portmanReplacements

globals.rawReplacements rawReplacements

_

_

_

_

_

_

operationPreRequestScripts operationPreRequestScripts

overwrites overwrites

_

tests.contentTests contentTests

tests.contractTests contractTests

tests.extendTests extendTests

tests.integrationTests integrationTests

tests.variationTests variationTests

{{repoTitle.MainEntity}}

collectionVariables collectionVariables

excludeForOperations excludeForOperations

openApiOperationIds openApiOperationIds

{{repoTitle.MainEntity}}

{{repoTitle.MainEntity}}

{{repoTitle.MainEntity}}

{{repoTitle.MainEntity}}

excludeForOperations excludeForOperations

openApiOperationIds openApiOperationIds

scripts scripts

{{repoTitle.MainEntity}}

excludeForOperations excludeForOperations

openApiOperationIds openApiOperationIds

overwriteRequestBody overwriteRequestBody

overwriteRequestHeaders overwriteRequestHeaders

overwriteRequestPathIdVariables overwriteRequestPathIdVariables

overwriteRequestPathVariables overwriteRequestPathVariables

overwriteRequestQueryParams overwriteRequestQueryParams

_overwrites

_overwrites

_overwrites

_overwrites

_overwrites

{{repoTitle.MainEntity}}

{{repoTitle.MainEntity}}

{{repoTitle.MainEntity}}

{{repoTitle.MainEntity}}

{{repoTitle.MainEntity}}

{{repoTitle.MainEntity}}

excludeForOperations excludeForOperations

openApiOperationIds openApiOperationIds

responseBodyTests responseBodyTests

{{repoTitle.MainEntity}}

{{repoTitle.MainEntity}}

_tests_contractTests

contentType.excludeForOperations excludeForOperations

excludeForOperations excludeForOperations

_tests_contractTests

headersPresent.excludeForOperations excludeForOperations

_tests_contractTests

jsonBody.excludeForOperations excludeForOperations

openApiOperationIds openApiOperationIds

_tests_contractTests

responseTime.excludeForOperations excludeForOperations

_tests_contractTests

schemaValidation.excludeForOperations excludeForOperations

_tests_contractTests

statusCode.excludeForOperations excludeForOperations

_tests_contractTests

statusSuccess.excludeForOperations excludeForOperations

{{repoTitle.MainEntity}}

excludeForOperations excludeForOperations

openApiOperationIds openApiOperationIds

tests tests