Apache HBase · API Governance Rules

Apache HBase API Rules

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

9 Rules error 3 warn 5 info 1

View Rules File View on GitHub

Rule Categories

hbase

Rules

error

hbase-operation-summary

All HBase REST API operations must have a summary

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

error

hbase-operation-id

All HBase REST API operations must have an operationId

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

warn

hbase-operation-tags

All HBase REST API operations must have at least one tag

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

warn

hbase-schema-description

All HBase schema components must have a description

$.components.schemas[*]

info

hbase-property-description

All HBase schema properties should have descriptions

$.components.schemas[*].properties[*]

warn

hbase-info-contact

API info must include contact information

$.info

warn

hbase-info-license

API info must include license information

$.info

warn

hbase-path-parameters-described

All HBase path parameters must have descriptions

$.paths[*][*].parameters[?(@.in=='path')]

error

hbase-success-response

All HBase operations must define at least one 2xx response

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

Spectral Ruleset

rules:
  hbase-operation-summary:
    description: All HBase REST API operations must have a summary
    severity: error
    given: "$.paths[*][get,put,post,delete,patch]"
    then:
      field: summary
      function: truthy

  hbase-operation-id:
    description: All HBase REST API operations must have an operationId
    severity: error
    given: "$.paths[*][get,put,post,delete,patch]"
    then:
      field: operationId
      function: truthy

  hbase-operation-tags:
    description: All HBase REST API operations must have at least one tag
    severity: warn
    given: "$.paths[*][get,put,post,delete,patch]"
    then:
      field: tags
      function: truthy

  hbase-schema-description:
    description: All HBase schema components must have a description
    severity: warn
    given: "$.components.schemas[*]"
    then:
      field: description
      function: truthy

  hbase-property-description:
    description: All HBase schema properties should have descriptions
    severity: info
    given: "$.components.schemas[*].properties[*]"
    then:
      field: description
      function: truthy

  hbase-info-contact:
    description: API info must include contact information
    severity: warn
    given: "$.info"
    then:
      field: contact
      function: truthy

  hbase-info-license:
    description: API info must include license information
    severity: warn
    given: "$.info"
    then:
      field: license
      function: truthy

  hbase-path-parameters-described:
    description: All HBase path parameters must have descriptions
    severity: warn
    given: "$.paths[*][*].parameters[?(@.in=='path')]"
    then:
      field: description
      function: truthy

  hbase-success-response:
    description: All HBase operations must define at least one 2xx response
    severity: error
    given: "$.paths[*][get,put,post,delete,patch].responses"
    then:
      function: schema
      functionOptions:
        schema:
          minProperties: 1