Grapes Knowledge Base · API Governance Rules

Grapes Knowledge Base API Rules

Spectral linting rules defining API design standards and conventions for Grapes Knowledge Base.

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

Rule Categories

no 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
no-empty-descriptions
Descriptions must not be empty strings.
$..description

Spectral Ruleset

Raw ↑ 
# grapes-knowledge-base — 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: 1/1 roots
#   - schema-draft-consistency: 2020-12 @ 100%
#   - schema-has-title: 1/1 roots
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
  no-empty-descriptions:
    description: Descriptions must not be empty strings.
    severity: warn
    given: $..description
    then:
      function: truthy