Publish key manager OpenAPI doc

Consensys / teku

Open-source Ethereum consensus client written in Java

https://consensys.io/teku

Apache License 2.0

663 stars 281 forks source link

Publish key manager OpenAPI doc #5570

Open NicolasMassart opened 2 years ago

NicolasMassart commented 2 years ago

Description

Find how to extract the Teku OpenAPI doc for key management (equivalent to https://ethereum.github.io/keymanager-APIs/#/Remote%20Key%20Manager but with the Teku source directly)
Create a CI workflow to publish it on the Github page alongside the validator API doc.

doc-change-required

requires also to update doc page https://docs.teku.consensys.net/en/latest/Reference/Rest_API/Rest/

rolfyone commented 2 years ago

one bit i do know:

➜   build/install/teku/bin/teku debug-tools generate-swagger-docs --output tmp
Writing validator-api to /Users/paulharris/IdeaProjects/artemis/tmp/validator-api.json