openFDA · API Governance Rules

openFDA API Rules

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

2 Rules warn 2
View Rules File View on GitHub

Rule Categories

no property

Rules

warn
property-name-casing
Schema properties should be snake_case (the dominant convention in this API).
$..properties
warn
no-empty-descriptions
Descriptions must not be empty strings.
$..description

Spectral Ruleset

open-fda-jsonschema-spectral-rules.yml Raw ↑ 
# open-fda — JSON Schema Spectral ruleset (strengthened)
# Plain Spectral. Rules measured from this provider's own JSON Schema
# conventions by strengthen_jsonschema.py, then self-validated against them.
#
# Provenance:
#   - property-name-casing: snake @ 100% (n=1007)
rules:
  property-name-casing:
    description: Schema properties should be snake_case (the dominant convention in this API).
    severity: warn
    given: $..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