US Court of Appeals for the Federal Circuit · API Governance Rules

US Court of Appeals for the Federal Circuit API Rules

Spectral linting rules defining API design standards and conventions for US Court of Appeals for the Federal Circuit.

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 2020-12 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

# us-court-of-appeals-for-the-federal-circuit — 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: 3/3 roots
#   - schema-draft-consistency: 2020-12 @ 100%
#   - schema-has-title: 3/3 roots
#   - property-name-casing: snake @ 100% (n=32)
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 2020-12 draft (this API's convention).
    severity: warn
    given: $.$schema
    then:
      function: pattern
      functionOptions:
        match: 2020\-12
  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