feat(openapi): add --dryRun option

[darrenyong]

🚥 Fix RM-3854

🧰 Changes

This adds a --dryRun option to the openapi command so users can debug their spec creation and updating.

🧬 QA & Testing

Provide as much information as you can on how to test what you've done.

[darrenyong]

@kanadgupta, what do you think we should do in the case where a user does a dryRun in a directory that only has one file?

we automatically return this notification letting them know that we're attempting to upload it. should we change the copy at all to avoid confusion or is that okay?

[kanadgupta]

@darrenyong good question... I think it's okay to leave the copy as is! I think it's clear from these logs what's happening:

We found petstore.json and are attempting to upload it.
🎭 dry run! The spec with the id SPEC_ID will be updated

I think we should clean up the dry run log copy a bit but I'll leave a suggestion during my actual review!

[darrenyong]

@kanadgupta merged main 😎

[kanadgupta]

A few copy edit suggestions below but the code and tests look great! Could you also add a little note about the dry run flag in the README.md file? I think it makes sense for that note to live around here.

[darrenyong]

A few copy edit suggestions below but the code and tests look great! Could you also add a little note about the dry run flag in the README.md file? I think it makes sense for that note to live around here.

Added! I'll update our docs here with the openapi --dryRun once we release this!

[kanadgupta]

Super tiny docs suggestion but otherwise looks LGTM 🚀

(also ticketed the docs change in RM-5475!)