University of Vienna · API Governance Rules

University of Vienna API Rules

Spectral linting rules defining API design standards and conventions for University of Vienna.

7 Rules error 2 warn 4 info 1
View Rules File View on GitHub

Rule Categories

phaidra

Rules

error
phaidra-info-title
API document must declare an info.title.
$.info
error
phaidra-info-version
API document must declare an info.version.
$.info
warn
phaidra-server-https
Production servers should use HTTPS (PHAIDRA is served over TLS).
$.servers[*].url
warn
phaidra-operation-tags
Every operation should carry at least one tag (object-basics, search, directory, etc.).
$.paths[*][get,post,put,delete,patch]
warn
phaidra-operation-summary
Every operation should have a human-readable summary.
$.paths[*][get,post,put,delete,patch]
info
phaidra-pid-path-param
Object paths use a {pid} path parameter for the persistent identifier.
$.paths[?(@property.match(/object\/\{pid\}/))]
warn
phaidra-security-defined
Components should define the basicAuth / tokenAuth security schemes used by PHAIDRA.
$.components.securitySchemes

Spectral Ruleset

Raw ↑ 
---
# Spectral ruleset encoding patterns observed in the University of Vienna
# PHAIDRA API (OpenAPI 3.0.2). Formats restricted to OpenAPI 3.x.
extends: [[spectral:oas, off]]
formats:
  - oas3
rules:
  phaidra-info-title:
    description: API document must declare an info.title.
    given: $.info
    severity: error
    then:
      field: title
      function: truthy

  phaidra-info-version:
    description: API document must declare an info.version.
    given: $.info
    severity: error
    then:
      field: version
      function: truthy

  phaidra-server-https:
    description: Production servers should use HTTPS (PHAIDRA is served over TLS).
    given: $.servers[*].url
    severity: warn
    then:
      function: pattern
      functionOptions:
        match: "^https://"

  phaidra-operation-tags:
    description: Every operation should carry at least one tag (object-basics, search, directory, etc.).
    given: $.paths[*][get,post,put,delete,patch]
    severity: warn
    then:
      field: tags
      function: truthy

  phaidra-operation-summary:
    description: Every operation should have a human-readable summary.
    given: $.paths[*][get,post,put,delete,patch]
    severity: warn
    then:
      field: summary
      function: truthy

  phaidra-pid-path-param:
    description: Object paths use a {pid} path parameter for the persistent identifier.
    given: $.paths[?(@property.match(/object\/\{pid\}/))]
    severity: info
    then:
      function: defined

  phaidra-security-defined:
    description: Components should define the basicAuth / tokenAuth security schemes used by PHAIDRA.
    given: $.components.securitySchemes
    severity: warn
    then:
      function: truthy