ClickHouse · API Governance Rules

ClickHouse API Rules

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

3 Rules warn 3
View Rules File View on GitHub

Rule Categories

no security server

Rules

warn
server-security-defined
Servers should declare their security requirements.
$.servers[*]
warn
security-schemes-defined
Security schemes should be defined in components.
$.components
warn
no-empty-descriptions
Descriptions must not be empty strings.
$..description

Spectral Ruleset

Raw ↑ 
# clickhouse — AsyncAPI Spectral ruleset (strengthened)
# Plain Spectral. Rules measured from this provider's own AsyncAPI event
# conventions by strengthen_asyncapi.py, then self-validated against the spec.
#
# Provenance:
#   - server-security-defined: 1/1 servers
#   - security-schemes: ['saslPlain', 'saslScramSha256', 'saslScramSha512']
extends:
  - spectral:asyncapi
rules:
  server-security-defined:
    description: Servers should declare their security requirements.
    severity: warn
    given: $.servers[*]
    then:
      field: security
      function: truthy
  security-schemes-defined:
    description: Security schemes should be defined in components.
    severity: warn
    given: $.components
    then:
      field: securitySchemes
      function: truthy
  no-empty-descriptions:
    description: Descriptions must not be empty strings.
    severity: warn
    given: $..description
    then:
      function: truthy