doc: generate -dev openapis
What
Currently, only the OpenAPIs of the last released version (candidate) of Octez are published in the doc.
This MR proposes to also publish the latest development versions, that is:
- the master version of the Octez node shell RPCs
- the Alpha version of the Octez node protocol RPCs
- the Alpha version of the smart rollup node RPCs
- the master version of the DAL node RPCs
Why
RPCs for Alpha are currently available in static RPC pages (*/*rpc.rst
) but not in OpenAPI format.
In turn, static RPCs include the master version but not the latest (stable or candidate) release.
How
Optionally generate *-dev
OpenAPIs int the documentation Makefile by running the generation script, and include the generated files in page api/openapi.rst
.
Manually testing the MR
Check the additions in the OpenAPI page, in the doc artifact. Some of the links to the generated files don't work yet, they'll only work once the MR is merged.
Generate the dev OpenAPIs locally, with make -C docs openapi
(after having done make
at root!). This will also tell you whether they are up-to-date or not.
You may check the diffs, with git diff
. You may ignore the different values for the version
fields in the files.
- Here, it should report significant differences.
Then, commit the modified api/*.json
files (with some REMOVEME
tag), and run make -C docs openapi
again.
- Now, it should report that files are up-to-date.
Please avoid pushing your test commit to the repo.
Checklist
-
Select suitable reviewers using the Reviewers
field below. -
Select as Assignee
the next person who should take action on that MR