joolfe / postman-to-openapi

🛸 Convert postman collection to OpenAPI
MIT License
577 stars 99 forks source link

Description is not converted over #231

Closed guyhagemans closed 1 year ago

guyhagemans commented 1 year ago

Hi,

I have a question regarding https://joolfe.github.io/postman-to-openapi/#info-object .

I've added the title, version and description as variables to my Postman collection. It seems after converted the title and version are converted but the description is not. Any suggestion is greatly appreciated!

guyhagemans commented 1 year ago

mm sorry now I see I need to provide this in an options file rather. Just curious the 'version' and 'title' are converted when provided as a postman variable from the collection :-)

joolfe commented 1 year ago

Hi @guyhagemans,

The description and title are obtained from the postman collection info object, this is how it looks like:

    "info": {
        "_postman_id": "2a45baa5-352f-4831-8483-1a0fcbc7da37",
        "name": "Postman to OpenAPI",
        "description": "Mi super test collection from postman",
        "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
    },

The title will be obtained from name and description will be obtained from description, the reason why the version is obtained from a postman variable is because there no exist this value in a postman collection for now and if you want to overwrite all you can use the info option object.

PS: title should not be get from the postman variables, is always obtain from the postman info object.

Best Regards