Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: do not store merged openapi spec inside customer repository #68

Merged
merged 1 commit into from
Nov 16, 2023

Conversation

ThomasRooney
Copy link
Member

No description provided.

@ThomasRooney ThomasRooney requested a review from a team as a code owner November 16, 2023 21:02
Copy link
Member

@simplesagar simplesagar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wouldn't we want to store the merged file in repo?

@ThomasRooney
Copy link
Member Author

ThomasRooney commented Nov 16, 2023

wouldn't we want to store the merged file in repo?

We don't right now -- we might want to expose it as a configuration option but as it is a transient file it doesn't really make sense.

The main reason why not to today, is that when we merge together openapi specs we are re-rendering it with LibOpenAPI, which causes formatting flux. Right now, libopenapi renders non-deterministically when we merge together multiple files, due to the current simplicity of the sorting mechanism (it only renders deterministically when it is generated from a source file, rather than several in-memory structures).

This means that a "generation" diff is unnecessarily hard to review, as things like paths are effectively randomly sorted every time in the openapi_merged file.

@ThomasRooney ThomasRooney merged commit e7c9717 into main Nov 16, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants