University of Sheffield · API Governance Rules

University of Sheffield API Rules

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

6 Rules error 1 warn 5

View Rules File View on GitHub

Rule Categories

uos

Rules

error

uos-info-title

API must declare a title.

$.info

warn

uos-info-description

API should provide a description.

$.info

warn

uos-server-figshare

Server URL should target the figshare v2 API base used by ORDA.

$.servers[*]

warn

uos-operation-tags

Every operation should be tagged so research-data endpoints stay grouped.

$.paths[*][get,post,put,delete]

warn

uos-article-id-integer

Article identifiers are integers across the figshare API.

$.components.schemas.Article.properties.id

warn

uos-doi-present

Research output objects should expose a DOI for citation.

$.components.schemas.Article.properties

Spectral Ruleset

---
# Spectral ruleset encoding patterns observed in the figshare API
# powering the University of Sheffield ORDA research data repository.
formats:
  - oas3
rules:
  uos-info-title:
    description: API must declare a title.
    severity: error
    given: $.info
    then:
      field: title
      function: truthy
  uos-info-description:
    description: API should provide a description.
    severity: warn
    given: $.info
    then:
      field: description
      function: truthy
  uos-server-figshare:
    description: Server URL should target the figshare v2 API base used by ORDA.
    severity: warn
    given: $.servers[*]
    then:
      field: url
      function: pattern
      functionOptions:
        match: "^https://api\\.figshare\\.com/v2"
  uos-operation-tags:
    description: Every operation should be tagged so research-data endpoints stay grouped.
    severity: warn
    given: $.paths[*][get,post,put,delete]
    then:
      field: tags
      function: truthy
  uos-article-id-integer:
    description: Article identifiers are integers across the figshare API.
    severity: warn
    given: $.components.schemas.Article.properties.id
    then:
      field: type
      function: pattern
      functionOptions:
        match: "^integer$"
  uos-doi-present:
    description: Research output objects should expose a DOI for citation.
    severity: warn
    given: $.components.schemas.Article.properties
    then:
      field: doi
      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/university-of-sheffield-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 email required.

GitHub Google LinkedIn

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