Akka · API Governance Rules

Akka API Rules

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

12 Rules error 7 warn 4 info 1
View Rules File View on GitHub

Rule Categories

get info openapi operation paths response servers

Rules

warn
info-title-akka-prefix
$.info.title
error
info-description-required
$.info
error
info-version-required
$.info
error
openapi-version-3
$
warn
servers-defined
$
error
operation-summary-required
$.paths[*][get,post,put,patch,delete]
warn
operation-summary-akka-prefix
$.paths[*][get,post,put,patch,delete].summary
error
operation-id-required
$.paths[*][get,post,put,patch,delete]
warn
operation-tags-required
$.paths[*][get,post,put,patch,delete]
error
response-description-required
$.paths[*][*].responses[*]
error
get-no-request-body
$.paths[*].get
info
paths-kebab-case
$.paths[*]~

Spectral Ruleset

Raw ↑ 
# Akka Management API Spectral Ruleset

rules:
  info-title-akka-prefix:
    message: "API title should start with 'Akka'"
    severity: warn
    given: "$.info.title"
    then:
      function: pattern
      functionOptions:
        match: "^Akka"

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

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

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

  servers-defined:
    message: "Servers must be defined"
    severity: warn
    given: "$"
    then:
      field: servers
      function: truthy

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

  operation-summary-akka-prefix:
    message: "Operation summaries should start with 'Akka'"
    severity: warn
    given: "$.paths[*][get,post,put,patch,delete].summary"
    then:
      function: pattern
      functionOptions:
        match: "^Akka"

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

  operation-tags-required:
    message: "Every operation must have at least one tag"
    severity: warn
    given: "$.paths[*][get,post,put,patch,delete]"
    then:
      field: tags
      function: truthy

  response-description-required:
    message: "All responses must have a description"
    severity: error
    given: "$.paths[*][*].responses[*]"
    then:
      field: description
      function: truthy

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

  paths-kebab-case:
    message: "Path segments should use kebab-case"
    severity: info
    given: "$.paths[*]~"
    then:
      function: pattern
      functionOptions:
        match: "^(\\/([a-z0-9][a-z0-9\\-]*|\\{[a-zA-Z][a-zA-Z0-9_]*\\}))*$"