Skip to content

Decide whether spotlight-validator should be public — its output already is #7

Description

@kinlane

api-commons/spotlight-validator holds the 740-rule catalog behind apicommons.org/rules and /rulesets/. It is currently private.

How it got here

The original remote 404'd with no rename redirect — the repo had been removed from the org at some point, and the local working copy was the only copy in existence. It was restored to api-commons/spotlight-validator as private on 2026-08-17, because republishing something that had been deliberately removed is a decision to take on purpose, not a side effect of restoring a backup.

The tension

scripts/generate-spotlight.py in the hub reads ../spotlight-validator/rules/all-rules.yaml to generate _data/spotlight_rules.json, assets/rulesets/*, and the /rules/ and /rulesets/ pages.

So the output is public and the source is private. Anyone can read all 740 rules on the site; nobody outside can see where they come from, propose a fix, or check provenance — in an organization whose entire premise is open, provenanced governance.

The generator now fails loudly with clone instructions if the checkout is missing, so the silent-stale-regeneration failure is closed. But the openness question is not.

The decision

  • Make it public — the rules are already public via the site; this just makes their source inspectable and contributable.
  • Keep it private — there is a reason it was removed that I do not have.

Related: spotlight-rules (the site), spotlight-spec (the format), spotlight-tools (the linter build) are all public.

Metadata

Metadata

Assignees

No one assigned

    Labels

    decisionWaiting on a call, not on effort

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions