Skip to content

README.md

Latest commit

 

History

History
11 lines (8 loc) · 1.44 KB

README.md

File metadata and controls

11 lines (8 loc) · 1.44 KB

Sidecar OpenApi UI

OpenApi spec for substrate-api-sidecar.

Contributing:

If you add a new endpoint or update an existing one (by modifying its parameters or output), you will also need to update the documentation (OpenApi specs). Here are some common steps to follow in order to do that:

  • Update this file by adding or updating the corresponding endpoint description in the paths and schemas sections.
  • After you complete the changes, verify that the yaml file has no errors by copying the contents of this file into the Swagger Editor or the New Swagger Editor.
  • If everything looks good, push the changes.
  • To preview the docs locally, you can run yarn build:docs from the root directory of this repository. This will update the docs/dist/index.html page which you can open (by copying its path) in your browser and verify that the content appear as expected. Please do not push/commit this file (or the dist folder) in your PR since this is not necessary. The docs will be build and published automatically in Github pages from the workflow (docs.yml).