diff --git a/server/fishtest/api.py b/server/fishtest/api.py index ecf34fe80..352fc3d03 100644 --- a/server/fishtest/api.py +++ b/server/fishtest/api.py @@ -20,14 +20,15 @@ Important note ============== -All APIs that rely on get_run() should be served from a single Fishtest instance. -It's essential to note that validate_request() can also utilize get_run(). -Therefore, any APIs using self.validate_request("/api/") could also -requires to be served from the same Fishtest instance. - -If other instances require information about runs, they should directly query the database. -However, please be aware that this information might be slightly outdated, -depending on how frequently the main instance flushes its run cache. +All APIs that rely on the `run_cache` of `rundb.get_run()` +must be served from the main Fishtest instance. +Note that `self.validate_request("/api/")` +uses `rundb.get_run()` under some conditions. + +If other Fishtest instances need information about runs, +they should query the database directly. +However, keep in mind that this information might be slightly outdated. +This depends on how frequently the main instance flushes its `run_cache`. """ WORKER_VERSION = 230