Apache Helix · API Governance Rules

Apache Helix API Rules

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

13 Rules error 2 warn 9 info 2
View Rules File View on GitHub

Rule Categories

helix no operationid path schema

Rules

error
helix-operation-summary
All Helix REST API operations must have a summary
$.paths[*][get,put,post,delete,patch]
error
helix-operation-id
All Helix REST API operations must have an operationId
$.paths[*][get,put,post,delete,patch]
warn
helix-operation-tags
All Helix REST API operations must have at least one tag
$.paths[*][get,put,post,delete,patch]
warn
helix-schema-description
All Helix schema components must have a description
$.components.schemas[*]
info
helix-property-description
All Helix schema properties should have descriptions
$.components.schemas[*].properties[*]
warn
helix-info-contact
API info must include contact information
$.info
warn
helix-info-license
API info must include license information
$.info
warn
helix-path-parameters-described
All Helix path parameters must have descriptions
$.paths[*][*].parameters[?(@.in=='path')]
warn
path-params-casing
Path parameters should be camelCase (the dominant convention in this API).
$.paths[*].parameters[?(@.in=='path')].name
warn
operationid-casing
Operation IDs should be camelCase (the dominant convention in this API).
$.paths[*][get,post,put,patch,delete].operationId
warn
schema-names-casing
Component schema names should be PascalCase (the dominant convention in this API).
$.components.schemas
info
schema-properties-casing
Schema properties should be snake_case (the dominant convention in this API).
$.components.schemas[*].properties
warn
no-empty-descriptions
Descriptions must not be empty strings.
$..description

Spectral Ruleset

Raw ↑ 
# apache-helix — Spectral ruleset (strengthened)
# Plain Spectral. Existing hand-authored rules preserved; measured rules added
# from this provider's own OpenAPI conventions by strengthen_ruleset.py,
# then self-validated against the spec.
#
# Provenance:
#   - path-params-casing: camel @ 100% (n=12)
#   - operationid-casing: camel @ 100% (n=10)
#   - schema-names-casing: pascal @ 100% (n=6)
#   - schema-properties-casing: snake @ 55% (n=22)
#   - merge: kept 8 existing, added 5 measured, upgraded 0
#   - added: path-params-casing, operationid-casing, schema-names-casing, schema-properties-casing, no-empty-descriptions
extends:
  - spectral:oas
rules:
  helix-operation-summary:
    description: All Helix REST API operations must have a summary
    severity: error
    given: $.paths[*][get,put,post,delete,patch]
    then:
      field: summary
      function: truthy
  helix-operation-id:
    description: All Helix REST API operations must have an operationId
    severity: error
    given: $.paths[*][get,put,post,delete,patch]
    then:
      field: operationId
      function: truthy
  helix-operation-tags:
    description: All Helix REST API operations must have at least one tag
    severity: warn
    given: $.paths[*][get,put,post,delete,patch]
    then:
      field: tags
      function: truthy
  helix-schema-description:
    description: All Helix schema components must have a description
    severity: warn
    given: $.components.schemas[*]
    then:
      field: description
      function: truthy
  helix-property-description:
    description: All Helix schema properties should have descriptions
    severity: info
    given: $.components.schemas[*].properties[*]
    then:
      field: description
      function: truthy
  helix-info-contact:
    description: API info must include contact information
    severity: warn
    given: $.info
    then:
      field: contact
      function: truthy
  helix-info-license:
    description: API info must include license information
    severity: warn
    given: $.info
    then:
      field: license
      function: truthy
  helix-path-parameters-described:
    description: All Helix path parameters must have descriptions
    severity: warn
    given: $.paths[*][*].parameters[?(@.in=='path')]
    then:
      field: description
      function: truthy
  path-params-casing:
    description: Path parameters should be camelCase (the dominant convention in this API).
    severity: warn
    given: $.paths[*].parameters[?(@.in=='path')].name
    then:
      function: casing
      functionOptions:
        type: camel
  operationid-casing:
    description: Operation IDs should be camelCase (the dominant convention in this API).
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].operationId
    then:
      function: casing
      functionOptions:
        type: camel
  schema-names-casing:
    description: Component schema names should be PascalCase (the dominant convention in this API).
    severity: warn
    given: $.components.schemas
    then:
      field: '@key'
      function: casing
      functionOptions:
        type: pascal
  schema-properties-casing:
    description: Schema properties should be snake_case (the dominant convention in this API).
    severity: info
    given: $.components.schemas[*].properties
    then:
      field: '@key'
      function: casing
      functionOptions:
        type: snake
  no-empty-descriptions:
    description: Descriptions must not be empty strings.
    severity: warn
    given: $..description
    then:
      function: truthy