Macquarie University API Rules

# authorship: generated by API Evangelist from this repo's own institution-operated contract.
# x-method: derived
# source: openapi/macquarie-research-portal-oai-pmh-openapi.yml
#
# A small Spectral ruleset expressing the conventions the Macquarie University Research Portal
# OAI-PMH description actually holds to. Built-in Spectral functions only.
formats:
  - oas3
extends:
  - spectral:oas
rules:
  macquarie-operator-declared:
    description: The contract must declare who operates the thing it describes.
    severity: error
    given: $.info
    then:
      field: x-operator
      function: truthy
  macquarie-provenance-declared:
    description: The contract must carry x-provenance with a method, so it is never credited as institution-published when it was probed.
    severity: error
    given: $.info.x-provenance
    then:
      field: method
      function: truthy
  macquarie-institution-host:
    description: Every server must sit on a Macquarie University registrable domain. A vendor host here is the misattribution this repo exists to prevent.
    severity: error
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: "^https://[a-z0-9.-]*mq\\.edu\\.au(/|$)"
  macquarie-https-only:
    description: No plaintext servers.
    severity: error
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        notMatch: "^http://"
  macquarie-contact-institutional:
    description: info.contact.email must be an mq.edu.au address — a vendor support address is the signal that the contract is not the institution's.
    severity: error
    given: $.info.contact.email
    then:
      function: pattern
      functionOptions:
        match: "@([a-z0-9-]+\\.)*mq\\.edu\\.au$"
  macquarie-operation-described:
    description: Every operation carries a description, not just a summary.
    severity: warn
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: description
      function: truthy