TrustRadius API Rules

# authorship: generated by API Evangelist tooling. Stamped 2026-08-18
# on the file's own generator header (roadmap#64). An unmarked file is
# NOT assumed to be ours -- absence of evidence was never stamped.
x-method: generated
# trustradius — 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.
#
# generated: '2026-08-14'
# method: derived
# source: json-schema/*.json — 17 schemas extracted from the provider-published OpenAPI
#         (openapi/_original/trustradius-api-openapi.yml, OpenAPI 3.0.0 v1.1)
#
# Provenance (re-measured 2026-08-14 against the real schemas):
#   - schema-declares-$schema: 17/17 roots
#   - schema-draft-consistency: 2020-12 @ 100%
#   - schema-has-title: 17/17 roots
#   - property-name-casing: camelCase @ 97% (167/172); the five exceptions are
#     account_id, activity_count, human_readable, web_url (snake) and _id (leading underscore,
#     on the /product-ids response only)
#
# CORRECTED 2026-08-14. The previous header measured 2 fabricated schemas and reported
# "snake @ 66% (n=44)", which is the opposite of this API's actual convention.
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 camelCase (97% of the 172 properties in this API's schemas).
      Known provider exceptions: account_id, activity_count, human_readable, web_url, and the
      leading-underscore _id on the /product-ids response.
    severity: info
    given: $..properties
    then:
      field: '@key'
      function: casing
      functionOptions:
        type: camel
  no-empty-descriptions:
    description: Descriptions must not be empty strings.
    severity: warn
    given: $..description
    then:
      function: truthy