v4.24.0 - 2024-08-13
- #98 12255 Added support for readOnly and writeOnly properties to be correctly present in generated collection.
- Replaced traverse with neotraverse.
v4.23.1 - 2024-07-22
- Conversion - Added option to set preferred request body content-type and use the first mentioned content-type as request body.
- Fixed issue with getOptions() API where default module version was still v1.
- Fix to convert "format:binary" to "type:file" for requests with formdata body.
v4.22.0 - 2024-07-10
- Updated postman-collection to v4.4.0.
v4.21.0 - 2024-05-17
- Added support for simplified request and response body matching in case of multiple examples.
v4.20.1 - 2024-03-27
- Fixed an issue where schemas under allOf keyword having additionalProperties set to false were not generating bodies correctly.
v4.20.0 - 2024-02-15
- Added support for reporting UserErrors in case when OpenAPI definition to converted is invalid.
v4.19.0 - 2024-01-18
v4.18.0 - 2023-09-28
v4.17.0 - 2023-09-12
v4.16.0 - 2023-08-18
- Added support for remote $ref resolution in bundle() API.
v4.15.0 - 2023-06-27
- Added support for usage of XML examples of type string.
- Fixed issue where generated collection contained request and folder in incorrect order for v2 interface.
- Fixed issue where collection generation took very large time.
- Reduced collection size by keeping maximum generated elements for array as 1 for definitions with larger schemas.
v4.14.0 - 2023-06-07
- Added support for consumption of schema level examples while generating data from XML schemas.
- Fixed the default value of auth in the generated request when it is not resolved.
- Fixed issue where collection name was empty in cases where definition title was defined as empty string.
v4.13.0 - 2023-05-24
- Added support for generating request and response bodies in correct XML format from mentioned examples.
- Added support for validation of specifications in case of errors to report User input errors correctly.
- Fixed issue where conversion was stuck for certain schemas with pattern.
- Fixed an issue where definition validation was not considering multiple white space characters.
- Fixed issue #708 where if string is defined for required field, conversion was failing.
- Fixed issue where for certain path segments, collection generation failed.
- Fixed TypeError occurring while checking typeof bodyContent in getXmlVersionContent.
v4.12.0 - 2023-05-04
- Fixed issue #31 Added support for enableOptionalParameters option in v2 interface.
- Fixed issue #11835 where Accept header was not present in Example request.
- Fixed issue where conversion was failing with RangeError in case of non-schema circular refs.
- Fixed issue where conversion was failing with TypeError by safer lodash functions usage.
- Fixed issue where TypeErrors were happening for null/undefined params.
v4.11.0 - 2021-04-14
- Fixed issue #11680 Added support for contentType field for Formdata request bodies.
- Fixed issue #10928 Added support for usage of interface version in CLI conversions with v2 as default.
- Fixed various known type errors related issues that were causing conversion errors.
- Fixed an issue where default response was not considered correctly while validating collection request response.
Newer releases follow the Keep a Changelog format.
- Fixed issue where Accept header was generated correctly in convertV2() interface.
- Fixed issue where request name generated were not validated correctly.
- Fixed test where getOptions() was not using criteria correctly.
- Fixed issue where deprecated params were reported missing even for includeDeprecated=false
- Added support for convertV2() interface which has more stacklimit for schema resolution.
- Added support for validateTransactionV2() interface uses same v2 interface for resolving schema.
- Fixed multiple issues for urlencoded body with anyOf and oneOf schemas where valid data was reported as mismatches.
- Fixed issue #660 where for certain XML request bodies, conversion was failing with TypeError.
- Fixed issue where for some definitions having non-string URLs were failing conversion with TypeErrors.
- Fixed issue where a test in-consistently kept failing due to uncertainity of jsf library.
- Added specifictionVersion field to validate result.
- Fixed an issue where same schema was being validated against examples multiple times during a conversion - using local cache here.
- Added a way to return analytics along with the result for better observability into the kind of schemas we get for conversion.
- Refactored the resolveRefs and resolveAll to take in an options object as an argument.
- Fixed issue where bundling of multi-file definition was not working correctly for more than 10 params correctly.
- Fixed issue where request name was not using operation description if available.
- Fixed issue #11519 Collection generated from imported OpenAPI were missing certain properties.
- Fixed issue #11227 Collection generated produces incorrect XML requests and responses from Open API 3.0 and Swagger 2.0 API definitions.
- Fixed issue #11527 where generated collection contained empty body when / was used as content-type.
- Fixed issue #626 - Add a new option (includeDeprecated) to handle deprecated properties (operations, parameters, or schema properties).
- Fixed issue #643 Generated value for corresponding authorization should be an environment value.
- Removed travis workflows as GitHub actions are present now.
- Updated README.md to include Swagger 2.0 and OpenAPI 3.1 support.
- Updated README.md to include new postman logo.
- Fixed issue where collection folder name for paths were having extra spaces.
- Fixed issue where pipelines were failing for certain node version.
- Fixed issue with nullable keywords getting validated incorrectly.
- Improved the way to detect a circular reference by adding a new condition
- A schema that comes from an allOf parent then we now return the same schema instead of defaulting to a schema with type as object, and no other properties
- The method resolveAllOf is executed when the current node is an allOf element.
- Avoiding to set type as object when property's schema is an empty object.
- Added OAuth2 flows and configuration support.
- OAuth2 values now default to variables instead of hardcoded strings.
- Replaced Object.hasOwnProperty usages with loadsh _.has for safe access.
- Fixed issue where conversion was failing for definitions with info object as null.
- Fixed issue where generated collection did not have correct examples value from XML type of content.
- Fixed issue #518 where generated collection were having NaN as value for integer query params with enum values.
- Fixed issue #496 where validateTransactions() was returning missing endpoints even though corresponding requests are present in collection.
- Fixed issue #478 where updation of path parameter in collection resulted in MISSING_IN_REQUEST error.
- Fixed issue #559 where parameter description was undefined for formdata type of content even if defined.
- Fixed issue where bundle() API didn't handle circular references correctly.
- Added non-required files to be published as npm module in .npmignore
- Fixed issue where disableBodyPruning option was not set for requests with no request body.
- Added support for new multi-file API detectRootFiles() for OpenAPI 3 and Swagger 2 formats to support detection of root files among multiple files.
- Added support for new multi-file API detectRelatedFiles() for OpenAPI 3 and Swagger 2 formats to support detection of related files for a provided root file amongst multiple files.
- Added support for new multi-file API bundle() for OpenAPI 3 and Swagger 2 formats to support bundling of root files from provided multiple files.
- Fixed some of critical and high level severity vulnerabilities.
- Fixed issue #10752 where deepObject style parameters were not generated correctly.
- Fixed issue #485 where validateTransaction() returns result where mismatch path for transaction are incorrect.
- Fixed issue #485 where validateTransaction() returns result where mismatch path for transaction are incorrect.
- Removed usage of schema resolution cache to avoid incorrect resolution.
- Fixed issue where newly converted collection had mismatches from validateTransaction() API.
- Fixed issue where falsy example were not getting converted correctly in generated collection.
- Fixed issue where readOnly and writeOnly properties were not removed from required in resolved schema.
- Fixed issue where if schema had pattern as property, conversion failed with error.
- Add support for OpenAPI 3.1.x https://www.openapis.org/blog/2021/02/18/openapi-specification-3-1-released.
- Separated schemUtils into common, 3.1, and 3.0 specific files.
- Added a new internal option for supporting Webhooks:
includeWebhooks - Added support for $schema through ajv for various JSON Schema drafts.
- Fixed issue where for certain collection requests validateTransactions() provided missing path varaible in request even though it was present.
- Fixed issue where we threw TypeError for undefined parameters.
- Fixed issue where $ref in additionalProperties created issue with validation.
- Fixed issue where content-type with wild characters resulted in mismatches for valid collection headers.
- Fixed issue where validation agaist collection failed for collection with larger request name.
- Added support for composite schema during validation flow.
- Fixed issue where conversion failed with type error if header example was null.
- Fixed issue where validation was giving INVALID_TYPE instead of MISSING_IN_REQUEST if path variable is not present in transaction.
- Fix issue where json and xml lanugages were not detected from the example request body content type
- Set param type in request to file if schema type is string and format is binary in binary body type.
- Handle the case when request body is of type string and format binary in form-data body type.
- Fixed path variable conversion in collection's examples.
- Fixed issue where generated collection contained response code as null.
- Added option to manage implicit headers.
- Bumped up few dependency versions.
- Added new internal option "stackLimit" to define nesting level till which schema gets resolved.
- Fixed issue where invalid cached schemas were being used for resolution.
- Fixed issue where example values with pm variable syntax were not picked up in conversion.
- Fixed the value format for apiKey security scheme.
- Fixed issue where description was missing from suggested fix from mismatches.
- Updated vulnerable dependencies.
- Added support for release script to automate the task.
- Fixed issue where params with style deepObject were converted to only one level of key-value pair.
- Add a new argument in input object 'origin' to handle browser specific changes.
- Added handling for type errors encountered on sentry.
- Added support for no-auth as auth in collection when empty object is specified in OAS.
- Bumped up dependencies and dev-dependencies.
- Fixed issue where nested objects present in parameters caused validation mismatches.
- Fixed issue in schema faker where schema with property named deafult was faked incorrectly.
- Fixed wrongly defined maxLength and minLength options for schemaFaker.
- Fix for #337 - Fixed issue where non-required params were not disbled for urlencoded body.
- Fix for #338 - Fixed issue where examples which had non-truthy value were not present in converted collection.
- Fixed issue where resolved schema contain conflicting info regarding pattern and format resulting in validation mismatches.
- Fixed issue where definition for path variable in path caused no matched request for certain paths in validation.
- Fix for #9396 - Fixed validation issue where result contained matched endpoints in incorrect order.
- Fix for #328 - Fixed incorrect usage of id field in sdk.variable and used key.
- Fix for issue where implicit headers generation and validation.
- Fix for #329 - Fixed issue where --test was failing for cli.
- Fixed issue where content type header was reported missing in validation even if present.
- Feature request #9046 - Added support for validation of request body of type urlencoded.
- Fixed issue with import folder flow on respective platform.
- Fixed issue where collection did not contain name for specification with empty string as title.
- Updated description of option to disable optional parameters.
- Fix for #9404 - Fixed issue where incorrect mismatches were reported for valid path variables.
- Fixed issue where validation result contained incorrect path variable indices.
- Fix for #9344 - Fixed issue where for type array examples with more than 2 elements were not used.
- Fix for #9080 - Fixed issue where parameter examples were not used in faked data.
- Fix for #315 - Fixed issue where ConfigFile options are overwritten by CLI options.
- Fix for #69 - Fixed incorrect handling for explodable parameters for resolution schema.
- Added support for disabling optional parameters via option.
- Updated minimum supported node version to v8.
- Fixed issue where schemas in allOf were not resolved correctly.
- Added support for options in CLI converter.
- Bumped up few dev-dependency versions.
- Fixed issue where schema type object with no properties reolved to string.
- Fix for #8474 - Unable to validate primitive data types in req/res body.
- Added support for handling correct media types which were throwing mismatches for validation.
- Added support for internal $ref resolution in validation flows.
- Fixed issue where parameter resolution was "schema" when "example" was specified.
- Add supported formats for schema resolution (deref).
- Fix for #7643, #7914, #9004 - Added support for Auth params in response/example.
- Bumped up multiple dependecies and dev-dependencies versions to keep them up-to-date.
- Updated code coverage tool from deprecated istanbul to nyc.
- Fixed TypeError happening when null parameter value provided.
- Fixed an issue where suggested value for mismatch did not fix corresponding mismatch upon applying.
- Fixed issue where root path was not matched during validation.
- Fixed an issue where transaction was not matching if path had segment with fix and variable parts during valiadtion.
- Fixed issue where URL did not contain baseUrl as host when base url variables are present.
- Fixed issue where collection variable generated for path variables had empty values.
- Fixed issue where invalid deserialisation was happening for param style matrix.
- Added validation tests to improve code coverage.
- Fixed incorrect variable name in schemapack.js.
- Introducing a new option
Optimize conversionfor improving performance of conversion for larger schemas.
- Added support for parameter serialisation in conversion and deserialisation in validation.
- Skipped validation for headers/query-params added by security scheme.
- Fixed incorrect Url and collection variable when path level server is present.
- Fixed issue where empty description property caused mismatch.
- Fixed issue where mismatch was happening even when correct path variable is present.
- Fixed dataPath handling for root property when dataPath is empty string.
- Fixed collection variable ignoring when pattern property is present.
- Added support for collection variables for local servers in suggested request for validation.
- Fixed TypeError happening when empty parameter is provided.
- Fixed invalid transaction json path for headers.
- Added support for collection request as suggested value for missing endpoints.
- Use forked version of oas-resolver to make folder imports work in browser.
- Fixed issues with collection conforimg to JSON schema validation as per v2.1.0 schema.
- Added support for validating content-type header.
- Added support for stricter request matching via option for validation.
- Added missing endpoints from collection info in result of validation.
- Suggest fixes in collection for violated properties in validation.
- Introduced option to validate metadata for validation.
- Use faked value instead of fallback to schema for parameter resolution when set to example.
- Use faked value instead of invalid schema defined example.
- Introduced option to ignore unresolved postman variable mismatches.
- Fixed invalid generated collection for body type formdata.
- Fix for #232 - Changes default auth of requests to null conforming to the JSON schema.
- Fix for #86 - Now global security schemes will be added at the collection level.
- Fix for #3 #57 - Introduced a new option
folderStrategy, can choose betweenTagsorPathwhile creating folders in Postman Collection. - Fixed an issue where undefined was returned as error message while trying to import invalid format.
- Use
minItemsandmaxItemsvalues if available in schema with type array.
- Change Url to URL in Naming Request option.
- Add missing yaml dependency.
- Added a new function to get meta data from a schema.
- Fix for #169 - Removed unused folderStrategy option.
- Added support for detailed validation body mismatches with option detailedBlobValidation.
- Fix for #8098 - Unable to validate schema with type array.
- Fixed URIError for invalid URI in transaction.
- Fix for #152 - Path references not resolved due to improver handling of special characters.
- Fix for #160 - Added handling for variables in local servers not a part of a URL segment. All path servers to be added as collection variables.
- Unresolved refs will not be stored in schemaResolutionCache.
- Fix for #133 and #101
- Ignore resolving circular references.
- Upgrade commander from 2.3.0 to 2.20.3
- Upgrade postman-collection from 3.5.1 to 3.5.5
- Safely handling invalid reference schemas/properties
- Safely handling malformed URIs and schemas
- Support for multi-file schemas. Added a new input method 'folder'.
- Fix for #162
- Caching faked/resolved schemas for better performance
- Empty input specs don't throw an error anymore
- Fix for #150 - empty examples don't throw exceptions during conversion
- A
(Required)annotation is added for required parameters
- Not throwing errors for missing schema path entries
- Not throwing errors for invalid schema references
- Not throwing errors for invalid schema.path entries
- Not throwing errors for unknown schema types
- More updated copy for mismatch reasons
- Added missing dependency for async.js
- Updated copy for mismatch reasons
- Returning errors instead of exceptions for invalid schemas
- Fix for duplicate mismatches
- Correct validation against JSON request/response bodies
- Correct JSON paths in response mismatches
- Handling cases where API definition parameters have no schema
- Validating input transaction schema before starting validation
- Forcing path variable descriptions to be strings instead of objects
- Exposing option to hide MISSING_IN_SCHEMA mismatches, hiding them by default
- Consistent response formats, more resilient against invalid schemas
- Deleting 'info.version' from generated collection JSON - it's not required and was causing versioning problems
- Scope-related bugfixes in schema validation flows
- New API to validate requests against a schema
- Fix for #113 - Correct description set for falsy values
- Invalid file paths return a falsy result and a reason (instead of an error)
- Invalid option values don't throw errors anymore
- Readme typo fix (courtesy https://github.com/disposedtrolley)
- Handled cases where the URL query has no description property
- Fix for #117 - Maintaining descriptions for form-urlencoded body params
- Added various options for converting OpenAPI specs into Postman Collections, including controlling how examples are generated
- Request parameters now default to a schema-based value generation, response parameters default to example-based value generation.
- Fix for postmanlabs/swagger2-postman2#21 - Not creating folders at each path level unless required
- Schemas with circular object definitions are imported successfully
- Empty local server definitions not crashing the converter
- Custom JSON headers being picked up for request/response body generation
- Stringifying boolean params if present as query parameters (courtesy https://github.com/Firtzberg)
- Fix for #102 - Not crashing on undefined name/email/description properties
- Fix for #90 - respecting
serverelements defined inside paths - Fix for #98 - respecting
readOnlyandwriteOnlyproperies while faking schemas - Fix for #88 - escaping / and ~ characters in
$refs (courtesy https://github.com/bzmw)
- Corrected code snippet in README (courtesy https://github.com/simonlampen)
- Fix for #44 - Prevent crashes for specs that contain a root endpoint (courtesy https://github.com/pitpit)
- Ignoring missing body propertes in schema objects
- Added system tests, updated lockfiles for [email protected]
- Fix for postmanlabs/postman-app-support#6538 - parsing JSON correctly from example references
- Fix for postmanlabs/postman-app-support#6538 - handling references in request/response examples
- Fix for postmanlabs/postman-app-support#6500 - manually stringifying number types as a workaround for SDK issues
- Fix for #23 - custom schema formats are not ignored
- Fix for #18 - consistent parsing for URL variables
- Fix for #64 - array params don't cause a crash with schemaFaker disabled (courtesy https://github.com/brpeterman)
- Fix for #52 - allowing $refs to point to paths, not just components
- Fix for #27 - support for allOf-type schemas
- Fix for #45 - trailing slashes in the path don't create empty folders
- Using a placeholder for servers.url in case the spec has a falsy value
- Support for x-postman-meta for including Postman auth in converted collections
- Fix for #36 - Property names with a . in the name are supported during schema faking
- Fix for #47 - Accepting application/vnd.api+json headers as JSON
- Removing unused dependencies
- Fix CLI test commands (courtesy https://github.com/aerotog)
- Fix README typos (courtesy https://github.com/T1l3 and https://github.com/evertharmeling)
- Safe property access to empty content/authHelper objects
- Setting postman_previewLanguage while setting responses
- Not overriding non-string variable types during schema faking
- Not doubly-stringifying string headers
- Removing Node v4/5 from CI
- Ignoring falsy responses in the OAS spec
- Correct error handling/output logging in the executable
- Showing detailed error messages for malformed JSON/YAML
- Fix for #5 - headers with refs to deeply nested components should work
- Fix for #4 - the cwd (not __dirname) is used to look for files specified by -s
- Adding tests for the executable
- Refactoring, restucturing tests
- Adding support for xml chemas
- Enabling travis CI
- Updating README, adding a license, moving to Github
- Converting all console.error to console.warn
- Handling schema.enum when no other schema is specified
- Resolving parameter schemas while creating requests
- Correctly setting path variable descriptions
- Using a browserified json-schema-faker
- Populating the original request in generated example responses
- Infer the response content-type header from the response body
- Generating more human-readable folder/request names from snake_case/camelCase
- Handling nested schemas, correct handling for oneOf/anyOf
- Prefer examples to schemas while generating example response body
- Correct handling for scheme variables in the URL
- Ignoring schema errors for invalid references
- Blocking schema nesting of >20 levels
- Correctly handling empty security sets for requests
- Removing the insecure node-uuid dependency
- Adding default URLs if "server" is absent
- Better indication of lack-of-support for allOf schemas
- Base release