National Tsing Hua University · API Governance Rules

National Tsing Hua University API Rules

Spectral linting rules defining API design standards and conventions for National Tsing Hua University.

5 Rules error 1 warn 2
Derived by API Evangelist Measured from the API contracts National Tsing Hua University publishes — the conventions those documents already follow, written down as rules. National Tsing Hua University did not publish this file.
View Rules File View on GitHub

Rule Categories

nthu

Rules

warn
nthu-info-version
API info must carry a semantic version (observed: 2.0.0).
$.info
error
nthu-operation-id
Every operation must declare an operationId (NTHU uses camelCase getX/listX/searchX).
$.paths[*][get,post,put,delete]
warn
nthu-operation-tags
Operations are grouped by campus unit tag (Announcements, Buses, Courses, etc.).
$.paths[*][get,post,put,delete]
hint
nthu-snake-case-properties
Schema property names use snake_case (with documented camelCase exceptions like routeEN).
$.components.schemas[*].properties[*]~
hint
nthu-uri-format-on-links
Link/url/image fields should declare format: uri.
$.components.schemas[*].properties[link,url,image]

Spectral Ruleset

Raw ↑
# method: derived
# x-source-url: openapi/_original/nthu-data-api.yaml (NTHU Student Association contract)
# note: Authored by API Evangelist, not published by National Tsing Hua University.
formats:
- oas3
rules:
  nthu-info-version:
    description: 'API info must carry a semantic version (observed: 2.0.0).'
    given: $.info
    severity: warn
    then:
      field: version
      function: truthy
  nthu-operation-id:
    description: Every operation must declare an operationId (NTHU uses camelCase
      getX/listX/searchX).
    given: $.paths[*][get,post,put,delete]
    severity: error
    then:
      field: operationId
      function: truthy
  nthu-operation-tags:
    description: Operations are grouped by campus unit tag (Announcements, Buses,
      Courses, etc.).
    given: $.paths[*][get,post,put,delete]
    severity: warn
    then:
      field: tags
      function: truthy
  nthu-snake-case-properties:
    description: Schema property names use snake_case (with documented camelCase exceptions
      like routeEN).
    given: $.components.schemas[*].properties[*]~
    severity: hint
    then:
      function: pattern
      functionOptions:
        match: ^[a-zA-Z][a-zA-Z0-9_]*$
  nthu-uri-format-on-links:
    description: 'Link/url/image fields should declare format: uri.'
    given: $.components.schemas[*].properties[link,url,image]
    severity: hint
    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/nthu-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.