KU Leuven · API Governance Rules

KU Leuven API Rules

Spectral linting rules defining API design standards and conventions for KU Leuven.

4 Rules error 1 warn 2 info 1

View Rules File View on GitHub

Rule Categories

Rules

warn

ku-leuven-info-title

API title must reference the KU Leuven RDR.

$.info.title

error

ku-leuven-server-host

Servers should point at the KU Leuven RDR host.

$.servers[*].url

warn

ku-leuven-operation-id

Every operation must declare an operationId (Dataverse pattern).

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

info

ku-leuven-response-envelope

Dataverse JSON responses use a standard {status, data} envelope; document a 200 response.

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

Spectral Ruleset

extends: [[spectral:oas, off]]
formats: [oas3]
documentationUrl: https://www.kuleuven.be/rdm/en/rdr/api-documentation
rules:
  ku-leuven-info-title:
    description: API title must reference the KU Leuven RDR.
    severity: warn
    given: $.info.title
    then:
      function: pattern
      functionOptions:
        match: "KU Leuven"
  ku-leuven-server-host:
    description: Servers should point at the KU Leuven RDR host.
    severity: error
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: "rdr\\.kuleuven\\.be"
  ku-leuven-operation-id:
    description: Every operation must declare an operationId (Dataverse pattern).
    severity: warn
    given: $.paths[*][get,post,put,delete,patch]
    then:
      field: operationId
      function: truthy
  ku-leuven-response-envelope:
    description: Dataverse JSON responses use a standard {status, data} envelope; document a 200 response.
    severity: info
    given: $.paths[*][get,post,put,delete,patch].responses
    then:
      field: "200"
      function: truthy