Customer.io · API Governance Rules

Customer.io API Rules

Spectral linting rules defining API design standards and conventions for Customer.io.

6 Rules error 3 warn 3
View Rules File View on GitHub

Rule Categories

customer

Rules

warn
customer-io-info-contact
Customer.io API specs must declare a contact.
$.info
error
customer-io-server-https
Customer.io API server URLs must use HTTPS.
$.servers[*].url
error
customer-io-base-host
Customer.io API base URLs must point to a customer.io host.
$.servers[*].url
warn
customer-io-tags-required
Every operation must declare at least one tag.
$.paths[*][get,post,put,patch,delete]
error
customer-io-operation-id-required
Every operation must declare an operationId.
$.paths[*][get,post,put,patch,delete]
warn
customer-io-security-required
Every operation must declare security requirements.
$.paths[*][get,post,put,patch,delete]

Spectral Ruleset

Raw ↑ 
extends: spectral:oas
rules:
  customer-io-info-contact:
    description: Customer.io API specs must declare a contact.
    severity: warn
    given: $.info
    then:
      field: contact
      function: truthy
  customer-io-server-https:
    description: Customer.io API server URLs must use HTTPS.
    severity: error
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: '^https://'
  customer-io-base-host:
    description: Customer.io API base URLs must point to a customer.io host.
    severity: error
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: '^https://([a-z]+\.)?customer\.io'
  customer-io-tags-required:
    description: Every operation must declare at least one tag.
    severity: warn
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: tags
      function: truthy
  customer-io-operation-id-required:
    description: Every operation must declare an operationId.
    severity: error
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: operationId
      function: truthy
  customer-io-security-required:
    description: Every operation must declare security requirements.
    severity: warn
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: security
      function: truthy