api

SRI Testing as a Web Service

The Reasoner Validator is available wrapped as a simple (FastAPI-coded) web service. The service may be run directly or as a Docker container (see below).

API

The web service has a single POST endpoint /validate taking a simple JSON request body, as follows:

{
  "trapi_version": "1.4.0",
  "biolink_version": "3.2.0",
  "message": "<TRAPI JSON message blob...>"
}

The request body consists of JSON data structure with two top level tag:

• An optional trapi_version tag can be given a value of the TRAPI version against which the message will be validated, expressed as a SemVer string (defaults to 'latest' if omitted; partial SemVer strings are resolved to their 'latest' minor and patch releases).
• An optional biolink_version tag can be given a value of the Biolink Model version against which the message knowledge graph semantic contents will be validated, expressed as a SemVer string (defaults to 'latest' Biolink Model Toolkit supported version, if omitted).
• A mandatory message tag should have as its value the complete TRAPI Message JSON data structure to be validated.

Running the Web Service API Directly

The web service application may be run directly as a Python module. It is suggested that a virtual environment first be created (using virtualenv, conda, within your IDE, or equivalent). Then, certain additional SRI Testing project Python dependencies need to be installed, as follows:

pip install -r requirements.txt          # non-web dependencies
pip install -r requirements-service.txt  # web service dependencies

The module may afterwards be run, as follows:

python -m api.main

Go to http://localhost/docs to see the service documentation and to use the simple web page to test TRAPI services. The available endpoints are summarized in the following table:

API Endpoint	Purpose
/registry	Returns list of all 'testable' resources in the Translator SmartAPI Registry
/run_tests	Initiates a test run
/status	Returns the % completion of a test run
/delete	Cancels a running test run or removes a saved test run from the system (all test run data is deleted from the report database)
/test_runs	Lists all completed test runs in the report database
/index	Provides the catalog of test run ARAs and KPs
/summary	Provides a summary of test run outcomes (i.e. unit test passes, failures, warnings and skips
/resource	Returns (conceptually) a test run results 'table' (as a structured JSON file)
/details	Returns the details of a given test run outcomes for one specified (KP) test data end
/response	Returns (streamed) the full JSON response of a unit test TRAPI call.
/recommendations	Returns non-redundant inventory of test messages recommended for follow-up action