api-backend

HamClock Client to Backend API

This is a document of HamClock's calls to the Backend. The calls are GET method URLs.

Workflow

• api-doc.csv is the central reference for API documentation. Make all new API changes here.
• Run python3 csv-to-md.py to generate .md file for input to other tools
• Run python3 md-to-doc.py api-doc.md > api-doc.txt to generate the plain text table api-doc.txt.
• Run python3 md-to-openapi.py api-doc.md hamclock-openapi.yaml to generate the OpenAPI specification hamclock-openapi.yaml.
• Generation of HTML documentation is done within update-generated-docs.sh as described below

To do all of the above plus generate HTML documentation, run:

./update-generated-docs.sh

Historical Notes

The endpoints and arguments were originally generated by scraping the ohb.hamclock.app logs using url-to-markdown.py (now deprecated) and md-to-doc.py (renamed from url-to-doc.py, now reads from md).

The log data is archived in log-extract.archive for reference.