Generated Postman collection is not matching with the Postman JSON schema - v2.1.0

[thim81]

It seems that the Postman format that is generated, does not match the Postman Schema.

In the generated Postman collection, it shows https://schema.getpostman.com/json/collection/v2.1.0/collection.json:

    "info": {
        "_postman_id": "40ffbc1c-f4ca-4df9-b51b-91bd1ed90a53",
        "name": "SMC API",
        "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
    }

But If I compare the generated Postman collection against the schema, it fails.

[thim81]

This causes problems when you try to import/sync the Postman collection using the Postman API.
But it passes the import via the Postman App.

See reference for more details: #47 (comment)

[kevinswiber]

Yep, confirmed.

Error introduced here: https://github.com/postmanlabs/openapi-to-postman/pull/217/files#diff-bd50fb6a90352e7364306751ae0078c0R899

Schema for the invalid part: https://github.com/postmanlabs/schemas/blob/develop/schemas/draft-07/v2.1.0/collection.json#L30-L38

The fix should be as simple as changing that line to return null.

[thim81]

@kevinswiber

Am I correct to state that the fix would be:

    if (!securitySet || (Array.isArray(securitySet) && securitySet.length === 0)) {
       return {		       
               return {};

with

    if (!securitySet || (Array.isArray(securitySet) && securitySet.length === 0)) {
       return {		       
               return null;

Based on the diff: https://github.com/postmanlabs/openapi-to-postman/pull/217/files#diff-bd50fb6a90352e7364306751ae0078c0R899

[kevinswiber]

@thim81 Yes, that's correct!

[thim81]

@umeshp7

The API upload still fails, even with the 1.1.19 release.
If I check the generated postman collection with Postman JSON schema v2.1, it also still fails.

[umeshp7]

@thim81 Could you share a sample OpenAPI schema with us that is failing in v1.1.19.

This issue specifically fixes the bug introduced by the auth: {}. We are working on adding a suite of sanity tests that will verify the collection json once it is generated for all the sample schemas we have in our fixtures.

There are still some areas where we aren't conforming to schema and we will be taking it up in the coming days.

[thim81]

@umeshp7

I'm using the Postman Collection Format v2.1.0
https://schema.getpostman.com/json/collection/latest/docs/index.html

JSON Schema: http://schema.getpostman.com/collection/json/v2.1.0/draft-04/collection.json

Since that is schema that is generated in the Postman collection.

Left: is the Postman Collection Format v2.1.0 schema
Right: is the generated Postman collection (format 2.1.0)
Below: the schema validation errors

(FYI: I'm using the online tool https://www.jsonschemavalidator.net/ to compare).

The errors shown are the same as when I tried to update my Postman collection via the https://api.getpostman.com/collections/ endpoint.

[umeshp7]

@thim81
Actually will it be possible for you to provide us the OpenAPI spec that is resulting in a non-conforming schema. We are currently working on #234 to add sanity testing for all the collections generated from our data/valida_openapi folder.

It would be great if you could provide us with a sample OpenAPI spec that results in the above erroneous collection?
You could also send the spec over to help@postman.com. So that we can reproduce this issue better.

[thim81]

Hi @umeshp7

I have mailed you the OpenApi spec and the generated postman collection.
Let me know, if you need more information.