HHS (US Department of Health and Human Services) · API Governance Rules

HHS (US Department of Health and Human Services) API Rules

Spectral linting rules defining API design standards and conventions for HHS (US Department of Health and Human Services).

5 Rules warn 4 info 1
View Rules File View on GitHub

Rule Categories

no property schema

Rules

warn
schema-declares-$schema
Every JSON Schema document should declare its $schema (draft).
$
warn
schema-draft-consistency
$schema should reference the 07 draft (this API's convention).
$.$schema
info
schema-has-title
JSON Schema documents should declare a title.
$
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

Raw ↑ 
# hhs — 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:
#   - schema-declares-$schema: 6/6 roots
#   - schema-draft-consistency: 07 @ 100%
#   - schema-has-title: 6/6 roots
#   - property-name-casing: snake @ 100% (n=42)
rules:
  schema-declares-$schema:
    description: Every JSON Schema document should declare its $schema (draft).
    severity: warn
    given: $
    then:
      field: $schema
      function: truthy
  schema-draft-consistency:
    description: $schema should reference the 07 draft (this API's convention).
    severity: warn
    given: $.$schema
    then:
      function: pattern
      functionOptions:
        match: '07'
  schema-has-title:
    description: JSON Schema documents should declare a title.
    severity: info
    given: $
    then:
      field: title
      function: truthy
  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