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: remove API description from metalv1 code files to reduce diff size #72

Merged
merged 2 commits into from
Aug 9, 2024

Conversation

ctreatma
Copy link
Contributor

@ctreatma ctreatma commented Aug 9, 2024

The default openapi-generator templates include the API description and version in the header comment of all code files. This causes unnecessarily large diffs any time those fields are updated in the API spec and makes it harder to figure out which code actually changed due to a spec update.

The Fabric team already ran into and addressed this issue for their service. This copies the fabricv4 header template over to the metalv1 service so that future Metal PRs will be easier to review.

@ctreatma ctreatma requested a review from a team as a code owner August 9, 2024 16:14
@ctreatma ctreatma merged commit ffb9e79 into main Aug 9, 2024
3 checks passed
@ctreatma ctreatma deleted the metalv1-smaller-headers branch August 9, 2024 16:23
Copy link
Contributor

github-actions bot commented Aug 9, 2024

This PR is included in version 0.43.0 🎉

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.

1 participant