MUST have info api audience
The info object MUST have an x-audience that matches at least one of these values:
Important:
For openapi definitions marked with info.x-api-type: pygeoapi, this rule’s severity is automatically set to warn by the override-severity-pygeoapi rule. See 1.
| audience | Use case |
|---|---|
company-internal |
for internal use only with UKHSA |
partner-external |
for UKHSA partners under a service agreement |
premium-external |
for publicly available but commercial/monetised APIs behind a paywall |
public-external |
for public and freely accessible APIs (e.g. Data Dashboard) |
Valid Example
info:
title: Test Results Api
x-audience: public-external
Published: 5 February 2025
Last updated: 25 September 2025
Page Source