OPTIONS.md

August 26, 2025 · View on GitHub

idtypeavailable optionsdefaultdescriptionusageversion
requestNameSourceenumURL, FallbackFallbackDetermines how the requests inside the generated collection will be named. If “Fallback” is selected, the request will be named after one of the following schema values: summary, operationId, description, url.CONVERSION, VALIDATIONv2, v1
indentCharacterenumSpace, TabSpaceOption for setting indentation character.CONVERSIONv2, v1
collapseFoldersboolean-trueImporting will collapse all folders that have only one child element and lack persistent folder-level data.CONVERSIONv1
optimizeConversionboolean-trueOptimizes conversion for large specification, disabling this option might affect the performance of conversion.CONVERSIONv1
requestParametersResolutionenumExample, SchemaSchemaSelect whether to generate the request parameters based on the schema or the example in the schema.CONVERSIONv1
exampleParametersResolutionenumExample, SchemaExampleSelect whether to generate the response parameters based on the schema or the example in the schema.CONVERSIONv1
disabledParametersValidationboolean-trueWhether disabled parameters of collection should be validatedVALIDATIONv2, v1
parametersResolutionenumExample, SchemaSchemaSelect whether to generate the request and response parameters based on the schema or the example in the schema.CONVERSIONv2, v1
folderStrategyenumPaths, TagsPathsSelect whether to create folders according to the spec’s paths or tags.CONVERSIONv2, v1
schemaFakerboolean-trueWhether or not schemas should be faked.CONVERSIONv2, v1
stackLimitinteger-10Number of nesting limit till which schema resolution will happen. Increasing this limit may result in more time to convert collection depending on complexity of specification. (To make sure this option works correctly "optimizeConversion" option needs to be disabled)CONVERSIONv2, v1
includeAuthInfoInExampleboolean-trueSelect whether to include authentication parameters in the example request.CONVERSIONv2, v1
shortValidationErrorsboolean-falseWhether detailed error messages are required for request <> schema validation operations.VALIDATIONv2, v1
validationPropertiesToIgnorearray-[]Specific properties (parts of a request/response pair) to ignore during validation. Must be sent as an array of strings. Valid inputs in the array: PATHVARIABLE, QUERYPARAM, HEADER, BODY, RESPONSE_HEADER, RESPONSE_BODYVALIDATIONv2, v1
showMissingInSchemaErrorsboolean-falseMISSING_IN_SCHEMA indicates that an extra parameter was included in the request. For most use cases, this need not be considered an error.VALIDATIONv2, v1
detailedBlobValidationboolean-falseDetermines whether to show detailed mismatch information for application/json content in the request/response body.VALIDATIONv2, v1
suggestAvailableFixesboolean-falseWhether to provide fixes for patching corresponding mismatches.VALIDATIONv2, v1
validateMetadataboolean-falseWhether to show mismatches for incorrect name and description of requestVALIDATIONv2, v1
ignoreUnresolvedVariablesboolean-falseWhether to ignore mismatches resulting from unresolved variables in the Postman requestVALIDATIONv2, v1
strictRequestMatchingboolean-falseWhether requests should be strictly matched with schema operations. Setting to true will not include any matches where the URL path segments don't match exactly.VALIDATIONv2, v1
allowUrlPathVarMatchingboolean-falseWhether to allow matching path variables that are available as part of URL itself in the collection requestVALIDATIONv2, v1
enableOptionalParametersboolean-trueOptional parameters aren't selected in the collection. Once enabled they will be selected in the collection and request as well.CONVERSIONv2, v1
keepImplicitHeadersboolean-falseWhether to keep implicit headers from the OpenAPI specification, which are removed by default.CONVERSIONv2, v1
includeWebhooksboolean-falseSelect whether to include Webhooks in the generated collectionCONVERSIONv2, v1
includeReferenceMapboolean-falseWhether or not to include reference map or not as part of outputBUNDLEv2, v1
includeDeprecatedboolean-trueSelect whether to include deprecated operations, parameters, and properties in generated collection or notCONVERSION, VALIDATIONv2, v1
alwaysInheritAuthenticationboolean-falseWhether authentication details should be included on every request, or always inherited from the collection.CONVERSIONv2, v1
nestedFolderHierarchyboolean-falseEnable this option to create subfolders in the collection based on the order of tags.CONVERSIONv2
preferredRequestBodyTypeenumx-www-form-urlencoded, form-data, raw, first-listedfirst-listedWhen there are multiple content-types defined in the request body of OpenAPI, the conversion selects the preferred option content-type as request body.If "first-listed" is set, the first content-type defined in the OpenAPI spec will be selected.CONVERSIONv2