Skip to content

fix: remove generated schema.yml file from git#1978

Closed
mentonin wants to merge 2 commits into
kernelci:mainfrom
profusion:georg/fix/remove_schema
Closed

fix: remove generated schema.yml file from git#1978
mentonin wants to merge 2 commits into
kernelci:mainfrom
profusion:georg/fix/remove_schema

Conversation

@mentonin

@mentonin mentonin commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

This file is being removed as it can be generated from the backend code and is an unecessary burden to manually sync in git.

This file is being removed as it can be generated from the backend code
and is an unecessary burden to manually sync in git.

Signed-off-by: Luiz Georg <luiz.georg@profusion.mobi>
@felipebergamin

Copy link
Copy Markdown
Contributor

shouldn't we also add it to .gitignore ?

Signed-off-by: Luiz Georg <luiz.georg@profusion.mobi>
@mentonin

mentonin commented Jul 8, 2026

Copy link
Copy Markdown
Contributor Author

gitignored

@tales-aparecida

Copy link
Copy Markdown

Add some lines of docs on how to create it

@mentonin

Copy link
Copy Markdown
Contributor Author

Add some lines of docs on how to create it

We have documentation on backend/README.md

@MarceloRobert MarceloRobert left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I don't see much reason to remove this from the git but it's fine for me. I think that we can rephrase the readme though, it currently says "Please use it whenever the ins and outs of endpoints change." and I guess that's not going to be needed anymore.

@tales-aparecida

tales-aparecida commented Jul 13, 2026

Copy link
Copy Markdown

Actually, I'm not sure I agree with this MR. We should be intentional of changes in the API, and commiting the schema is a good way to do that.

The CI should check whether the author changed the API accidentally, by running generate-schema.sh and blocking in case it gets updated, such that the author must state they intended and expected an update to the schema by commiting an updated version of it.

@mentonin mentonin closed this Jul 15, 2026
@mentonin

Copy link
Copy Markdown
Contributor Author

I actually agree with you, Tales. I uploaded a new PR (#1992) that adds a check to pre-commit and CI instead

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.

Enforce OpenAPI schema updates in CI

4 participants