This repository contains the API for OpenPlan, implemented as Azure Function Apps and secured with Microsoft Entra ID. The code exposes structured data and reference endpoints for planning and analytical workflows, and includes an OpenAPI definition for interactive documentation.
OpenPlan API provides a lightweight HTTP layer built on Azure Functions for access to OpenPlan datasets and reference information. The service currently includes:
- provider and reference lookups
- demographic data endpoints
- TPMA rate queries by provider and financial year
- generated OpenAPI and Swagger documentation
The deployment locations and environment details are intentionally not described in this repository.
function_app.py— Azure Functions app entry point and route registrationopenplan/— application modules and API route handlersinfrastructure/— infrastructure-as-code for Azure resourceshost.jsonandlocal.settings.json— Azure Functions runtime configurationrequirements.txt/pyproject.toml— Python project dependencies and packaging metadata
This project targets Python 3.14.
- Create and activate a virtual environment:
python -m venv .venvsource .venv/bin/activate
- Install dependencies:
pip install -r requirements.txt- or
uv sync
- Start the Azure Functions host locally:
func start
Once running, the API exposes OpenAPI and Swagger endpoints through the Azure Functions app.
This repository contains Azure Function Apps secured with Microsoft Entra ID. Authentication and authorization are enforced at the application boundary; access to deployed resources is managed through Microsoft Entra ID-based identity configuration.
This project is licensed under the MIT License. See LICENSE for details.