Skip to content
This repository has been archived by the owner on Sep 27, 2023. It is now read-only.

Implement semantic diffing capability #1

Open
darrelmiller opened this issue Jun 18, 2017 · 2 comments
Open

Implement semantic diffing capability #1

darrelmiller opened this issue Jun 18, 2017 · 2 comments

Comments

@darrelmiller
Copy link
Member

It would be useful to be able to take two OpenAPIDocument models and create a list of differences. Ideally the diff should describe the type of difference and where applicable hold a reference to the old and new value. We should also know the context of where in the document the difference occurred.

@MikeRalphson
Copy link
Contributor

It would be useful to be able to determine whether a change should trigger a major, minor or patch version number change according to semver. A 'semantic OpenAPI version' spec/guidance would allow tools to be consistent in this regard.

@darrelmiller
Copy link
Member Author

As we are not requiring users of OpenAPI definitions to use semantic versioning I don't think OpenAPI should get into the business of defining what is and isn't a breaking change.

However, I do think we should have a way for a user to define what types of changes they want consumers to opt-into, versus the types of changes that will just get pushed. If a user defines these policies, then we could review the diffs based on those policies and provide guidance on how an API should be versioned.

# for free to subscribe to this conversation on GitHub. Already have an account? #.
Projects
None yet
Development

No branches or pull requests

2 participants