University of Manchester · API Governance Rules
University of Manchester API Rules
Spectral linting rules defining API design standards and conventions for University of Manchester.
10 Rules
error 5
warn 5
Rule Categories
uom
Rules
error
uom-info-title-present
Every contract must declare an info.title.
$.info
error
uom-info-description-present
Every contract must carry an info.description saying what the University operates and what it merely runs on. The attribution belongs in the contract, not only in the catalog.
$.info
warn
uom-info-contact-present
A contract must name a responsible party inside the institution.
$.info
error
uom-servers-absolute-institution-host
servers[].url must be an absolute URL on a manchester.ac.uk host. A relative server URL is how Elsevier's Pure contract avoided naming any operator at all, and it is the pattern that let one vendor specification be attributed to dozens of universities.
$.servers[*].url
error
uom-no-vendor-contact
info.contact.email must not be a supplier support address. If the contact is the vendor's, the contract is the vendor's.
$.info.contact.email
error
uom-no-placeholder-server
Reject placeholder hosts. An example/test/localhost server is never a surface.
$.servers[*].url
warn
uom-operations-have-operation-id
Every operation needs an operationId so it can be referenced and generated against.
$.paths[*][get,put,post,delete,patch]
warn
uom-operations-have-description
Every operation must describe what was actually observed, including the probe that verified it.
$.paths[*][get,put,post,delete,patch]
warn
uom-operations-document-404
Every read operation must document a 404. Manchester's IIIF services return real 404s on unknown identifiers; a contract that omits it invites soft-404 false credit downstream.
$.paths[*].get.responses
warn
uom-terms-of-service-present
A public reuse surface should point at its terms.
$.info