Cleanshelf · API Governance Rules

Cleanshelf API Rules

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

6 Rules error 4 warn 2

View Rules File View on GitHub

Rule Categories

cleanshelf

Rules

warn

cleanshelf-info-contact

API info MUST contain a contact email or URL.

$.info

error

cleanshelf-https-only

All Zylo (Cleanshelf successor) API servers MUST use HTTPS.

$.servers[*].url

error

cleanshelf-operation-id

Operations MUST have an operationId.

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

warn

cleanshelf-tag-required

Operations MUST be tagged for SaaS-management domain grouping.

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

error

cleanshelf-security-required

API MUST define API key or bearer token security schemes.

$.components.securitySchemes

error

cleanshelf-server-url

API MUST declare at least one server URL.

$.servers

Spectral Ruleset

extends:
  - spectral:oas
rules:
  cleanshelf-info-contact:
    description: API info MUST contain a contact email or URL.
    severity: warn
    given: $.info
    then:
      field: contact
      function: truthy
  cleanshelf-https-only:
    description: All Zylo (Cleanshelf successor) API servers MUST use HTTPS.
    severity: error
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: '^https://'
  cleanshelf-operation-id:
    description: Operations MUST have an operationId.
    severity: error
    given: $.paths[*][get,post,put,delete,patch]
    then:
      field: operationId
      function: truthy
  cleanshelf-tag-required:
    description: Operations MUST be tagged for SaaS-management domain grouping.
    severity: warn
    given: $.paths[*][get,post,put,delete,patch].tags
    then:
      function: truthy
  cleanshelf-security-required:
    description: API MUST define API key or bearer token security schemes.
    severity: error
    given: $.components.securitySchemes
    then:
      function: truthy
  cleanshelf-server-url:
    description: API MUST declare at least one server URL.
    severity: error
    given: $.servers
    then:
      function: truthy