Commit the API schema in the repository
I propose to commit the api schema in the repo.
This will help with:
- reduce dependency between the CI build_api_docs and build_docs jobs
- faster way to build the docs without requiring the api
- allow to spot any unwanted changes (say spectacular introduce a bug, we can see it)
- easier way to track which code change did change the spec (will be handy if you generate the api clients using the schema file)
To enforce this using the CI (the CI don't commit, but enforce), we can either be really strict, or somewhat relax:
- either the schema must be generated for each of the commits (1 commits 1 spec change)
- or we allow for multiple commits (merge request) to have a single spec change (n commits, 1 spec change)
I prefer to be really strict, but maybe this needs some discussions ?