University of Cape Town · API Governance Rules

University of Cape Town API Rules

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

8 Rules error 2 warn 6

Derived by API Evangelist Measured from the API contracts University of Cape Town publishes — the conventions those documents already follow, written down as rules. University of Cape Town did not publish this file.

View Rules File View on GitHub

Rule Categories

uct

Rules

warn

uct-info-contact

API info object should include a contact.

$.info

warn

uct-info-description

API info object should include a description.

$.info

error

uct-https-servers

All servers must use HTTPS (UCT public APIs are HTTPS-only).

$.servers[*].url

error

uct-operation-operationid

Every operation must declare an operationId.

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

warn

uct-operation-summary

Every operation should have a summary.

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

warn

uct-operation-tags

Every operation should be tagged.

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

warn

uct-resource-has-id

DataFirst catalog objects expose a stable integer id.

$.components.schemas[?(@property.match(/Study$|StudyDetail$|DataFile$|Variable$/))].properties

warn

uct-doi-as-string

DOI fields should be modeled as strings.

$.components.schemas[*].properties.doi

Spectral Ruleset

# x-provenance:
#   generated: '2026-08-30'
#   method: derived
#   source: openapi/_original/university-of-cape-town-datafirst-nada.yaml
#   x-operator: institution
#   note: Figshare schema names (Article/Collection/Project) removed 2026-08-30.
formats: [oas3]
rules:
  uct-info-contact:
    description: API info object should include a contact.
    severity: warn
    given: $.info
    then:
      field: contact
      function: truthy
  uct-info-description:
    description: API info object should include a description.
    severity: warn
    given: $.info
    then:
      field: description
      function: truthy
  uct-https-servers:
    description: All servers must use HTTPS (UCT public APIs are HTTPS-only).
    severity: error
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: '^https://'
  uct-operation-operationid:
    description: Every operation must declare an operationId.
    severity: error
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: operationId
      function: truthy
  uct-operation-summary:
    description: Every operation should have a summary.
    severity: warn
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: summary
      function: truthy
  uct-operation-tags:
    description: Every operation should be tagged.
    severity: warn
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: tags
      function: truthy
  uct-resource-has-id:
    description: DataFirst catalog objects expose a stable integer id.
    severity: warn
    given: $.components.schemas[?(@property.match(/Study$|StudyDetail$|DataFile$|Variable$/))].properties
    then:
      field: id
      function: truthy
  uct-doi-as-string:
    description: DOI fields should be modeled as strings.
    severity: warn
    given: $.components.schemas[*].properties.doi
    then:
      field: type
      function: defined

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-cape-town-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.

GitHub Google LinkedIn

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