Apache Kafka · API Governance Rules

Apache Kafka API Rules

Spectral linting rules defining API design standards and conventions for Apache Kafka.

16 Rules error 9 warn 3 info 4
View Rules File View on GitHub

Rule Categories

get info no openapi operation parameter paths response schema servers

Rules

warn
info-title-prefix
Info title should start with Kafka or Apache Kafka
$.info
error
info-version-required
Info must have a version
$.info
error
openapi-version
Must use OpenAPI 3.x
$
error
servers-defined
Servers must be defined
$
error
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,patch,delete]
error
operation-id-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete]
error
operation-tags-required
Every operation must have tags
$.paths[*][get,post,put,patch,delete]
error
response-description-required
Responses must have descriptions
$.paths[*][get,post,put,patch,delete].responses[*]
error
response-2xx-required
Every operation must have a 2xx response
$.paths[*][get,post,put,patch,delete].responses
error
get-no-request-body
GET operations must not have request bodies
$.paths[*].get
info
paths-kebab-case
Path segments should use kebab-case or snake_case
$.paths
info
schema-description-required
Component schemas should have descriptions
$.components.schemas[*]
warn
no-empty-descriptions
Descriptions must not be empty
$..description
warn
parameter-description-required
Parameters should have descriptions
$.paths[*][get,post,put,patch,delete].parameters[*]
info
response-error-404
GET operations should document 404 responses
$.paths[*].get.responses
info
response-error-400
POST operations should document 400 responses
$.paths[*].post.responses

Spectral Ruleset

Raw ↑ 
rules:
  info-title-prefix:
    description: Info title should start with Kafka or Apache Kafka
    severity: warn
    given: "$.info"
    then:
      field: title
      function: pattern
      functionOptions:
        match: "^(Apache )?Kafka"

  info-version-required:
    description: Info must have a version
    severity: error
    given: "$.info"
    then:
      field: version
      function: truthy

  openapi-version:
    description: Must use OpenAPI 3.x
    severity: error
    given: "$"
    then:
      field: openapi
      function: pattern
      functionOptions:
        match: "^3\\."

  servers-defined:
    description: Servers must be defined
    severity: error
    given: "$"
    then:
      field: servers
      function: truthy

  operation-summary-required:
    description: Every operation must have a summary
    severity: error
    given: "$.paths[*][get,post,put,patch,delete]"
    then:
      field: summary
      function: truthy

  operation-id-required:
    description: Every operation must have an operationId
    severity: error
    given: "$.paths[*][get,post,put,patch,delete]"
    then:
      field: operationId
      function: truthy

  operation-tags-required:
    description: Every operation must have tags
    severity: error
    given: "$.paths[*][get,post,put,patch,delete]"
    then:
      field: tags
      function: truthy

  response-description-required:
    description: Responses must have descriptions
    severity: error
    given: "$.paths[*][get,post,put,patch,delete].responses[*]"
    then:
      field: description
      function: truthy

  response-2xx-required:
    description: Every operation must have a 2xx response
    severity: error
    given: "$.paths[*][get,post,put,patch,delete].responses"
    then:
      function: schema
      functionOptions:
        schema:
          anyOf:
            - required: ["200"]
            - required: ["201"]
            - required: ["204"]

  get-no-request-body:
    description: GET operations must not have request bodies
    severity: error
    given: "$.paths[*].get"
    then:
      field: requestBody
      function: falsy

  paths-kebab-case:
    description: Path segments should use kebab-case or snake_case
    severity: info
    given: "$.paths"
    then:
      field: "@key"
      function: pattern
      functionOptions:
        match: "^(\/([a-z0-9{}_-]+))*$"

  schema-description-required:
    description: Component schemas should have descriptions
    severity: info
    given: "$.components.schemas[*]"
    then:
      field: description
      function: truthy

  no-empty-descriptions:
    description: Descriptions must not be empty
    severity: warn
    given: "$..description"
    then:
      function: pattern
      functionOptions:
        match: ".+"

  parameter-description-required:
    description: Parameters should have descriptions
    severity: warn
    given: "$.paths[*][get,post,put,patch,delete].parameters[*]"
    then:
      field: description
      function: truthy

  response-error-404:
    description: GET operations should document 404 responses
    severity: info
    given: "$.paths[*].get.responses"
    then:
      field: "404"
      function: truthy

  response-error-400:
    description: POST operations should document 400 responses
    severity: info
    given: "$.paths[*].post.responses"
    then:
      field: "400"
      function: truthy