Nagios · API Governance Rules

Nagios API Rules

Spectral linting rules defining API design standards and conventions for Nagios.

3 Rules error 1 warn 2
View Rules File View on GitHub

Rule Categories

ncpa

Rules

error
ncpa-token-required
Every NCPA operation must require the `token` query parameter.
$.paths..[get,post]
warn
ncpa-summary-title-case
Operation summaries should use Title Case.
$.paths..[get,post,put,delete].summary
warn
ncpa-tag-vocabulary
Tags must come from the NCPA module vocabulary.
$.paths..[get,post,put,delete].tags[*]

Spectral Ruleset

Raw ↑ 
extends: [[spectral:oas, all]]
documentationUrl: https://github.com/api-evangelist/nagios

rules:
  ncpa-token-required:
    description: Every NCPA operation must require the `token` query parameter.
    severity: error
    given: $.paths..[get,post]
    then:
      field: security
      function: truthy
  ncpa-summary-title-case:
    description: Operation summaries should use Title Case.
    severity: warn
    given: $.paths..[get,post,put,delete].summary
    then:
      function: pattern
      functionOptions:
        match: '^([A-Z][A-Za-z0-9]*)( ([A-Z][A-Za-z0-9]*|API|CPU|NCPA))*$'
  ncpa-tag-vocabulary:
    description: Tags must come from the NCPA module vocabulary.
    severity: warn
    given: $.paths..[get,post,put,delete].tags[*]
    then:
      function: enumeration
      functionOptions:
        values: [System, CPU, Memory, Disk, Interface, Processes, Services, Plugins]