Repository navigation
Can't disable backward incompatibility for a pattern change #845
Description
When changing the regexp pattern of an existing property, there are no overrides available to explicitly skip the verification on pattern change.
Example:
previous schema
Widget:
type: object
properties:
prop1:
type: string
updated schema
Widget:
type: object
properties:
prop1:
type: string
pattern: '[A-Za-z0-9#$]$'
Gives an Schema: Broken compatibility error.
This issue is to add a new config property (something like incompatible.schema.pattern.changed) so we can disabled the pattern change rule.
Activity
jdesrochers-atpco commentedon Oct 8, 2025
I do have a simple code fix to implement this, but I'm not sure what is the process to submit a PR for review.
Can you provide any pointers into how we could submit that? In the meantime we are using a local snapshot build to unblock our api spec development, but it's not ideal. I would love to see this integrated into the main codebase so we can rely on the official source of truth for openapi-diff
jdesrochers-atpco commentedon Oct 9, 2025
Sharing a patch with the content of my local commit to resolve this issue:
0001-fix-845-Proposed-solution-to-disable-BC-on-pattern-c.patch
DrSatyr commentedon Oct 10, 2025
Hello, thanks for collaboration, the process to provide PR is pretty common for all GitHub repos: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork
DrSatyr commentedon Oct 10, 2025
@jdesrochers-atpco let me know if you did not manage to create a PR. Once changes will be merged I can create a next minor release for you ASAP.
fix(OpenAPITools#845): Proposed solution to disable BC on pattern change
fix(OpenAPITools#845): Proposed solution to disable BC on pattern change
jdesrochers-atpco commentedon Oct 14, 2025
Just needed to figure out how to work with public git repos... Submitted a PR for review:
#848
Merge pull request #848
jdesrochers-atpco commentedon Oct 14, 2025
Thanks for reviewing my PR and merging it @DrSatyr . Let me know when a new release will be available so we can switch from our own internal snapshot build.
DrSatyr commentedon Oct 14, 2025
@jdesrochers-atpco release has been published #850. Thank you for your contribution.
jdesrochers-atpco commentedon Oct 15, 2025
Thanks for the quick turn-around time on this ; greatly appreciated @DrSatyr.
The latest 2.1.4 release is integrated in our pipeline automation and it works great.
DrSatyr commentedon Oct 15, 2025
You are welcome! Nice to hear it.