Breaking Change: Adding & applying security scheme #1305
Replies: 2 comments 2 replies
-
Hey @maticardenas -- adding a security schema makes sense as a breaking change. Are there any other kinds of changes you think we should be checking for? If we're going to add / announce support for security we may want to do take a pass at some of the other breaking changes too. |
Beta Was this translation helpful? Give feedback.
-
Hey @maticardenas -- as of 0.34.1 you can write rules about security! You will be able to access the
This will either be the |
Beta Was this translation helpful? Give feedback.
-
We are currently using
optic
and have found recently that adding a newsecuritySheme
to an OAS and applying it globally or individually in an endpoint that didn't have any applied previously, doesn't end up in a breaking change validation error.As stated here, I'd expect it to clearly be a breaking change for your API as it would become not accessible anymore with the same authentication method for consumers.
As an example it would be:
Previous version
New version
Beta Was this translation helpful? Give feedback.
All reactions