Kubernetes · API Governance Rules

Kubernetes API Rules

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

5 Rules error 1 warn 4
View Rules File View on GitHub

Rule Categories

no operation security server

Rules

error
server-secure-protocol
Servers should use a secure protocol (this API's convention).
$.servers[*].protocol
warn
server-security-defined
Servers should declare their security requirements.
$.servers[*]
warn
security-schemes-defined
Security schemes should be defined in components.
$.components
warn
operation-id-casing
Operation IDs should be camelCase (the dominant convention in this API).
$.channels[*][publish,subscribe].operationId
warn
no-empty-descriptions
Descriptions must not be empty strings.
$..description

Spectral Ruleset

Raw ↑ 
# kubernetes — 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-secure-protocol: 100% of servers already secure
#   - server-security-defined: 1/1 servers
#   - security-schemes: ['bearerAuth', 'clientCertificate']
#   - operation-id-casing: camel @ 100% (n=7, v2)
extends:
  - spectral:asyncapi
rules:
  server-secure-protocol:
    description: Servers should use a secure protocol (this API's convention).
    severity: error
    given: $.servers[*].protocol
    then:
      function: pattern
      functionOptions:
        match: ^(amqps|https|ibmmq|jms|kafka-secure|mqtts|secure-mqtt|stomps|wss)$
  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
  operation-id-casing:
    description: Operation IDs should be camelCase (the dominant convention in this API).
    severity: warn
    given: $.channels[*][publish,subscribe].operationId
    then:
      function: casing
      functionOptions:
        type: camel
  no-empty-descriptions:
    description: Descriptions must not be empty strings.
    severity: warn
    given: $..description
    then:
      function: truthy