Six rules in the Spotlight catalog carry this text, inherited verbatim from the third-party rulesets they were harvested from:
WARN: This rule is under implementation and just provides an hint.
That is team-digitale's honest note about the maturity of their rule. Carried into the API Commons catalog unchanged, it reads as a warning about our rule — published at apicommons.org/rules with no attribution explaining whose caveat it is.
Affected rules:
response-error-match-problem-schemaresponse-error-schema-problem-property-names- and four others in the same family
Three options
- Attribute it. Keep the text, but say whose caveat it is and link the upstream ruleset. Honest, and consistent with how the registry treats provenance elsewhere.
- Reimplement the rule so the caveat no longer applies, and write our own description. These are error-handling rules — the Problem Details ruleset now covers the same ground properly, grounded in RFC 9457.
- Drop them, since (2) supersedes them.
Option 2 or 3 is probably right — the Problem Details ruleset already does this job with real grounding.
Where to fix it
Not in _data/spotlight_rules.json — that file is generated. The source is spotlight-validator/rules/all-rules.yaml, then regenerate with scripts/generate-spotlight.py. rules/sources/* holds the harvested third-party originals and must not be edited; rewriting those would misrepresent what those vendors publish.
Six rules in the Spotlight catalog carry this text, inherited verbatim from the third-party rulesets they were harvested from:
That is team-digitale's honest note about the maturity of their rule. Carried into the API Commons catalog unchanged, it reads as a warning about our rule — published at apicommons.org/rules with no attribution explaining whose caveat it is.
Affected rules:
response-error-match-problem-schemaresponse-error-schema-problem-property-namesThree options
Option 2 or 3 is probably right — the Problem Details ruleset already does this job with real grounding.
Where to fix it
Not in
_data/spotlight_rules.json— that file is generated. The source isspotlight-validator/rules/all-rules.yaml, then regenerate withscripts/generate-spotlight.py.rules/sources/*holds the harvested third-party originals and must not be edited; rewriting those would misrepresent what those vendors publish.