It would be nice to have a /ping API endpoint, as a mnemonic one to test if the API is working, the current rate limit, etc.
The endpoint would do nothing except return "pong" (what else, right? :-))
Our documentation currently uses /stat/counters as an example in similar cases. /ping sounds nicer and could be used instead of that.
| rDWAPPS Web applications | |||
| D2728 | rDWAPPSf77207f42eb0 Add /ping/ endpoint to Web API | ||
Hi, I'd like to take this up :)
So, I'd simply have to make a new Django view in swh/web/api/views that returns the string 'pong' (besides appropriately calling the @api_route and @api_doc decorators and writing the appropriate docstring)?
Incidentally, is there a guide to hacking on the swh-web API? I could only find the API documentation
@krithikvaidya, you got it right. Please follow these instructions to start hacking on swh source code.
Cool :-)
Yeah, I've done this 👍 . I was talking about documentation specific to developing on the web API. For example, the different decorators (like @api_route, @format_document, etc.) available, guidelines on writing docstrings for this module, etc.
Anyways, I'll open a diff soon, thanks 👍
You can find Python API documentation for swh-web here. Otherwise, you can inspire from the /stat/counters/ implementation. Please note that currently, we use [[ https://sphinxcontrib-httpdomain.readthedocs.io/en/stable/ | sphinxcontrib-httpdomain ]] format to document the API endpoints.