Axon Framework · API Governance Rules

Axon Framework API Rules

Spectral linting rules defining API design standards and conventions for Axon Framework.

5 Rules error 3 warn 1 info 1

View Rules File View on GitHub

Rule Categories

axon

Rules

warn

axon-operation-summary

All operations must have a summary starting with "Axon Framework"

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

error

axon-operation-id

All operations must have an operationId

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

error

axon-info-title

Info object must have a title

$.info

error

axon-response-description

All responses must have a description

$.paths[*][*].responses[*]

info

axon-microcks-annotation

Operations should have x-microcks-operation annotation

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

Spectral Ruleset

rules:
  axon-operation-summary:
    description: All operations must have a summary starting with "Axon Framework"
    severity: warn
    given: "$.paths[*][get,post,put,delete,patch]"
    then:
      field: summary
      function: pattern
      functionOptions:
        match: "^Axon Framework"
  axon-operation-id:
    description: All operations must have an operationId
    severity: error
    given: "$.paths[*][get,post,put,delete,patch]"
    then:
      field: operationId
      function: truthy
  axon-info-title:
    description: Info object must have a title
    severity: error
    given: "$.info"
    then:
      field: title
      function: truthy
  axon-response-description:
    description: All responses must have a description
    severity: error
    given: "$.paths[*][*].responses[*]"
    then:
      field: description
      function: truthy
  axon-microcks-annotation:
    description: Operations should have x-microcks-operation annotation
    severity: info
    given: "$.paths[*][get,post,put,delete,patch]"
    then:
      field: x-microcks-operation
      function: truthy