Lancaster University · API Governance Rules

Lancaster University API Rules

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

5 Rules error 2 warn 3
View Rules File View on GitHub

Rule Categories

lancaster

Rules

warn
lancaster-info-contact
Lancaster API descriptions should carry the library DIT contact.
$.info
error
lancaster-oai-verb-param-required
The OAI-PMH dispatch operation must declare the required "verb" query parameter (the protocol selects the operation by verb).
$.paths['/oai2'].get.parameters[?(@.name=='verb')]
error
lancaster-oai-verb-enumerated
The verb parameter must enumerate the supported OAI-PMH verbs.
$.paths['/oai2'].get.parameters[?(@.name=='verb')].schema
warn
lancaster-metadata-prefix-enumerated
metadataPrefix should be constrained to the formats this repository actually disseminates.
$.paths['/oai2'].get.parameters[?(@.name=='metadataPrefix')].schema
warn
lancaster-datetime-granularity
from/until selective-harvesting params should use date-time format.
$.paths['/oai2'].get.parameters[?(@.name=='from' || @.name=='until')].schema

Spectral Ruleset

Raw ↑
extends: spectral:oas
formats:
  - oas3
rules:
  lancaster-info-contact:
    description: Lancaster API descriptions should carry the library DIT contact.
    severity: warn
    given: $.info
    then:
      field: contact
      function: truthy
  lancaster-oai-verb-param-required:
    description: >-
      The OAI-PMH dispatch operation must declare the required "verb" query
      parameter (the protocol selects the operation by verb).
    severity: error
    given: $.paths['/oai2'].get.parameters[?(@.name=='verb')]
    then:
      field: required
      function: truthy
  lancaster-oai-verb-enumerated:
    description: The verb parameter must enumerate the supported OAI-PMH verbs.
    severity: error
    given: $.paths['/oai2'].get.parameters[?(@.name=='verb')].schema
    then:
      field: enum
      function: truthy
  lancaster-metadata-prefix-enumerated:
    description: >-
      metadataPrefix should be constrained to the formats this repository
      actually disseminates.
    severity: warn
    given: $.paths['/oai2'].get.parameters[?(@.name=='metadataPrefix')].schema
    then:
      field: enum
      function: truthy
  lancaster-datetime-granularity:
    description: from/until selective-harvesting params should use date-time format.
    severity: warn
    given: $.paths['/oai2'].get.parameters[?(@.name=='from' || @.name=='until')].schema
    then:
      field: format
      function: truthy

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/lancaster-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.