GridGain · API Governance Rules

GridGain API Rules

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

3 Rules error 2 warn 1
View Rules File View on GitHub

Rule Categories

gridgain

Rules

error
gridgain-info-version-required
GridGain spec must declare a version.
$.info
error
gridgain-security-defined
GridGain management API must declare security schemes (bearer/basic).
$.components.securitySchemes
warn
gridgain-operation-tag-required
Each GridGain operation must be tagged so it groups under a capability.
$.paths[*][get,post,put,delete,patch]

Spectral Ruleset

Raw ↑ 
rules:
  gridgain-info-version-required:
    description: GridGain spec must declare a version.
    given: $.info
    severity: error
    then:
      field: version
      function: truthy
  gridgain-security-defined:
    description: GridGain management API must declare security schemes (bearer/basic).
    given: $.components.securitySchemes
    severity: error
    then:
      function: truthy
  gridgain-operation-tag-required:
    description: Each GridGain operation must be tagged so it groups under a capability.
    given: $.paths[*][get,post,put,delete,patch]
    severity: warn
    then:
      field: tags
      function: truthy