University of Birmingham · API Governance Rules

University of Birmingham API Rules

Spectral linting rules defining API design standards and conventions for University of Birmingham.

5 Rules error 2 warn 2 info 1
View Rules File View on GitHub

Rule Categories

uob

Rules

warn
uob-info-contact
API info should include a contact (Constructicon API lists a project contact email).
$.info
error
uob-construction-schema-required
Construction schema must keep id, construction_id and name as required fields.
$.components.schemas.Construction
error
uob-operationid-present
Every operation must declare an operationId (listConstructions, getConstruction).
$.paths[*][get,post,put,delete]
warn
uob-json-only
Responses are JSON; observed media type is application/json.
$.paths[*][get].responses[*].content
info
uob-no-auth
The English Constructicon API is open and requires no security scheme.
$

Spectral Ruleset

Raw ↑
# authorship: generated by API Evangelist tooling from this repository's own OpenAPI.
# NOT authored or published by the University of Birmingham.
# x-method: derived
# x-source-url: openapi/university-of-birmingham-constructions-api-openapi.yml
# generated: 2026-08-30
formats:
  - oas3
rules:
  uob-info-contact:
    description: API info should include a contact (Constructicon API lists a project contact email).
    given: $.info
    severity: warn
    then:
      field: contact
      function: truthy
  uob-construction-schema-required:
    description: Construction schema must keep id, construction_id and name as required fields.
    given: $.components.schemas.Construction
    severity: error
    then:
      field: required
      function: truthy
  uob-operationid-present:
    description: Every operation must declare an operationId (listConstructions, getConstruction).
    given: $.paths[*][get,post,put,delete]
    severity: error
    then:
      field: operationId
      function: truthy
  uob-json-only:
    description: Responses are JSON; observed media type is application/json.
    given: $.paths[*][get].responses[*].content
    severity: warn
    then:
      field: application/json
      function: truthy
  uob-no-auth:
    description: The English Constructicon API is open and requires no security scheme.
    given: $
    severity: info
    then:
      field: security
      function: falsy

Work with this as data

Every ruleset here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for spectral rules

4 MCP tools reach this
  • find_rulesBrowse and filter every ruleset in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This ruleset
curl "https://apis.io/api/v1/rules/university-of-birmingham-rules"
All spectral rules
curl "https://apis.io/api/v1/rules?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.