Skip to main content

examples

Worked response examples published in the served OpenAPI document.

Kept out of models.py so the model definitions stay readable. These are wired into the routes as OpenAPI examples, which is what makes them show up in /openapi.json, /openapi.yaml and the Swagger UI example picker.

The evidence examples exist to cover the EligibilityCriterion families end-to-end: every family in models.CRITERION_VARIANTS appears in at least one of them, alongside the evidence_mapping each set of config_fields produces, and every code_match branch a code filter can emit (a decisive match — including a multi-code one, since matched_codes reports all of them — codes awaiting review, and an uninspected code column). tests/bitfount/patient_api/test_openapi.py asserts both of those properties, so an example cannot silently drift from the code that builds the real thing.