openapi-to-postman icon indicating copy to clipboard operation
openapi-to-postman copied to clipboard

Published 20 hours ago • verified publisher icon postmanlabs

OpenAPI v3.1.0

Open philsturgeon opened this issue 3 years ago • 6 comments

Howdy Postman People! I wanted to make a quick issue to track the progress towards supporting OpenAPI v3.1. I'm sure you folks are all familiar with it and I bet its supported in various parts of the toolchain, but I wanted to see how this particular tool was doing so I can potentially update the "3.1 Support" column.

Here's a guide to the differences written for end-users, but it should help make things fairly clear to tooling vendors

https://www.openapis.org/blog/2021/02/16/migrating-from-openapi-3-0-to-3-1-0

If you say you'll be working on it I can update openapi.tools to reflect that.

Let me know if you have any questions or need any help with the upgrade process.

philsturgeon avatar Apr 08 '22 12:04 philsturgeon

Hey @philsturgeon, Thanks for reaching out!

We already have added support for OpenAPI v3.1.0 for our existing functional APIs (i.e. converting OpenAPI 3.1 definition to Postman collection, validating the collection against the OpenAPI 3.1 definition etc.). It seems README.md hasn't been updated with these changes so I'll create a task to do that.

We'll let you know once we have updated README.md so you can include v3.1.0 support under openapi.tools.

VShingala avatar May 04 '22 12:05 VShingala

Brilliant, thank you @VShingala!

philsturgeon avatar May 04 '22 15:05 philsturgeon

Hey @VShingala, Do you have any idea when the README.md will be updated? I want to use another package that is waiting on these changes. =)

schelv avatar Aug 12 '22 14:08 schelv

Yes, please! We gave it a try, and it seems to be working fine!

petkostas avatar Aug 17 '22 10:08 petkostas

@VShingala congrats on the OpenApi 3.1 support. We are great fans and users of the OpenApi-to-postman library and we wondering if the new version is fully backward compatible or are there breaking changes that we should be aware off?

thim81 avatar Sep 21 '22 06:09 thim81

@thim81 It's fully backward compatible. We've designed the support for OpenAPI 3.1 keeping existing flows and code being the same and have created separate or reuse existing components so OpenAPI 3.0 related APIs are not affected in any way.

Also, we added support for this around February 2022 and haven't seen any issues affecting OpenAPI 3.0 related APIs.

If interested, here's the PR that added support: https://github.com/postmanlabs/openapi-to-postman/pull/471

VShingala avatar Sep 21 '22 08:09 VShingala

Thank you!

philsturgeon avatar Oct 19 '22 16:10 philsturgeon

@philsturgeon This module now supports both 2.0 and 3.1. I've also updated the README with same. Let me know if anything more is needed to include 2.0 and 3.1 support on openapi.tools page.

VShingala avatar Jan 02 '23 18:01 VShingala

Can't think of anything, if you support 3.1 that's great news and a pull request is all thats required.

philsturgeon avatar Jan 02 '23 21:01 philsturgeon