Université de Montréal · API Governance Rules

Université de Montréal API Rules

Spectral linting rules defining API design standards and conventions for Université de Montréal.

5 Rules error 2 warn 3

View Rules File View on GitHub

Rule Categories

udem

Rules

error

udem-info-title-present

API info.title must be present.

$.info

error

udem-info-version-present

API info.version must be present (Borealis/Dataverse reports a semantic version).

$.info

warn

udem-operations-have-tags

Every operation should carry at least one tag, as the Dataverse API groups operations by tag.

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

warn

udem-paths-kebab-or-segment

Path segments should not contain underscores or uppercase, matching observed Dataverse path style.

$.paths

warn

udem-responses-json

Operations should declare JSON responses; the Borealis API returns application/json envelopes.

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

Spectral Ruleset

formats:
  - oas3
rules:
  udem-info-title-present:
    description: API info.title must be present.
    severity: error
    given: $.info
    then:
      field: title
      function: truthy
  udem-info-version-present:
    description: API info.version must be present (Borealis/Dataverse reports a semantic version).
    severity: error
    given: $.info
    then:
      field: version
      function: truthy
  udem-operations-have-tags:
    description: Every operation should carry at least one tag, as the Dataverse API groups operations by tag.
    severity: warn
    given: $.paths[*][get,put,post,delete,patch]
    then:
      field: tags
      function: truthy
  udem-paths-kebab-or-segment:
    description: Path segments should not contain underscores or uppercase, matching observed Dataverse path style.
    severity: warn
    given: $.paths
    then:
      field: "@key"
      function: pattern
      functionOptions:
        notMatch: "[A-Z_]"
  udem-responses-json:
    description: Operations should declare JSON responses; the Borealis API returns application/json envelopes.
    severity: warn
    given: $.paths[*][get,post,put,delete,patch].responses[*].content
    then:
      field: application/json
      function: truthy